edge badge
Skip to Content Skip to Search

Wraps the Google Cloud Storage as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.

Namespace
Methods
D
E
H
N
U

Class Public methods

new(public: false, **config)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 14
def initialize(public: false, **config)
  @config = config
  @public = public
end

Instance Public methods

delete(key)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 63
def delete(key)
  instrument :delete, key: key do
    file_for(key).delete
  rescue Google::Cloud::NotFoundError
    # Ignore files already deleted
  end
end

delete_prefixed(prefix)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 71
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)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 32
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)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 55
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)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 81
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:, filename: nil, disposition: nil, **)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 123
def headers_for_direct_upload(key, checksum:, filename: nil, disposition: nil, **)
  content_disposition = content_disposition_with(type: disposition, filename: filename) if filename

  headers = { "Content-MD5" => checksum, "Content-Disposition" => content_disposition }

  if @config[:cache_control].present?
    headers["Cache-Control"] = @config[:cache_control]
  end

  headers
end

update_metadata(key, content_type:, disposition: nil, filename: nil)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 46
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)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 19
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, cache_control: @config[:cache_control], content_type: content_type, content_disposition: content_disposition)
  rescue Google::Cloud::InvalidArgumentError
    raise ActiveStorage::IntegrityError
  end
end

url_for_direct_upload(key, expires_in:, checksum:, **)

# File activestorage/lib/active_storage/service/gcs_service.rb, line 89
def url_for_direct_upload(key, expires_in:, checksum:, **)
  instrument :url, key: key do |payload|
    headers = {}
    version = :v2

    if @config[:cache_control].present?
      headers["Cache-Control"] = @config[:cache_control]
      # v2 signing doesn't support non `x-goog-` headers. Only switch to v4 signing
      # if necessary for back-compat; v4 limits the expiration of the URL to 7 days
      # whereas v2 has no limit
      version = :v4
    end

    args = {
      content_md5: checksum,
      expires: expires_in,
      headers: headers,
      method: "PUT",
      version: version,
    }

    if @config[:iam]
      args[:issuer] = issuer
      args[:signer] = signer
    end

    generated_url = bucket.signed_url(key, **args)

    payload[:url] = generated_url

    generated_url
  end
end