genesis_ruby 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16e207efd1721cd293a6749709104f57410f684e5bbb3d0b3378001cdfe5d19
-  data.tar.gz: 495b1333514eecfc206cac7ae713b9593fdd886233ef840be3af610f499f80c8
+  metadata.gz: 3bae58236ea63ffb79254010e7dd8651252a8f128eb3c9e245eaf6cc4588c426
+  data.tar.gz: e9bc31285e5acceefe5df452d274445f6b88e3039115d313ea1361b9990cc149
 SHA512:
-  metadata.gz: 58dba79785a36d57714cf28f6b56878cbf2c8a748584bf7c5e0a4440775c77b39db44eb0a3cf645b399aef81ca3e84967ea05be8e513014b7498ae61a078eec4
-  data.tar.gz: 8fea90819598e5f3830de518c4a044fbbf2f7c83dc96f56fe1b1b9c2479a157f095fe5ec1cc8b9fddc4de51a80bbaad0167fe9c84df77f5b0e79652fcf6bc5f6
+  metadata.gz: 235e870d4dc316eface0f780352fe0129293740742ab45b6638d839cf51cbd9296e193be9a9cf533da6f1c089e39885e47fbf4220523a715a1db8c3c821a3b6c
+  data.tar.gz: 346de3c0848acea9c8394323b8377fc1fb86eab52fa125f30586dcb71bf0f2422d7f128fe3152547284274ca5eddde44a1a1d96206d9391bcf65525669f46529

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.1.6
+-----
+**Features**:
+
+* Added Web Payment Form `lifetime` validations with a maximum allowed value of 3 months in minutes (131487)
+* Added Web Payment Form `lifetime` default value of 30 minutes
+* Added Web Payment Form Reminders support
+* Added Pay Later parameter support to the Web Payment Form
+  * Reminders will be sent to the Gateway only when `pay_later=true`
+* Added Reminder Language parameter support to the Web Payment Form. It accepts only available WPF locales.
+* Added validation for Web Payment Form `locale` attribute. It accepts only available WPF locales.
+
 0.1.5
 -----
 **Features**:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    genesis_ruby (0.1.5)
+    genesis_ruby (0.1.6)
       net-http (~> 0.3.2)
       nokogiri (~> 1.14)
 
@@ -12,7 +12,7 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.7)
     concurrent-ruby (1.2.3)
     crack (1.0.0)
       bigdecimal
@@ -34,7 +34,7 @@ GEM
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
@@ -45,7 +45,7 @@ GEM
       ruby2_keywords (~> 0.0.1)
     net-http (0.3.2)
       uri
-    nokogiri (1.15.5)
+    nokogiri (1.15.6)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (7.2.0)
@@ -68,7 +68,7 @@ GEM
       rubocop (>= 0.63.1, < 2.0)
     public_suffix (5.0.4)
     racc (1.7.3)
-    rack (2.2.8.1)
+    rack (2.2.9)
     rack-protection (3.2.0)
       base64 (>= 0.1.0)
       rack (~> 2.2, >= 2.2.4)
@@ -91,7 +91,7 @@ GEM
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.61.0)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -99,10 +99,10 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.1)
+    rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
@@ -111,7 +111,7 @@ GEM
     rubocop-faker (1.1.0)
       faker (>= 2.12.0)
       rubocop (>= 0.82.0)
-    rubocop-rspec (2.27.0)
+    rubocop-rspec (2.27.1)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)

data/README.md

@@ -98,6 +98,11 @@ begin
     # Other
     request.lifetime            = 30
     request.web_payment_form_id = '987654321'
+
+    # Reminders
+    request.pay_later           = true
+    request.add_reminder channel: 'email', after: 10
+    request.add_reminder channel: 'sms', after: 30
   end.execute
   
   puts genesis.response.response_object

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

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

@@ -0,0 +1,90 @@
+module GenesisRuby
+  module Api
+    module Constants
+      # WPF localization constants
+      class I18n
+
+        extend Mixins::Constants::Common
+
+        # Arabic
+        AR = 'ar'.freeze
+
+        # Bulgarian
+        BG = 'bg'.freeze
+
+        # German
+        DE = 'de'.freeze
+
+        # English
+        EN = 'en'.freeze
+
+        # Spanish
+        ES = 'es'.freeze
+
+        # French
+        FR = 'fr'.freeze
+
+        # Hindu
+        HI = 'hi'.freeze
+
+        # Japanese
+        JA = 'ja'.freeze
+
+        # Icelandic
+        IS = 'is'.freeze
+
+        # Italian
+        IT = 'it'.freeze
+
+        # Dutch
+        NL = 'nl'.freeze
+
+        # Portuguese
+        PT = 'pt'.freeze
+
+        # Polish
+        PL = 'pl'.freeze
+
+        # Russian
+        RU = 'ru'.freeze
+
+        # Turkish
+        TR = 'tr'.freeze
+
+        # Mandarin Chinese
+        ZH = 'zh'.freeze
+
+        # Indonesian
+        ID = 'id'.freeze
+
+        # Malay
+        MS = 'ms'.freeze
+
+        # Thai
+        TH = 'th'.freeze
+
+        # Czech
+        CS = 'cs'.freeze
+
+        # Croatian
+        HR = 'hr'.freeze
+
+        # Slovenian
+        SL = 'sl'.freeze
+
+        # Finnish
+        FI = 'fi'.freeze
+
+        # Norwegian
+        NO = 'no'.freeze
+
+        # Danish
+        DA = 'da'.freeze
+
+        # Swedish
+        SV = 'sv'.freeze
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/wpf/reminder_channels.rb

@@ -0,0 +1,24 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          module Wpf
+            # Channel for sending WPF reminder. Valid values are ’email’ and ’sms’
+            class ReminderChannels
+
+              extend Mixins::Constants::Common
+
+              # Channel email
+              EMAIL = 'email'.freeze
+
+              # Channel sms
+              SMS   = 'sms'.freeze
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'genesis_ruby/utils/options/reminder'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Settings for reminders sending when using the ’Pay Later’ feature
+        module WpfRemindersAttributes
+
+          attr_reader :reminder_language
+          attr_writer :reminders
+
+          # It must be a valid language abbreviation
+          def reminder_language=(value)
+            allowed_options attribute: __method__,
+                            allowed: Api::Constants::I18n.all,
+                            value: value.to_s.downcase,
+                            allow_empty: true
+          end
+
+          # Settings for a single reminder. Upto three reminders are allowed
+          def add_reminder(channel:, after:)
+            raise InvalidArgumentError, 'Reminders exceed the allowed count of 3.' if reminders.count >= 3
+
+            reminders << init_reminder(channel: channel, after: after)
+          end
+
+          protected
+
+          # Reminders structure
+          def reminders_structure
+            return reminders if reminders.empty?
+
+            reminders.map &:object_structure
+          end
+
+          private :reminders=
+
+          # Reminder Data Object
+          def init_reminder(channel:, after:)
+            reminder = Utils::Options::Reminder.new
+
+            reminder.channel = channel
+            reminder.after   = after.to_i
+
+            reminder
+          end
+
+          # The number of the sent reminders would be exactly as sent or configured and delivery failures could be
+          # handled on demand. Also there will be no reminders sent if the WPF is already completed
+          def reminders
+            @reminders ||= []
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/wpf/create.rb

@@ -1,5 +1,7 @@
 require 'genesis_ruby/utils/transactions/wpf_types'
 require 'genesis_ruby/api/constants/transactions/parameters/sca_exemptions'
+require 'genesis_ruby/api/constants/i18n'
+require 'genesis_ruby/api/mixins/requests/wpf_reminders_attributes'
 
 module GenesisRuby
   module Api
@@ -19,10 +21,17 @@ module GenesisRuby
           include Mixins::Requests::Financial::DynamicDescriptorAttributes
           include Mixins::Requests::Financial::RiskAttributes
           include Mixins::Requests::Financial::Business::BusinessAttributes
+          include Mixins::Requests::WpfRemindersAttributes
 
           attr_reader   :locale, :sca_preference, :sca_exemption
           attr_accessor :transaction_id, :usage, :description, :consumer_id, :return_cancel_url, :remember_card,
-                        :lifetime, :web_payment_form_id
+                        :web_payment_form_id
+
+          MAX_LIFETIME     = 131_487
+          DEFAULT_LIFETIME = 30
+
+          private_constant :MAX_LIFETIME
+          private_constant :DEFAULT_LIFETIME
 
           # The transaction types that the merchant is willing to accept payments for
           def add_transaction_type(name, custom_attributes = {})
@@ -37,7 +46,12 @@ module GenesisRuby
 
           # Define ISO 639-1 language code to the URL
           def locale=(value)
-            init_api_wpf_configuration(language: value.to_s.downcase)
+            allowed_options attribute: __method__,
+                            allowed: Constants::I18n.all,
+                            value: value.to_s.downcase,
+                            allow_empty: true
+
+            init_api_wpf_configuration(language: locale)
           end
 
           # Signifies whether to perform SCA on the transaction. At least one 3DS transaction type has to be submitted.
@@ -59,6 +73,41 @@ module GenesisRuby
                             allow_empty: true
           end
 
+          # Signifies whether the ’Pay Later’ feature would be enabled on the WPF
+          def pay_later
+            @pay_later ||= false
+
+            return nil unless @pay_later
+
+            @pay_later
+          end
+
+          # Signifies whether the ’Pay Later’ feature would be enabled on the WPF
+          def pay_later=(value)
+            allowed_options attribute: __method__,
+                            allowed: [true, false],
+                            value: value,
+                            allow_empty: true,
+                            error_message: 'Accepts only boolean values'
+          end
+
+          # A number of minutes determining how long the WPF will be valid. Will be set to 30 minutes by default.
+          def lifetime
+            @lifetime ||= DEFAULT_LIFETIME
+          end
+
+          # A number of minutes determining how long the WPF will be valid. Will be set to 30 minutes by default.
+          def lifetime=(value)
+            lifetime = value.to_i
+
+            if lifetime < 1 || lifetime > MAX_LIFETIME
+              raise InvalidArgumentError,
+                    "Valid value ranges between 1 minute and 3 months (#{MAX_LIFETIME} minutes) given in minutes"
+            end
+
+            @lifetime = lifetime
+          end
+
           protected
 
           # Load base configuration
@@ -86,6 +135,8 @@ module GenesisRuby
               raise ParameterError, "Invalid Currency given with value #{currency}"
             end
 
+            validate_reminders
+
             super
           end
 
@@ -121,7 +172,9 @@ module GenesisRuby
                 recurring_category:        recurring_category,
                 dynamic_descriptor_params: dynamic_descriptor_structure,
                 risk_params:               risk_parameters_structure,
-                account_owner:             account_owner_attributes_structure
+                account_owner:             account_owner_attributes_structure,
+                pay_later:                 pay_later,
+                reminders:                 pay_later ? reminders_structure : []
               }
             }
           end
@@ -137,6 +190,20 @@ module GenesisRuby
             @transaction_types.push(value)
           end
 
+          # Validate Reminders against the lifetime
+          def validate_reminders
+            return if lifetime.nil?
+
+            reminders.each do |reminder|
+              next unless reminder.after >= lifetime
+
+              raise(
+                ParameterError,
+                "Reminder (#{reminder.after} min) could not be greater than or equal to lifetime (#{lifetime} min)."
+              )
+            end
+          end
+
         end
       end
     end

data/lib/genesis_ruby/utils/options/reminder.rb

@@ -0,0 +1,60 @@
+require 'genesis_ruby/utils/options/base'
+require 'genesis_ruby/api/constants/transactions/parameters/wpf/reminder_channels'
+
+module GenesisRuby
+  module Utils
+    module Options
+      # Single reminder data object
+      class Reminder < Base
+
+        # Min After minutes
+        MIN_AFTER = 1
+        # Max After minutes
+        MAX_AFTER = 31 * 24 * 60
+
+        def []=(key, value)
+          unless available_keys.include? key.to_s
+            raise InvalidArgumentError, "Invalid Reminder Key given! Allowed: #{available_keys.join(", ")}"
+          end
+
+          __send__ "validate_#{key}", value
+
+          super(key.to_sym, value)
+        end
+
+        # Single Reinder structure
+        def object_structure
+          { reminder: self }
+        end
+
+        private
+
+        # Available Reminder Data keys
+        def available_keys
+          %w(channel after)
+        end
+
+        # Validate Channel value
+        def validate_channel(value)
+          return if Api::Constants::Transactions::Parameters::Wpf::ReminderChannels.all.include? value
+
+          raise InvalidArgumentError,
+                "Invalid Reminder Channel given. Allowed values: #{
+                  Api::Constants::Transactions::Parameters::Wpf::ReminderChannels.all.join(", ")
+                }"
+        end
+
+        # Number of minutes after WPF creation when the reminder should be sent.
+        # Valid value ranges between 1 minute and 31 days given in minutes
+        def validate_after(value)
+          value_int = value.to_i
+
+          return if value_int >= MIN_AFTER && value_int <= MAX_AFTER
+
+          raise InvalidArgumentError, 'Invalid After value given. Allowed integer between 1 and 31'
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/version.rb

@@ -1,5 +1,5 @@
 module GenesisRuby
 
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genesis_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - emerchantpay Ltd.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -240,6 +240,7 @@ files:
 - lib/genesis_ruby/api/constants/date_time_formats.rb
 - lib/genesis_ruby/api/constants/endpoints.rb
 - lib/genesis_ruby/api/constants/environments.rb
+- lib/genesis_ruby/api/constants/i18n.rb
 - lib/genesis_ruby/api/constants/states.rb
 - lib/genesis_ruby/api/constants/states/state.rb
 - lib/genesis_ruby/api/constants/transactions.rb
@@ -270,6 +271,7 @@ files:
 - lib/genesis_ruby/api/constants/transactions/parameters/threeds/version2/purchase/categories.rb
 - lib/genesis_ruby/api/constants/transactions/parameters/threeds/version2/sdk/interfaces.rb
 - lib/genesis_ruby/api/constants/transactions/parameters/threeds/version2/sdk/ui_types.rb
+- lib/genesis_ruby/api/constants/transactions/parameters/wpf/reminder_channels.rb
 - lib/genesis_ruby/api/mixins/constants/common.rb
 - lib/genesis_ruby/api/mixins/requests/address_info_attributes.rb
 - lib/genesis_ruby/api/mixins/requests/attribute_validation.rb
@@ -317,6 +319,7 @@ files:
 - lib/genesis_ruby/api/mixins/requests/financial/threeds/version2/sdk.rb
 - lib/genesis_ruby/api/mixins/requests/financial/threeds/version2/wpf_attributes.rb
 - lib/genesis_ruby/api/mixins/requests/restricted_setter.rb
+- lib/genesis_ruby/api/mixins/requests/wpf_reminders_attributes.rb
 - lib/genesis_ruby/api/notification.rb
 - lib/genesis_ruby/api/request.rb
 - lib/genesis_ruby/api/requests/base/financial.rb
@@ -374,6 +377,7 @@ files:
 - lib/genesis_ruby/utils/options/api_config.rb
 - lib/genesis_ruby/utils/options/base.rb
 - lib/genesis_ruby/utils/options/network_adapter_config.rb
+- lib/genesis_ruby/utils/options/reminder.rb
 - lib/genesis_ruby/utils/threeds/v2.rb
 - lib/genesis_ruby/utils/transactions/financial_types.rb
 - lib/genesis_ruby/utils/transactions/references/capturable_types.rb