edge badge

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)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 10
def initialize(**config)
  @config = config
end
Instance Public methods
delete(key)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 56
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)
# 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|
      begin
        file.delete
      rescue Google::Cloud::NotFoundError
        # Ignore concurrently-deleted files
      end
    end
  end
end
download(key, &block)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 30
def download(key, &block)
  if block_given?
    instrument :streaming_download, key: key do
      stream(key, &block)
    end
  else
    instrument :download, key: key do
      begin
        file_for(key).download.string
      rescue Google::Cloud::NotFoundError
        raise ActiveStorage::FileNotFoundError
      end
    end
  end
end
download_chunk(key, range)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 46
def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    begin
      file_for(key).download(range: range).string
    rescue Google::Cloud::NotFoundError
      raise ActiveStorage::FileNotFoundError
    end
  end
end
exist?(key)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 78
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:, **)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 109
def headers_for_direct_upload(key, checksum:, **)
  { "Content-MD5" => checksum }
end
upload(key, io, checksum: nil)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 14
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:)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 86
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:, **)
# File activestorage/lib/active_storage/service/gcs_service.rb, line 99
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