class BackupStorage::Service
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. -
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_services.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.backup_storage.service = :local
If you are using Backup Storage outside of a Ruby on Rails application, you can configure the service to use like this:
BackupStorage::Blob.service = BackupStorage::Service.configure( :Disk, root: Pathname("/foo/bar/storage") )
Public Class Methods
Configure an Backup Storage service by name from a set of configurations, typically loaded from a YAML file. The Backup Storage engine uses this to set the global Backup Storage service when the app boots.
# File lib/backup_storage/service.rb, line 46 def configure(service_name, configurations) Configurator.build(service_name, configurations) end
Public Instance Methods
Delete the file at the `key`.
# File lib/backup_storage/service.rb, line 73 def delete(key) raise NotImplementedError end
Return the content of the file at the `key`.
# File lib/backup_storage/service.rb, line 68 def download(key) raise NotImplementedError end
Return true if a file exists at the `key`.
# File lib/backup_storage/service.rb, line 78 def exist?(key) raise NotImplementedError end
Returns a Hash of headers for `url_for_direct_upload` requests.
# File lib/backup_storage/service.rb, line 98 def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:) {} end
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 `BackupStorage::IntegrityError`.
# File lib/backup_storage/service.rb, line 63 def upload(key, io, checksum: nil) raise NotImplementedError end
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 lib/backup_storage/service.rb, line 85 def url(key, expires_in:, disposition:, filename:, content_type:) raise NotImplementedError end
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 lib/backup_storage/service.rb, line 93 def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) raise NotImplementedError end
Private Instance Methods
# File lib/backup_storage/service.rb, line 103 def instrument(operation, key, payload = {}, &block) ActiveSupport::Notifications.instrument( "service_#{operation}.backup_storage", payload.merge(key: key, service: service_name), &block) end
# File lib/backup_storage/service.rb, line 109 def service_name # BackupStorage::Service::DiskService => Disk self.class.name.split("::").third.remove("Service") end