redfish_client 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d565357ebc33ecafd73baf529638da1b24e03ed80c1272f769278f8d65822982
-  data.tar.gz: 21724f92efa1c966eb1fcd361ae5fbcc34a5c3f4b13d76e261f325f382fce825
+  metadata.gz: b77e06cc7ad353a5981721f72545f3ad266bf0b4a34ed08ef836ee52c48d8002
+  data.tar.gz: 2a674965dc162d9924eb6c0ef5050af50e173e3334c6fa5b0a59f66d9576921f
 SHA512:
-  metadata.gz: fe37c7362f8365175014ec302c66aad65d968bb18fac641cdbbe97fc0ca7842330bd4dbbbac02eff150d90ea50148922f73444eaf3bfb89a4bffb92d4f37fec3
-  data.tar.gz: 29a334780905e1ffea4fd1a9798d8b51aa9120e2aef7031e6e4d0c56d60536759a4d405c5e3cec39a008c0764b72dc3c89b8ad4b8720cc1b076cceb26f61ee6d
+  metadata.gz: 8996d61ef36dad455a10de898c9e83108a447d897e4de9396102279ef6b1865c2acd7daca3f8adc067dca079e1e7cc953de7a653ffdbbd4a7702d11790d73de7
+  data.tar.gz: 275323b6abbcbfc4fc9b619da2ff48140e3ed272890167084e8678130f546c4ea3d2dafcfd43757597f1cc3dd2cc6d30d116a7fc056c74e1d50503ae7b4e178f

data/lib/redfish_client/connector.rb

@@ -3,6 +3,7 @@
 require "base64"
 require "excon"
 require "json"
+require "logger"
 
 require "redfish_client/nil_hash"
 require "redfish_client/response"
@@ -113,13 +114,14 @@ module RedfishClient
       request(:post, path, data)
     end
 
-    # Issue PATCH requests to the service.
+    # Issue PATCH requests to the service with optional ETag support.
     #
     # @param path [String] path to the resource, relative to the base
     # @param data [Hash] data to be sent over the socket
+    # @param options [Hash] optional parameters including :etag
     # @return [Response] response object
-    def patch(path, data = nil)
-      request(:patch, path, data)
+    def patch(path, data = nil, **options)
+      etag_handler(path, data, options[:etag])
     end
 
     # Issue DELETE requests to the service.
@@ -187,6 +189,89 @@ module RedfishClient
 
     private
 
+    # ETag handler containing workarounds for PATCH requests with ETags.
+    # Based on sushy's _etag_handler implementation.
+    #
+    # @param path [String] path to the resource
+    # @param data [Hash] data to be sent
+    # @param etag [String, nil] ETag value
+    # @return [Response] response object
+    def etag_handler(path, data, etag)
+      # Guard clause: if no ETag provided, perform regular PATCH and return
+      return request(:patch, path, data) if etag.nil? || etag.empty?
+
+      logger = Logger.new($stdout)
+      logger.level = Logger::WARN
+
+      # Prepare headers with If-Match
+      headers_to_add = { "If-Match" => etag }
+      add_headers(headers_to_add)
+
+      begin
+        # First attempt with the provided ETag
+        response = request(:patch, path, data)
+
+        # Handle 412 Precondition Failed with retry logic.
+        # Some hardware vendors have non-standard Redfish implementations
+        # that incorrectly handle ETags (e.g., rejecting weak ETags or
+        # requiring ETags to be omitted even when provided correctly).
+        # To work around these vendor-specific issues, we retry with:
+        # 1. Converting weak ETag (W/"...") to strong ETag ("...")
+        # 2. Removing the If-Match header entirely
+        # This approach is based on similar workarounds implemented in
+        # the Sushy library:
+        # https://github.com/openstack/sushy
+        # Other statuses (success or errors like 400, 500) should be
+        # returned as-is for the caller to handle appropriately.
+        unless response.status == 412
+          return response
+        end
+
+        logger.warn("Initial request with eTag failed: HTTP 412")
+
+        # Check for weak ETag (W/"...")
+        weak_etag_pattern = /^(W\/)(".+")$/
+        match = weak_etag_pattern.match(etag)
+
+        if match
+          logger.info("Weak eTag provided with original request to #{path}. " \
+                     "Attempting conversion to strong eTag and re-trying.")
+
+          # Try with strong ETag (remove W/ prefix)
+          strong_etag = match[2]
+          remove_headers(["If-Match"])
+          add_headers("If-Match" => strong_etag)
+
+          response = request(:patch, path, data)
+
+          unless response.status == 412
+            return response
+          end
+
+          logger.warn("Request to #{path} with weak eTag converted to " \
+                     "strong eTag also failed. Making the final attempt " \
+                     "with no eTag specified.")
+        else
+          # ETag is strong, retry without it
+          logger.warn("Strong eTag provided - retrying request to #{path} " \
+                     "with eTag removed.")
+        end
+
+        # Final attempt without If-Match header
+        remove_headers(["If-Match"])
+        response = request(:patch, path, data)
+
+        if response.status == 412
+          logger.error("Final re-try with eTag removed has also failed with HTTP 412")
+        end
+
+        response
+      ensure
+        # Clean up headers
+        remove_headers(headers_to_add.keys) unless headers_to_add.empty?
+      end
+    end
+
     def do_request(method, path, data)
       params = prepare_request_params(method, path, data)
       r = @connection.request(params)

