genesis_ruby 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5d3d0e9a97a91f74ce48b4e8607d40362b6c1b7559480aaa8c6996a64077215
-  data.tar.gz: 156b75a8de3262f3cea5587b2f149307aada10b25c53b3e9710f1ccc8b8374db
+  metadata.gz: b8bb23a143ba4c359861d35f9e03cfde80130d4e7566cd95a899e27e5f77b8d2
+  data.tar.gz: 72496117a1a8a3ec4dcca3b39f41ac080b9696b1d16e2844c3f3488b11b15104
 SHA512:
-  metadata.gz: ee6d13886cf45ec36864c50dd6ce6f2803818bd990bbdccb9e25bd8209b96ed8b3885fd66d770a01e77105162cfec84c3a8b144ccdac5baf95d574aa608f1f51
-  data.tar.gz: 22b62855963c557566a2bf95e439f337234fd0039d182e7903f3bb89ff03b8947902cd6526643c2c5aa138c2f38f7294617ce2c1a74d3d364e4cab115f14a153
+  metadata.gz: 54bfbce4e0a95961f64aafdc168e8509f810c070d9a24ff1430648da7f12611f87e418dea7483e97e655065b24a83bf80d61a9fe870ac6656e9bfd55704e2474
+  data.tar.gz: 9a10b7cd257d4dacb18b420d454cc564c265f0e636221454b00b6ed86ca95002a8cc8dfc9212ad599002fd6101da571a63063d14f1c71fe1675430a38443a47b

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+0.2.2
+-----
+**Features**:
+
+* Added Installments API services support
+* Added Installments attributes support to the following transaction requests:
+  * Authorize
+  * Authorize 3D
+  * Capture
+  * Sale
+  * Sale 3D
+  * Refund
+* Added Level 3 Travel Data attributes support to Refund transaction request
+
+0.2.1
+-----
+**Features**:
+
+* Added Online Banking PayOut transaction request
+* Added Funding Parameters support to Google Pay and Apple Pay transaction requests
+* Added Bancontact transaction request support
+* Added Cash transaction request support
+* Added COF and UCOF parameters support to the following transaction requests:
+  * Authorize
+  * Authorize 3D
+  * Sale
+  * Sale 3D
+* Added Tokenized e-commerce payment support
+
 0.2.0
 -----
 **Features**:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    genesis_ruby (0.2.0)
+    genesis_ruby (0.2.2)
       net-http (~> 0.3.2)
       nokogiri (~> 1.14)
 
@@ -41,13 +41,13 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.7)
+    mini_portile2 (2.8.8)
     multi_xml (0.6.0)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     net-http (0.3.2)
       uri
-    nokogiri (1.15.6)
+    nokogiri (1.15.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (7.2.0)
@@ -135,7 +135,7 @@ GEM
     thor (1.3.2)
     tilt (2.4.0)
     unicode-display_width (2.6.0)
-    uri (1.0.1)
+    uri (1.0.3)
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)

data/README.md

@@ -996,6 +996,7 @@ GenesisRuby::Api::Requests::Financial::Cards::Argencard
 GenesisRuby::Api::Requests::Financial::Cards::Aura
 GenesisRuby::Api::Requests::Financial::Cards::Authorize
 GenesisRuby::Api::Requests::Financial::Cards::Authorize3d
+GenesisRuby::Api::Requests::Financial::Cards::Bancontact
 GenesisRuby::Api::Requests::Financial::Cards::Cabal
 GenesisRuby::Api::Requests::Financial::Cards::Cencosud
 GenesisRuby::Api::Requests::Financial::Cards::Elo
@@ -1016,6 +1017,7 @@ GenesisRuby::Api::Requests::Financial::Wallets::PayPal
 GenesisRuby::Api::Requests::Financial::CashPayments::Baloto
 GenesisRuby::Api::Requests::Financial::CashPayments::BancoDeOccidente
 GenesisRuby::Api::Requests::Financial::CashPayments::Boleto
+GenesisRuby::Api::Requests::Financial::CashPayments::Cash
 GenesisRuby::Api::Requests::Financial::CashPayments::Efecty
 GenesisRuby::Api::Requests::Financial::CashPayments::Oxxo
 GenesisRuby::Api::Requests::Financial::CashPayments::PagoFacil
@@ -1039,6 +1041,8 @@ GenesisRuby::Api::Requests::Financial::OnlineBankingPayments::Santander
 GenesisRuby::Api::Requests::Financial::OnlineBankingPayments::Webpay
 # PayIn
 GenesisRuby::Api::Requests::Financial::OnlineBankingPayments::OnlineBanking::PayIn
+# PayOut
+GenesisRuby::Api::Requests::Financial::OnlineBankingPayments::OnlineBanking::PayOut
 
 # References
 GenesisRuby::Api::Requests::Financial::Capture
@@ -1049,6 +1053,10 @@ GenesisRuby::Api::Requests::Financial::Refund
 ## Reconcile
 GenesisRuby::Api::Requests::NonFinancial::Reconcile::Transaction
 GenesisRuby::Api::Requests::NonFinancial::Reconcile::DateRange
+
+## Installments
+GenesisRuby::Api::Requests::NonFinancial::Installments::Fetch
+
 ```
 
 ### Manual initialization

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.2

data/lib/genesis_ruby/api/constants/date_time_formats.rb

@@ -24,6 +24,9 @@ module GenesisRuby
         # Date Format ISO 8601
         YYYY_MM_DD_ISO_8601   = '%Y-%m-%d'.freeze
 
+        # Date Format
+        MM_DD                 = '%m%d'.freeze
+
         class << self
 
           def all
@@ -33,6 +36,7 @@ module GenesisRuby
               DD_MM_YYYY_L_SLASHES,
               YYYY_MM_DD_H_I_S_ZULU,
               YYYY_MM_DD_H_I_S,
+              MM_DD,
               YYYY_MM_DD_ISO_8601 # Always keep it last!!!
             ]
           end

data/lib/genesis_ruby/api/constants/transactions/parameters/cash_payments/cash_payment_types.rb

@@ -0,0 +1,36 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module CashPayments
+            # Cash Payment Types allowed values
+            class CashPaymentTypes
+
+              extend Mixins::Constants::Common
+
+              # 7 Eleven
+              SEVEN_ELEVEN             = 'seven_eleven'.freeze
+
+              # Bancomer
+              BANCOMER                 = 'bancomer'.freeze
+
+              # Farmacias del Dr. Ahorro
+              PHARMACIES_DEL_DR_AHORRO = 'pharmacies_del_dr_ahorro'.freeze
+
+              # Farmacias Santa Maria
+              PHARMACIES_SANTA_MARIA   = 'pharmacies_santa_maria'.freeze
+
+              # OXXO
+              OXXO                     = 'oxxo'.freeze
+
+              # Scotiabank
+              SCOTIABANK               = 'scotiabank'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/credential_on_files.rb

@@ -0,0 +1,29 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          # Credential On Files allowed values
+          class CredentialOnFiles
+
+            extend Mixins::Constants::Common
+
+            # Initial transaction used to store payment credentials for future customer initiated payments while
+            # processing. Required for external tokenization, and optional for gateway-based tokenization
+            INITIAL_CUSTOMER_INITIATED    = 'initial_customer_initiated'.freeze
+
+            # Subsequent customer initiated transaction using previously stored payment credentials.
+            # Required for external tokenization, and optional for gateway-based tokenization
+            SUBSEQUENT_CUSTOMER_INITIATED = 'subsequent_customer_initiated'.freeze
+
+            # For UCOF transaction, the scheme transaction identifier of the initial transaction must be sent in
+            # the transaction request. For MasterCard or Maestro UCOF, the scheme settlement date in MMDD format
+            # (e.g. 0107) of the initial transaction must be sent in the transaction request.
+            MERCHANT_UNSCHEDULED          = 'merchant_unscheduled'.freeze
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/online_banking/bank_account_types.rb

@@ -0,0 +1,30 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module OnlineBanking
+            # Bank Payout Account Types allowed values
+            class BankAccountTypes
+
+              extend Mixins::Constants::Common
+
+              # Checking accounts
+              CHECKING = 'C'.freeze
+
+              # Savings accounts
+              SAVINGS  = 'S'.freeze
+
+              # Maestra accounts(Only Peru)
+              MAESTRA  = 'M'.freeze
+
+              # Payment accounts
+              PAYMENT  = 'P'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/online_banking/payout_payment_types.rb

@@ -0,0 +1,42 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module OnlineBanking
+            # Bank Payout Payment Types allowed values
+            class PayoutPaymentTypes
+
+              extend Api::Mixins::Constants::Common
+
+              # Bank to Bank
+              BANK_TO_BANK     = 'bank_to_bank'.freeze
+
+              # PIX
+              PIX              = 'pix'.freeze
+
+              # BSB
+              BSB              = 'bsb'.freeze
+
+              # Pay ID
+              PAY_ID           = 'pay_id'.freeze
+
+              # Bank to Bank, Business to Business
+              BANK_TO_BANK_B2B = 'bank_to_bank_b2b'.freeze
+
+              # PIX Business to Business
+              PIX_B2B          = 'pix_b2b'.freeze
+
+              # Clabe
+              CLABE            = 'clabe'.freeze
+
+              # Cellphone
+              CELLPHONE        = 'cellphone'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/refund/credit_reason_indicators.rb

@@ -0,0 +1,30 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module Refund
+            # Credit Reason Indicator allowed values
+            class CreditReasonIndicators
+
+              extend Api::Mixins::Constants::Common
+
+              # Passenger Transport Ancillary Cancellation
+              INDICATOR_A = 'A'.freeze
+
+              # Travel Ticket and Passenger Transport
+              INDICATOR_B = 'B'.freeze
+
+              # Partial Refund of Travel Ticket
+              INDICATOR_P = 'P'.freeze
+
+              # Other
+              INDICATOR_O = 'O'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/refund/ticket_change_indicators.rb

@@ -0,0 +1,24 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module Refund
+            # Ticket Change Indicator allowed values
+            class TicketChangeIndicators
+
+              extend Api::Mixins::Constants::Common
+
+              # Change to existing Ticket
+              INDICATOR_C = 'C'.freeze
+
+              # New ticket
+              INDICATOR_N = 'N'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions.rb

@@ -79,6 +79,10 @@ module GenesisRuby
         # Capture settles a transaction which has been authorized before.
         CAPTURE = 'capture'.freeze
 
+        # Cash payment methods allow customers to pay bills and online purchases in cash at convenient
+        # physical locations such as stores, banks, ATMs, even pharmacies in some countries.
+        CASH = 'cash'.freeze
+
         # Voucher-based payment
         CASHU = 'cashu'.freeze
 

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

@@ -0,0 +1,29 @@
+require 'genesis_ruby/api/constants/transactions/parameters/credential_on_files'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Cards
+            # Credential On File shared attributes mixin
+            module CredentialOnFileAttributes
+
+              attr_accessor :credential_on_file
+
+              protected
+
+              # Credential on file allowed field values validations
+              def credential_on_file_field_validations
+                {
+                  credential_on_file: Api::Constants::Transactions::Parameters::CredentialOnFiles.all
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Cards
+            # Installment shared attributes mixin
+            module InstallmentAttributes
+
+              attr_accessor :installment_plan_id, :installment_plan_reference
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -55,6 +55,16 @@ module GenesisRuby
                 }
               end
 
+              # Field value dependencies for MPI parameters
+              def mpi_attributes_field_dependencies
+                {
+                  mpi_protocol_version: Hash[
+                    Api::Constants::Transactions::Parameters::MpiProtocolVersions::PROTOCOL_VERSION_2,
+                    %w(mpi_directory_server_id)
+                  ]
+                }
+              end
+
             end
           end
         end

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

@@ -0,0 +1,33 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Cards
+            # UCOF shared attributes mixin
+            module UcofAttributes
+
+              attr_reader :credential_on_file_transaction_identifier
+
+              # UCOF Transaction Identifier
+              def credential_on_file_transaction_identifier=(value)
+                limited_string attribute: __method__, value: value.to_s, min: 15, max: 32
+              end
+
+              # UCOF Settlement Date
+              def credential_on_file_settlement_date
+                @credential_on_file_settlement_date&.strftime Api::Constants::DateTimeFormats::MM_DD
+              end
+
+              # UCOF Settlement Date
+              def credential_on_file_settlement_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module OnlineBankingPayments
+            # PIX shared attributes
+            module PixAttributes
+
+              attr_accessor :company_type, :company_activity, :mothers_name
+
+              # Incorporation Date Accessor
+              def incorporation_date
+                @incorporation_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Incorporation Date Accessor
+              def incorporation_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/request.rb

@@ -7,7 +7,7 @@ require 'genesis_ruby/utils/money_format'
 module GenesisRuby
   module Api
     # Base Request Class
-    class Request
+    class Request # rubocop:disable Metrics/ClassLength
 
       include Mixins::Requests::RestrictedSetter
       include Mixins::Requests::AttributeValidation
@@ -70,6 +70,11 @@ module GenesisRuby
         @api_config.load_form_config
       end
 
+      # Pre-defined GET Request Configuration
+      def init_get_configuration
+        @api_config.load_get_config
+      end
+
       # Initializes Api EndPoint Url with request path & terminal token
       def init_api_gateway_configuration(options = { request_path: 'process', include_token: true })
         request_path  = options.fetch :request_path, 'process'

data/lib/genesis_ruby/api/requests/base/financials/credit_card.rb

@@ -7,23 +7,46 @@ module GenesisRuby
           class CreditCard < GenesisRuby::Api::Requests::Base::Financial
 
             include Mixins::Requests::Financial::Cards::AccountOwnerAttributes
+            include Mixins::Requests::Financial::Cards::CredentialOnFileAttributes
             include Mixins::Requests::Financial::Cards::CreditCardAttributes
             include Mixins::Requests::Financial::Cards::TokenizationAttributes
+            include Mixins::Requests::Financial::Cards::UcofAttributes
             include Mixins::Requests::Financial::PaymentAttributes
 
+            attr_reader :scheme_tokenized
+
+            # Visa tokenization for Visa
+            # Digital Secure Remote Payments (DSRP) for Mastercard.
+            def scheme_tokenized=(value)
+              allowed_options attribute:      __method__,
+                              allowed:        [true, false],
+                              value:          value,
+                              allow_empty:    true,
+                              error_message: 'Accepts only boolean values'
+            end
+
             protected
 
             # Request Field validations
             def init_field_validations
               required_fields.push *%i[transaction_id amount currency]
-              field_values.merge! currency: Api::Constants::Currencies::Iso4217.all.map(&:upcase)
+              field_values.merge!(
+                { currency: Api::Constants::Currencies::Iso4217.all.map(&:upcase) },
+                credential_on_file_field_validations
+              )
             end
 
             # Credit Card attributes
             def payment_transaction_structure
               payment_attributes_structure.merge(
                 credit_card_attributes_structure, tokenization_attributes_structure,
-                { account_owner: account_owner_attributes_structure }
+                {
+                  account_owner:                             account_owner_attributes_structure,
+                  credential_on_file:                        credential_on_file,
+                  credential_on_file_transaction_identifier: credential_on_file_transaction_identifier,
+                  credential_on_file_settlement_date:        credential_on_file_settlement_date,
+                  scheme_tokenized:                          scheme_tokenized
+                }
               )
             end
 

data/lib/genesis_ruby/api/requests/base/versioned.rb

@@ -0,0 +1,88 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Base
+        # Base Versioned Request class used for Non Financial JSON API services
+        class Versioned < Request
+
+          DEFAULT_VERSION = 'v1'.freeze
+          private_constant :DEFAULT_VERSION
+
+          attr_reader :version, :allowed_versions
+
+          # Base Versioned Request constructor
+          def initialize(configuration, builder_interface = Builder::JSON)
+            super configuration, builder_interface
+
+            self.allowed_versions = [DEFAULT_VERSION]
+            self.version          = DEFAULT_VERSION
+            self.request_path     = ''
+          end
+
+          # Defines the version for the request
+          def version=(value)
+            allowed_options(
+              attribute:     __method__,
+              value:         value,
+              allowed:       allowed_versions,
+              allow_empty:   false,
+              error_message: 'Invalid API version! '
+            )
+
+            init_configuration
+          end
+
+          protected
+
+          attr_reader :request_path
+
+          # Every Specific request defines available versions
+          def allowed_versions=(value)
+            raise InvalidArgumentError, 'Allowed versions accepts only Array values' unless value.is_a? Array
+
+            @allowed_versions = value
+          end
+
+          # Defines the endpoint of the request
+          def request_path=(value)
+            @request_path = value.to_s
+
+            init_configuration
+
+            @request_path
+          rescue BuilderError
+            @request_path = ''
+
+            raise InvalidArgumentError, 'The Request can not be configured!'
+          end
+
+          # Initialize Request configuration
+          def init_configuration
+            super
+
+            case @builder_interface
+            when Builder::XML then init_xml_configuration
+            when Builder::JSON then init_json_configuration
+            else raise BuilderError, "Invalid Builder Interface specified for #{self.class.name}"
+            end
+
+            init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+          end
+
+          # Request structure. Overridden for common structure parameters
+          def populate_structure
+            super
+
+            @tree_structure = request_structure
+          end
+
+          # Request structure
+          def request_structure
+            raise NoMethodError, 'Request structure must be defined!'
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/capture.rb

@@ -6,6 +6,7 @@ module GenesisRuby
         class Capture < Requests::Base::Reference
 
           include Mixins::Requests::Financial::Business::BusinessAttributes
+          include Mixins::Requests::Financial::Cards::InstallmentAttributes
           include Mixins::Requests::Financial::TravelData::TravelAttributes
 
           protected
@@ -18,9 +19,11 @@ module GenesisRuby
           # Capture Transaction Request Structure
           def reference_transaction_structure
             {
-              reference_id:        reference_id,
-              business_attributes: business_attributes_structure,
-              travel:              travel_data_attributes_structure
+              reference_id:               reference_id,
+              business_attributes:        business_attributes_structure,
+              travel:                     travel_data_attributes_structure,
+              installment_plan_id:        installment_plan_id,
+              installment_plan_reference: installment_plan_reference
             }
           end