azure-blob 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72003b15ad78aeab66adc7aca2e6786ae2921ad1469cf94145e049705f52c33c
-  data.tar.gz: a77f87dff2f59a22476f0c5e490540a73166cf88dbf3616de8a15a87132aaa5f
+  metadata.gz: 15d8cb5bf91f904bff341c26f5f6b6392abbb14e0de1f092fab8697cabab75b1
+  data.tar.gz: de847a4e6a9925b31ed1900dea10e8e0d078277f4af4e4e7f434b00e4e0bc298
 SHA512:
-  metadata.gz: 910c2d759b83d7b56168fd42a239ffb5da1b4aced25b8f39bc84a1beb63e736690a72586f64313d5fcebf7250808b27d15e23450e850635e24558891eed375ff
-  data.tar.gz: 2d4ecfb6e3e5318d8c6cb07569da7b83bccd49ee3a7d153d43c41e655474dcd43d7a73d28d68fb2baa4124326a1b41562275314348730250610420640c3dc3bd
+  metadata.gz: ef60c4be02b9725ba53209234d471a71451fe7270a58c4fad908c5e06669cb686290cd7ce75e57dfced02fc1d1efee85e3201d0d05b868881abe16e13fb77e68
+  data.tar.gz: 1460b8c46b849b0e1a89e2e628cf20dad0ba223dc3e090e7f8ce3bc16d124db497f0785144eed3a8c48210e2d085bb4c178f74d9ff18c77da98ce21d65f6af45

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.5.4] 2024-11-18
+
+- Allow creating public container
+- Add Azurite support
+
+## [0.5.3] 2024-10-31
+
+- Add support for setting tags when uploading a blob
+- Add get_blob_tags
 
 ## [0.5.2] 2024-09-12
 

data/README.md

@@ -46,6 +46,30 @@ prod:
   principal_id: 71b34410-4c50-451d-b456-95ead1b18cce
 ```
 
+### Azurite
+
+To use Azurite, pass the `storage_blob_host` config key with the Azurite URL (`http://127.0.0.1:10000/devstoreaccount1` by default)
+and the Azurite credentials (`devstoreaccount1` and `Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==` by default).
+
+Example:
+
+```
+dev:
+  service: AzureBlob
+  container: container_name
+  storage_account_name: devstoreaccount1
+  storage_access_key: "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
+  storage_blob_host: http://127.0.0.1:10000/devstoreaccount1
+```
+
+You'll have to create the container before you can start uploading files.
+You can do so using Azure CLI, Azure Storage Explorer, or by running:
+
+`bin/rails runner "ActiveStorage::Blob.service.client.tap{|client| client.create_container unless client.get_container_properties.present?}.tap { |client| puts 'done!' if client.get_container_properties.present?}"`
+
+Make sure that `config.active_storage.service = :dev` is set to your azurite configuration.
+Container names can't have any special characters, or you'll get an error.
+
 ## Standalone
 
 Instantiate a client with your account name, an access key and the container name:

data/Rakefile

@@ -5,6 +5,7 @@ require "minitest/test_task"
 require "azure_blob"
 require_relative "test/support/app_service_vpn"
 require_relative "test/support/azure_vm_vpn"
