spree_emerchantpay_genesis 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c220bb96644c56f0979a39ad4e8465ef9560f5e58c45acf36e89faf4dcafb9d
-  data.tar.gz: 42f7abcc36024c096e88a39a072e57d0138aac80decc629a8278d6b1642616d9
+  metadata.gz: 15b5e5ed86841d728dddc6749dd6829a422e915c9ddca396d3da9f63f8d0cf48
+  data.tar.gz: 31f819b12ba869f0ea706fbec6b55d1d2f77064862f5602c879a04d67317bc1c
 SHA512:
-  metadata.gz: fdbeb22309bc146f4cc8c957eda170fb17249afb73f7fc8e544f8d15a6560a5e22d2ed6a4749c8e0e3bdb455b533a5f8400165db6f812b6706f149addb8dbbce
-  data.tar.gz: 774446783c40d05322b15dd9768fda5db2873ccd2b87320ca75eb4cebee3401a2e1759e17e4d28e02ea8b5420d4e656987a20a1522608623a06820bfee73d94d
+  metadata.gz: 6e9a3a9dd894f4f26f78ded9c05e7d0bd1e7ee9e9339e8abc5c4d8244c1f7be0605959df1fea55f9797e8c7b69b6f8d0e807314441770998acc32d586744e20f
+  data.tar.gz: cce74188db70045556aea1bcdba4516f4f508a40dd6b3d0fdaa0b3e368dcda7ebcadc79f7bc698c830d031ff77c92c0ad2c90f808bfd8ee17d8021df090df9ff

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.1.7
+-----
+**Features**:
+
+* Added the following Mobile transaction types support through the emerchantpay Checkout payment method:
+  * Apple Pay
+  * Google Pay
+  * Pay Pal
+
 0.1.6
 -----
 **Features**:

data/app/helpers/spree_emerchantpay_genesis/mappers/genesis.rb

@@ -214,8 +214,7 @@ module SpreeEmerchantpayGenesis
 
       # Map WPF Transaction Types
       def transaction_types_attributes(options, source)
-        custom_attributes = source.public_metadata
-        transaction_types = PaymentMethodHelper.select_options_value options, :transaction_types
+        transaction_types, custom_attributes = wpf_selected_transaction_types options, source
 
         transaction_types.each do |type|
           next if type.empty?
@@ -248,6 +247,19 @@ module SpreeEmerchantpayGenesis
         @context.locale = locale.delete_prefix('\'').delete_suffix('\'')
       end
 
+      # Map WPF transaction types selected in the Payment Method Options
+      def wpf_selected_transaction_types(options, source)
+        transaction_types = PaymentMethodHelper.select_options_value options, :transaction_types
+        mobile_types      = PaymentMethodHelper.fetch_wpf_mobile_types transaction_types
+
+        custom_attributes = source.public_metadata.merge mobile_types
+        transaction_types = (transaction_types - Mappers::Transaction.mobile_types_with_payment_sub_types).push(
+          *mobile_types.keys
+        )
+
+        [transaction_types, custom_attributes]
+      end
+
     end
   end
 end

data/app/helpers/spree_emerchantpay_genesis/mappers/transaction.rb

@@ -16,6 +16,16 @@ module SpreeEmerchantpayGenesis
         GenesisRuby::Api::Constants::Transactions::VOID
       ].freeze
 
+      MOBILE_TYPES = [
+        GenesisRuby::Api::Constants::Transactions::GOOGLE_PAY,
+        GenesisRuby::Api::Constants::Transactions::APPLE_PAY,
+        GenesisRuby::Api::Constants::Transactions::PAY_PAL
+      ].freeze
+
+      MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE = 'authorize'.freeze
+      MOBILE_PAYMENT_SUB_TYPE_SALE      = 'sale'.freeze
+      MOBILE_PAYMENT_SUB_TYPE_EXPRESS   = 'express'.freeze
+
       # Provide transaction class object from the given type
       def self.for(transaction_type)
         object_class   = nil
@@ -40,6 +50,56 @@ module SpreeEmerchantpayGenesis
         "GenesisRuby::Api::Requests::Financial::#{transaction_type.capitalize}".constantize
       end
 
+      # Map Web Payment Form Mobile transaction types
+      def self.map_wpf_config_mobile_types(types)
+        MOBILE_TYPES.each { |type| types.delete type }
+
+        types.push(*mobile_types_with_payment_sub_types)
+      end
+
+      # Provides Mobile payment types|subtypes
+      def self.mobile_payment_sub_types
+        %W[
+          _#{Mappers::Transaction::MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE}
+          _#{Mappers::Transaction::MOBILE_PAYMENT_SUB_TYPE_SALE}
+          _#{Mappers::Transaction::MOBILE_PAYMENT_SUB_TYPE_EXPRESS}
+        ]
+      end
+
+      # Provides all Mobile payment types with their subtypes
+      def self.mobile_types_with_payment_sub_types
+        %W[
+          #{GenesisRuby::Api::Constants::Transactions::GOOGLE_PAY}_#{MOBILE_PAYMENT_SUB_TYPE_SALE}
+          #{GenesisRuby::Api::Constants::Transactions::GOOGLE_PAY}_#{MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE}
+          #{GenesisRuby::Api::Constants::Transactions::APPLE_PAY}_#{MOBILE_PAYMENT_SUB_TYPE_SALE}
+          #{GenesisRuby::Api::Constants::Transactions::APPLE_PAY}_#{MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE}
+          #{GenesisRuby::Api::Constants::Transactions::PAY_PAL}_#{MOBILE_PAYMENT_SUB_TYPE_SALE}
+          #{GenesisRuby::Api::Constants::Transactions::PAY_PAL}_#{MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE}
+          #{GenesisRuby::Api::Constants::Transactions::PAY_PAL}_#{MOBILE_PAYMENT_SUB_TYPE_EXPRESS}
+        ]
+      end
+
+      # Extract mobile type from the sub type and return the WPF custom attribute structure
+      def self.extract_mobile_type_with_sub_type(mobile_with_sub_type)
+        mobile_type = mobile_with_sub_type.gsub(/#{Mappers::Transaction.mobile_payment_sub_types.join("|")}/, '')
+
+        Hash[mobile_type, Hash[mobile_subtype_key(mobile_type), mobile_with_sub_type.gsub(/#{mobile_type}_/, '')]]
+      end
+
+      # Returns the Mobile Sub/Type WFP custom attribute
+      def self.mobile_subtype_key(mobile_type)
+        google_pay  = GenesisRuby::Api::Constants::Transactions::GOOGLE_PAY
+        apple_pay   = GenesisRuby::Api::Constants::Transactions::APPLE_PAY
+        pay_pal     = GenesisRuby::Api::Constants::Transactions::PAY_PAL
+
+        case mobile_type
+        when google_pay, apple_pay
+          'payment_subtype'
+        when pay_pal
+          'payment_type'
+        end
+      end
+
     end
   end
 end

data/app/helpers/spree_emerchantpay_genesis/payment_method_helper.rb

@@ -35,6 +35,25 @@ module SpreeEmerchantpayGenesis
         options[key]
       end
 
+      # Provide a list of the available transaction types for the checkout payment method configuration
+      def fetch_wpf_transaction_types
+        Mappers::Transaction.map_wpf_config_mobile_types GenesisRuby::Utils::Transactions::WpfTypes.all
+      end
+
+      # Extract Custom Attributes defined along with the transaction types
+      def fetch_wpf_mobile_types(selected_transaction_types)
+        attributes            = {}
+        selected_mobile_types = selected_transaction_types.intersection(
+          Mappers::Transaction.mobile_types_with_payment_sub_types
+        )
+
+        selected_mobile_types.each do |type|
+          attributes.merge! Mappers::Transaction.extract_mobile_type_with_sub_type type
+        end
+
+        attributes
+      end
+
     end
 
   end

data/app/models/spree/gateway/emerchantpay_checkout.rb

@@ -4,7 +4,7 @@ module Spree
 
     preference :transaction_types, :multi_select,  default: lambda {
       {
-        values:   GenesisRuby::Utils::Transactions::WpfTypes.all,
+        values:   SpreeEmerchantpayGenesis::PaymentMethodHelper.fetch_wpf_transaction_types,
         selected: [GenesisRuby::Api::Constants::Transactions::SALE_3D]
       }
     }

data/app/repositories/spree_emerchantpay_genesis/spree_payments_repository.rb

@@ -35,11 +35,9 @@ module SpreeEmerchantpayGenesis
 
       # Update the Spree Payment status from GenesisRuby::Api::Response object
       def update_payment_status(payment, response, transaction_type)
-        capturable_types = GenesisRuby::Utils::Transactions::References::CapturableTypes
-
         if response.approved?
           action = :complete
-          action = :pend if capturable_types.allowed_reference? transaction_type
+          action = :pend if capturable_type? payment, transaction_type
 
           payment.public_send(action)
         end
@@ -48,6 +46,34 @@ module SpreeEmerchantpayGenesis
         payment.void if response.voided?
       end
 
+      # Determine if the given transaction type need capture reference action
+      def capturable_type?(payment, transaction_type)
+        capturable_types = GenesisRuby::Utils::Transactions::References::CapturableTypes
+
+        if SpreeEmerchantpayGenesis::Mappers::Transaction::MOBILE_TYPES.include? transaction_type
+          return mobile_authorize_type? payment, transaction_type
+        end
+
+        capturable_types.allowed_reference? transaction_type
+      end
+
+      # Determine if the given mobile type is authorize or not
+      def mobile_authorize_type?(payment, transaction_type)
+        transaction_helper    = SpreeEmerchantpayGenesis::Mappers::Transaction
+        selected_mobile_types = SpreeEmerchantpayGenesis::PaymentMethodHelper.fetch_wpf_mobile_types(
+          payment.payment_method.preferred_transaction_types
+        )
+
+        if selected_mobile_types.is_a?(Hash) && selected_mobile_types.key?(transaction_type)
+          custom_attribute     = selected_mobile_types[transaction_type.to_s]
+          custom_attribute_key = transaction_helper.mobile_subtype_key transaction_type
+
+          return custom_attribute[custom_attribute_key.to_s] == transaction_helper::MOBILE_PAYMENT_SUB_TYPE_AUTHORIZE
+        end
+
+        false
+      end
+
     end
 
   end

data/config/locales/en.yml

@@ -75,6 +75,13 @@ en:
       webmoney: Webmoney
       webpay: Webpay
       wechat: Wechat
+      google_pay_authorize: Google Pay (Authorize)
+      google_pay_sale: Google Pay (Sale)
+      apple_pay_authorize: Apple Pay (Authorize)
+      apple_pay_sale: Apple Pay (Sale)
+      pay_pal_authorize: Pay Pal (Authorize)
+      pay_pal_sale: Pay Pal (Sale)
+      pay_pal_express: Pay Pal (Express)
       ar: Arabic
       bg: Bulgarian
       de: German

data/lib/spree_emerchantpay_genesis/version.rb

@@ -1,7 +1,7 @@
 # :nocov:
 module SpreeEmerchantpayGenesis
 
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.1.7'.freeze
 
 end
 # :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_emerchantpay_genesis
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - emerchantpay ltd.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: genesis_ruby
@@ -45,6 +45,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +55,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +65,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +75,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
@@ -401,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.4.10
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: emerchantpay Gateway Module for Spree