pcp-server-ruby-sdk 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb0118721663f462f5bc434e7b2df5d76e517f2865d03d666cd32dbce5133fca
-  data.tar.gz: 37c389d8f6d02e865f4713f93b7d0745c232846acc797e697a1295de7921db43
+  metadata.gz: b8ce0d57a0a0e4d9c198eb972c3be51d325e4f12a54ec51d71dc12e84ad0b6d8
+  data.tar.gz: 5768198ed551baecf7a798f281a68e3134b783d49f8eb0848c64ea6cbb1714e3
 SHA512:
-  metadata.gz: 4f2912be3416517cb213a8d50196879fe2fa60248d011d83d19bced6d1f4b6d20abbf279b59dd68f837dd1d8df0f243431b50c571a2012a2ae940ca264512b07
-  data.tar.gz: 48c4c4540f71b982ca05b17c7e4d357835eee938b7164e059890a2dc85a906018a720201c5f3840fb0dc86494f25026beba0e7c5fcbb1108d1574f5f1c99c3ff
+  metadata.gz: 6d6b1ff0f33d0d2c138813a86300ad55f6be2763476de2b71448c340d2be00b14cb3bad7a99348452a683042cc6e5f94e8911dccfb7a18a5d1682e27bb77aace
+  data.tar.gz: aab39f7785eac2e22e312fe70764840809a74d9b2443d5542650feedd32b41109795c9799b6b4b40e66cb6228f21901823a40ae125d6ac6d86b1ed7f04f947a8

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.3.1](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/compare/v0.0.6...v1.3.1) (2025-09-04)
+
+### Bug Fixes
+
+* fix: update version script to actually set the version ([9193d60c4e3f3160ef628c8e093573394a802bc4](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/9193d60c4e3f3160ef628c8e093573394a802bc4))
+
+### Documentation
+
+* docs: add section about custom http client to readme ([07992f759ba6fe9b435ce37a17eb3aeff537456c](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/07992f759ba6fe9b435ce37a17eb3aeff537456c))
+* docs: clarify comment for category attribute in APIError class ([ccafb6db2bc474bb07a30a1fda7ff6e730a8137d](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/ccafb6db2bc474bb07a30a1fda7ff6e730a8137d))
+* docs: improve comment clarity for tax_amount_per_unit attribute in OrderLineDetailsInput model ([37fcf28f22a1a9ccf93689c21c07f06d2e3249a8](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/37fcf28f22a1a9ccf93689c21c07f06d2e3249a8))
+* docs: update docs ([a4b33ef94dc183847f5be0288c84312c0dd8cfba](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/a4b33ef94dc183847f5be0288c84312c0dd8cfba))
+* docs: update readme ([39af578246533fda6b3bed100a4fbf66371885b7](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/39af578246533fda6b3bed100a4fbf66371885b7))
+* docs: update README with new badge links and API version ([c69507cd4b9da665fb686576c0900570462fc1bf](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/c69507cd4b9da665fb686576c0900570462fc1bf))
+
+### Features
+
+* feat: add apple pay transformer and tests ([110182da3735202d0d3ee2b6bde2f57739221d49](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/110182da3735202d0d3ee2b6bde2f57739221d49))
+* feat: add auth client ([c8fd009b11a8ec3416a33ecab949ec2c51406e7e](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/c8fd009b11a8ec3416a33ecab949ec2c51406e7e))
+* feat: add BusinessRelation class and update customer model to use it ([68ab9fc5c41aad7f3f967b75b1ecdd0ac02cba63](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/68ab9fc5c41aad7f3f967b75b1ecdd0ac02cba63))
+* feat: add CustomerAccount class and integrate it into Customer class ([ee1600ec78d66498cc758b4c931f510dd3ffb4c7](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/ee1600ec78d66498cc758b4c931f510dd3ffb4c7))
+* feat: add fraud_net_id attribute to RedirectPaymentProduct840SpecificInput model ([27ec17cce2fb42eb37116790ce2dd106502487c0](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/27ec17cce2fb42eb37116790ce2dd106502487c0))
+* feat: add RecurringPaymentSequenceIndicator class and update CardRecurrenceDetails to use it ([e2507f4328a297dc700fa1635029a1599fa58101](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/e2507f4328a297dc700fa1635029a1599fa58101))
+* feat: allow customization of http client ([98df1ad32cfa6956b3710f3b22dd6ad1cd61fa3c](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/98df1ad32cfa6956b3710f3b22dd6ad1cd61fa3c))
+* feat: implement ActionType class and update MerchantAction to use it ([8e259dc45f4e20ea0a10a351a3abdc86926b91f1](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/8e259dc45f4e20ea0a10a351a3abdc86926b91f1))
+* feat: implement api level 1.28.0 ([b26df0bc2da08cd900775c45bd64f5db120ede0a](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/b26df0bc2da08cd900775c45bd64f5db120ede0a))
+* feat: implement AvsResult enum class and update CardFraudResults to use it ([c0a40cc08aa878afaae93851be1619907e7c5e86](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/commit/c0a40cc08aa878afaae93851be1619907e7c5e86))
+
 # [1.3.0](https://github.com/PAYONE-GmbH/PCP-ServerSDK-ruby/compare/v1.2.0...v1.3.0) (2025-07-10)
 
 ### Features

