erp_integration 0.55.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865d21dfcb8c0caaed6bb6e76151e019424294a04c5a553c68459cbda871278b
-  data.tar.gz: 5da7b05a69bc74a8dcfa508ebe2b7b544e5902b26398b6da552fd139f20170f1
+  metadata.gz: d3ca1dee9c59a3fe44512bb878c063385b9ce338a8fdc4a6ff5b9c8f7167609d
+  data.tar.gz: cd1a513db316b7a69ace5ef024f4e64bc8214d4a08fc19c939280bb8217f505b
 SHA512:
-  metadata.gz: ea5e4f2a3f0e8bec393964d050ef9db305d1b7859032989d6899750306eba46efba5627e741fc469b95c215a23a42e6f6fcdee7f418f1ddf3da2f276cb201629
-  data.tar.gz: 71db26f1be6f150c53f34591d7ca46f7f89805fb65b5f44258c6dac86067bb8752feae8a08c11bf5cc4f6c096e7b3749b511583d1e3cf536921463e0d829e385
+  metadata.gz: a1c33b241d2bf37cdc487e49079d0fe85500125216799b872ea2921baf5769dbb33c0c57e9679cf09a5aa8ea8b68e0738052275c5b58883a76a12d4221431d19
+  data.tar.gz: 622bc6cd1456950c07a1b67ff75ab8c66e5c7e6ece19dc685d592e43adad88ce3aaa0b927e456ecc1344a3e5bebbaf81d529755c644ee4249459aa2e4701fb84

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.
@@ -162,16 +168,16 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the tracking number.
     attr_writer :product_option_adapter
 
-    # Logger that will be used for HTTP operations on Client
-    # @return [Logger] The configured logger
-    attr_accessor :logger
-
     def initialize(**options)
       options.each_pair do |key, value|
         public_send("#{key}=", value) if respond_to?("#{key}=")
       end
     end
 
+    def api_key_rotation_threshold=(threshold)
+      @api_key_rotation_threshold = threshold || 0
+    end
+
     def carrier_adapter
       @carrier_adapter || :fulfil
     end
@@ -309,7 +315,15 @@ 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
+
+    def logger
+      @logger || Logger.new(nil)
+    end
+
+    def logger=(logger)
+      @logger = Logger.new(logger)
     end
   end
 

data/lib/erp_integration/fulfil/client.rb

@@ -3,6 +3,8 @@
 module ErpIntegration
   module Fulfil
     class Client
+      FORMATTER = ErpIntegration::Middleware::Formatter
+
       attr_reader :api_keys_pool, :base_url
       attr_writer :connection, :faraday_adapter, :rotate_statuses
 
@@ -33,9 +35,9 @@ 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
+          faraday.use ErpIntegration::Middleware::Logger, @logger, formatter: FORMATTER if @logger
 
           # Adapter definition should be last in order to make the json parsers be loaded correctly
           faraday.adapter faraday_adapter
@@ -76,6 +78,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/logger.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The Logger class is a simple wrapper around the logger object.
+  class Logger
+    delegate :debug, :info, :warn, :error, :fatal, to: :logger, allow_nil: true
+
+    def initialize(logger = nil)
+      @logger = logger
+    end
+
+    # Logs the given tags if the logger is present.
+    # If the logger does not respond to `tagged`, it logs the tags as an info message.
+    def with_tags(*tags)
+      return yield unless logger
+
+      if logger.respond_to?(:tagged)
+        logger.tagged(*tags) { yield }
+      else
+        logger.info("Requested ERP with #{tags.join(', ')}")
+        yield
+      end
+    end
+
+    private
+
+    attr_reader :logger
+  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/formatter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Middleware
+    # The {Formatter} class is a custom formatter for the Faraday logger.
+    # It logs the rate limiter headers in the response.
+    class Formatter < Faraday::Logging::Formatter
+      def response(env)
+        super
+        public_send(log_level, 'response', &rate_limiter_headers(env.response_headers))
+      end
+
+      # Formats the rate limiter headers.
+      # @param headers [Hash]
+      def rate_limiter_headers(headers)
+        proc do
+          [
+            limit(headers),
+            remaining(headers),
+            reset_at(headers)
+          ].join(', ')
+        end
+      end
+
+      def limit(headers)
+        "Rate Limit #{headers['x-ratelimit-limit']}"
+      end
+
+      def remaining(headers)
+        "Remaining Limit #{headers['x-ratelimit-remaining']}"
+      end
+
+      def reset_at(headers)
+        "Rate Limit Reset at #{Time.at(headers['x-ratelimit-reset'].to_i).utc}"
+      end
+    end
+  end
+end

data/lib/erp_integration/middleware/logger.rb

@@ -19,16 +19,10 @@ 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'
+        request_uuid = SecureRandom.uuid
 
-        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}")
+        @logger.with_tags(api_key_tag(api_key_fragment), request_uuid) do
           @formatter.request(env)
 
           @app.call(env).on_complete { |response| on_complete(response) }
@@ -48,6 +42,10 @@ module ErpIntegration
       def sanitize_api_key(api_key)
         api_key[-4..-1] if api_key
       end
+
+      def api_key_tag(api_key_fragment)
+        "API key *#{api_key_fragment}"
+      end
     end
   end
 end

data/lib/erp_integration/rate_limiter.rb

@@ -7,7 +7,7 @@ module ErpIntegration
     # 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
+    REQUIRED_METHODS = %i[api_key_fragment name within_limit].freeze
 
     class << self
       # Validates that the rate limiter object responds to the required methods.
@@ -29,7 +29,7 @@ module ErpIntegration
       # @param api_key [String]
       # @return [Object] The rate limiter object.
       def find_by_api_key(api_key)
-        rate_limiters[api_key] || unlimited
+        new(rate_limiters[api_key] || unlimited)
       end
 
       # Returns an unlimited rate limiter.
@@ -53,11 +53,30 @@ module ErpIntegration
       end
     end
 
+    delegate :name, to: :@rate_limiter
+
+    def initialize(rate_limiter)
+      @rate_limiter = rate_limiter
+    end
+
+    def within_limit(&block)
+      ErpIntegration.config.logger.with_tags(@rate_limiter.name) do
+        @rate_limiter.within_limit(&block)
+      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.
+
+      attr_reader :name
+
+      def initialize
+        @name = 'unlimited'
+      end
+
       def within_limit
         yield
       end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -12,12 +12,14 @@ 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/logger'
 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'
+require_relative 'erp_integration/middleware/formatter'
 
 # 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.55.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -317,8 +317,10 @@ files:
 - lib/erp_integration/gift_card.rb
 - lib/erp_integration/internal_shipment.rb
 - lib/erp_integration/location.rb
+- lib/erp_integration/logger.rb
 - lib/erp_integration/middleware/api_keys_rotation.rb
 - lib/erp_integration/middleware/error_handling.rb
+- lib/erp_integration/middleware/formatter.rb
 - lib/erp_integration/middleware/logger.rb
 - lib/erp_integration/party_address.rb
 - lib/erp_integration/product.rb
@@ -369,7 +371,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