genesis_ruby 0.1.6 → 0.1.8

data/lib/genesis_ruby/api/mixins/requests/attribute_validation.rb

@@ -6,13 +6,15 @@ module GenesisRuby
       module Requests
         # Request Class attribute validations
         # Reads the pre-set `validation_<attribute>` and perform validation on the fields
-        module AttributeValidation
+        module AttributeValidation # rubocop:disable Metrics/ModuleLength
 
           protected
 
           # Perform validation
           def validate
-            validate_required_fields
+            validate_required_fields required_fields
+            validate_field_values field_values
+            validate_field_value_dependencies field_value_dependencies
           end
 
           # Required Fields Accessor
@@ -22,15 +24,41 @@ module GenesisRuby
 
           # Required Fields Accessor
           def required_fields=(value)
-            raise RequestError, 'Invalid value given for Required Fields! Allowed type Array.' unless value.is_a? Array
+            raise RequestError, 'Invalid value given for Required Fields! Allowed: Array.' unless value.is_a? Array
 
             @required_fields = value
           end
 
+          # Field Values Accessor
+          def field_values
+            @field_values ||= {}
+          end
+
+          # Field Values Accessor
+          def field_values=(value)
+            raise RequestError, 'Invalid value given for Field Values! Allowed: Hash.' unless value.is_a? Hash
+
+            @field_values = value
+          end
+
+          # Field Value Dependencies Accessor
+          def field_value_dependencies
+            @field_value_dependencies ||= {}
+          end
+
+          # Field Value Dependencies Accessor
+          def field_value_dependencies=(value)
+            unless value.is_a? Hash
+              raise RequestError, 'Invalid value given for Required Field Conditional! Allowed: Hash.'
+            end
+
+            @field_value_dependencies = value
+          end
+
           private
 
           # Validated Required fields
-          def validate_required_fields
+          def validate_required_fields(required_fields)
             required_fields.each do |field_name|
               if null_or_empty_field?(field_name)
                 raise ParameterError, "Empty (nil) for required parameter: #{field_name}"
@@ -38,6 +66,41 @@ module GenesisRuby
             end
           end
 
+          # Validate Required Field Values
+          def validate_field_values(field_values)
+            field_values.each do |field_name, field_value|
+              # Allow optional attributes by bypassing null or empty field values
+              next if null_or_empty_field? field_name
+
+              # Validate against Array set of values
+              next if allowed_array field_name, field_value
+
+              # Validate against a value
+              allowed_value field_name, field_value
+            end
+          end
+
+          # Validate Required Field Conditional
+          # Validates if given field
+          def validate_field_value_dependencies(required_field_conditional) # rubocop:disable Metrics/MethodLength
+            required_field_conditional.each do |field_name, value_dependencies|
+              # Allow optional attributes
+              next if null_or_empty_field? field_name
+
+              unless value_dependencies.is_a?(Hash) || value_dependencies.is_a?(Array)
+                raise RequestError, 'Invalid value given for Required Field Conditional Dependencies! Allowed: Hash.'
+              end
+
+              if value_dependencies.is_a? Array
+                group_field_dependencies field_name, value_dependencies
+
+                next
+              end
+
+              loop_field_value_dependencies field_name, value_dependencies
+            end
+          end
+
           # Validate if the given field_name is null or empty
           def null_or_empty_field?(field_name)
             field_value = __send__ field_name.to_sym
@@ -47,6 +110,77 @@ module GenesisRuby
             field_value.nil? || field_value.empty?
           end
 
