onlinepayments-sdk-ruby 4.23.0 → 5.1.0

data/lib/onlinepayments/sdk/factory.rb

@@ -1,135 +1,180 @@
 require 'yaml'
+require 'onlinepayments/sdk/client'
+require 'onlinepayments/sdk/communicator'
+require 'onlinepayments/sdk/communicator_configuration'
+require 'onlinepayments/sdk/authentication/authorization_type'
+require 'onlinepayments/sdk/authentication/v1hmac_authenticator'
+require 'onlinepayments/sdk/communication/default_connection'
+require 'onlinepayments/sdk/communication/metadata_provider'
+require 'onlinepayments/sdk/json/default_marshaller'
 
-module OnlinePayments::SDK
+module OnlinePayments
+  module SDK
+    # Convenience class that constructs instances of several other classes in the SDK.
+    # Provides methods to construct
+    # {OnlinePayments::SDK::CommunicatorConfiguration}, {OnlinePayments::SDK::Communicator} and {OnlinePayments::SDK::Client} instances.
+    class Factory
 
-  # Convenience class that constructs instances of several other classes in the SDK.
-  # Provides methods to construct
-  # {OnlinePayments::SDK::CommunicatorConfiguration}, {OnlinePayments::SDK::Communicator} and {OnlinePayments::SDK::Client} instances.
-  class Factory
+      # Creates and returns a {OnlinePayments::SDK::CommunicatorConfiguration} based on the configuration in the file
+      # located at _configuration_file_name_.
+      #
+      # @param configuration_file_name [String] Path to the configuration file to use, should be in YAML format.
+      # @param api_key_id              [String] Key id for the Online Payments platform.
+      # @param secret_api_key          [String] Secret key used for authentication to the Online Payments platform.
+      # @return [OnlinePayments::SDK::CommunicatorConfiguration] The created communicator configuration
+      def self.create_configuration(configuration_file_name, api_key_id, secret_api_key)
+        properties = YAML::load_file(configuration_file_name)
+        CommunicatorConfiguration.new(properties: properties,
+                                      api_key_id: api_key_id,
+                                      secret_api_key: secret_api_key)
+      end
 
-    # Creates and returns a {OnlinePayments::SDK::CommunicatorConfiguration} based on the configuration in the file located at _configuration_file_name_.
-    #
-    # @param config_file_name [String] Path to the configuration file to use, should be in YAML format.
-    # @param api_key_id       [String] Key id for the OnlinePayments service.
-    # @param secret_api_key   [String] Secret key used for authentication to the OnlinePayments service.
-    # @return [OnlinePayments::SDK::CommunicatorConfiguration] The created communicator configuration
-    def self.create_configuration(config_file_name, api_key_id, secret_api_key)
-      properties = YAML::load_file(config_file_name)
-      CommunicatorConfiguration.new(properties: properties,
-                                    api_key_id: api_key_id,
-                                    secret_api_key: secret_api_key)
-    end
+      # Creates and returns a {OnlinePayments::SDK::Communicator} from a {OnlinePayments::SDK::CommunicatorConfiguration},
+      # a {OnlinePayments::SDK::Communication::MetadataProvider}, a {OnlinePayments::SDK::Communication::Connection},
+      # an {OnlinePayments::SDK::Authentication::Authenticator} and a {OnlinePayments::SDK::JSON::Marshaller}.
+      #
+      # @param configuration     [OnlinePayments::SDK::CommunicatorConfiguration] configuration settings to be used by the client.
+      # @param metadata_provider [OnlinePayments::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+      # @param connection        [OnlinePayments::SDK::Communication::Connection] connection that can be used to communicate with the Online Payments platform.
+      # @param authenticator     [OnlinePayments::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Online Payments platform.
+      # @param marshaller        [OnlinePayments::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+      # @return [OnlinePayments::SDK::Communicator] The created communicator
+      def self.create_communicator_from_configuration(configuration, metadata_provider: nil,
+                                                      connection: nil, authenticator: nil, marshaller: nil)
+        unless metadata_provider
+          metadata_provider = Communication::MetadataProvider.new(configuration.integrator,
+                                                    shopping_cart_extension: configuration.shopping_cart_extension)
+        end
+        unless connection
+          connection = Communication::DefaultConnection.new({ connect_timeout: configuration.connect_timeout,
+                                                              socket_timeout: configuration.socket_timeout,
+                                                              max_connections: configuration.max_connections,
+                                                              proxy_configuration: configuration.proxy_configuration })
+        end
+        unless authenticator
+          authenticator = get_authenticator(configuration)
+        end
+        unless marshaller
+          marshaller = JSON::DefaultMarshaller.instance
+        end
+        Communicator.new(configuration.api_endpoint, connection, authenticator, metadata_provider, marshaller)
+      end
 
-    # Creates and returns an {OnlinePayments::SDK::Communicator} that can be used for communication with the OnlinePayments service.
-    #
-    # @param configuration      [OnlinePayments::SDK::CommunicatorConfiguration] contains configuration settings to be used by the client.
-    # @param meta_data_provider [OnlinePayments::SDK::MetaDataProvider,nil] stores the metadata for the communicating client.
-    # @param connection         [OnlinePayments::SDK::Connection,nil] connection that can be used to communicate with the Online Payments platform.
-    # @param authenticator      [OnlinePayments::SDK::Authenticator,nil] authenticator that can authenticate messages sent to the Online Payments platform.
-    # @param marshaller         [OnlinePayments::SDK::Marshaller,nil] marshaller that marshalls and unmarshalls messages sent to the Online Payments platform.
-    # @return [OnlinePayments::SDK::Communicator] The created communicator
-    def self.create_communicator_from_configuration(configuration, meta_data_provider: nil, connection: nil, authenticator: nil, marshaller: DefaultImpl::DefaultMarshaller.INSTANCE)
-      meta_data_provider ||= MetaDataProvider.new(configuration.integrator, shopping_cart_extension: configuration.shopping_cart_extension)
-      connection ||= DefaultImpl::DefaultConnection.new({ connect_timeout: configuration.connect_timeout,
-                                                          socket_timeout: configuration.socket_timeout,
-                                                          max_connections: configuration.max_connections,
-                                                          proxy_configuration: configuration.proxy_configuration })
-      authenticator ||= DefaultImpl::DefaultAuthenticator.new(configuration.api_key_id,
-                                                              configuration.secret_api_key,
-                                                              configuration.authorization_type)
-      Communicator.new(configuration.api_endpoint, connection, authenticator, meta_data_provider, marshaller)
-    end
+      # Creates and returns a {OnlinePayments::SDK::Communicator} from a file containing the communicator configuration, api_key_id, secret_api_key,
+      # a {OnlinePayments::SDK::Communication::MetadataProvider}, a {OnlinePayments::SDK::Communication::Connection}.
+      # an {OnlinePayments::SDK::Authentication::Authenticator} and a {OnlinePayments::SDK::JSON::Marshaller}.
+      #
+      # @param configuration_file_name [String] Path to the configuration file to use, should be in YAML format.
+      # @param api_key_id              [String] Key id for the Online Payments platform.
+      # @param secret_api_key          [String] Secret key used for authentication to the Online Payments platform.
+      # @param metadata_provider       [OnlinePayments::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+      # @param connection              [OnlinePayments::SDK::Communication::Connection] connection that can be used to communicate with the Online Payments platform.
+      # @param authenticator           [OnlinePayments::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Online Payments platform.
+      # @param marshaller              [OnlinePayments::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+      # @return [OnlinePayments::SDK::Communicator] The created communicator
+      def self.create_communicator_from_file(configuration_file_name, api_key_id, secret_api_key,
+                                             metadata_provider: nil, connection: nil, authenticator: nil, marshaller: nil)
+        configuration = create_configuration(configuration_file_name, api_key_id, secret_api_key)
+        create_communicator_from_configuration(configuration, metadata_provider: metadata_provider, connection: connection,
+                                               authenticator: authenticator, marshaller: marshaller)
+      end
 
