Class: ActiveStorage::Service::S3Service

Inherits:
ActiveStorage::Service show all
Defined in:
activestorage/lib/active_storage/service/s3_service.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ActiveStorage::Service

build, configure

Methods included from ActiveSupport::Autoload

#autoload, #autoload_at, #autoload_under, #autoloads, #eager_autoload, #eager_load!, extended

Constructor Details

#initialize(access_key_id:, secret_access_key:, region:, bucket:, upload: {}, **options) ⇒ S3Service

Returns a new instance of S3Service.



12
13
14
15
16
17
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 12

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 Attribute Details

#bucket ⇒ Object (readonly)

Returns the value of attribute bucket.



10
11
12
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 10

def bucket
  @bucket
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 10

def client
  @client
end

#upload_options ⇒ Object (readonly)

Returns the value of attribute upload_options.



10
11
12
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 10

def upload_options
  @upload_options
end

Instance Method Details

#delete(key) ⇒ Object 



41
42
43
44
45
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 41

def delete(key)
  instrument :delete, key do
    object_for(key).delete
  end
end

#download(key) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 29

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) ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
51
52
53
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 47

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:) ⇒ Object 



78
79
80
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 78

def headers_for_direct_upload(key, content_type:, checksum:, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum }
end

#upload(key, io, checksum: nil) ⇒ Object 



19
20
21
22
23
24
25
26
27
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 19

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 ActiveStorage::IntegrityError
    end
  end
end

#url(key, expires_in:, filename:, disposition:, content_type:) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 55

def url(key, expires_in:, filename:, disposition:, content_type:)
  instrument :url, key do |payload|
    generated_url = object_for(key).presigned_url :get, expires_in: expires_in,
      response_content_disposition: disposition,
      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:) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'activestorage/lib/active_storage/service/s3_service.rb', line 67

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