genesis_ruby 0.2.6 → 0.2.8

data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/kyc_billing_info_attributes.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Kyc
+            # Mixin KycBillingInfoAttributes for KYC Non-Financial API services
+            module KycBillingInfoAttributes
+
+              attr_accessor :billing_first_name, :billing_last_name, :billing_address1, :billing_address2,
+                            :billing_city, :billing_province, :billing_zip_code, :billing_birth_date
+              attr_reader   :billing_customer_email, :billing_country, :billing_gender, :billing_phone1
+
+              # Sets the billing_customer_email attribute
+              def billing_customer_email=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /\A.+@.+\..+\Z/
+
+                @billing_customer_email = value
+              end
+
+              # Sets the billing_country attribute
+              def billing_country=(value)
+                allowed_options(
+                  attribute: __method__,
+                  allowed: GenesisRuby::Utils::Country::COUNTRIES.keys,
+                  value: value,
+                  error_message: 'Invalid country code for Create Transaction billing country',
+                  allow_empty: true
+                )
+              end
+
+              # Sets the billing_gender attribute
+              def billing_gender=(value)
+                allowed_options(
+                  attribute: __method__,
+                  allowed: Api::Constants::NonFinancial::Kyc::Genders.all,
+                  value: value,
+                  error_message: 'Invalid gender for Create Transaction billing gender',
+                  allow_empty: true
+                )
+              end
+
+              # Sets the billing_phone1 attribute
+              def billing_phone1=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /^\d+$/
+
+                @billing_phone1 = value
+              end
+
+              protected
+
+              # Returns KYC billing information structure
+              def kyc_billing_info_structure # rubocop:disable Metrics/MethodLength
+                {
+                  first_name:     billing_first_name,
+                  last_name:      billing_last_name,
+                  customer_email: billing_customer_email,
+                  address1:       billing_address1,
+                  address2:       billing_address2,
+                  city:           billing_city,
+                  province:       billing_province,
+                  zip_code:       billing_zip_code,
+                  country:        billing_country,
+                  phone1:         billing_phone1,
+                  birth_date:     billing_birth_date,
+                  gender:         billing_gender
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/kyc_shipping_info_attributes.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Kyc
+            # Mixin KycShippingInfoAttributes for KYC Non-Financial API services
+            module KycShippingInfoAttributes
+
+              attr_accessor :shipping_first_name, :shipping_last_name, :shipping_address1, :shipping_address2,
+                            :shipping_city, :shipping_province, :shipping_zip_code
+              attr_reader   :shipping_customer_email, :shipping_country, :shipping_phone1
+
+              # Sets the shipping customer email
+              def shipping_customer_email=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /\A.+@.+\..+\Z/
+
+                @shipping_customer_email = value
+              end
+
+              # Sets the shipping country attribute
+              def shipping_country=(value)
+                allowed_options(
+                  attribute: __method__,
+                  allowed: GenesisRuby::Utils::Country::COUNTRIES.keys,
+                  value: value,
+                  error_message: 'Invalid country code for Create Transaction shipping country',
+                  allow_empty: true
+                )
+              end
+
+              # Sets the shipping_gender attribute
+              def shipping_gender=(value)
+                allowed_options(
+                  attribute: __method__,
+                  allowed: Api::Constants::NonFinancial::Kyc::Genders.all,
+                  value: value,
+                  error_message: 'Invalid gender for Create Transaction shipping gender',
+                  allow_empty: true
+                )
+              end
+
+              # Sets the shipping_phone1 attribute
+              def shipping_phone1=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /^\d+$/
+
+                @shipping_phone1 = value
+              end
+
+              protected
+
+              # Returns KYC Shipping Information structure
+              def kyc_shipping_info_structure # rubocop:disable Metrics/MethodLength
+                {
+                  first_name:     shipping_first_name,
+                  last_name:      shipping_last_name,
+                  customer_email: shipping_customer_email,
+                  address1:       shipping_address1,
+                  address2:       shipping_address2,
+                  city:           shipping_city,
+                  province:       shipping_province,
+                  zip_code:       shipping_zip_code,
+                  country:        shipping_country,
+                  phone1:         shipping_phone1
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/payment_details_attributes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Kyc
+            # Payment Details Attributes mixin for KYC Non-Financial API services
+            module PaymentDetailsAttributes
+
+              attr_accessor :bin, :tail, :cvv_present, :hashed_pan, :routing, :account, :ewallet_id
+
+              # Returns the payment details structure
+              def payment_details_structure
+                {
+                  bin:         bin,
+                  tail:        tail,
+                  cvv_present: cvv_present,
+                  hashed_pan:  hashed_pan,
+                  routing:     routing,
+                  account:     account,
+                  ewallet_id:  ewallet_id
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/verification_attributes.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/document_supported_types'
+require 'genesis_ruby/utils/country'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Kyc
+            # Common Verification Attributes mixin
+            module VerificationAttributes
+
+              attr_accessor :reference_id
+              attr_reader   :email, :backside_proof_required, :country
+
+              # User's email
+              def email=(value)
+                parse_email attribute: __method__, value: value
+              end
+
+              # Signifies that both sides of the document are required to verify the identity
+              def backside_proof_required=(value)
+                allowed_options attribute:     __method__,
+                                allowed:       [true, false],
+                                value:         value,
+                                allow_empty:   true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              # Document's expiry date
+              def expiry_date
+                @expiry_date&.strftime(
+                  Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+                )
+              end
+
+              # Document's expiry date
+              def expiry_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Supported types of document that can be verified
+              def document_supported_types=(value)
+                parse_array_of_strings attribute:   __method__,
+                                       value:       value,
+                                       allowed:     Api::Constants::NonFinancial::Kyc::DocumentSupportedTypes.all,
+                                       allow_empty: true
+              end
+
+              # Supported types of document that can be verified
+              def document_supported_types
+                @document_supported_types || []
+              end
+
+              # Country code
+              def country=(value)
+                allowed_options attribute:     __method__,
+                                allowed:       GenesisRuby::Utils::Country::COUNTRIES.keys,
+                                value:         value,
+                                error_message: 'Invalid country code',
+                                allow_empty:   true
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/verification_document_attributes.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Kyc
+            # Data used by the document verification service to check
+            # the authenticity of identity documents submitted by customers
+            module VerificationDocumentAttributes
+
+              attr_accessor :document_first_name, :document_last_name
+              attr_reader   :document_allow_offline, :document_allow_online
+
+              # Customer's date of birth
+              def document_date_of_birth
+                @document_date_of_birth&.strftime(
+                  GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+                )
+              end
+
+              # Customer's date of birth
+              def document_date_of_birth=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Whether uploading of previously taken picture is allowed for verification of document
+              def document_allow_offline=(value)
+                allowed_options attribute:     __method__,
+                                allowed:       [true, false],
+                                value:         value,
+                                allow_empty:   true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              # Whether the realtime usage of device camera is allowed for verification of document
+              def document_allow_online=(value)
+                allowed_options attribute:     __method__,
+                                allowed:       [true, false],
+                                value:         value,
+                                allow_empty:   true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              protected
+
+              # Defines the structure of the document attributes
+              def verification_document_attributes_structure
+                {
+                  first_name:    document_first_name,
+                  last_name:     document_last_name,
+                  date_of_birth: document_date_of_birth,
+                  allow_offline: document_allow_offline,
+                  allow_online:  document_allow_online
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Mixins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Mixins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Mixins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Mixins

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Mixins
@@ -17,14 +19,7 @@ module GenesisRuby
 
               # 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
+                parse_email attribute: __method__, value: value, allow_empty: true
               end
 
               protected

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/constants/date_time_formats'
 require 'genesis_ruby/utils/common'
 
@@ -79,6 +81,16 @@ module GenesisRuby
             assign_instance_variable attribute, value
           end
 
+          # Parses given value to a valid email address and assign it to the given attribute
+          # If allow_empty is true, it will assign nil if the value is empty
+          def parse_email(attribute:, value:, allow_empty: false)
+            return assign_instance_variable attribute, nil if allow_empty && value.to_s.empty?
+
+            raise InvalidArgumentError, "#{attribute} must be a valid email address." unless value =~ /\A.+@.+\..+\Z/
+
+            assign_instance_variable attribute, value
+          end
+
           private
 
           # Helper for assigning a attribute to the class instance

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Smart Router Attributes Mixin
+        module SmartRouterAttributes
+
+          # Use Smart Router endpoint for the current request
+          def use_smart_router
+            @use_smart_router ||= false
+          end
+
+          # Use Smart Router endpoint for the current request
+          def use_smart_router=(value)
+            unless [true, false].include? value
+              raise InvalidArgumentError, 'Given invalid Use Smart Routing value! Allowed: true, false'
+            end
+
+            @use_smart_router = value
+          end
+
+          protected
+
+          # Process the request
+          def process_request_parameters
+            init_api_smart_router_configuration if use_smart_router
+
+            super
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/utils/options/reminder'
 
 module GenesisRuby

data/lib/genesis_ruby/api/notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'digest'
 
@@ -9,14 +11,14 @@ module GenesisRuby
       attr_reader :unique_id, :notification, :reconciliation
 
       # Signature algorithms
-      SHA1_SIGNATURE_TYPE   = 'SHA1'.freeze
-      SHA256_SIGNATURE_TYPE = 'SHA256'.freeze
-      SHA512_SIGNATURE_TYPE = 'SHA512'.freeze
+      SHA1_SIGNATURE_TYPE   = 'SHA1'
+      SHA256_SIGNATURE_TYPE = 'SHA256'
+      SHA512_SIGNATURE_TYPE = 'SHA512'
 
       # Possible request/response identifier fields
-      API_UNIQUE_FIELD = 'unique_id'.freeze
-      WPF_UNIQUE_FIELD = 'wpf_unique_id'.freeze
-      KYC_UNIQUE_FIELD = 'reference_id'.freeze
+      API_UNIQUE_FIELD = 'unique_id'
+      WPF_UNIQUE_FIELD = 'wpf_unique_id'
+      KYC_UNIQUE_FIELD = 'reference_id'
 
       # Class constructor
       def initialize(configuration, data)

data/lib/genesis_ruby/api/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/utils/options/api_config'
 require 'genesis_ruby/errors/endpoint_not_set_error'
 require 'genesis_ruby/builder'
@@ -12,15 +14,16 @@ module GenesisRuby
       include Mixins::Requests::RestrictedSetter
       include Mixins::Requests::AttributeValidation
 
-      PROTOCOL_HTTPS = 'https'.freeze
+      PROTOCOL_HTTPS = 'https'
       PORT_HTTPS     = 443
 
-      METHOD_POST    = 'POST'.freeze
-      METHOD_GET     = 'GET'.freeze
-      METHOD_PUT     = 'PUT'.freeze
+      METHOD_POST    = 'POST'
+      METHOD_GET     = 'GET'
+      METHOD_PUT     = 'PUT'
+      METHOD_PATCH   = 'PATCH'
 
-      AUTH_TYPE_BASIC = 'basic'.freeze
-      AUTH_TYPE_TOKEN = 'bearer'.freeze
+      AUTH_TYPE_BASIC = 'basic'
+      AUTH_TYPE_TOKEN = 'bearer'
 
       attr_reader :api_config
 
@@ -83,6 +86,11 @@ module GenesisRuby
         @api_config.load_graphql_config
       end
 
+      # Pre-defined PATCH Request Configuration
+      def init_patch_configuration
+        @api_config.load_patch_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/consumer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests
@@ -7,20 +9,7 @@ module GenesisRuby
 
           include Mixins::Requests::Financial::BaseAttributes
           include Mixins::Requests::Financial::PaymentAttributes
-
-          # Use Smart Router endpoint for the current request
-          def use_smart_router
-            @use_smart_router ||= false
-          end
-
-          # Use Smart Router endpoint for the current request
-          def use_smart_router=(value)
-            unless [true, false].include? value
-              raise InvalidArgumentError, 'Given invalid Use Smart Routing value! Allowed: true, false'
-            end
-
-            @use_smart_router = value
-          end
+          include Mixins::Requests::SmartRouterAttributes
 
           protected
 
@@ -42,13 +31,6 @@ module GenesisRuby
             init_api_smart_router_configuration if @configuration.force_smart_routing
           end
 
-          # Process the request
-          def process_request_parameters
-            init_api_smart_router_configuration if use_smart_router
-
-            super
-          end
-
           # Populate the request structure
           def populate_structure
             self.tree_structure = {

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

data/lib/genesis_ruby/api/requests/base/non_financial/kyc/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests
@@ -5,7 +7,7 @@ module GenesisRuby
         # Base Versioned Request class used for Non Financial JSON API services
         class Versioned < Request
 
-          DEFAULT_VERSION = 'v1'.freeze
+          DEFAULT_VERSION = 'v1'
           private_constant :DEFAULT_VERSION
 
           attr_reader :version, :allowed_versions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

data/lib/genesis_ruby/api/requests/financial/cards/argencard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

data/lib/genesis_ruby/api/requests/financial/cards/aura.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

data/lib/genesis_ruby/api/requests/financial/cards/authorize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/requests/base/financials/credit_card'
 
 module GenesisRuby

data/lib/genesis_ruby/api/requests/financial/cards/authorize3d.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/requests/base/financials/credit_card'
 
 module GenesisRuby

data/lib/genesis_ruby/api/requests/financial/cards/bancontact.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests