direct-sdk-ruby 1.0.0

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

@@ -0,0 +1,55 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/api_resource'
+require 'ingenico/direct/sdk/response_exception'
+require 'ingenico/direct/sdk/domain/error_response'
+require 'ingenico/direct/sdk/domain/session_request'
+require 'ingenico/direct/sdk/domain/session_response'
+
+module Ingenico::Direct::SDK
+  module Merchant
+    module Sessions
+
+      # Sessions client. Thread-safe.
+      class SessionsClient < Ingenico::Direct::SDK::ApiResource
+
+        # @param parent        [Ingenico::Direct::SDK::ApiResource]
+        # @param path_context  [Hash, nil]
+        def initialize(parent, path_context = nil)
+          super(parent, path_context)
+        end
+
+        # Resource /v2/!{merchantId}/sessions - {https://support.direct.ingenico.com/documentation/api/reference#operation/CreateSessionApi Create session}
+        # @param body    [Ingenico::Direct::SDK::Domain::SessionRequest]
+        # @param context [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::SessionResponse]
+        # @raise [Ingenico::Direct::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Direct::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Direct::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Direct::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)
+        # @raise [Ingenico::Direct::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments 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)
+        # @raise [Ingenico::Direct::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def create_session(body, context = nil)
+          uri = instantiate_uri('/v2/{merchantId}/sessions')
+          @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Direct::SDK::Domain::SessionResponse,
+            context
+          )
+        rescue ResponseException => e
+          error_type = Ingenico::Direct::SDK::Domain::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/direct/sdk/merchant/tokens/tokens_client.rb

