direct-sdk-ruby 1.0.0

data/lib/ingenico/direct/sdk/domain/three_d_secure_base.rb

@@ -0,0 +1,47 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/three_d_secure_data'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [String] challenge_canvas_size
+    # @attr [String] challenge_indicator
+    # @attr [String] exemption_request
+    # @attr [Ingenico::Direct::SDK::Domain::ThreeDSecureData] prior_three_d_secure_data
+    # @attr [true/false] skip_authentication
+    class ThreeDSecureBase < Ingenico::Direct::SDK::DataObject
+      attr_accessor :challenge_canvas_size
+      attr_accessor :challenge_indicator
+      attr_accessor :exemption_request
+      attr_accessor :prior_three_d_secure_data
+      attr_accessor :skip_authentication
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['challengeCanvasSize'] = @challenge_canvas_size unless @challenge_canvas_size.nil?
+        hash['challengeIndicator'] = @challenge_indicator unless @challenge_indicator.nil?
+        hash['exemptionRequest'] = @exemption_request unless @exemption_request.nil?
+        hash['priorThreeDSecureData'] = @prior_three_d_secure_data.to_h if @prior_three_d_secure_data
+        hash['skipAuthentication'] = @skip_authentication unless @skip_authentication.nil?
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        @challenge_canvas_size = hash['challengeCanvasSize'] if hash.key? 'challengeCanvasSize'
+        @challenge_indicator = hash['challengeIndicator'] if hash.key? 'challengeIndicator'
+        @exemption_request = hash['exemptionRequest'] if hash.key? 'exemptionRequest'
+        if hash.key? 'priorThreeDSecureData'
+          raise TypeError, "value '%s' is not a Hash" % [hash['priorThreeDSecureData']] unless hash['priorThreeDSecureData'].is_a? Hash
+          @prior_three_d_secure_data = Ingenico::Direct::SDK::Domain::ThreeDSecureData.new_from_hash(hash['priorThreeDSecureData'])
+        end
+        @skip_authentication = hash['skipAuthentication'] if hash.key? 'skipAuthentication'
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/three_d_secure_data.rb

@@ -0,0 +1,35 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [String] acs_transaction_id
+    # @attr [String] method
+    # @attr [String] utc_timestamp
+    class ThreeDSecureData < Ingenico::Direct::SDK::DataObject
+      attr_accessor :acs_transaction_id
+      attr_accessor :method
+      attr_accessor :utc_timestamp
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['acsTransactionId'] = @acs_transaction_id unless @acs_transaction_id.nil?
+        hash['method'] = @method unless @method.nil?
+        hash['utcTimestamp'] = @utc_timestamp unless @utc_timestamp.nil?
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        @acs_transaction_id = hash['acsTransactionId'] if hash.key? 'acsTransactionId'
+        @method = hash['method'] if hash.key? 'method'
+        @utc_timestamp = hash['utcTimestamp'] if hash.key? 'utcTimestamp'
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/three_d_secure_results.rb

@@ -0,0 +1,31 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [String] eci
+    # @attr [String] xid
+    class ThreeDSecureResults < Ingenico::Direct::SDK::DataObject
+      attr_accessor :eci
+      attr_accessor :xid
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['eci'] = @eci unless @eci.nil?
+        hash['xid'] = @xid unless @xid.nil?
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        @eci = hash['eci'] if hash.key? 'eci'
+        @xid = hash['xid'] if hash.key? 'xid'
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_card.rb

@@ -0,0 +1,35 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/token_card_data'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [String] alias
+    # @attr [Ingenico::Direct::SDK::Domain::TokenCardData] data
+    class TokenCard < Ingenico::Direct::SDK::DataObject
+      attr_accessor :alias
+      attr_accessor :data
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['alias'] = @alias unless @alias.nil?
+        hash['data'] = @data.to_h if @data
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        @alias = hash['alias'] if hash.key? 'alias'
+        if hash.key? 'data'
+          raise TypeError, "value '%s' is not a Hash" % [hash['data']] unless hash['data'].is_a? Hash
+          @data = Ingenico::Direct::SDK::Domain::TokenCardData.new_from_hash(hash['data'])
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_card_data.rb

