nexio_activemerchant 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71ca2a7f93f4b56d210272254bb2e5b42f21971a67dcdb4577b7676aeb77963
-  data.tar.gz: 438164011b498f1d97be2d03e41ddfb5cd5d92c06ef66aa65cfdf7def2baafc9
+  metadata.gz: aed1e22c05eb961b28f55d0576219532c0b4077ed15f86bf39e33a45f59a42de
+  data.tar.gz: c9729141380772a443e1aca9bed8c88ce76c206dd46b834a9342499f242a3ea7
 SHA512:
-  metadata.gz: fbcaea369894ec54d50b0aab65cdfa66fd17c97febbeaadd80b07a6c3b7165e97728a115eecfd60d144c0aefc030682fb6d5331946db14129f966636eb584f8f
-  data.tar.gz: 418c3d334030134e369d897ac2a4a09b7226af458cc6972b2f90d0de1201250614baecc94b06a3f657ab4c6a52e4fdd5c287a8ef2c4a0f86f0bd62c23ca2d91d
+  metadata.gz: 2f8bb6a1e812b6f303a269908f997fd50ce308b219b956dceb74aadeb0f1b03d4f5b319d89af7125552d231b4ae24ae1b3624c6328a8fb0f608d367267f030e0
+  data.tar.gz: 88a4222587961c5a8d7d10c15c104aa2a75132e9425e8de7d3be64b9c0264c16fb5625ad0cea1dd8db52b58f7ddcfb7715a7ac044e06643eef36a9a640685440

data/.rubocop.yml

@@ -11,6 +11,10 @@
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/MethodLength:
@@ -19,3 +23,5 @@ Lint/AssignmentInCondition:
   Enabled: false
 Style/GuardClause:
   Enabled: false
+Style/Documentation:
+  Enabled: false

data/lib/active_merchant/billing/encrypted_nexio_card.rb

@@ -3,7 +3,7 @@
 module ActiveMerchant
   module Billing
     class EncryptedNexioCard < CreditCard
-      ALLOWED_CARD_BRANDS = %w(amex discover jcb mastercard visa).freeze
+      ALLOWED_CARD_BRANDS = %w[amex discover jcb mastercard visa].freeze
 
       attr_accessor :encrypted_number, :own_form, :one_time_token
 

data/lib/active_merchant/billing/gateways/nexio_apm_gateway.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative './nexio_base_gateway'
+
+module ActiveMerchant
+  module Billing
+    class NexioApmGateway < NexioBaseGateway
+      self.display_name = 'Nexio AMP'
+      self.base_path = '/apm/v3'
+      self.abstract_class = false
+
+      OneTimeToken = Struct.new(:token, :iframe_url, :redirect_urls, :button_urls)
+
+      def generate_token(money, options = {})
+        post = build_payload(options)
+        add_invoice(post, money, options)
+        post[:data][:paymentMethod] = options[:payment_method] if options[:payment_method].present?
+        add_order_data(post, options)
+        post[:customerRedirectUrl] = options[:callback_url] if options[:callback_url].present?
+        post[:processingOptions][:saveRecurringToken] = true if options[:save_token]
+        post[:isAuthOnly] = true if options[:is_auth_only]
+        resp = commit('token', post)
+        return unless resp.success?
+
+        OneTimeToken.new(
+          resp.params['token'],
+          resp.params['expressIFrameUrl'],
+          map_urls(resp.params['redirectUrls']),
+          map_urls(resp.params['buttonIFrameUrls'])
+        )
+      end
+
+      def purchase(money, payment, options = {})
+        post = build_payload(options)
+        add_invoice(post, money, options)
+        post[:apm] = { token: payment.is_a?(Spree::PaymentSource) ? payment.gateway_payment_profile_id : payment }
+        add_order_data(post, options)
+        post[:isAuthOnly] = true if options[:is_auth_only]
+        commit('process', post)
+      end
+
+      def authorize(money, payment, options = {})
+        purchase(money, payment, options.merge(is_auth_only: true))
+      end
+
+      private
+
+      def map_urls(list)
+        list.each_with_object({}) { |item, acc| acc[item['paymentMethod']] = item['url'] }
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/{nexio.rb → nexio_base_gateway.rb}