+require_relative "test/support/azurite"
 
 Minitest::TestTask.create(:test_rails) do
   self.test_globs = [ "test/rails/**/test_*.rb",
@@ -39,6 +40,28 @@ ensure
   vpn.kill
 end
 
+task :test_azurite do |t|
+  azurite = Azurite.new
+  # Azurite well-known credentials
+  # https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage#well-known-storage-account-and-key
+  account_name = ENV["AZURE_ACCOUNT_NAME"] = "devstoreaccount1"
+  access_key = ENV["AZURE_ACCESS_KEY"] = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
+  host = ENV["STORAGE_BLOB_HOST"] = "http://127.0.0.1:10000/devstoreaccount1"
+  ENV["TESTING_AZURITE"] = "true"
+
+  # Create containers
+  private_container = AzureBlob::Client.new(account_name:, access_key:, host:, container: ENV["AZURE_PRIVATE_CONTAINER"])
+  public_container = AzureBlob::Client.new(account_name:, access_key:, host:, container: ENV["AZURE_PUBLIC_CONTAINER"])
+  # public_container.delete_container
+  private_container.create_container unless private_container.get_container_properties.present?
+  public_container.create_container(public_access: true) unless public_container.get_container_properties.present?
+
+  Rake::Task["test_client"].execute
+  Rake::Task["test_rails"].execute
+ensure
+  azurite.kill
+end
+
 task :test_entra_id do |t|
   ENV["AZURE_ACCESS_KEY"] = nil
   Rake::Task["test"].execute

data/lib/active_storage/service/azure_blob_service.rb

@@ -35,13 +35,14 @@ module ActiveStorage
   class Service::AzureBlobService < Service
     attr_reader :client, :container, :signer
 
-    def initialize(storage_account_name:, storage_access_key: nil, container:, public: false, **options)
+    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: storage_account_name,
         access_key: storage_access_key,
         container: container,
+        host: storage_blob_host,
         **options)
     end
 

data/lib/azure_blob/client.rb

@@ -4,6 +4,7 @@ require_relative "block_list"
 require_relative "blob_list"
 require_relative "blob"
 require_relative "container"
+require_relative "tags"
 require_relative "http"
 require_relative "shared_key_signer"
 require_relative "entra_id_signer"
@@ -14,9 +15,10 @@ module AzureBlob
   # AzureBlob Client class. You interact with the Azure Blob api
   # through an instance of this class.
   class Client
-    def initialize(account_name:, access_key: nil, principal_id: nil, container:, **options)
+    def initialize(account_name:, access_key: nil, principal_id: nil, container:, host: nil, **options)
       @account_name = account_name
       @container = container
+      @host = host
       @cloud_regions = options[:cloud_regions]&.to_sym || :global
 
       no_access_key = access_key.nil? || access_key&.empty?
@@ -28,8 +30,8 @@ module AzureBlob
         )
       end
       @signer = using_managed_identities ?
-        AzureBlob::EntraIdSigner.new(account_name:, host:, principal_id: ) :
-        AzureBlob::SharedKeySigner.new(account_name:, access_key:)
+        AzureBlob::EntraIdSigner.new(account_name:, host: self.host, principal_id:) :
+        AzureBlob::SharedKeySigner.new(account_name:, access_key:, host: self.host)
     end
 
     # Create a blob of type block. Will automatically split the the blob in multiple block and send the blob in pieces (blocks) if the blob is too big.
@@ -157,6 +159,20 @@ module AzureBlob
       Blob.new(response)
     end
 
+    # Returns the tags associated with a blob
+    #
+    # Calls to the {Get Blob Tags}[https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-tags] endpoint.
+    #
+    # Takes a key (path) of the blob.
+    #
+    # Returns a hash of the blob's tags.
+    def get_blob_tags(key)
+      uri = generate_uri("#{container}/#{key}?comp=tags")
+      response = Http.new(uri, signer:).get
+
+      Tags.from_response(response).to_h
+    end
+
     # Returns a Container object.
     #
     # Calls to {Get Container Properties}[https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties]
@@ -175,8 +191,12 @@ module AzureBlob
     # Calls to {Create Container}[https://learn.microsoft.com/en-us/rest/api/storageservices/create-container]
     def create_container(options = {})
       uri = generate_uri(container)
+      headers = {}
+      headers[:"x-ms-blob-public-access"] = "blob" if options[:public_access]
+      headers[:"x-ms-blob-public-access"] = options[:public_access] if ["container","blob"].include?(options[:public_access])
+
       uri.query = URI.encode_www_form(restype: "container")
-      response = Http.new(uri, signer:).put
+      response = Http.new(uri, headers, signer:).put
     end
 
     # Delete the container
@@ -230,7 +250,7 @@ module AzureBlob
         "x-ms-blob-content-disposition": options[:content_disposition],
       }
 