data/README.md

@@ -113,6 +113,111 @@ When making a request any client may throw a `PCPServerSDK::Errors::ApiException
 
 Network errors are not wrap, you can should handle the standard `IOExeption`.
 
+### HTTP Client Customization
+
+The SDK allows you to customize the underlying HTTP client used for API requests. This provides flexibility to configure timeouts, SSL settings, proxies, and other HTTP-specific options according to your application's needs.
+
+#### Global HTTP Client Configuration
+
+You can set a global HTTP client that will be used by all API clients:
+
+```rb
+require 'pcp-server-ruby-sdk'
+
+# Option 1: Using a custom Net::HTTP instance
+custom_http = Net::HTTP.new('api.preprod.commerce.payone.com', 443)
+custom_http.use_ssl = true
+custom_http.read_timeout = 30
+custom_http.open_timeout = 10
+
+communicator_configuration = PCPServerSDK::CommunicatorConfiguration.new(
+  api_key,
+  api_secret,
+  'https://api.preprod.commerce.payone.com',
+  custom_http
+)
+
+# Option 2: Using a factory proc for dynamic client creation
+http_factory = proc do |uri|
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = uri.scheme == 'https'
+  http.read_timeout = 60
+  http.open_timeout = 15
+  # Add custom headers, proxy settings, etc.
+  http
+end
+
+communicator_configuration = PCPServerSDK::CommunicatorConfiguration.new(
+  api_key,
+  api_secret,
+  'https://api.preprod.commerce.payone.com',
+  http_factory
+)
+
+# Option 3: Set after initialization
+communicator_configuration.http_client = custom_http
+```
+
+#### Client-Specific HTTP Client Configuration
+
+You can also set HTTP clients for individual API clients, which will override the global configuration:
+
+```rb
+require 'pcp-server-ruby-sdk'
+
+# Create a specific HTTP client for this API client
+commerce_case_http = Net::HTTP.new('api.preprod.commerce.payone.com', 443)
+commerce_case_http.use_ssl = true
+commerce_case_http.read_timeout = 45
+
+# Pass it to the API client constructor
+commerce_case_client = PCPServerSDK::Endpoints::CommerceCaseApiClient.new(
+  communicator_configuration,
+  commerce_case_http
+)
+
+# Or set it after initialization
+commerce_case_client.http_client = commerce_case_http
+```
+
+#### Priority Logic
+
+The SDK uses the following priority order when determining which HTTP client to use:
+
+1. **Client-specific HTTP client** (set on individual API client instances)
+2. **Global HTTP client** (set in CommunicatorConfiguration)
+3. **Default HTTP client** (created automatically by the SDK)
+
+#### HTTP Client Factory Pattern
+
+For advanced use cases, you can provide a factory (Proc or any callable object) that creates HTTP clients dynamically:
+
+```rb
+# Factory that creates clients with different configurations based on the URI
+adaptive_factory = proc do |uri|
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = uri.scheme == 'https'
+
+  # Configure based on environment or URI
+  if uri.host.include?('preprod')
+    http.read_timeout = 60  # Longer timeout for preprod
+  else
+    http.read_timeout = 30  # Standard timeout for production
+  end
+
+  http
+end
+
+communicator_configuration.http_client = adaptive_factory
+```
+
+This customization allows you to:
+- Configure custom timeouts and connection settings
+- Set up proxy configurations
+- Add custom SSL/TLS settings
+- Implement retry logic or circuit breakers
+- Add request/response logging or monitoring
+
 ### Client Side
 
 For most [payment methods](https://docs.payone.com/pcp/commerce-platform-payment-methods) some information from the client is needed, e.g. payment information given by Apple when a payment via ApplePay suceeds. PAYONE provides client side SDKs which helps you interact the third party payment providers. You can find the SDKs under the [PAYONE GitHub organization](https://github.com/PAYONE-GmbH). Either way ensure to never store or even send credit card information to your server. The PAYONE Commerce Platform never needs access to the credit card information. The client side is responsible for safely retrieving a credit card token. This token must be used with this SDK.

data/example-app/example.rb

@@ -3,6 +3,74 @@
 require_relative '../lib/PCP-server-Ruby-SDK.rb'
 require_relative 'commerce_case_api_example'
 
+def demonstrate_http_client_customization(api_key, api_secret)
+  puts "\n=== HTTP Client Customization Examples ==="
+
+  # Example 1: Global HTTP client with custom timeouts
+  puts "\n1. Global HTTP client with custom timeouts:"
+  custom_http = Net::HTTP.new('api.preprod.commerce.payone.com', 443)
+  custom_http.use_ssl = true
+  custom_http.read_timeout = 30
+  custom_http.open_timeout = 10
+
+  config_with_custom_http = PCPServerSDK::CommunicatorConfiguration.new(
+    api_key,
+    api_secret,
+    'https://api.preprod.commerce.payone.com',
+    custom_http
+  )
+
+  puts "  - Read timeout: #{config_with_custom_http.http_client.read_timeout}s"
+  puts "  - Open timeout: #{config_with_custom_http.http_client.open_timeout}s"
+
+  # Example 2: HTTP client factory with dynamic configuration
+  puts "\n2. HTTP client factory with dynamic configuration:"
+  http_factory = proc do |uri|
+    puts "  - Creating HTTP client for: #{uri.host}:#{uri.port}"
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.scheme == 'https'
+    http.read_timeout = 60
+    http.open_timeout = 15
+    http
+  end
+
+  config_with_factory = PCPServerSDK::CommunicatorConfiguration.new(
+    api_key,
+    api_secret,
+    'https://api.preprod.commerce.payone.com',
+    http_factory
+  )
+
+  puts "  - Factory configured for dynamic client creation"
+
+  # Example 3: Client-specific HTTP client
+  puts "\n3. Client-specific HTTP client override:"
+  client_specific_http = Net::HTTP.new('api.preprod.commerce.payone.com', 443)
+  client_specific_http.use_ssl = true
+  client_specific_http.read_timeout = 45
+
+  commerce_case_client = PCPServerSDK::Endpoints::CommerceCaseApiClient.new(
+    config_with_custom_http,
+    client_specific_http
+  )
+
+  puts "  - Client-specific timeout: #{commerce_case_client.http_client.read_timeout}s"
+  puts "  - This overrides the global configuration"
+
+  # Example 4: Setting HTTP client after initialization
+  puts "\n4. Setting HTTP client after initialization:"
+  auth_client = PCPServerSDK::Endpoints::AuthenticationApiClient.new(config_with_custom_http)
+
+  post_init_http = Net::HTTP.new('api.preprod.commerce.payone.com', 443)
+  post_init_http.use_ssl = true
+  post_init_http.read_timeout = 20
+
+  auth_client.http_client = post_init_http
+  puts "  - HTTP client set after initialization with #{auth_client.http_client.read_timeout}s timeout"
+
+  puts "\n=== HTTP Client Customization Examples Complete ==="
+end
+
 def run
   api_key = ENV['API_KEY']
   api_secret = ENV['API_SECRET']
@@ -29,6 +97,9 @@ def run
   # commerce_case_api_client_example.run_get_one
   # commerce_case_api_client_example.run_update_one
   commerce_case_api_client_example.run_auth_token_example
+
+  # Demonstrate HTTP client customization
+  demonstrate_http_client_customization(api_key, api_secret)
 end
 
 run

data/lib/PCP-server-Ruby-SDK/communicator_configuration.rb

@@ -2,15 +2,18 @@
 module PCPServerSDK
   class CommunicatorConfiguration
     attr_reader :api_key, :api_secret, :host
-  
+    attr_accessor :http_client
+
     # The constructor
     # @param [String] api_key
     # @param [String] api_secret
     # @param [String] host
-    def initialize(api_key, api_secret, host)
+    # @param [Net::HTTP, Proc, nil] http_client Optional HTTP client instance or factory proc
+    def initialize(api_key, api_secret, host, http_client = nil)
       @api_key = api_key
       @api_secret = api_secret
       @host = host
+      @http_client = http_client
     end
-  end  
+  end
 end

data/lib/PCP-server-Ruby-SDK/endpoints/authentication_api_client.rb

@@ -9,6 +9,10 @@ module PCPServerSDK
   module Endpoints
     # Client for authentication token operations
     class AuthenticationApiClient < BaseApiClient
+      def initialize(config, http_client = nil)
+        super(config, http_client)
+      end
+
       def get_authentication_tokens(merchant_id, request_id = nil)
         raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
 

data/lib/PCP-server-Ruby-SDK/endpoints/base_api_client.rb

@@ -15,11 +15,13 @@ PAYLOAD_REQUIRED_ERROR = 'Payload is required'
 
 module PCPServerSDK
   module Endpoints
-    
     class BaseApiClient
-      def initialize(config)
+      attr_accessor :http_client
+
+      def initialize(config, http_client = nil)
         @config = config
         @request_header_generator = RequestHeaderGenerator.new(config)
+        @http_client = http_client
       end
 
     protected
@@ -33,13 +35,12 @@ module PCPServerSDK
       # @param [Hash] request_init
       def make_api_call(url, request_init)
         uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = uri.scheme == 'https'
-        
+        http = get_http_client(uri)
+
         modified_request = @request_header_generator.generate_additional_request_headers(url, request_init || {})
-        
+
         request = build_http_request(uri, modified_request)
-        response = get_response(http, request)    
+        response = get_response(http, request)
         handle_error(response)
 
         JSON.parse(response.body)
@@ -51,12 +52,62 @@ module PCPServerSDK
 
     private
 
+      # Get the HTTP client with priority logic:
+      # 1. Client-specific http_client (instance variable)
+      # 2. Global http_client from configuration
+      # 3. Default Net::HTTP client
+      # @param [URI] uri
+      # @return [Net::HTTP]
+      def get_http_client(uri)
+        # Priority 1: Client-specific HTTP client
+        if @http_client
+          return resolve_http_client(@http_client, uri)
+        end
+
+        # Priority 2: Global HTTP client from configuration
+        if @config.http_client
+          return resolve_http_client(@config.http_client, uri)
+        end
+
+        # Priority 3: Default HTTP client
+        create_default_http_client(uri)
+      end
+
+      # Resolve HTTP client from various input types
+      # @param [Net::HTTP, Proc, Object] client_or_factory
+      # @param [URI] uri
+      # @return [Net::HTTP]
+      def resolve_http_client(client_or_factory, uri)
+        case client_or_factory
+        when Net::HTTP
+          client_or_factory
+        when Proc
+          client_or_factory.call(uri)
+        else
+          # If it responds to call, treat it as a factory
+          if client_or_factory.respond_to?(:call)
+            client_or_factory.call(uri)
+          else
+            raise ArgumentError, "HTTP client must be a Net::HTTP instance, Proc, or respond to :call"
+          end
+        end
+      end
+
+      # Create default HTTP client
+      # @param [URI] uri
+      # @return [Net::HTTP]
+      def create_default_http_client(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http
+      end
+
       # Get the response
       # @param [Net::HTTP] http
       # @param [Net::HTTP::Request] request
       # @return [Net::HTTP::Response]
       def get_response(http, request)
-        http.request(request) 
+        http.request(request)
       end
 
       def handle_error(response)

data/lib/PCP-server-Ruby-SDK/endpoints/checkout_api_client.rb

@@ -11,8 +11,8 @@ module PCPServerSDK
   module Endpoints
     
     class CheckoutApiClient < BaseApiClient
-      def initialize(config)
-        super(config)
+      def initialize(config, http_client = nil)
+        super(config, http_client)
       end
 
       # Create a checkout

data/lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb

@@ -10,8 +10,8 @@ module PCPServerSDK
   module Endpoints
     
     class CommerceCaseApiClient < BaseApiClient
-      def initialize(config)
-        super(config)
+      def initialize(config, http_client = nil)
+        super(config, http_client)
       end
 
       # Create a commerce case

data/lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb

@@ -10,8 +10,8 @@ module PCPServerSDK
   module Endpoints
     
     class OrderManagementCheckoutActionsApiClient < BaseApiClient
-      def initialize(config)
-        super(config)
+      def initialize(config, http_client = nil)
+        super(config, http_client)
       end
 
       # Create an order

data/lib/PCP-server-Ruby-SDK/endpoints/payment_execution_api_client.rb

@@ -13,8 +13,8 @@ module PCPServerSDK
     class PaymentExecutionApiClient < BaseApiClient
       PAYMENT_EXECUTION_ID_REQUIRED_ERROR = 'Payment Execution ID is required'
 
-      def initialize(config)
-        super(config)
+      def initialize(config, http_client = nil)
+        super(config, http_client)
       end
 
       # Create a payment

data/lib/PCP-server-Ruby-SDK/endpoints/payment_information_api_client.rb

@@ -11,8 +11,8 @@ module PCPServerSDK
     class PaymentInformationApiClient < BaseApiClient
       PAYMENT_INFORMATION_ID_REQUIRED_ERROR = 'Payment Information ID is required'
 
-      def initialize(config)
-        super(config)
+      def initialize(config, http_client = nil)
+        super(config, http_client)
       end
 
       # Create a payment information

data/lib/PCP-server-Ruby-SDK/version.rb

@@ -1,4 +1,4 @@
 
 module PCPServerSDK
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end