genesis_ruby 0.2.3 → 0.2.5

data/lib/genesis_ruby/api/requests/non_financial/fx/get_rates.rb

@@ -0,0 +1,53 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fx
+          # This call is used to return all rates for Tier
+          class GetRates < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Fx::TierIdAttributes
+
+            # Get Rates initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'fx/tiers/:tier_id/rates'
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_get_configuration
+            end
+
+            # Fetch request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tier_id_required_fields
+            end
+
+            # Get Rates request structure
+            def request_structure
+              {}
+            end
+
+            # Override API endpoint with provided ID
+            def process_request_parameters
+              super
+
+              request_path.sub!(':tier_id', tier_id)
+
+              init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fx/get_tier.rb

@@ -0,0 +1,53 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fx
+          # This call is used to return information about selected Tier for your merchant
+          class GetTier < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Fx::IdAttributes
+
+            # Get Tier initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'fx/tiers/:id'
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_get_configuration
+            end
+
+            # Fetch request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *id_required_fields
+            end
+
+            # Get Tier request structure
+            def request_structure
+              {}
+            end
+
+            # Override API endpoint with provided ID
+            def process_request_parameters
+              super
+
+              request_path.sub!(':id', id)
+
+              init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fx/get_tiers.rb

@@ -0,0 +1,35 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fx
+          # This call is used to return all Tiers that are related to your account
+          class GetTiers < Base::Versioned
+
+            # Get Tiers initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'fx/tiers'
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_get_configuration
+            end
+
+            # Get Tiers request structure
+            def request_structure
+              {}
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fx/search_rate.rb

@@ -0,0 +1,61 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fx
+          # This call is used to return information about selected Rate by currency pair
+          class SearchRate < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Fx::TierIdAttributes
+
+            attr_writer :source_currency, :target_currency
+
+            # Search Rate initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'fx/tiers/:tier_id/rates/search'
+            end
+
+            # Source currency
+            def source_currency
+              @source_currency.to_s.upcase
+            end
+
+            # Target currency
+            def target_currency
+              @target_currency.to_s.upcase
+            end
+
+            protected
+
+            # Fetch request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tier_id_required_fields, *%i[source_currency target_currency]
+            end
+
+            # Search Rate request structure
+            def request_structure
+              {
+                source_currency: source_currency,
+                target_currency: target_currency
+              }
+            end
+
+            # Override API endpoint with provided ID
+            def process_request_parameters
+              super
+
+              request_path.sub!(':tier_id', tier_id)
+
+              init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/consumer_registration/create.rb

@@ -0,0 +1,99 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module ConsumerRegistration
+            # Create Consumer Registration Request class for KYC Non-Financial API services
+            class Create < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::NonFinancial::Kyc::CustomerInformationAttributes
+
+              attr_accessor :session_id, :customer_unique_id, :transaction_unique_id, :customer_phone_number,
+                            :service_language, :security_code, :service_type, :customer_username,
+                            :customer_registration_date, :customer_registration_ip_address,
+                            :customer_registration_device_id, :third_party_device_id, :device_fingerprint,
+                            :bonus_code, :bonus_submission_date, :bonus_amount, :merchant_website,
+                            :how_did_you_hear, :affiliate_id, :rule_context
+              attr_writer   :profile_action_type, :device_fingerprint_type, :profile_current_status, :industry_type
+
+              # Initializes the Create Consumer Registration Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'create_consumer'
+              end
+
+              # Returns device_fingerprint_type as an integer
+              def device_fingerprint_type
+                @device_fingerprint_type&.to_i
+              end
+
+              # Returns profile_action_type as an integer
+              def profile_action_type
+                @profile_action_type&.to_i
+              end
+
+              # Returns profile_current_status as an integer
+              def profile_current_status
+                @profile_current_status&.to_i
+              end
+
+              # Returns industry_type as an integer
+              def industry_type
+                @industry_type&.to_i
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations # rubocop:disable Metrics/MethodLength
+                super
+
+                required_fields.push *%i[
+                  customer_information_structure
+                  customer_unique_id
+                  customer_registration_date
+                  customer_registration_ip_address
+                ] + customer_information_required_fields
+
+                field_values.merge! device_fingerprint_type: [1, 2, 3],
+                                    profile_action_type:     [1, 2],
+                                    profile_current_status:  [0, 1, 2, 3],
+                                    industry_type:           [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+                field_values.merge! customer_information_required_field_values
+              end
+
+              # Defines the request structure
+              def request_structure # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+                {
+                  session_id:                       session_id,
+                  customer_username:                customer_username,
+                  customer_unique_id:               customer_unique_id,
+                  customer_registration_date:       customer_registration_date,
+                  customer_registration_ip_address: customer_registration_ip_address,
+                  customer_registration_device_id:  customer_registration_device_id,
+                  customer_information:             customer_information_structure,
+                  third_party_device_id:            third_party_device_id,
+                  device_fingerprint:               device_fingerprint,
+                  device_fingerprint_type:          device_fingerprint_type,
+                  profile_action_type:              profile_action_type,
+                  profile_current_status:           profile_current_status,
+                  bonus_code:                       bonus_code,
+                  bonus_submission_date:            bonus_submission_date,
+                  bonus_amount:                     bonus_amount,
+                  merchant_website:                 merchant_website,
+                  industry_type:                    industry_type,
+                  how_did_you_hear:                 how_did_you_hear,
+                  affiliate_id:                     affiliate_id,
+                  rule_context:                     rule_context
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/date_range.rb

@@ -0,0 +1,68 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Date range based processed transaction retrieval allows you to fetch information for
+          # all processed transactions for a given merchant within a given date range.
+          class DateRange < Request
+
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
+            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+            attr_accessor :externally_processed, :processing_type
+
+            # Start of the requested date range
+            def start_date
+              @start_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            # End of the requested date range
+            def end_date
+              @end_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            protected
+
+            # Processed Transactions API DateRange request configuration
+            def init_configuration
+              init_xml_configuration
+              @api_config.parser_skip_root_node = false
+
+              init_api_gateway_configuration request_path: 'processed_transactions/by_date', include_token: false
+            end
+
+            # Processed Transactions API DateRange field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[start_date]
+              field_values.merge! externally_processed: Constants::Transactions::Parameters::NonFinancial::
+                                      ExternallyProcessed.all,
+                                  processing_type:      Constants::Transactions::Parameters::NonFinancial::
+                                      ProcessingType.all
+            end
+
+            # Processed Transactions API DateRange request structure
+            def populate_structure
+              @tree_structure = {
+                processed_transaction_request: {
+                  start_date:           start_date,
+                  end_date:             end_date,
+                  externally_processed: externally_processed,
+                  processing_type:      processing_type,
+                  page:                 page,
+                  per_page:             per_page
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/post_date_range.rb

@@ -0,0 +1,72 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Post Date range based processed transaction retrieval allows you to fetch information for
+          # all processed transactions for a given merchant within a given post date range.
+          class PostDateRange < Request
+
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
+            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+            attr_accessor :batch_number, :batch_slip_number, :deposit_slip_number, :externally_processed,
+                          :processing_type
+
+            # Start of the requested date range
+            def start_date
+              @start_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            # End of the requested date range
+            def end_date
+              @end_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            protected
+
+            # Processed Transactions API DateRange request configuration
+            def init_configuration
+              init_xml_configuration
+              @api_config.parser_skip_root_node = false
+
+              init_api_gateway_configuration request_path: 'processed_transactions/by_post_date', include_token: false
+            end
+
+            # Processed Transactions API DateRange field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[start_date]
+              field_values.merge! externally_processed: Constants::Transactions::Parameters::NonFinancial::
+                                      ExternallyProcessed.all,
+                                  processing_type:      Constants::Transactions::Parameters::NonFinancial::
+                                      ProcessingType.all
+            end
+
+            # Processed Transactions API DateRange request structure
+            def populate_structure # rubocop:disable Metrics/MethodLength
+              @tree_structure = {
+                processed_transaction_request: {
+                  start_date:           start_date,
+                  end_date:             end_date,
+                  batch_number:         batch_number,
+                  batch_slip_number:    batch_slip_number,
+                  deposit_slip_number:  deposit_slip_number,
+                  externally_processed: externally_processed,
+                  processing_type:      processing_type,
+                  page:                 page,
+                  per_page:             per_page
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/transaction.rb

@@ -0,0 +1,48 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Single processed transaction retrieval allows to get a certain processed transaction by
+          # its ARN or by passing its unique ID.
+          class Transaction < Request
+
+            attr_accessor :arn, :unique_id
+
+            protected
+
+            # Processed Transactions API Transaction request configuration
+            def init_configuration
+              init_xml_configuration
+
+              init_api_gateway_configuration request_path: 'processed_transactions', include_token: false
+            end
+
+            # Processed Transactions API Transaction custom validations
+            def check_requirements
+              unless arn.nil? ^ unique_id.nil?
+                raise(
+                  ParameterError,
+                  'Either ARN or unique ID field has to be set, not both'
+                )
+              end
+
+              super
+            end
+
+            # Processed Transactions API Transaction request structure
+            def populate_structure
+              @tree_structure = {
+                processed_transaction_request: {
+                  arn:       arn,
+                  unique_id: unique_id
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/sca/checker.rb

@@ -0,0 +1,77 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/sca_exemptions'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Sca
+          # SCA Checker call is used for the determination whether SCA is required
+          class Checker < Base::Versioned
+
+            include Api::Mixins::Requests::Financial::MotoAttributes
+
+            attr_reader :mit, :card_number
+            attr_accessor :transaction_amount, :transaction_currency, :recurring_type, :transaction_exemption
+
+            # SCA Checker constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = "sca/checker/#{configuration.token}"
+            end
+
+            # Full card number or first 6 digits
+            def card_number=(value)
+              unless value.nil? || value.to_s =~ /\A\d{6,16}\Z/
+                raise(
+                  InvalidArgumentError,
+                  'Invalid value for card_number. Allowed only digits with min length 6 and max length 16'
+                )
+              end
+
+              @card_number = value.to_s
+            end
+
+            # Signifies whether a MIT (merchant initiated transaction) is performed
+            def mit=(value)
+              allowed_options attribute:     __method__,
+                              value:         value,
+                              allowed:       [true, false],
+                              allow_empty:   true,
+                              error_message: 'Accepts only boolean values'
+            end
+
+            protected
+
+            # SCA Checker field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[card_number transaction_amount transaction_currency]
+              field_values.merge! transaction_currency:  Constants::Currencies::Iso4217.all.map(&:upcase),
+                                  recurring_type:        [Constants::Transactions::Parameters::Recurring::Types::
+                                                              INITIAL,
+                                                          Constants::Transactions::Parameters::Recurring::Types::
+                                                              SUBSEQUENT],
+                                  transaction_exemption: Constants::Transactions::Parameters::ScaExemptions.all
+            end
+
+            # SCA Checker request structure
+            def request_structure
+              {
+                card_number:           card_number,
+                transaction_amount:    transform_amount(transaction_amount, transaction_currency).to_i,
+                transaction_currency:  transaction_currency,
+                moto:                  moto,
+                mit:                   mit,
+                recurring_type:        recurring_type,
+                transaction_exemption: transaction_exemption
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/tokenization/cryptogram.rb

@@ -0,0 +1,46 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Tokenization
+          # Get cryptogram on behalf of a token that will be used for the authorization
+          class Cryptogram < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenAttributes
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenizationAttributes
+
+            attr_accessor :transaction_reference
+
+            def initialize(configuration, builder_interface = Builder::XML)
+              super configuration, builder_interface
+
+              self.request_path = 'cryptogram'
+            end
+
+            protected
+
+            # Cryptogram field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tokenization_required_fields, *%i[token transaction_reference]
+            end
+
+            # API Request structure
+            def request_structure
+              {
+                cryptogram_request: tokenization_attributes_structure.merge(
+                  {
+                    token:                 token,
+                    transaction_reference: transaction_reference
+                  }
+                )
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/tokenization/delete_token.rb

@@ -0,0 +1,43 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Tokenization
+          # Deletes a token
+          class DeleteToken < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenAttributes
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenizationAttributes
+
+            def initialize(configuration, builder_interface = Builder::XML)
+              super configuration, builder_interface
+
+              self.request_path = 'delete_token'
+            end
+
+            protected
+
+            # Delete Token field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tokenization_required_fields, *%i[token]
+            end
+
+            # API Request structure
+            def request_structure
+              {
+                delete_token_request: tokenization_attributes_structure.merge(
+                  {
+                    token: token
+                  }
+                )
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end