edge badge

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.

Methods
D
E
H
N
U
Attributes
[R] bucket
[R] client
[R] upload_options
Class Public methods
new(access_key_id:, secret_access_key:, region:, bucket:, upload: {}, **options)
# File activestorage/lib/active_storage/service/s3_service.rb, line 11
def initialize(access_key_id,, secret_access_key,, region,, bucket,, upload: {}, **options)
  @client = Aws::S3::Resource.new(access_key_id: access_key_id, secret_access_key: secret_access_key, region: region, **options)
  @bucket = @client.bucket(bucket)

  @upload_options = upload
end
Instance Public methods
delete(key)
# File activestorage/lib/active_storage/service/s3_service.rb, line 40
def delete(key)
  instrument :delete, key: key do
    object_for(key).delete
  end
end
delete_prefixed(prefix)
# File activestorage/lib/active_storage/service/s3_service.rb, line 46
def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    bucket.objects(prefix: prefix).batch_delete!
  end
end
download(key, &block)
# File activestorage/lib/active_storage/service/s3_service.rb, line 28
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.read.force_encoding(Encoding::BINARY)
    end
  end
end
exist?(key)
# File activestorage/lib/active_storage/service/s3_service.rb, line 52
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:, **)
# File activestorage/lib/active_storage/service/s3_service.rb, line 83
def headers_for_direct_upload(key, content_type,, checksum,, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum }
end
upload(key, io, checksum: nil)
# File activestorage/lib/active_storage/service/s3_service.rb, line 18
def upload(key, io, checksum: nil)
  instrument :upload, key: key, checksum: checksum do
    begin
      object_for(key).put(upload_options.merge(body: io, content_md5: checksum))
    rescue Aws::S3::Errors::BadDigest
      raise ActiveStorage::IntegrityError
    end
  end
end
url(key, expires_in:, filename:, disposition:, content_type:)
# File activestorage/lib/active_storage/service/s3_service.rb, line 60
def url(key, expires_in,, filename,, disposition,, content_type))
  instrument :url, key: key do |payload|
    generated_url = object_for(key).presigned_url :get, expires_in: expires_in.to_i,
      response_content_disposition: content_disposition_with(type: disposition, filename: filename),
      response_content_type: content_type

    payload[:url] = generated_url

    generated_url
  end
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
# File activestorage/lib/active_storage/service/s3_service.rb, line 72
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

    payload[:url] = generated_url

    generated_url
  end
end