onlinepayments-sdk-ruby 4.23.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987bf75ee1540bd8abf3a28d9906db7e94f1375dd4f1fa5633a32b87a5ca0ae5
-  data.tar.gz: 232425d9abf5e0c208264d6fc38133cddbfc0d8b1a372860b31d1c699d0ce403
+  metadata.gz: 6dc4e740cbc9653b392253ba2f6266a6ca88f5b2721c029dfc2e11b08c3bea93
+  data.tar.gz: 1d7f251e223133008f132baac2d771a4349744868ce381ab8d294333014beaa9
 SHA512:
-  metadata.gz: f6287c6f28f6940aa3d0925f64b5906f24d2d85908b9909a65e075a4347930a49edb2d72a888c8eef4cc1970cc04a5b8bdbaf5245601c26c1300788ae3951d50
-  data.tar.gz: ffb47f7328e8216c595fe4978fd8394633fca9323806a6843c3e5a67ef0643059257f3d260b861d669c474a602c55827e4e54cbef636f0881a109f5108b15d8e
+  metadata.gz: 206a8aec1a179fb3b3918f20c5e4aad8ff5737087de7194fffa7bc6ee6eaf09d44c5f87ee98f2436dd3b290359518678822367a1b09ef3d76cf1d674e739b4b1
+  data.tar.gz: 93c319108e40291f2f5ae50acbe6df67e1000f77214008b70a81e5c7e1bc030e7286cd4b7139942bae39249139b6bdf398b57b7d526cc81bdad5ff5e014a2143

data/README.md

@@ -8,7 +8,7 @@ The Ruby SDK helps you to communicate with the payment platform server API. Its
     * marshalls Ruby request objects to HTTP requests
     * unmarshalls HTTP responses to Ruby response objects or Ruby exceptions
 * handling of all the details concerning authentication
-* handling of required meta data
+* handling of required metadata
 
 Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys. 
 
@@ -80,11 +80,9 @@ After the Ruby SDK has been installed, it can be required in Ruby program as fol
 
 There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
 First, some environment variables need to be set:
-
-* `onlinePayments_api_apiKeyId` for the API key id to use. This can be retrieved from the Configuration Center.
-* `onlinePayments_api_secretApiKey` for the secret API key to use. This can be retrieved from the Configuration Center.
+* `onlinePayments_api_v1hmac_apiKeyId` for the API key id to use. This can be retrieved from the Configuration Center.
+* `onlinePayments_api_v1hmac_secretApiKey` for the secret API key to use. This can be retrieved from the Configuration Center.
 * `onlinePayments_api_merchantId` for your merchant ID.
-
 In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the `spec/fixtures/resources/properties.proxy.yml` file.
 
 In order to run the unit and integration tests, some additional dependencies are required:
@@ -92,7 +90,8 @@ In order to run the unit and integration tests, some additional dependencies are
 * [rake](https://ruby.github.io/rake/) 12.3.3 or higher
 * [rspec](https://github.com/rspec/rspec) 3.5 or higher
 * [webmock](https://github.com/bblimke/webmock) 2.1 or higher
-* [sinatra](https://github.com/sinatra/sinatra) 1.4 or higher
+* [sinatra](https://github.com/sinatra/sinatra) 2.1 or higher
+* [webrick](https://github.com/ruby/webrick) 1.7 or higher
 
 They can be installed using the following command:
 

data/lib/onlinepayments/sdk/api_exception.rb

@@ -1,42 +1,54 @@
-module OnlinePayments::SDK
+#
+# This file was automatically generated.
+#
+require 'onlinepayments/sdk/domain/api_error'
 
-  # Base class for many exceptions raised by the SDK.
-  # It is raised when an error response is received from the Online Payments platform.
-  # It contains data about the returned response.
-  #
-  # @attr_reader [Integer] status_code   HTTP status code of the returned response.
-  # @attr_reader [String]  response_body Message body of the returned response.
-  # @attr_reader [String]  error_id      An error id corresponding to the error that occurred, if available.
-  # @attr_reader [Array<OnlinePayments::SDK::Domain::APIError>] errors A list of errors received from the Online Payments platform;
-  #              may be empty but never _nil_
-  class ApiException < RuntimeError
-
-    # Creates a new ApiException that reports an error response from the Online Payments platform.
+module OnlinePayments
+  module SDK
+    # Represents an error response from the payment platform which contains an ID and a list of errors.
     #
-    # @param status_code   (Integer) HTTP status code the response
-    # @param response_body (String) HTTP response body
-    # @param error_id      (String) error id of the error, may be _nil_
-    # @param errors        (Array<OnlinePayments::SDK::Domain::APIError>) a list of errors that occurred, may be empty
-    # @param message       (String) error message to include
-    def initialize(status_code, response_body, error_id, errors,
-                   message = 'the Online Payments platform returned an error response')
-      super(message)
-      @status_code = status_code
-      @response_body = response_body
-      @error_id = error_id
-      @errors = errors || [].freeze
-    end
+    # @attr_reader [Integer] status_code   HTTP status code of the returned response.
+    # @attr_reader [String]  response_body Message body of the returned response.
+    # @attr_reader [String] error_id The _errorId_ received from the Payment platform if available.
+    # @attr_reader [Array<OnlinePayments::SDK::Domain::APIError>] errors The _errors_ received from the Payment platform if available;
+    #              may be empty but never _nil_
+    class ApiException < RuntimeError
+
+      # Creates a new ApiException that reports an error response from the Payment platform.
+      #
+      # @param status_code   (Integer) HTTP status code the response
+      # @param response_body (String) HTTP response body
+      # @param error_id      (String) The _errorId_ received from the Payment platform
+      # @param errors        (Array<OnlinePayments::SDK::Domain::APIError>) The _errors_ received from the Payment platform
+      # @param message       (String) error message to include
+      def initialize(status_code, response_body, error_id, errors,
+                     message='the payment platform returned an error response')
+        super(message)
+        @status_code = status_code
+        @response_body = response_body
+        @error_id = error_id
+        if errors.nil?
+          @errors = [].freeze
+        else
+          @errors = errors
+        end
+      end
 
-    attr_reader :status_code
-    attr_reader :response_body
-    attr_reader :error_id
-    attr_reader :errors
+      attr_reader :status_code
+      attr_reader :response_body
+      attr_reader :error_id
+      attr_reader :errors
 
-    def to_s
-      str = super.to_s
-      str += "; status_code=#{@status_code}" if @status_code.positive?
-      str += "; response_body='#{@response_body}'" if @response_body&.length&.positive?
-      str.to_s
+      def to_s
+        str = super.to_s
+        if @status_code > 0
+          str += '; status_code=' + @status_code.to_s
+        end
+        if !@response_body.nil? && @response_body.length > 0
+          str += "; response_body='" + @response_body + "'"
+        end
+        str.to_s
+      end
     end
   end
 end

data/lib/onlinepayments/sdk/api_resource.rb

@@ -1,115 +1,67 @@
-require 'onlinepayments/sdk/domain/error_response'
+require 'onlinepayments/sdk/communication/request_header'
 
-module OnlinePayments::SDK
-
-  # Base class of all Online Payments platform API resources.
-  # Provides shared functionality to facilitate communication with the Online Payments platform.
-  #
-  # @attr_reader [OnlinePayments::SDK::Communicator] communicator Communicator instance that provides communication with the Online Payments platform.
-  # @attr_reader [String] client_meta_info JSON string containing client info specific to the current client.
-  class ApiResource
-
-    # Creates a new ApiResource.
+module OnlinePayments
+  module SDK
+    # Base class of all Online Payments platform API resources.
+    # Provides shared functionality to facilitate communication with the Online Payments platform.
     #
-    # @param arg              [OnlinePayments::SDK::ApiResource, OnlinePayments::SDK::Communicator] parent class or Communicator instance.
-    #                         If a parent class is given its communicator will be used for communication.
-    # @param path_context     [Hash, nil] hash that contains substitutions for generic locations in the URL path.
-    #                         This hash will be used to instantiate a concrete URL used to access specific resources.
-    #                         For example in the URL https://payment.preprod.online-payments.com/!{version}/!{merchantId}/payments
-    #                         !{version} and !{merchantId} can be instantiated using the hash
-    #                         !{'version' => 'v2', 'merchantId' => '1'}. The final URL in this case will be
-    #                         https://payment.preprod.online-payments.com/v2/1/payments.
-    # @param client_meta_info [String, nil] JSON string containing the meta data for the client.
-    def initialize(arg, path_context = nil, client_meta_info = false)
-      if client_meta_info == false
-        raise ArgumentError, 'parent is required' unless arg
+    # @attr_reader [OnlinePayments::SDK::Communicator] communicator Communicator instance that provides communication with the Online Payments platform.
+    # @attr_reader [String] client_meta_info JSON string containing client info specific to the current client.
+    class ApiResource
 
-        @parent = arg
-        @communicator = arg.communicator
-        @client_meta_info = arg.client_meta_info
-      else
-        raise ArgumentError, 'communicator is required' unless arg
-
-        @parent = nil
-        @communicator = arg
-        @client_meta_info = client_meta_info
+      # Creates a new ApiResource.
+      #
+      # @param parent           [OnlinePayments::SDK::ApiResource] parent resource instance.
+      # @param communicator     [OnlinePayments::SDK::Communicator] Communicator instance.
+      # @param path_context     [Hash] hash that contains substitutions for generic locations in the URL path.
+      #                         This hash will be used to instantiate a concrete URL used to access specific resources.
+      # @param client_meta_info [String] JSON string containing the metadata for the client.
+      def initialize(parent: nil, communicator: nil, path_context: nil, client_meta_info: nil)
+        raise ArgumentError.new('parent and/or communicator is required') if parent.nil? and communicator.nil?
+        @parent = parent
+        @communicator = communicator.nil? ? parent.communicator : communicator
+        @path_context = path_context
+        @client_meta_info = client_meta_info || parent.nil? ? client_meta_info : parent.client_meta_info
       end
-      @path_context = path_context
-    end
 
-    attr_reader :communicator
-    attr_reader :client_meta_info
-
-    protected
-
-    # @return [Array<OnlinePayments::SDK::RequestHeader>, nil] the X-GCS-ClientMetaInfo header.
-    def client_headers
-      @client_meta_info ?
-        [RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)] :
-        nil
-    end
+      attr_reader :communicator
+      attr_reader :client_meta_info
 
-    def instantiate_uri(uri, path_context = nil)
-      uri = replace_all(uri, path_context) if path_context
-      uri = replace_all(uri, @path_context)
-      @parent ? @parent.instantiate_uri(uri) : uri
-    end
+      protected
 
-    def create_exception(status_code, response_body, error_object, context)
-      if error_object.nil?
-        error_id = nil
-        errors = []
-      elsif error_object.is_a?(OnlinePayments::SDK::Domain::PaymentErrorResponse) && error_object.payment_result
-        return DeclinedPaymentException.new(status_code, response_body, error_object)
-      elsif error_object.is_a?(OnlinePayments::SDK::Domain::PayoutErrorResponse) && error_object.payout_result
-        return DeclinedPayoutException.new(status_code, response_body, error_object)
-      elsif error_object.is_a?(OnlinePayments::SDK::Domain::RefundErrorResponse) && error_object.refund_result
-        return DeclinedRefundException.new(status_code, response_body, error_object)
-      elsif error_object.is_a?(OnlinePayments::SDK::Domain::PaymentErrorResponse) ||
-        error_object.is_a?(OnlinePayments::SDK::Domain::PayoutErrorResponse) ||
-        error_object.is_a?(OnlinePayments::SDK::Domain::RefundErrorResponse) ||
-        error_object.is_a?(OnlinePayments::SDK::Domain::ErrorResponse)
-        error_id = error_object.error_id
-        errors = error_object.errors
-      else
-        raise ArgumentError, "unsupported error object type: #{error_object.class.name}"
+      # @return [Array<OnlinePayments::SDK::Communication::RequestHeader>, nil] the client headers,
+      #         including the X-GCS-ClientMetaInfo header if metadata for the client is available
+      def client_headers
+        if @client_meta_info.nil?
+          nil
+        else
+          [Communication::RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)]
+        end
       end
 
-      case status_code
-      when 400
-        return ValidationException.new(status_code, response_body, error_id, errors)
-      when 403
-        return AuthorizationException.new(status_code, response_body, error_id, errors)
-      when 404, 410
-        return ReferenceException.new(status_code, response_body, error_id, errors)
-      when 409
-        if is_idempotence_error(errors, context)
-          idempotence_key = context.idempotence_key
-          idempotence_request_timestamp = context.idempotence_request_timestamp
-          return IdempotenceException.new(status_code, response_body, error_id,
-                                          errors, idempotence_key,
-                                          idempotence_request_timestamp)
+      def instantiate_uri(uri, path_context = nil)
+        if path_context
+          uri = replace_all(uri, path_context)
+          instantiate_uri(uri)
         else
-          return ReferenceException.new(status_code, response_body, error_id, errors)
+          uri = replace_all(uri, @path_context)
+          unless @parent.nil?
+            uri = @parent.instantiate_uri(uri)
+          end
+          uri
         end
-      when 500, 502, 503
-        return PaymentPlatformException.new(status_code, response_body, error_id, errors)
-      else
-        return ApiException.new(status_code, response_body, error_id, errors)
       end
-    end
 
-    private
+      private
 
-    def replace_all(uri, path_context)
-      path_context&.each do |key, value|
-        uri = uri.gsub("{#{key}}", value)
+      def replace_all(uri, path_context)
+        if path_context
+          path_context.each do |key, value|
+            uri = uri.gsub('{' + key + '}', value)
+          end
+        end
+        uri
       end
-      uri
-    end
-
-    def is_idempotence_error(errors, context)
-      context&.idempotence_key && errors.length == 1 && errors[0].code == '1409'
     end
   end
 end

data/lib/onlinepayments/sdk/authentication/authenticator.rb

@@ -0,0 +1,19 @@
+module OnlinePayments
+  module SDK
+    module Authentication
+      # Abstract class that is responsible for authenticating requests sent to the Online Payments platform.
+      class Authenticator
+
+        # Returns a value that can be used for the "Authorization" header.
+        #
+        # @param http_method     [String] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
+        # @param resource_uri    [URI::HTTP] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
+        # @param request_headers [Array<OnlinePayments::SDK::Communication::RequestHeader>] all headers used by the request
+        # @return [String] the "Authorization" header value
+        def get_authorization(http_method, resource_uri, request_headers)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/authentication/authorization_type.rb

@@ -0,0 +1,15 @@
+module OnlinePayments
+  module SDK
+    module Authentication
+      # Contains all authentication schemes supported by the Online Payments platform.
+      class AuthorizationType
+        V1HMAC = "v1HMAC".freeze
+
+        # @return [String] the authorization string that belongs to the parameter _authorization_, or _nil_ if not found.
+        def self.get_authorization(authorization)
+          authorization if authorization == 'v1HMAC'
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/authentication/v1hmac_authenticator.rb

@@ -0,0 +1,109 @@
+require 'openssl'
+require 'base64'
+
+require 'onlinepayments/sdk/authentication/authenticator'
+require 'onlinepayments/sdk/communication/default_connection'
+require 'onlinepayments/sdk/communication/request_header'
+
+module OnlinePayments
+  module SDK
+    module Authentication
+      # Authenticates requests made to the Online Payments platform using V1Hmac.
+      class V1HmacAuthenticator < Authenticator
+
+        # HMAC algorithm used to generate the signature
+        HMAC_ALGOR = 'SHA256'.freeze
+        CONTENT_TYPE = 'Content-Type'.freeze
+        DATE = 'Date'.freeze
+        XGCS = 'x-gcs'.freeze
+
+        # Constructs a new V1HmacAuthenticator instance using the provided CommunicatorConfiguration.
+        #
+        # @param communicator_configuration [OnlinePayments::SDK::CommunicatorConfiguration] The configuration object
+        #                                   containing the V1Hmac authorization id and authorization secret,
+        #                                   connection timeout, and socket timeout. None of these can be _nil_ or empty,
+        #                                   and the timeout values must be positive.
+        def initialize(communicator_configuration)
+          raise ArgumentError unless communicator_configuration.api_key_id and not communicator_configuration.api_key_id.strip.empty?
+          raise ArgumentError unless communicator_configuration.secret_api_key and not communicator_configuration.secret_api_key.strip.empty?
+
+          @api_key_id = communicator_configuration.api_key_id
+          @secret_api_key = communicator_configuration.secret_api_key
+          @authorization_type = communicator_configuration.authorization_type
+        end
+
+        # @param http_method     [String, nil] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
+        # @param resource_uri    [URI::HTTP, nil] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
+        # @param request_headers [Array<OnlinePayments::SDK::Communication::RequestHeader>, nil] all headers used by the request
+        def get_authorization(http_method, resource_uri, request_headers)
+          raise ArgumentError unless http_method && !http_method.strip.empty?
+          raise ArgumentError unless resource_uri
+
+          data_to_sign = to_data_to_sign(http_method, resource_uri, request_headers)
+          "GCS #{@authorization_type}:#{@api_key_id}:#{create_auth_signature(data_to_sign)}"
+        end
+
+        protected
+
+        # Canonizes the _http_method_, _resource_uri_ and _http_headers_ so a unique signature can be generated.
+        # Canonical form is as follows:
+        # * _http_method_ in upper case
+        # * Content-Type
+        # * Date header
+        # * X-GCS headers sorted alphabetically. Names are in lowercase and values are stripped of excess whitespace
+        # * path and query portion of the uri, separated by a question mark
+        def to_data_to_sign(http_method, resource_uri, http_headers)
+          content_type = ''
+          date = ''
+          canonical_resource = to_canonical_resource(resource_uri)
+          xgc_http_headers = []
+
+          http_headers&.each do |header|
+            name = header.name
+            value = header.value
+            case
+            when name.casecmp(CONTENT_TYPE).zero?
+              content_type = value
+            when name.casecmp(DATE).zero?
+              date = value
+            when to_canonical_header_name(name).start_with?("x-gcs")
+              xgc_http_headers << [to_canonical_header_name(name), to_canonical_header_value(value)]
+            end
+          end
+
+          xgc_http_headers.sort! { |(h1, v1), (h2, v2)| h1 <=> h2 } unless xgc_http_headers.empty?
+
+          data = "#{http_method.upcase}\n#{content_type}\n#{date}\n"
+          data << xgc_http_headers.inject('') { |s, (k, v)| "#{s}#{k}:#{v}\n" } unless xgc_http_headers.empty?
+          data << "#{canonical_resource}\n" if canonical_resource
+        end
+
+        # Applies the HMAC algorithm to the canonicalized data to obtain an HMAC digest.
+        # Afterwards the HMAC digest is encoded using base64 encoding.
+        def create_auth_signature(data_to_sign)
+          digest = OpenSSL::Digest.new(HMAC_ALGOR)
+          hmac = OpenSSL::HMAC.digest(digest, @secret_api_key, data_to_sign)
+          Base64.strict_encode64(hmac).strip
+        end
+
+        private
+
+        # Returns the encoded URI path without the HTTP method and including all decoded query parameters.
+        def to_canonical_resource(resource_uri)
+          return "#{resource_uri.path}?#{resource_uri.query}" if resource_uri.query
+          resource_uri.path
+        end
+
+        def to_canonical_header_name(original_name)
+          original_name ? original_name.downcase : original_name
+        end
+
+        # Strips a header value of excess whitespace to produce a canonical value
+        def to_canonical_header_value(original_value)
+          return '' unless original_value
+          original_value.gsub(/\r?\n[\s&&[^\r\n]]*/, ' ').strip
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/authentication.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'authentication', '*.rb')].each { |f| require f }

data/lib/onlinepayments/sdk/authorization_exception.rb

@@ -1,13 +1,19 @@
-module OnlinePayments::SDK
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
 
-  # This exception is thrown when a request sent to the Online Payments platform is not correctly authenticated.
-  # Corresponds to a HTTP status code of 403.
-  # @see ApiException#initialize
-  class AuthorizationException < ApiException
+module OnlinePayments
+  module SDK
+    # Represents an error response from the payment platform when authorization failed.
+    class AuthorizationException < ApiException
 
-    def initialize(status_code, response_body, error_id, errors,
-                   message = 'the Online Payments platform returned an authorization error response')
-      super(status_code, response_body, error_id, errors, message)
+      # Create a new AuthorizationException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, error_id, errors,
+                     message='the payment platform returned an authorization error response')
+        super(status_code, response_body, error_id, errors, message)
+      end
     end
   end
 end

data/lib/onlinepayments/sdk/call_context.rb

@@ -1,26 +1,35 @@
-module OnlinePayments::SDK
+require 'date'
 
-  # A CallContext is used to identify requests and manage idempotent requests.
-  # A CallContext contains the following:
-  #
-  # idempotence_key::               A randomly generated key used to identify requests
-  # idempotence_request_timestamp:: If a previous request arrived with the same idempotence key,
-  #                                 this value will be set to a timestamp of that request.
-  #
-  # @attr_reader [String] idempotence_key The idempotence key used to identify this request.
-  #              If two requests share the same _idempotence_key_, they are considered to be the same request
-  #              and only the first request will be processed.
-  # @attr        [Integer] idempotence_request_timestamp If two or more requests arrive at the Online Payments platform with the same _idempotence_key_,
-  #              the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
-  class CallContext
-    @idempotence_request_timestamp = nil
-    @idempotence_key = nil
+module OnlinePayments
+  module SDK
+    # A CallContext is used to identify requests and manage idempotent requests.
+    # A CallContext contains the following:
+    #
+    # idempotence_key::                A randomly generated key used to identify requests
+    # idempotence_request_timestamp::  If a previous request arrived with the same idempotence key,
+    #                                  this value will be set to a timestamp of that request.
+    # idempotence_response_date_time:: If a previous request arrived with the same idempotence key,
+    #                                  this value will be set to the date/time of the first response.
+    #
+    # @attr_reader [String] idempotence_key The idempotence key used to identify this request.
+    #              If two requests share the same _idempotence_key_, they are considered to be the same request
+    #              and only the first request will be processed.
+    # @attr        [Integer] idempotence_request_timestamp If two or more requests arrive at the Online Payments platform with the same _idempotence_key_,
+    #              the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
+    # @attr        [DateTime] idempotence_response_date_time If two or more requests arrive at the Online Payments platform with the same _idempotence_key_,
+    #              the _idempotence_response_date_time_ will be set to the response date/time of the first response.
+    class CallContext
+      @idempotence_key = nil
+      @idempotence_request_timestamp = nil
+      @idempotence_response_date_time = nil
 
-    def initialize(idempotence_key = nil)
-      @idempotence_key = idempotence_key
-    end
+      def initialize(idempotence_key = nil)
+        @idempotence_key = idempotence_key
+      end
 
-    attr_reader :idempotence_key
-    attr_accessor :idempotence_request_timestamp
+      attr_reader :idempotence_key
+      attr_accessor :idempotence_request_timestamp
+      attr_accessor :idempotence_response_date_time
+    end
   end
 end

data/lib/onlinepayments/sdk/client.rb

@@ -1,15 +1,17 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
+require 'base64'
+
 require 'onlinepayments/sdk/api_resource'
-require 'onlinepayments/sdk/data_object'
+require 'onlinepayments/sdk/domain/data_object'
 require 'onlinepayments/sdk/logging/logging_capable'
+require 'onlinepayments/sdk/logging/obfuscation/obfuscation_capable'
 require 'onlinepayments/sdk/merchant/merchant_client'
-require 'base64'
 
 module OnlinePayments
   module SDK
-    # payment platform client.
+    # Payment platform client.
     #
     # This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.
     #
@@ -18,29 +20,32 @@ module OnlinePayments
     # Thread safe.
     class Client < ApiResource
       include Logging::LoggingCapable
-
-      # @return [String]
-      def self.API_VERSION
-        'v2'
-      end
+      include Logging::Obfuscation::ObfuscationCapable
 
       # @param communicator     [OnlinePayments::SDK::Communicator]
       # @param client_meta_info [String, nil]
       def initialize(communicator, client_meta_info = nil)
-        super(communicator, nil, client_meta_info)
+        super(communicator: communicator, client_meta_info: client_meta_info)
       end
 
-      # @param client_meta_info [String, nil] JSON string containing the meta data for the client
-      # @return [OnlinePayments::SDK::Client] a Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
-      # @raise [OnlinePayments::SDK::MarshallerSyntaxException] if the given clientMetaInfo is not a valid JSON string
+      # @param client_meta_info [String] JSON string containing the metadata for the client
+      # @return [OnlinePayments::SDK::Client] a Client which uses the passed metadata for the X-GCS-ClientMetaInfo header.
+      # @raise [OnlinePayments::SDK::JSON::MarshallerSyntaxException] if the given clientMetaInfo is not a valid JSON string
       def with_client_meta_info(client_meta_info)
-        if client_meta_info
+        if @client_meta_info.nil? && client_meta_info.nil?
+          self
+        elsif client_meta_info.nil?
+          return Client.new(@communicator, nil)
+        else
           # Checking to see if this is valid JSON (no JSON parse exceptions)
           @communicator.marshaller.unmarshal(client_meta_info, DataObject)
           client_meta_info = Base64.strict_encode64(client_meta_info)
-          return @client_meta_info == client_meta_info ? self : Client.new(@communicator, client_meta_info)
+          if @client_meta_info == client_meta_info
+            self
+          else
+            return Client.new(@communicator, client_meta_info)
+          end
         end
-        @client_meta_info ? Client.new(@communicator) : self
       end
 
       # Utility method that delegates the call to this client's communicator.
@@ -53,6 +58,18 @@ module OnlinePayments
         @communicator.close_expired_connections
       end
 
+      # Sets the current body obfuscator to use.
+      # @param body_obfuscator [OnlinePayments::SDK::Logging::Obfuscation::BodyObfuscator]
+      def set_body_obfuscator(body_obfuscator)
+        @communicator.set_body_obfuscator(body_obfuscator)
+      end
+
+      # Sets the current header obfuscator to use.
+      # @param header_obfuscator [OnlinePayments::SDK::Logging::Obfuscation::HeaderObfuscator]
+      def set_header_obfuscator(header_obfuscator)
+        @communicator.set_header_obfuscator(header_obfuscator)
+      end
+
       # Turns on logging using the given communicator logger.
       # @param communicator_logger [OnlinePayments::SDK::Logging::CommunicatorLogger]
       def enable_logging(communicator_logger)
@@ -69,12 +86,13 @@ module OnlinePayments
         @communicator.close
       end
 
-      # Resource /v2/!{merchantId}
+      # Resource /v2/{merchantId}
+      #
       # @param merchant_id [String]
       # @return [OnlinePayments::SDK::Merchant::MerchantClient]
       def merchant(merchant_id)
         OnlinePayments::SDK::Merchant::MerchantClient.new(self, {
-          'merchantId'.freeze => merchant_id
+          'merchantId'.freeze => merchant_id,
         })
       end
     end