connect-sdk-ruby 2.47.1 → 3.0.0

data/lib/worldline/connect/sdk/communicator_configuration.rb

@@ -0,0 +1,190 @@
+require 'worldline/connect/sdk/authentication/authorization_type'
+
+module Worldline
+  module Connect
+    module SDK
+      # A CommunicatorConfiguration stores all data used to initialize an {Worldline::Connect::SDK::Communicator}.
+      #
+      # @attr [String] api_endpoint         Base URL to the Worldline Global Collect platform
+      # @attr [String] authorization_id     An id used for authorization. The meaning of this id is different for each authorization type.
+      #                                     For instance, for v1HMAC this is the identifier for the secret API key
+      # @attr [String] authorization_secret A secret used for authorization. The meaning of this secret is different for each authorization type.
+      #                                     For instance, for v1HMAC this is the secret API key
+      # @attr [String] authorization_type   String representing the authentication algorithm used
+      # @attr [Integer] connect_timeout     The number of seconds before a connection attempt with the Worldline Global Collect platform times out.
+      # @attr [Integer] socket_timeout      The number of seconds before a timeout occurs when transmitting data to or from the Worldline Global Collect platform.
+      # @attr [Integer] max_connections     The number of connections with the Worldline Global Collect platform that are kept alive in the connection pool.
+      #       These connections will be reused when possible.
+      # @attr [Worldline::Connect::SDK::ProxyConfiguration] proxy_configuration Proxy settings.
+      # @attr [String] integrator           Name of the integrator
+      # @attr [Worldline::Connect::SDK::Domain::ShoppingCartExtension] shopping_cart_extension Shopping cart-related metadata.
+      class CommunicatorConfiguration
+        private
+
+        DEFAULT_MAX_CONNECTIONS = 10
+
+        public
+
+        # The default number of connections that are kept alive in the connection pool.
+        # Used if _maxConnections_ is not present in the properties.
+        # @return [Integer]
+        def self.default_max_connections
+          DEFAULT_MAX_CONNECTIONS
+        end
+
+        # Creates a new CommunicatorConfiguration instance.
+        #
+        # If a _properties_ object is given, it will be parsed like a hash in order to read these attributes.
+        # If a value is given in both the _properties_ hash and as a separate parameter,
+        # the separate parameter will take precedence over the value in the properties.
+        #
+        # @param properties              [Hash, nil] hash that may contain any of the other parameters.
+        # @param api_endpoint            [String, nil] the base URL to the Worldline Global Collect platform.
+        # @param authorization_id        [String] An id used for authorization. The meaning of this id is different for each authorization type.
+        #                                For instance, for v1HMAC this is the identifier for the secret API key.
+        # @param authorization_secret    [String] A secret used for authorization. The meaning of this secret is different for each authorization type.
+        #                                For instance, for v1HMAC this is the secret API key.
+        # @param api_key_id              [String, nil] the identifier of the _secret_api_key_ used to authenticate requests.
+        #                                This is an alias for _authorization_id_.
+        # @param secret_api_key          [String, nil] the key used to authenticate requests sent to the Worldline Global Collect platform.
+        #                                This is an alias for _authorization_secret_.
+        # @param authorization_type      [String, nil] string describing the authorization protocol to follow.
+        # @param connect_timeout         [Integer, nil] the number of seconds before a connection attempt with the Worldline Global Collect platform times out.
+        # @param socket_timeout          [Integer, nil] the number of seconds before a timeout occurs when transmitting data to or from the Worldline Global Collect platform.
+        # @param max_connections         [Integer, nil] the number of connections with the Worldline Global Collect platform that are kept alive in the connection pool.
+        #                                These connections will be reused when possible.
+        # @param proxy_configuration     [Worldline::Connect::SDK::ProxyConfiguration, nil] stores the URL to a proxy to be used in all communication,
+        #                                or nil if no proxy should be used.
+        # @param integrator              [String, nil] name of the integrator
+        # @param shopping_cart_extension [Worldline::Connect::SDK::Domain::ShoppingCartExtension, nil] stores shopping cart-related metadata.
+        def initialize(properties: nil, api_endpoint: nil,
+                       authorization_id: nil, authorization_secret: nil,
+                       api_key_id: nil, secret_api_key: nil,
+                       authorization_type: nil,
+                       connect_timeout: nil, socket_timeout: nil,
+                       max_connections: nil, proxy_configuration: nil,
+                       integrator: nil, shopping_cart_extension: nil)
+          unless properties.nil?
+            @api_endpoint = get_endpoint(properties)
+            @authorization_type = Authentication::AuthorizationType.get_authorization(properties['connect.api.authorizationType'])
+            @connect_timeout = properties['connect.api.connectTimeout']
+            @socket_timeout = properties['connect.api.socketTimeout']
+            @max_connections = get_property(properties, 'connect.api.maxConnections', DEFAULT_MAX_CONNECTIONS)
+
+            proxy_uri = properties['connect.api.proxy.uri']
+            proxy_user = properties['connect.api.proxy.username']
+            proxy_pass = properties['connect.api.proxy.password']
+            unless proxy_uri.nil?
+              @proxy_configuration = ProxyConfiguration.new(address: URI(proxy_uri),
+                                                            username: proxy_user,
+                                                            password: proxy_pass)
+            end
+            @integrator = properties['connect.api.integrator']
+            @shopping_cart_extension = get_shopping_cart_extension(properties)
+          end
+
+          if api_endpoint
+            @api_endpoint = api_endpoint
+          end
+          if authorization_id
+            @authorization_id = authorization_id
+          end
+          if authorization_secret
+            @authorization_secret = authorization_secret
+          end
+          if api_key_id
+            @authorization_id = api_key_id
+          end
+          if secret_api_key
+            @authorization_secret = secret_api_key
+          end
+          if authorization_type
+            @authorization_type = authorization_type
+          end
+          if connect_timeout
+            @connect_timeout = connect_timeout
+          end
+          if socket_timeout
+            @socket_timeout = socket_timeout
+          end
+          if max_connections
+            @max_connections = max_connections
+          end
+          if proxy_configuration
+            @proxy_configuration = proxy_configuration
+          end
+          if integrator
+            @integrator = integrator
+          end
+          if shopping_cart_extension
+            @shopping_cart_extension = shopping_cart_extension
+          end
+        end
+
+        attr_accessor :api_endpoint
+
+        attr_accessor :authorization_id
+        attr_accessor :authorization_secret
+        attr_accessor :authorization_type
+
+        attr_accessor :connect_timeout
+        attr_accessor :socket_timeout
+        attr_accessor :max_connections
+
+        attr_accessor :proxy_configuration
+
+        attr_accessor :integrator
+        attr_accessor :shopping_cart_extension
+
+        alias :api_key_id      :authorization_id
+        alias :api_key_id=     :authorization_id=
+        alias :secret_api_key  :authorization_secret
+        alias :secret_api_key= :authorization_secret=
+
+        private
+
+        def get_property(properties, key, default_value)
+          property_value = properties[key]
+          if property_value.nil?
+            default_value
+          else
+            property_value
+          end
+        end
+
+        def get_endpoint(properties)
+          host = properties['connect.api.endpoint.host']
+          scheme = properties['connect.api.endpoint.scheme']
+          port = properties['connect.api.endpoint.port']
+          if scheme.nil?
+            scheme = 'https'
+          end
+          if port.nil?
+            port = -1
+          end
+          create_uri(scheme, host, port)
+        end
+
+        def create_uri(scheme, host, port)
+          if port == -1
+            "#{scheme}://#{host}"
+          else
+            "#{scheme}://#{host}:#{port.to_s}"
+          end
+        end
+
+        def get_shopping_cart_extension(properties)
+          creator = properties['connect.api.shoppingCartExtension.creator']
+          name = properties['connect.api.shoppingCartExtension.name']
+          version = properties['connect.api.shoppingCartExtension.version']
+          extension_id = properties['connect.api.shoppingCartExtension.extensionId']
+          if creator.nil? && name.nil? && version.nil? && extension_id.nil?
+            nil
+          else
+            Domain::ShoppingCartExtension.new(creator, name, version, extension_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/connect/sdk/domain/data_object.rb

@@ -0,0 +1,34 @@
+module Worldline
+  module Connect
+    module SDK
+      module Domain
+        # Base class for all SDK data objects, supports marshalling and unmarshalling the data object to and from JSON.
+        class DataObject
+
+          # Returns a hash representation of the DataObject.
+          # The hash contains camelCase representations of the variables, and their values.
+          # Should be overridden to add all instance variables of the object.
+          #
+          # @return [Hash]
+          def to_h
+            {}
+          end
+
+          # Create a new instance of this object (DataObject or descendant)
+          # from a hash containing attribute values in camelCase.
+          # Note that the hash contains Strings as keys instead of more commonly used tokens.
+          def self.new_from_hash(hash)
+            obj = self.new
+            obj.from_hash(hash)
+            obj
+          end
+
+          # Set attributes from values in parameter hash.
+          # Should be overridden by descendants in order to properly restore their attributes from the hash.
+          # Note that the hash contains Strings as keys instead of more commonly used tokens.
+          def from_hash(hash) end
+        end
+      end
+    end
+  end
+end

data/lib/worldline/connect/sdk/domain/shopping_cart_extension.rb

@@ -0,0 +1,62 @@
+require 'worldline/connect/sdk/domain/data_object'
+
+module Worldline
+  module Connect
+    module SDK
+      module Domain
+        # Represents metadata part of shopping carts.
+        #
+        # @attr_reader [String] creator
+        # @attr_reader [String] name
+        # @attr_reader [String] version
+        # @attr_reader [String] extension_id
+        class ShoppingCartExtension < DataObject
+          def initialize(creator, name, version, extension_id=nil)
+            raise ArgumentError.new if creator.nil? or creator.strip.empty?
+            raise ArgumentError.new if name.nil? or name.strip.empty?
+            raise ArgumentError.new if version.nil? or version.to_s.strip.empty?
+
+            @creator = creator
+            @name = name
+            @version = version.to_s
+            @extension_id = extension_id
+          end
+
+          # Constructs a new ShoppingCartExtension from parameter hash
+          # the hash should contain a _creator_, _name_, _version_ and _extensionId_
+          #--
+          # Overridden so ShoppingCartExtension can retain mandatory default arguments
+          #++
+          def self.new_from_hash(hash)
+            creator = hash['creator'] if hash.has_key?('creator')
+            name = hash['name'] if hash.has_key?('name')
+            version = hash['version'] if hash.has_key?('version')
+            extension_id = hash['extensionId'] if hash.has_key?('extensionId')
+            self.new(creator, name, version, extension_id)
+          end
+
+          # Converts the shopping cart metadata to a hash
+          def to_h
+            hash = super
+            hash['creator'] = @creator unless @creator.nil?
+            hash['name'] = @name unless @name.nil?
+            hash['version'] = @version unless @version.nil?
+            hash['extensionId'] = @extension_id unless @extension_id.nil?
+            hash
+          end
+
+          # loads shopping cart metadata from a parameter hash
+          def from_hash(hash)
+            super
+            @creator = hash['creator'] if hash.has_key? 'creator'
+            @name = hash['name'] if hash.has_key? 'name'
+            @version = hash['version'] if hash.has_key? 'version'
+            @extension_id = hash['extensionId'] if hash.has_key? 'extensionId'
+          end
+
+          attr_reader :creator, :name, :version, :extension_id
+        end
+      end
+    end
+  end
+end

data/lib/worldline/connect/sdk/domain/uploadable_file.rb

@@ -0,0 +1,35 @@
+module Worldline
+  module Connect
+    module SDK
+      module Domain
+        # A file that can be uploaded
+        #
+        # The allowed forms of content are defined by the Connection implementation
+        # The default implementation supports file paths and IO objects.
+        #
+        # @attr_reader [String] file_name       The name of the file.
+        # @attr_reader [String, IO] content     The file's content.
+        # @attr_reader [String] content_type    The file's content type.
+        # @attr_reader [Integer] content_length The file's content length, or -1 if not known.
+        class UploadableFile
+
+          def initialize(file_name, content, content_type, content_length = -1)
+            raise ArgumentError.new("file_name is required") if file_name.nil? or !file_name.strip
+            raise ArgumentError.new("content is required") if content.nil?
+            raise ArgumentError.new("content_type is required") if content_type.nil? or !content_type.strip
+
+            @file_name = file_name
+            @content = content
+            @content_type = content_type
+            @content_length = [content_length, -1].max
+          end
+
+          attr_reader :file_name
+          attr_reader :content
+          attr_reader :content_type
+          attr_reader :content_length
+        end
+      end
+    end
+  end
+end

data/lib/worldline/connect/sdk/factory.rb

@@ -0,0 +1,183 @@
+require 'yaml'
+require 'worldline/connect/sdk/client'
+require 'worldline/connect/sdk/communicator'
+require 'worldline/connect/sdk/communicator_configuration'
+require 'worldline/connect/sdk/authentication/authorization_type'
+require 'worldline/connect/sdk/authentication/v1hmac_authenticator'
+require 'worldline/connect/sdk/communication/default_connection'
+require 'worldline/connect/sdk/communication/metadata_provider'
+require 'worldline/connect/sdk/json/default_marshaller'
+
+module Worldline
+  module Connect
+    module SDK
+      # Convenience class that constructs instances of several other classes in the SDK.
+      # Provides methods to construct
+      # {Worldline::Connect::SDK::CommunicatorConfiguration}, {Worldline::Connect::SDK::Communicator} and {Worldline::Connect::SDK::Client} instances.
+      class Factory
+
+        # Creates and returns a {Worldline::Connect::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 authorization_id        [String] Authorization id, e.g. the key id for the Worldline Global Collect platform.
+        # @param authorization_secret    [String] Authorization secret, e.g. the secret key used for authentication to the Worldline Global Collect platform.
+        # @return [Worldline::Connect::SDK::CommunicatorConfiguration] The created communicator configuration
+        def self.create_configuration(configuration_file_name, authorization_id, authorization_secret)
+          properties = YAML::load_file(configuration_file_name)
+          CommunicatorConfiguration.new(properties: properties,
+                                        authorization_id: authorization_id,
+                                        authorization_secret: authorization_secret)
+        end
+
+        # Creates and returns a {Worldline::Connect::SDK::Communicator} from a {Worldline::Connect::SDK::CommunicatorConfiguration},
+        # a {Worldline::Connect::SDK::Communication::MetadataProvider}, a {Worldline::Connect::SDK::Communication::Connection},
+        # an {Worldline::Connect::SDK::Authentication::Authenticator} and a {Worldline::Connect::SDK::JSON::Marshaller}.
+        #
+        # @param configuration     [Worldline::Connect::SDK::CommunicatorConfiguration] configuration settings to be used by the client.
+        # @param metadata_provider [Worldline::Connect::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+        # @param connection        [Worldline::Connect::SDK::Communication::Connection] connection that can be used to communicate with the Worldline Global Collect platform.
+        # @param authenticator     [Worldline::Connect::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Worldline Global Collect platform.
+        # @param marshaller        [Worldline::Connect::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+        # @return [Worldline::Connect::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 = 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 = DefaultMarshaller.instance
+          end
+          Communicator.new(configuration.api_endpoint, connection, authenticator, metadata_provider, marshaller)
+        end
+
+        # Creates and returns a {Worldline::Connect::SDK::Communicator} from a file containing the communicator configuration, authorization_id, authorization_secret,
+        # a {Worldline::Connect::SDK::Communication::MetadataProvider}, a {Worldline::Connect::SDK::Communication::Connection}.
+        # an {Worldline::Connect::SDK::Authentication::Authenticator} and a {Worldline::Connect::SDK::JSON::Marshaller}.
+        #
+        # @param configuration_file_name [String] Path to the configuration file to use, should be in YAML format.
+        # @param authorization_id        [String] Authorization id, e.g. the key id for the Worldline Global Collect platform.
+        # @param authorization_secret    [String] Authorization secret, e.g. the secret key used for authentication to the Worldline Global Collect platform.
+        # @param metadata_provider       [Worldline::Connect::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+        # @param connection              [Worldline::Connect::SDK::Communication::Connection] connection that can be used to communicate with the Worldline Global Collect platform.
+        # @param authenticator           [Worldline::Connect::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Worldline Global Collect platform.
+        # @param marshaller              [Worldline::Connect::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+        # @return [Worldline::Connect::SDK::Communicator] The created communicator
+        def self.create_communicator_from_file(configuration_file_name, authorization_id, authorization_secret,
+                                               metadata_provider: nil, connection: nil, authenticator: nil, marshaller: nil)
+          configuration = create_configuration(configuration_file_name, authorization_id, authorization_secret)
+          create_communicator_from_configuration(configuration, metadata_provider: metadata_provider, connection: connection,
+                                                 authenticator: authenticator, marshaller: marshaller)
+        end
+
+        # Creates and returns an {Worldline::Connect::SDK::Client} that provides the a high-level interface with the Worldline Global Collect 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|
+        #             client.v1.merchant(merchant_id).services.testconnection
+        #           end
+        #           # client is closed here
+        #
+        # @param configuration     [Worldline::Connect::SDK::CommunicatorConfiguration] contains configuration settings to be used by the client.
+        # @param metadata_provider [Worldline::Connect::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+        # @param connection        [Worldline::Connect::SDK::Communication::Connection] connection that can be used to communicate with the Worldline Global Collect platform.
+        # @param authenticator     [Worldline::Connect::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Worldline Global Collect platform.
+        # @param marshaller        [Worldline::Connect::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+        # @return [Worldline::Connect::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 {Worldline::Connect::SDK::Client} that provides the a high-level interface with the Worldline Global Collect 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|
+        #             client.v1.merchant(merchant_id).services.testconnection
+        #           end
+        #           # client is closed here
+        #
+        # @param communicator [Worldline::Connect::SDK::Communicator] provides network communication service for the Client
+        # @return [Worldline::Connect::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
+        end
+
+        # Creates and returns an {Worldline::Connect::SDK::Client} that provides the a high-level interface with the Worldline Global Collect 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, authorization_id, authorization_secret) do |client|
+        #             client.v1.merchant(merchant_id).services.testconnection
+        #           end
+        #           # client is closed here
+        #
+        # @param configuration_file_name [String] Path to the configuration file to use, should be in YAML format.
+        # @param authorization_id        [String] Authorization id, e.g. the key id for the Worldline Global Collect platform.
+        # @param authorization_secret    [String] Authorization secret, e.g. the secret key used for authentication to the Worldline Global Collect platform.
+        # @param metadata_provider       [Worldline::Connect::SDK::Communication::MetadataProvider] stores the metadata for the communicating client.
+        # @param connection              [Worldline::Connect::SDK::Communication::Connection] connection that can be used to communicate with the Worldline Global Collect platform.
+        # @param authenticator           [Worldline::Connect::SDK::Authentication::Authenticator] authenticator that can authenticate messages sent to the Worldline Global Collect platform.
+        # @param marshaller              [Worldline::Connect::SDK::JSON::Marshaller] marshaller that can marshal and unmarshal objects to and from JSON.
+        # @return [Worldline::Connect::SDK::Client] The created client
+        def self.create_client_from_file(configuration_file_name, authorization_id, authorization_secret,
+                                         metadata_provider: nil, connection: nil, authenticator: nil, marshaller: nil)
+          communicator = create_communicator_from_file(configuration_file_name, authorization_id, authorization_secret,
+                                                       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
+
+        private
+
+        # @param configuration [Worldline::Connect::SDK::CommunicatorConfiguration]
+        def self.get_authenticator(configuration)
+          if configuration.authorization_type == Authentication::AuthorizationType::V1HMAC
+            return Authentication::V1HMACAuthenticator.new(configuration.api_key_id, configuration.secret_api_key)
+          end
+          raise RuntimeError.new("Unknown authorizationType #{configuration.authorization_type}")
+        end
+      end
+    end
+  end
+end

data/lib/worldline/connect/sdk/json/default_marshaller.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'singleton'
+require 'worldline/connect/sdk/json/marshaller'
+
+module Worldline
+  module Connect
+    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
+end

data/lib/worldline/connect/sdk/json/marshaller.rb

@@ -0,0 +1,29 @@
+module Worldline
+  module Connect
+    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 [Worldline::Connect::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
+end

data/lib/worldline/connect/sdk/json/marshaller_syntax_exception.rb

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

data/lib/worldline/connect/sdk/json.rb

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

data/lib/worldline/connect/sdk/logging/communicator_logger.rb

@@ -0,0 +1,26 @@
+module Worldline
+  module Connect
+    module SDK
+      module Logging
+        # Base logger class used in this SDK. This class is an interface and cannot be instantiated.
+        class CommunicatorLogger
+
+          # Interface, no instantiation
+          # @see Worldline::Connect::SDK::Logging::StdoutCommunicatorLogger
+          # @see Worldline::Connect::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, 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
+  end
+end