genesis_ruby 0.2.2 → 0.2.4

data/lib/genesis_ruby/api/mixins/requests/financial/bank_attributes.rb

@@ -0,0 +1,26 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Bank Attributes mixin
+          module BankAttributes
+
+            attr_reader :bic, :iban
+
+            # BIC parameter validation
+            def bic=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, min: 8, max: 11
+            end
+
+            # IBAN parameter validation
+            def iban=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 34
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/beneficiary_attributes.rb

@@ -0,0 +1,38 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # The beneficiary parameters attributes
+          module BeneficiaryAttributes
+
+            attr_accessor :beneficiary_name
+            attr_reader   :beneficiary_document_id, :beneficiary_pix_key
+
+            # The Document ID of the beneficiary, such as CPF or CNPJ for Brazilian entities
+            def beneficiary_document_id=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 14
+            end
+
+            # The PIX key associated with the beneficiary
+            def beneficiary_pix_key=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 36
+            end
+
+            protected
+
+            # Beneficiary parameters structure
+            def beneficiary_parameters_structure
+              {
+                name:        beneficiary_name,
+                document_id: beneficiary_document_id,
+                pix_key:     beneficiary_pix_key
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/customer_account_attributes.rb

@@ -0,0 +1,21 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Customer Account Attributes
+          module CustomerAccountAttributes
+
+            attr_reader :customer_account_id
+
+            # Customer account id parameter validation
+            def customer_account_id=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 20
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module OnlineBankingPayments
+            # Payer attributes
+            module PayerAttributes
+
+              attr_reader :payer_document_id, :payer_bank_code, :payer_bank_account_number,
+                          :payer_bank_branch, :payer_bank_account_verification_digit,
+                          :payer_bank_phone_number
+
+              # Payer document ID
+              def payer_document_id=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 16
+              end
+
+              # The bank code used to process the transaction
+              def payer_bank_code=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 12
+              end
+
+              # The payer's bank account number
+              def payer_bank_account_number=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 33
+              end
+
+              # The name of the bank branch where the account is held
+              def payer_bank_branch=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 11
+              end
+
+              # Single digit verification code assigned by the external provider,
+              # used to validate the bank account
+              def payer_bank_account_verification_digit=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 1
+              end
+
+              # The payer's bank contact phone number
+              def payer_bank_phone_number=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 11
+              end
+
+              protected
+
+              # Payer parameters structure
+              def payer_parameters_structure
+                {
+                  document_id:                     payer_document_id,
+                  bank_code:                       payer_bank_code,
+                  bank_account_number:             payer_bank_account_number,
+                  bank_branch:                     payer_bank_branch,
+                  bank_account_verification_digit: payer_bank_account_verification_digit,
+                  bank_phone_number:               payer_bank_phone_number
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/billing_api/sort_attributes.rb

@@ -0,0 +1,18 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module BillingApi
+            # Sort Attributes mixin
+            module SortAttributes
+
+              attr_accessor :sort_by_field, :sort_by_direction
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/date_attributes.rb

@@ -0,0 +1,64 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          # Date Attributes mixin
+          module DateAttributes
+
+            # Start of the requested date range (time is optional)
+            def start_date
+              format = if start_date_time?
+                         Api::Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
+                       else
+                         Api::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: true
+            end
+
+            # Start of the requested date range (time is optional)
+            def end_date
+              format = if end_date_time?
+                         Api::Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
+                       else
+                         Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+                       end
+
+              @end_date&.strftime format
+            end
+
+            # 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
+
+            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
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/mode_attributes.rb

@@ -0,0 +1,24 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          # Mode Attributes mixin
+          module ModeAttributes
+
+            attr_reader :mode
+
+            # Mode
+            def mode=(value)
+              allowed_options attribute: __method__,
+                              allowed: %w(list),
+                              value: value.to_s.downcase,
+                              allow_empty: true
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/paging_attributes.rb

@@ -0,0 +1,33 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          # Paging Attributes mixin
+          module PagingAttributes
+
+            attr_reader :page, :per_page
+
+            # Page accessor
+            def page=(value)
+              parse_int attribute: __method__, value: value, allow_empty: true
+            end
+
+            # Per Page accessor
+            def per_page=(value)
+              parse_int attribute: __method__, value: value, allow_empty: true
+            end
+
+            protected
+
+            # Paging Response fields
+            def paging_query_fields
+              %w(page perPage pagesCount totalCount)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/tokenization/card_data_attributes.rb

@@ -0,0 +1,62 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Tokenization
+            # Card Data Attributes mixin
+            module CardDataAttributes
+
+              attr_accessor :card_holder
+              attr_reader   :card_number, :expiration_month, :expiration_year
+
+              # Complete credit/debit card number of customer
+              def card_number=(value)
+                limited_string attribute: __method__, value: value.to_s, min: 13, max: 19
+              end
+
+              # Expiration month as printed on credit card
+              def expiration_month=(value)
+                error_message = format(
+                  'Invalid value "%{value}" given for %{attribute}, should be in MM format',
+                  value: value,
+                  attribute: __method__
+                )
+
+                raise GenesisRuby::ParameterError, error_message unless value.nil? || value =~ /^(0[1-9]|1[0-2])$/
+
+                @expiration_month = value
+              end
+
+              # Expiration year as printed on credit card
+              def expiration_year=(value)
+                error_message = format(
+                  'Invalid value "%{value}" given for %{attribute}, should be in YYYY format',
+                  value: value,
+                  attribute: __method__
+                )
+
+                raise GenesisRuby::ParameterError, error_message unless value.nil? || value =~ /^(20)\d{2}$/
+
+                @expiration_year = value
+              end
+
+              protected
+
+              # Card Data Attributes Structure
+              def card_data_attributes_structure
+                {
+                  card_number:      card_number,
+                  card_holder:      card_holder,
+                  expiration_month: expiration_month,
+                  expiration_year:  expiration_year
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/tokenization/token_attributes.rb

@@ -0,0 +1,23 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Tokenization
+            # Token Attributes mixin
+            module TokenAttributes
+
+              attr_reader :token
+
+              # Plain-text token value
+              def token=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 36
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/tokenization/tokenization_attributes.rb

@@ -0,0 +1,51 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Tokenization
+            # Common Tokenization API Attributes mixin
+            module TokenizationAttributes
+
+              attr_accessor :token_type
+              attr_reader   :consumer_id, :email
+
+              # Consumer unique reference
+              def consumer_id=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 10
+              end
+
+              # Consumer e-mail address
+              def email=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+
+                raise GenesisRuby::ParameterError, error_message unless value.nil? || value =~ /\A.+@.+\..+\Z/
+
+                @email = value
+              end
+
+              protected
+
+              def tokenization_required_fields
+                %i[consumer_id email token_type]
+              end
+
+              # Tokenization Attributes Structure
+              def tokenization_attributes_structure
+                {
+                  consumer_id: consumer_id,
+                  email:       email,
+                  token_type:  token_type
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -61,6 +61,24 @@ module GenesisRuby
             assign_instance_variable attribute, value.to_i
           end
 
+          # Parses given value by validating if an array is given
+          # Apply .to_s to every array value
+          def parse_array_of_strings(attribute:, value:, allowed: [], allow_empty: false)
+            raise InvalidArgumentError, "#{attribute} accepts only Array value." unless value.is_a?(Array)
+            raise InvalidArgumentError, "#{attribute} empty value not allowed!" if !allow_empty && value.empty?
+
+            parsed_value = value.map(&:to_s)
+
+            unless allowed.empty?
+              diff    = parsed_value - allowed
+              message = "#{attribute} has invalid values #{diff.join(", ")}. Allowed: #{allowed.join(", ")}."
+
+              raise InvalidArgumentError, message unless diff.empty?
+            end
+
+            assign_instance_variable attribute, value
+          end
+
           private
 
           # Helper for assigning a attribute to the class instance

data/lib/genesis_ruby/api/request.rb

@@ -19,6 +19,9 @@ module GenesisRuby
       METHOD_GET     = 'GET'.freeze
       METHOD_PUT     = 'PUT'.freeze
 
+      AUTH_TYPE_BASIC = 'basic'.freeze
+      AUTH_TYPE_TOKEN = 'bearer'.freeze
+
       attr_reader :api_config
 
       def initialize(configuration, builder_interface = 'xml')
@@ -75,6 +78,11 @@ module GenesisRuby
         @api_config.load_get_config
       end
 
+      # Pre-defined GraphQL Request Configuration
+      def init_graphql_configuration
+        @api_config.load_graphql_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'
@@ -101,6 +109,13 @@ module GenesisRuby
         )
       end
 
+      # Initializes API Service Configuration
+      def init_api_service_configuration(options = { request_path: 'graphql' })
+        request_path = options.fetch :request_path, 'graphql'
+
+        api_config.url = build_request_url({ subdomain: 'api_service', path: request_path })
+      end
+
       # Process Everything the variables set previously
       #
       # Step 1: Execute per-field actions

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

@@ -0,0 +1,24 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Base
+        # Consumers API base request class
+        class Consumer < Versioned
+
+          def initialize(configuration, builder_interface = Builder::XML)
+            super configuration, builder_interface
+          end
+
+          protected
+
+          def populate_structure
+            super
+
+            @tree_structure = Hash["#{request_path}_request", request_structure]
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module GenesisRuby
         class Financial < Request
 
           include Mixins::Requests::Financial::BaseAttributes
+          include Mixins::Requests::Financial::PaymentAttributes
 
           # Use Smart Router endpoint for the current request
           def use_smart_router
@@ -48,6 +49,7 @@ module GenesisRuby
             super
           end
 
+          # Populate the request structure
           def populate_structure
             self.tree_structure = {
               payment_transaction: {
@@ -55,7 +57,7 @@ module GenesisRuby
                 transaction_id:   transaction_id,
                 usage:            usage,
                 remote_ip:        remote_ip
-              }.merge(payment_transaction_structure)
+              }.merge(payment_attributes_structure, payment_transaction_structure)
             }
           end
 
@@ -64,6 +66,13 @@ module GenesisRuby
             api_config.url = build_request_url({ subdomain: 'smart_router', path: 'transactions' })
           end
 
+          # Initialize Financial class validations
+          def init_field_validations
+            super
+
+            field_values.merge! currency: Api::Constants::Currencies::Iso4217.all.map(&:upcase)
+          end
+
         end
       end
     end

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

@@ -11,7 +11,6 @@ module GenesisRuby
             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
 
@@ -29,17 +28,16 @@ module GenesisRuby
 
             # Request Field validations
             def init_field_validations
+              super
+
               required_fields.push *%i[transaction_id amount currency]
-              field_values.merge!(
-                { currency: Api::Constants::Currencies::Iso4217.all.map(&:upcase) },
-                credential_on_file_field_validations
-              )
+              field_values.merge! credential_on_file_field_validations
             end
 
             # Credit Card attributes
             def payment_transaction_structure
-              payment_attributes_structure.merge(
-                credit_card_attributes_structure, tokenization_attributes_structure,
+              credit_card_attributes_structure.merge(
+                tokenization_attributes_structure,
                 {
                   account_owner:                             account_owner_attributes_structure,
                   credential_on_file:                        credential_on_file,

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

@@ -9,7 +9,6 @@ module GenesisRuby
             include Api::Mixins::Requests::AddressInfoAttributes
             include Api::Mixins::Requests::Financial::AsyncAttributes
             include Api::Mixins::Requests::BirthDateAttributes
-            include Api::Mixins::Requests::Financial::PaymentAttributes
             include Api::Mixins::Requests::Financial::ConsumerIdentifierAttributes
 
             # Billing Country custom accessor
@@ -36,19 +35,17 @@ module GenesisRuby
             end
 
             # South American payments
-            def payment_transaction_structure # rubocop:disable Metrics/MethodLength
-              payment_attributes_structure.merge(
-                {
-                  return_success_url: return_success_url,
-                  return_failure_url: return_failure_url,
-                  consumer_reference: consumer_reference,
-                  national_id:        national_id,
-                  birth_date:         birth_date,
-                  customer_email:     customer_email,
-                  billing_address:    billing_address_parameters_structure,
-                  shipping_address:   shipping_address_parameters_structure
-                }
-              )
+            def payment_transaction_structure
+              {
+                return_success_url: return_success_url,
+                return_failure_url: return_failure_url,
+                consumer_reference: consumer_reference,
+                national_id:        national_id,
+                birth_date:         birth_date,
+                customer_email:     customer_email,
+                billing_address:    billing_address_parameters_structure,
+                shipping_address:   shipping_address_parameters_structure
+              }
             end
 
           end