+          # Validates Field accessor against allowed values
+          def allowed_array(field_name, allowed_values)
+            return nil unless allowed_values.is_a? Array
+
+            unless allowed_values.include?(__send__(field_name))
+              raise ParameterError, format(
+                'Parameter %{field} is set to %{field_value}, but expected to be one of (%{allowed})',
+                field:       field_name,
+                field_value: __send__(field_name),
+                allowed:     allowed_values.join(', ')
+              )
+            end
+
+            true
+          end
+
+          # Validates Field accessor against allowed value
+          def allowed_value(field_name, allowed_value)
+            return nil if __send__(field_name) == allowed_value
+
+            raise ParameterError, format(
+              'Required parameter %{field_name} is set to %{field_value}, but expected to be %{allowed_value}',
+              field_name:    field_name,
+              field_value:   __send__(field_name),
+              allowed_value: allowed_value
+            )
+          end
+
+          # Validate if given dependencies based on the field value satisfy the request
+          def loop_field_value_dependencies(field_name, value_dependencies)
+            value_dependencies.each do |value_depend, dependencies|
+              next if __send__(field_name).to_s != value_depend.to_s
+
+              group_field_dependencies field_name, dependencies if dependencies.is_a? Array
+              group_field_value_dependencies field_name, dependencies if dependencies.is_a? Hash
+            end
+          end
+
+          # Validates Group field dependencies
+          # Check if all of the given array of attributes are set (not null or empty fields)
+          def group_field_dependencies(field_name, fields)
+            fields.each do |field|
+              next unless null_or_empty_field? field
+
+              raise ParameterError, format(
+                '%{field_name} is depending on: %{field}, which is empty (null)!',
+                field_name: field_name,
+                field:      field
+              )
+            end
+          end
+
+          # Validates Group of attributes against given allowed values
+          def group_field_value_dependencies(field_name, dependencies) # rubocop:disable Metrics/MethodLength
+            dependencies.each do |field_depend, allowed_values|
+              next if null_or_empty_field? field_depend
+
+              next if allowed_values.include? __send__(field_depend)
+
+              raise ParameterError, format(
+                '%{field} with value %{field_value} is depending on: %{field_depend}, which is ' \
+                  'expected to be one of (%{allowed})! Please refer the official documentation for %{trx_type} type.',
+                field:        field_name,
+                field_value:  __send__(field_name),
+                field_depend: field_depend,
+                allowed:      allowed_values.join(', '),
+                trx_type:     self.class.name
+              )
+            end
+          end
+
         end
       end
     end

data/lib/genesis_ruby/api/mixins/requests/birth_date_attributes.rb

@@ -0,0 +1,22 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Birth Date Attributes mixin
+        module BirthDateAttributes
+
+          # Birth Date Accessor
+          def birth_date
+            @birth_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::DD_MM_YYYY_L_HYPHENS
+          end
+
+          # Birth Date Accessor
+          def birth_date=(value)
+            parse_date attribute: __method__, value: value, allow_empty: true
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/customer_address/customer_info_attributes.rb

@@ -13,7 +13,7 @@ module GenesisRuby
 
             # Email of the customer
             def customer_email=(value)
-              raise GenesisRuby::ParameterError unless value =~ /\A.+@.+\..+\Z/
+              raise GenesisRuby::ParameterError unless value.nil? || value =~ /\A.+@.+\..+\Z/
 
               @customer_email = value
             end

data/lib/genesis_ruby/api/mixins/requests/financial/cards/credit_card_attributes.rb

@@ -11,6 +11,13 @@ module GenesisRuby
 
               protected
 
+              # Credit Card Fields validation structure
+              def required_cc_fields_conditional
+                {
+                  card_number: %i[card_holder expiration_month expiration_year]
+                }
+              end
+
               # Credit Card Attributes Structure
               def credit_card_attributes_structure
                 {

data/lib/genesis_ruby/api/mixins/requests/financial/cards/mpi_attributes.rb

@@ -1,4 +1,5 @@
 require 'genesis_ruby/api/constants/transactions/parameters/mpi_protocol_versions'
+require 'genesis_ruby/api/constants/transactions/parameters/mpi_protocol_sub_versions'
 
 module GenesisRuby
   module Api
@@ -9,9 +10,8 @@ module GenesisRuby
             # Mixin Mpi Attributes
             module MpiAttributes
 
-              attr_reader :mpi_threeds_challenge_indicator, :mpi_protocol_version
-              attr_accessor :mpi_cavv, :mpi_eci, :mpi_xid, :mpi_directory_server_id,
-                            :mpi_asc_transaction_id
+              attr_reader :mpi_threeds_challenge_indicator, :mpi_protocol_version, :mpi_protocol_sub_version
+              attr_accessor :mpi_cavv, :mpi_eci, :mpi_xid, :mpi_directory_server_id, :mpi_asc_transaction_id
 
               # The used 3DS protocol version. Default is 1 if not supplied.
               def mpi_protocol_version=(value)
@@ -31,6 +31,15 @@ module GenesisRuby
                 allowed_options attribute: __method__, allowed: allowed_indicators, value: value, allow_empty: true
               end
 
+              # The used 3DSv2 authentication protocol.
+              def mpi_protocol_sub_version=(value)
+                allowed_options attribute:   __method__,
+                                allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::
+                                    MpiProtocolSubVersions.all,
+                                value:       value.to_i,
+                                allow_empty: true
+              end
+
               protected
 
               # Mpi Attributes Structure
@@ -41,7 +50,8 @@ module GenesisRuby
                   protocol_version:            mpi_protocol_version,
                   directory_server_id:         mpi_directory_server_id,
                   acs_transaction_id:          mpi_asc_transaction_id,
-                  threeds_challenge_indicator: mpi_threeds_challenge_indicator
+                  threeds_challenge_indicator: mpi_threeds_challenge_indicator,
+                  protocol_sub_version:        mpi_protocol_sub_version
                 }
               end
 

