123456789_123456789_123456789_123456789_123456789_

Class: ActiveStorage::Service::AzureStorageService

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/azure_storage_service.rb

Overview

Wraps the Microsoft Azure Storage Blob ::ActiveStorage::Service as an Active Storage service. See ::ActiveStorage::Service for the generic API documentation that applies to all services.

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(storage_account_name:, storage_access_key:, container:, **options) ⇒ AzureStorageService

[ GitHub ] 

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 13



def initialize(storage_account_name:, storage_access_key:, container:, **options)
  @client = Azure::Storage::Client.create(storage_account_name: , storage_access_key: storage_access_key, **options)
  @signer = Azure::Storage::Core::Auth::SharedAccessSignature.new(, storage_access_key)
  @blobs = client.blob_client
  @container = container
end


  







Instance Attribute Details



  

    #blobs   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 11



attr_reader :client, :blobs, :container, :signer


  








  

    #client   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 11



attr_reader :client, :blobs, :container, :signer


  








  

    #container   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 11



attr_reader :client, :blobs, :container, :signer


  








  

    #signer   (readonly)
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 11



attr_reader :client, :blobs, :container, :signer


  







Instance Method Details



  

    #delete(key)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 50



def delete(key)
  instrument :delete, key: key do
    begin
      blobs.delete_blob(container, key)
    rescue Azure::Core::Http::HTTPError
      # Ignore files already deleted
    end
  end
end


  








  

    #delete_prefixed(prefix)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 60



def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    marker = nil

    loop do
      results = blobs.list_blobs(container, prefix: prefix, marker: marker)

      results.each do |blob|
        blobs.delete_blob(container, blob.name)
      end

      break unless marker = results.continuation_token.presence
    end
  end
end


  








  

    #download(key, &block)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 30



def download(key, &block)
  if block_given?
    instrument :streaming_download, key: key do
      stream(key, &block)
    end
  else
    instrument :download, key: key do
      _, io = blobs.get_blob(container, key)
      io.force_encoding(Encoding::BINARY)
    end
  end
end


  








  

    #download_chunk(key, range)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 43



def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    _, io = blobs.get_blob(container, key, start_range: range.begin, end_range: range.exclude_end? ? range.end - 1 : range.end)
    io.force_encoding(Encoding::BINARY)
  end
end


  








  

    #exist?(key)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 76



def exist?(key)
  instrument :exist, key: key do |payload|
    answer = blob_for(key).present?
    payload[:exist] = answer
    answer
  end
end


  








  

    #headers_for_direct_upload(key, content_type:, checksum:)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 116



def headers_for_direct_upload(key, content_type:, checksum:, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-type" => "BlockBlob" }
end


  








  

    #upload(key, io, checksum: nil)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 20



def upload(key, io, checksum: nil, **)
  instrument :upload, key: key, checksum: checksum do
    begin
      blobs.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum)
    rescue Azure::Core::Http::HTTPError
      raise ActiveStorage::IntegrityError
    end
  end
end


  








  

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

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 84



def url(key, expires_in:, filename:, disposition:, content_type:)
  instrument :url, key: key do |payload|
    generated_url = signer.signed_uri(
      uri_for(key), false,
      service: "b",
      permissions: "r",
      expiry: format_expiry(expires_in),
      content_disposition: content_disposition_with(type: disposition, filename: filename),
      content_type: content_type
    ).to_s

    payload[:url] = generated_url

    generated_url
  end
end


  








  

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

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 101



def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key: key do |payload|
    generated_url = signer.signed_uri(
      uri_for(key), false,
      service: "b",
      permissions: "rw",
      expiry: format_expiry(expires_in)
    ).to_s

    payload[:url] = generated_url

    generated_url
  end
end