Wraps the Google Cloud Storage as an Active Storage service. See ActiveStorage::Service
for the generic API documentation that applies to all services.
Methods
- D
- E
- H
- N
- U
Class Public methods
new(**config)
Link
Instance Public methods
delete(key)
Link
delete_prefixed(prefix)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 66 def delete_prefixed(prefix) instrument :delete_prefixed, prefix: prefix do bucket.files(prefix: prefix).all do |file| file.delete rescue Google::Cloud::NotFoundError # Ignore concurrently-deleted files end end end
download(key, &block)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 27 def download(key, &block) if block_given? instrument :streaming_download, key: key do stream(key, &block) end else instrument :download, key: key do file_for(key).download.string rescue Google::Cloud::NotFoundError raise ActiveStorage::FileNotFoundError end end end
download_chunk(key, range)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 50 def download_chunk(key, range) instrument :download_chunk, key: key, range: range do file_for(key).download(range: range).string rescue Google::Cloud::NotFoundError raise ActiveStorage::FileNotFoundError end end
exist?(key)
Link
headers_for_direct_upload(key, checksum:, **)
Link
update_metadata(key, content_type:, disposition: nil, filename: nil)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 41 def update_metadata(key, content_type:, disposition: nil, filename: nil) instrument :update_metadata, key: key, content_type: content_type, disposition: disposition do file_for(key).update do |file| file.content_type = content_type file.content_disposition = content_disposition_with(type: disposition, filename: filename) if disposition && filename end end end
upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 14 def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil) instrument :upload, key: key, checksum: checksum do # GCS's signed URLs don't include params such as response-content-type response-content_disposition # in the signature, which means an attacker can modify them and bypass our effort to force these to # binary and attachment when the file's content type requires it. The only way to force them is to # store them as object's metadata. content_disposition = content_disposition_with(type: disposition, filename: filename) if disposition && filename bucket.create_file(io, key, md5: checksum, content_type: content_type, content_disposition: content_disposition) rescue Google::Cloud::InvalidArgumentError raise ActiveStorage::IntegrityError end end
url(key, expires_in:, filename:, content_type:, disposition:)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 84 def url(key, expires_in:, filename:, content_type:, disposition:) instrument :url, key: key do |payload| generated_url = file_for(key).signed_url expires: expires_in, query: { "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:, checksum:, **)
Link
# File activestorage/lib/active_storage/service/gcs_service.rb, line 97 def url_for_direct_upload(key, expires_in:, checksum:, **) instrument :url, key: key do |payload| generated_url = bucket.signed_url key, method: "PUT", expires: expires_in, content_md5: checksum payload[:url] = generated_url generated_url end end