data/lib/redfish_client/resource.rb

@@ -42,6 +42,23 @@ module RedfishClient
     # @return [Hash] resource raw data
     attr_reader :raw
 
+    # Get ETag from the response headers or resource property.
+    #
+    # Redfish services may provide ETag in two ways:
+    # 1. HTTP ETag header (preferred)
+    # 2. @odata.etag property in the resource (fallback)
+    #
+    # This method checks both locations, prioritizing the HTTP header.
+    #
+    # @return [String, nil] ETag value or nil if not present
+    def etag
+      # Prefer HTTP header (used for If-Match header)
+      return @headers["etag"] if @headers&.key?("etag")
+
+      # Fallback to @odata.etag property
+      raw["@odata.etag"]
+    end
+
     # Create new resource.
     #
     # Resource can be created either by passing in OpenData identifier or
@@ -149,10 +166,24 @@ module RedfishClient
     # @param method [Symbol] HTTP method (:get, :post, :patch or :delete)
     # @param field [String, Symbol] path lookup field
     # @param path [String] path to post to
+    # @param payload Hash<String, >] data to send
+    # @param headers [Hash<String, String>] additional headers for this request only
+    # @param etag [String, nil] optional ETag value for If-Match header
     # @return [RedfishClient::Response] response
     # @raise  [NoODataId] resource has no OpenData id
-    def request(method, field, path, payload = nil)
-      @connector.request(method, get_path(field, path), payload)
+    def request(method, field, path, payload = nil, headers = nil, etag = nil)
+      @connector.add_headers(headers) if headers&.any?
+      target_path = get_path(field, path)
+
+      # Use etag-aware patch method when etag is provided
+      if method == :patch && etag
+        # Forward ETag value from caller to Connector#patch as keyword argument
+        @connector.patch(target_path, payload, etag: etag)
+      else
+        @connector.request(method, target_path, payload)
+      end
+    ensure
+      @connector.remove_headers(headers) if headers&.any?
     end
 
     # Issue a GET requests to the selected endpoint.
@@ -169,10 +200,11 @@ module RedfishClient
     #
     # @param field [String, Symbol] path lookup field
     # @param path [String] path to post to
+    # @param headers [Hash<String, String>] additional headers for this request only
     # @return [RedfishClient::Response] response
     # @raise  [NoODataId] resource has no OpenData id
