Module: Paperclip::Storage::S3

Defined in:
lib/paperclip/storage/s3.rb

Overview

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

To use Paperclip with S3, include the aws-sdk gem in your Gemfile:

gem 'aws-sdk'

There are a few S3-specific options for has_attached_file:

  • s3_credentials: Takes a path, a File, a Hash or a Proc. 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. When using a Proc it provides a single parameter which is the attachment itself. A method #instance is available on the attachment which will take you back to your code. eg.

    class User
      has_attached_file :download,
                        :storage => :s3,
                        :s3_credentials => Proc.new{|a| a.instance.s3_credentials }
    
      def s3_credentials
        {:bucket => "xxx", :access_key_id => "xxx", :secret_access_key => "xxx"}
      end
    end
  • 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.aws.amazon.com/AmazonS3/latest/dev/ACLOverview.html) The default for Paperclip is public-read.

    You can set permission on a per style bases by doing the following:

    :s3_permissions => {
      :original => :private
    }

    Or globally:

    :s3_permissions => :private
  • s3_protocol: The protocol for the URLs generated to your S3 assets. Can be either 'http', 'https', or an empty string to generate protocol-relative URLs. Defaults to empty string.

  • s3_headers: A hash of headers or a Proc. You may specify a hash such as => 1.year.from_now.httpdate. If you use a Proc, headers are determined at runtime. Paperclip will call that Proc with attachment as the only argument. Can be defined both globally and within a style-specific hash.

  • 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 its 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.

  • s3_prefixes_in_alias: The number of prefixes that is prepended by s3_host_alias. This will remove the prefixes from the path in :s3_alias_url url interpolation

  • url: There are four 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). You can also 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.

    Notes:

    • The value of this option is a string, not a symbol. right: ":s3_domain_url" wrong: :s3_domain_url

    • 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. The fourth option for the S3 url is :asset_host, which uses Rails' built-in asset_host settings.

    • To get the full url from a paperclip'd object, use the image_path helper; this is what image_tag uses to generate the url for an img tag.

  • 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.

  • s3_host_name: If you are using your bucket in Tokyo region etc, write host_name.

  • s3_region: For aws-sdk v2, s3_region is required.

  • s3_metadata: These key/value pairs will be stored with the object. This option works by prefixing each key with “x-amz-meta-” before sending it as a header on the object upload request. Can be defined both globally and within a style-specific hash.

  • s3_storage_class: If this option is set to :REDUCED_REDUNDANCY, the object will be stored using Reduced Redundancy Storage. RRS enables customers to reduce their costs by storing non-critical, reproducible data at lower levels of redundancy than Amazon S3's standard storage.

  • use_accelerate_endpoint: Use accelerate endpoint docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html

    You can set storage class on a per style bases by doing the following:

    :s3_storage_class => {
      :thumb => :REDUCED_REDUNDANCY
    }

    Or globally:

    :s3_storage_class => :REDUCED_REDUNDANCY

    Other storage classes, such as :STANDARD_IA, are also available—see the documentation for the aws-sdk gem for the full list.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/paperclip/storage/s3.rb', line 123