@@ -1,59 +1,28 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'nexio_activemerchant/transaction'
 
 module ActiveMerchant
   module Billing
-    class NexioGateway < Gateway
+    class NexioBaseGateway < Gateway
       self.test_url = 'https://api.nexiopaysandbox.com'
       self.live_url = 'https://api.nexiopay.com'
 
       self.supported_countries = %w[CA US]
       self.default_currency = 'USD'
       self.supported_cardtypes = %i[visa master american_express discover]
-
       self.homepage_url = 'https://nex.io'
-      self.display_name = 'Nexio'
-
-      STANDARD_ERROR_CODE_MAPPING = {}.freeze
+      self.abstract_class = true
 
-      OneTimeToken = Struct.new(:token, :expiration, :fraud_url)
+      class_attribute :base_path
+      self.base_path = ''
 
       def initialize(options = {})
         requires!(options, :merchant_id, :auth_token)
         super
       end
 
-      def generate_token(options = {})
-        post = build_payload(options)
-        post[:data][:allowedCardTypes] = %w(amex discover jcb mastercard visa)
-        add_currency(post, options)
-        add_order_data(post, options)
-        add_card_data(post, options)
-        resp = commit('token', post)
-        return unless resp.success?
-
-        token, expiration, fraud_url = resp.params.values_at('token', 'expiration', 'fraudUrl')
-        OneTimeToken.new(token, Time.parse(expiration), fraud_url)
-      end
-
-      def purchase(money, payment, options = {})
-        post = build_payload(options)
-        post[:processingOptions] ||= {}
-        post[:processingOptions][:verboseResponse] = true if test?
-        post[:processingOptions][:customerRedirectUrl] = options[:three_d_callback_url] if options.key?(:three_d_callback_url)
-        post[:processingOptions][:check3ds] = options[:three_d_secure]
-        post[:processingOptions][:paymentType] = options[:payment_type] if options.key?(:payment_type)
-        add_invoice(post, money, options)
-        add_payment(post, payment, options)
-        add_order_data(post, options)
-        commit('process', post)
-      end
-
-      def authorize(money, payment, options = {})
-        purchase(money, payment, options.merge(payload: options.fetch(:payload, {}).merge(isAuthOnly: true)))
-      end
-
       def capture(money, authorization, _options = {})
         commit('capture', { id: authorization, data: { amount: amount(money).to_f } })
       end
@@ -67,13 +36,6 @@ module ActiveMerchant
         commit('void', { id: authorization })
       end
 
-      def verify(credit_card, options = {})
-        MultiResponse.run(:use_first_response) do |r|
-          r.process { authorize(100, credit_card, options) }
-          r.process(:ignore_result) { void(r.authorization, options) }
-        end
-      end
-
       def supports_scrubbing?
         false
       end
@@ -82,28 +44,19 @@ module ActiveMerchant
         transcript
       end
 
-      def store(payment, options = {})
-        post = build_payload(options)
-        add_card_details(post, payment, options)
-        add_currency(post, options)
-        add_order_data(post, options)
-        resp = commit('saveCard', post)
-        return unless resp.success?
-
-        resp.params.fetch('token', {}).fetch('token', nil)
-      end
-
-      def set_webhooks(data)
+      def setup_webhooks(data)
         post = { merchantId: options[:merchant_id].to_s }
         if data.is_a?(String)
           post[:webhooks] = {
             TRANSACTION_AUTHORIZED: { url: data },
-            TRANSACTION_CAPTURED: { url: data }
+            TRANSACTION_CAPTURED: { url: data },
+            TRANSACTION_SETTLED: { url: data }
           }
         else
           webhooks = {}
           webhooks[:TRANSACTION_AUTHORIZED] = { url: data[:authorized] } if data.key?(:authorized)
           webhooks[:TRANSACTION_CAPTURED] = { url: data[:captured] } if data.key?(:captured)
+          webhooks[:TRANSACTION_SETTLED] = { url: data[:settled] } if data.key?(:settled)
           post[:webhooks] = webhooks
         end
         commit('webhook', post)
@@ -114,12 +67,24 @@ module ActiveMerchant
       end
 
       def get_transaction(id)
-        parse(ssl_get(action_url("/transaction/v3/paymentId/#{id}"), base_headers))
-      rescue ResponseError => e
+        data = parse(ssl_get(action_url("/transaction/v3/paymentId/#{id}"), base_headers))
+        ::NexioActivemerchant::Transaction.new(data)
+      rescue ResponseError
+        nil
       end
 
       private
 
+      def build_payload(params)
+        result = params.fetch(:payload, {}).deep_dup
+        result[:data] ||= {}
+        result[:data][:customer] ||= {}
+        result[:processingOptions] ||= {}
+        result[:processingOptions][:merchantId] ||= options[:merchant_id]
+        result[:processingOptions][:verboseResponse] = true if test?
+        result
+      end
+
       def add_invoice(post, money, options)
         post[:data][:amount] = amount(money).to_f
         add_currency(post, options)
@@ -134,11 +99,13 @@ module ActiveMerchant
           case customer
           when String
             post[:data][:customer][:email] = customer
+            post[:data][:customer][:customerRef] = customer
           when Hash
             post[:data][:customer].merge!({
                                             firstName: customer[:first_name],
                                             lastName: customer[:last_name],
-                                            email: customer[:email]
+                                            email: customer[:email],
+                                            customerRef: customer[:email]
                                           })
           end
         end
@@ -172,74 +139,14 @@ module ActiveMerchant
       def add_address(post, data, prefix)
         return post if data.blank?
 
-        post[:data][:customer].merge!({
-                                        "#{prefix}AddressOne": data[:address1],
-                                        "#{prefix}AddressTwo": data[:address2],
-                                        "#{prefix}City": data[:city],
-                                        "#{prefix}Country": data[:country],
-                                        "#{prefix}Phone": data[:phone],
-                                        "#{prefix}Postal": data[:zip],
-                                        "#{prefix}State": data[:state]
-                                      })
-      end
-
-      def add_payment(post, payment, options)
-        post[:tokenex] = token_from(payment)
-        if payment.is_a?(Spree::CreditCard)
-          post[:card] = {
-            cardHolderName: payment.name,
-            cardType: payment.brand
-          }.merge!(post.fetch(:card, {}))
-        end
-        post[:processingOptions] ||= {}
-        post[:processingOptions][:merchantId] = self.options[:merchant_id].to_s
-        post[:processingOptions][:saveCardToken] = options[:save_credit_card] if options.key?(:save_credit_card)
-      end
-
-      def token_from(payment)
-        return { token: payment } if payment.is_a?(String)
-
         {
-          token: payment.gateway_payment_profile_id,
-          lastFour: payment.last_digits,
-          cardType: payment.brand
-        }
-      end
-
-      def add_card_data(post, options)
-        if card = options[:card]
-          post[:card] = {
-            cardHolderName: card[:name],
-            expirationMonth: card[:month],
-            expirationYear: card[:year]
-          }
+          AddressOne: :address1, AddressTwo: :address2, City: :city,
+          Country: :country, Phone: :phone, Postal: :zip, State: :state
+        }.each do |suffix, key|
+          post[:data][:customer]["#{prefix}#{suffix}"] = data[key]
         end
       end
 
-      def add_card_details(post, payment, _options)
-        if payment.is_a?(EncryptedNexioCard)
-          raise ArgumentError, 'The provided card is invalid' unless payment.valid?
-
-          post[:card] = {
-            cardHolderName: payment.name,
-            encryptedNumber: payment.encrypted_number,
-            expirationMonth: payment.month,
-            expirationYear: payment.short_year,
-            cardType: payment.brand,
-            securityCode: payment.verification_value
-          }
-          post[:token] = payment.one_time_token
-        else
-          raise ArgumentError, "Only #{EncryptedNexioCard} payment method is supported to store cards"
-        end
-      end
-
-      def parse(body)
-        JSON.parse(body)
-      rescue StandardError
-        {}
-      end
-
       def commit(action, parameters)
         payload = parse(ssl_post(commit_action_url(action, parameters), post_data(action, parameters), base_headers))
 
@@ -265,29 +172,23 @@ module ActiveMerchant
         )
       end
 
-      def response_status(action, payload)
-        case action
-        when 'process' then authorization_from(payload).present?
-        else
-          true
-        end
+      def post_data(_action, post = {})
+        JSON.dump(post)
       end
 
-      def authorization_from(payload)
-        payload.fetch('id', nil)
-      end
-
-      def post_data(_action, parameters = {})
-        { merchantId: options[:merchant_id] }.merge(parameters).to_json
+      def parse(body)
+        JSON.parse(body)
+      rescue StandardError
+        {}
       end
 
       def commit_action_url(action, _parameters)
         path = case action
-        when 'webhook' then '/webhook/v3/config'
-        when 'secret' then '/webhook/v3/secret'
-        else
-          "/pay/v3/#{action}"
-        end
+               when 'webhook' then '/webhook/v3/config'
+               when 'secret' then '/webhook/v3/secret'
+               else
+                 "#{self.class.base_path}/#{action}"
+               end
         action_url(path)
       end
 
@@ -295,6 +196,24 @@ module ActiveMerchant
         "#{test? ? test_url : live_url}#{path}"
       end
 
+      def base_headers(custom = {})
+        { Authorization: "Basic #{options[:auth_token]}" }.merge(custom)
+      end
+
+      SUCCESS_PROCESS_STATUSES = %w[authOnlyPending authorizedPending pending authOnly settled].freeze
+
+      def response_status(action, payload)
+        case action
+        when 'process' then SUCCESS_PROCESS_STATUSES.include?(payload['transactionStatus'])
+        else
+          true
+        end
+      end
+
+      def authorization_from(payload)
+        payload.fetch('id', nil)
+      end
+
       def build_avs_result(data)
         return if data.blank?
 
@@ -306,14 +225,6 @@ module ActiveMerchant
 
         CVVResult.new(data.fetch('gatewayMessage', {}).fetch('cvvresponse', nil))
       end
-
-      def build_payload(params)
-        { data: { customer: {} } }.merge!(params.fetch(:payload, {}))
-      end
-
-      def base_headers(custom = {})
-        { Authorization: "Basic #{options[:auth_token]}" }
-      end
     end
   end
 end

data/lib/active_merchant/billing/gateways/nexio_gateway.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative './nexio_base_gateway'
+
+module ActiveMerchant
+  module Billing
+    class NexioGateway < NexioBaseGateway
+      self.display_name = 'Nexio'
+      self.base_path = '/pay/v3'
+      self.abstract_class = false
+
+      OneTimeToken = Struct.new(:token, :expiration, :fraud_url)
+
+      def generate_token(options = {})
+        post = build_payload(options)
+        post[:data][:allowedCardTypes] = %w[amex discover jcb mastercard visa]
+        add_currency(post, options)
+        add_order_data(post, options)
+        add_card_data(post, options)
+        resp = commit('token', post)
+        return unless resp.success?
+
+        token, expiration, fraud_url = resp.params.values_at('token', 'expiration', 'fraudUrl')
+        OneTimeToken.new(token, Time.parse(expiration), fraud_url)
+      end
+
+      def purchase(money, payment, options = {})
+        post = build_payload(options)
+        add_invoice(post, money, options)
+        add_payment(post, payment, options)
+        add_order_data(post, options)
+        commit('process', post)
+      end
+
+      def authorize(money, payment, options = {})
+        purchase(money, payment, options.merge(payload: options.fetch(:payload, {}).merge(isAuthOnly: true)))
+      end
+
+      def verify(credit_card, options = {})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(100, credit_card, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
+      def store(payment, options = {})
+        post = build_payload(options)
+        post[:merchantId] ||= options[:merchant_id]
+        add_card_details(post, payment, options)
+        add_currency(post, options)
+        add_order_data(post, options)
+        resp = commit('saveCard', post)
+        return unless resp.success?
+
+        resp.params.fetch('token', {}).fetch('token', nil)
+      end
+
+      private
+
+      def add_payment(post, payment, options)
+        post[:tokenex] = token_from(payment)
+        if payment.is_a?(Spree::CreditCard)
+          post[:card] = {
+            cardHolderName: payment.name,
+            cardType: payment.brand
+          }.merge!(post.fetch(:card, {}))
+        end
+        post[:processingOptions][:saveCardToken] = options[:save_credit_card] if options.key?(:save_credit_card)
+        if options[:three_d_callback_url].present?
+          post[:processingOptions][:customerRedirectUrl] = options[:three_d_callback_url]
+        end
+        post[:processingOptions][:check3ds] = options[:three_d_secure]
+        post[:processingOptions][:paymentType] = options[:payment_type] if options[:payment_type].present?
+      end
+
+      def token_from(payment)
+        return { token: payment } if payment.is_a?(String)
+
+        {
+          token: payment.gateway_payment_profile_id,
+          lastFour: payment.last_digits,
+          cardType: payment.brand
+        }
+      end
+
+      def add_card_data(post, options)
+        if card = options[:card]
+          post[:card] = {
+            cardHolderName: card[:name],
+            expirationMonth: card[:month],
+            expirationYear: card[:year]
+          }
+        end
+      end
+
+      def add_card_details(post, payment, _options)
+        if payment.is_a?(EncryptedNexioCard)
+          raise ArgumentError, 'The provided card is invalid' unless payment.valid?
+
+          post[:card] = {
+            cardHolderName: payment.name,
+            encryptedNumber: payment.encrypted_number,
+            expirationMonth: payment.month,
+            expirationYear: payment.short_year,
+            cardType: payment.brand,
+            securityCode: payment.verification_value
+          }
+          post[:token] = payment.one_time_token
+        else
+          raise ArgumentError, "Only #{EncryptedNexioCard} payment method is supported to store cards"
+        end
+      end
+    end
+  end
+end

data/lib/nexio_activemerchant/transaction.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NexioActivemerchant
+  Transaction = Struct.new(:data) do
+    def status
+      data['transactionStatus']
+    end
+
+    def amount
+      data['amount'].to_d
+    end
+  end
+end

data/lib/nexio_activemerchant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NexioActivemerchant
-  VERSION = '0.2.6'
+  VERSION = '0.3.1'
 end

data/lib/nexio_activemerchant.rb

@@ -3,7 +3,8 @@
 require 'activemerchant'
 require 'active_merchant/billing/rails'
 require 'active_merchant/billing/encrypted_nexio_card'
-require 'active_merchant/billing/gateways/nexio'
+require 'active_merchant/billing/gateways/nexio_gateway'
+require 'active_merchant/billing/gateways/nexio_apm_gateway'
 require 'nexio_activemerchant/version'
 
 module NexioActivemerchant

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexio_activemerchant
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Whitespectre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemerchant
@@ -57,8 +57,11 @@ files:
 - bin/console
 - bin/setup
 - lib/active_merchant/billing/encrypted_nexio_card.rb
-- lib/active_merchant/billing/gateways/nexio.rb
+- lib/active_merchant/billing/gateways/nexio_apm_gateway.rb
+- lib/active_merchant/billing/gateways/nexio_base_gateway.rb
+- lib/active_merchant/billing/gateways/nexio_gateway.rb
 - lib/nexio_activemerchant.rb
+- lib/nexio_activemerchant/transaction.rb
 - lib/nexio_activemerchant/version.rb
 - nexio_activemerchant.gemspec
 homepage: https://github.com/whitespectre/nexio_activemerchant