class BackupStorage::Service::S3Service

Wraps the Amazon Simple Storage Service (S3) as a Backup Storage service. See `BackupStorage::Service` for the generic API documentation that applies to all services.

Attributes

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

Public Class Methods

new(access_key_id:, secret_access_key:, region:, bucket:, upload: {}, **options) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 9
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

Public Instance Methods

delete(key) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 38
def delete(key)
  instrument :delete, key do
    object_for(key).delete
  end
end
download(key) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 26
def download(key)
  if block_given?
    instrument :streaming_download, key do
      stream(key, &block)
    end
  else
    instrument :download, key do
      object_for(key).get.body.read.force_encoding(Encoding::BINARY)
    end
  end
end
exist?(key) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 44
def exist?(key)
  instrument :exist, key do |payload|
    answer = object_for(key).exists?
    payload[:exist] = answer
    answer
  end
end
headers_for_direct_upload(key, content_type:, checksum:, **) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 75
def headers_for_direct_upload(key, content_type:, checksum:, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum }
end
upload(key, io, checksum: nil) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 16
def upload(key, io, checksum: nil)
  instrument :upload, key, checksum: checksum do
    begin
      object_for(key).put(upload_options.merge(body: io, content_md5: checksum))
    rescue Aws::S3::Errors::BadDigest
      raise BackupStorage::IntegrityError
    end
  end
end
url(key, expires_in:, disposition:, filename:, content_type:) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 52
def url(key, expires_in:, disposition:, filename:, content_type:)
  instrument :url, key do |payload|
    generated_url = object_for(key).presigned_url :get, expires_in: expires_in,
      response_content_disposition: "#{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:) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 64
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key do |payload|
    generated_url = object_for(key).presigned_url :put, expires_in: expires_in,
      content_type: content_type, content_length: content_length, content_md5: checksum

    payload[:url] = generated_url

    generated_url
  end
end

Private Instance Methods

object_for(key) click to toggle source
# File lib/backup_storage/service/s3_service.rb, line 80
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/backup_storage/service/s3_service.rb, line 85
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