edge badge

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

Methods
D
E
H
N
U
Attributes
[R] blobs
[R] client
[R] container
[R] signer
Class Public methods
new(storage_account_name:, storage_access_key:, container:, **options)
# 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_account_name, storage_access_key: storage_access_key, **options)
  @signer = Azure::Storage::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
  @blobs = client.blob_client
  @container = container
end
Instance Public methods
delete(key)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 52
def delete(key)
  instrument :delete, key: key do
    blobs.delete_blob(container, key)
  rescue Azure::Core::Http::HTTPError => e
    raise unless e.type == "BlobNotFound"
    # Ignore files already deleted
  end
end
delete_prefixed(prefix)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 61
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)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 28
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 = blobs.get_blob(container, key)
        io.force_encoding(Encoding::BINARY)
      end
    end
  end
end
download_chunk(key, range)
# 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
    handle_errors 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
end
exist?(key)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 77
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:, **)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 117
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, **)
# 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
    handle_errors do
      blobs.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum)
    end
  end
end
url(key, expires_in:, filename:, disposition:, content_type:)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 85
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:)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 102
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