direct-sdk-ruby 1.0.0

data/lib/ingenico/direct/sdk/logging/request_log_message_builder.rb

@@ -0,0 +1,39 @@
+module Ingenico::Direct::SDK
+  module Logging
+
+    # Class that converts data about a request into a properly formatted log message.
+    # Formats request id, http method, uri, headers and body into a helpful message.
+    class RequestLogMessageBuilder < Ingenico::Direct::SDK::Logging::LogMessageBuilder
+
+      def initialize(request_id, method, uri)
+        super(request_id)
+        @method = method
+        @uri = uri
+      end
+
+      # Constructs and returns a log message based on the request data. The log message is a string.
+      def get_message
+        @body ?
+            sprintf(MSG_TEMPLATE_WITH_BODY, @request_id, empty_if_null(@method),
+                    format_uri, @headers, empty_if_null(@content_type), @body) :
+            sprintf(MSG_TEMPLATE_WITHOUT_BODY, @request_id, empty_if_null(@method), format_uri, @headers)
+      end
+
+      private
+
+      MSG_TEMPLATE_WITHOUT_BODY = "Outgoing request (requestId=\"%s\"):\n"\
+                                  "  method:       \"%s\"\n"\
+                                  "  uri:          \"%s\"\n"\
+                                  "  headers:      \"%s\"".freeze
+      MSG_TEMPLATE_WITH_BODY = "#{MSG_TEMPLATE_WITHOUT_BODY}\n"\
+                               "  content-type: \"%s\"\n"\
+                               "  body:         \"%s\"".freeze
+
+      def format_uri
+        return '' unless @uri && @uri.path
+        return @uri.path unless @uri.query
+        "#{@uri.path}?#{@uri.query}"
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/logging/response_log_message_builder.rb

@@ -0,0 +1,34 @@
+module Ingenico::Direct::SDK
+  module Logging
+
+    class ResponseLogMessageBuilder < LogMessageBuilder
+
+      # Class that converts data about a response into a properly formatted log message.
+      # Formats request id, status code, headers, body and time between request and response into a helpful message.
+      #
+      # @param request_id  [String] identifier of the request corresponding to this response.
+      # @param status_code [Integer] HTTP status code of the response.
+      # @param duration    [Float] time elapsed between request and response.
+      def initialize(request_id, status_code, duration = -1)
+        super(request_id)
+        @status_code = status_code
+        @duration = duration
+      end
+
+      # Constructs and returns a log message based on the request data. The log message is a string.
+      def get_message
+        msg_template = "Incoming response (requestId=\"%s\"#{(@duration.positive?) ? ", %.3f ms" : ""}):\n" +
+          "  status-code:  \"%s\"\n" +
+          "  headers:      \"%s\"\n" +
+          "  content-type: \"%s\"\n" +
+          "  body:         \"%s\""
+
+        @duration.positive? ?
+          sprintf(msg_template, @request_id, @duration, @status_code, @headers,
+                  empty_if_null(@content_type), empty_if_null(@body)) :
+          sprintf(msg_template, @request_id, @status_code, @headers,
+                  empty_if_null(@content_type), empty_if_null(@body))
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/logging/ruby_communicator_logger.rb

@@ -0,0 +1,57 @@
+require 'English'
+
+module Ingenico::Direct::SDK
+  module Logging
+
+    # Logging class that Logs messages and errors to a logger.
+    # Errors can be logged at a separate level compared to regular messages.
+    class RubyCommunicatorLogger < CommunicatorLogger
+
+      # Creates a new RubyCommunicatorLogger instance.
+      #
+      # @param logger      [Logger] the logger to log messages to. Messages to log will be provided using logger#log(message level, message)
+      # @param log_level   [String] log level to use for non-error messages.
+      # @param error_level [String] error logging level to use.
+      def initialize(logger, log_level, error_level = false)
+        # implement the interface
+        error_level ||= log_level
+        raise ArgumentError unless logger
+        raise ArgumentError unless log_level
+        raise ArgumentError unless error_level
+
+        @logger = logger
+        @log_level = log_level
+        @errorLevel = error_level
+      end
+
+      # Logs a single error or non-error message to the logger.
+      def log(msg, thrown = nil)
+        # use Ruby Logger
+        if thrown
+          @logger.log(@errorLevel) { msg + $RS + thrown.to_s + $RS + thrown.backtrace.join($RS) }
+        else
+          @logger.log(@log_level, msg)
+        end
+      end
+
+      # Opens or creates a new file in write-only mode with _filename_.
+      def self.create_logfile(filename)
+        logdev = begin
+                   open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+                 rescue Errno::EEXIST
+                   # file is created by another process
+                   open_logfile(filename)
+                 end
+        logdev.sync = true
+        logdev
+      end
+
+      # Opens or creates a new file in write-only mode with _filename_.
+      def self.open_logfile(filename)
+        open(filename, (File::WRONLY | File::APPEND))
+      rescue Errno::ENOENT
+        create_logfile(filename)
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/logging/stdout_communicator_logger.rb

