fulfil_api 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b08b66a980bb816b1424c5bdf4b6f07bdc652a0dc0838715b6176dd8dd3a52ac
-  data.tar.gz: e659a978bd939c89aafc27bab91d36c3af9daad8c2779f8e87ff7f9dc8203766
+  metadata.gz: e5088d4a6e17bfc91b7dbdbd841db0d649bbc7fc16e295fb63a1cf8d4e80436a
+  data.tar.gz: 30f89d00763dde2c6d2b1573ded61440097b87904dae062c7f8ee147de9621e0
 SHA512:
-  metadata.gz: 1da9f24a29088c2a177717731176b75ba29fcd9db6281ea7834ec2627e76b3b9029fb7f006ab428caba8035e68c39e221f77cf903145058820a2ebbb93e73552
-  data.tar.gz: de48831aca1ac5ebc8aed263e61ccd0bdb25728240504dbf43c6a91c298f253e8d566141a29c7cab7c67b2d8366704b0f1d4b40f436dd9ea005c582df5f4086e
+  metadata.gz: 35aa477f5a29a3597d7567bcb8f6708fb89cb13d20c0f848cb06dd46f381bbff94dbddb36bf6fb95d9e544f01c7e94989f44ab872e1ed891f5ea254dfa358727
+  data.tar.gz: de45ced7efb091fc5cfcce224310afab14b233f97197887d94137f2c31007b43b363db424a1478108a8469e1813eeb980a71febe0d4c55f6b6e63d101a57c35b

data/lib/fulfil_api/client.rb

@@ -5,6 +5,36 @@ require "faraday/net_http_persistent"
 
 module FulfilApi
   class Client
+    @connection_cache = {}
+    @connection_cache_mutex = Mutex.new
+
+    class << self
+      # Looks up a memoized {Faraday::Connection} for the given cache key, or
+      #   builds and stores one by yielding the block.
+      #
+      # The cache is process-wide, so the underlying `net_http_persistent` adapter
+      #   can actually reuse its TCP/TLS connection pool across requests. Without
+      #   this, each `FulfilApi.client` call would instantiate a fresh Faraday
+      #   connection, defeating the purpose of the persistent adapter.
+      #
+      # @param cache_key [Array] A key uniquely identifying the connection.
+      # @yieldreturn [Faraday::Connection] The newly built connection.
+      # @return [Faraday::Connection]
+      def connection_for(cache_key)
+        @connection_cache_mutex.synchronize do
+          @connection_cache[cache_key] ||= yield
+        end
+      end
+
+      # Clears the memoized connection cache. Intended for use in test suites
+      #   that need to isolate connection state between tests.
+      #
+      # @return [void]
+      def reset_connection_cache!
+        @connection_cache_mutex.synchronize { @connection_cache.clear }
+      end
+    end
+
     # @param configuration [FulfilApi::Configuration]
     def initialize(configuration)
       @configuration = configuration
@@ -56,13 +86,29 @@ module FulfilApi
       @api_endpoint ||= "https://#{configuration.merchant_id}.fulfil.io"
     end
 
+    # Returns a {Faraday::Connection} for the current configuration, reusing the
+    #   memoized connection from the class-level cache whenever possible.
+    #
     # @return [Faraday::Connection]
     def connection
-      @connection ||= Faraday.new(
-        headers: request_headers,
-        url: api_endpoint,
-        request: configuration.request_options
-      ) do |connection|
+      self.class.connection_for(connection_cache_key) { build_connection }
+    end
+
+    # Builds a fresh {Faraday::Connection} for the current configuration.
+    #
+    # The connection carries no credentials — authentication headers are applied
+    #   per-request in {#request}. This keeps tokens out of any long-lived data
+    #   structure (cache keys, the connection's default headers) and lets a single
+    #   connection be shared across configurations that target the same merchant
+    #   with different access tokens.
+    #
+    # No `Content-Type` header is set on the connection. The `:json` request
+    #   middleware adds it on requests that actually have a body, so bodyless
+    #   verbs (GET, DELETE) are not sent with a misleading content type.
+    #
+    # @return [Faraday::Connection]
+    def build_connection
+      Faraday.new(url: api_endpoint, request: configuration.request_options) do |connection|
         connection.adapter :net_http_persistent # TODO: Allow passing configuration options
 
         # Configuration of the request middleware
@@ -74,6 +120,11 @@ module FulfilApi
       end
     end
 
+    # @return [Array] The cache key identifying a unique connection.
+    def connection_cache_key
+      [configuration.merchant_id, configuration.request_options]
+    end
+
     # @param relative_path [String] The relative path to the API endpoint.
     # @return [String] The absolute path for the request to the API endpoint.
     def expand_relative_path(relative_path)
@@ -98,17 +149,26 @@ module FulfilApi
     # @param relative_path [String] The relative path to the API endpoint.
     # @return [Array, Hash, String] The parsed response body.
     def request(method, relative_path, *args, **kwargs)
-      connection.send(method.to_sym, expand_relative_path(relative_path), *args, **kwargs).body
+      response = connection.send(method.to_sym, expand_relative_path(relative_path), *args, **kwargs) do |req|
+        apply_authentication(req)
+      end
+
+      response.body
     rescue Faraday::Error => e
       handle_request_error(e)
     end
 
