Class: ActiveStorage::Service

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::Autoload
Defined in:
lib/active_storage/service.rb

Overview

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")
)

Defined Under Namespace

Classes: AzureStorageService, Configurator, DiskService, GCSService, MirrorService, S3Service

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.build(configurator:, service: nil, **service_config) ⇒ Object

Override in subclasses that stitch together multiple services and hence need to build additional services using the configurator.

Passes the configurator and all of the service's config as keyword args.

See MirrorService for an example.



60
61
62
 
# File 'lib/active_storage/service.rb', line 60

def build(configurator:, service: nil, **service_config) #:nodoc:
  new(**service_config)
end

.configure(service_name, configurations) ⇒ Object

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.



50
51
52
 
# File 'lib/active_storage/service.rb', line 50

def configure(service_name, configurations)
  Configurator.build(service_name, configurations)
end

Instance Method Details

#delete(key) ⇒ Object

Delete the file at the key.

Raises:

  • (NotImplementedError) 


88
89
90
 
# File 'lib/active_storage/service.rb', line 88

def delete(key)
  raise NotImplementedError
end

#delete_prefixed(prefix) ⇒ Object

Delete files at keys starting with the prefix.

Raises:

  • (NotImplementedError) 


93
94
95
 
# File 'lib/active_storage/service.rb', line 93

def delete_prefixed(prefix)
  raise NotImplementedError
end

#download(key) ⇒ Object

Return the content of the file at the key.

Raises:

  • (NotImplementedError) 


78
79
80
 
# File 'lib/active_storage/service.rb', line 78

def download(key)
  raise NotImplementedError
end

#download_chunk(key, range) ⇒ Object

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

Raises:

  • (NotImplementedError) 


83
84
85
 
# File 'lib/active_storage/service.rb', line 83

def download_chunk(key, range)
  raise NotImplementedError
end

#exist?(key) ⇒ Boolean

Return true if a file exists at the key.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


98
99
100
 
# File 'lib/active_storage/service.rb', line 98

def exist?(key)
  raise NotImplementedError
end

#headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:) ⇒ Object

Returns a Hash of headers for url_for_direct_upload requests.



118
119
120
 
# File 'lib/active_storage/service.rb', line 118

def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:)
  {}
end

#update_metadata(key, **metadata) ⇒ Object

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.



74
75
 
# File 'lib/active_storage/service.rb', line 74

def update_metadata(key, **metadata)
end

#upload(key, io, checksum: nil, **options) ⇒ Object

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.

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/active_storage/service.rb', line 67

def upload(key, io, checksum: nil, **options)
  raise NotImplementedError
end

#url(key, expires_in:, disposition:, filename:, content_type:) ⇒ Object

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.

Raises:

  • (NotImplementedError) 


105
106
107
 
# File 'lib/active_storage/service.rb', line 105

def url(key, expires_in:, disposition:, filename:, content_type:)
  raise NotImplementedError
end

#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) ⇒ Object

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.

Raises:

  • (NotImplementedError) 


113
114
115
 
# File 'lib/active_storage/service.rb', line 113

def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  raise NotImplementedError
end