onlinepayments-sdk-ruby 4.23.0 → 5.0.0

data/lib/onlinepayments/sdk/communicator_configuration.rb

@@ -1,59 +1,168 @@
-module OnlinePayments::SDK
+require 'onlinepayments/sdk/authentication/authorization_type'
 
-  # A CommunicatorConfiguration stores all data used to initialize an {OnlinePayments::SDK::Communicator}.
-  #
-  # @attr [String] api_endpoint       Base URL to the Online Payments platform
-  # @attr [String] api_key_id         Identifier of the _secret_api_key_ used in authentication.
-  # @attr [String] secret_api_key     Secret key used in authentication
-  # @attr [String] authorization_type String representing the authentication algorithm used
-  class CommunicatorConfiguration < EndpointConfiguration
-
-    # Creates a new CommunicatorConfiguration instance.
-    #
-    # If a _properties_ object is given, it will be parsed like a hash in order to read these attributes.
-    # If a value is given in both the _properties_ hash and as a separate parameter,
-    # the separate parameter will take precedence over the value in the properties.
+module OnlinePayments
+  module SDK
+    # A CommunicatorConfiguration stores all data used to initialize an {OnlinePayments::SDK::Communicator}.
     #
-    # @param properties              [Hash] hash that may contain any of the other parameters.
-    # @param api_endpoint            [String] the base URL to the Online Payments platform.
-    # @param api_key_id              [String] the identifier of the _secret_api_key_ used to authenticate requests.
-    # @param secret_api_key          [String] the key used to authenticate requests sent to the Online Payments platform.
-    # @param authorization_type      [String] string describing the authorization protocol to follow.
-    # @param connect_timeout         [Integer] the number of seconds before a connection attempt with the Online Payments platform times out.
-    # @param socket_timeout          [Integer] the number of seconds before a timeout occurs when transmitting data to or from the Online Payments platform.
-    # @param max_connections         [Integer] the number of connections with the Online Payments platform that are kept alive in the connection pool.
-    #                                These connections will be reused when possible.
-    # @param proxy_configuration     [OnlinePayments::SDK::ProxyConfiguration] stores the URL to a proxy to be used in all communication,
-    #                                or nil if no proxy should be used.
-    # @param integrator              [String] name of the integrator
-    # @param shopping_cart_extension [OnlinePayments::SDK::Domain::ShoppingCartExtension] stores shopping cart-related metadata.
-    # @see EndpointConfiguration#initialize
-    def initialize(properties: nil, api_endpoint: nil, api_key_id: nil,
-                   secret_api_key: nil, authorization_type: nil,
-                   connect_timeout: nil, socket_timeout: nil,
-                   max_connections: nil, proxy_configuration: nil,
-                   integrator: nil, shopping_cart_extension: nil)
-      if properties
-        super(properties, 'onlinePayments.api')
-        @authorization_type = properties['onlinePayments.api.authorizationType'] ?
-                                DefaultImpl::AuthorizationType.get_authorization(properties['onlinePayments.api.authorizationType']) :
-                                DefaultImpl::AuthorizationType::V1HMAC
+    # @attr [String] api_endpoint         Base URL to the Online Payments platform
+    # @attr [String] api_key_id           Identifier of the _secret_api_key_ used in authentication.
+    # @attr [String] secret_api_key       Secret key used in authentication
+    # @attr [String] authorization_type   String representing the authentication algorithm used
+    # @attr [Integer] connect_timeout     The number of seconds before a connection attempt with the Online Payments platform times out.
+    # @attr [Integer] socket_timeout      The number of seconds before a timeout occurs when transmitting data to or from the Online Payments platform.
+    # @attr [Integer] max_connections     The number of connections with the Online Payments platform that are kept alive in the connection pool.
+    #       These connections will be reused when possible.
+    # @attr [OnlinePayments::SDK::ProxyConfiguration] proxy_configuration Proxy settings.
+    # @attr [String] integrator           Name of the integrator
+    # @attr [OnlinePayments::SDK::Domain::ShoppingCartExtension] shopping_cart_extension Shopping cart-related metadata.
+    class CommunicatorConfiguration
+      private
+
+      DEFAULT_MAX_CONNECTIONS = 10
+
+      public
+
+      # The default number of connections that are kept alive in the connection pool.
+      # Used if _maxConnections_ is not present in the properties.
+      # @return [Integer]
+      def self.default_max_connections
+        DEFAULT_MAX_CONNECTIONS
       end
