class ActiveStorage::Service::GCSService
Wraps the Google Cloud Storage as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.
Attributes
config[R]
Public Class Methods
new(**config)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 15 def initialize(**config) @config = config end
Public Instance Methods
delete(key)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 59 def delete(key) instrument :delete, key: key do begin file_for(key).delete rescue Google::Cloud::NotFoundError # Ignore files already deleted end end end
delete_prefixed(prefix)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 69 def delete_prefixed(prefix) instrument :delete_prefixed, prefix: prefix do bucket.files(prefix: prefix).all(&:delete) end end
download(key) { |read| ... }
click to toggle source
FIXME: Download in chunks when given a block.
# File lib/active_storage/service/gcs_service.rb, line 36 def download(key) instrument :download, key: key do io = file_for(key).download io.rewind if block_given? yield io.read else io.read end end end
download_chunk(key, range)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 49 def download_chunk(key, range) instrument :download_chunk, key: key, range: range do uri = URI(url(key, expires_in: 30.seconds, filename: ActiveStorage::Filename.new(""), content_type: "application/octet-stream", disposition: "inline")) Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client| client.get(uri, "Range" => "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body end end end
exist?(key)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 75 def exist?(key) instrument :exist, key: key do |payload| answer = file_for(key).exists? payload[:exist] = answer answer end end
headers_for_direct_upload(key, checksum:, **)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 106 def headers_for_direct_upload(key, checksum:, **) { "Content-MD5" => checksum } end
upload(key, io, checksum: nil)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 19 def upload(key, io, checksum: nil) instrument :upload, key: key, checksum: checksum do begin # The official GCS client library doesn't allow us to create a file with no Content-Type metadata. # We need the file we create to have no Content-Type so we can control it via the response-content-type # param in signed URLs. Workaround: let the GCS client create the file with an inferred # Content-Type (usually "application/octet-stream") then clear it. bucket.create_file(io, key, md5: checksum).update do |file| file.content_type = nil end rescue Google::Cloud::InvalidArgumentError raise ActiveStorage::IntegrityError end end end
url(key, expires_in:, filename:, content_type:, disposition:)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 83 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:, **)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 96 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
Private Instance Methods
bucket()
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 117 def bucket @bucket ||= client.bucket(config.fetch(:bucket)) end
client()
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 121 def client @client ||= Google::Cloud::Storage.new(config.except(:bucket)) end
file_for(key)
click to toggle source
# File lib/active_storage/service/gcs_service.rb, line 113 def file_for(key) bucket.file(key, skip_lookup: true) end