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 `::Object` ActiveStorage::Service ActiveStorage::Service::AzureStorageService
Defined in:	activestorage/lib/active_storage/service/azure_storage_service.rb

Overview

Active Storage Azure Storage Service

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 Method Summary

.new(storage_account_name:, storage_access_key:, container:, public: false, **options) ⇒ AzureStorageService constructor

`::ActiveStorage::Service` - Inherited

.configure	Configure an Active Storage service by name from a set of configurations, typically loaded from a YAML file.
.build	Override in subclasses that stitch together multiple services and hence need to build additional services using the configurator.

`::ActiveSupport::Autoload` - Extended

autoload, autoload_at, autoload_under, eager_autoload, eager_load!

Instance Attribute Summary

#client readonly
#container readonly
#signer readonly

`::ActiveStorage::Service` - Inherited

#name, #public?

Instance Method Summary

#compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
#delete(key)
#delete_prefixed(prefix)
#download(key, &block)
#download_chunk(key, range)
#exist?(key) ⇒ Boolean
#headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, custom_metadata: {})
#upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
#blob_for(key) private
#custom_metadata_headers(metadata) private
#format_expiry(expires_in) private
#handle_errors private
#private_url(key, expires_in:, filename:, disposition:, content_type:) private
#public_url(key) private
#stream(key) private

Reads the object for the given key in chunks, yielding each to the block.
#uri_for(key) private

`::ActiveStorage::Service` - Inherited

#compose	Concatenate multiple files into a single “composed” file.
#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.
#open,
#update_metadata	Update metadata for the file identified by `key` in the service.
#upload	Upload the `io` to the `key` specified.
#url	Returns the 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`.
#content_disposition_with, #custom_metadata_headers, #instrument, #private_url, #public_url, #service_name

Constructor Details

.new(storage_account_name:, storage_access_key:, container:, public: false, **options) ⇒ `AzureStorageService`

[ GitHub ]

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


def initialize(storage_account_name:, storage_access_key:, container:, public: false, **options)
  ActiveStorage.deprecator.warn <<~MSG.squish
    `ActiveStorage::Service::AzureStorageService` is deprecated and will be
    removed in Rails 8.1.
    Please try the `azure-blob` gem instead.
    This gem is not maintained by the Rails team, so please test your applications before deploying to production.
  MSG

  @client = Azure::Storage::Blob::BlobService.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key, **options)
  @signer = Azure::Storage::Common::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
  @container = container
  @public = public
end

Instance Attribute Details

#client (readonly)

[ GitHub ]

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


attr_reader :client, :container, :signer

#container (readonly)

[ GitHub ]

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


attr_reader :client, :container, :signer

#signer (readonly)

[ GitHub ]

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


attr_reader :client, :container, :signer

Instance Method Details

#blob_for(key) (private)

[ GitHub ]

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


def blob_for(key)
  client.get_blob_properties(container, key)
rescue Azure::Core::Http::HTTPError
  false
end

#compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})

[ GitHub ]

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


def compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
  content_disposition = content_disposition_with(type: disposition, filename: filename) if disposition && filename

  client.create_append_blob(
    container,
    destination_key,
    content_type: content_type,
    content_disposition: content_disposition,
    metadata: custom_metadata,
  ).tap do |blob|
    source_keys.each do |source_key|
      stream(source_key) do |chunk|
        client.append_blob_block(container, blob.name, chunk)
      end
    end
  end
end

#custom_metadata_headers(metadata) (private)

[ GitHub ]

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


def custom_metadata_headers(metadata)
  metadata.transform_keys { |key| "x-ms-meta-#{key}" }
end

#delete(key)

[ GitHub ]

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


def delete(key)
  instrument :delete, key: key do
    client.delete_blob(container, key)
  rescue Azure::Core::Http::HTTPError => e
    raise unless e.type == "BlobNotFound"
    # Ignore files already deleted
  end
