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] client
[R] container
[R] signer
Class Public methods
new(storage_account_name:, storage_access_key:, container:, public: false, **options)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 15
def initialize(storage_account_name:, storage_access_key:, container:, public: false, **options)
  @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 Public methods
delete(key)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 56
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)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 65
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)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 32
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)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 47
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)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 81
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:, filename: nil, disposition: nil, **)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 104
def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **)
  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" }
end
upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 22
def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
  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)
    end
  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 89
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