azure-blob 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 363606d640d9841d39afc55797fde060f8a706bf0bbc85b9c6e2c1d0f51e40bb
-  data.tar.gz: 4f6d315afcece7d4499891bf727311c7a79551fd3d8aaca3ed8d85d662c51ae0
+  metadata.gz: 0fd3246ce35e01647d7aaa6e5819320799d347a96d0b95b9bc4d4d89939ce9a1
+  data.tar.gz: b6ace232dddeed3415294e866115420a91935b7332c79494e5b17c9a2e91eb52
 SHA512:
-  metadata.gz: 9ca4c5a7146c9a9d684c53a403e5d3270e1f6c0d51211bd467f297124e5771971840c78faa468ef620158ce98f7353097d6db66b830c59c34b4dab852985674f
-  data.tar.gz: 1d452597c9d69a8d2b4dd97f06ab70d1c3d09a7dfe316ea98853dfd709b565bf0f3d6e605dc256fdfa5c73d93cd56643e8f034d054a27c7d8c1dab5914ff00f0
+  metadata.gz: f375dca9e699671f5fc165b8463b313f1cc823d5cb6f3f0666cffc22665fa7becb7d075f61dd0cbb131cf85ddc14c47b37b236d6d28b276b2d13b89cc7626660
+  data.tar.gz: 06bfe2d031d6deb2a58da359258df5923ffab3c23d6edf0a36ee4adb93ee4ac69a82d50d571e97b4cfdff10913f2e6c4a834f5338258c33f0b0a0336de1cde17

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.7.0] 2025-01-05
+
+- Add optional `timeout` parameter to all API methods
+- Add `AzureBlob::Http::TimeoutError` for handling Azure `OperationTimedOut` errors
+
 ## [0.6.0] 2025-12-01
 
 - Add support for AKS workload identity

data/lib/azure_blob/client.rb

