connect-sdk-ruby 1.0.0

data/lib/ingenico/connect/sdk/merchant/services/services_client.rb

@@ -0,0 +1,149 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/response_exception'
+require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/services/bank_details_response'
+require 'ingenico/connect/sdk/domain/services/convert_amount'
+require 'ingenico/connect/sdk/domain/services/get_iin_details_response'
+require 'ingenico/connect/sdk/domain/services/test_connection'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Services
+
+      # Services client. Thread-safe.
+      class ServicesClient < Ingenico::Connect::SDK::ApiResource
+
+        # parent::       {Ingenico::Connect::SDK::ApiResource}
+        # path_context:: Hash of String to String
+        def initialize(parent, path_context)
+          super(parent, path_context)
+        end
+
+        # Resource /{{merchantId}}/services/convert/amount
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__services_convert_amount_get Convert amount}
+        # query::   {Ingenico::Connect::SDK::Merchant::Services::ConvertAmountParams}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Services::ConvertAmount}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def convert_amount(query, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/services/convert/amount', nil)
+          return @communicator.get(
+            uri,
+            client_headers,
+            query,
+            Ingenico::Connect::SDK::Domain::Services::ConvertAmount,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/services/convert/bankaccount
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__services_convert_bankaccount_post Convert Bankaccount}
+        # body::    {Ingenico::Connect::SDK::Domain::Services::BankDetailsRequest}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Services::BankDetailsResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def bankaccount(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/services/convert/bankaccount', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Services::BankDetailsResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/services/getIINdetails
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__services_getIINdetails_post Get IIN details}
+        # body::    {Ingenico::Connect::SDK::Domain::Services::GetIINDetailsRequest}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Services::GetIINDetailsResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def get_iin_details(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/services/getIINdetails', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Services::GetIINDetailsResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/services/testconnection
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__services_testconnection_get Test connection}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Services::TestConnection}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def testconnection(context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/services/testconnection', nil)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Services::TestConnection,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            403 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/merchant/sessions/sessions_client.rb

@@ -0,0 +1,55 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/response_exception'
+require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/sessions/session_response'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Sessions
+
+      # Sessions client. Thread-safe.
+      class SessionsClient < Ingenico::Connect::SDK::ApiResource
+
+        # parent::       {Ingenico::Connect::SDK::ApiResource}
+        # path_context:: Hash of String to String
+        def initialize(parent, path_context)
+          super(parent, path_context)
+        end
+
+        # Resource /{{merchantId}}/sessions
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__sessions_post Create Session}
+        # body::    {Ingenico::Connect::SDK::Domain::Sessions::SessionRequest}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Sessions::SessionResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def create(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/sessions', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Sessions::SessionResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/merchant/tokens/delete_token_params.rb

@@ -0,0 +1,27 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/param_request'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Tokens
+
+      # Query parameters for {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens__tokenId__delete Delete token}
+      class DeleteTokenParams < Ingenico::Connect::SDK::ParamRequest
+
+        # String
+        attr_accessor :mandate_cancel_date
+        attr_accessor :mandate_cancel_date
+
+        # Returns an Array of {Ingenico::Connect::SDK::RequestParam} objects representing the attributes of this class
+        def to_request_parameters
+          result = []
+          add_parameter(result, 'mandateCancelDate', @mandate_cancel_date)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb

@@ -0,0 +1,192 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/response_exception'
+require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/token/create_token_response'
+require 'ingenico/connect/sdk/domain/token/token_response'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Tokens
+
+      # Tokens client. Thread-safe.
+      class TokensClient < Ingenico::Connect::SDK::ApiResource
+
+        # parent::       {Ingenico::Connect::SDK::ApiResource}
+        # path_context:: Hash of String to String
+        def initialize(parent, path_context)
+          super(parent, path_context)
+        end
+
+        # Resource /{{merchantId}}/tokens
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens_post Create token}
+        # body::    {Ingenico::Connect::SDK::Domain::Token::CreateTokenRequest}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Token::CreateTokenResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def create(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Token::CreateTokenResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            403 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/tokens/{{tokenId}}
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens__tokenId__delete Delete token}
+        # token_id:: String
+        # query::    {Ingenico::Connect::SDK::Merchant::Tokens::DeleteParams}
+        # context::  {Ingenico::Connect::SDK::CallContext}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def delete(token_id, query, context=nil)
+          path_context = {
+            'tokenId' => token_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
+          return @communicator.delete(
+            uri,
+            client_headers,
+            query,
+            nil,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/tokens/{{tokenId}}
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens__tokenId__get Get token}
+        # token_id:: String
+        # context::  {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Token::TokenResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def get(token_id, context=nil)
+          path_context = {
+            'tokenId' => token_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Token::TokenResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/tokens/{{tokenId}}
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens__tokenId__put Update token}
+        # token_id:: String
+        # body::     {Ingenico::Connect::SDK::Domain::Token::UpdateTokenRequest}
+        # context::  {Ingenico::Connect::SDK::CallContext}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def update(token_id, body, context=nil)
+          path_context = {
+            'tokenId' => token_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}', path_context)
+          return @communicator.put(
+            uri,
+            client_headers,
+            nil,
+            body,
+            nil,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/tokens/{{tokenId}}/approvesepadirectdebit
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__tokens__tokenId__approvesepadirectdebit_post Approve SEPA DD mandate}
+        # token_id:: String
+        # body::     {Ingenico::Connect::SDK::Domain::Token::ApproveTokenRequest}
+        # context::  {Ingenico::Connect::SDK::CallContext}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {Ingenico::Connect::SDK::ReferenceException} if an object was attempted to be referenced that doesn't exist or has been removed,  
+        #          or there was a conflict (HTTP status code 404, 409 or 410)
+        # Raises:: {Ingenico::Connect::SDK::GlobalCollectException} if something went wrong at the GlobalCollect platform,  
+        #          the GlobalCollect platform was unable to process a message from a downstream partner/acquirer,  
+        #          or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the GlobalCollect platform returned any other error
+        def approvesepadirectdebit(token_id, body, context=nil)
+          path_context = {
+            'tokenId' => token_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/tokens/{tokenId}/approvesepadirectdebit', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            nil,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/meta_data_provider.rb

@@ -0,0 +1,152 @@
+require 'ingenico/connect/sdk/domain/metadata/shopping_cart_extension'
+require 'base64'
+
+module Ingenico::Connect::SDK
+
+  # Manages metadata about the server using the SDK
+  class MetaDataProvider
+    @@SDK_VERSION = '1.0.0'
+    @@SERVER_META_INFO_HEADER = 'X-GCS-ServerMetaInfo'
+    @@PROHIBITED_HEADERS = [@@SERVER_META_INFO_HEADER, 'X-GCS-Idempotence-Key',
+                            'Date', 'Content-Type', 'Authorization'].sort!.freeze
+    @@CHARSET = 'utf-8'
+
+    # Stores metadata about the server so it can be sent to the GlobalCollect platform
+    class ServerMetaInfo < DataObject
+      @platform_identifier = nil
+      @sdk_identifier = nil
+      @sdk_creator = nil
+      @integrator = nil
+      @shopping_cart_extension = nil
+
+      # String containing system information (Operating system and Ruby version).
+      attr_accessor :platform_identifier
+
+      # String containing this SDK version.
+      attr_accessor :sdk_identifier
+
+      attr_accessor :sdk_creator
+
+      attr_accessor :integrator
+
+      attr_accessor :shopping_cart_extension
+
+      # Returns the values of all attributes as a hash.
+      def to_h
+        hash = super
+        add_to_hash(hash, 'platformIdentifier', platform_identifier)
+        add_to_hash(hash, 'sdkIdentifier', sdk_identifier)
+        add_to_hash(hash, 'sdkCreator', sdk_creator)
+        add_to_hash(hash, 'integrator', integrator)
+        add_to_hash(hash, 'shoppingCartExtension', shopping_cart_extension)
+        hash
+      end
+
+      # Initializes the ServerMetaInfo object with properties stored in the parameter hash
+      def from_hash(hash)
+        super
+        @platform_identifier = hash['platformIdentifier'] if hash.has_key?('platformIdentifier')
+        @sdk_identifier = hash['sdkIdentifier'] if hash.has_key?('sdkIdentifier')
+        @sdk_creator = hash['sdkCreator'] if hash.has_key?('sdkCreator')
+        @integrator = hash['integrator'] if hash.has_key?('integrator')
+        if hash.has_key?('shoppingCartExtension')
+          @shopping_cart_extension = Domain::Metadata::ShoppingCartExtension.new_from_hash(hash['shoppingCartExtension'])
+        end
+      end
+    end
+
+    # Create a new MetaDataProvider instance that can be used to access platform-related information
+    #
+    # integrator::                  String
+    # shopping_cart_extension::     String
+    # additional_request_headers::  {Ingenico::Connect::SDK::RequestHeader} list of additional headers to include in all requests made.
+    #                               The following headers are not allowed due to conflicts with already added headers:
+    #                               'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization'
+    #                               and 'X-GCS-ServerMetaInfo'
+    def initialize(integrator, shopping_cart_extension: nil, additional_request_headers: [].freeze)
+
+      MetaDataProvider.validate_additional_request_headers(additional_request_headers)
+      server_meta_info = ServerMetaInfo.new
+      server_meta_info.platform_identifier = get_platform_identifier
+      server_meta_info.sdk_identifier = get_sdk_identifier
+      server_meta_info.sdk_creator = 'Ingenico'
+      server_meta_info.integrator = integrator
+      server_meta_info.shopping_cart_extension = shopping_cart_extension unless shopping_cart_extension.nil?
+      server_meta_info_string = DefaultImpl::DefaultMarshaller.INSTANCE.marshal(server_meta_info)
+      server_meta_info_header = RequestHeader.new(
+          @@SERVER_META_INFO_HEADER, Base64.strict_encode64(
+          server_meta_info_string.force_encoding('iso-8859-1').encode(@@CHARSET)))
+      if additional_request_headers.nil? || additional_request_headers.empty?
+        @meta_data_headers = [server_meta_info_header].freeze
+      else
+        request_headers = [server_meta_info_header]
+        request_headers += additional_request_headers
+        @meta_data_headers = request_headers.freeze
+      end
+    end
+
+    # Checks that none of the {Ingenico::Connect::SDK::RequestHeaders} in _additional_request_headers_ is equal to any of the forbidden headers.
+    # The forbidden headers are:
+    #'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization' and 'X-GCS-ServerMetaInfo'
+    # If a header is found that is equal to one of the forbidden headers an ArgumentError is raised.
+    def self.validate_additional_request_headers(additional_request_headers)
+      unless additional_request_headers.nil?
+        additional_request_headers.each { |additional_request_header|
+          validate_additional_request_header(additional_request_header)
+        }
+      end
+    end
+
+    # Checks that the {Ingenico::Connect::SDK::RequestHeaders} _additional_request_header_ is equal to any of the forbidden headers.
+    # The forbidden headers are:
+    #'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization' and 'X-GCS-ServerMetaInfo'
+    # If the header is equal to one of the forbidden headers an ArgumentError is raised.
+    def self.validate_additional_request_header(additional_request_header)
+      if MetaDataProvider.PROHIBITED_HEADERS.include? additional_request_header.name
+        raise ArgumentError.new('request header not allowed' + additional_request_header.name)
+      end
+    end
+
+    protected
+
+    # String containing information of the system using the SDK.
+    # It contains data like Operating System version and Ruby version
+    def get_platform_identifier
+      config = RbConfig::CONFIG['host_os']
+      if config.include? 'mingw'
+        s = 'Windows'
+      elsif config.include? 'linux'
+        s = 'Linux'
+      else
+        s = 'Mac OS X'
+      end
+      s += '/' + RUBY_DESCRIPTION
+    end
+
+    # String describing the version of the SDK being used
+    def get_sdk_identifier
+      'RubyServerSDK/v' + @@SDK_VERSION
+    end
+
+    public
+
+    # Version of this SDK being used
+    def self.SDK_VERSION
+      @@SDK_VERSION
+    end
+
+    # A {Ingenico::Connect::SDK::RequestHeader} that contains serialized and encoded {Ingenico::Connect::SDK::MetaDataProvider::ServerMetaInfo}.
+    def self.SERVER_META_INFO_HEADER
+      @@SERVER_META_INFO_HEADER
+    end
+
+    # A list of header names that should not be used by any added headers.
+    # These headers are reserved for specific purposes.
+    def self.PROHIBITED_HEADERS
+      @@PROHIBITED_HEADERS
+    end
+
+    # A {Ingenico::Connect::SDK::RequestHeader} list of headers that should be used in all requests.
+    attr_reader :meta_data_headers
+  end
+end