Class: ActiveStorage::Service::AzureStorageService

Inherits:
ActiveStorage::Service show all
Defined in:
activestorage/lib/active_storage/service/azure_storage_service.rb

Overview

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.

Instance Attribute Summary collapse

Attributes inherited from ActiveStorage::Service

#name

Instance Method Summary collapse

Methods inherited from ActiveStorage::Service

build, configure, #open, #public?, #update_metadata, #url

Methods included from ActiveSupport::Autoload

#autoload, #autoload_at, #autoload_under, #eager_autoload, #eager_load!

Constructor Details

#initialize(storage_account_name:, storage_access_key:, container:, public: false, **options) ⇒ AzureStorageService

Returns a new instance of AzureStorageService.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# 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 "    `ActiveStorage::Service::AzureStorageService` is deprecated and will be\n    removed in Rails 8.1.\n    Please try the `azure-blob` gem instead.\n    This gem is not maintained by the Rails team, so please test your applications before deploying to production.\n  MSG\n\n  @client = Azure::Storage::Blob::BlobService.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key, **options)\n  @signer = Azure::Storage::Common::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)\n  @container = container\n  @public = public\nend\n".squish

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



15
16
17
 
# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 15

def client
  @client
end

#container ⇒ Object (readonly)

Returns the value of attribute container.



15
16
17
 
# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 15

def container
  @container
end

#signer ⇒ Object (readonly)

Returns the value of attribute signer.



15
16
17
 
# File 'activestorage/lib/active_storage/service/azure_storage_service.rb', line 15

def signer
  @signer
end

Instance Method Details

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# 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

#delete(key) ⇒ Object 



65
66
67
68
69
70
71
72
 
# 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

#delete_prefixed(prefix) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# 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

#download(key, &block) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# 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

#download_chunk(key, range) ⇒ Object 



56
57
58
59
60
61
62
63
 
# 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

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
93
94
95
96
 
# 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

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



113
114
115
116
117
 
# 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

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



31
32
33
34
35
36
37
38
39
 
# 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

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# 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