-      Http.new(uri, headers, metadata: options[:metadata], signer:).put(nil)
+      Http.new(uri, headers, signer:, **options.slice(:metadata, :tags)).put(nil)
     end
 
     # Append a block to an Append Blob
@@ -305,7 +325,7 @@ module AzureBlob
         "x-ms-blob-content-disposition": options[:content_disposition],
       }
 
-      Http.new(uri, headers, metadata: options[:metadata], signer:).put(content)
+      Http.new(uri, headers, signer:, **options.slice(:metadata, :tags)).put(content)
     end
 
     private
@@ -337,7 +357,7 @@ module AzureBlob
         "x-ms-blob-content-disposition": options[:content_disposition],
       }
 
-      Http.new(uri, headers, metadata: options[:metadata], signer:).put(content.read)
+      Http.new(uri, headers, signer:, **options.slice(:metadata, :tags)).put(content.read)
     end
 
     def host

data/lib/azure_blob/http.rb

@@ -24,12 +24,16 @@ module AzureBlob
 
     include REXML
 
-    def initialize(uri, headers = {}, signer: nil, metadata: {}, debug: false, raise_on_error: true)
+    def initialize(uri, headers = {}, signer: nil, metadata: {}, tags: {}, debug: false, raise_on_error: true)
       @raise_on_error = raise_on_error
       @date = Time.now.httpdate
       @uri = uri
       @signer = signer
-      @headers = headers.merge(Metadata.new(metadata).headers)
+      @headers = headers.merge(
+        Metadata.new(metadata).headers,
+        Tags.new(tags).headers,
+      )
+
       sanitize_headers
 
       @http = Net::HTTP.new(uri.hostname, uri.port)

data/lib/azure_blob/shared_key_signer.rb

@@ -7,9 +7,11 @@ require_relative "canonicalized_resource"
 
 module AzureBlob
   class SharedKeySigner # :nodoc:
-    def initialize(account_name:, access_key:)
+    def initialize(account_name:, access_key:, host:)
       @account_name = account_name
       @access_key = Base64.decode64(access_key)
+      @host = host
+      @remove_prefix = @host.include?("/#{@account_name}")
     end
 
     def authorization_header(uri:, verb:, headers: {})
@@ -39,6 +41,11 @@ module AzureBlob
     end
 
     def sas_token(uri, options = {})
+      if remove_prefix
+        uri = uri.clone
+        uri.path = uri.path.delete_prefix("/#{account_name}")
+      end
+
       to_sign = [
         options[:permissions],
         options[:start],
@@ -99,6 +106,6 @@ module AzureBlob
       end
     end
 
-    attr_reader :access_key, :account_name
+    attr_reader :access_key, :account_name, :remove_prefix
   end
 end

data/lib/azure_blob/tags.rb

@@ -0,0 +1,35 @@
+require "rexml/document"
+
+module AzureBlob
+  class Tags # :nodoc:
+    def self.from_response(response)
+      document = REXML::Document.new(response)
+      tags = {}
+      document.elements.each("Tags/TagSet/Tag") do |tag|
+        key = tag.elements["Key"].text
+        value = tag.elements["Value"].text
+        tags[key] = value
+      end
+      new(tags)
+    end
+
+    def initialize(tags = nil)
+      @tags = tags || {}
+    end
+
+    def headers
+      return {} if @tags.empty?
+
+      {
+        "x-ms-tags":
+        @tags.map do |key, value|
+          %(#{key}=#{value})
+        end.join("&"),
+      }
+    end
+
+    def to_h
+      @tags
+    end
+  end
+end

data/lib/azure_blob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AzureBlob
-  VERSION = "0.5.2"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-blob
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Joé Dupuis
@@ -51,6 +51,7 @@ files:
 - lib/azure_blob/identity_token.rb
 - lib/azure_blob/metadata.rb
 - lib/azure_blob/shared_key_signer.rb
+- lib/azure_blob/tags.rb
 - lib/azure_blob/user_delegation_key.rb
 - lib/azure_blob/version.rb
 homepage: https://github.com/testdouble/azure-blob