@@ -70,6 +70,7 @@ module AzureBlob
     #   Ending point in bytes
     def get_blob(key, options = {})
       uri = generate_uri("#{container}/#{key}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       headers = {
         "x-ms-range": options[:start] && "bytes=#{options[:start]}-#{options[:end]}",
@@ -92,6 +93,7 @@ module AzureBlob
     def copy_blob(key, source_key, options = {})
       source_client = options.delete(:source_client) || self
       uri = generate_uri("#{container}/#{key}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       source_uri = source_client.signed_uri(source_key, permissions: "r", expiry: Time.at(Time.now.to_i + 300).utc.iso8601)
 
@@ -114,6 +116,7 @@ module AzureBlob
     #   Sets the value of the x-ms-delete-snapshots header. Default to +include+
     def delete_blob(key, options = {})
       uri = generate_uri("#{container}/#{key}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       headers = {
         "x-ms-delete-snapshots": options[:delete_snapshots] || "include",
@@ -152,6 +155,7 @@ module AzureBlob
         prefix: options[:prefix].to_s.gsub(/\\/, "/"),
       }
       query[:maxresults] = options[:max_results] if options[:max_results]
+      query[:timeout] = options[:timeout] if options[:timeout]
       uri.query = URI.encode_www_form(**query)
 
       fetcher = ->(marker) do
@@ -172,6 +176,7 @@ module AzureBlob
     # 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}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       response = Http.new(uri, additional_headers(options), signer:).head
 
@@ -196,7 +201,9 @@ module AzureBlob
     # Returns a hash of the blob's tags.
     def get_blob_tags(key, options = {})
       uri = generate_uri("#{container}/#{key}")
-      uri.query = URI.encode_www_form(comp: "tags")
+      query = { comp: "tags" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
       response = Http.new(uri, additional_headers(options), signer:).get
 
       Tags.from_response(response).to_h
@@ -209,7 +216,9 @@ module AzureBlob
     # This can be used to see if the container exist or obtain metadata.
     def get_container_properties(options = {})
       uri = generate_uri(container)
-      uri.query = URI.encode_www_form(restype: "container")
+      query = { restype: "container" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
       response = Http.new(uri, additional_headers(options), signer:, raise_on_error: false).head
 
       Container.new(response)
@@ -232,7 +241,9 @@ module AzureBlob
       headers[:"x-ms-blob-public-access"] = options[:public_access] if [ "container", "blob" ].include?(options[:public_access])
       headers.merge!(additional_headers(options))
 
-      uri.query = URI.encode_www_form(restype: "container")
+      query = { restype: "container" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
       response = Http.new(uri, headers, signer:).put
     end
 
@@ -241,7 +252,9 @@ module AzureBlob
     # Calls to {Delete Container}[https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container]
     def delete_container(options = {})
       uri = generate_uri(container)
-      uri.query = URI.encode_www_form(restype: "container")
+      query = { restype: "container" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
       response = Http.new(uri, additional_headers(options), signer:).delete
     end
 
@@ -283,6 +296,7 @@ module AzureBlob
     #   Will be saved on the blob in Azure.
     def create_append_blob(key, options = {})
       uri = generate_uri("#{container}/#{key}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       headers = {
         "x-ms-blob-type": "AppendBlob",
@@ -306,7 +320,9 @@ module AzureBlob
     #   The checksum must be the checksum of the block not the blob.
     def append_blob_block(key, content, options = {})
       uri = generate_uri("#{container}/#{key}")
-      uri.query = URI.encode_www_form(comp: "appendblock")
+      query = { comp: "appendblock" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
 
       headers = {
         "Content-Length": content_size(content),
@@ -330,7 +346,9 @@ module AzureBlob
     def put_blob_block(key, index, content, options = {})
       block_id = generate_block_id(index)
       uri = generate_uri("#{container}/#{key}")
-      uri.query = URI.encode_www_form(comp: "block", blockid: block_id)
+      query = { comp: "block", blockid: block_id }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
 
       headers = {
         "Content-Length": content_size(content),
@@ -358,7 +376,9 @@ module AzureBlob
       block_list = BlockList.new(block_ids)
       content = block_list.to_s
       uri = generate_uri("#{container}/#{key}")
-      uri.query = URI.encode_www_form(comp: "blocklist")
+      query = { comp: "blocklist" }
+      query[:timeout] = options[:timeout] if options[:timeout]
+      uri.query = URI.encode_www_form(**query)
 
       headers = {
         "Content-Length": content_size(content),
@@ -386,7 +406,7 @@ module AzureBlob
       block_size = options[:block_size] || DEFAULT_BLOCK_SIZE
       block_count = (content_size(content).to_f / block_size).ceil
       block_ids = block_count.times.map do |i|
-        put_blob_block(key, i, content.read(block_size))
+        put_blob_block(key, i, content.read(block_size), options.slice(:timeout))
       end
 
       commit_blob_blocks(key, block_ids, options)
@@ -395,6 +415,7 @@ module AzureBlob
     def put_blob_single(key, content, options = {})
       content = StringIO.new(content) if content.is_a? String
       uri = generate_uri("#{container}/#{key}")
+      uri.query = URI.encode_www_form(timeout: options[:timeout]) if options[:timeout]
 
       headers = {
         "x-ms-blob-type": "BlockBlob",

data/lib/azure_blob/http.rb

@@ -21,6 +21,7 @@ module AzureBlob
     class FileNotFoundError < Error; end
     class ForbiddenError < Error; end
     class IntegrityError < Error; end
+    class TimeoutError < Error; end
 
     include REXML
 
@@ -99,6 +100,7 @@ module AzureBlob
 
     ERROR_CODE_MAPPINGS = {
       "Md5Mismatch" => IntegrityError,
+      "OperationTimedOut" => TimeoutError,
     }
 
     def sanitize_headers

data/lib/azure_blob/version.rb

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

metadata

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