Class: ActiveStorage::Service::S3Service

Inherits:
ActiveStorage::Service show all
Defined in:
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, #update_metadata

Constructor Details

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

Returns a new instance of S3Service.



14
15
16
17
18
19
 
# File '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

Instance Attribute Details

#bucket ⇒ Object (readonly)

Returns the value of attribute bucket.



12
13
14
 
# File 'lib/active_storage/service/s3_service.rb', line 12

def bucket
  @bucket
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



12
13
14
 
# File 'lib/active_storage/service/s3_service.rb', line 12

def client
  @client
end

#upload_options ⇒ Object (readonly)

Returns the value of attribute upload_options.



12
13
14
 
# File 'lib/active_storage/service/s3_service.rb', line 12

def upload_options
  @upload_options
end

Instance Method Details

#delete(key) ⇒ Object 



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

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

#delete_prefixed(prefix) ⇒ Object 



55
56
57
58
59
 
# File '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

#download(key, &block) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File '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

#download_chunk(key, range) ⇒ Object 



43
44
45
46
47
 
# File '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

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
 
# File '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

#headers_for_direct_upload(key, content_type:, checksum:) ⇒ Object 



93
94
95
 
# File '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

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



21
22
23
24
25
26
27
28
29
 
# File '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

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



69
70
71
72
73
74
75
76
77
78
79
 
# File '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

#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File '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