-      @api_endpoint = api_endpoint if api_endpoint
-      @api_key_id = api_key_id if api_key_id
-      @secret_api_key = secret_api_key if secret_api_key
-      @authorization_type = DefaultImpl::AuthorizationType.get_authorization(authorization_type) if authorization_type
-      @connect_timeout = connect_timeout if connect_timeout
-      @socket_timeout = socket_timeout if socket_timeout
-      @max_connections = max_connections if max_connections
-      @proxy_configuration = proxy_configuration if proxy_configuration
-      @integrator = integrator if integrator
-      @shopping_cart_extension = shopping_cart_extension if shopping_cart_extension
-    end
 
-    attr_accessor :api_endpoint
-    attr_accessor :api_key_id
-    attr_accessor :secret_api_key
-    attr_accessor :authorization_type
+      # Creates a new CommunicatorConfiguration instance.
+      #
+      # If a _properties_ object is given, it will be parsed like a hash in order to read these attributes.
+      # If a value is given in both the _properties_ hash and as a separate parameter,
+      # the separate parameter will take precedence over the value in the properties.
+      #
+      # @param properties              [Hash, nil] hash that may contain any of the other parameters.
+      # @param api_endpoint            [String, nil] the base URL to the Online Payments platform.
+      # @param api_key_id              [String, nil] the identifier of the _secret_api_key_ used to authenticate requests.
+      # @param secret_api_key          [String, nil] the key used to authenticate requests sent to the Online Payments platform.
+      # @param authorization_type      [String, nil] string describing the authorization protocol to follow.
+      # @param connect_timeout         [Integer, nil] the number of seconds before a connection attempt with the Online Payments platform times out.
+      # @param socket_timeout          [Integer, nil] the number of seconds before a timeout occurs when transmitting data to or from the Online Payments platform.
+      # @param max_connections         [Integer, nil] the number of connections with the Online Payments platform that are kept alive in the connection pool.
+      #                                These connections will be reused when possible.
+      # @param proxy_configuration     [OnlinePayments::SDK::ProxyConfiguration, nil] stores the URL to a proxy to be used in all communication,
+      #                                or _nil_ if no proxy should be used.
+      # @param integrator              [String, nil] name of the integrator
+      # @param shopping_cart_extension [OnlinePayments::SDK::Domain::ShoppingCartExtension, nil] stores shopping cart-related metadata.
+      def initialize(properties: nil, api_endpoint: nil,
+                     api_key_id: nil, secret_api_key: nil,
+                     authorization_type: nil,
+                     connect_timeout: nil, socket_timeout: nil,
+                     max_connections: nil, proxy_configuration: nil,
+                     integrator: nil, shopping_cart_extension: nil)
+        unless properties.nil?
+          @api_endpoint = get_endpoint(properties)
+          @authorization_type = Authentication::AuthorizationType.get_authorization(properties['onlinePayments.api.authorizationType'])
+          @connect_timeout = properties['onlinePayments.api.connectTimeout']
+          @socket_timeout = properties['onlinePayments.api.socketTimeout']
+          @max_connections = get_property(properties, 'onlinePayments.api.maxConnections', DEFAULT_MAX_CONNECTIONS)
+
+          proxy_uri = properties['onlinePayments.api.proxy.uri']
+          proxy_user = properties['onlinePayments.api.proxy.username']
+          proxy_pass = properties['onlinePayments.api.proxy.password']
+          unless proxy_uri.nil?
+            @proxy_configuration = ProxyConfiguration.new(address: URI(proxy_uri),
+                                                          username: proxy_user,
+                                                          password: proxy_pass)
+          end
+          @integrator = properties['onlinePayments.api.integrator']
+          @shopping_cart_extension = get_shopping_cart_extension(properties)
+        end
+
+        if api_endpoint
+          @api_endpoint = api_endpoint
+        end
+        if api_key_id
+          @api_key_id = api_key_id
+        end
+        if secret_api_key
+          @secret_api_key = secret_api_key
+        end
+        if authorization_type
+          @authorization_type = authorization_type
+        end
+        if connect_timeout
+          @connect_timeout = connect_timeout
+        end
+        if socket_timeout
+          @socket_timeout = socket_timeout
+        end
+        if max_connections
+          @max_connections = max_connections
+        end
+        if proxy_configuration
+          @proxy_configuration = proxy_configuration
+        end
+        if integrator
+          @integrator = integrator
+        end
+        if shopping_cart_extension
+          @shopping_cart_extension = shopping_cart_extension
+        end
+      end
+
+      attr_accessor :api_endpoint
+
+      attr_accessor :api_key_id
+      attr_accessor :secret_api_key
+      attr_accessor :authorization_type
+
+      attr_accessor :connect_timeout
+      attr_accessor :socket_timeout
+      attr_accessor :max_connections
+
+      attr_accessor :proxy_configuration
+
+      attr_accessor :integrator
+      attr_accessor :shopping_cart_extension
+
+      private
+
+      def get_property(properties, key, default_value)
+        property_value = properties[key]
+        if property_value.nil?
+          default_value
+        else
+          property_value
+        end
+      end
+
+      def get_endpoint(properties)
+        host = properties['onlinePayments.api.endpoint.host']
+        scheme = properties['onlinePayments.api.endpoint.scheme']
+        port = properties['onlinePayments.api.endpoint.port']
+        if scheme.nil?
+          scheme = 'https'
+        end
+        if port.nil?
+          port = -1
+        end
+        create_uri(scheme, host, port)
+      end
+
+      def create_uri(scheme, host, port)
+        if port == -1
+          "#{scheme}://#{host}"
+        else
+          "#{scheme}://#{host}:#{port.to_s}"
+        end
+      end
+
+      def get_shopping_cart_extension(properties)
+        creator = properties['onlinePayments.api.shoppingCartExtension.creator']
+        name = properties['onlinePayments.api.shoppingCartExtension.name']
+        version = properties['onlinePayments.api.shoppingCartExtension.version']
+        extension_id = properties['onlinePayments.api.shoppingCartExtension.extensionId']
+        if creator.nil? && name.nil? && version.nil? && extension_id.nil?
+          nil
+        else
+          Domain::ShoppingCartExtension.new(creator, name, version, extension_id)
+        end
+      end
+    end
   end
 end

data/lib/onlinepayments/sdk/declined_payment_exception.rb

@@ -1,29 +1,36 @@
-module OnlinePayments::SDK
+#
+# This file was automatically generated.
+#
+require_relative 'declined_transaction_exception'
 
-  # Indicates that a payment is declined by the Online Payments platform or one of its downstream partners/acquirers.
-  class DeclinedPaymentException < DeclinedTransactionException
+module OnlinePayments
+  module SDK
+    # Represents an error response from a create payment call.
+    class DeclinedPaymentException < DeclinedTransactionException
 
-    # Create a new DeclinedPaymentException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      super(status_code, response_body, errors&.error_id, errors&.errors, build_message(errors))
-      @errors = errors
-    end
+      # Create a new DeclinedPaymentException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, response)
+        super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+        @response = response
+      end
 
-    # The declined payment result returned by the Online Payments platform.
-    # @return [OnlinePayments::SDK::Domain::CreatePaymentResult, nil]
-    def payment_result
-      @errors&.payment_result
-    end
+      # The result of creating a payment
+      # @return [OnlinePayments::SDK::Domain::CreatePaymentResponse, nil]
+      def payment_result
+        @response&.payment_result
+      end
 
-    private
+      private
 
-    def build_message(errors)
-      payment = errors&.payment_result&.payment
-      if payment
-        "declined payment '#{payment.id}' with status '#{payment.status}'"
-      else
-        'the Online Payments platform returned a declined payment response'
+      # @param response [OnlinePayments::SDK::Domain::PaymentErrorResponse, nil]
+      def build_message(response)
+        payment = response&.payment_result&.payment
+        if payment.nil?
+          'the payment platform returned a declined payment response'
+        else
+          "declined payment '#{payment.id}' with status '#{payment.status}'"
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/declined_payout_exception.rb

@@ -1,31 +1,36 @@
-require 'onlinepayments/sdk/declined_transaction_exception'
+#
+# This file was automatically generated.
+#
+require_relative 'declined_transaction_exception'
 
-module OnlinePayments::SDK
+module OnlinePayments
+  module SDK
+    # Represents an error response from a payout call.
+    class DeclinedPayoutException < DeclinedTransactionException
 
-  # Indicates that a payout is declined by the Online Payments platform or one of its downstream partners/acquirers.
-  class DeclinedPayoutException < DeclinedTransactionException
-
-    # Create a new DeclinedPayoutException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      super(status_code, response_body, errors&.error_id, errors&.errors, build_message(errors))
-      @errors = errors
-    end
+      # Create a new DeclinedPayoutException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, response)
+        super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+        @response = response
+      end
 
-    # The declined payout result as returned by the Online Payments platform.
-    # @return [OnlinePayments::SDK::Domain::PayoutResult, nil]
-    def payout_result
-      @errors&.payout_result
-    end
+      # The result of creating a payout
+      # @return [OnlinePayments::SDK::Domain::PayoutResult, nil]
+      def payout_result
+        @response&.payout_result
+      end
 
-    private
+      private
 
-    def build_message(errors)
-      payout = errors&.payout_result
-      if payout
-        "declined payout '#{payout.id}' with status '#{payout.status}'"
-      else
-        'the Online Payments platform returned a declined payout response'
+      # @param response [OnlinePayments::SDK::Domain::PayoutErrorResponse, nil]
+      def build_message(response)
+        payout_result = response&.payout_result
+        if payout_result.nil?
+          'the payment platform returned a declined payout response'
+        else
+          "declined payout '#{payout_result.id}' with status '#{payout_result.status}'"
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/declined_refund_exception.rb

@@ -1,31 +1,36 @@
-require 'onlinepayments/sdk/declined_transaction_exception'
+#
+# This file was automatically generated.
+#
+require_relative 'declined_transaction_exception'
 
-module OnlinePayments::SDK
+module OnlinePayments
+  module SDK
+    # Represents an error response from a refund call.
+    class DeclinedRefundException < DeclinedTransactionException
 
-  # Indicates that a refund is declined by the Online Payments platform or one of its downstream partners/acquirers.
-  class DeclinedRefundException < DeclinedTransactionException
-
-    # Create a new DeclinedRefundException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      super(status_code, response_body, errors&.error_id, errors&.errors, build_message(errors))
-      @errors = errors
-    end
+      # Create a new DeclinedRefundException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, response)
+        super(status_code, response_body, response&.error_id, response&.errors, build_message(response))
+        @response = response
+      end
 
-    # The declined refund result as returned by the Online Payments platform.
-    # @return [OnlinePayments::SDK::Domain::RefundResult, nil]
-    def refund_result
-      @errors&.refund_result
-    end
+      # The result of creating a refund
+      # @return [OnlinePayments::SDK::Domain::RefundResponse, nil]
+      def refund_result
+        @response&.refund_result
+      end
 
-    private
+      private
 
-    def build_message(errors)
-      refund = errors&.refund_result
-      if refund
-        "declined refund '#{refund.id}' with status '#{refund.status}'"
-      else
-        'the Online Payments platform returned a declined refund response'
+      # @param response [OnlinePayments::SDK::Domain::RefundErrorResponse, nil]
+      def build_message(response)
+        refund_result = response&.refund_result
+        if refund_result.nil?
+          'the payment platform returned a declined refund response'
+        else
+          "declined refund '#{refund_result.id}' with status '#{refund_result.status}'"
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/declined_transaction_exception.rb

@@ -1,15 +1,21 @@
-module OnlinePayments::SDK
+#
+# This file was automatically generated.
+#
+require_relative 'api_exception'
 
-  # Indicates that a transaction is declined by the Online Payments platform or one of its downstream partners/acquirers.
-  class DeclinedTransactionException < ApiException
+module OnlinePayments
+  module SDK
+    # Represents an error response from a create payment, payout or refund call.
+    class DeclinedTransactionException < ApiException
 
-    # Create a new DeclinedTransactionException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors, message = nil)
-      if message
-        super(status_code, response_body, error_id, errors, message)
-      else
-        super(status_code, response_body, error_id, errors)
+      # Create a new DeclinedTransactionException.
+      # @see ApiException#initialize
+      def initialize(status_code, response_body, error_id, errors, message = nil)
+        if message
+          super(status_code, response_body, error_id, errors, message)
+        else
+          super(status_code, response_body, error_id, errors)
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/domain/account_on_file.rb

@@ -1,48 +1,57 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-require 'onlinepayments/sdk/data_object'
 require 'onlinepayments/sdk/domain/account_on_file_attribute'
 require 'onlinepayments/sdk/domain/account_on_file_display_hints'
+require 'onlinepayments/sdk/domain/data_object'
 
-module OnlinePayments::SDK
-  module Domain
+module OnlinePayments
+  module SDK
+    module Domain
+      # @attr [Array<OnlinePayments::SDK::Domain::AccountOnFileAttribute>] attributes
+      # @attr [OnlinePayments::SDK::Domain::AccountOnFileDisplayHints] display_hints
+      # @attr [Integer] id
+      # @attr [Integer] payment_product_id
+      class AccountOnFile < OnlinePayments::SDK::Domain::DataObject
 
-    # @attr [Array<OnlinePayments::SDK::Domain::AccountOnFileAttribute>] attributes
-    # @attr [OnlinePayments::SDK::Domain::AccountOnFileDisplayHints] display_hints
-    # @attr [Integer] id
-    # @attr [Integer] payment_product_id
-    class AccountOnFile < OnlinePayments::SDK::DataObject
-      attr_accessor :attributes
-      attr_accessor :display_hints
-      attr_accessor :id
-      attr_accessor :payment_product_id
+        attr_accessor :attributes
 
-      # @return (Hash)
-      def to_h
-        hash = super
-        hash['attributes'] = @attributes.collect(&:to_h) if @attributes
-        hash['displayHints'] = @display_hints.to_h if @display_hints
-        hash['id'] = @id unless @id.nil?
-        hash['paymentProductId'] = @payment_product_id unless @payment_product_id.nil?
-        hash
-      end
+        attr_accessor :display_hints
 
-      def from_hash(hash)
-        super
-        if hash.key? 'attributes'
-          raise TypeError, "value '%s' is not an Array" % [hash['attributes']] unless hash['attributes'].is_a? Array
-          @attributes = []
-          hash['attributes'].each do |e|
-            @attributes << OnlinePayments::SDK::Domain::AccountOnFileAttribute.new_from_hash(e)
-          end
+        attr_accessor :id
+
+        attr_accessor :payment_product_id
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['attributes'] = @attributes.collect{|val| val.to_h} unless @attributes.nil?
+          hash['displayHints'] = @display_hints.to_h unless @display_hints.nil?
+          hash['id'] = @id unless @id.nil?
+          hash['paymentProductId'] = @payment_product_id unless @payment_product_id.nil?
+          hash
         end
-        if hash.key? 'displayHints'
-          raise TypeError, "value '%s' is not a Hash" % [hash['displayHints']] unless hash['displayHints'].is_a? Hash
-          @display_hints = OnlinePayments::SDK::Domain::AccountOnFileDisplayHints.new_from_hash(hash['displayHints'])
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'attributes'
+            raise TypeError, "value '%s' is not an Array" % [hash['attributes']] unless hash['attributes'].is_a? Array
+            @attributes = []
+            hash['attributes'].each do |e|
+              @attributes << OnlinePayments::SDK::Domain::AccountOnFileAttribute.new_from_hash(e)
+            end
+          end
+          if hash.has_key? 'displayHints'
+            raise TypeError, "value '%s' is not a Hash" % [hash['displayHints']] unless hash['displayHints'].is_a? Hash
+            @display_hints = OnlinePayments::SDK::Domain::AccountOnFileDisplayHints.new_from_hash(hash['displayHints'])
+          end
+          if hash.has_key? 'id'
+            @id = hash['id']
+          end
+          if hash.has_key? 'paymentProductId'
+            @payment_product_id = hash['paymentProductId']
+          end
         end
-        @id = hash['id'] if hash.key? 'id'
-        @payment_product_id = hash['paymentProductId'] if hash.key? 'paymentProductId'
       end
     end
   end

data/lib/onlinepayments/sdk/domain/account_on_file_attribute.rb

@@ -1,37 +1,51 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-require 'onlinepayments/sdk/data_object'
+require 'onlinepayments/sdk/domain/data_object'
 
-module OnlinePayments::SDK
-  module Domain
+module OnlinePayments
+  module SDK
+    module Domain
+      # @attr [String] key
+      # @attr [String] must_write_reason
+      # @attr [String] status
+      # @attr [String] value
+      class AccountOnFileAttribute < OnlinePayments::SDK::Domain::DataObject
 
-    # @attr [String] key
-    # @attr [String] must_write_reason
-    # @attr [String] status
-    # @attr [String] value
-    class AccountOnFileAttribute < OnlinePayments::SDK::DataObject
-      attr_accessor :key
-      attr_accessor :must_write_reason
-      attr_accessor :status
-      attr_accessor :value
+        attr_accessor :key
 
-      # @return (Hash)
-      def to_h
-        hash = super
-        hash['key'] = @key unless @key.nil?
-        hash['mustWriteReason'] = @must_write_reason unless @must_write_reason.nil?
-        hash['status'] = @status unless @status.nil?
-        hash['value'] = @value unless @value.nil?
-        hash
-      end
+        # @deprecated Deprecated
+        attr_accessor :must_write_reason
+
+        attr_accessor :status
+
+        attr_accessor :value
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['key'] = @key unless @key.nil?
+          hash['mustWriteReason'] = @must_write_reason unless @must_write_reason.nil?
+          hash['status'] = @status unless @status.nil?
+          hash['value'] = @value unless @value.nil?
+          hash
+        end
 
-      def from_hash(hash)
-        super
-        @key = hash['key'] if hash.key? 'key'
-        @must_write_reason = hash['mustWriteReason'] if hash.key? 'mustWriteReason'
-        @status = hash['status'] if hash.key? 'status'
-        @value = hash['value'] if hash.key? 'value'
+        def from_hash(hash)
+          super
+          if hash.has_key? 'key'
+            @key = hash['key']
+          end
+          if hash.has_key? 'mustWriteReason'
+            @must_write_reason = hash['mustWriteReason']
+          end
+          if hash.has_key? 'status'
+            @status = hash['status']
+          end
+          if hash.has_key? 'value'
+            @value = hash['value']
+          end
+        end
       end
     end
   end