class ActiveStorage::Service

Abstract class serving as an interface for concrete services.

The available services are:

Inside a Rails 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: <%= Rails.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 Rails application, you can configure the service to use like this:

ActiveStorage::Blob.service = ActiveStorage::Service.configure(
  :local,
  { local: {service: "Disk",  root: Pathname("/tmp/foo/storage") } }
)

Attributes

name[RW]

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 lib/active_storage/service.rb, line 50
def configure(service_name, configurations)
  Configurator.build(service_name, configurations)
end

Public Instance Methods

compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}) click to toggle source

Concatenate multiple files into a single “composed” file.

# File lib/active_storage/service.rb, line 94
def compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
  raise NotImplementedError
end
delete(key) click to toggle source

Delete the file at the key.

# File lib/active_storage/service.rb, line 99
def delete(key)
  raise NotImplementedError
end
delete_prefixed(prefix) click to toggle source

Delete files at keys starting with the prefix.

# File lib/active_storage/service.rb, line 104
def delete_prefixed(prefix)
  raise NotImplementedError
end
download(key) click to toggle source

Return the content of the file at the key.

# File lib/active_storage/service.rb, line 80
def download(key)
  raise NotImplementedError
end
download_chunk(key, range) click to toggle source

Return the partial content in the byte range of the file at the key.

# File lib/active_storage/service.rb, line 85
def download_chunk(key, range)
  raise NotImplementedError
end
exist?(key) click to toggle source

Return true if a file exists at the key.

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

Returns a Hash of headers for url_for_direct_upload requests.

# File lib/active_storage/service.rb, line 141
def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:, custom_metadata: {})
  {}
end
open(*args, **options, &block) click to toggle source
# File lib/active_storage/service.rb, line 89
def open(*args, **options, &block)
  ActiveStorage::Downloader.new(self).open(*args, **options, &block)
end
public?() click to toggle source
# File lib/active_storage/service.rb, line 145
def public?
  @public
end
update_metadata(key, **metadata) click to toggle source

Update metadata for the file identified by key in the service. Override in subclasses only if the service needs to store specific metadata that has to be updated upon identification.

# File lib/active_storage/service.rb, line 76
def update_metadata(key, **metadata)
end
upload(key, io, checksum: nil, **options) 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 lib/active_storage/service.rb, line 69
def upload(key, io, checksum: nil, **options)
  raise NotImplementedError
end
url(key, **options) click to toggle source

Returns the URL for the file at the key. This returns a permanent URL for public files, and returns a short-lived URL for private files. For private files you can provide the disposition (:inline or :attachment), filename, and content_type that you wish the file to be served with on request. Additionally, you can also provide the amount of seconds the URL will be valid for, specified in expires_in.

# File lib/active_storage/service.rb, line 117
def url(key, **options)
  instrument :url, key: key do |payload|
    generated_url =
      if public?
        public_url(key, **options)
      else
        private_url(key, **options)
      end

    payload[:url] = generated_url

    generated_url
  end
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {}) 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 must 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 lib/active_storage/service.rb, line 136
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
  raise NotImplementedError
end

Private Instance Methods

content_disposition_with(type: "inline", filename:) click to toggle source
# File lib/active_storage/service.rb, line 173
def content_disposition_with(type: "inline", filename:)
  disposition = (type.to_s.presence_in(%w( attachment inline )) || "inline")
  ActionDispatch::Http::ContentDisposition.format(disposition: disposition, filename: filename.sanitized)
end
custom_metadata_headers(metadata) click to toggle source
# File lib/active_storage/service.rb, line 158
def custom_metadata_headers(metadata)
  raise NotImplementedError
end
instrument(operation, payload = {}, &block) click to toggle source
# File lib/active_storage/service.rb, line 162
def instrument(operation, payload = {}, &block)
  ActiveSupport::Notifications.instrument(
    "service_#{operation}.active_storage",
    payload.merge(service: service_name), &block)
end
private_url(key, expires_in:, filename:, disposition:, content_type:, **) click to toggle source
# File lib/active_storage/service.rb, line 150
def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
  raise NotImplementedError
end
public_url(key, **) click to toggle source
# File lib/active_storage/service.rb, line 154
def public_url(key, **)
  raise NotImplementedError
end
service_name() click to toggle source
# File lib/active_storage/service.rb, line 168
def service_name
  # ActiveStorage::Service::DiskService => Disk
  self.class.name.split("::").third.remove("Service")
end