erp_integration 0.54.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 015dee8d29c0a8bcd763966f25c24b77efb9cd2e7ac4a1555aa104e9a708c2ec
-  data.tar.gz: 92f5a27785677904bd7b0cd60fc5a033195ed99d64d9c16941fbb4d942db8b31
+  metadata.gz: 55974d4e2c7b76ca461070fe996522e0b7fa06391760549f8959000ed07b2a9e
+  data.tar.gz: 43683efd68525709be0fcba1537051830f52d7c0663779a7ab5b4c24b0a6e2e9
 SHA512:
-  metadata.gz: 526e86fb610c85d0b5c69f36e2cf1b1c396ff36e6f74c2db6d9764eae9eb1f076d9ed7771b5347ac3060bbdbd047777c1901c427351a280bcb26bf49b6edb269
-  data.tar.gz: f876d9874077923090353f7e2c9d6766cae725fe1558345ba98f4d5cfc07495bb272f451205f04c6a957402fdf10bc756d69ad8792a55405c91a07ce856d5e4e
+  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
 ```
@@ -61,6 +64,47 @@ ErpIntegration::SalesOrder.api_keys_pool = '<your-api-key>'
 ErpIntegration::SalesOrder.api_keys_pool = ['<your-api-key1>', '<your-api-key2>']
 ```
 
+### Rate limiting
+
+To manage the number of requests made to avoid rate limiting by the API provider, you can configure rate limiters in the ERP Integration gem. Each rate limiter should implement the `api_key_fragment` and `within_limit` methods.
+
+### Setting Up Rate Limiters
+You can configure multiple rate limiters to be used for HTTP operations on the client.
+
+```ruby
+# config/initializers/erp_integration.rb
+ErpIntegration.configure do |config|
+  config.rate_limiters = [
+    MyRateLimiter.new(api_key_fragment: 'key1'),
+    MyRateLimiter.new(api_key_fragment: 'key2')
+  ]
+end
+```
+
+Each rate limiter must implement the following methods:
+- `api_key_fragment`: This method should return a string that is used to identify the rate limiter by the API key.
+- `within_limit`: This method should `yield` to the block if the rate limit is not exceeded.
+
+### Example Rate Limiter
+Here is an example implementation of a rate limiter:
+
+```ruby
+class MyRateLimiter
+  def initialize(api_key_fragment:)
+    @api_key_fragment = api_key_fragment
+  end
+
+  def api_key_fragment
+    @api_key_fragment
+  end
+
+  def within_limit
+    # Implement your rate limiting logic here
+    yield
+  end
+end
+```
+
 ### Supported Query Methods
 
 After configuring the gem, one can easily query all the available ERP resources from the connected third-parties. In all cases, the API will return a collection of resources.

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
@@ -299,6 +309,18 @@ module ErpIntegration
     def product_option_adapter
       @product_option_adapter || :fulfil
     end
+
+    # Rate limiters that will be used for HTTP operations on Client
+    # to manage the number of requests made to avoid rate limiting by the API provider.
+    def rate_limiters
+      @rate_limiters ||= []
+    end
+
+    # 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) }
+    end
   end
 
   # Returns ERP Integration's configuration.

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
 
@@ -48,7 +48,9 @@ module ErpIntegration
             raise ErpIntegration::Error, 'The Fulfil API key and/or base URL are missing.'
           end
 
-          connection.public_send(action_name, "api/#{version}/#{path}", options).body
+          rate_limiter.within_limit do
+            connection.public_send(action_name, "api/#{version}/#{path}", options).body
+          end
         end
       end
 
@@ -64,12 +66,23 @@ module ErpIntegration
         api_keys_pool.current_key
       end
 
+      def rate_limiter
+        RateLimiter.find_by_api_key(api_key)
+      end
+
       def default_headers
         {
           'Accept': 'application/json',
           '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
@@ -43,6 +43,8 @@ module ErpIntegration
         @formatter.exception(exc) if @formatter.respond_to?(:exception)
       end
 
+      # @param [String] api_key
+      # @return [String] The last 4 characters of the API key
       def sanitize_api_key(api_key)
         api_key[-4..-1] if api_key
       end

data/lib/erp_integration/rate_limiter.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  class RateLimiter
+    class MissingMethodError < StandardError; end
+    # The `api_key_fragment` method should return a string that is used to identify
+    # the rate limiter by the API key.
+    #
+    # The `within_limit` method should yield to the block if the rate limit is not exceeded.
+    REQUIRED_METHODS = %i[api_key_fragment within_limit].freeze
+
+    class << self
+      # Validates that the rate limiter object responds to the required methods.
+      # It requires the `api_key_fragment` and `within_limit` methods to be present.
+      #
+      # @raise [MissingMethodError]
+      # @param rate_limiter [Object]
+      def validate!(rate_limiter)
+        REQUIRED_METHODS.each do |method|
+          next if rate_limiter.respond_to?(method)
+
+          raise MissingMethodError, "'#{rate_limiter.class}##{method}' method is required."
+        end
+      end
+
+      # Finds the rate limiter by the API key.
+      # If the API key is not found, it returns an unlimited rate limiter.
+      #
+      # @param api_key [String]
+      # @return [Object] The rate limiter object.
+      def find_by_api_key(api_key)
+        rate_limiters[api_key] || unlimited
+      end
+
+      # Returns an unlimited rate limiter.
+      #
+      # @return [RateLimiter::Unlimited] The unlimited rate limiter object.
+      def unlimited
+        @unlimited ||= Unlimited.new
+      end
+
+      private
+
+      # The `rate_limiters` hash stores the rate limiter objects found by the API key.
+      #
+      # @return [Hash] The rate limiters hash.
+      def rate_limiters
+        @rate_limiters ||= Hash.new do |h, api_key|
+          h[api_key] = ErpIntegration.config.rate_limiters.find do |rate_limiter|
+            api_key.end_with?(rate_limiter.api_key_fragment)
+          end
+        end
+      end
+    end
+
+    # {Unlimited} is a rate limiter that allows all requests.
+    # When the rate limiter wasn't found by the API key, it defaults to this class.
+    # Or if the `rate_limiters` option is not set in the configuration.
+    class Unlimited
+      # Executes the block without any restrictions.
+      def within_limit
+        yield
+      end
+    end
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -11,6 +11,7 @@ require 'json'
 require_relative 'erp_integration/version'
 require_relative 'erp_integration/errors'
 require_relative 'erp_integration/api_keys_pool'
+require_relative 'erp_integration/rate_limiter'
 require_relative 'erp_integration/configuration'
 
 # Middleware

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Stefan Vermaas
@@ -329,6 +329,7 @@ files:
 - lib/erp_integration/purchase_order.rb
 - lib/erp_integration/purchase_order_line.rb
 - lib/erp_integration/purchase_request.rb
+- lib/erp_integration/rate_limiter.rb
 - lib/erp_integration/resource.rb
 - lib/erp_integration/resources/errors.rb
 - lib/erp_integration/resources/persistence.rb
@@ -368,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors