spree_emerchantpay_genesis 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9deca475addd04cfdc51f7185d69c3d6fd031b8ee69becf096905f883f34ef5b
-  data.tar.gz: 3543891820d71bf926c0d33d9ef4b9dd2b960a320ac1475d9a80aed3d73ffb3b
+  metadata.gz: d2dbd23a908a23677fb4ee2bea0a49cc739052aa5d882e57b7c532d57c480602
+  data.tar.gz: d6b2c2fbbe86dcc820946edda7c79d7ff34b83ba702e0b678226ad5c87667306
 SHA512:
-  metadata.gz: 4ea32ec52afa0ad5c3189381d87f18bfed25478ab2cca31e967e6f7d67baf4f83d4275477e2a8b20a564ac572d63f466400774e8f8b2ce2b72b15e3834c99efa
-  data.tar.gz: ed907c1c11536ca5ec89980e1535f91a9638b84db018cb8fe7c01a87c6047f855bc31611863eb9493f6ce40f59cf0a164ab7a375699beb7ef7995560aefbff15
+  metadata.gz: '0487117b7c98132dd864200b76d52c9b9c2b678244726bb6386a3c4c2c3220de2b729dc3c6f8d767abc46bf460c6655e158c301664777b10cf71d6a22f9268a9'
+  data.tar.gz: 861e78025ac386920634ddacb4c130d2d6285067fb693ddad00da2b9fc897a3e0011999d567795cd385931aada42d280e0e105225c07652bd618d786e282cfbf

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.1.5
+-----
+**Features**:
+
+* Added `emerchantpay Checkout` Description field handling
+* Updated Genesis Ruby SDK to version 0.1.6
+* Updated project dependencies
+* Added `emerchantpay Checkout` Custom Attributes handling
+* Added `emerchantpay Checkout` Language support
+
 0.1.4
 -----
 **Features**:

data/README.md

@@ -7,7 +7,7 @@ This is a Payment Module for Spree eCommerce that gives you the ability to proce
 * Spree FrontEnd - Optional (Tested up to 4.4.0)
 * Ruby >= 2.7
 * Ruby on Rails >= 6.1.4
-* [GenesisRuby v0.1.5](https://github.com/GenesisGateway/genesis_ruby/releases/tag/0.1.5)
+* [GenesisRuby v0.1.6](https://github.com/GenesisGateway/genesis_ruby/releases/tag/0.1.6)
 * PCI-certified server in order to use emerchantpay Direct
 
 ## Installation
@@ -216,7 +216,30 @@ curl --request 'POST' \
 
 #### Create Checkout Payment
 
-The Checkout Gateway doesn't require `source_attributes` (see [p.4 Update Order](#payment-point-4)). Upon Order Update or Payment Create the only required parameter is `payment_method_id`.
+The Checkout Gateway doesn't require `source_attributes` by default (see [p.4 Update Order](#payment-point-4)). Upon Order Update or Payment Create the only required parameter is `payment_method_id`.
+
+In some cases, the Gateway Web Payment Form may require Custom Attributes. Those attributes can be passed to the gateway via `api/v2/storefront/checkout/create_payment`.
+public_metadata contains a list with custom attributes where the key is the transaction type chosen on the payment method configuration inside the administration backend.
+
+```bash
+curl --request 'POST' \
+  --header 'Accept: application/vnd.api+json' \
+  --header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
+  --header 'Content-Type: application/vnd.api+json' \
+  --url 'http://localhost:4000/api/v2/storefront/checkout/create_payment' \
+  --data '{
+  "payment_method_id": "8",
+  "source_attributes": {
+    "consumer_id":"123456",
+    "consumer_email": "travis@example.com",
+    "public_metadata": {
+      "sale3d": { "bin": "401200", "tail": "0085"},
+      "trustly_sale": {"return_success_url_target": "top"}
+    }
+  }
+}'
+```
+Full list with the available Custom Attributes for every Transaction Type can be found [here](https://emerchantpay.github.io/gateway-api-docs/#wpf-transaction-types).
 
 The payment can be finished and a request to the Gateway will be sent with one of the Order Next or Complete endpoints.  
 

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

@@ -75,16 +75,15 @@ module SpreeEmerchantpayGenesis
       end
 
       # Map WPF request
-      def map_wpf(order, _source, options)
+      def map_wpf(order, source, options)
         common_attributes order, support_ip: false
+        description_attribute order
         billing_attributes order
         shipping_attributes order
-        asyn_attributes options
-        transaction_types_attributes options
+        asyn_attributes options, is_wpf: true
+        transaction_types_attributes options, source
         threeds_wpf_attributes order, options if ActiveModel::Type::Boolean.new.cast options[:threeds_allowed]
-
-        @context.return_cancel_url  = options[:return_cancel_url]
-        @context.return_pending_url = options[:return_pending_url]
+        wpf_locale_attributes options
 
         self
       end
@@ -181,11 +180,16 @@ module SpreeEmerchantpayGenesis
       end
 
       # Asynchronous attributes
-      def asyn_attributes(options)
+      def asyn_attributes(options, is_wpf: false)
         @context.notification_url   = "#{options[:hostname]}#{api_v2_storefront_emerchantpay_notification_path}"
         @context.return_success_url = options[:return_success_url]
         @context.return_failure_url = options[:return_failure_url]
 
+        if is_wpf
+          @context.return_cancel_url  = options[:return_cancel_url]
+          @context.return_pending_url = options[:return_pending_url]
+        end
+
         nil
       end
 
@@ -209,12 +213,41 @@ module SpreeEmerchantpayGenesis
       end
 
       # Map WPF Transaction Types
-      def transaction_types_attributes(options)
-        options[:transaction_types].each do |type|
-          @context.add_transaction_type type unless type.empty?
+      def transaction_types_attributes(options, source)
+        custom_attributes = source.public_metadata
+        transaction_types = PaymentMethodHelper.select_options_value options, :transaction_types
+
+        transaction_types.each do |type|
+          next if type.empty?
+
+          if custom_attributes.key?(type.to_s) && custom_attributes[type.to_s].is_a?(Hash)
+            @context.add_transaction_type type, custom_attributes[type.to_s].deep_symbolize_keys
+
+            next
+          end
+
+          @context.add_transaction_type type
         end
       end
 
+      # Map WPF Description field
+      def description_attribute(order)
+        items_description = order.line_items.map { |item| ["#{item[:product_name]} x #{item[:quantity]}"] }
+
+        @context.description = items_description.join("\n")
+
+        nil
+      end
+
+      # Map WPF language attributes
+      def wpf_locale_attributes(options)
+        locale = PaymentMethodHelper.select_options_value options, :language
+
+        return unless locale.is_a? String
+
+        @context.locale = locale.delete_prefix('\'').delete_suffix('\'')
+      end
+
     end
   end
 end

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

@@ -5,11 +5,10 @@ module SpreeEmerchantpayGenesis
 
       NESTED_NODES             = %w(billing_address shipping_address line_items user).freeze
       ORDER_ALLOWED_ATTRIBUTES = %w(
-        id currency item_total total user_id token item_count email shipment_total
-        bill_address_id ship_address_id last_ip_address adjustment_total additional_tax_total included_tax_total number
-        customer ip order_id shipping tax subtotal discount name address1 address2 city
-        state zip country phone digital
-        created_at updated_at
+        id currency item_total total user_id token item_count email shipment_total bill_address_id ship_address_id
+        last_ip_address adjustment_total additional_tax_total included_tax_total number customer ip order_id shipping
+        tax subtotal discount name address1 address2 city state zip country phone digital created_at updated_at
+        product_name
       ) + NESTED_NODES
 
       # Prepare Order data used from the Order mapper
@@ -17,7 +16,11 @@ module SpreeEmerchantpayGenesis
         order.attributes.symbolize_keys.merge(
           gateway_options,
           { digital: order.digital? },
-          { line_items: order.line_items.map { |line_item| line_item.attributes.symbolize_keys } },
+          {
+            line_items: order.line_items.map do |line_item|
+              line_item.attributes.symbolize_keys.merge({ product_name: line_item.product.name })
+            end
+          },
           { user: (user ? user.attributes.symbolize_keys : {}) }
         )
       end

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

@@ -71,7 +71,8 @@ module SpreeEmerchantpayGenesis
 
         @context.threeds_v2_control_challenge_window_size =
           fetch_threeds_constant('Control::ChallengeWindowSizes::FULLSCREEN')
-        @context.threeds_v2_control_challenge_indicator   = options[:challenge_indicator]
+        @context.threeds_v2_control_challenge_indicator   =
+          PaymentMethodHelper.select_options_value options, :challenge_indicator
 
         nil
       end

data/app/helpers/spree_emerchantpay_genesis/payment_method_helper.rb

@@ -28,6 +28,13 @@ module SpreeEmerchantpayGenesis
         default_attr
       end
 
+      # Get default values for select options
+      def select_options_value(options, key)
+        return options[key][:selected] if options[key].is_a? Hash
+
+        options[key]
+      end
+
     end
 
   end

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

@@ -3,10 +3,19 @@ module Spree
   class Gateway::EmerchantpayCheckout < SpreeEmerchantpayGenesis::Base::Gateway # rubocop:disable Style/ClassAndModuleChildren
 
     preference :transaction_types, :multi_select,  default: lambda {
-      { values: GenesisRuby::Utils::Transactions::WpfTypes.all }
+      {
+        values:   GenesisRuby::Utils::Transactions::WpfTypes.all,
+        selected: [GenesisRuby::Api::Constants::Transactions::SALE_3D]
+      }
     }
     preference :return_cancel_url, :string, default: 'http://localhost:4000/checkout/payment'
     preference :return_pending_url, :string, default: 'http://localhost:4000/orders/|:ORDER:|'
+    preference :language, :select, default: lambda {
+      {
+        values:   GenesisRuby::Api::Constants::I18n.all,
+        selected: GenesisRuby::Api::Constants::I18n::EN
+      }
+    }
 
     delegate :load_data, :load_source, :load_payment, to: :provider
 

data/app/models/spree_emerchantpay_genesis/base/gateway.rb

@@ -9,7 +9,12 @@ module SpreeEmerchantpayGenesis
       preference :return_failure_url, :string, default: 'http://localhost:4000/checkout/payment?order_number=|:ORDER:|'
       preference :threeds_allowed, :boolean_select, default: true
       preference :challenge_indicator, :select, default: lambda {
-        { values: [:no_preference, :no_challenge_requested, :preference, :mandate] }
+        {
+          values:   GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::Control::
+              ChallengeIndicators.all,
+          selected: GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::Control::
+              ChallengeIndicators::NO_PREFERENCE
+        }
       }
       preference :hostname, :string, default: 'http://127.0.0.1:4000'
       preference :test_mode, :boolean_select, default: true

data/app/services/spree_emerchantpay_genesis/notifications/service_handler.rb

@@ -1,5 +1,3 @@
-require 'spree/gateway/emerchantpay_direct'
-
 module SpreeEmerchantpayGenesis
   module Notifications
     # Notification Handler Service

data/app/services/spree_emerchantpay_genesis/threeds/method_continue.rb

@@ -1,5 +1,3 @@
-require 'spree/gateway/emerchantpay_direct'
-
 module SpreeEmerchantpayGenesis
   module Threeds
     # Method Continue service

data/app/views/spree/admin/payments/source_views/_emerchantpay_checkout.html.erb

@@ -14,6 +14,31 @@
         <th><%= I18n.t('emerchantpay.payments_table.source_consumer_email') %>:</th>
         <td><%= payment.source.consumer_email %></td>
       </tr>
+      <% unless payment.source.public_metadata.empty? %>
+        <tr>
+          <td colspan="2" class="text-center">
+            <h3><%= I18n.t('emerchantpay.payments_table.source_custom_attributes') %></h3>
+            <table class="table border-top-0">
+              <% payment.source.public_metadata.each do |transaction_type, custom_attributes| %>
+                <% next unless custom_attributes.is_a? Hash %>
+                  <tr>
+                    <th class="col-2"><%= transaction_type %></th>
+                    <td class="text-left col-10">
+                      <table class="table">
+                        <% custom_attributes  .each do |attribute, value| %>
+                          <tr>
+                            <td class="col-5"><%= attribute %></td>
+                            <td class="col-7"><%= value %></td>
+                          </tr>
+                        <% end %>
+                      </table>
+                    </td>
+                  </tr>
+              <% end %>
+            </table>
+          </td>
+        </tr>
+      <% end %>
     </table>
   </div>
 </fieldset>

data/config/locales/en.yml

@@ -75,6 +75,32 @@ en:
       webmoney: Webmoney
       webpay: Webpay
       wechat: Wechat
+      ar: Arabic
+      bg: Bulgarian
+      de: German
+      en: English
+      es: Spanish
+      fr: French
+      hi: Hindu
+      ja: Japanese
+      is: Icelandic
+      it: Italian
+      nl: Dutch
+      pt: Portuguese
+      pl: Polish
+      ru: Russian
+      tr: Turkish
+      zh: Mandarin Chinese
+      id: Indonesian
+      ms: Malay
+      th: Thai
+      cs: Czech
+      hr: Croatian
+      sl: Slovenian
+      fi: Finnish
+      "no": Norwegian
+      da: Danish
+      sv: Swedish
     payment:
       usage: Electronic transaction via Spree eCommerce platform
       reference: Reference transaction via Spree eCommerce platform
@@ -96,6 +122,7 @@ en:
       source_name: Name
       source_consumer_id: Consumer ID
       source_consumer_email: Consumer Email
+      source_custom_attributes: Custom Attributes
   spree:
     token: Token
     username: Username

data/lib/spree_emerchantpay_genesis/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_emerchantpay_genesis
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - emerchantpay ltd.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: genesis_ruby
@@ -16,49 +16,32 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.5
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: securerandom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spree_backend
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
@@ -66,9 +49,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
@@ -76,9 +56,6 @@ dependencies:
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
@@ -86,9 +63,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.0
@@ -96,16 +70,16 @@ dependencies:
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -264,16 +238,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement