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

Attributes

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

Class Public methods

new(bucket:, upload: {}, **options)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 14
    def initialize(bucket:, upload: {}, **options)
      @client = Aws::S3::Resource.new(**options)
      @bucket = @client.bucket(bucket)

      @upload_options = upload
    end
🔎 See on GitHub

Instance Public methods

delete(key)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 49
    def delete(key)
      instrument :delete, key: key do
        object_for(key).delete
      end
    end
🔎 See on GitHub

delete_prefixed(prefix)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 55
    def delete_prefixed(prefix)
      instrument :delete_prefixed, prefix: prefix do
        bucket.objects(prefix: prefix).batch_delete!
      end
    end
🔎 See on GitHub

download(key, &block)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 31
    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)
        end
      end
    end
🔎 See on GitHub

download_chunk(key, range)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 43
    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.read.force_encoding(Encoding::BINARY)
      end
    end
🔎 See on GitHub

exist?(key)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 61
    def exist?(key)
      instrument :exist, key: key do |payload|
        answer = object_for(key).exists?
        payload[:exist] = answer
        answer
      end
    end
🔎 See on GitHub

headers_for_direct_upload(key, content_type:, checksum:, **)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 93
    def headers_for_direct_upload(key, content_type:, checksum:, **)
      { "Content-Type" => content_type, "Content-MD5" => checksum }
    end
🔎 See on GitHub

upload(key, io, checksum: nil, **)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 21
    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
🔎 See on GitHub

url(key, expires_in:, filename:, disposition:, content_type:)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 69
    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
🔎 See on GitHub

url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)

📝 Source code
# File activestorage/lib/active_storage/service/s3_service.rb, line 81
    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']

        payload[:url] = generated_url

        generated_url
      end
    end
🔎 See on GitHub