activemerchant 1.55.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e8d9130eaadeedc543af0a5b2cf5b060a2f1399
-  data.tar.gz: 868d04daf3f0dbd97f7f87adb0d96add9e868a57
+  metadata.gz: 8a7fa5a42dbb05e1c335a93e8cefc85781e7cbae
+  data.tar.gz: 928d0561eab8bc6a0fcac4245ccc2342d4e8fa6a
 SHA512:
-  metadata.gz: c079b666da79f7f8e77f47ca08003f2712a5daefb801b927454234c9c25f7b1b7d311e63b9432f758dcbb1594d111a323a8606e8636d50cd45da33a87cc35434
-  data.tar.gz: 0c77b4dbbf7f9f8b3bcbb5e1ae1bbc9af213cab749a0690b1337d46772813043dc65aefb2cc816b86c26dd8fe42cf53b0ce11cb93de53587bc2af3b55b6ecd49
+  metadata.gz: bf1511639e9a72d13e6be69a301e0f0553cd4b52e65205a0e9f777c951e355124c16440182716a622beb5cd56037d98aea1659e1bdf49541b20d0438d2bf3802
+  data.tar.gz: 83dd4208bb147e5dce68f4751ff27e7298f03fffa0ef8c32f0f335fbf8fa79b1c4177d4839b236510fc7d9f66bedf98a4237085fbb2dcc94a9509d57f3004feb

data/CHANGELOG

@@ -1,5 +1,26 @@
 = ActiveMerchant CHANGELOG
 
+== Version 1.56.0 (December 1, 2015)
+* Add Cardknox gateway [dlehren]
+* Mercury: Add support for card present track 2 [ryanbalsdon]
+* Cardstream: Improve default currency handling [duff]
+* Mercury: Strip start and end sentinels on track 2 [ryanbalsdon]
+* Redsys: Support new SHA256 authentication method [davidsantoso]
+* Cashnet: Allow custcode override [duff]
+* Add Rails 5 support [rafaelfranca]
+* Set required Ruby version for install to 2 or greater [rafaelfranca]
+* JetPay: Pass ud_fields in capture too [duff]
+* Stripe: Correctly detect test mode refunds [aprofeit]
+* Fix variables in remote gateways test template [sdball]
+* Micropayment: Update fieldnames for new API [duff]
+* Fix CreditCard#valid_number? erroring on non-digit characters [PatrickTulskie]
+* Stripe: Correctly detect test mode voids [methodmissing]
+* Garanti: Add test mode URL and update remote test credentials [cbilgili]
+* Cashnet: Allow custcode override on refund [duff]
+* Omise: Add a new optional api_version config [zdk]
+* Elavon: Include IP address in purchase and authorize requests [aprofeit]
+* TransFirst: Add support for ACH and more operations [davidsantoso]
+* FirstData_e4: Fix void for even dollar transactions [duff]
 
 == Version 1.55.0 (November 9, 2015)
 * CyberSource: send customer IP address when provided [fastjames]
@@ -51,6 +72,7 @@
 * PayBox Direct: Refunds and working test credentials [ivanfer]
 * Vanco: Handle case of no billing_address [duff]
 * BluePay: Add support for CUSTOM_ID2 field [ajporterfield]
+* Creditcall: Handle no verification_value [duff]
 
 == Version 1.54.0 (October 2, 2015)
 * Beanstream: Add Network Tokenization support [girasquid]

data/CONTRIBUTORS

@@ -562,3 +562,7 @@ Payeezy (October 2015)
 Clearhaus (October 2015)
 
 * Dinesh Yadav (dinesh)
+
+Cardknox (November 2015)
+
+* (dlehren)

data/README.md

@@ -97,6 +97,7 @@ The [ActiveMerchant Wiki](http://github.com/activemerchant/active_merchant/wikis
 * [Borgun](https://www.borgun.is/) - IS
 * [Braintree](http://www.braintreepaymentsolutions.com) - US, CA, AU, AD, AT, BE, BG, CY, CZ, DK, EE, FI, FR, GI, DE, GR, HU, IS, IM, IE, IT, LV, LI, LT, LU, MT, MC, NL, NO, PL, PT, RO, SM, SK, SI, ES, SE, CH, TR, GB
 * [BridgePay](http://www.bridgepaynetwork.com/) - CA, US
+* [Cardknox](https://www.cardknox.com/) - US, CA, GB
 * [CardSave](http://www.cardsave.net/) - GB
 * [CardStream](http://www.cardstream.com/) - GB
 * [Cashnet](http://www.higherone.com/) - US

data/lib/active_merchant.rb

@@ -33,7 +33,6 @@ if(!defined?(ActiveSupport::VERSION) || (ActiveSupport::VERSION::STRING < "4.1")
   require 'active_support/core_ext/class/attribute_accessors'
 end
 
-require 'active_support/core_ext/class/delegating_attributes'
 require 'active_support/core_ext/module/attribute_accessors'
 
 require 'base64'

data/lib/active_merchant/billing/credit_card_methods.rb

@@ -68,6 +68,7 @@ module ActiveMerchant #:nodoc:
         def valid_number?(number)
           valid_test_mode_card_number?(number) ||
             valid_card_number_length?(number) &&
+            valid_card_number_characters?(number) &&
             valid_checksum?(number)
         end
 
@@ -138,6 +139,10 @@ module ActiveMerchant #:nodoc:
           number.to_s.length >= 12
         end
 
+        def valid_card_number_characters?(number) #:nodoc:
+          !number.to_s.match(/\D/)
+        end
+
         def valid_test_mode_card_number?(number) #:nodoc:
           ActiveMerchant::Billing::Base.test? &&
             %w[1 2 3 success failure error].include?(number.to_s)

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

@@ -6,8 +6,8 @@ module ActiveMerchant #:nodoc:
       self.display_name = "BridgePay"
       self.homepage_url = "http://www.bridgepaynetwork.com/"
 
-      self.test_url = "https://gatewaystage.itstgate.com/SmartPayments/transact.asmx/ProcessCreditCard"
-      self.live_url = "https://gateway.itstgate.com/SmartPayments/transact.asmx/ProcessCreditCard"
+      self.test_url = "https://gatewaystage.itstgate.com/SmartPayments/transact.asmx"
+      self.live_url = "https://gateway.itstgate.com/SmartPayments/transact.asmx"
 
       self.supported_countries = ["CA", "US"]
       self.default_currency = "USD"
@@ -19,30 +19,30 @@ module ActiveMerchant #:nodoc:
         super
       end
 
-      def purchase(amount, creditcard, options={})
-        post = post_required_fields("Sale")
+      def purchase(amount, payment_method, options={})
+        post = initialize_required_fields("Sale")
 
         # Allow the same amount in multiple transactions.
         post[:ExtData] = "<Force>T</Force>"
         add_invoice(post, amount, options)
-        add_creditcard(post, creditcard)
+        add_payment_method(post, payment_method)
         add_customer_data(post, options)
 
         commit(post)
       end
 
-      def authorize(amount, creditcard, options={})
-        post = post_required_fields("Auth")
+      def authorize(amount, payment_method, options={})
+        post = initialize_required_fields("Auth")
 
         add_invoice(post, amount, options)
-        add_creditcard(post, creditcard)
+        add_payment_method(post, payment_method)
         add_customer_data(post, options)
 
         commit(post)
       end
 
       def capture(amount, authorization, options={})
-        post = post_required_fields("Force")
+        post = initialize_required_fields("Force")
 
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -52,7 +52,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def refund(amount, authorization, options={})
-        post = post_required_fields("Return")
+        post = initialize_required_fields("Return")
 
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -61,7 +61,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def void(authorization, options={})
-        post = post_required_fields("Void")
+        post = initialize_required_fields("Void")
 
         add_reference(post, authorization)
 
@@ -75,9 +75,37 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((&?CardNum=)[^&]*)i, '\1[FILTERED]').
+          gsub(%r((&?CVNum=)[^&]*)i, '\1[FILTERED]').
+          gsub(%r((&?Password=)[^&]*)i, '\1[FILTERED]').
+          gsub(%r((&?TransitNum=)[^&]*)i, '\1[FILTERED]').
+          gsub(%r((&?AccountNum=)[^&]*)i, '\1[FILTERED]')
+      end
+
       private
 
-      def post_required_fields(transaction_type)
+      def add_payment_method(post, payment_method)
+        if payment_method.respond_to? :brand
+          post[:NameOnCard] = payment_method.name if payment_method.name
+          post[:ExpDate]    = expdate(payment_method)
+          post[:CardNum]    = payment_method.number
+          post[:CVNum]      = payment_method.verification_value
+        else
+          post[:CheckNum] = payment_method.number
+          post[:TransitNum] = payment_method.routing_number
+          post[:AccountNum] = payment_method.account_number
+          post[:NameOnCheck] = payment_method.name
+          post[:ExtData] = "<AccountType>#{payment_method.account_type.capitalize}</AccountType>"
+        end
+      end
+
+      def initialize_required_fields(transaction_type)
         post = {}
         post[:TransType] = transaction_type
         post[:Amount] = ""
@@ -92,6 +120,12 @@ module ActiveMerchant #:nodoc:
         post[:CVNum] = ""
         post[:MagData] = ""
         post[:ExtData] = ""
+        post[:MICR] = ""
+        post[:DL] = ""
+        post[:SS] = ""
+        post[:DOB] = ""
+        post[:StateCode] = ""
+        post[:CheckType] = ""
         post
       end
 
@@ -107,13 +141,6 @@ module ActiveMerchant #:nodoc:
         post[:InvNum] = options[:order_id]
       end
 
-      def add_creditcard(post, creditcard)
-        post[:NameOnCard] = creditcard.name if creditcard.name
-        post[:ExpDate]    = expdate(creditcard)
-        post[:CardNum]    = creditcard.number
-        post[:CVNum]      = creditcard.verification_value
-      end
-
       def expdate(creditcard)
         "#{format(creditcard.month, :two_digits)}#{format(creditcard.year, :two_digits)}"
       end
@@ -137,12 +164,12 @@ module ActiveMerchant #:nodoc:
       end
 
       def commit(parameters)
-        url = (test? ? test_url : live_url)
+        url = url(parameters[:TransitNum] ? 'ProcessCheck' : 'ProcessCreditCard')
         data = post_data(parameters)
         raw = parse(ssl_post(url, data))
 
         Response.new(
-          success_from(raw[:respmsg]),
+          success_from(raw),
           message_from(raw),
           raw,
           authorization: authorization_from(raw),
@@ -150,17 +177,17 @@ module ActiveMerchant #:nodoc:
         )
       end
 
-      def success_from(result)
-        case result
-        when "Approved"
-          true
-        else
-          false
-        end
+      def url(action)
+        base = test? ? test_url : live_url
+        "#{base}/#{action}"
+      end
+
+      def success_from(response)
+        response[:result] == "0"
       end
 
       def message_from(response)
-        response[:respmsg]
+        response[:respmsg] || response[:message]
       end
 
       def authorization_from(response)

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

@@ -14,6 +14,7 @@ module ActiveMerchant #:nodoc:
 
       CURRENCY_CODES = {
         "AUD" => '036',
+        "BRL" => '986',
         "CAD" => '124',
         "CZK" => '203',
         "DKK" => '208',
@@ -132,7 +133,7 @@ module ActiveMerchant #:nodoc:
 
       def add_amount(post, money, options)
         add_pair(post, :amount, amount(money), :required => true)
-        add_pair(post, :currencyCode, currency_code(options[:currency] || currency(money)) || currency_code(self.default_currency))
+        add_pair(post, :currencyCode, currency_code(options[:currency] || currency(money)))
       end
 
       def add_customer_data(post, options)

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

@@ -0,0 +1,328 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CardknoxGateway < Gateway
+      self.live_url = 'https://x1.cardknox.com/gateway'
+
+      self.supported_countries = ['US','CA','GB']
+      self.default_currency = 'USD'
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+
+      self.homepage_url = 'https://www.cardknox.com/'
+      self.display_name = 'Cardknox'
+
+      COMMANDS = {
+        credit_card: {
+          purchase:          'cc:sale',
+          authorization:     'cc:authonly',
+          capture:           'cc:capture',
+          refund:            'cc:refund',
+          void:              'cc:void',
+          save:              'cc:save'
+        },
+        check: {
+          purchase:    'check:sale',
+          refund:      'check:refund',
+          void:        'check:void',
+          save:        'check:save'
+        }
+      }
+
+      def initialize(options={})
+        requires!(options, :api_key)
+        super
+      end
+
+      # There are three sources for doing a purchase transation:
+      # - credit card
+      # - check
+      # - cardknox token, which is returned in the the authorization string "ref_num;token;command"
+
+      def purchase(amount, source, options={})
+        post = {}
+        add_amount(post, amount, options)
+        add_invoice(post, options)
+        add_source(post, source)
+        add_address(post, source, options)
+        add_customer_data(post, options)
+        add_custom_fields(post, options)
+        commit(:purchase, source_type(source), post)
+      end
+
+      def authorize(amount, source, options={})
+        post = {}
+        add_amount(post, amount)
+        add_invoice(post, options)
+        add_source(post, source)
+        add_address(post, source, options)
+        add_customer_data(post, options)
+        add_custom_fields(post, options)
+        commit(:authorization, source_type(source), post)
+      end
+
+      def capture(amount, authorization, options = {})
+        post = {}
+        add_reference(post, authorization)
+        add_amount(post, amount)
+        commit(:capture, source_type(authorization), post)
+      end
+
+      def refund(amount, authorization, options={})
+        post = {}
+        add_reference(post, authorization)
+        add_amount(post, amount)
+        commit(:refund, source_type(authorization), post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_reference(post, authorization)
+        commit(:void, source_type(authorization), post)
+      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(source, options = {})
+        post = {}
+        add_source(post, source)
+        add_address(post, source, options)
+        add_invoice(post, options)
+        add_customer_data(post, options)
+        add_custom_fields(post, options)
+        commit(:save, source_type(source), post)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((xCardNum=)\d+), '\1[FILTERED]').
+          gsub(%r((xCVV=)\d+), '\1[FILTERED]').
+          gsub(%r((xAccount=)\d+), '\1[FILTERED]').
+          gsub(%r((xRouting=)\d+), '\1[FILTERED]').
+          gsub(%r((xKey=)\w+), '\1[FILTERED]')
+      end
+
+      private
+
+      def split_authorization(authorization)
+        authorization.split(";")
+      end
+
+      def add_reference(post, reference)
+        reference, _, _ = split_authorization(reference)
+        post[:Refnum] = reference
+      end
+
+      def source_type(source)
+        if source.respond_to?(:brand)
+          :credit_card
+        elsif source.respond_to?(:routing_number)
+          :check
+        elsif source.kind_of?(String)
+          source_type_from(source)
+        else
+          raise ArgumentError, "Unknown source #{source.inspect}"
+        end
+      end
+
+      def source_type_from(authorization)
+        _, _, source_type = split_authorization(authorization)
+        (source_type || "credit_card").to_sym
+      end
+
+      def add_source(post, source)
+        if source.respond_to?(:brand)
+          add_credit_card(post, source)
+        elsif source.respond_to?(:routing_number)
+          add_check(post, source)
+        elsif source.kind_of?(String)
+          add_cardknox_token(post, source)
+        else
+          raise ArgumentError, "Invalid payment source #{source.inspect}"
+        end
+      end
+
+      # Subtotal + Tax + Tip = Amount.
+
+      def add_amount(post, money, options = {})
+        post[:Tip]    = amount(options[:tip])
+        post[:Amount] = amount(money)
+      end
+
+      def expdate(credit_card)
+        year  = format(credit_card.year, :two_digits)
+        month = format(credit_card.month, :two_digits)
+        "#{month}#{year}"
+      end
+
+      def add_customer_data(post, options)
+        address = options[:billing_address] || {}
+        post[:Street] = address[:address1]
+        post[:Zip] = address[:zip]
+        post[:PONum] = options[:po_number]
+        post[:Fax] = options[:fax]
+        post[:Email] = options[:email]
+        post[:IP] = options[:ip]
+      end
+
+      def add_address(post, source, options)
+        add_address_for_type(:billing, post, source, options[:billing_address]) if options[:billing_address]
+        add_address_for_type(:shipping, post, source, options[:shipping_address]) if options[:shipping_address]
+      end
+
+      def add_address_for_type(type, post, source, address)
+        prefix = address_key_prefix(type)
+        if source.respond_to?(:first_name)
+          post[address_key(prefix, 'FirstName')] = source.first_name
+          post[address_key(prefix, 'LastName')]  = source.last_name
+        else
+          post[address_key(prefix, 'FirstName')] = address[:first_name]
+          post[address_key(prefix, 'LastName')]  = address[:last_name]
+        end
+        post[address_key(prefix, 'MiddleName')]  = address[:middle_name]
+
+        post[address_key(prefix, 'Company')]  = address[:company]
+        post[address_key(prefix, 'Street')]   = address[:address1]
+        post[address_key(prefix, 'Street2')]  = address[:address2]
+        post[address_key(prefix, 'City')]     = address[:city]
+        post[address_key(prefix, 'State')]    = address[:state]
+        post[address_key(prefix, 'Zip')]      = address[:zip]
+        post[address_key(prefix, 'Country')]  = address[:country]
+        post[address_key(prefix, 'Phone')]    = address[:phone]
+        post[address_key(prefix, 'Mobile')]   = address[:mobile]
+      end
+
+      def address_key_prefix(type)
+        case type
+        when :shipping then 'Ship'
+        when :billing then 'Bill'
+        else
+          raise ArgumentError, "Unknown address key prefix: #{type}"
+        end
+      end
+
+      def address_key(prefix, key)
+        "#{prefix}#{key}".to_sym
+      end
+
+      def add_invoice(post, options)
+        post[:Invoice] = options[:invoice]
+        post[:OrderID] = options[:order_id]
+        post[:Comments] = options[:comments]
+        post[:Description] = options[:description]
+        post[:Tax] = amount(options[:tax])
+      end
+
+      def add_custom_fields(post, options)
+        options.keys.grep(/^custom(?:[01]\d|20)$/) do |key|
+          post[key.to_s.capitalize] = options[key]
+        end
+      end
+
+      def add_credit_card(post, credit_card)
+        if credit_card.track_data.present?
+          post[:Magstripe] = credit_card.track_data
+          post[:Cardpresent] = true
+        else
+          post[:CardNum] = credit_card.number
+          post[:CVV] = credit_card.verification_value
+          post[:Exp] = expdate(credit_card)
+          post[:Name] = credit_card.name
+          post[:CardPresent] = true if credit_card.manual_entry
+        end
+      end
+
+      def add_check(post, check)
+        post[:Routing] = check.routing_number
+        post[:Account] = check.account_number
+        post[:Name] = check.name
+        post[:CheckNum] = check.number
+      end
+
+      def add_cardknox_token(post, authorization)
+        _, token, _ = split_authorization(authorization)
+
+        post[:Token] = token
+      end
+
+      def parse(body)
+        fields = {}
+        for line in body.split('&')
+          key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+          fields[key] = CGI.unescape(value.to_s)
+        end
+
+        {
+          result:            fields['xResult'],
+          status:            fields['xStatus'],
+          error:             fields['xError'],
+          auth_code:         fields['xAuthCode'],
+          ref_num:           fields['xRefNum'],
+          current_ref_num:   fields['xRefNumCurrent'],
+          token:             fields['xToken'],
+          batch:             fields['xBatch'],
+          avs_result:        fields['xAvsResult'],
+          avs_result_code:   fields['xAvsResultCode'],
+          cvv_result:        fields['xCvvResult'],
+          cvv_result_code:   fields['xCvvResultCode'],
+          remaining_balance: fields['xRemainingBalance'],
+          amount:            fields['xAuthAmount'],
+          masked_card_num:   fields['xMaskedCardNumber'],
+          masked_account_number: fields['MaskedAccountNumber']
+        }.delete_if{|k, v| v.nil?}
+      end
+
+
+      def commit(action, source_type, parameters)
+        response = parse(ssl_post(live_url, post_data(COMMANDS[source_type][action], parameters)))
+
+       Response.new(
+          (response[:status] == 'Approved'),
+          message_from(response),
+          response,
+          authorization: authorization_from(response, source_type),
+          avs_result: { code: response[:avs_result_code] },
+          cvv_result: response[:cvv_result_code]
+        )
+      end
+
+      def message_from(response)
+        if response[:status] == "Approved"
+          "Success"
+        elsif response[:error].blank?
+          "Unspecified error"
+        else
+          response[:error]
+        end
+      end
+
+      def authorization_from(response, source_type)
+        "#{response[:ref_num]};#{response[:token]};#{source_type}"
+      end
+
+      def post_data(command, parameters = {})
+        initial_parameters = {
+          Key: @options[:api_key],
+          Version: "4.5.4",
+          SoftwareName: 'Active Merchant',
+          SoftwareVersion: "#{ActiveMerchant::VERSION}",
+          Command: command,
+        }
+
+        seed = SecureRandom.hex(32).upcase
+        hash = Digest::SHA1.hexdigest("#{initial_parameters[:command]}:#{@options[:pin]}:#{parameters[:amount]}:#{parameters[:invoice]}:#{seed}")
+        initial_parameters[:Hash] = "s/#{seed}/#{hash}/n" unless @options[:pin].blank?
+        parameters = initial_parameters.merge(parameters)
+
+        parameters.reject{|k, v| v.blank?}.collect{ |key, value| "x#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+    end
+  end
+end