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
- D
- E
- H
- N
- U
Attributes
[R] | bucket | |
[R] | client | |
[R] | upload_options |
Class Public methods
new(bucket:, upload: {}, **options)
Link
Instance Public methods
delete(key)
Link
delete_prefixed(prefix)
Link
download(key, &block)
Link
# File activestorage/lib/active_storage/service/s3_service.rb, line 29 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) rescue Aws::S3::Errors::NoSuchKey raise ActiveStorage::FileNotFoundError end end end
download_chunk(key, range)
Link
# 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) rescue Aws::S3::Errors::NoSuchKey raise ActiveStorage::FileNotFoundError end end
exist?(key)
Link
headers_for_direct_upload(key, content_type:, checksum:, **)
Link
upload(key, io, checksum: nil, content_type: nil, **)
Link
# File activestorage/lib/active_storage/service/s3_service.rb, line 21 def upload(key, io, checksum: nil, content_type: nil, **) instrument :upload, key: key, checksum: checksum do object_for(key).put(upload_options.merge(body: io, content_md5: checksum, content_type: content_type)) rescue Aws::S3::Errors::BadDigest raise ActiveStorage::IntegrityError end end
url(key, expires_in:, filename:, disposition:, content_type:)
Link
# File activestorage/lib/active_storage/service/s3_service.rb, line 71 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:)
Link
# File activestorage/lib/active_storage/service/s3_service.rb, line 83 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