data/lib/genesis_ruby/api/mixins/requests/financial/cards/recurring/managed_recurring_attributes.rb

@@ -1,3 +1,5 @@
+require 'genesis_ruby/api/constants/transactions/parameters/managed_recurring/modes'
+require 'genesis_ruby/api/constants/transactions/parameters/managed_recurring/intervals'
 require 'genesis_ruby/api/mixins/requests/financial/cards/recurring/managed_recurring_indian_card_attributes'
 
 module GenesisRuby
@@ -13,26 +15,8 @@ module GenesisRuby
 
                 include Recurring::ManagedRecurringIndianCardAttributes
 
-                attr_reader :managed_recurring_mode, :managed_recurring_interval, :managed_recurring_time_of_day,
-                            :managed_recurring_period, :managed_recurring_max_count
-                attr_accessor :managed_recurring_amount
-
-                # This indicates that the gateway will automatically manage the subsequent recurring transactions.
-                def managed_recurring_mode=(value)
-                  allowed_options attribute: __method__,
-                                  allowed:   GenesisRuby::Api::Constants::Transactions::Parameters::ManagedRecurring::
-                                      Modes.all,
-                                  value:     value
-                end
-
-                # The interval type for the period: days or months. The default value is days
-                def managed_recurring_interval=(value)
-                  allowed_options attribute:   __method__,
-                                  allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::ManagedRecurring::
-                                      Intervals.all,
-                                  value:       value,
-                                  allow_empty: true
-                end
+                attr_reader :managed_recurring_time_of_day, :managed_recurring_period, :managed_recurring_max_count
+                attr_accessor :managed_recurring_amount, :managed_recurring_mode, :managed_recurring_interval
 
                 # Specifies the date of the first recurring event in the future
                 # default value is date of creation + period.
@@ -65,6 +49,25 @@ module GenesisRuby
 
                 protected
 
+                # Managed Recurring field values validation structure
+                def managed_recurring_field_values
+                  {
+                    managed_recurring_mode:     Api::Constants::Transactions::Parameters::ManagedRecurring::Modes.all,
+                    managed_recurring_interval: Api::Constants::Transactions::Parameters::ManagedRecurring::Intervals
+                      .all
+                  }.merge managed_recurring_indian_card_field_values
+                end
+
+                # Managed Recurring Field validation structure
+                def required_recurring_managed_type_field_conditional
+                  {
+                    recurring_type: Hash[
+                                      Api::Constants::Transactions::Parameters::Recurring::Types::MANAGED,
+                                      %i[managed_recurring_mode]
+                                    ]
+                  }
+                end
+
                 # Managed Recurring attributes structure
                 def managed_recurring_attributes_structure
                   amount = managed_recurring_amount

data/lib/genesis_ruby/api/mixins/requests/financial/cards/recurring/managed_recurring_indian_card_attributes.rb

@@ -1,3 +1,7 @@
+require 'genesis_ruby/api/constants/transactions/parameters/managed_recurring/payment_types'
+require 'genesis_ruby/api/constants/transactions/parameters/managed_recurring/amount_types'
+require 'genesis_ruby/api/constants/transactions/parameters/managed_recurring/frequencies'
+
 module GenesisRuby
   module Api
     module Mixins
@@ -10,49 +14,25 @@ module GenesisRuby
               # India (RBI) regulations.
               module ManagedRecurringIndianCardAttributes
 
-                attr_reader :managed_recurring_payment_type, :managed_recurring_amount_type,
-                            :managed_recurring_frequency, :managed_recurring_validated
-
-                attr_accessor :managed_recurring_registration_reference_number, :managed_recurring_max_amount
-
-                # Payment Type of the current recurring transaction
-                def managed_recurring_payment_type=(value)
-                  allowed_options attribute:   __method__,
-                                  allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::ManagedRecurring::
-                                    PaymentTypes.all,
-                                  value:       value.to_s,
-                                  allow_empty: true
-                end
-
-                # Amount Type of the current recurring transaction
-                def managed_recurring_amount_type=(value)
-                  allowed_options attribute:   __method__,
-                                  allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::ManagedRecurring::
-                                      AmountTypes.all,
-                                  value:       value.to_s,
-                                  allow_empty: true
-                end
+                attr_accessor :managed_recurring_registration_reference_number, :managed_recurring_max_amount,
+                              :managed_recurring_payment_type, :managed_recurring_amount_type,
+                              :managed_recurring_frequency, :managed_recurring_validated
 