-    # Creates and returns an {OnlinePayments::SDK::Communicator} that is used for communication with the OnlinePayments service.
-    #
-    # @param config_file_name   [String] Path to the configuration file to use, should be in YAML format.
-    # @param api_key_id         [String] Key id for the OnlinePayments service.
-    # @param secret_api_key     [String] Secret key used for authentication to the OnlinePayments service.
-    # @param meta_data_provider [OnlinePayments::SDK::MetaDataProvider,nil] stores the metadata for the communicating client.
-    # @param connection         [OnlinePayments::SDK::Connection,nil] connection that can be used to communicate with the Online Payments platform.
-    # @param authenticator      [OnlinePayments::SDK::Authenticator,nil] authenticator that can authenticate messages sent to the Online Payments platform.
-    # @return [OnlinePayments::SDK::Communicator] The created communicator
-    def self.create_communicator_from_file(config_file_name, api_key_id, secret_api_key,
-                                           meta_data_provider: nil, connection: nil, authenticator: nil,
-                                           marshaller: DefaultImpl::DefaultMarshaller.INSTANCE)
-      configuration = create_configuration(config_file_name, api_key_id, secret_api_key)
-      create_communicator_from_configuration(configuration, meta_data_provider: meta_data_provider, connection: connection,
-                                             authenticator: authenticator, marshaller: marshaller)
-    end
+      # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the Online Payments platform.
+      # If a code block is given, the created client is returned to the code block and closed afterwards.
+      #
+      # @example Providing a code block
+      #           Factory.create_client_from_configuration(configuration) do |client|
+      #             # use client as needed
+      #           end
+      #           # client is closed here
+      #
+      # @param configuration     [OnlinePayments::SDK::CommunicatorConfiguration] contains configuration settings to be used by the client.
+      # @param metadata_provider [OnlinePayments::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+      # @param connection        [OnlinePayments::SDK::Communication::Connection] connection that can be used to communicate with the Online Payments platform.
+      # @param authenticator     [OnlinePayments::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Online Payments platform.
+      # @param marshaller        [OnlinePayments::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+      # @return [OnlinePayments::SDK::Client] The created client
+      def self.create_client_from_configuration(configuration, metadata_provider: nil, connection: nil, authenticator: nil, marshaller: nil)
+        communicator = create_communicator_from_configuration(configuration, metadata_provider: metadata_provider, connection: connection,
+                                                              authenticator: authenticator, marshaller: marshaller)
+        client = Client.new(communicator)
+        if block_given?
+          begin
+            yield client
+          ensure
+            client.close
+          end
+        else
+          return client
+        end
+      end
 
-    # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the OnlinePayments service.
-    # If a code block is given, the created client is returned to the code block and closed afterwards.
-    #
-    # @example Providing a code block
-    #           Factory.create_client_from_configuration(configuration) do |client|
-    #             client.merchant(merchant_id).services.testconnection
-    #           end
-    #           # client is closed here
-    #
-    # @param configuration [OnlinePayments::SDK::CommunicatorConfiguration] contains configuration settings to be used by the client.
-    # @return [OnlinePayments::SDK::Client] The created client
-    def self.create_client_from_configuration(configuration)
-      communicator = create_communicator_from_configuration(configuration)
-      client = Client.new(communicator)
-      if block_given?
-        begin
-          yield client
-        ensure
-          client.close
+      # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the Online Payments platform.
+      # If a code block is given, the created client is returned to the code block and closed afterwards.
+      #
+      # @example Providing a code block
+      #           Factory.create_client_from_communicator(communicator) do |client|
+      #             # use client as needed
+      #           end
+      #           # client is closed here
+      #
+      # @param communicator [OnlinePayments::SDK::Communicator] provides network communication service for the Client
+      # @return [OnlinePayments::SDK::Client] The created client
+      def self.create_client_from_communicator(communicator)
+        client = Client.new(communicator)
+        if block_given?
+          begin
+            yield client
+          ensure
+            client.close
+          end
+        else
+          return client
         end
-      else
-        return client
       end
-    end
 
-    # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the OnlinePayments service.
-    # If a code block is given, the created client is returned to the code block and closed afterwards.
-    #
-    # @example Providing a code block
-    #           Factory.create_client_from_communicator(communicator) do |client|
-    #             client.merchant(merchant_id).services.testconnection
-    #           end
-    #           # client is closed here
-    #
-    # @param communicator [OnlinePayments::SDK::Communicator] provides network communication service for the Client
-    # @return [OnlinePayments::SDK::Client] The created client
-    def self.create_client_from_communicator(communicator)
-      client = Client.new(communicator)
-      if block_given?
-        begin
-          yield client
-        ensure
-          client.close
+      # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the Online Payments platform.
+      # If a code block is given, the created client is returned to the code block and closed afterwards.
+      #
+      # @example Providing a code block
+      #           Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key) do |client|
+      #             # use client as needed
+      #           end
+      #           # client is closed here
+      #
+      # @param configuration_file_name [String] Path to the configuration file to use, should be in YAML format.
+      # @param api_key_id              [String] Key id for the Online Payments platform.
+      # @param secret_api_key          [String] Secret key used for authentication to the Online Payments platform.
+      # @param metadata_provider       [OnlinePayments::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+      # @param connection              [OnlinePayments::SDK::Communication::Connection] connection that can be used to communicate with the Online Payments platform.
+      # @param authenticator           [OnlinePayments::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Online Payments platform.
+      # @param marshaller              [OnlinePayments::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+      # @return [OnlinePayments::SDK::Client] The created client
+      def self.create_client_from_file(configuration_file_name, api_key_id, secret_api_key,
+                                       metadata_provider: nil, connection: nil, authenticator: nil, marshaller: nil)
+        communicator = create_communicator_from_file(configuration_file_name, api_key_id, secret_api_key,
+                                                     metadata_provider: metadata_provider, connection: connection,
+                                                     authenticator: authenticator, marshaller: marshaller)
+        client = Client.new(communicator)
+        if block_given?
+          begin
+            yield client
+          ensure
+            client.close
+          end
+        else
+          return client
         end
-      else
-        return client
       end
-    end
 
-    # Creates and returns an {OnlinePayments::SDK::Client} that provides the a high-level interface with the OnlinePayments service.
-    # If a code block is given, the created client is returned to the code block and closed afterwards.
-    #
-    # @example Providing a code block
-    #           Factory.create_client_from_file(config_file_name, api_key_id, secret_api_key) do |client|
-    #             client.merchant(merchant_id).services.testconnection
-    #           end
-    #           # client is closed here
-    #
-    # @param config_file_name [String] Path to the configuration file to use, should be in YAML format.
-    # @param api_key_id       [String] Key id for the OnlinePayments service.
-    # @param secret_api_key   [String] Secret key used for authentication to the OnlinePayments service.
-    # @return [OnlinePayments::SDK::Client] The created client
-    def self.create_client_from_file(config_file_name, api_key_id, secret_api_key)
-      communicator = create_communicator_from_file(config_file_name, api_key_id, secret_api_key)
-      client = Client.new(communicator)
-      if block_given?
-        begin
-          yield client
-        ensure
-          client.close
+      private
+
+      # @param configuration [OnlinePayments::SDK::CommunicatorConfiguration]
+      def self.get_authenticator(configuration)
+        if configuration.authorization_type == Authentication::AuthorizationType::V1HMAC
+          return Authentication::V1HmacAuthenticator.new(configuration)
         end
-      else
-        return client
+        raise RuntimeError.new("Unknown authorizationType #{configuration.authorization_type}")
       end
     end
   end

data/lib/onlinepayments/sdk/idempotence_exception.rb

@@ -1,24 +1,28 @@
-module OnlinePayments::SDK
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
 
-  # This exception is thrown when a response from the Online Payments platform indicates
-  # a request with the same _idempotence_key_ was received earlier.
-  # The _idempotence_request_timestamp_ indicates the time when the first request with this _idempotence_key_ arrived.
-  #
-  # @attr_reader [String] idempotence_key                The idempotence key used in the request.
-  # @attr_reader [Integer] idempotence_request_timestamp A timestamp indicating the arrival time of the request that conflicts with the request just sent.
-  class IdempotenceException < ApiException
+module OnlinePayments
+  module SDK
+    # Represents an error response from the payment platform when an idempotent request failed because the first request has not finished yet.
+    # The _idempotence_request_timestamp_ indicates the time when the first request with this _idempotence_key_ arrived.
+    #
+    # @attr_reader [String] idempotence_key                The idempotence key used in the request.
+    # @attr_reader [Integer] idempotence_request_timestamp A timestamp indicating the arrival time of the request that conflicts with the request just sent.
+    class IdempotenceException < ApiException
 
-    # Create a new IdempotenceException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors, idempotence_key,
-                   idempotence_request_timestamp,
-                   message = 'the Online Payments platform returned a duplicate request error response')
-      super(status_code, response_body, error_id, errors, message)
-      @idempotence_key = idempotence_key
-      @idempotence_request_timestamp = idempotence_request_timestamp
-    end
+      # Create a new IdempotenceException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, error_id, errors, idempotence_key, idempotence_request_timestamp,
+                     message='the payment platform returned a duplicate request error response')
+        super(status_code, response_body, error_id, errors, message)
+        @idempotence_key = idempotence_key
+        @idempotence_request_timestamp = idempotence_request_timestamp
+      end
 
-    attr_reader :idempotence_key
-    attr_reader :idempotence_request_timestamp
+      attr_reader :idempotence_key
+      attr_reader :idempotence_request_timestamp
+    end
   end
 end

data/lib/onlinepayments/sdk/json/default_marshaller.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'singleton'
+require 'onlinepayments/sdk/json/marshaller'
+
+module OnlinePayments
+  module SDK
+    module JSON
+      # Marshals objects to and from JSON format.
+      # Currently supports marshalling and unmarshalling of classes that support class.new_from_hash and class#to_h
+      class DefaultMarshaller < Marshaller
+        include Singleton
+
+        # Marshals the _request_object_ to a JSON string using request_object#to_h
+        def marshal(request_object)
+          ::JSON.pretty_generate(request_object.to_h)
+        end
+
+        # Unmarshals a JSON string into an object of type _klass_ using klass.new_from_hash
+        def unmarshal(json_string, klass)
+          if json_string.nil?
+            return nil
+          elsif json_string.length == 0
+            return ''
+          end
+          if klass.respond_to?(:new_from_hash)
+            klass.new_from_hash(::JSON.load(json_string))
+          else
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/json/marshaller.rb

@@ -0,0 +1,27 @@
+module OnlinePayments
+  module SDK
+    module JSON
+      # Class responsible for marshalling and unmarshalling objects to and from JSON
+      class Marshaller
+
+        # Marshals _request_object_ to JSON format by calling #to_h on it.
+        #
+        # @param request_object [OnlinePayments::SDK::Domain::DataObject] the object to format
+        # @return [String] _request_object_ converted to JSON
+        def marshal(request_object)
+          raise NotImplementedError
+        end
+
+        # Unmarshals a JSON string into an object of type _type_.
+        # The new object is initialized by calling .new_from_hash with contents of the JSON as a Hash object.
+        #
+        # @param response_json [String] The JSON to unmarshal
+        # @param type          [Type] The class of the object that will be instantiated using _type.new_from_hash_
+        # @return The JSON unmarshalled to the given type
+        def unmarshal(response_json, type)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/json/marshaller_syntax_exception.rb

@@ -0,0 +1,9 @@
+module OnlinePayments
+  module SDK
+    module JSON
+      # Raised when an error occurred while marshalling/unmarshalling data to/from JSON
+      class MarshallerSyntaxException < RuntimeError
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/json.rb

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

data/lib/onlinepayments/sdk/logging/communicator_logger.rb

@@ -1,21 +1,23 @@
-module OnlinePayments::SDK
-  module Logging
+module OnlinePayments
+  module SDK
+    module Logging
+      # Base logger class used in this SDK. This class is an interface and cannot be instantiated.
+      class CommunicatorLogger
 
-    # Base logger class used in this SDK. This class is an interface and cannot be instantiated.
-    class CommunicatorLogger
-      # Interface, no instantiation
-      # @see OnlinePayments::SDK::Logging::StdoutCommunicatorLogger
-      # @see OnlinePayments::SDK::Logging::RubyCommunicatorLogger
-      def initialize
-        raise NotImplementedError, "#{self.class.name} is not implemented."
-      end
+        # Interface, no instantiation
+        # @see OnlinePayments::SDK::Logging::StdoutCommunicatorLogger
+        # @see OnlinePayments::SDK::Logging::RubyCommunicatorLogger
+        def initialize
+          raise NotImplementedError.new("#{self.class.name} is not implemented.")
+        end
 
-      # Logs a message with or without exception
-      #
-      # @param message [String] the message to log
-      # @param thrown  [Exception, false] the exception to log, or false to log no exception
-      def log(message, thrown = false)
-        raise NotImplementedError, "#{self.class.name}#log() is not implemented."
+        # Logs a message with or without exception
+        #
+        # @param message [String] the message to log
+        # @param thrown  [Exception, nil] the exception to log, or nil to log no exception
+        def log(message, thrown = nil)
+          raise NotImplementedError.new("#{self.class.name}#log() is not implemented.")
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/logging/log_message_builder.rb

@@ -1,56 +1,89 @@
-module OnlinePayments::SDK
-  module Logging
-
-    # Abstract class used to construct a message describing a request or response.
-    #
-    # @attr_reader [String] request_id   An identifier assigned to the request and response
-    # @attr_reader [String] headers      Request or response headers in string form
-    # @attr_reader [String] body         Request or response body as a string
-    # @attr_reader [String] content_type Content type of the body, generally 'application/json' or 'text/html'
-    class LogMessageBuilder
-
-      attr_reader :request_id
-      attr_reader :headers
-      attr_reader :body
-      attr_reader :content_type
-
-      # Create a new LogMessageBuilder
-      def initialize(request_id)
-        raise ArgumentError if request_id.nil? || request_id.empty?
-        @request_id = request_id
-        @headers = ''
-      end
+require 'onlinepayments/sdk/logging/obfuscation/body_obfuscator'
+require 'onlinepayments/sdk/logging/obfuscation/header_obfuscator'
 