-    def get(field: "@odata.id", path: nil)
-      request(:get, field, path)
+    def get(field: "@odata.id", path: nil, headers: nil)
+      request(:get, field, path, nil, headers)
     end
 
     # Issue a POST requests to the selected endpoint.
@@ -193,10 +225,11 @@ module RedfishClient
     # @param field [String, Symbol] path lookup field
     # @param path [String] path to post to
     # @param payload [Hash<String, >] data to send
+    # @param headers [Hash<String, String>] additional headers for this request only
     # @return [RedfishClient::Response] response
     # @raise  [NoODataId] resource has no OpenData id
-    def post(field: "@odata.id", path: nil, payload: nil)
-      request(:post, field, path, payload)
+    def post(field: "@odata.id", path: nil, payload: nil, headers: nil)
+      request(:post, field, path, payload, headers)
     end
 
     # Issue a PATCH requests to the selected endpoint.
@@ -207,10 +240,40 @@ module RedfishClient
     # @param field [String, Symbol] path lookup field
     # @param path [String] path to patch
     # @param payload [Hash<String, >] data to send
+    # @param headers [Hash<String, String>] additional headers for this request only
+    # @param etag [String, nil] optional ETag value for If-Match header
+    # @return [RedfishClient::Response] response
+    # @raise  [NoODataId] resource has no OpenData id
+    def patch(field: "@odata.id", path: nil, payload: nil, headers: nil, etag: nil)
+      request(:patch, field, path, payload, headers, etag)
+    end
+
+    # Issue a PATCH request using the ETag from this resource.
+    #
+    # This is a convenience method that uses the ETag value obtained when
+    # this resource was retrieved from the service. The resource must be
+    # fetched via GET (e.g., using `client.find()`) before calling this
+    # method, so that the ETag is available in the response headers.
+    #
+    # If no ETag is present in the headers, this method will perform a
+    # regular PATCH without the If-Match header.
+    #
+    # @example Basic usage
+    #   # First, retrieve the resource (GET request with ETag in response)
+    #   system = client.find("/redfish/v1/Systems/1")
+    #
+    #   # Then, update with ETag validation (PATCH with If-Match header)
+    #   system.patch_if_match({ "AssetTag" => "Server-001" })
+    #
+    # @param payload [Hash<String, >] data to send
+    # @param field [String, Symbol] path lookup field
+    # @param path [String] path to patch
+    # @param headers [Hash<String, String>] additional headers for this request only
     # @return [RedfishClient::Response] response
     # @raise  [NoODataId] resource has no OpenData id
-    def patch(field: "@odata.id", path: nil, payload: nil)
-      request(:patch, field, path, payload)
+    def patch_if_match(payload, field: "@odata.id", path: nil, headers: nil)
+      current_etag = etag
+      patch(field: field, path: path, payload: payload, headers: headers, etag: current_etag)
     end
 
     # Issue a DELETE requests to the endpoint of the resource.
@@ -219,16 +282,20 @@ module RedfishClient
     # raised, since deleting non-networked resources makes no sense and
     # probably indicates bug in library consumer.
     #
+    # @param field [String, Symbol] path lookup field
+    # @param path [String] path to patch
+    # @param payload [Hash<String, >] data to send
+    # @param headers [Hash<String, String>] additional headers for this request only
     # @return [RedfishClient::Response] response
     # @raise  [NoODataId] resource has no OpenData id
-    def delete(field: "@odata.id", path: nil, payload: nil)
-      request(:delete, field, path, payload)
+    def delete(field: "@odata.id", path: nil, payload: nil, headers: nil)
+      request(:delete, field, path, payload, headers)
     end
 
     # Refresh resource content from the API
     #
     # Caling this method will ensure that the resource data is in sync with
-    # the Redfis API, invalidating any caches as necessary.
+    # the Redfish API, invalidating any caches as necessary.
     def refresh
       return unless self["@odata.id"]
 

data/lib/redfish_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedfishClient
-  VERSION = "0.6.2"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_client
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2026-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon