genesis_ruby 0.2.4 → 0.2.6

data/lib/genesis_ruby/api/requests/financial/vouchers/neosurf.rb

@@ -0,0 +1,61 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Vouchers
+          # Neosurf is a prepaid card (voucher) that is used for online shopping
+          class Neosurf < Base::Financial
+
+            include Api::Mixins::Requests::AddressInfoAttributes
+            include Api::Mixins::Requests::Financial::AsyncAttributes
+
+            attr_reader :voucher_number
+
+            # Voucher number. Alphanumeric maximum 10 characters
+            def voucher_number=(value)
+              limited_string attribute: __method__,
+                             value: value.to_s.empty? ? nil : value.to_s,
+                             min: 1,
+                             max: 10
+            end
+
+            protected
+
+            # Neosurf transaction type
+            def transaction_type
+              Api::Constants::Transactions::NEOSURF
+            end
+
+            # Neosurf Field Validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id amount currency billing_country]
+              field_values.merge! currency:        %w( AUD BGN BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR
+                                                      ILS INR JPY KRW MXN MYR NOK NZD PHP PLN RON RUB SEK
+                                                      SGD THB TRY USD XOF ZAR ),
+                                  billing_country: %w( AT DZ AU BI BF BJ BE CV CY CA CF TD CO CG CM CD DK GQ
+                                                    FR GM DE GA GN GH GW HK IE IT CI KE LU MW MZ MA MR ML
+                                                    NE NG NL NZ NO PL PT RW RU RO SE ES SL SN ST CH RS TR
+                                                    TG TN GB TZ UG ZW ZM )
+            end
+
+            # Neosurf request structure
+            def payment_transaction_structure
+              {
+                voucher_number:     voucher_number,
+                customer_email:     customer_email,
+                customer_phone:     customer_phone,
+                return_success_url: return_success_url,
+                return_failure_url: return_failure_url,
+                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/chargeback/date_range.rb

@@ -0,0 +1,82 @@
+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 Chargeback
+            # Date range based chargeback retrieval allows you to fetch information for all
+            # chargebacks 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
+
+              # Date of import in the system
+              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: 'chargebacks/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 = {
+                  chargeback_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/chargeback/transaction.rb

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Chargeback
+            # Retrieve a single chargeback or a list of chargebacks 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: 'chargebacks', include_token: false
+              end
+
+              # Chargeback 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 = {
+                  chargeback_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/fraud/reports/date_range.rb

@@ -0,0 +1,108 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Reports
+            # Date range based SAFE/TC40 retrieval allows you to fetch information for
+            # all SAFE/TC40 reports 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
+
+              # 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
+
+              # Date of import in the system
+              def import_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Start of the requested date range for the date when the fraud was reported
+              def report_start_date
+                @report_start_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Start of the requested date range for the date when the fraud was reported
+              def report_start_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # End of the requested date range for the date when the fraud was reported
+              def report_end_date
+                @report_end_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # End of the requested date range for the date when the fraud was reported
+              def report_end_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: 'fraud_reports/by_date', include_token: false
+                @api_config.parser_skip_root_node = false
+              end
+
+              # Field Validations
+              def init_field_validations
+                super
+
+                field_value_dependencies.merge!(
+                  {
+                    start_date:        %i[end_date],
+                    report_start_date: %i[report_end_date]
+                  }
+                )
+              end
+
+              # Custom field validations
+              def check_requirements
+                fields        = [start_date, import_date, report_start_date]
+                error_message =
+                  'Either start_date/end_date, import_date or report_start_date/report_end_date' \
+                  ' fields have to be set, do not mix'
+
+                raise ParameterError, error_message if fields.compact.size != 1
+
+                super
+              end
+
+              # API Request structure
+              def populate_structure # rubocop:disable Metrics/MethodLength
+                @tree_structure = {
+                  fraud_report_request: {
+                    start_date:        start_date,
+                    end_date:          end_date,
+                    import_date:       import_date,
+                    report_start_date: report_start_date,
+                    report_end_date:   report_end_date,
+                    page:              page,
+                    per_page:          per_page
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Reports
+            # Retrieve a single SAFE/TC40 or a list of SAFE/TC40 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: 'fraud_reports', include_token: false
+              end
+
+              # Report 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 = {
+                  fraud_report_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/fx/get_rate.rb

@@ -0,0 +1,55 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fx
+          # This call is used to return information about selected Rate for merchant
+          class GetRate < Base::Versioned
+
+            include Api::Mixins::Requests::NonFinancial::Fx::IdAttributes
+            include Api::Mixins::Requests::NonFinancial::Fx::TierIdAttributes
+
+            # Get Rate initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'fx/tiers/:tier_id/rates/: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, *tier_id_required_fields
+            end
+
+            # Get Rate request structure
+            def request_structure
+              {}
+            end
+
+            # Override API endpoint with provided IDs
+            def process_request_parameters
+              super
+
+              request_path.sub!(':tier_id', tier_id)
+              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_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