-      # Adds a single header to the #headers string
-      def add_headers(name, value)
-        @headers += ', ' unless @headers.empty?
-        @headers += "#{name}='#{LoggingUtil.obfuscate_header(name, value)}'"
-      end
+module OnlinePayments
+  module SDK
+      module Logging
+        # Abstract class used to construct a message describing a request or response.
+        #
+        # @attr_reader [String] request_id   An identifier assigned to the request and response
+        # @attr_reader [String] headers      Request or response headers in string form
+        # @attr_reader [String] body         Request or response body as a string
+        # @attr_reader [String] content_type Content type of the body, generally 'application/json' or 'text/html'
+        # @attr_reader [OnlinePayments::SDK::Logging::Obfuscation::BodyObfuscator] body_obfuscator
+        # @attr_reader [OnlinePayments::SDK::Logging::Obfuscation::HeaderObfuscator] header_obfuscator
+        class LogMessageBuilder
 
-      # Sets the body of this message to the parameter body.
+          attr_reader :request_id
+          attr_reader :headers
+          attr_reader :body
+          attr_reader :content_type
+          attr_reader :body_obfuscator
+          attr_reader :header_obfuscator
 
-      # @param body         [String] the message body
-      # @param content_type [String] the content type of the body
-      def set_body(body, content_type)
-        @body = LoggingUtil.obfuscate_body(body)
-        @content_type = content_type
-      end
+          # Create a new LogMessageBuilder
+          def initialize(request_id,
+                         body_obfuscator = Obfuscation::BodyObfuscator.default_obfuscator,
+                         header_obfuscator = Obfuscation::HeaderObfuscator.default_obfuscator)
+            raise ArgumentError if request_id.nil? or request_id.empty?
+            raise ArgumentError if body_obfuscator.nil?
+            raise ArgumentError if header_obfuscator.nil?
+            @request_id = request_id
+            @headers = ''
+            @body_obfuscator = body_obfuscator
+            @header_obfuscator = header_obfuscator
+          end
 
-      # Constructs and returns the log message as a string.
-      def get_message
-        raise NotImplementedError, "#{self.class.name}#get_message() is not implemented."
-      end
+          # Adds a single header to the #headers string
+          def add_headers(name, value)
+            @headers += ', ' if @headers.length > 0
+            @headers += name + '="'
+            @headers += @header_obfuscator.obfuscate_header(name, value) unless value.nil?
+            @headers += '"'
+          end
 
-      def to_s
-        self.class == LogMessageBuilder ?
-          super.to_s :
-          get_message
-      end
+          # Sets the body of this message to the parameter body.
+
+          # @param body         [String] the message body
+          # @param content_type [String] the content type of the body
+          def set_body(body, content_type)
+            if is_binary(content_type)
+              @body = "<binary content>"
+            else
+              @body = @body_obfuscator.obfuscate_body(body)
+            end
+            @content_type = content_type
+          end
+
+          # Constructs and returns the log message as a string.
+          # @return [String]
+          def get_message
+            raise NotImplementedError.new("#{self.class.name}#get_message() is not implemented.")
+          end
+
+          def to_s
+            if self.class == LogMessageBuilder
+              super.to_s
+            else
+              get_message
+            end
+          end
+
+          # Returns an empty string if the parameter is nil, and returns the parameter itself otherwise
+          protected def empty_if_null(value)
+            value.nil? ? '' : value
+          end
 
-      # Returns an empty string if the parameter is nil, and returns the parameter itself otherwise
-      protected def empty_if_null(value)
-        value.nil? ? '' : value
+          # Returns whether or not the content type is binary
+          def is_binary(content_type)
+            if content_type.nil?
+              false
+            else
+              content_type = content_type.downcase
+              !(content_type.start_with?("text/") || content_type.include?("json") || content_type.include?("xml"))
+            end
+          end
+        end
       end
-    end
   end
 end

data/lib/onlinepayments/sdk/logging/logging_capable.rb

@@ -1,9 +1,9 @@
 module OnlinePayments
   module SDK
     module Logging
-
       # Abstract mixin module that allows loggers to be registered to an object.
       module LoggingCapable
+
         def enable_logging(communicator_logger)
           raise NotImplementedError
         end