@@ -0,0 +1,34 @@
+require 'English'
+require 'singleton'
+
+module Ingenico::Direct::SDK
+  module Logging
+
+    # {Ingenico::Direct::SDK::Logging::CommunicatorLogger} that logs the messages to $stdout.
+    class StdoutCommunicatorLogger < CommunicatorLogger
+      include Singleton
+
+      def initialize
+        # implement the interface
+      end
+
+      # NOTE: this alias is needed to not break existing method calls depending on old interface
+      class << self
+        alias_method :INSTANCE, :instance
+      end
+
+      # Logs a single error or non-error message to $stdout.
+      def log(msg, thrown = nil)
+        $stdout.puts get_date_prefix + msg
+        $stdout.puts thrown.to_s if thrown
+        $stdout.puts thrown.backtrace.join($RS) if thrown
+      end
+
+      private
+
+      def get_date_prefix
+        Time.now.strftime("%Y-%m-%dT%H:%M:%S ")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Ingenico::Direct::SDK
+
+  # 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 [Ingenico::Direct::SDK::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

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

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

data/lib/ingenico/direct/sdk/merchant/hostedcheckout/hosted_checkout_client.rb

@@ -0,0 +1,87 @@
+#
+# 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_hosted_checkout_request'
+require 'ingenico/direct/sdk/domain/create_hosted_checkout_response'
+require 'ingenico/direct/sdk/domain/error_response'
+require 'ingenico/direct/sdk/domain/get_hosted_checkout_response'
+
+module Ingenico::Direct::SDK
+  module Merchant
+    module HostedCheckout
+
+      # HostedCheckout client. Thread-safe.
+      class HostedCheckoutClient < 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}/hostedcheckouts - {https://support.direct.ingenico.com/documentation/api/reference#operation/CreateHostedCheckoutApi Create hosted checkout}
+        # @param body    [Ingenico::Direct::SDK::Domain::CreateHostedCheckoutRequest]
+        # @param context [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::CreateHostedCheckoutResponse]
+        # @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_hosted_checkout(body, context = nil)
+          uri = instantiate_uri('/v2/{merchantId}/hostedcheckouts')
+          @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Direct::SDK::Domain::CreateHostedCheckoutResponse,
+            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}/hostedcheckouts/!{hostedCheckoutId} - {https://support.direct.ingenico.com/documentation/api/reference#operation/GetHostedCheckoutApi Get hosted checkout status}
+        # @param hosted_checkout_id [String]
+        # @param context            [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::GetHostedCheckoutResponse]
+        # @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_hosted_checkout(hosted_checkout_id, context = nil)
+          path_context = {
+            'hostedCheckoutId'.freeze => hosted_checkout_id,
+          }
+          uri = instantiate_uri('/v2/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
+          @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Direct::SDK::Domain::GetHostedCheckoutResponse,
+            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/hostedtokenization/hosted_tokenization_client.rb

@@ -0,0 +1,87 @@
+#
+# 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_hosted_tokenization_request'
+require 'ingenico/direct/sdk/domain/create_hosted_tokenization_response'
+require 'ingenico/direct/sdk/domain/error_response'
+require 'ingenico/direct/sdk/domain/get_hosted_tokenization_response'
+
+module Ingenico::Direct::SDK
+  module Merchant
+    module HostedTokenization
+
+      # HostedTokenization client. Thread-safe.
+      class HostedTokenizationClient < 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}/hostedtokenizations - {https://support.direct.ingenico.com/documentation/api/reference#operation/CreateHostedTokenizationApi Create hosted tokenization session}
+        # @param body    [Ingenico::Direct::SDK::Domain::CreateHostedTokenizationRequest]
+        # @param context [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::CreateHostedTokenizationResponse]
+        # @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_hosted_tokenization(body, context = nil)
+          uri = instantiate_uri('/v2/{merchantId}/hostedtokenizations')
+          @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Direct::SDK::Domain::CreateHostedTokenizationResponse,
+            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}/hostedtokenizations/!{hostedTokenizationId} - {https://support.direct.ingenico.com/documentation/api/reference#operation/GetHostedTokenizationApi Get hosted tokenization session}
+        # @param hosted_tokenization_id [String]
+        # @param context                [Ingenico::Direct::SDK::CallContext]
+        # @return [Ingenico::Direct::SDK::Domain::GetHostedTokenizationResponse]
+        # @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_hosted_tokenization(hosted_tokenization_id, context = nil)
+          path_context = {
+            'hostedTokenizationId'.freeze => hosted_tokenization_id,
+          }
+          uri = instantiate_uri('/v2/{merchantId}/hostedtokenizations/{hostedTokenizationId}', path_context)
+          @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Direct::SDK::Domain::GetHostedTokenizationResponse,
+            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/merchant_client.rb

@@ -0,0 +1,83 @@
+#
+# 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/merchant/hostedcheckout/hosted_checkout_client'
+require 'ingenico/direct/sdk/merchant/hostedtokenization/hosted_tokenization_client'
+require 'ingenico/direct/sdk/merchant/payments/payments_client'
+require 'ingenico/direct/sdk/merchant/payouts/payouts_client'
+require 'ingenico/direct/sdk/merchant/productgroups/product_groups_client'
+require 'ingenico/direct/sdk/merchant/products/products_client'
+require 'ingenico/direct/sdk/merchant/services/services_client'
+require 'ingenico/direct/sdk/merchant/sessions/sessions_client'
+require 'ingenico/direct/sdk/merchant/tokens/tokens_client'
+
+module Ingenico::Direct::SDK
+  module Merchant
+
+    # Merchant client. Thread-safe.
+    class MerchantClient < 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}/products
+      # @return [Ingenico::Direct::SDK::Merchant::Products::ProductsClient]
+      def products
+        Ingenico::Direct::SDK::Merchant::Products::ProductsClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/sessions
+      # @return [Ingenico::Direct::SDK::Merchant::Sessions::SessionsClient]
+      def sessions
+        Ingenico::Direct::SDK::Merchant::Sessions::SessionsClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/payouts
+      # @return [Ingenico::Direct::SDK::Merchant::Payouts::PayoutsClient]
+      def payouts
+        Ingenico::Direct::SDK::Merchant::Payouts::PayoutsClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/payments
+      # @return [Ingenico::Direct::SDK::Merchant::Payments::PaymentsClient]
+      def payments
+        Ingenico::Direct::SDK::Merchant::Payments::PaymentsClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/services/testconnection
+      # @return [Ingenico::Direct::SDK::Merchant::Services::ServicesClient]
+      def services
+        Ingenico::Direct::SDK::Merchant::Services::ServicesClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/productgroups
+      # @return [Ingenico::Direct::SDK::Merchant::ProductGroups::ProductGroupsClient]
+      def product_groups
+        Ingenico::Direct::SDK::Merchant::ProductGroups::ProductGroupsClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/hostedtokenizations
+      # @return [Ingenico::Direct::SDK::Merchant::HostedTokenization::HostedTokenizationClient]
+      def hosted_tokenization
+        Ingenico::Direct::SDK::Merchant::HostedTokenization::HostedTokenizationClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/tokens
+      # @return [Ingenico::Direct::SDK::Merchant::Tokens::TokensClient]
+      def tokens
+        Ingenico::Direct::SDK::Merchant::Tokens::TokensClient.new(self, nil)
+      end
+
+      # Resource /v2/!{merchantId}/hostedcheckouts
+      # @return [Ingenico::Direct::SDK::Merchant::HostedCheckout::HostedCheckoutClient]
+      def hosted_checkout
+        Ingenico::Direct::SDK::Merchant::HostedCheckout::HostedCheckoutClient.new(self, nil)
+      end
+    end
+  end
+end