checkout_sdk 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26bd6c4871771d8d22c647b6724c577af0434c881b9af1433959cb1e4fdf98c8
-  data.tar.gz: b18c0c03cef39d44080aadbf798f76910c87fc84506ecb4d6dfcb9b6c67a5d76
+  metadata.gz: 9849ed54d294ed9bea5fdb04bb5378fb55b942a2adb0ffe0653cb5c628cc0882
+  data.tar.gz: 7bd35374ce13e3feb72eb37a16930316ab6a01ce2cc10c49245f3e5a2daf6229
 SHA512:
-  metadata.gz: abbd929efceca48389c89b804075ee1c49a18a2a99532e03445ce061221a69c07545dbd1271cbb209435ca60da1209ad3c30c585d35b15a1db1d29832023fee8
-  data.tar.gz: 2bb659ec58fa5022fd17278f9d4467ab9f18b8ca47f657240c2d8da0b76724bc13d136ab865d68d90d01b81791e2a32fb886258eaa3d9edc34f3f90b5a7fcf38
+  metadata.gz: b6f8c31a1c66aecb8b8fad6345a2b693f133b8bee59376920445caa7779db02a3f18882170318870c5f86fb728d898a4baffc32a0b71159d8b1fa4e17087c144
+  data.tar.gz: 6bdaf1a3c38c96bcafe0f52135ff77edda7a51d66946df1bc7d4b4d8e9e5729bf85f017e0a3a755567466e9132b4464428b7861ee58e56040fbf74294bc97598

data/README.md

