class ActiveStorage::Service

Abstract class serving as an interface for concrete services.

The available services are:

Inside a Quails application, you can set-up your services through the generated config/storage.yml file and reference one of the aforementioned constant under the service key. For example:

local:
  service: Disk
  root: <%= Quails.root.join("storage") %>

You can checkout the service's constructor to know which keys are required.

Then, in your application's configuration, you can specify the service to use like this:

config.active_storage.service = :local

If you are using Active Storage outside of a Ruby on Quails application, you can configure the service to use like this:

ActiveStorage::Blob.service = ActiveStorage::Service.configure(
  :Disk,
  root: Pathname("/foo/bar/storage")
)

Public Class Methods

configure(service_name, configurations) click to toggle source

Configure an Active Storage service by name from a set of configurations, typically loaded from a YAML file. The Active Storage engine uses this to set the global Active Storage service when the app boots.

# File activestorage/lib/active_storage/service.rb, line 49
def configure(service_name, configurations)
  Configurator.build(service_name, configurations)
end

Public Instance Methods

delete(key) click to toggle source

Delete the file at the key.

# File activestorage/lib/active_storage/service.rb, line 76
def delete(key)
  raise NotImplementedError
end
download(key) click to toggle source

Return the content of the file at the key.

# File activestorage/lib/active_storage/service.rb, line 71
def download(key)
  raise NotImplementedError
end
exist?(key) click to toggle source

Return true if a file exists at the key.

# File activestorage/lib/active_storage/service.rb, line 81
def exist?(key)
  raise NotImplementedError
end
headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:) click to toggle source

Returns a Hash of headers for url_for_direct_upload requests.

# File activestorage/lib/active_storage/service.rb, line 101
def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:)
  {}
end
upload(key, io, checksum: nil) click to toggle source

Upload the io to the key specified. If a checksum is provided, the service will ensure a match when the upload has completed or raise an ActiveStorage::IntegrityError.

# File activestorage/lib/active_storage/service.rb, line 66
def upload(key, io, checksum: nil)
  raise NotImplementedError
end
url(key, expires_in:, disposition:, filename:, content_type:) click to toggle source

Returns a signed, temporary URL for the file at the key. The URL will be valid for the amount of seconds specified in expires_in. You most also provide the disposition (:inline or :attachment), filename, and content_type that you wish the file to be served with on request.

# File activestorage/lib/active_storage/service.rb, line 88
def url(key, expires_in:, disposition:, filename:, content_type:)
  raise NotImplementedError
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) click to toggle source

Returns a signed, temporary URL that a direct upload file can be PUT to on the key. The URL will be valid for the amount of seconds specified in expires_in. You most also provide the content_type, content_length, and checksum of the file that will be uploaded. All these attributes will be validated by the service upon upload.

# File activestorage/lib/active_storage/service.rb, line 96
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  raise NotImplementedError
end

Private Instance Methods

instrument(operation, key, payload = {}, &block) click to toggle source
# File activestorage/lib/active_storage/service.rb, line 106
def instrument(operation, key, payload = {}, &block)
  ActiveSupport::Notifications.instrument(
    "service_#{operation}.active_storage",
    payload.merge(key: key, service: service_name), &block)
end
service_name() click to toggle source
# File activestorage/lib/active_storage/service.rb, line 112
def service_name
  # ActiveStorage::Service::DiskService => Disk
  self.class.name.split("::").third.remove("Service")
end