Class: Service::AzureBlobService

Inherits:
Service
  • Object
show all
Defined in:
lib/active_storage/service/azure_blob_service.rb

Overview

Active Storage Azure Blob Service

Wraps the Microsoft Azure Storage Blob Service as an Active Storage service. See ActiveStorage::Service for more details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(storage_account_name:, storage_access_key: nil, container:, storage_blob_host: nil, public: false, **options) ⇒ AzureBlobService

Returns a new instance of AzureBlobService.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 38

def initialize(storage_account_name:, storage_access_key: nil, container:, storage_blob_host: nil, public: false, **options)
  @container = container
  @public = public
  @client = AzureBlob::Client.new(
    account_name: ,
    access_key: storage_access_key,
    container: container,
    host: storage_blob_host,
    **options)
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



36
37
38
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 36

def client
  @client
end

#container ⇒ Object (readonly)

Returns the value of attribute container.



36
37
38
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 36

def container
  @container
end

#signer ⇒ Object (readonly)

Returns the value of attribute signer.



36
37
38
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 36

def signer
  @signer
end

Instance Method Details

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 123

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

  # use copy_blob operation if composing a new blob from a single existing blob
  # and that single blob is <= 256 MiB which is the upper limit for copy_blob operation
  if source_keys.length == 1 && client.get_blob_properties(source_keys[0]).size <= 256.megabytes
    client.copy_blob(destination_key, source_keys[0], metadata: custom_metadata)
  else
    client.create_append_blob(
      destination_key,
      content_type: content_type,
      content_disposition: content_disposition,
      metadata: custom_metadata,
    )

    source_keys.each do |source_key|
      stream(source_key) do |chunk|
        client.append_blob_block(destination_key, chunk)
      end
    end
  end
end

#delete(key) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 83

def delete(key)
  instrument :delete, key: key do
    client.delete_blob(key)
  rescue AzureBlob::Http::FileNotFoundError
    # Ignore files already deleted
  end
end

#delete_prefixed(prefix) ⇒ Object 



91
92
93
94
95
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 91

def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    client.delete_prefix(prefix)
  end
end

#download(key, &block) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 59

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(key)
        io.force_encoding(Encoding::BINARY)
      end
    end
  end
end

#download_chunk(key, range) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 74

def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    handle_errors do
      io = client.get_blob(key, start: range.begin, end: range.exclude_end? ? range.end - 1 : range.end)
      io.force_encoding(Encoding::BINARY)
    end
  end
end

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 97

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

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



117
118
119
120
121
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 117

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

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 49

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(key, IO.try_convert(io) || io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition, metadata: custom_metadata)
    end
  end
end

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



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/active_storage/service/azure_blob_service.rb', line 103

def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
  instrument :url, key: key do |payload|
    generated_url = client.signed_uri(
      key,
      permissions: "rw",
      expiry: format_expiry(expires_in)
    ).to_s

    payload[:url] = generated_url

    generated_url
  end
end