edge badge

Abstract class serving as an interface for concrete services.

The available services are:

  • Disk, to manage attachments saved directly on the hard drive.

  • GCS, to manage attachments through Google Cloud Storage.

  • S3, to manage attachments through Amazon S3.

  • AzureStorage, to manage attachments through Microsoft Azure Storage.

  • Mirror, to be able to use several services to manage attachments.

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(
  :Disk,
  root: Pathname("/foo/bar/storage")
)
Namespace
Methods
C
D
E
H
O
P
U
Attributes
[RW] name
Class Public methods
configure(service_name, configurations)

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 50
def configure(service_name, configurations)
  Configurator.build(service_name, configurations)
end
Instance Public methods
delete(key)

Delete the file at the key.

# File activestorage/lib/active_storage/service.rb, line 94
def delete(key)
  raise NotImplementedError
end
delete_prefixed(prefix)

Delete files at keys starting with the prefix.

# File activestorage/lib/active_storage/service.rb, line 99
def delete_prefixed(prefix)
  raise NotImplementedError
end
download(key)

Return the content of the file at the key.

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

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

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

Return true if a file exists at the key.

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

Returns a Hash of headers for url_for_direct_upload requests.

# File activestorage/lib/active_storage/service.rb, line 135
def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:)
  {}
end
open(*args, **options, &block)
# File activestorage/lib/active_storage/service.rb, line 89
def open(*args, **options, &block)
  ActiveStorage::Downloader.new(self).open(*args, **options, &block)
end
public?()
# File activestorage/lib/active_storage/service.rb, line 139
def public?
  @public
end
update_metadata(key, **metadata)

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 activestorage/lib/active_storage/service.rb, line 76
def update_metadata(key, **metadata)
end
upload(key, io, checksum: nil, **options)

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 69
def upload(key, io, checksum: nil, **options)
  raise NotImplementedError
end
url(key, **options)

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 must 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 111
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:)

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 activestorage/lib/active_storage/service.rb, line 130
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  raise NotImplementedError
end