end

#delete_prefixed(prefix)

[ GitHub ]

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


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

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

      results.each do |blob|
        client.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 41


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

#download_chunk(key, range)

[ GitHub ]

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


def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    handle_errors do
      _, io = client.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
end

#exist?(key) ⇒ `Boolean`

[ GitHub ]

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


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

#format_expiry(expires_in) (private)

[ GitHub ]

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


def format_expiry(expires_in)
  expires_in ? Time.now.utc.advance(seconds: expires_in).iso8601 : nil
end

#handle_errors (private)

[ GitHub ]

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


def handle_errors
  yield
rescue Azure::Core::Http::HTTPError => e
  case e.type
  when "BlobNotFound"
    raise ActiveStorage::FileNotFoundError
  when "Md5Mismatch"
    raise ActiveStorage::IntegrityError
  else
    raise
  end
end

#headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, custom_metadata: {})

[ GitHub ]

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


def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, custom_metadata: {}, **)
  content_disposition = content_disposition_with(type: disposition, filename: filename) if filename

  { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-content-disposition" => content_disposition, "x-ms-blob-type" => "BlockBlob", **custom_metadata_headers(custom_metadata) }
end

#private_url(key, expires_in:, filename:, disposition:, content_type:) (private)

[ GitHub ]

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


def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
  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
end

#public_url(key) (private)

[ GitHub ]

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


def public_url(key, **)
  uri_for(key).to_s
end

#stream(key) (private)

Reads the object for the given key in chunks, yielding each to the block.

Raises:

(ActiveStorage::FileNotFoundError)

[ GitHub ]

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


def stream(key)
  blob = blob_for(key)

  chunk_size = 5.megabytes
  offset = 0

  raise ActiveStorage::FileNotFoundError unless blob.present?

  while offset < blob.properties[:content_length]
    _, chunk = client.get_blob(container, key, start_range: offset, end_range: offset + chunk_size - 1)
    yield chunk.force_encoding(Encoding::BINARY)
    offset += chunk_size
  end
end

#upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})

[ GitHub ]

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


def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}, **)
  instrument :upload, key: key, checksum: checksum do
    handle_errors do
      content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename

      client.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition, metadata: custom_metadata)
    end
  end
end

#uri_for(key) (private)

[ GitHub ]

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


def uri_for(key)
  client.generate_uri("#{container}/#{key}")
end

#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})

[ GitHub ]

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


def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
  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

Class: ActiveStorage::Service::AzureStorageService

Overview

Active Storage Azure Storage Service

Class Method Summary

::ActiveStorage::Service - Inherited

::ActiveSupport::Autoload - Extended

Instance Attribute Summary

::ActiveStorage::Service - Inherited

Instance Method Summary

::ActiveStorage::Service - Inherited

Constructor Details

.new(storage_account_name:, storage_access_key:, container:, public: false, **options) ⇒ AzureStorageService

Instance Attribute Details

#client (readonly)

#container (readonly)

#signer (readonly)

Instance Method Details

#blob_for(key) (private)

#compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})

#custom_metadata_headers(metadata) (private)

#delete(key)

#delete_prefixed(prefix)

#download(key, &block)

#download_chunk(key, range)

#exist?(key) ⇒ Boolean

#format_expiry(expires_in) (private)

#handle_errors (private)

#headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, custom_metadata: {})

#private_url(key, expires_in:, filename:, disposition:, content_type:) (private)

#public_url(key) (private)

#stream(key) (private)

#upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})

#uri_for(key) (private)

#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})

`::ActiveStorage::Service` - Inherited

`::ActiveSupport::Autoload` - Extended

`::ActiveStorage::Service` - Inherited

`::ActiveStorage::Service` - Inherited

.new(storage_account_name:, storage_access_key:, container:, public: false, **options) ⇒ `AzureStorageService`

#exist?(key) ⇒ `Boolean`