erp_integration 0.52.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7984c5549446febb8478fe9611b601c257a0bd03b3642ec5d35b480f504cbff5
-  data.tar.gz: 540f6ca9033aebe017cb2c32db0d21de595ea172a42316e5e3366fe933a8739f
+  metadata.gz: 7719f3eaa455812be74cbdb4448118217e8294c90e742bb9d4074fad423a10ab
+  data.tar.gz: 35e221932e9c229957951869daa324c7f40549bf1cdfe21d7c56dc3202741832
 SHA512:
-  metadata.gz: 36d578d1ac7e5bfaacd79118fc1f5405e5a754e4a6a3571bc0957aa7347b159beafdce7bcaf27f968df2a18b7a736f63956426b1db3ca5c99ec923102a2db592
-  data.tar.gz: d985ee23e864310a16034cb25c360777be1b172ca4160c707a63ea387e4623e323c88c16ff8330763bee7cc122b78bc4c516fd0e36736924d88eae4a33b312ec
+  metadata.gz: e9835ef2f7400c112999ac8ca0135d7f11be0c69129bd4403f5620042b06394e09a6ec62c225d9d82d41d66b7d6290a602edf525d48fe910e92ab48562456711
+  data.tar.gz: 4a39d845dda9398b971334392fb58539a3cc208896a19e608c2207ddc040331b9e2a27ffef6ff1bcdc1ab56df4ba4a5de1a6da85399d37ca53a3b795f762771f

data/.github/workflows/pull_requests.yml

@@ -15,4 +15,4 @@ jobs:
     steps:
       - uses: seferov/pr-lint-action@master
         with:
-          title-regex: '^\[RELEASE|NO-TICKET|DL|UDL|AD|DU|AR|IN|CON|DIS|AS|MT|SCR|RO|DEL|BE-\d*\](\ )'
+          title-regex: '^\[RELEASE|NO-TICKET|DL|UDL|AD|DU|AR|IN|CON|DIS|AS|MT|SCR|RO|DEL|BE|STORE-\d*\](\ )'

data/README.md

@@ -25,11 +25,42 @@ To configure the gem, create an initializer and add the following lines:
 ```erb
 # config/initializers/erp_integration.rb
 ErpIntegration.configure do |config|
-  config.fulfil_api_key = '<your-api-key>'
+  config.fulfil_api_keys = '<your-api-key>'
   config.fulfil_merchant_id = '<your-merchant-id>'
 end
 ```
 
+You can configure multiple API keys, to enable rotation mechanism (see ["API key rotation"](README.md:L42)).
+```erb
+# 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>'
+end
+```
+
+### API keys rotation
+
+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.
+
+```erb
+# config/initializers/erp_integration.rb
+ErpIntegration.configure do |config|
+  config.fulfil_api_keys = ['<your-api-key1>', '<your-api-key2>']
+  ...
+end
+```
+
+You can also configure a separate group of API keys for each resource.
+From this point, `ErpIntegration::SalesOrder` will use custom API keys, and the other resources will continue to use the configured API keys pool.
+
+```ruby
+ErpIntegration::SalesOrder.api_keys_pool = '<your-api-key>'
+# or
+ErpIntegration::SalesOrder.api_keys_pool = ['<your-api-key1>', '<your-api-key2>']
+```
+
 ### 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/api_keys_pool.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ApiKeysPool` class is a simple
+  # class that holds a list of API keys
+  # and rotates between them.
+  class ApiKeysPool
+    attr_reader :api_keys
+
+    def initialize
+      @api_keys = []
+      @current_key_index = 0
+    end
+
+    # Allows setting a list of API keys for the pool.
+    def api_keys=(keys)
+      @api_keys = Array(keys)
+    end
+
+    # Returns the current API key.
+    # @return [String] The current API key.
+    def current_key
+      @api_keys[@current_key_index]
+    end
+
+    # Rotates the API key to the next one in the list.
+    def rotate_key!
+      @current_key_index = (@current_key_index + 1) % @api_keys.size
+    end
+  end
+end

data/lib/erp_integration/configuration.rb

@@ -8,14 +8,14 @@ module ErpIntegration
   #   ```ruby
   #     # config/initializers/erp_integration.rb
   #     ErpIntegration.configure do |config|
-  #       config.fulfil_api_key = "..."
+  #       config.fulfil_api_keys = "..."
   #     end
   #   ```
   class Configuration
