Module: Paperclip::Storage::S3

Amazon‘s S3 file hosting service is a scalable, easy place to store files for distribution. You can find out more about it at aws.amazon.com/s3 There are a few S3-specific options for has_attached_file:

+s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point to a YAML file containing the access_key_id and secret_access_key that Amazon gives you. You can ‘environment-space’ this just like you do to your database.yml file, so different environments can use different accounts:
```
  development:
    access_key_id: 123...
    secret_access_key: 123...
  test:
    access_key_id: abc...
    secret_access_key: abc...
  production:
    access_key_id: 456...
    secret_access_key: 456...
```
This is not required, however, and the file may simply look like this:
```
  access_key_id: 456...
  secret_access_key: 456...
```
In which case, those access keys will be used in all environments. You can also put your bucket name in this file, instead of adding it to the code directly. This is useful when you want the same account but a different bucket for development versus production.
+s3_permissions+: This is a String that should be one of the "canned" access policies that S3 provides (more information can be found here: docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies) The default for Paperclip is :public_read.
+s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either ‘http’ or ‘https’. Defaults to ‘http’ when your :s3_permissions are :public_read (the default), and ‘https’ when your :s3_permissions are anything else.
+s3_headers+: A hash of headers such as {‘Expires’ => 1.year.from_now.httpdate}
bucket: This is the name of the S3 bucket that will store your files. Remember that the bucket must be unique across all of Amazon S3. If the bucket does not exist Paperclip will attempt to create it. The bucket name will not be interpolated. You can define the bucket as a Proc if you want to determine it‘s name at runtime. Paperclip will call that Proc with attachment as the only argument.
+s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the link in the url entry for more information about S3 domains and buckets.
url: There are three options for the S3 url. You can choose to have the bucket‘s name placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket). Lastly, you can specify a CNAME (which requires the CNAME to be specified as :s3_alias_url. You can read more about CNAMEs and S3 at docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html Normally, this won‘t matter in the slightest and you can leave the default (which is path-style, or :s3_path_url). But in some cases paths don‘t work and you need to use the domain-style (:s3_domain_url). Anything else here will be treated like path-style. NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host alias, the :bucket parameter is ignored, as the hostname is used as the bucket name by S3.
path: This is the key under the bucket in which the file will be stored. The URL will be constructed from the bucket and the path. This is what you will want to interpolate. Keys should be unique, like filenames, and despite the fact that S3 (strictly speaking) does not support directories, you can still use a / to separate parts of your file name.

Methods

bucket_name create_bucket exists? expiring_url extended parse_credentials s3_host_alias s3_protocol to_file

Public Class methods

extended(base)

[Source]

    # File lib/paperclip/storage/s3.rb, line 60
60:       def self.extended base
61:         begin
62:           require 'aws/s3'
63:         rescue LoadError => e
64:           e.message << " (You may need to install the aws-s3 gem)"
65:           raise e
66:         end
67: 
68:         base.instance_eval do
69:           @s3_credentials = parse_credentials(@options[:s3_credentials])
70:           @bucket         = @options[:bucket]         || @s3_credentials[:bucket]
71:           @bucket         = @bucket.call(self) if @bucket.is_a?(Proc)
72:           @s3_options     = @options[:s3_options]     || {}
73:           @s3_permissions = @options[:s3_permissions] || :public_read
74:           @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == :public_read ? 'http' : 'https')
75:           @s3_headers     = @options[:s3_headers]     || {}
76:           @s3_host_alias  = @options[:s3_host_alias]
77:           unless @url.to_s.match(/^:s3.*url$/)
78:             @path          = @path.gsub(/:url/, @url)
79:             @url           = ":s3_path_url"
80:           end
81:           AWS::S3::Base.establish_connection!( @s3_options.merge(
82:             :access_key_id => @s3_credentials[:access_key_id],
83:             :secret_access_key => @s3_credentials[:secret_access_key]
84:           ))
85:         end
86:         Paperclip.interpolates(:s3_alias_url) do |attachment, style|
87:           "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
88:         end
89:         Paperclip.interpolates(:s3_path_url) do |attachment, style|
90:           "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
91:         end
92:         Paperclip.interpolates(:s3_domain_url) do |attachment, style|
93:           "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
94:         end
95:       end

Public Instance methods

bucket_name()

[Source]

     # File lib/paperclip/storage/s3.rb, line 101
101:       def bucket_name
102:         @bucket
103:       end

create_bucket()

[Source]

     # File lib/paperclip/storage/s3.rb, line 140
140:       def create_bucket
141:         AWS::S3::Bucket.create(bucket_name)
142:       end

exists?(style = default_style)

[Source]

     # File lib/paperclip/storage/s3.rb, line 114
114:       def exists?(style = default_style)
115:         if original_filename
116:           AWS::S3::S3Object.exists?(path(style), bucket_name)
117:         else
118:           false
119:         end
120:       end

expiring_url(time = 3600)

[Source]

    # File lib/paperclip/storage/s3.rb, line 97
97:       def expiring_url(time = 3600)
98:         AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
99:       end

parse_credentials(creds)

[Source]

     # File lib/paperclip/storage/s3.rb, line 109
109:       def parse_credentials creds
110:         creds = find_credentials(creds).stringify_keys
111:         (creds[Rails.env] || creds).symbolize_keys
112:       end

s3_host_alias()

[Source]

     # File lib/paperclip/storage/s3.rb, line 105
105:       def s3_host_alias
106:         @s3_host_alias
107:       end

s3_protocol()

[Source]

     # File lib/paperclip/storage/s3.rb, line 122
122:       def s3_protocol
123:         @s3_protocol
124:       end

to_file(style = default_style)

Returns representation of the data of the file assigned to the given style, in the format most representative of the current storage.

[Source]

     # File lib/paperclip/storage/s3.rb, line 128
128:       def to_file style = default_style
129:         return @queued_for_write[style] if @queued_for_write[style]
130:         filename = path(style)
131:         extname  = File.extname(filename)
132:         basename = File.basename(filename, extname)
133:         file = Tempfile.new([basename, extname])
134:         file.binmode
135:         file.write(AWS::S3::S3Object.value(path(style), bucket_name))
136:         file.rewind
137:         return file
138:       end