@@ -0,0 +1,31 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/card_without_cvv'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [Ingenico::Direct::SDK::Domain::CardWithoutCvv] card_without_cvv
+    class TokenCardData < Ingenico::Direct::SDK::DataObject
+      attr_accessor :card_without_cvv
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['cardWithoutCvv'] = @card_without_cvv.to_h if @card_without_cvv
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        if hash.key? 'cardWithoutCvv'
+          raise TypeError, "value '%s' is not a Hash" % [hash['cardWithoutCvv']] unless hash['cardWithoutCvv'].is_a? Hash
+          @card_without_cvv = Ingenico::Direct::SDK::Domain::CardWithoutCvv.new_from_hash(hash['cardWithoutCvv'])
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_card_specific_input.rb

@@ -0,0 +1,31 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/token_data'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [Ingenico::Direct::SDK::Domain::TokenData] data
+    class TokenCardSpecificInput < Ingenico::Direct::SDK::DataObject
+      attr_accessor :data
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['data'] = @data.to_h if @data
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        if hash.key? 'data'
+          raise TypeError, "value '%s' is not a Hash" % [hash['data']] unless hash['data'].is_a? Hash
+          @data = Ingenico::Direct::SDK::Domain::TokenData.new_from_hash(hash['data'])
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_data.rb

@@ -0,0 +1,31 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/card'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [Ingenico::Direct::SDK::Domain::Card] card
+    class TokenData < Ingenico::Direct::SDK::DataObject
+      attr_accessor :card
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['card'] = @card.to_h if @card
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        if hash.key? 'card'
+          raise TypeError, "value '%s' is not a Hash" % [hash['card']] unless hash['card'].is_a? Hash
+          @card = Ingenico::Direct::SDK::Domain::Card.new_from_hash(hash['card'])
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_e_wallet.rb

@@ -0,0 +1,35 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/customer_token'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [String] alias
+    # @attr [Ingenico::Direct::SDK::Domain::CustomerToken] customer
+    class TokenEWallet < Ingenico::Direct::SDK::DataObject
+      attr_accessor :alias
+      attr_accessor :customer
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['alias'] = @alias unless @alias.nil?
+        hash['customer'] = @customer.to_h if @customer
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        @alias = hash['alias'] if hash.key? 'alias'
+        if hash.key? 'customer'
+          raise TypeError, "value '%s' is not a Hash" % [hash['customer']] unless hash['customer'].is_a? Hash
+          @customer = Ingenico::Direct::SDK::Domain::CustomerToken.new_from_hash(hash['customer'])
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/token_response.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/data_object'
+require 'ingenico/direct/sdk/domain/external_token_linked'
+require 'ingenico/direct/sdk/domain/token_card'
+require 'ingenico/direct/sdk/domain/token_e_wallet'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [Ingenico::Direct::SDK::Domain::TokenCard] card
+    # @attr [Ingenico::Direct::SDK::Domain::TokenEWallet] e_wallet
+    # @attr [Ingenico::Direct::SDK::Domain::ExternalTokenLinked] external_token_linked
+    # @attr [String] id
+    # @attr [Integer] payment_product_id
+    class TokenResponse < Ingenico::Direct::SDK::DataObject
+      attr_accessor :card
+      attr_accessor :e_wallet
+      attr_accessor :external_token_linked
+      attr_accessor :id
+      attr_accessor :payment_product_id
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['card'] = @card.to_h if @card
+        hash['eWallet'] = @e_wallet.to_h if @e_wallet
+        hash['externalTokenLinked'] = @external_token_linked.to_h if @external_token_linked
+        hash['id'] = @id unless @id.nil?
+        hash['paymentProductId'] = @payment_product_id unless @payment_product_id.nil?
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        if hash.key? 'card'
+          raise TypeError, "value '%s' is not a Hash" % [hash['card']] unless hash['card'].is_a? Hash
+          @card = Ingenico::Direct::SDK::Domain::TokenCard.new_from_hash(hash['card'])
+        end
+        if hash.key? 'eWallet'
+          raise TypeError, "value '%s' is not a Hash" % [hash['eWallet']] unless hash['eWallet'].is_a? Hash
+          @e_wallet = Ingenico::Direct::SDK::Domain::TokenEWallet.new_from_hash(hash['eWallet'])
+        end
+        if hash.key? 'externalTokenLinked'
+          raise TypeError, "value '%s' is not a Hash" % [hash['externalTokenLinked']] unless hash['externalTokenLinked'].is_a? Hash
+          @external_token_linked = Ingenico::Direct::SDK::Domain::ExternalTokenLinked.new_from_hash(hash['externalTokenLinked'])
+        end
+        @id = hash['id'] if hash.key? 'id'
+        @payment_product_id = hash['paymentProductId'] if hash.key? 'paymentProductId'
+      end
+    end
+  end
+end