-    # The `fulfil_api_key` is used by the `FulfilClient` to authorize the
-    # requests to the Fulfil API endpoints.
-    # @return [String] The API key for Fulfil.
-    attr_accessor :fulfil_api_key
+    # 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.
+    attr_accessor :fulfil_api_keys
 
     # The `fulfil_merchant_id` is used by the `FulfilClient` to connect to
     # the right Fulfil API endpoints.

data/lib/erp_integration/fulfil/api_resource.rb

@@ -17,7 +17,7 @@ module ErpIntegration
       include QueryMethods
 
       attr_accessor :resource_klass
-      delegate :client, :model_name, to: 'self.class'
+      delegate :api_keys_pool=, :client, :model_name, to: 'self.class'
 
       def initialize(resource_klass)
         @resource_klass = resource_klass
@@ -27,12 +27,24 @@ module ErpIntegration
       # @return [ErpIntegration::Fulfil::Client] The HTTP client for Fulfil.
       def self.client
         Client.new(
-          api_key: config.fulfil_api_key,
+          api_keys_pool: api_keys_pool,
           merchant_id: config.fulfil_merchant_id,
           logger: config.logger
         )
       end
 
+      # The `api_keys_pool` exposes the API keys pool to the class.
+      # @return [ErpIntegration::ApiKeysPool] The API keys pool object.
+      def self.api_keys_pool
+        @api_keys_pool ||= ApiKeysPool.new.tap { |pool| pool.api_keys = config.fulfil_api_keys }
+      end
+
+      # Allows setting a new API keys pool for the `ApiResource`
+      # @return [ErpIntegration::ApiKeysPool] ApiKeysPool object with the new API keys.
+      def self.api_keys_pool=(fulfil_api_keys)
+        @api_keys_pool = ApiKeysPool.new.tap { |pool| pool.api_keys = fulfil_api_keys }
+      end
+
       # The `config` exposes the gem's configuration to the `ApiResource`.
       # @return [ErpIntegration::Configuration] The gem's configuration object.
       def self.config
@@ -60,19 +72,16 @@ module ErpIntegration
       # be executed and the results will be fetched.
       # @return [Array] An enumerable collection object with all API results.
       def all
-        return @results if defined?(@results)
-
-        @results =
-          client.put(
-            api_resource_path,
-            Query.new(
-              fields: selected_fields,
-              filters: where_clauses,
-              alternative_filters: or_clauses,
-              limit: limit_value,
-              offset: calculated_offset
-            )
-          ).map { |item| resource_klass.new(item) }
+        client.put(
+          api_resource_path,
+          Query.new(
+            fields: selected_fields,
+            filters: where_clauses,
+            alternative_filters: or_clauses,
+            limit: limit_value,
+            offset: calculated_offset
+          )
+        ).map { |item| resource_klass.new(item) }
       end
 
       # As with the `all` method, the `query methods` lazyly build a search/read
@@ -81,17 +90,14 @@ module ErpIntegration
       # the result will be fetched
       # @return [Integer] The count of records that match with the query in Fulfil
       def count
-        return @count if defined?(@count)
-
-        @count =
-          client.put(
-            "model/#{model_name}/search_count",
-            Query.new(
-              fields: nil,
-              filters: where_clauses,
-              alternative_filters: or_clauses
-            ).to_h.except(:fields)
-          )
+        client.put(
+          "model/#{model_name}/search_count",
+          Query.new(
+            fields: nil,
+            filters: where_clauses,
+            alternative_filters: or_clauses
+          ).to_h.except(:fields)
+        )
       end
 
       # The `each` method turns the `ApiResource` instance into an enumerable object.

data/lib/erp_integration/fulfil/client.rb

@@ -3,11 +3,11 @@
 module ErpIntegration
   module Fulfil
     class Client
-      attr_reader :api_key, :merchant_id
-      attr_writer :connection, :faraday_adapter
+      attr_reader :api_keys_pool, :merchant_id
+      attr_writer :connection, :faraday_adapter, :rotate_statuses
 
-      def initialize(api_key:, merchant_id:, logger: nil)
-        @api_key = api_key
+      def initialize(api_keys_pool:, merchant_id:, logger: nil)
+        @api_keys_pool = api_keys_pool
         @merchant_id = merchant_id
         @logger = logger
       end
@@ -36,13 +36,12 @@ module ErpIntegration
           faraday.response :follow_redirects
           faraday.response :json # Decode response bodies as JSON
 
