class ActiveStorage::Service::AzureStorageService

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.

Attributes

blobs[R]
client[R]
container[R]
path[R]
signer[R]

Public Class Methods

new(path:, storage_account_name:, storage_access_key:, container:) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 13
def initialize(path:, storage_account_name:, storage_access_key:, container:)
  @client = Azure::Storage::Client.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key)
  @signer = Azure::Storage::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
  @blobs = client.blob_client
  @container = container
  @path = path
end

Public Instance Methods

delete(key) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 44
def delete(key)
  instrument :delete, key do
    begin
      blobs.delete_blob(container, key)
    rescue Azure::Core::Http::HTTPError
      false
    end
  end
end
download(key) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 31
def download(key)
  if block_given?
    instrument :streaming_download, key do
      stream(key, &block)
    end
  else
    instrument :download, key do
      _, io = blobs.get_blob(container, key)
      io.force_encoding(Encoding::BINARY)
    end
  end
end
exist?(key) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 54
def exist?(key)
  instrument :exist, key do |payload|
    answer = blob_for(key).present?
    payload[:exist] = answer
    answer
  end
end
headers_for_direct_upload(key, content_type:, checksum:, **) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 91
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) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 21
def upload(key, io, checksum: nil)
  instrument :upload, key, checksum: checksum do
    begin
      blobs.create_block_blob(container, key, io, content_md5: checksum)
    rescue Azure::Core::Http::HTTPError
      raise ActiveStorage::IntegrityError
    end
  end
end
url(key, expires_in:, filename:, disposition:, content_type:) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 62
def url(key, expires_in:, filename:, disposition:, content_type:)
  instrument :url, key do |payload|
    base_url = url_for(key)
    generated_url = signer.signed_uri(
      URI(base_url), false,
      permissions: "r",
      expiry: format_expiry(expires_in),
      content_disposition: disposition,
      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:) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 79
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key do |payload|
    base_url = url_for(key)
    generated_url = signer.signed_uri(URI(base_url), false, permissions: "rw",
      expiry: format_expiry(expires_in)).to_s

    payload[:url] = generated_url

    generated_url
  end
end

Private Instance Methods

blob_for(key) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 100
def blob_for(key)
  blobs.get_blob_properties(container, key)
rescue Azure::Core::Http::HTTPError
  false
end
format_expiry(expires_in) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 106
def format_expiry(expires_in)
  expires_in ? Time.now.utc.advance(seconds: expires_in).iso8601 : nil
end
stream(key, options = {}) { |io| ... } click to toggle source

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

# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 111
def stream(key, options = {}, &block)
  blob = blob_for(key)

  chunk_size = 5.megabytes
  offset = 0

  while offset < blob.properties[:content_length]
    _, io = blobs.get_blob(container, key, start_range: offset, end_range: offset + chunk_size - 1)
    yield io
    offset += chunk_size
  end
end
url_for(key) click to toggle source
# File activestorage/lib/active_storage/service/azure_storage_service.rb, line 96
def url_for(key)
  "#{path}/#{container}/#{key}"
end