data/lib/ingenico/direct/sdk/domain/value_mapping_element.rb

@@ -0,0 +1,38 @@
+#
+# This class was auto-generated from the API references found at
+# https://support.direct.ingenico.com/documentation/api/reference/
+#
+require 'ingenico/direct/sdk/data_object'
+require 'ingenico/direct/sdk/domain/payment_product_field_display_element'
+
+module Ingenico::Direct::SDK
+  module Domain
+
+    # @attr [Array<Ingenico::Direct::SDK::Domain::PaymentProductFieldDisplayElement>] display_elements
+    # @attr [String] value
+    class ValueMappingElement < Ingenico::Direct::SDK::DataObject
+      attr_accessor :display_elements
+      attr_accessor :value
+
+      # @return (Hash)
+      def to_h
+        hash = super
+        hash['displayElements'] = @display_elements.collect(&:to_h) if @display_elements
+        hash['value'] = @value unless @value.nil?
+        hash
+      end
+
+      def from_hash(hash)
+        super
+        if hash.key? 'displayElements'
+          raise TypeError, "value '%s' is not an Array" % [hash['displayElements']] unless hash['displayElements'].is_a? Array
+          @display_elements = []
+          hash['displayElements'].each do |e|
+            @display_elements << Ingenico::Direct::SDK::Domain::PaymentProductFieldDisplayElement.new_from_hash(e)
+          end
+        end
+        @value = hash['value'] if hash.key? 'value'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+require 'uri'
+
+module Ingenico::Direct::SDK
+
+  # Base class for configuration classes in the SDK.
+  #
+  # @attr [String] api_endpoint     The base URL to the Ingenico ePayments platform.
+  # @attr [Integer] connect_timeout The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
+  # @attr [Integer] socket_timeout  The number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.
+  # @attr [Integer] max_connections The number of connections with the Ingenico ePayments platform that are kept alive in the connection pool.
+  #       These connections will be reused when possible.
+  # @attr [Ingenico::Direct::SDK::ProxyConfiguration] proxy_configuration Proxy settings.
+  # @attr [String] integrator       Name of the integrator
+  # @attr [Ingenico::Direct::SDK::Domain::ShoppingCartExtension] shopping_cart_extension Shopping cart-related metadata.
+  class EndpointConfiguration
+    DEFAULT_CONNECT_TIMEOUT = 10
+    DEFAULT_SOCKET_TIMEOUT = 10
+    DEFAULT_MAX_CONNECTIONS = 10
+
+    # The default number of seconds before a connection attempt with the Ingenico ePayments platform times out.
+    # Used if _connectTimeout_ is not present in the properties.
+    def self.default_connect_timeout
+      DEFAULT_CONNECT_TIMEOUT
+    end
+
+    # The default number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.
+    # Used if _socketTimeout_ is not present in the properties.
+    def self.default_socket_timeout
+      DEFAULT_SOCKET_TIMEOUT
+    end
+
+    # The default number of connections that are kept alive in the connection pool.
+    # Used if _maxConnections_ is not present in the properties.
+    def self.default_max_connections
+      DEFAULT_MAX_CONNECTIONS
+    end
+
+    # Initializes a new EndpointConfiguration.
+    #
+    # The given _properties_ is searched for settings using properties[prefix + '.setting_name']
+    # The following settings are searched:
+    #
+    # endpoint::                This property is searched for *endpoint.host*, *endpoint.scheme* and *endpoint.port*.
+    #                           The found host, scheme and port are used to construct the base URL to the Ingenico ePayments platform.
+    # connectTimeout::          The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
+    # socketTimeout::           The number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.
+    # maxConnections::          The number of connections with the Ingenico ePayments platform
+    #                           that are kept alive in the connection pool. These connections will be reused when possible.
+    # proxy::                   This property is searched for *proxy.uri*, *proxy.username* and *proxy.password*.
+    #                           The found URI, username and password are used
+    #                           for connecting to the Ingenico ePayments platform using a proxy.
+    # integrator::              Name of the integrator
+    # shoppingCartExtension::   Will be used to initialize a {Ingenico::Direct::SDK::Domain::ShoppingCartExtension}.
+    def initialize(properties = nil, prefix = nil)
+      return unless properties
+
+      @api_endpoint = get_endpoint(properties, prefix)
+      @connect_timeout = get_property(properties, "#{prefix}.connectTimeout", DEFAULT_CONNECT_TIMEOUT)
+      @socket_timeout = get_property(properties, "#{prefix}.socketTimeout", DEFAULT_SOCKET_TIMEOUT)
+      @max_connections = get_property(properties, "#{prefix}.maxConnections", DEFAULT_MAX_CONNECTIONS)
+
+      proxy_uri = properties["#{prefix}.proxy.uri"]
+      if proxy_uri
+        proxy_user = properties["#{prefix}.proxy.username"]
+        proxy_pass = properties["#{prefix}.proxy.password"]
+        @proxy_configuration = ProxyConfiguration.new(address: URI(proxy_uri),
+                                                      username: proxy_user,
+                                                      password: proxy_pass)
+      end
+      @integrator = properties["#{prefix}.integrator"]
+      @shopping_cart_extension = get_shopping_cart_extension(properties, prefix)
+    end
+
+    protected
+
+    def set_endpoint(endpoint)
+      if endpoint
+        raise ArgumentError, 'endpoint should not contain a path' if endpoint.path
+        if endpoint.userinfo || endpoint.query || endpoint.fragment
+          raise ArgumentError('endpoint should not contain user info, query or fragment')
+        end
+      end
+      @api_endpoint = endpoint
+    end
+
+    private
+
+    def get_property(properties, key, default_value)
+      property_value = properties[key]
+      property_value.nil? ? default_value : property_value
+    end
+
+    def get_endpoint(properties, prefix)
+      host = properties["#{prefix}.endpoint.host"]
+      scheme = properties["#{prefix}.endpoint.scheme"] || 'https'
+      port = properties["#{prefix}.endpoint.port"] || -1
+      create_uri(scheme, host, port)
+    end
+
+    def create_uri(scheme, host, port)
+      port == -1 ? "#{scheme}://#{host}" : "#{scheme}://#{host}:#{port}"
+    end
+
+    def get_shopping_cart_extension(properties, prefix)
+      creator = properties["#{prefix}.shoppingCartExtension.creator"]
+      name = properties["#{prefix}.shoppingCartExtension.name"]
+      version = properties["#{prefix}.shoppingCartExtension.version"]
+      extension_id = properties["#{prefix}.shoppingCartExtension.extensionId"]
+      (creator || name || version || extension_id) ?
+          Domain::ShoppingCartExtension.new(creator, name, version, extension_id) :
+          nil
+    end
+
+    public
+
+    attr_reader :api_endpoint
+
+    attr_accessor :connect_timeout
+    attr_accessor :socket_timeout
+    attr_accessor :max_connections
+
+    attr_accessor :proxy_configuration
+
+    attr_accessor :integrator
+    attr_accessor :shopping_cart_extension
+  end
+end