-    # @return [Hash] The HTTP headers for any HTTP request to Fulfil.
-    def request_headers
-      default_headers = { "Content-Type" => "application/json" }
-      return default_headers if configuration.access_token.nil?
+    # Applies the configured access token to the request as an HTTP header.
+    #
+    # Authentication is set per-request rather than on the shared {#connection},
+    #   so the connection cache does not need to know about credentials.
+    #
+    # @param request [Faraday::Request] The request being prepared.
+    # @return [void]
+    def apply_authentication(request)
+      return if configuration.access_token.nil?
 
-      default_headers.merge(**configuration.access_token.to_http_header)
+      configuration.access_token.to_http_header.each { |name, value| request.headers[name] = value }
     end
   end
 

data/lib/fulfil_api/error.rb

@@ -15,7 +15,21 @@ module FulfilApi
 
     # @return [String]
     def message
+      body_message = parsed_body_message
+      return "[FulfilApi::Error] #{body_message}" if body_message
+
       "[FulfilApi::Error] #{super}"
     end
+
+    private
+
+    def parsed_body_message
+      body = details&.dig(:response_body)
+      return unless body
+
+      JSON.parse(body)
+    rescue JSON::ParserError
+      nil
+    end
   end
 end

data/lib/fulfil_api/tpl_client.rb

@@ -16,6 +16,36 @@ module FulfilApi
 
     DEFAULT_API_VERSION = "v1"
 
+    @connection_cache = {}
+    @connection_cache_mutex = Mutex.new
+
+    class << self
+      # Looks up a memoized {Faraday::Connection} for the given cache key, or
+      #   builds and stores one by yielding the block.
+      #
+      # The cache is process-wide, so the underlying `net_http_persistent` adapter
+      #   can actually reuse its TCP/TLS connection pool across requests. Without
+      #   this, each `FulfilApi.tpl_client` call would instantiate a fresh Faraday
+      #   connection, defeating the purpose of the persistent adapter.
+      #
+      # @param cache_key [Array] A key uniquely identifying the connection.
+      # @yieldreturn [Faraday::Connection] The newly built connection.
+      # @return [Faraday::Connection]
+      def connection_for(cache_key)
+        @connection_cache_mutex.synchronize do
+          @connection_cache[cache_key] ||= yield
+        end
+      end
+
+      # Clears the memoized connection cache. Intended for use in test suites
+      #   that need to isolate connection state between tests.
+      #
+      # @return [void]
+      def reset_connection_cache!
+        @connection_cache_mutex.synchronize { @connection_cache.clear }
+      end
+    end
+
     # @param configuration [FulfilApi::Configuration]
     def initialize(configuration)
       @configuration = configuration
@@ -77,10 +107,23 @@ module FulfilApi
       @api_endpoint ||= "https://#{merchant_id}.fulfil.io"
     end
 
+    # Returns a {Faraday::Connection} for the current configuration, reusing the
+    #   memoized connection from the class-level cache whenever possible.
+    #
     # @return [Faraday::Connection]
     def connection
-      @connection ||= Faraday.new(
-        headers: request_headers,
+      self.class.connection_for(connection_cache_key) { build_connection }
+    end
+
+    # Builds a fresh {Faraday::Connection} for the current configuration.
+    #
+    # The connection carries no credentials — the bearer token is applied
+    #   per-request in {#request}, keeping it out of long-lived data structures
+    #   such as cache keys or default connection headers.
+    #
+    # @return [Faraday::Connection]
+    def build_connection
+      Faraday.new(
         url: api_endpoint,
         request: configuration.request_options
       ) do |connection|
@@ -95,6 +138,11 @@ module FulfilApi
       end
     end
 
+    # @return [Array] The cache key identifying a unique connection.
+    def connection_cache_key
+      [merchant_id, api_version, configuration.request_options]
+    end
+
     # @param relative_path [String] The relative path to the API endpoint.
     # @return [String] The absolute path for the request to the API endpoint.
     def expand_relative_path(relative_path)
@@ -119,16 +167,24 @@ module FulfilApi
     # @param relative_path [String] The relative path to the API endpoint.
     # @return [Array, Hash, String] The parsed response body.
     def request(method, relative_path, *args, **kwargs)
-      connection.send(method.to_sym, expand_relative_path(relative_path), *args, **kwargs).body
+      response = connection.send(method.to_sym, expand_relative_path(relative_path), *args, **kwargs) do |req|
+        apply_authentication(req)
+      end
+
+      response.body
     rescue Faraday::Error => e
       handle_request_error(e)
     end
 
-    # @return [Hash] The HTTP headers for any HTTP request to the 3PL API.
-    def request_headers
-      {
-        "Authorization" => "Bearer #{auth_token}"
-      }
+    # Applies the configured bearer token to the request as an HTTP header.
+    #
+    # Authentication is set per-request rather than on the shared {#connection},
+    #   so the connection cache does not need to know about credentials.
+    #
+    # @param request [Faraday::Request] The request being prepared.
+    # @return [void]
+    def apply_authentication(request)
+      request.headers["Authorization"] = "Bearer #{auth_token}"
     end
   end
 

data/lib/fulfil_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FulfilApi
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Stefan Vermaas
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A HTTP client to interact the Fulfil.io API
 test_files: []