def self.extended base
  begin
    require 'aws-sdk'
  rescue LoadError => e
    e.message << " (You may need to install the aws-sdk gem)"
    raise e
  end
  if Gem::Version.new(Aws::VERSION) >= Gem::Version.new(2) &&
     Gem::Version.new(Aws::VERSION) <= Gem::Version.new("2.0.33")
    raise LoadError, "paperclip does not support aws-sdk versions 2.0.0 - 2.0.33.  Please upgrade aws-sdk to a newer version."
  end

  base.instance_eval do
    @s3_options     = @options[:s3_options]     || {}
    @s3_permissions = set_permissions(@options[:s3_permissions])
    @s3_protocol    = @options[:s3_protocol] || "".freeze
    @s3_metadata = @options[:s3_metadata] || {}
    @s3_headers = {}
    merge_s3_headers(@options[:s3_headers], @s3_headers, @s3_metadata)

    @s3_storage_class = set_storage_class(@options[:s3_storage_class])

    @s3_server_side_encryption = "AES256"
    if @options[:s3_server_side_encryption].blank?
      @s3_server_side_encryption = false
    end
    if @s3_server_side_encryption
      @s3_server_side_encryption = @options[:s3_server_side_encryption]
    end

    unless @options[:url].to_s.match(/\A:s3.*url\z/) || @options[:url] == ":asset_host".freeze
      @options[:path] = path_option.gsub(/:url/, @options[:url]).sub(/\A:rails_root\/public\/system/, "".freeze)
      @options[:url]  = ":s3_path_url".freeze
    end
    @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)

    @http_proxy = @options[:http_proxy] || nil

    if @options.has_key?(:use_accelerate_endpoint) &&
        Gem::Version.new(Aws::VERSION) < Gem::Version.new("2.3.0")
      raise LoadError, ":use_accelerate_endpoint is only available from aws-sdk version 2.3.0. Please upgrade aws-sdk to a newer version."
    end

    @use_accelerate_endpoint = @options[:use_accelerate_endpoint]
  end

  Paperclip.interpolates(:s3_alias_url) do |attachment, style|
    protocol = attachment.s3_protocol(style, true)
    host = attachment.s3_host_alias
    path = attachment.path(style).
      split("/")[attachment.s3_prefixes_in_alias..-1].
      join("/").
      sub(%r{\A/}, "".freeze)
    "#{protocol}//#{host}/#{path}"
  end unless Paperclip::Interpolations.respond_to? :s3_alias_url
  Paperclip.interpolates(:s3_path_url) do |attachment, style|
    "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_name}/#{attachment.bucket_name}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
  end unless Paperclip::Interpolations.respond_to? :s3_path_url
  Paperclip.interpolates(:s3_domain_url) do |attachment, style|
    "#{attachment.s3_protocol(style, true)}//#{attachment.bucket_name}.#{attachment.s3_host_name}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
  end unless Paperclip::Interpolations.respond_to? :s3_domain_url
  Paperclip.interpolates(:asset_host) do |attachment, style|
    "#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
  end unless Paperclip::Interpolations.respond_to? :asset_host
end

Instance Method Details

#bucket_nameObject



235
236
237
238
239
# File 'lib/paperclip/storage/s3.rb', line 235

def bucket_name
  @bucket = @options[:bucket] || s3_credentials[:bucket]
  @bucket = @bucket.call(self) if @bucket.respond_to?(:call)
  @bucket or raise ArgumentError, "missing required :bucket option"
end

#copy_to_local_file(style, local_dest_path) ⇒ Object



421
422
423
424
425
426
427
428
429
430
431
# File 'lib/paperclip/storage/s3.rb', line 421

def copy_to_local_file(style, local_dest_path)
  log("copying #{path(style)} to local file #{local_dest_path}")
  ::File.open(local_dest_path, 'wb') do |local_file|
    s3_object(style).get do |chunk|
      local_file.write(chunk)
    end
  end
rescue Aws::Errors::ServiceError => e
  warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
  false
end

#create_bucketObject



355
356
357
# File 'lib/paperclip/storage/s3.rb', line 355

def create_bucket
  s3_interface.bucket(bucket_name).create
end

#exists?(style = default_style) ⇒ Boolean

Returns:

  • (Boolean)


324
325
326
327
328
329
330
331
332
# File 'lib/paperclip/storage/s3.rb', line 324

def exists?(style = default_style)
  if original_filename
    s3_object(style).exists?
  else
    false
  end
rescue Aws::Errors::ServiceError => e
  false
end

#expiring_url(time = 3600, style_name = default_style) ⇒ Object



189
190
191
192
193
194
195
196
197
198
199
# File 'lib/paperclip/storage/s3.rb', line 189

def expiring_url(time = 3600, style_name = default_style)
  if path(style_name)
    base_options = { expires_in: time }
    s3_object(style_name).presigned_url(
      :get,
      base_options.merge(s3_url_options),
    ).to_s
  else
    url(style_name)
  end
end

#flush_deletesObject

:nodoc:



409
410
411
412
413
414
415
416
417
418
419
# File 'lib/paperclip/storage/s3.rb', line 409

def flush_deletes #:nodoc:
  @queued_for_delete.each do |path|
    begin
      log("deleting #{path}")
      s3_bucket.object(path.sub(%r{\A/}, "")).delete
    rescue Aws::Errors::ServiceError => e
      # Ignore this.
    end
  end
  @queued_for_delete = []
end

#flush_writesObject

:nodoc:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/paperclip/storage/s3.rb', line 359

def flush_writes #:nodoc:
  @queued_for_write.each do |style, file|
  retries = 0
    begin
      log("saving #{path(style)}")
      write_options = {
        :content_type => file.content_type,
        :acl => s3_permissions(style)
      }

      # add storage class for this style if defined
      storage_class = s3_storage_class(style)
      write_options.merge!(:storage_class => storage_class) if storage_class

      if @s3_server_side_encryption
        write_options[:server_side_encryption] = @s3_server_side_encryption
      end

      style_specific_options = styles[style]

      if style_specific_options
        merge_s3_headers( style_specific_options[:s3_headers], @s3_headers, @s3_metadata) if style_specific_options[:s3_headers]
        @s3_metadata.merge!(style_specific_options[:s3_metadata]) if style_specific_options[:s3_metadata]
      end

      write_options[:metadata] = @s3_metadata unless @s3_metadata.empty?
      write_options.merge!(@s3_headers)

      s3_object(style).upload_file(file.path, write_options)
    rescue ::Aws::S3::Errors::NoSuchBucket
      create_bucket
      retry
    rescue ::Aws::S3::Errors::SlowDown
      retries += 1
      if retries <= 5
        sleep((2 ** retries) * 0.5)
        retry
      else
        raise
      end
    ensure
      file.rewind
    end
  end

  after_flush_writes # allows attachment to clean up temp files

  @queued_for_write = {}
end

#http_proxy_hostObject



292
293
294
# File 'lib/paperclip/storage/s3.rb', line 292

def http_proxy_host
  using_http_proxy? ? @http_proxy[:host] : nil
end

#http_proxy_passwordObject



304
305
306
# File 'lib/paperclip/storage/s3.rb', line 304

def http_proxy_password
  using_http_proxy? ? @http_proxy[:password] : nil
end

#http_proxy_portObject



296
297
298
# File 'lib/paperclip/storage/s3.rb', line 296

def http_proxy_port
  using_http_proxy? ? @http_proxy[:port] : nil
end

#http_proxy_userObject



300
301
302
# File 'lib/paperclip/storage/s3.rb', line 300

def http_proxy_user
  using_http_proxy? ? @http_proxy[:user] : nil
end

#obtain_s3_instance_for(options) ⇒ Object



267
268
269
270
# File 'lib/paperclip/storage/s3.rb', line 267

def obtain_s3_instance_for(options)
  instances = (Thread.current[:paperclip_s3_instances] ||= {})
  instances[options] ||= ::Aws::S3::Resource.new(options)
end

#parse_credentials(creds) ⇒ Object



318
319
320
321
322
# File 'lib/paperclip/storage/s3.rb', line 318

def parse_credentials creds
  creds = creds.respond_to?(:call) ? creds.call(self) : creds
  creds = find_credentials(creds).stringify_keys
  (creds[RailsEnvironment.get] || creds).symbolize_keys
end

#s3_bucketObject



272
273
274
# File 'lib/paperclip/storage/s3.rb', line 272

def s3_bucket
  @s3_bucket ||= s3_interface.bucket(bucket_name)
end

#s3_credentialsObject



201
202
203
# File 'lib/paperclip/storage/s3.rb', line 201

def s3_credentials
  @s3_credentials ||= parse_credentials(@options[:s3_credentials])
end

#s3_host_aliasObject



219
220
221
222
223
# File 'lib/paperclip/storage/s3.rb', line 219

def s3_host_alias
  @s3_host_alias = @options[:s3_host_alias]
  @s3_host_alias = @s3_host_alias.call(self) if @s3_host_alias.respond_to?(:call)
  @s3_host_alias
end

#s3_host_nameObject



205
206
207
208
209
210
# File 'lib/paperclip/storage/s3.rb', line 205

def s3_host_name
  host_name = @options[:s3_host_name]
  host_name = host_name.call(self) if host_name.is_a?(Proc)

  host_name || s3_credentials[:s3_host_name] || "s3.amazonaws.com".freeze
end

#s3_interfaceObject



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/paperclip/storage/s3.rb', line 241

