class ActiveStorage::Service::S3Service

Attributes

bucket[R]
client[R]

Public Class Methods

new(access_key_id:, secret_access_key:, region:, bucket:) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 7
def initialize(access_key_id:, secret_access_key:, region:, bucket:)
  @client = Aws::S3::Resource.new(access_key_id: access_key_id, secret_access_key: secret_access_key, region: region)
  @bucket = @client.bucket(bucket)
end

Public Instance Methods

delete(key) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 25
def delete(key)
  object_for(key).delete
end
download(key) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 17
def download(key)
  if block_given?
    stream(key, &block)
  else
    object_for(key).get.body.read
  end
end
exist?(key) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 29
def exist?(key)
  object_for(key).exists?
end
upload(key, io, checksum: nil) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 12
def upload(key, io, checksum: nil)
  # FIXME: Ensure integrity by sending the checksum for service side verification
  object_for(key).put(body: io)
end
url(key, expires_in:, disposition:, filename:) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 33
def url(key, expires_in:, disposition:, filename:)
  object_for(key).presigned_url :get, expires_in: expires_in,
    response_content_disposition: "#{disposition}; filename=\"#{filename}\""
end

Private Instance Methods

object_for(key) click to toggle source
# File lib/active_storage/service/s3_service.rb, line 39
def object_for(key)
  bucket.object(key)
end
stream(key, options = {}) { |read(merge(:range => "bytes=#{offset}-#{offset + chunk_size - 1}"))| ... } click to toggle source

Reads the object for the given key in chunks, yielding each to the block.

# File lib/active_storage/service/s3_service.rb, line 44
def stream(key, options = {}, &block)
  object = object_for(key)

  chunk_size = 5.megabytes
  offset = 0

  while offset < object.content_length
    yield object.read(options.merge(:range => "bytes=#{offset}-#{offset + chunk_size - 1}"))
    offset += chunk_size
  end
end