class ActiveStorage::Service::S3Service

Parent:
ActiveStorage::Service

Wraps the Amazon Simple Storage Service (S3) as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.

Constants

MAXIMUM_UPLOAD_PARTS_COUNT
MINIMUM_UPLOAD_PART_SIZE

Attributes

bucket[R]
client[R]
multipart_upload_threshold[R]
upload_options[R]

Public Class Methods

new(bucket:, upload: {}, public: false, **options) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 15
def initialize(bucket:, upload: {}, public: false, **options)
  @client = Aws::S3::Resource.new(**options)
  @bucket = @client.bucket(bucket)

  @multipart_upload_threshold = upload.delete(:multipart_threshold) || 100.megabytes
  @public = public

  @upload_options = upload
  @upload_options[:acl] = "public-read" if public?
end

Public Instance Methods

delete(key) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 60
def delete(key)
  instrument :delete, key: key do
    object_for(key).delete
  end
end
delete_prefixed(prefix) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 66
def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    bucket.objects(prefix: prefix).batch_delete!
  end
end
download(key, &block) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 38
def download(key, &block)
  if block_given?
    instrument :streaming_download, key: key do
      stream(key, &block)
    end
  else
    instrument :download, key: key do
      object_for(key).get.body.string.force_encoding(Encoding::BINARY)
    rescue Aws::S3::Errors::NoSuchKey
      raise ActiveStorage::FileNotFoundError
    end
  end
end
download_chunk(key, range) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 52
def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    object_for(key).get(range: "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body.string.force_encoding(Encoding::BINARY)
  rescue Aws::S3::Errors::NoSuchKey
    raise ActiveStorage::FileNotFoundError
  end
end
exist?(key) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 72
def exist?(key)
  instrument :exist, key: key do |payload|
    answer = object_for(key).exists?
    payload[:exist] = answer
    answer
  end
end
headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 92
def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **)
  content_disposition = content_disposition_with(type: disposition, filename: filename) if filename

  { "Content-Type" => content_type, "Content-MD5" => checksum, "Content-Disposition" => content_disposition }
end
upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 26
def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
  instrument :upload, key: key, checksum: checksum do
    content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename

    if io.size < multipart_upload_threshold
      upload_with_single_part key, io, checksum: checksum, content_type: content_type, content_disposition: content_disposition
    else
      upload_with_multipart key, io, content_type: content_type, content_disposition: content_disposition
    end
  end
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) Show source
# File activestorage/lib/active_storage/service/s3_service.rb, line 80
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key: key do |payload|
    generated_url = object_for(key).presigned_url :put, expires_in: expires_in.to_i,
      content_type: content_type, content_length: content_length, content_md5: checksum,
      whitelist_headers: ["content-length"], **upload_options

    payload[:url] = generated_url

    generated_url
  end
end

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.