-                # Frequencies of the Frequency of the subsequent transactions
-                def managed_recurring_frequency=(value)
-                  allowed_options attribute:   __method__,
-                                  allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::ManagedRecurring::
-                                    Frequencies.all,
-                                  value:       value.to_s,
-                                  allow_empty: true
-                end
+                protected
 
-                # Indicates if the current transaction is valid as per the registered agreement. Values: true, false
-                def managed_recurring_validated=(value)
-                  allowed_options attribute:     __method__,
-                                  allowed:       [true, false],
-                                  value:         value,
-                                  allow_empty:   true,
-                                  error_message: 'Accepts only boolean values'
+                # Managed Recurring Indian Card field values validation structure
+                def managed_recurring_indian_card_field_values
+                  {
+                    managed_recurring_payment_type: Api::Constants::Transactions::Parameters::ManagedRecurring::
+                        PaymentTypes.all,
+                    managed_recurring_amount_type:  Api::Constants::Transactions::Parameters::ManagedRecurring::
+                        AmountTypes.all,
+                    managed_recurring_frequency:    Api::Constants::Transactions::Parameters::ManagedRecurring::
+                        Frequencies.all,
+                    managed_recurring_validated:    [true, false]
+                  }
                 end
 
-                protected
-
                 # Managed Recurring Indian Card attributes structure
                 def managed_recurring_indian_card_attributes_structure
                   max_amount = managed_recurring_max_amount

data/lib/genesis_ruby/api/mixins/requests/financial/cards/recurring/recurring_type_attributes.rb

@@ -10,18 +10,24 @@ module GenesisRuby
               # Recurring Type Attributes
               module RecurringTypeAttributes
 
-                attr_reader :recurring_type
+                attr_accessor :recurring_type
 
-                # Specifies the recurring type of transaction
-                def recurring_type=(value)
-                  allowed_options attribute:   __method__,
-                                  allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::
-                                      Types.all,
-                                  value:       value,
-                                  allow_empty: true
+                protected
+
+                # Recurring Type for Initial transaction types validation structure
+                def recurring_type_initial_field_values_validation_structure
+                  {
+                    recurring_type: Api::Constants::Transactions::Parameters::Recurring::Types.all -
+                      [Api::Constants::Transactions::Parameters::Recurring::Types::SUBSEQUENT]
+                  }
                 end
 
-                protected
+                # Recurring Type Field Value validation structure
+                def recurring_type_field_values_validation_structure
+                  {
+                    recurring_type: Api::Constants::Transactions::Parameters::Recurring::Types.all
+                  }
+                end
 
                 # Minimum required fields with recurring_type subsequent request
                 def recurring_type_subsequent_required_request_attributes

data/lib/genesis_ruby/api/mixins/requests/financial/cards/tokenization_attributes.rb

@@ -21,6 +21,15 @@ module GenesisRuby
 
               protected
 
