dear_inventory 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab68553f46a24e50cfe0e70ea0408c82dc8e3cf05510b4cdf46c6e1fe08bc90
-  data.tar.gz: 8f1a4b53abb6eeb8655dd0ee8e32592399810108d34fff20412df491c29306ab
+  metadata.gz: f50f5fccdaf7007a7f7d80ebf08745d50b0cc7243a445cfc4c4a13d197533a79
+  data.tar.gz: 2713ad24418a84bcc12ace816ef59e21a48cdd40ebeed3dbff5b4999863c69f2
 SHA512:
-  metadata.gz: ceb5f12c7f4ce1047a938f8104a9408be2d4b8b31396d429fc1dc1b49cdbb13611c4c53c7fe0a8622e7f7a08d1b364ec2a4c672fe78e9db7c4a00eb7dda74c92
-  data.tar.gz: 182ff3b147f47cf471a1e1bf95a1e47af75fe201d25f2f5f9e335e9d95821d824f630246db50ff51d09b1d2171c0303afaeccdd8313e21c36b0777077df1a097
+  metadata.gz: d942ed12b4022323851b4a285ab1fc1cd8356c7a8a99528ae2050ddfc8237d91b5e9994224dbfc30185f0f7fab2a1fcc823802183ad53cc41bf2fb01169baed5
+  data.tar.gz: 87114e0054e9e3444cb8aa01d6315c5c9322dd0e2070e97938f60353e36d623ffbd32ae347d85556036b9ea5863f335792a2bc0e7872c2cb0d48ad035d24c69c

data/lib/dear_inventory/errors/api_limit.rb

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
 module DearInventory
-  class APILimitError < DearInventory::Error; end
+  class APILimitError < DearInventory::RequestError
+    # Cin7 sends "60 Seconds" in Retry-After rather than the delta-seconds or
+    # HTTP-date that RFC 9110 allows, so only a leading integer can be trusted.
+    # X-RateLimit-Reset carries the same value as a bare integer
+    def retry_after
+      return if response.nil?
+
+      reset = response.headers["X-RateLimit-Reset"]
+      return reset.to_i unless reset.nil?
+
+      response.headers["Retry-After"].to_s[/\A\d+/]&.to_i
+    end
+  end
 end

data/lib/dear_inventory/lib/request.rb

@@ -56,7 +56,7 @@ module DearInventory
       raise if @retries >= MAX_RETRIES
 
       message_prefix = ERROR_MESSAGE_PREFIXES[error.class]
-      retry_time = @retries * RETRY_DELAY
+      retry_time = retry_delay(error)
 
       DearInventory.config.logger.warn(
         "#{message_prefix} while fetching #{@parameters.uri}. " \
@@ -66,5 +66,12 @@ module DearInventory
       sleep(retry_time)
       call
     end
+
+    def retry_delay(error)
+      backoff = @retries * RETRY_DELAY
+      return backoff unless error.is_a?(DearInventory::APILimitError)
+
+      error.retry_after || backoff
+    end
   end
 end

data/lib/dear_inventory/response.rb

@@ -134,10 +134,13 @@ module DearInventory
     def raise_error
       raise DearInventory::BadRequestError.new(error, self) if http_status == 400
 
-      raise DearInventory::APILimitError if http_status == 503 && error == API_LIMIT_ERROR
+      # Cin7 reported the rate limit as a 503 until 2026. The message is still
+      # checked for that status because a 503 is also a genuine outage
+      if http_status == 429 || (http_status == 503 && error == API_LIMIT_ERROR)
+        raise DearInventory::APILimitError.new(error, self)
+      end
 
-      raise DearInventory::Error.
-        new("Unknown error (#{http_status}): #{error}")
+      raise DearInventory::Error, "Unknown error (#{http_status}): #{error}"
     end
 
     def iterate_over_records(response, block)

data/lib/dear_inventory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DearInventory
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/lib/dear_inventory.rb

@@ -6,12 +6,12 @@ require "dear_inventory/config"
 require "dear_inventory/environment"
 
 require "dear_inventory/error"
-require "dear_inventory/errors/api_limit"
 require "dear_inventory/errors/no_more_pages"
 require "dear_inventory/errors/not_paginated"
 require "dear_inventory/errors/validation"
 
 require "dear_inventory/errors/request"
+require "dear_inventory/errors/api_limit"
 require "dear_inventory/errors/bad_request"
 
 require "dear_inventory/lib/endpoint_class"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Adam Rice