azure-blob 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d8cb5bf91f904bff341c26f5f6b6392abbb14e0de1f092fab8697cabab75b1
-  data.tar.gz: de847a4e6a9925b31ed1900dea10e8e0d078277f4af4e4e7f434b00e4e0bc298
+  metadata.gz: f67999e9a3c71ecac32f52a65dae1e4bf82e76704f97ecdaed08c84b66df5630
+  data.tar.gz: 19fedb6d95a7d1c14da8baa8e3f608b4c3ae8e99f76a68daa5a54efe7213858a
 SHA512:
-  metadata.gz: ef60c4be02b9725ba53209234d471a71451fe7270a58c4fad908c5e06669cb686290cd7ce75e57dfced02fc1d1efee85e3201d0d05b868881abe16e13fb77e68
-  data.tar.gz: 1460b8c46b849b0e1a89e2e628cf20dad0ba223dc3e090e7f8ce3bc16d124db497f0785144eed3a8c48210e2d085bb4c178f74d9ff18c77da98ce21d65f6af45
+  metadata.gz: 42405d38134512ed6ac88372c8a2e7383835e2d3558280b8dad0570532d905c6edaba6bfb84bd3fd2478f3a4456d575da5448bb223e016b89f99a96bd00bcec2
+  data.tar.gz: f5148357bb3ba47ea5d730ebc123a2ab901e8c9380d7c7d6620cf6fd6623ec495f9dc0659434be42458888f6a936ffd221bd9f27591f3fbce2f0b0361fee5b9f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.5.5] 2025-01-10
+
+- Allow lazy loading the signer
+- Add `blob_exist?`
+- Add `container_exist?`
+
 ## [0.5.4] 2024-11-18
 
 - Allow creating public container

data/README.md

@@ -95,6 +95,19 @@ client.delete_blob(path)
 
 For the full list of methods: https://www.rubydoc.info/gems/azure-blob/AzureBlob/Client
 
+## options
+
+### Lazy loading
+
+The client is configured to raise an error early for missing credentials, causing it to crash before becoming healthy. This behavior can sometimes be undesirable, such as during assets precompilation.
+
+To enable lazy loading and ignore missing credentials, set the `lazy` option:
+
+`AzureBlob::Client.new(account_name: nil, access_key: nil, container: nil, lazy: true)`
+
+or add `lazy: true` to your `config/storage.yml` for Active Storage.
+
+
 ## Contributing
 
 ### Dev environment

data/lib/azure_blob/client.rb

@@ -20,18 +20,10 @@ module AzureBlob
       @container = container
       @host = host
       @cloud_regions = options[:cloud_regions]&.to_sym || :global
-
-      no_access_key = access_key.nil? || access_key&.empty?
-      using_managed_identities = no_access_key && !principal_id.nil? || options[:use_managed_identities]
-
-      if !using_managed_identities && no_access_key
-        raise AzureBlob::Error.new(
-          "`access_key` cannot be empty. To use managed identities instead, pass a `principal_id` or set `use_managed_identities` to true."
-        )
-      end
-      @signer = using_managed_identities ?
-        AzureBlob::EntraIdSigner.new(account_name:, host: self.host, principal_id:) :
-        AzureBlob::SharedKeySigner.new(account_name:, access_key:, host: self.host)
+      @access_key = access_key
+      @principal_id = principal_id
+      @use_managed_identities = options[:use_managed_identities]
+      signer unless options[:lazy]
     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.
@@ -150,7 +142,8 @@ module AzureBlob
     #
     # Calls to {Get Blob Properties}[https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties]
     #
-    # This can be used to see if the blob exist or obtain metadata such as content type, disposition, checksum or Azure custom metadata.
+    # This can be used to obtain metadata such as content type, disposition, checksum or Azure custom metadata.
+    # To check for blob presence, look for `blob_exist?` as `get_blob_properties` raises on missing blob.
     def get_blob_properties(key, options = {})
       uri = generate_uri("#{container}/#{key}")
 
@@ -159,6 +152,15 @@ module AzureBlob
       Blob.new(response)
     end
 
+    # Returns a boolean indicating if the blob exists.
+    #
+    # Calls to {Get Blob Properties}[https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties]
+    def blob_exist?(key, options = {})
+      get_blob_properties(key, options).present?
+    rescue AzureBlob::Http::FileNotFoundError
+      false
+    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.
@@ -186,6 +188,13 @@ module AzureBlob
       Container.new(response)
     end
 
+    # Returns a boolean indicating if the container exists.
+    #
+    # Calls to {Get Container Properties}[https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties]
+    def container_exist?(options = {})
+      get_container_properties(options = {}).present?
+    end
+
     # Create the container
     #
     # Calls to {Create Container}[https://learn.microsoft.com/en-us/rest/api/storageservices/create-container]
@@ -364,6 +373,24 @@ module AzureBlob
       @host ||= "https://#{account_name}.blob.#{CLOUD_REGIONS_SUFFIX[cloud_regions]}"
     end
 
-    attr_reader :account_name, :signer, :container, :http, :cloud_regions
+    def signer
+      @signer ||=
+        begin
+          no_access_key = access_key.nil? || access_key&.empty?
+          using_managed_identities = no_access_key && !principal_id.nil? || use_managed_identities
+
+          if !using_managed_identities && no_access_key
+            raise AzureBlob::Error.new(
+              "`access_key` cannot be empty. To use managed identities instead, pass a `principal_id` or set `use_managed_identities` to true."
+            )
+          end
+
+          using_managed_identities ?
+            AzureBlob::EntraIdSigner.new(account_name:, host:, principal_id:) :
+            AzureBlob::SharedKeySigner.new(account_name:, access_key:, host:)
+        end
+    end
+
+    attr_reader :account_name, :container, :http, :cloud_regions, :access_key, :principal_id, :use_managed_identities
   end
 end

data/lib/azure_blob/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-blob
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Joé Dupuis