+              # Tokenization Attributes validation structure
+              def required_tokenization_fields_conditional
+                {
+                  token:         %i[consumer_id customer_email],
+                  remember_card: { true => %i[customer_email card_number] },
+                  consumer_id:   %i[customer_email]
+                }
+              end
+
               # Tokenization Attributes Structure
               def tokenization_attributes_structure
                 {

data/lib/genesis_ruby/api/mixins/requests/financial/mobile/apple_pay_token_attributes.rb

@@ -0,0 +1,51 @@
+require 'json'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Mobile
+            # Apple Pay Token Attributes mixin
+            module ApplePayTokenAttributes
+
+              attr_accessor :token_version, :token_data, :token_signature,
+                            :token_ephemeral_public_key, :token_public_key_hash, :token_transaction_id,
+                            :token_display_name, :token_network, :token_type, :token_transaction_identifier,
+                            :token_application_data, :token_wrapped_key
+
+              # Apple Pay token structure
+              def payment_token_structure # rubocop:disable Metrics/MethodLength
+                structure = {
+                  paymentData:           {
+                    version:   token_version,
+                    data:      token_data,
+                    signature: token_signature,
+                    header:    {
+                      applicationData:    token_application_data,
+                      ephemeralPublicKey: token_ephemeral_public_key,
+                      wrappedKey:         token_wrapped_key,
+                      publicKeyHash:      token_public_key_hash,
+                      transactionId:      token_transaction_id
+                    }
+                  },
+                  paymentMethod:         {
+                    displayName: token_display_name,
+                    network:     token_network,
+                    type:        token_type
+                  },
+                  transactionIdentifier: token_transaction_identifier
+                }
+
+                GenesisRuby::Utils::Common.deep_compact!(structure)
+
+                structure.to_json
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/mobile/google_pay_token_attributes.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Mobile
+            # Google Pay Token Attributes
+            module GooglePayTokenAttributes
+
+              attr_accessor :token_signature, :token_signed_key, :token_protocol_version, :token_signed_message
+
+              # Google Pay Token Signatures accessor
+              def token_signatures
+                @token_signatures ||= []
+              end
+
+              # Google Pay Token Signatures accessor
+              def token_signatures=(value)
+                if !value.is_a?(Array) && !value.nil?
+                  raise InvalidArgumentError, 'Invalid value given for Token Signatures. Accept array'
+                end
+
+                @token_signatures = value
+              end
+
+              def google_pay_token_structure # rubocop:disable Metrics/MethodLength
+                structure = {
+                  signature:              token_signature,
+                  protocolVersion:        token_protocol_version,
+                  signedMessage:          token_signed_message,
+                  intermediateSigningKey: {
+                    signedKey:  token_signed_key,
+                    signatures: token_signatures
+                  }
+                }
+
+                GenesisRuby::Utils::Common.deep_compact!(structure)
+
+                structure.to_json
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/online_banking_payments/virtual_payment_address_attributes.rb

@@ -0,0 +1,27 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module OnlineBankingPayments
+            # Virtual Payment Address Attributes
+            module VirtualPaymentAddressAttributes
+
+              attr_reader :virtual_payment_address
+
+              # Virtual Payment Address (VPA) of the customer, format: someone@bank
+              def virtual_payment_address=(value)
+                @virtual_payment_address = value.to_s
+
+                return if value.to_s.empty? || value =~ /\A.+@.+\Z/
+
+                raise InvalidArgumentError, 'Virtual Payment Address has invalid format. Correct format: someone@bank'
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/threeds/version2/browser.rb

@@ -11,10 +11,10 @@ module GenesisRuby
               # Mixin ThreedsV2 Browser Attributes
               module Browser
 
-                attr_reader :threeds_v2_browser_accept_header, :threeds_v2_browser_java_enabled,
-                            :threeds_v2_browser_language, :threeds_v2_browser_color_depth,
+                attr_reader :threeds_v2_browser_accept_header, :threeds_v2_browser_language,
                             :threeds_v2_browser_screen_height, :threeds_v2_browser_screen_width,
                             :threeds_v2_browser_time_zone_offset, :threeds_v2_browser_user_agent
+                attr_accessor :threeds_v2_browser_color_depth, :threeds_v2_browser_java_enabled
 
                 # Exact content of the HTTP accept headers as sent to the 3DS Requester from the Cardholder browser
                 def threeds_v2_browser_accept_header=(value)
@@ -26,17 +26,6 @@ module GenesisRuby
                   limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 8
                 end
 
-                # Value representing the bit depth of the colour palette for displaying images, in bits per pixel
-                def threeds_v2_browser_color_depth=(value)
-                  allowed_depths = GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::
-                      Browser::ColorDepths.all
-
-                  allowed_options attribute:   __method__,
-                                  allowed:     allowed_depths,
-                                  value:       value.to_s.empty? ? nil : value.to_i,
-                                  allow_empty: true
-                end
-
                 # Total height of the Cardholder's screen in pixels
                 def threeds_v2_browser_screen_height=(value)
                   parse_int attribute: __method__, value: value, allow_empty: true
@@ -47,15 +36,6 @@ module GenesisRuby
                   parse_int attribute: __method__, value: value, allow_empty: true
                 end
 
-                # Boolean that represents the ability of the cardholder browser to execute Java
-                def threeds_v2_browser_java_enabled=(value)
-                  allowed_options attribute:     __method__,
-                                  allowed:       [true, false],
-                                  value:         value,
-                                  allow_empty:   true,
-                                  error_message: 'Accepts only boolean values'
-                end
-
                 # Time difference between UTC time and the Cardholder browser local time, in minutes
                 def threeds_v2_browser_time_zone_offset=(value)
                   limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 5
@@ -68,6 +48,15 @@ module GenesisRuby
 
                 protected
 
+                # Browser filed validations structure
+                def threeds_browser_field_validations
+                  {
+                    threeds_v2_browser_color_depth:  Api::Constants::Transactions::Parameters::Threeds::Version2::
+                        Browser::ColorDepths.all,
+                    threeds_v2_browser_java_enabled: [true, false]
+                  }
+                end
+
                 # Request Browser Attributes structure
                 def browser_attributes
                   {