Active Storage Azure Storage Service

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

Attributes

[R] client
[R] container
[R] signer

Class Public methods

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

📝 Source code
# 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
🔎 See on GitHub

Instance Public methods

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

📝 Source code
# 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
🔎 See on GitHub

delete(key)

📝 Source code
# 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
🔎 See on GitHub

delete_prefixed(prefix)

📝 Source code
# 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
🔎 See on GitHub

download(key, &block)

📝 Source code
# 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
🔎 See on GitHub

download_chunk(key, range)

📝 Source code
# 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
🔎 See on GitHub

exist?(key)

📝 Source code
# 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
🔎 See on GitHub

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

📝 Source code
# 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
🔎 See on GitHub

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

📝 Source code
# 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
🔎 See on GitHub

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

📝 Source code
# 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
🔎 See on GitHub