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

bucket[R]
client[R]

Public Class Methods

new(project:, keyfile:, bucket:) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 12
def initialize(project:, keyfile:, bucket:)
  @client = Google::Cloud::Storage.new(project: project, keyfile: keyfile)
  @bucket = @client.bucket(bucket)
end

Public Instance Methods

delete(key) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 36
def delete(key)
  instrument :delete, key do
    file_for(key).try(:delete)
  end
end
download(key) click to toggle source

FIXME: Add streaming when given a block

# File activestorage/lib/active_storage/service/gcs_service.rb, line 28
def download(key)
  instrument :download, key do
    io = file_for(key).download
    io.rewind
    io.read
  end
end
exist?(key) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 42
def exist?(key)
  instrument :exist, key do |payload|
    answer = file_for(key).present?
    payload[:exist] = answer
    answer
  end
end
headers_for_direct_upload(key, content_type:, checksum:, **) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 74
def headers_for_direct_upload(key, content_type:, checksum:, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum }
end
upload(key, io, checksum: nil) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 17
def upload(key, io, checksum: nil)
  instrument :upload, key, checksum: checksum do
    begin
      bucket.create_file(io, key, md5: checksum)
    rescue Google::Cloud::InvalidArgumentError
      raise ActiveStorage::IntegrityError
    end
  end
end
url(key, expires_in:, filename:, content_type:, disposition:) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 50
def url(key, expires_in:, filename:, content_type:, disposition:)
  instrument :url, key do |payload|
    generated_url = file_for(key).signed_url expires: expires_in, query: {
      "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:) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 63
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key do |payload|
    generated_url = bucket.signed_url key, method: "PUT", expires: expires_in,
      content_type: content_type, content_md5: checksum

    payload[:url] = generated_url

    generated_url
  end
end

Private Instance Methods

file_for(key) click to toggle source
# File activestorage/lib/active_storage/service/gcs_service.rb, line 79
def file_for(key)
  bucket.file(key)
end