def s3_interface
  @s3_interface ||= begin
    config = { region: s3_region }

    if using_http_proxy?

      proxy_opts = { :host => http_proxy_host }
      proxy_opts[:port] = http_proxy_port if http_proxy_port
      if http_proxy_user
        userinfo = http_proxy_user.to_s
        userinfo += ":#{http_proxy_password}" if http_proxy_password
        proxy_opts[:userinfo] = userinfo
      end
      config[:proxy_uri] = URI::HTTP.build(proxy_opts)
    end

    config[:use_accelerate_endpoint] = use_accelerate_endpoint?

    [:access_key_id, :secret_access_key, :credential_provider, :credentials].each do |opt|
      config[opt] = s3_credentials[opt] if s3_credentials[opt]
    end

    obtain_s3_instance_for(config.merge(@s3_options))
  end
end

#s3_object(style_name = default_style) ⇒ Object



280
281
282
# File 'lib/paperclip/storage/s3.rb', line 280

def s3_object style_name = default_style
  s3_bucket.object style_name_as_path(style_name)
end

#s3_permissions(style = default_style) ⇒ Object



334
335
336
337
338
# File 'lib/paperclip/storage/s3.rb', line 334

def s3_permissions(style = default_style)
  s3_permissions = @s3_permissions[style] || @s3_permissions[:default]
  s3_permissions = s3_permissions.call(self, style) if s3_permissions.respond_to?(:call)
  s3_permissions
end

#s3_prefixes_in_aliasObject



225
226
227
# File 'lib/paperclip/storage/s3.rb', line 225

def s3_prefixes_in_alias
  @s3_prefixes_in_alias ||= @options[:s3_prefixes_in_alias].to_i
end

#s3_protocol(style = default_style, with_colon = false) ⇒ Object



344
345
346
347
348
349
350
351
352
353
# File 'lib/paperclip/storage/s3.rb', line 344

def s3_protocol(style = default_style, with_colon = false)
  protocol = @s3_protocol
  protocol = protocol.call(style, self) if protocol.respond_to?(:call)

  if with_colon && !protocol.empty?
    "#{protocol}:"
  else
    protocol.to_s
  end
end

#s3_regionObject



212
213
214
215
216
217
# File 'lib/paperclip/storage/s3.rb', line 212

def s3_region
  region = @options[:s3_region]
  region = region.call(self) if region.is_a?(Proc)

  region || s3_credentials[:s3_region]
end

#s3_storage_class(style = default_style) ⇒ Object



340
341
342
# File 'lib/paperclip/storage/s3.rb', line 340

def s3_storage_class(style = default_style)
  @s3_storage_class[style] || @s3_storage_class[:default]
end

#s3_url_optionsObject



229
230
231
232
233
# File 'lib/paperclip/storage/s3.rb', line 229

def s3_url_options
  s3_url_options = @options[:s3_url_options] || {}
  s3_url_options = s3_url_options.call(instance) if s3_url_options.respond_to?(:call)
  s3_url_options
end

#set_permissions(permissions) ⇒ Object



308
309
310
311
# File 'lib/paperclip/storage/s3.rb', line 308

def set_permissions permissions
  permissions = { :default => permissions } unless permissions.respond_to?(:merge)
  permissions.merge :default => (permissions[:default] || :public-read")
end

#set_storage_class(storage_class) ⇒ Object



313
314
315
316
# File 'lib/paperclip/storage/s3.rb', line 313

def set_storage_class(storage_class)
  storage_class = {:default => storage_class} unless storage_class.respond_to?(:merge)
  storage_class
end

#style_name_as_path(style_name) ⇒ Object



276
277
278
# File 'lib/paperclip/storage/s3.rb', line 276

def style_name_as_path(style_name)
  path(style_name).sub(%r{\A/},'')
end

#use_accelerate_endpoint?Boolean

Returns:

  • (Boolean)


284
285
286
# File 'lib/paperclip/storage/s3.rb', line 284

def use_accelerate_endpoint?
  !!@use_accelerate_endpoint
end

#using_http_proxy?Boolean

Returns:

  • (Boolean)


288
289
290
# File 'lib/paperclip/storage/s3.rb', line 288

def using_http_proxy?
  !!@http_proxy
end