123456789_123456789_123456789_123456789_123456789_

Class: ActiveStorage::Service::MirrorService

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveStorage::Service, ::ActiveSupport::Autoload
Instance Chain:
self, ::ActiveStorage::Service
Inherits: ActiveStorage::Service
Defined in: activestorage/lib/active_storage/service/mirror_service.rb

Overview

Wraps a set of mirror services and provides a single ::ActiveStorage::Service object that will all have the files uploaded to them. A #primary service is designated to answer calls to #download, exists?, and #url.

Class Attribute Summary

::ActiveStorage::Service - Inherited

.url_expires_in, .url_expires_in?

Class Method Summary

::ActiveStorage::Service - Inherited

.configure

Configure an Active Storage service by name from a set of configurations, typically loaded from a YAML file.

::ActiveSupport::Autoload - Extended

autoload, autoload_at, autoload_under, autoloads, eager_autoload, eager_load!

Instance Attribute Summary

::ActiveStorage::Service - Inherited

#url_expires_in, #url_expires_in?

Instance Method Summary

::ActiveStorage::Service - Inherited

#delete

Delete the file at the key.
#delete_prefixed

Delete files at keys starting with the prefix.
#download

Return the content of the file at the key.
#download_chunk

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

Return true if a file exists at the key.
#headers_for_direct_upload

Returns a ::Hash of headers for #url_for_direct_upload requests.
#update_metadata

Update metadata for the file identified by key in the service.
#upload

Upload the io to the key specified.
#url

Returns a signed, temporary URL for the file at the key.
#url_for_direct_upload

Returns a signed, temporary URL that a direct upload file can be PUT to on the key.

Constructor Details

.new(primary:, mirrors:) ⇒ MirrorService

[ GitHub ] 

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 21



def initialize(primary:, mirrors:)
  @primary, @mirrors = primary, mirrors
end


  







Instance Attribute Details



  

    #download   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 12



delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary


  








  

    #download_chunk   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 12



delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary


  








  

    #mirrors   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 10



attr_reader :primary, :mirrors


  








  

    #path_for   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 12



delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary


  








  

    #primary   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 10



attr_reader :primary, :mirrors


  








  

    #url   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 12



delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary


  







Instance Method Details



  

    #delete(key)  
  



  

    

Delete the file at the key on all services.


  



  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 34



def delete(key)
  perform_across_services :delete, key
end


  








  

    #delete_prefixed(prefix)  
  



  

    

Delete files at keys starting with the prefix on all services.


  



  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 39



def delete_prefixed(prefix)
  perform_across_services :delete_prefixed, prefix
end


  








  

    #exist?  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 12



delegate :download, :download_chunk, :exist?, :url, :path_for, to: :primary


  








  

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



  

    

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


  



  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/mirror_service.rb', line 27



def upload(key, io, checksum: nil, **options)
  each_service.collect do |service|
    service.upload key, io.tap(&:rewind), checksum: checksum, **options
  end
end