connect-sdk-ruby 2.47.1 → 3.0.0

data/examples/merchant/tokens/update_token_example.rb

@@ -1,76 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/
-#
-require 'ingenico/connect/sdk/factory'
-require 'ingenico/connect/sdk/domain/definitions/address'
-require 'ingenico/connect/sdk/domain/definitions/card_without_cvv'
-require 'ingenico/connect/sdk/domain/definitions/company_information'
-require 'ingenico/connect/sdk/domain/token/customer_token'
-require 'ingenico/connect/sdk/domain/token/personal_information_token'
-require 'ingenico/connect/sdk/domain/token/personal_name_token'
-require 'ingenico/connect/sdk/domain/token/token_card'
-require 'ingenico/connect/sdk/domain/token/token_card_data'
-require 'ingenico/connect/sdk/domain/token/update_token_request'
-
-Definitions = Ingenico::Connect::SDK::Domain::Definitions
-Token = Ingenico::Connect::SDK::Domain::Token
-
-def example
-  get_client do |client|
-    billing_address = Definitions::Address.new
-    billing_address.additional_info = 'b'
-    billing_address.city = 'Monument Valley'
-    billing_address.country_code = 'US'
-    billing_address.house_number = '13'
-    billing_address.state = 'Utah'
-    billing_address.street = 'Desertroad'
-    billing_address.zip = '84536'
-
-    company_information = Definitions::CompanyInformation.new
-    company_information.name = 'Acme Labs'
-
-    name = Token::PersonalNameToken.new
-    name.first_name = 'Wile'
-    name.surname = 'Coyote'
-    name.surname_prefix = 'E.'
-
-    personal_information = Token::PersonalInformationToken.new
-    personal_information.name = name
-
-    customer = Token::CustomerToken.new
-    customer.billing_address = billing_address
-    customer.company_information = company_information
-    customer.merchant_customer_id = '1234'
-    customer.personal_information = personal_information
-
-    card_without_cvv = Definitions::CardWithoutCvv.new
-    card_without_cvv.card_number = '4567350000427977'
-    card_without_cvv.cardholder_name = 'Wile E. Coyote'
-    card_without_cvv.expiry_date = '1299'
-    card_without_cvv.issue_number = '12'
-
-    data = Token::TokenCardData.new
-    data.card_without_cvv = card_without_cvv
-
-    card = Token::TokenCard.new
-    card.customer = customer
-    card.data = data
-
-    body = Token::UpdateTokenRequest.new
-    body.card = card
-    body.payment_product_id = 1
-
-    client.merchant('merchantId').tokens.update('tokenId', body)
-  end
-end
-
-def get_client
-  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
-  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
-  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
-  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
-ensure
-  # Free networking resources when done
-  client.close unless client.nil?
-end

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

@@ -1,53 +0,0 @@
-module Ingenico
-  module Connect
-    module SDK
-      # Base class for many exceptions raised by the SDK.
-      # It is raised when an error response is received from the Ingenico ePayments platform.
-      # It contains data about the returned response.
-      #
-      # @attr_reader [Integer] status_code   HTTP status code of the returned response.
-      # @attr_reader [String]  response_body Message body of the returned response.
-      # @attr_reader [String]  error_id      An error id corresponding to the error that occurred, if available.
-      # @attr_reader [Array<Ingenico::Connect::SDK::Domain::Errors::APIError>] errors A list of errors received from the Ingenico ePayments platform;
-      #              may be empty but never _nil_
-      class ApiException < RuntimeError
-
-        # Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
-        #
-        # @param status_code   (Integer) HTTP status code the response
-        # @param response_body (String) HTTP response body
-        # @param error_id      (String) error id of the error, may be _nil_
-        # @param errors        (Array<Ingenico::Connect::SDK::Domain::Errors::APIError>) a list of errors that occurred, may be empty
-        # @param message       (String) error message to include
-        def initialize(status_code, response_body, error_id, errors,
-                       message = 'the Ingenico ePayments platform returned an error response')
-          super(message)
-          @status_code = status_code
-          @response_body = response_body
-          @error_id = error_id
-          if errors.nil?
-            @errors = [].freeze
-          else
-            @errors = errors
-          end
-        end
-
-        attr_reader :status_code
-        attr_reader :response_body
-        attr_reader :error_id
-        attr_reader :errors
-
-        def to_s
-          str = super.to_s
-          if @status_code > 0
-            str += '; status_code=' + @status_code.to_s
-          end
-          if !@response_body.nil? && @response_body.length > 0
-            str += "; response_body='" + @response_body + "'"
-          end
-          str.to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,144 +0,0 @@
-require 'ingenico/connect/sdk/api_exception'
-require 'ingenico/connect/sdk/authorization_exception'
-require 'ingenico/connect/sdk/declined_payment_exception'
-require 'ingenico/connect/sdk/declined_payout_exception'
-require 'ingenico/connect/sdk/declined_refund_exception'
-require 'ingenico/connect/sdk/domain/errors/error_response'
-require 'ingenico/connect/sdk/domain/payment/payment_error_response'
-require 'ingenico/connect/sdk/domain/payout/payout_error_response'
-require 'ingenico/connect/sdk/domain/refund/refund_error_response'
-require 'ingenico/connect/sdk/global_collect_exception'
-require 'ingenico/connect/sdk/idempotence_exception'
-require 'ingenico/connect/sdk/reference_exception'
-require 'ingenico/connect/sdk/request_header'
-require 'ingenico/connect/sdk/validation_exception'
-
-module Ingenico
-  module Connect
-    module SDK
-      # Base class of all Ingenico ePayments platform API resources.
-      # Provides shared functionality to facilitate communication with the Ingenico ePayments platform.
-      #
-      # @attr_reader [Ingenico::Connect::SDK::Communicator] communicator Communicator instance that provides communication with the Ingenico ePayments platform.
-      # @attr_reader [String] client_meta_info JSON string containing client info specific to the current client.
-      class ApiResource
-
-        # Creates a new ApiResource.
-        #
-        # @param arg              [Ingenico::Connect::SDK::ApiResource, Ingenico::Connect::SDK::Communicator] parent class or Communicator instance.
-        #                         If a parent class is given its communicator will be used for communication.
-        # @param path_context     [Hash] hash that contains substitutions for generic locations in the URL path.
-        #                         This hash will be used to instantiate a concrete URL used to access specific resources.
-        #                         For example in the URL https://eu.sandbox.api-ingenico.com/!{version}/!{merchantId}/payments
-        #                         !{version} and !{merchantId} can be instantiated using the hash
-        #                         !{'version' => 'v1', 'merchantId' => '1234'}. The final URL in this case will be
-        #                         https://eu.sandbox.api-ingenico.com/v1/1234/payments.
-        # @param client_meta_info [String] JSON string containing the meta data for the client.
-        def initialize(arg, path_context, client_meta_info = false)
-          if client_meta_info == false
-            if arg.nil?
-              raise ArgumentError.new('parent is required')
-            end
-            @parent = arg
-            @communicator = arg.communicator
-            @path_context = path_context
-            @client_meta_info = arg.client_meta_info
-          else
-            if arg.nil?
-              raise ArgumentError.new('communicator is required')
-            end
-            @parent = nil
-            @communicator = arg
-            @path_context = path_context
-            @client_meta_info = client_meta_info
-          end
-        end
-
-        attr_reader :communicator
-        attr_reader :client_meta_info
-
-        protected
-
-        # @return [Array<Ingenico::Connect::SDK::RequestHeader>, nil] the client headers,
-        #         including the X-GCS-ClientMetaInfo header if meta data for the client is available
-        def client_headers
-          if @client_meta_info.nil?
-            nil
-          else
-            [RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)]
-          end
-        end
-
-        def instantiate_uri(uri, path_context = false)
-          if path_context == false
-            uri = replace_all(uri, @path_context)
-            unless @parent.nil?
-              uri = @parent.instantiate_uri(uri)
-            end
-            uri
-          else
-            uri = replace_all(uri, path_context)
-            instantiate_uri(uri)
-          end
-        end
-
-        def create_exception(status_code, response_body, error_object, context)
-          if error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) && !error_object.payment_result.nil?
-            return DeclinedPaymentException.new(status_code, response_body, error_object)
-          elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) && !error_object.payout_result.nil?
-            return DeclinedPayoutException.new(status_code, response_body, error_object)
-          elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) && !error_object.refund_result.nil?
-            return DeclinedRefundException.new(status_code, response_body, error_object)
-          end
-          if !(error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) ||
-            error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) ||
-            error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) ||
-            error_object.is_a?(Ingenico::Connect::SDK::Domain::Errors::ErrorResponse))
-            raise ArgumentError.new("unsupported error object type: " + error_object.class.name)
-          else
-            error_id = error_object.error_id
-            errors = error_object.errors
-          end
-          case status_code
-          when 400
-            return ValidationException.new(status_code, response_body, error_id, errors)
-          when 403
-            return AuthorizationException.new(status_code, response_body, error_id, errors)
-          when 404, 410
-            return ReferenceException.new(status_code, response_body, error_id, errors)
-          when 409
-            if is_idempotence_error(errors, context)
-              idempotence_key = context.idempotence_key
-              idempotence_request_timestamp = context.idempotence_request_timestamp
-              return IdempotenceException.new(status_code, response_body, error_id,
-                                              errors, idempotence_key,
-                                              idempotence_request_timestamp)
-            else
-              return ReferenceException.new(status_code, response_body, error_id, errors)
-            end
-          when 500, 502, 503
-            return GlobalCollectException.new(status_code, response_body, error_id, errors)
-          else
-            return ApiException.new(status_code, response_body, error_id, errors)
-          end
-        end
-
-        private
-
-        def replace_all(uri, path_context)
-          unless path_context.nil?
-            path_context.each do |key, value|
-              uri = uri.gsub('{' + key + '}', value)
-            end
-          end
-          uri
-        end
-
-        def is_idempotence_error(errors, context)
-          !context.nil? && !context.idempotence_key.nil? && errors.length == 1 &&
-            errors[0].code == '1409'
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Ingenico
-  module Connect
-    module SDK
-      # Abstract class that is responsible for authenticating requests sent to the Ingenico ePayments platform.
-      class Authenticator
-
-        # Creates a signature to authenticate a request.
-        #
-        # @param http_method     [String] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
-        # @param resource_uri    [URI::HTTP] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
-        # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] all headers used by the request
-        # @return [String] the created signature
-        def create_simple_authentication_signature(http_method, resource_uri, request_headers)
-          raise NotImplementedError
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-require 'ingenico/connect/sdk/api_exception'
-
-module Ingenico
-  module Connect
-    module SDK
-      # This exception is thrown when a request sent to the Ingenico ePayments platform is not correctly authenticated.
-      # Corresponds to a HTTP status code of 403.
-      # @see ApiException#initialize
-      class AuthorizationException < ApiException
-
-        def initialize(status_code, response_body, error_id, errors,
-                       message = 'the Ingenico ePayments platform returned an authorization error response')
-          super(status_code, response_body, error_id, errors, message)
-        end
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-module Ingenico
-  module Connect
-    module SDK
-      # A CallContext is used to identify requests and manage idempotent requests.
-      # A CallContext contains the following:
-      #
-      # idempotence_key::               A randomly generated key used to identify requests
-      # idempotence_request_timestamp:: If a previous request arrived with the same idempotence key,
-      #                                 this value will be set to a timestamp of that request.
-      #
-      # @attr_reader [String] idempotence_key The idempotence key used to identify this request.
-      #              If two requests share the same _idempotence_key_, they are considered to be the same request
-      #              and only the first request will be processed.
-      # @attr        [Integer] idempotence_request_timestamp If two or more requests arrive at the Ingenico ePayments platform with the same _idempotence_key_,
-      #              the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
-      class CallContext
-        @idempotence_request_timestamp = nil
-        @idempotence_key = nil
-
-        def initialize(idempotence_key = nil)
-          @idempotence_key = idempotence_key
-        end
-
-        attr_reader :idempotence_key
-        attr_accessor :idempotence_request_timestamp
-      end
-    end
-  end
-end

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

@@ -1,106 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/
-#
-require 'base64'
-require 'ingenico/connect/sdk/api_resource'
-require 'ingenico/connect/sdk/data_object'
-require 'ingenico/connect/sdk/logging/logging_capable'
-require 'ingenico/connect/sdk/logging/obfuscation/obfuscation_capable'
-require 'ingenico/connect/sdk/merchant/merchant_client'
-
-module Ingenico
-  module Connect
-    module SDK
-      # Ingenico ePayments platform client.
-      #
-      # This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.
-      #
-      # To get a new client with a different header value, use with_client_meta_info.
-      #
-      # Thread safe.
-      class Client < ApiResource
-        include Logging::LoggingCapable
-        include Logging::Obfuscation::ObfuscationCapable
-
-        # @return [String]
-        def self.API_VERSION
-          'v1'
-        end
-
-        # @param communicator     [Ingenico::Connect::SDK::Communicator]
-        # @param client_meta_info [String]
-        def initialize(communicator, client_meta_info = nil)
-          super(communicator, nil, client_meta_info)
-        end
-
-        # @param client_meta_info [String] JSON string containing the meta data for the client
-        # @return [Ingenico::Connect::SDK::Client] a Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
-        # @raise [Ingenico::Connect::SDK::MarshallerSyntaxException] if the given clientMetaInfo is not a valid JSON string
-        def with_client_meta_info(client_meta_info)
-          if @client_meta_info.nil? && client_meta_info.nil?
-            self
-          elsif client_meta_info.nil?
-            return Client.new(@communicator, nil)
-          else
-            # Checking to see if this is valid JSON (no JSON parse exceptions)
-            @communicator.marshaller.unmarshal(client_meta_info, DataObject)
-            client_meta_info = Base64.strict_encode64(client_meta_info)
-            if @client_meta_info == client_meta_info
-              self
-            else
-              return Client.new(@communicator, client_meta_info)
-            end
-          end
-        end
-
-        # Utility method that delegates the call to this client's communicator.
-        def close_idle_connections(idle_time)
-          @communicator.close_idle_connections(idle_time)
-        end
-
-        # Utility method that delegates the call to this client's communicator.
-        def close_expired_connections
-          @communicator.close_expired_connections
-        end
-
-        # Sets the current body obfuscator to use.
-        # @param body_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::BodyObfuscator]
-        def set_body_obfuscator(body_obfuscator)
-          @communicator.set_body_obfuscator(body_obfuscator)
-        end
-
-        # Sets the current header obfuscator to use.
-        # @param header_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::HeaderObfuscator]
-        def set_header_obfuscator(header_obfuscator)
-          @communicator.set_header_obfuscator(header_obfuscator)
-        end
-
-        # Turns on logging using the given communicator logger.
-        # @param communicator_logger [Ingenico::Connect::SDK::Logging::CommunicatorLogger]
-        def enable_logging(communicator_logger)
-          @communicator.enable_logging(communicator_logger)
-        end
-
-        # Turns off logging.
-        def disable_logging
-          @communicator.disable_logging
-        end
-
-        # Releases any system resources associated with this object.
-        def close
-          @communicator.close
-        end
-
-        # Resource /!{merchantId}
-        # @param merchant_id [String]
-        # @return [Ingenico::Connect::SDK::Merchant::MerchantClient]
-        def merchant(merchant_id)
-          Ingenico::Connect::SDK::Merchant::MerchantClient.new(self, {
-            'merchantId'.freeze => merchant_id,
-          })
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Ingenico
-  module Connect
-    module SDK
-      # This exception is used when an error occurs during network communication with the Ingenico ePayments platform.
-      # A common cause is a timeout while connecting or when receiving or sending data.
-      #
-      # @attr [Exception] cause The error that is the cause of this error.
-      class CommunicationException < RuntimeError
-
-        def initialize(cause)
-          super()
-          @cause = cause
-        end
-
-        attr_accessor :cause
-      end
-    end
-  end
-end