@@ -0,0 +1,117 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/api_resource'
+require 'ingenico/direct/sdk/response_exception'
+require 'ingenico/direct/sdk/domain/create_token_request'
+require 'ingenico/direct/sdk/domain/created_token_response'
+require 'ingenico/direct/sdk/domain/error_response'
+require 'ingenico/direct/sdk/domain/token_response'
+
+module Ingenico::Direct::SDK
+  module Merchant
+    module Tokens
+
+      # Tokens client. Thread-safe.
+      class TokensClient < Ingenico::Direct::SDK::ApiResource
+
+        # @param parent        [Ingenico::Direct::SDK::ApiResource]
+        # @param path_context  [Hash, nil]
+        def initialize(parent, path_context = nil)
+          super(parent, path_context)
+        end
+
+        # Resource /v2/!{merchantId}/tokens - {https://support.direct.ingenico.com/documentation/api/reference#operation/CreateTokenApi Create token}
+        # @param body    [Ingenico::Direct::SDK::Domain::CreateTokenRequest]
+        # @param context [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::CreatedTokenResponse]
+        # @raise [Ingenico::Direct::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Direct::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Direct::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Direct::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)
+        # @raise [Ingenico::Direct::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments 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)
+        # @raise [Ingenico::Direct::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def create_token(body, context = nil)
+          uri = instantiate_uri('/v2/{merchantId}/tokens')
+          @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Direct::SDK::Domain::CreatedTokenResponse,
+            context
+          )
+        rescue ResponseException => e
+          error_type = Ingenico::Direct::SDK::Domain::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /v2/!{merchantId}/tokens/!{tokenId} - {https://support.direct.ingenico.com/documentation/api/reference#operation/GetTokenApi Get token}
+        # @param token_id [String]
+        # @param context  [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::TokenResponse]
+        # @raise [Ingenico::Direct::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Direct::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Direct::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Direct::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)
+        # @raise [Ingenico::Direct::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments 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)
+        # @raise [Ingenico::Direct::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def get_token(token_id, context = nil)
+          path_context = {
+            'tokenId'.freeze => token_id,
+          }
+          uri = instantiate_uri('/v2/{merchantId}/tokens/{tokenId}', path_context)
+          @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Direct::SDK::Domain::TokenResponse,
+            context
+          )
+        rescue ResponseException => e
+          error_type = Ingenico::Direct::SDK::Domain::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /v2/!{merchantId}/tokens/!{tokenId} - {https://support.direct.ingenico.com/documentation/api/reference#operation/DeleteTokenApi Delete token}
+        # @param token_id [String]
+        # @param context  [Ingenico::Direct::SDK::CallContext]
+        # @raise [Ingenico::Direct::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Direct::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Direct::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Direct::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)
+        # @raise [Ingenico::Direct::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments 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)
+        # @raise [Ingenico::Direct::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def delete_token(token_id, context = nil)
+          path_context = {
+            'tokenId'.freeze => token_id,
+          }
+          uri = instantiate_uri('/v2/{merchantId}/tokens/{tokenId}', path_context)
+          @communicator.delete(
+            uri,
+            client_headers,
+            nil,
+            nil,
+            context
+          )
+        rescue ResponseException => e
+          error_type = Ingenico::Direct::SDK::Domain::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/direct/sdk/meta_data_provider.rb

@@ -0,0 +1,150 @@
+require 'ingenico/direct/sdk/domain/shopping_cart_extension'
+require 'base64'
+
+module Ingenico::Direct::SDK
+
+  # Manages metadata about the server using the SDK
+  #
+  # @attr_reader [Array<Ingenico::Direct::SDK::RequestHeader>] meta_data_headers List of headers that should be used in all requests.
+  class MetaDataProvider
+    SDK_VERSION = '0.0.1'.freeze
+    SERVER_META_INFO_HEADER = 'X-GCS-ServerMetaInfo'.freeze
+    PROHIBITED_HEADERS = [SERVER_META_INFO_HEADER,
+                          'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization'].sort!.freeze
+    CHARSET = 'utf-8'.freeze
+
+    # Stores metadata about the server so it can be sent to the Ingenico ePayments 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
+        hash['platformIdentifier'] = @platform_identifier if @platform_identifier
+        hash['sdkIdentifier'] = @sdk_identifier if @sdk_identifier
+        hash['sdkCreator'] = @sdk_creator if @sdk_creator
+        hash['integrator'] = @integrator if @integrator
+        hash['shoppingCartExtension'] = @shopping_cart_extension.to_h if @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'
+        @shopping_cart_extension = Domain::ShoppingCartExtension.new_from_hash(hash['shoppingCartExtension']) if hash.has_key? 'shoppingCartExtension'
+      end
+    end
+
+    # Create a new MetaDataProvider instance that can be used to access platform-related information
+    #
+    # @param integrator                 [String] Name of the integrator
+    # @param shopping_cart_extension    [Ingenico::Direct::SDK::Domain::ShoppingCartExtension] shopping cart-related metadata.
+    # @param additional_request_headers [Array<Ingenico::Direct::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 if shopping_cart_extension
+      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::Direct::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)
+      if additional_request_headers
+        additional_request_headers.each { |additional_request_header|
+          validate_additional_request_header(additional_request_header)
+        }
+      end
+    end
+
+    # Checks that the {Ingenico::Direct::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, "request header '#{additional_request_header.name}' not allowed"
+      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
+      os_host = RbConfig::CONFIG['host_os']
+      if os_host.include? 'mingw'
+        s = 'Windows'
+      elsif os_host.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::Direct::SDK::RequestHeader} that contains serialized and encoded {Ingenico::Direct::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
+
+    attr_reader :meta_data_headers
+  end
+end

data/lib/ingenico/direct/sdk/modules.rb

@@ -0,0 +1,71 @@
+# Main module of this SDK. All non-data classes that are used at multiple places in the SDK are placed in this module.
+module Ingenico::Direct::SDK
+end
+
+# Contains provided implementations for abstract functionality in this SDK.
+# These implementations can be replaced or adapted if desired to suit specific needs.
+module Ingenico::Direct::SDK::DefaultImpl
+end
+
+# Container for all data-containing modules.
+# The data-classes contained within can be serialized and communicated with the Ingenico ePayments platform.
+# These classes generally contain data used in processing requests or responses.
+module Ingenico::Direct::SDK::Domain
+end
+
+# Contains all logging-related classes.
+module Ingenico::Direct::SDK::Logging
+end
+
+# Contains interfaces to all Direct services. These services are accessed through a *Ingenico::Direct::SDK::Client* instance.
+module Ingenico::Direct::SDK::Merchant
+end
+
+# Contains the client used to access the Hosted Checkout service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/HostedCheckout/
+module Ingenico::Direct::SDK::Merchant::HostedCheckout
+end
+
+# Contains the client used to access the Hosted Tokenization service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/HostedTokenization/
+module Ingenico::Direct::SDK::Merchant::HostedTokenization
+end
+
+# Contains the client used to access the Payment service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Payments/
+module Ingenico::Direct::SDK::Merchant::Payments
+end
+
+# Contains the client used to access the Payout service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Payouts/
+module Ingenico::Direct::SDK::Merchant::Payouts
+end
+
+# Contains the client used to access the Product Groups service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/ProductGroups/
+module Ingenico::Direct::SDK::Merchant::ProductGroups
+end
+
+# Contains the client used to access the Products service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Products/
+module Ingenico::Direct::SDK::Merchant::Products
+end
+
+# Contains the client to access miscellaneous services.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Services/
+module Ingenico::Direct::SDK::Merchant::Services
+end
+
+# Contains the client used to access the Sessions service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Sessions/
+module Ingenico::Direct::SDK::Merchant::Sessions
+end
+
+# Contains the client used to access the Tokens service.
+# @see https://support.direct.ingenico.com/documentation/api/reference/index.html#tag/Tokens/
+module Ingenico::Direct::SDK::Merchant::Tokens
+end
+
+# Contains data classes related to Webhooks functionality.
+module Ingenico::Direct::SDK::Webhooks
+end

data/lib/ingenico/direct/sdk/not_found_exception.rb

@@ -0,0 +1,16 @@
+module Ingenico::Direct::SDK
+
+  # Raised when a resource is not found on the Ingenico ePayments platform.
+  # This error corresponds to a 404 HTTP response.
+  #
+  # @attr [Exception] cause The error that is the cause of this error.
+  class NotFoundException < RuntimeError
+
+    def initialize(cause, message = nil)
+      super(message)
+      @cause = cause
+    end
+
+    attr_accessor :cause
+  end
+end

data/lib/ingenico/direct/sdk/param_request.rb

@@ -0,0 +1,11 @@
+module Ingenico::Direct::SDK
+
+  # Class that represents the URL request parameters.
+  # Contains a method to add a name and value pair to a parameter array as a {Ingenico::Direct::SDK::RequestParam}.
+  class ParamRequest
+    # @return [Array<Ingenico::Direct::SDK::RequestParam>]
+    def to_request_parameters
+      raise NotImplementedError
+    end
+  end
+end

data/lib/ingenico/direct/sdk/pooled_connection.rb

@@ -0,0 +1,21 @@
+module Ingenico::Direct::SDK
+
+  # {Ingenico::Direct::SDK::Connection} that supports connection pooling. This is used to more efficiently communicate using HTTP.
+  # Connection pooling means that a number of connections are kept alive after use so they can possibly be reused.
+  # If the Connection does not do so automatically,
+  # the methods _close_idle_connections_ and _close_expired_connections_ can be used to drop connections
+  # that are idle for a specified amount of time or that have expired.
+  # @see Ingenico::Direct::SDK::DefaultImpl::DefaultConnection
+  class PooledConnection < Connection
+
+    # Closes all connections that have not been used for _idle_time_ seconds.
+    def close_idle_connections(idle_time)
+      raise NotImplementedError
+    end
+
+    # Closes all connections that have expired.
+    def close_expired_connections
+      raise NotImplementedError
+    end
+  end
+end