erp_integration 0.53.1 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94641315e041baf5dfa5ade8f7d4802f53bf70cff09f3fadd61b2232f2b541ca
-  data.tar.gz: b32375c29eed88ee070426ea42465d36cb8c8dd309512a41cf54649fc956940d
+  metadata.gz: 865d21dfcb8c0caaed6bb6e76151e019424294a04c5a553c68459cbda871278b
+  data.tar.gz: 5da7b05a69bc74a8dcfa508ebe2b7b544e5902b26398b6da552fd139f20170f1
 SHA512:
-  metadata.gz: 4e87ddefd4bc53228dd37ba8f6e1651d9f160401898f44f9d16b740b3e78d5aab6f1e2cc415b6ab31066393e7ac8babf272c17107bc7b113005f67ec5c8395c2
-  data.tar.gz: 9c0f725849676df52f149df431367079cb9652afcb07ad55b295433e96124f251a292e91f98df08d70f9fe986b1da25b1a8e497d6ccfddb2a04bd8529fd801b4
+  metadata.gz: ea5e4f2a3f0e8bec393964d050ef9db305d1b7859032989d6899750306eba46efba5627e741fc469b95c215a23a42e6f6fcdee7f418f1ddf3da2f276cb201629
+  data.tar.gz: 71db26f1be6f150c53f34591d7ca46f7f89805fb65b5f44258c6dac86067bb8752feae8a08c11bf5cc4f6c096e7b3749b511583d1e3cf536921463e0d829e385

data/README.md

@@ -26,7 +26,7 @@ To configure the gem, create an initializer and add the following lines:
 # config/initializers/erp_integration.rb
 ErpIntegration.configure do |config|
   config.fulfil_api_keys = '<your-api-key>'
-  config.fulfil_merchant_id = '<your-merchant-id>'
+  config.fulfil_base_url = '<your-base-url>'
 end
 ```
 
@@ -35,7 +35,7 @@ You can configure multiple API keys, to enable rotation mechanism (see ["API key
 # config/initializers/erp_integration.rb
 ErpIntegration.configure do |config|
   config.fulfil_api_keys = ['<your-api-key1>', '<your-api-key2>']
-  config.fulfil_merchant_id = '<your-merchant-id>'
+  config.fulfil_base_url = '<your-base-url>'
 end
 ```
 
@@ -61,6 +61,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

@@ -14,13 +14,13 @@ module ErpIntegration
   class Configuration
     # The `fulfil_api_keys` sets a single or a list of API keys to use
     # in the `FulfilClient` to authorize the requests to the Fulfil API endpoints.
-    # @return [Array<Atring>] The API keys for Fulfil.
+    # @return [Array<String>] The API keys for Fulfil.
     attr_accessor :fulfil_api_keys
 
-    # The `fulfil_merchant_id` is used by the `FulfilClient` to connect to
+    # The `fulfil_base_url` is used by the `FulfilClient` to connect to
     # the right Fulfil API endpoints.
-    # @return [String] The merchant ID for Fulfil.
-    attr_accessor :fulfil_merchant_id
+    # @return [String] The base URL for Fulfil.
+    attr_accessor :fulfil_base_url
 
     # Allows configuring an adapter for the `BillOfMaterial` resource. When
     # none is configured, it will default to Fulfil.
@@ -299,6 +299,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/api_resource.rb

@@ -28,7 +28,7 @@ module ErpIntegration
       def self.client
         Client.new(
           api_keys_pool: api_keys_pool,
-          merchant_id: config.fulfil_merchant_id,
+          base_url: config.fulfil_base_url,
           logger: config.logger
         )
       end

data/lib/erp_integration/fulfil/client.rb

@@ -3,21 +3,15 @@
 module ErpIntegration
   module Fulfil
     class Client
-      attr_reader :api_keys_pool, :merchant_id
+      attr_reader :api_keys_pool, :base_url
       attr_writer :connection, :faraday_adapter, :rotate_statuses
 
-      def initialize(api_keys_pool:, merchant_id:, logger: nil)
+      def initialize(api_keys_pool:, base_url:, logger: nil)
         @api_keys_pool = api_keys_pool
-        @merchant_id = merchant_id
+        @base_url = base_url.strip
         @logger = logger
       end
 
-      # Generates the url prefix for the Faraday connection client.
-      # @return [String] The base url for the Fulfil HTTP client
-      def base_url
-        "https://#{merchant_id}.fulfil.io/"
-      end
-
       # Sets the default adapter for the Faraday Connection.
       # @return [Symbol] The default Faraday adapter
       def faraday_adapter
@@ -50,11 +44,13 @@ module ErpIntegration
 
       %i[delete get patch put post].each do |action_name|
         define_method(action_name) do |path, options = {}|
-          if api_key.nil? || merchant_id.nil?
-            raise ErpIntegration::Error, 'The Fulfil API key and/or Merchant ID are missing.'
+          if api_key.nil? || base_url.nil?
+            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
 
@@ -70,6 +66,10 @@ 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',

data/lib/erp_integration/middleware/logger.rb

@@ -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.53.1'
+  VERSION = '0.55.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.53.1
+  version: 0.55.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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