genesis_ruby 0.2.2 → 0.2.4

data/lib/genesis_ruby/api/requests/non_financial/consumers/update.rb

@@ -0,0 +1,45 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Updates consumer email and addresses.
+          class Update < Base::Consumer
+
+            include Api::Mixins::Requests::CustomerAddress::BillingInfoAttributes
+            include Api::Mixins::Requests::CustomerAddress::ShippingInfoAttributes
+
+            attr_accessor :email, :consumer_id
+
+            # Update Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'update_consumer'
+            end
+
+            protected
+
+            # Update Consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email consumer_id]
+            end
+
+            # Update Consumer request structure
+            def request_structure
+              {
+                email:            email,
+                consumer_id:      consumer_id,
+                billing_address:  billing_address_parameters_structure,
+                shipping_address: shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fraud/retrieval/date_range.rb

@@ -0,0 +1,81 @@
+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 Fraud
+          module Retrieval
+            # Date range based retrieval request retrieval allows you to fetch information
+            # for all retrieval requests for a given merchant within a given date range
+            class DateRange < Api::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 Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # End of the requested date range
+              def end_date
+                @end_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Date of import in the system
+              def import_date
+                @import_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              def import_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              protected
+
+              # Set Gateway API configuration
+              def init_configuration
+                init_xml_configuration
+                init_api_gateway_configuration request_path: 'retrieval_requests/by_date', include_token: false
+                @api_config.parser_skip_root_node = false
+              end
+
+              # Field Validations
+              def init_field_validations
+                super
+
+                constant_values = {
+                  externally_processed: Constants::Transactions::Parameters::NonFinancial::ExternallyProcessed.all,
+                  processing_type:      Constants::Transactions::Parameters::NonFinancial::ProcessingType.all
+                }
+
+                required_fields.push *%i[start_date]
+                field_values.merge! constant_values
+              end
+
+              # API Request structure
+              def populate_structure # rubocop:disable Metrics/MethodLength
+                @tree_structure = {
+                  retrieval_request_request: {
+                    start_date:           start_date,
+                    end_date:             end_date,
+                    import_date:          import_date,
+                    page:                 page,
+                    per_page:             per_page,
+                    externally_processed: externally_processed,
+                    processing_type:      processing_type
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fraud/retrieval/transaction.rb

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Retrieval
+            # Retrieve a single retrieval request or a list of requests by ARN or by passing the unique ID
+            # of the original transaction.
+            class Transaction < Api::Request
+
+              include Api::Mixins::Requests::NonFinancial::ModeAttributes
+
+              attr_accessor :arn, :original_transaction_unique_id
+
+              protected
+
+              # Set Gateway API configuration
+              def init_configuration
+                init_xml_configuration
+                init_api_gateway_configuration request_path: 'retrieval_requests', include_token: false
+              end
+
+              # Retrieval custom field validations
+              def check_requirements
+                unless arn.nil? ^ original_transaction_unique_id.nil?
+                  raise(
+                    ParameterError,
+                    'Either arn or original_transaction_unique_id field has to be set, not both.'
+                  )
+                end
+
+                super
+              end
+
+              # API Request structure
+              def populate_structure
+                @tree_structure = {
+                  retrieval_request_request: {
+                    arn:                            arn,
+                    original_transaction_unique_id: original_transaction_unique_id,
+                    mode:                           mode
+                  }
+                }
+              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/reconcile/date_range.rb

@@ -8,43 +8,9 @@ module GenesisRuby
           # The response is paginated, each request will return 100 entries max.
           class DateRange < Api::Request
 
-            attr_reader :page
-
-            # Start of the requested date range (time is optional)
-            def start_date
-              format = if start_date_time?
-                         Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
-                       else
-                         Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
-                       end
-
-              @start_date&.strftime format
-            end
-
-            # Start of the requested date range (time is optional)
-            def start_date=(value)
-              self.start_date_time = Utils::Common.date_has_time? value
-
-              parse_date attribute: __method__, value: value, allow_empty: false
-            end
-
-            # Start of the requested date range (time is optional)
-            def end_date
-              format = if end_date_time?
-                         Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
-                       else
-                         Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
-                       end
-
-              @end_date&.strftime format
-            end
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
 
-            # End of the requested date range (time is optional)
-            def end_date=(value)
-              self.end_date_time = Utils::Common.date_has_time? value
-
-              parse_date attribute: __method__, value: value, allow_empty: true
-            end
+            attr_reader :page
 
             # The page within the paginated result, defaults to 1
             def page=(value)
@@ -75,20 +41,6 @@ module GenesisRuby
               }
             end
 
-            private
-
-            attr_accessor :start_date_time, :end_date_time
-
-            # Start Date has time within the given string
-            def start_date_time?
-              self.start_date_time ||= false
-            end
-
-            # End Date has time within the given string
-            def end_date_time?
-              self.end_date_time ||= false
-            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,43 @@
+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
+
+            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]
+            end
+
+            # API Request structure
+            def request_structure
+              {
+                cryptogram_request: tokenization_attributes_structure.merge(
+                  {
+                    token: token
+                  }
+                )
+              }
+            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

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

@@ -0,0 +1,43 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Tokenization
+          # Exchanges the token with the tokenized cardholder data
+          class Detokenize < 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 = 'detokenize'
+            end
+
+            protected
+
+            # Detokenize field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tokenization_required_fields, *%i[token]
+            end
+
+            # API Request structure
+            def request_structure
+              {
+                detokenize_request: tokenization_attributes_structure.merge(
+                  {
+                    token: token
+                  }
+                )
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Tokenization
+          # Exchanges the token with the tokenized masked cardholder data
+          class GetCard < 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 = 'get_card'
+            end
+
+            protected
+
+            # Get Card field validations
+            def init_field_validations
+              super
+
+              required_fields.push *tokenization_required_fields, *%i[token]
+            end
+
+            # API Request structure
+            def request_structure
+              {
+                get_card_request: tokenization_attributes_structure.merge(
+                  {
+                    token: token
+                  }
+                )
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end