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

Methods

Class Public methods

new(public: false, **config)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 10
    def initialize(public: false, **config)
      @config = config
      @public = public
    end
🔎 See on GitHub

Instance Public methods

delete(key)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 59
    def delete(key)
      instrument :delete, key: key do
        file_for(key).delete
      rescue Google::Cloud::NotFoundError
        # Ignore files already deleted
      end
    end
🔎 See on GitHub

delete_prefixed(prefix)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 67
    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
🔎 See on GitHub

download(key, &block)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 28
    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
🔎 See on GitHub

download_chunk(key, range)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 51
    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
🔎 See on GitHub

exist?(key)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 77
    def exist?(key)
      instrument :exist, key: key do |payload|
        answer = file_for(key).exists?
        payload[:exist] = answer
        answer
      end
    end
🔎 See on GitHub

headers_for_direct_upload(key, checksum:, filename: nil, disposition: nil, **)

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

      { "Content-MD5" => checksum, "Content-Disposition" => content_disposition }
    end
🔎 See on GitHub

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

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 42
    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
🔎 See on GitHub

upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil)

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 15
    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
🔎 See on GitHub

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

📝 Source code
# File activestorage/lib/active_storage/service/gcs_service.rb, line 85
    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
🔎 See on GitHub