@@ -172,6 +172,10 @@ api = CheckoutSdk.builder
                  .build
 ```
 
+If your connection uses the `raise_error` middleware, configure it as the default client does:
+`conn.response :raise_error, include_request: false` (the option needs Faraday 2.7.11 or later;
+the SDK leaves the request data out of the errors it raises in any case).
+
 You don't need to specify the URL for Faraday constructor the SDK grabs the belong URI from `CheckoutSdk::Environment`
 however if you want to
 use specific URI's without a proxy you can create the `Environment` object as follows.

data/lib/checkout_sdk/api_client.rb

@@ -52,10 +52,12 @@ module CheckoutSdk
       json_body = CheckoutSdk::JsonSerializer.to_custom_hash(body).to_json
 
       begin
-        @log.info "#{method}: /#{path}"
+        @log.info "#{method}: /#{CheckoutUtils.loggable_path(path)}"
         response = @client.run_request(method, path, json_body, headers)
       rescue Faraday::ClientError => e
-        raise CheckoutApiException, e.response
+        raise CheckoutApiException.new(e.response), cause: nil
+      rescue Faraday::Error => e
+        raise CheckoutUtils.without_request_data(e), cause: nil
       end
 
       parse_response(response)
@@ -140,10 +142,12 @@ module CheckoutSdk
         form = build_multipart_request(file_request, file)
 
         begin
-          @log.info "post: /#{path}"
+          @log.info "post: /#{CheckoutUtils.loggable_path(path)}"
           response = @multipart_client.run_request(:post, path, form, headers)
         rescue Faraday::ClientError => e
-          raise CheckoutApiException, e.response
+          raise CheckoutApiException.new(e.response), cause: nil
+        rescue Faraday::Error => e
+          raise CheckoutUtils.without_request_data(e), cause: nil
         end
 
         parse_response(response)

data/lib/checkout_sdk/checkout_utils.rb

@@ -21,11 +21,86 @@ module CheckoutSdk
       http_metadata
     end
 
+    MAX_MESSAGE_DETAILS_LENGTH = 256
+    private_constant :MAX_MESSAGE_DETAILS_LENGTH
+
+    # Returns the request path in a form safe for a single log line: the query string is left out
+    # and control characters are escaped.
+    #
+    # @param [String, nil] path
+    # @return [String]
+    def self.loggable_path(path)
+      escape_control_characters(utf8_text(path).split('?', 2).first.to_s)
+    end
+
+    # Builds an exception message from a prefix and a response body. A JSON object body adds its
+    # "key: value" pairs as details; any other non-empty body is added as is only when
+    # include_text_body is true. Details are shortened and their control characters escaped.
+    #
+    # @param [String] prefix
+    # @param [String, nil] body
+    # @param [Boolean] include_text_body
+    # @return [String]
+    def self.error_message(prefix, body, include_text_body: false)
+      text = utf8_text(body).strip
+      parsed = json_object(text)
+      details = parsed&.map { |key, value| "#{key}: #{value}" }&.join(', ')
+      details = text if details.nil? && include_text_body
+      return prefix if details.nil? || details.empty?
+
+      details = "#{details[0, MAX_MESSAGE_DETAILS_LENGTH]}..." if details.length > MAX_MESSAGE_DETAILS_LENGTH
+      "#{prefix} Details: #{escape_control_characters(details)}."
+    end
+
+    # Returns a copy of the Faraday error, of the same class and with the same backtrace and wrapped
+    # exception, that keeps only the response status, headers and body and whose message names the
+    # method and URL without the query string. Errors without a response are returned unchanged.
+    #
+    # @param [Faraday::Error] error
+    # @return [Faraday::Error]
+    def self.without_request_data(error)
+      return error if error.response.nil?
+
+      metadata = map_to_http_metadata(error.response)
+      rebuilt = error.exception(response_error_message(metadata.status_code, error.response))
+      rebuilt.instance_variable_set(:@response,
+                                    { status: metadata.status_code, headers: metadata.headers, body: metadata.body })
+      rebuilt
+    end
+
+    def self.response_error_message(status, response)
+      message = "the server responded with status #{status}"
+      request = response.is_a?(Hash) ? response[:request] : nil
+      return message unless request.is_a?(Hash) && request[:url]
+
+      "#{message} for #{request[:method].to_s.upcase} #{loggable_path(request[:url].to_s)}"
+    end
+    private_class_method :response_error_message
+
+    def self.json_object(text)
+      parsed = JSON.parse(text)
+      parsed.is_a?(Hash) ? parsed : nil
+    rescue JSON::ParserError
+      nil
+    end
+    private_class_method :json_object
+
+    # Escapes control characters and Unicode line and paragraph separators in UTF-8 text.
+    def self.escape_control_characters(text)
+      text.gsub(/[[:cntrl:]\p{Zl}\p{Zp}]/) { |char| char.dump[1..-2] }
+    end
+    private_class_method :escape_control_characters
+
+    def self.utf8_text(text)
+      text.to_s.dup.force_encoding(Encoding::UTF_8).scrub
+    end
+    private_class_method :utf8_text
+
     # @return [Faraday::Connection]
     def self.build_multipart_client
       Faraday.new do |f|
         f.request :multipart
-        f.response :raise_error
+        f.response :raise_error, include_request: false
       end
     end
 
@@ -33,7 +108,7 @@ module CheckoutSdk
     def self.build_default_client
       Faraday.new do |f|
         f.response :follow_redirects
-        f.response :raise_error
+        f.response :raise_error, include_request: false
       end
     end
   end

data/lib/checkout_sdk/error.rb

@@ -6,6 +6,16 @@ module CheckoutSdk
   class CheckoutArgumentException < CheckoutException; end
 
   class CheckoutAuthorizationException < CheckoutException
+    # @return [CheckoutSdk::HttpMetadata, nil] response status, headers and body when raised for an OAuth token response
+    attr_reader :http_metadata
+
+    # @param [String, nil] message
+    # @param [CheckoutSdk::HttpMetadata, nil] http_metadata
+    def initialize(message = nil, http_metadata = nil)
+      @http_metadata = http_metadata
+      super(message)
+    end
+
     def self.invalid_authorization(authorization_type)
       new("Operation requires #{authorization_type} authorization type.")
     end
@@ -13,6 +23,22 @@ module CheckoutSdk
     def self.invalid_key(key_type)
       new("#{key_type} is required for this operation.")
     end
+
+    # Builds the error for an unsuccessful OAuth token response from the response data only.
+    #
+    # @param [CheckoutSdk::HttpMetadata] http_metadata
+    # @return [CheckoutSdk::CheckoutAuthorizationException]
+    def self.token_request_failed(http_metadata)
+      prefix = "The OAuth token response status code (#{http_metadata.status_code}) does not indicate success."
+      new(CheckoutUtils.error_message(prefix, http_metadata.body, include_text_body: true), http_metadata)
+    end
+
+    # Builds the error for an OAuth token request that failed without a response.
+    #
+    # @return [CheckoutSdk::CheckoutAuthorizationException]
+    def self.token_request_without_response
+      new('The OAuth token request failed without a response.')
+    end
   end
 
   class CheckoutApiException < CheckoutException
@@ -35,12 +61,8 @@ module CheckoutSdk
     end
 
     def build_error_message
-      message = "The API response status code (#{http_metadata.status_code}) does not indicate success."
-      if @error_details && !@error_details.to_h.empty?
-        details = @error_details.to_h.map { |key, value| "#{key}: #{value}" }.join(', ')
-        message += " Details: #{details}."
-      end
-      message
+      prefix = "The API response status code (#{http_metadata.status_code}) does not indicate success."
+      CheckoutUtils.error_message(prefix, http_metadata.body)
     end
   end
 end

data/lib/checkout_sdk/events/events_client.rb

@@ -20,7 +20,7 @@ module CheckoutSdk
 
         # @param [String,nil] version
         def retrieve_all_event_types(version = nil)
-          query = "version=#{version}" unless version.nil?
+          query = URI.encode_www_form(version: version) unless version.nil?
           api_client.invoke_get(EVENT_TYPES, sdk_authorization, query)
         end
 

data/lib/checkout_sdk/oauth_sdk_credentials.rb

@@ -65,17 +65,7 @@ module CheckoutSdk
         scope: @scopes.join(' ')
       }
 
-      headers = { 'Content-Type': 'application/x-www-form-urlencoded' }
-      body = URI.encode_www_form data
-
-      begin
-        @log.info "post: #{authorization_uri}"
-        response = @oauth_http_client.run_request(:post, @authorization_uri, body, headers)
-      rescue Faraday::ClientError => e
-        raise CheckoutAuthorizationException, e.response
-      rescue Faraday::ConnectionFailed => e
-        raise CheckoutArgumentException, e.wrapped_exception
-      end
+      response = request_access_token(URI.encode_www_form(data))
 
       if !response.body.nil? && response.body != ''
         oauth_response = JSON.parse(response.body, object_class: OpenStruct)
@@ -90,6 +80,23 @@ module CheckoutSdk
 
     private
 
+    # @param [String] body
+    # @return [Faraday::Response]
+    def request_access_token(body)
+      headers = { 'Content-Type': 'application/x-www-form-urlencoded' }
+      @log.info "post: #{CheckoutUtils.loggable_path(authorization_uri)}"
+      @oauth_http_client.run_request(:post, @authorization_uri, body, headers)
+    rescue Faraday::ClientError => e
+      raise CheckoutAuthorizationException.token_request_without_response if e.response.nil?
+
+      raise CheckoutAuthorizationException.token_request_failed(CheckoutUtils.map_to_http_metadata(e.response)),
+            cause: nil
+    rescue Faraday::ConnectionFailed => e
+      raise CheckoutArgumentException, e.wrapped_exception
+    rescue Faraday::Error => e
+      raise CheckoutUtils.without_request_data(e), cause: nil
+    end
+
     # @param [String] client_id
     # @param [String] client_secret
     # @param [Environment] environment

data/lib/checkout_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CheckoutSdk
-  VERSION = '2.8.0'
+  VERSION = '2.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-11-02 00:00:00.000000000 Z
+date: 2026-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement