Module | Paperclip::Storage::S3
In: | vendor/plugins/paperclip/lib/paperclip/storage.rb

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 exists? extended parse_credentials s3 s3_bucket s3_host_alias s3_protocol to_file to_io

### Public Class methods

extended(base)

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 132
    132:       def self.extended base
    133:         require 'right_aws'
    134:         base.instance_eval do
    135:           @s3_credentials = parse_credentials(@options[:s3_credentials])
    136:           @bucket         = @options[:bucket]         || @s3_credentials[:bucket]
    137:           @bucket         = @bucket.call(self) if @bucket.is_a?(Proc)
    138:           @s3_options     = @options[:s3_options]     || {}
    139:           @s3_permissions = @options[:s3_permissions] || 'public-read'
    140:           @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == 'public-read' ? 'http' : 'https')
    141:           @s3_headers     = @options[:s3_headers]     || {}
    142:           @s3_host_alias  = @options[:s3_host_alias]
    143:           @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
    144:         end
    145:         base.class.interpolations[:s3_alias_url] = lambda do |attachment, style|
    146:           "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
    147:         end
    148:         base.class.interpolations[:s3_path_url] = lambda do |attachment, style|
    149:           "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
    150:         end
    151:         base.class.interpolations[:s3_domain_url] = lambda do |attachment, style|
    152:           "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
    153:         end
    154:         ActiveRecord::Base.logger.info("[paperclip] S3 Storage Initalized.")
    155:       end

### Public Instance methods

bucket_name()

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 167
    167:       def bucket_name
    168:         @bucket
    169:       end

exists?(style = default_style)

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 180
    180:       def exists?(style = default_style)
    181:         s3_bucket.key(path(style)) ? true : false
    182:       end

parse_credentials(creds)

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 175
    175:       def parse_credentials creds
    176:         creds = find_credentials(creds).stringify_keys
    177:         (creds[ENV['RAILS_ENV']] || creds).symbolize_keys
    178:       end

s3()

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 157
    157:       def s3
    158:         @s3 ||= RightAws::S3.new(@s3_credentials[:access_key_id],
    159:                                  @s3_credentials[:secret_access_key],
    160:                                  @s3_options)
    161:       end

s3_bucket()

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 163
    163:       def s3_bucket
    164:         @s3_bucket ||= s3.bucket(@bucket, true, @s3_permissions)
    165:       end

s3_host_alias()

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 171
    171:       def s3_host_alias
    172:         @s3_host_alias
    173:       end

s3_protocol()

[Source]

         # File vendor/plugins/paperclip/lib/paperclip/storage.rb, line 184
    184:       def s3_protocol
    185:         @s3_protocol
    186:       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 vendor/plugins/paperclip/lib/paperclip/storage.rb, line 190
    190:       def to_file style = default_style
    191:         @queued_for_write[style] || s3_bucket.key(path(style))
    192:       end

to_io(style = default_style)

Alias for to_file

[Validate]