-          # Notice that logging headers will expose sensitive information
-          # like api-key. To avoid use filters:
-          # https://lostisland.github.io/faraday/middleware/logger
-          faraday.response :logger, @logger, { headers: false, bodies: true } if @logger
-
           # 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
+          # Custom middleware for logging requests and responses
+          faraday.use ErpIntegration::Middleware::Logger, @logger if @logger
 
           # Adapter definition should be last in order to make the json parsers be loaded correctly
           faraday.adapter faraday_adapter
@@ -67,11 +66,14 @@ module ErpIntegration
 
       private
 
+      def api_key
+        api_keys_pool.current_key
+      end
+
       def default_headers
         {
           'Accept': 'application/json',
-          'Content-Type': 'application/json',
-          'X-API-KEY': api_key
+          'Content-Type': 'application/json'
         }
       end
     end

data/lib/erp_integration/middleware/api_keys_rotation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Middleware
+    class ApiKeysRotation < Faraday::Middleware
+      HTTP_ROTATE_CODES = [404, 429].freeze
+
+      attr_reader :options
+
+      def initialize(app, options = {})
+        super(app)
+
+        @options = options
+      end
+
+      def call(env)
+        on_request(env)
+
+        @app.call(env).on_complete { |response| on_complete(response) }
+      end
+
+      def on_request(env)
+        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)
+
+        options[:api_keys_pool].rotate_key!
+      end
+    end
+  end
+end

data/lib/erp_integration/middleware/logger.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'faraday/logging/formatter'
+
+module ErpIntegration
+  module Middleware
+    class Logger < Faraday::Middleware
+      # Notice that logging headers will expose sensitive information
+      # like api-key.
+      DEFAULT_OPTIONS = { headers: false, bodies: true, errors: true }.freeze
+
+      def initialize(app, logger = nil, options = {})
+        super(app)
+
+        @logger = logger
+        formatter_klass = options.delete(:formatter) || Faraday::Logging::Formatter
+        @formatter = formatter_klass.new(logger: logger, options: DEFAULT_OPTIONS)
+        yield @formatter if block_given?
+      end
+
+      def call(env)
+        api_key_fragment = sanitize_api_key(env[:request_headers]['X-API-KEY'])
+
+        if @logger.respond_to?(:tagged)
+          @logger.tagged("API key *#{api_key_fragment}") do
+            @formatter.request(env)
+
+            @app.call(env).on_complete { |response| on_complete(response) }
+          end
+        else
+          @logger.info("Requested ERP with API key *#{api_key_fragment}")
+          @formatter.request(env)
+
+          @app.call(env).on_complete { |response| on_complete(response) }
+        end
+      end
+
+      def on_complete(env)
+        @formatter.response(env)
+      end
+
+      def on_error(exc)
+        @formatter.exception(exc) if @formatter.respond_to?(:exception)
+      end
+
+      def sanitize_api_key(api_key)
+        api_key[-4..-1] if api_key
+      end
+    end
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -10,10 +10,13 @@ require 'json'
 
 require_relative 'erp_integration/version'
 require_relative 'erp_integration/errors'
+require_relative 'erp_integration/api_keys_pool'
 require_relative 'erp_integration/configuration'
 
 # Middleware
+require_relative 'erp_integration/middleware/api_keys_rotation'
 require_relative 'erp_integration/middleware/error_handling'
+require_relative 'erp_integration/middleware/logger'
 
 # HTTP clients
 require_relative 'erp_integration/fulfil/client'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -259,6 +259,7 @@ files:
 - bin/setup
 - erp_integration.gemspec
 - lib/erp_integration.rb
+- lib/erp_integration/api_keys_pool.rb
 - lib/erp_integration/bill_of_material.rb
 - lib/erp_integration/bill_of_material_input.rb
 - lib/erp_integration/bill_of_material_output.rb
@@ -316,7 +317,9 @@ files:
 - lib/erp_integration/gift_card.rb
 - lib/erp_integration/internal_shipment.rb
 - lib/erp_integration/location.rb
+- lib/erp_integration/middleware/api_keys_rotation.rb
 - lib/erp_integration/middleware/error_handling.rb
+- lib/erp_integration/middleware/logger.rb
 - lib/erp_integration/party_address.rb
 - lib/erp_integration/product.rb
 - lib/erp_integration/product_category.rb
@@ -365,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors