erp_integration 0.55.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865d21dfcb8c0caaed6bb6e76151e019424294a04c5a553c68459cbda871278b
-  data.tar.gz: 5da7b05a69bc74a8dcfa508ebe2b7b544e5902b26398b6da552fd139f20170f1
+  metadata.gz: 55974d4e2c7b76ca461070fe996522e0b7fa06391760549f8959000ed07b2a9e
+  data.tar.gz: 43683efd68525709be0fcba1537051830f52d7c0663779a7ab5b4c24b0a6e2e9
 SHA512:
-  metadata.gz: ea5e4f2a3f0e8bec393964d050ef9db305d1b7859032989d6899750306eba46efba5627e741fc469b95c215a23a42e6f6fcdee7f418f1ddf3da2f276cb201629
-  data.tar.gz: 71db26f1be6f150c53f34591d7ca46f7f89805fb65b5f44258c6dac86067bb8752feae8a08c11bf5cc4f6c096e7b3749b511583d1e3cf536921463e0d829e385
+  metadata.gz: f0943cc3b1047ef17259a1eeb039fdd65ee74cb3ebc6911ff431162f60058b89d8e26e3f742028b261c2979c304aab4b1a0fd155e5d72fd0f0063a3a3afa351f
+  data.tar.gz: 4a06481fb232e9ad506c0d038af4114169546d622eecec0e6d5b03877e6f85648777c278728f87f6cae52c3e695f382ec34e4c1a2adcfadf0d9af23fc354374f

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.2.2

data/README.md

@@ -44,10 +44,13 @@ end
 To set up API key rotation, configure multiple keys.
 Every time a Fulfil client receives a `404` or `429`, it will rotate an API key.
 
+You can set the `api_key_rotation_threshold` option to automatically change the API key when requests are running low. If you don't want to use the `x-ratelimit-remaining` response header for rotation, set the `api_key_rotation_threshold` to 0 or ignore it. The minimum threshold is 1, meaning the key will rotate when there are 0 remaining requests.
+
 ```erb
 # config/initializers/erp_integration.rb
 ErpIntegration.configure do |config|
   config.fulfil_api_keys = ['<your-api-key1>', '<your-api-key2>']
+  config.api_key_rotation_threshold = 1
   ...
 end
 ```

data/lib/erp_integration/configuration.rb

@@ -22,6 +22,12 @@ module ErpIntegration
     # @return [String] The base URL for Fulfil.
     attr_accessor :fulfil_base_url
 
+    # The `api_key_rotation_threshold` is used by the `ApiKeysRotation` middleware
+    # it will rotate the API key when the remaining requests are less than the threshold.
+    #
+    # Set the `api_key_rotation_threshold` to 0, it you don't want to rotate by the remaining requests.
+    attr_reader :api_key_rotation_threshold
+
     # Allows configuring an adapter for the `BillOfMaterial` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the bill_of_material.
@@ -172,6 +178,10 @@ module ErpIntegration
       end
     end
 
+    def api_key_rotation_threshold=(threshold)
+      @api_key_rotation_threshold = threshold || 0
+    end
+
     def carrier_adapter
       @carrier_adapter || :fulfil
     end
@@ -309,7 +319,7 @@ module ErpIntegration
     # Sets the rate limiters that will be used
     # @raise [MissingMethodError] if the rate limiter object doesn't respond to the required methods.
     def rate_limiters=(rate_limiters)
-      @rate_limiters = rate_limiters.each { |limiter| RateLimiter.validate!(limiter) }
+      @rate_limiters = (rate_limiters || []).each { |limiter| RateLimiter.validate!(limiter) }
     end
   end
 

data/lib/erp_integration/fulfil/client.rb

@@ -33,7 +33,7 @@ module ErpIntegration
           # Custom error handling for the error response
           faraday.use ErpIntegration::Middleware::ErrorHandling
           # Custom middleware for rotating API keys
-          faraday.use ErpIntegration::Middleware::ApiKeysRotation, api_keys_pool: api_keys_pool
+          faraday.use ErpIntegration::Middleware::ApiKeysRotation, rotation_options
           # Custom middleware for logging requests and responses
           faraday.use ErpIntegration::Middleware::Logger, @logger if @logger
 
@@ -76,6 +76,13 @@ module ErpIntegration
           'Content-Type': 'application/json'
         }
       end
+
+      def rotation_options
+        {
+          api_keys_pool: api_keys_pool,
+          rotation_theshold: ErpIntegration.config.api_key_rotation_threshold
+        }
+      end
     end
   end
 end

data/lib/erp_integration/middleware/api_keys_rotation.rb

@@ -20,14 +20,21 @@ module ErpIntegration
       end
 
       def on_request(env)
-        env[:request_headers]['X-API-KEY'] = options[:api_keys_pool].current_key
+        env.request_headers['X-API-KEY'] = options[:api_keys_pool].current_key
       end
 
       def on_complete(env)
-        return unless HTTP_ROTATE_CODES.include?(env.status)
+        return unless rotate?(env)
 
         options[:api_keys_pool].rotate_key!
       end
+
+      def rotate?(env)
+        return true if HTTP_ROTATE_CODES.include?(env.status)
+        return false unless env.response_headers['x-ratelimit-remaining'].present?
+
+        env.response_headers['x-ratelimit-remaining'].to_i < options[:rotation_theshold].to_i
+      end
     end
   end
 end

data/lib/erp_integration/middleware/logger.rb

@@ -19,7 +19,7 @@ module ErpIntegration
       end
 
       def call(env)
-        api_key_fragment = sanitize_api_key(env[:request_headers]['X-API-KEY'])
+        api_key_fragment = sanitize_api_key(env.request_headers['X-API-KEY']) || 'none'
 
         if @logger.respond_to?(:tagged)
           @logger.tagged("API key *#{api_key_fragment}") do

data/lib/erp_integration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.55.0'
+  VERSION = '0.56.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.55.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Stefan Vermaas
@@ -369,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors