spree_emerchantpay_genesis 0.1.3 → 0.1.5

data/app/controllers/spree/api/v2/storefront/checkout_controller_decorator.rb

@@ -5,12 +5,31 @@ module Spree
         # Decorate Create Payment action
         module CheckoutControllerDecorator
 
+          def complete
+            spree_authorize! :update, spree_current_order, order_token
+
+            result = complete_service.call(order: spree_current_order)
+
+            return emerchantpay_checkout_handler if result.success? && emerchantpay_checkout_method?
+
+            render_order(result)
+          end
+
+          def next
+            spree_authorize! :update, spree_current_order, order_token
+
+            result = next_service.call(order: spree_current_order)
+
+            return emerchantpay_checkout_handler if result.success? && emerchantpay_checkout_method?
+
+            render_order(result)
+          end
+
           def create_payment
             result = create_payment_service.call(order: spree_current_order, params: params)
 
             if result.success?
-              return emerchantpay_direct_payment_handler if
-                result.value.payment_method.type == Spree::Gateway::EmerchantpayDirect.name
+              return emerchantpay_direct_payment_handler if emerchantpay_direct_method?
 
               render_serialized_payload(201) { serialize_resource(spree_current_order.reload) }
             else
@@ -22,32 +41,42 @@ module Spree
 
           # Handle EmerchantpayDirect Payment Method Create Payment API Call
           def emerchantpay_direct_payment_handler
-            return render_error_payload('You must authenticate in order to create Emerchanptpay payment') if
-              order_token.empty?
-
             spree_authorize! :update, spree_current_order, order_token
 
             # Complete the order. This will call the purchase method with source containing credit card number
             loop { break unless spree_current_order.next }
 
+            return handle_order_state 201 if spree_current_order.completed?
+
+            render_error_payload(spree_current_order.errors[:base].join('|'))
+          end
+
+          # Handle Emerchantpay Checkout Payment Method Next and Complete API Calls
+          def emerchantpay_checkout_handler
             handle_order_state
           end
 
-          # Generate Spree Response
-          def handle_order_state
-            #  spree_current_order.payments.last.source
+          # Check if the payment is made via emerchantpay direct method
+          def emerchantpay_direct_method?
+            spree_current_order&.payments &&
+              spree_current_order.payments.last.payment_method.type == Spree::Gateway::EmerchantpayDirect.name
+          end
+
+          # Check if the payment is made via emerchantpay checkout method
+          def emerchantpay_checkout_method?
+            spree_current_order&.completed? && spree_current_order&.payments &&
+              spree_current_order.payments.last.payment_method.type == Spree::Gateway::EmerchantpayCheckout.name
+          end
 
-            if spree_current_order.completed?
-              return render_serialized_payload(201) do
-                response = serialize_resource(spree_current_order.reload)
+          # Generate Spree Response
+          def handle_order_state(status = 200)
+            render_serialized_payload(status) do
+              response = serialize_resource(spree_current_order.reload)
 
-                response[:data].merge!(build_genesis_response_parameters)
+              response[:data].merge!(build_genesis_response_parameters)
 
-                response
-              end
+              response
             end
-
-            render_error_payload(spree_current_order.errors[:base].join('|'))
           end
 
           # Build additional response parameters

data/app/controllers/spree/api/v2/storefront/emerchantpay_notification_controller.rb

@@ -24,11 +24,11 @@ module Spree
 
           # Validate params
           def validate_params
-            params.require [:unique_id, :signature]
+            params.require [:signature]
           end
 
           # Permit params
-          def process_params
+          def process_params # rubocop:disable Metrics/MethodLength
             @permitted_params = params.permit(
               :transaction_id, :terminal_token, :unique_id, :transaction_type, :status, :signature, :amount,
               :eci, :cvv_result_code, :retrieval_reference_number, :authorization_code, :scheme_transaction_identifier,
@@ -36,7 +36,9 @@ module Spree
               :threeds_concrete_protocol_version, :threeds_method_status, :scheme_response_code, :avs_response_code,
               :avs_response_text, :reference_transaction_unique_id, :threeds_authentication_status_reason_code,
               :card_brand, :card_number, :card_type, :card_subtype, :card_issuing_bank, :card_holder, :expiration_year,
-              :expiration_month
+              :expiration_month, :wpf_unique_id, :payment_transaction_terminal_token, :payment_transaction_unique_id,
+              :payment_transaction_transaction_type, :payment_transaction_amount, :wpf_status, :wpf_transaction_id,
+              :notification_type
             )
           end
 

data/app/helpers/spree/admin/payment_methods_helper.rb

@@ -17,21 +17,16 @@ module Spree
           label_tag(field, Spree.t(field))
           form.select(field, { Spree.t(:enabled) => true, Spree.t(:disabled) => false }, {}, class: 'select2')
         when :select
+          add_select_preference(form, field, options, { class: 'select2' })
+        when :multi_select
           label_tag(field, Spree.t(field))
-          form.select(
-            field,
-            options_for_select(
-              options[:values].map { |key| [I18n.t(key, scope: 'emerchantpay.preferences'), key] }, options[:selected]
-            ),
-            {},
-            class: 'select2'
-          )
+          add_select_preference(form, field, options, { class: 'select2', multiple: true })
         else
           form.text_field(field, preference_field_options(options))
         end
       end
 
-      def preference_field_tag(name, value, options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def preference_field_tag(name, value, options) # rubocop:disable Metrics/MethodLength
         case options[:type]
         when :integer, :string
           text_field_tag(name, value, preference_field_options(options))
@@ -42,9 +37,7 @@ module Spree
           password_field_tag(name, value, preference_field_options(options))
         when :text
           text_area_tag(name, value, preference_field_options(options))
-        when :boolean_select
-          select_tag(name, value, preference_field_options(options))
-        when :select
+        when :boolean_select, :select
           select_tag(name, value, preference_field_options(options))
         else
           text_field_tag(name, value, preference_field_options(options))
@@ -95,9 +88,23 @@ module Spree
         end
       end
 
+      def add_select_preference(form, field, options, html_options)
+        form.select(
+          field,
+          options_for_select(
+            options[:values].map { |key| [I18n.t(key, scope: 'emerchantpay.preferences'), key] }, options[:selected]
+          ),
+          {},
+          html_options
+        )
+      end
+
       def default_preference_support?(object, preference)
         unsupported_default_preferences.include?(preference.to_s) &&
-          object.instance_of?(Spree::Gateway::EmerchantpayDirect)
+          (
+            object.instance_of?(Spree::Gateway::EmerchantpayDirect) ||
+              object.instance_of?(Spree::Gateway::EmerchantpayCheckout)
+          )
       end
 
       # Not Supported preferences from Emerchantpay Gateway

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

@@ -39,10 +39,18 @@ module SpreeEmerchantpayGenesis
         this.map_method_continue emerchantpay_payment
       end
 
+      def self.for_wpf(genesis, order, source, options)
+        this = new genesis
+
+        this.map_wpf order, source, options
+      end
+
       # Replace URL patterns
       def self.for_urls!(options, order_number)
         options[:return_success_url]&.sub! ORDER_REPLACE_PATTERN, order_number
         options[:return_failure_url]&.sub! ORDER_REPLACE_PATTERN, order_number
+        options[:return_cancel_url]&.sub! ORDER_REPLACE_PATTERN, order_number
+        options[:return_pending_url]&.sub! ORDER_REPLACE_PATTERN, order_number
 
         options
       end
@@ -57,14 +65,29 @@ module SpreeEmerchantpayGenesis
         credit_card_attributes source
         billing_attributes order
         shipping_attributes order
-        if TransactionHelper.asyn? @context
-          asyn_attributes options
-          threeds_attributes order, source, options if ActiveModel::Type::Boolean.new.cast options[:threeds_allowed]
+        asyn_attributes options if TransactionHelper.asyn? @context
+
+        if TransactionHelper.asyn?(@context) && ActiveModel::Type::Boolean.new.cast(options[:threeds_allowed])
+          threeds_processing_attributes order, source, options
         end
 
         self
       end
 
+      # Map WPF request
+      def map_wpf(order, source, options)
+        common_attributes order, support_ip: false
+        description_attribute order
+        billing_attributes order
+        shipping_attributes order
+        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]
+        wpf_locale_attributes options
+
+        self
+      end
+
       # Map Reference transaction
       def map_reference(amount, transaction, order)
         @context.transaction_id = TransactionHelper.generate_transaction_id
@@ -82,7 +105,7 @@ module SpreeEmerchantpayGenesis
       def map_config(options)
         @context.username    = options[:username]
         @context.password    = options[:password]
-        @context.token       = options[:token]
+        @context.token       = options[:token] || nil
         @context.environment = fetch_genesis_environment ActiveModel::Type::Boolean.new.cast(options[:test_mode])
         @context.endpoint    = GenesisRuby::Api::Constants::Endpoints::EMERCHANTPAY
 
@@ -101,14 +124,16 @@ module SpreeEmerchantpayGenesis
       private
 
       # Common Genesis Attributes
-      def common_attributes(provider) # rubocop:disable Metrics/AbcSize
+      def common_attributes(provider, support_ip: true) # rubocop:disable Metrics/AbcSize
         @context.transaction_id = TransactionHelper.generate_transaction_id
         @context.amount         = provider.total.to_s
         @context.currency       = provider.currency
         @context.usage          = I18n.t 'usage', scope: 'emerchantpay.payment'
         @context.customer_email = provider.email
         @context.customer_phone = provider.billing_address&.phone
-        @context.remote_ip      = provider.ip
+        @context.remote_ip      = provider.ip if support_ip
+
+        nil
       end
 
       # Credit Card Attributes
@@ -118,6 +143,8 @@ module SpreeEmerchantpayGenesis
         @context.expiration_month = source.month
         @context.expiration_year  = source.year
         @context.cvv              = source.verification_value
+
+        nil
       end
 
       # Billing Attributes
@@ -132,6 +159,8 @@ module SpreeEmerchantpayGenesis
         @context.billing_city       = provider.billing_address.city
         @context.billing_state      = provider.billing_address.state
         @context.billing_country    = provider.billing_address.country
+
+        nil
       end
 
       # Shipping Attributes
@@ -146,12 +175,22 @@ module SpreeEmerchantpayGenesis
         @context.shipping_city       = provider.shipping_address.city
         @context.shipping_state      = provider.shipping_address.state
         @context.shipping_country    = provider.shipping_address.country
+
+        nil
       end
 
-      def asyn_attributes(options)
+      # Asynchronous attributes
+      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
 
       # Fetch Genesis Environments
@@ -163,168 +202,50 @@ module SpreeEmerchantpayGenesis
         end
       end
 
-      # 3DSv2 attributes
-      def threeds_attributes(order, source, options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        user_orders = []
-        @context.threeds_v2_purchase_category = fetch_threeds_category order
-        @context.threeds_v2_method_callback_url =
-          "#{options[:hostname]}#{api_v2_storefront_emerchantpay_threeds_callback_handler_path}"
-        threeds_control_attributes options
-        @context.threeds_v2_merchant_risk_shipping_indicator = fetch_shipping_indicator order
-        @context.threeds_v2_merchant_risk_delivery_timeframe = fetch_delivery_timeframe order
-        threeds_browser_attributes source
-
-        user_orders = SpreeOrderRepository.orders_by_user order.user_id if order.user_id
-        @context.threeds_v2_merchant_risk_reorder_items_indicator = fetch_reorder_items_indicator order, user_orders
-
-        if order.user.empty?
-          @context.threeds_v2_card_holder_account_registration_indicator = GenesisRuby::Api::Constants::Transactions::
-              Parameters::Threeds::Version2::CardHolderAccount::RegistrationIndicators::GUEST_CHECKOUT
-        end
-
-        threeds_card_holder_attributes order, user_orders unless order.user.empty?
-      end
-
-      # 3DSv2 Control attributes
-      def threeds_control_attributes(options)
-        @context.threeds_v2_control_device_type           = GenesisRuby::Api::Constants::Transactions::Parameters::
-            Threeds::Version2::Control::DeviceTypes::BROWSER
-        @context.threeds_v2_control_challenge_window_size =
-          GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::Control::ChallengeWindowSizes::
-              FULLSCREEN
-        @context.threeds_v2_control_challenge_indicator   = options[:challenge_indicator]
+      # 3DSv2 Processing attributes
+      def threeds_processing_attributes(order, source, options)
+        ThreedsAttributes.for_payment @context, order, source, options
       end
 
-      # 3DSv2 Browser attributes
-      def threeds_browser_attributes(source) # rubocop:disable Metrics/AbcSize
-        @context.threeds_v2_browser_accept_header    = source.public_metadata[:accept_header]
-        @context.threeds_v2_browser_java_enabled     = ActiveModel::Type::Boolean.new.cast(
-          source.public_metadata[:java_enabled]
-        )
-        @context.threeds_v2_browser_language         = source.public_metadata[:language]
-        @context.threeds_v2_browser_color_depth      = source.public_metadata[:color_depth]
-        @context.threeds_v2_browser_screen_height    = source.public_metadata[:screen_height]
-        @context.threeds_v2_browser_screen_width     = source.public_metadata[:screen_width]
-        @context.threeds_v2_browser_time_zone_offset = source.public_metadata[:time_zone_offset]
-        @context.threeds_v2_browser_user_agent       = source.public_metadata[:user_agent]
-      end
-
-      # Fetch 3DSv2 Purchase Category
-      def fetch_threeds_category(order)
-        if order.digital
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::Purchase::Categories::SERVICE
-        end
-
-        GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::Purchase::Categories::GOODS
+      # 3DSv2 WPF attributes
+      def threeds_wpf_attributes(order, options)
+        ThreedsAttributes.for_wpf @context, order, options
       end
 
-      # Fetch 3DSv2 Merchant Risk Shipping Indicator
-      def fetch_shipping_indicator(order) # rubocop:disable Metrics/MethodLength
-        if order.digital
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-              ShippingIndicators::DIGITAL_GOODS
-        end
+      # Map WPF Transaction Types
+      def transaction_types_attributes(options, source)
+        custom_attributes = source.public_metadata
+        transaction_types = PaymentMethodHelper.select_options_value options, :transaction_types
 
-        if order.shipping_address&.to_s == order.billing_address&.to_s
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-              ShippingIndicators::SAME_AS_BILLING
-        end
+        transaction_types.each do |type|
+          next if type.empty?
 
-        if order.user_id
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-              ShippingIndicators::STORED_ADDRESS
-        end
+          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
 
-        GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-            ShippingIndicators::OTHER
-      end
+            next
+          end
 
-      # Fetch 3DSv2 Merchant Risk Delivery Timeframe
-      def fetch_delivery_timeframe(order)
-        if order.digital
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-              DeliveryTimeframes::ELECTRONICS
+          @context.add_transaction_type type
         end
-
-        GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::DeliveryTimeframes::
-            ANOTHER_DAY
       end
 
-      # Fetch 3DSv2 Merchant Risk Reorder Items Indicator
-      def fetch_reorder_items_indicator(order, user_orders) # rubocop:disable Metrics/MethodLength
-        unless order.user_id
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-            ReorderItemIndicators::FIRST_TIME
-        end
-
-        variants = []
-        order.line_items.each { |line_item| variants.push line_item[:variant_id] }
-
-        reordered = SpreeEmerchantpayGenesis::SpreeOrderRepository.reordered_variant? order.id, variants, user_orders
+      # Map WPF Description field
+      def description_attribute(order)
+        items_description = order.line_items.map { |item| ["#{item[:product_name]} x #{item[:quantity]}"] }
 
-        if reordered
-          return GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-            ReorderItemIndicators::REORDERED
-        end
+        @context.description = items_description.join("\n")
 
-        GenesisRuby::Api::Constants::Transactions::Parameters::Threeds::Version2::MerchantRisk::
-            ReorderItemIndicators::FIRST_TIME
+        nil
       end
 
-      # 3DSv2 Card Holder Account attributes
-      def threeds_card_holder_attributes(order, user_orders) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        @context.threeds_v2_card_holder_account_creation_date = order.user.created_at_formatted
-
-        # Card Holder last changes with the 3DS requester
-        card_holder_updated_at = ThreedsHelper.fetch_last_change_date(
-          order.user.billing_address, order.user.shipping_address
-        )
-        @context.threeds_v2_card_holder_account_update_indicator = ThreedsHelper.fetch_class_indicator(
-          'UpdateIndicators', card_holder_updated_at
-        )
-        @context.threeds_v2_card_holder_account_last_change_date = card_holder_updated_at
-
-        # Card Holder Password changes
-        @context.threeds_v2_card_holder_account_password_change_indicator = ThreedsHelper.fetch_class_indicator(
-          'PasswordChangeIndicators', order.user.updated_at_formatted
-        )
-        @context.threeds_v2_card_holder_account_password_change_date = order.user.updated_at_formatted
-
-        # Card Holder Shipping Address first time used
-        shipping_address_first_used = ThreedsHelper.fetch_shipping_address_first_used(order.user.shipping_address)
-        @context.threeds_v2_card_holder_account_shipping_address_usage_indicator = ThreedsHelper.fetch_class_indicator(
-          'ShippingAddressUsageIndicators', shipping_address_first_used
-        )
-        @context.threeds_v2_card_holder_account_shipping_address_date_first_used = shipping_address_first_used
-
-        # Card Holder Payments count
-        activity_last24_hours = ThreedsHelper.filter_transaction_activity_24_hours user_orders
-        if activity_last24_hours.positive?
-          @context.threeds_v2_card_holder_account_transactions_activity_last24_hours = activity_last24_hours
-        end
-
-        previous_year_count = ThreedsHelper.filter_transaction_activity_previous_year user_orders
-        if previous_year_count.positive?
-          @context.threeds_v2_card_holder_account_transactions_activity_previous_year = previous_year_count
-        end
-
-        purchases_last6_months = SpreeEmerchantpayGenesis::ThreedsHelper.filter_purchases_count_last6_months user_orders
-        if purchases_last6_months.positive?
-          @context.threeds_v2_card_holder_account_purchases_count_last6_months = purchases_last6_months
-        end
+      # Map WPF language attributes
+      def wpf_locale_attributes(options)
+        locale = PaymentMethodHelper.select_options_value options, :language
 
-        # Card Holder registration with the 3D requester
-        first_completed_payment = ThreedsHelper.filter_first_completed_payment user_orders
-        unless first_completed_payment.empty?
-          string_date = DateTime.parse(first_completed_payment['payment_created_at'].to_s)
-                                .strftime(ThreedsHelper::DATE_ISO_FORMAT)
-          @context.threeds_v2_card_holder_account_registration_indicator = ThreedsHelper.fetch_class_indicator(
-            'RegistrationIndicators', string_date
-          )
-          @context.threeds_v2_card_holder_account_registration_date = string_date
-        end
+        return unless locale.is_a? String
 
-        nil
+        @context.locale = locale.delete_prefix('\'').delete_suffix('\'')
       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