activemerchant-nsp 1.27.0

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

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/sage/sage_bankcard'
+require File.dirname(__FILE__) + '/sage/sage_virtual_check'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageGateway < Gateway
+      self.supported_countries = SageBankcardGateway.supported_countries
+      self.supported_cardtypes = SageBankcardGateway.supported_cardtypes
+
+      self.abstract_class = true
+
+      # Creates a new SageGateway
+      # 
+      # The gateway requires that a valid login and password be passed
+      # in the +options+ hash.
+      # 
+      # ==== Options
+      #
+      # * <tt>:login</tt> - The Sage Payment Solutions Merchant ID Number.
+      # * <tt>:password</tt> - The Sage Payment Solutions Merchant Key Number.
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      # Performs an authorization transaction
+      # 
+      # ==== Parameters
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>credit_card</tt> - The CreditCard object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_shipping</tt>.      
+      def authorize(money, credit_card, options = {})
+        bankcard.authorize(money, credit_card, options)
+      end
+      
+      # Performs a purchase, which is essentially an authorization and capture in a single operation.
+      # 
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>source</tt> - The CreditCard or Check object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an integer value in cents. Maps to Sage <tt>T_shipping</tt>.
+      #
+      # ==== Additional options in the +options+ hash for when using a Check as the funding source
+      # * <tt>:originator_id</tt> - 10 digit originator. If not provided, Sage will use the default Originator ID for the specific customer type.
+      # * <tt>:addenda</tt> - Transaction addenda.
+      # * <tt>:ssn</tt> - The customer's Social Security Number.
+      # * <tt>:drivers_license_state</tt> - The customer's drivers license state code.
+      # * <tt>:drivers_license_number</tt> - The customer's drivers license number.
+      # * <tt>:date_of_birth</tt> - The customer's date of birth as a Time or Date object or a string in the format <tt>mm/dd/yyyy</tt>.
+      def purchase(money, source, options = {})
+        if card_brand(source) == "check"
+          virtual_check.purchase(money, source, options)
+        else
+          bankcard.purchase(money, source, options)
+        end
+      end                       
+    
+      # Captures authorized funds.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents. Sage doesn't support changing the capture amount, so the full amount of the initial transaction will be captured.
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def capture(money, reference, options = {})
+        bankcard.capture(money, reference, options)
+      end
+      
+      # Voids a prior transaction. Works for both CreditCard and Check transactions.
+      #
+      # ==== Parameters
+      #
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def void(reference, options = {})
+        if reference.split(";").last == "virtual_check"
+          virtual_check.void(reference, options)
+        else
+          bankcard.void(reference, options)
+        end
+      end
+
+      # Performs a credit transaction. (Sage +Credit+ transaction).
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>source</tt> - The CreditCard or Check object to be used as the target for the credit.
+      def credit(money, source, options = {})
+        if card_brand(source) == "check"
+          virtual_check.credit(money, source, options)
+        else
+          bankcard.credit(money, source, options)
+        end
+      end
+          
+      private
+      def bankcard
+        @bankcard ||= SageBankcardGateway.new(@options)
+      end
+      
+      def virtual_check
+        @virtual_check ||= SageVirtualCheckGateway.new(@options)
+      end 
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/sage/sage_bankcard.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/sage_core'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageBankcardGateway < Gateway #:nodoc:
+      include SageCore
+      self.live_url = 'https://www.sagepayments.net/cgi-bin/eftBankcard.dll?transaction'
+      self.source = 'bankcard'
+          
+      # Credit cards supported by Sage
+      # * VISA
+      # * MasterCard
+      # * AMEX
+      # * Diners
+      # * Carte Blanche
+      # * Discover
+      # * JCB
+      # * Sears
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :diners_club]
+      
+      def authorize(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:authorization, post)
+      end
+      
+      def purchase(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:purchase, post)
+      end                       
+    
+      # The +money+ amount is not used. The entire amount of the 
+      # initial authorization will be captured.
+      def capture(money, reference, options = {})
+        post = {}
+        add_reference(post, reference)
+        commit(:capture, post)
+      end
+      
+      def void(reference, options = {})
+        post = {}
+        add_reference(post, reference)
+        commit(:void, post)
+      end
+      
+      def credit(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:credit, post)
+      end
+          
+      private
+      def exp_date(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+
+      def add_credit_card(post, credit_card)
+        post[:C_name]       = credit_card.name
+        post[:C_cardnumber] = credit_card.number
+        post[:C_exp]        = exp_date(credit_card)
+        post[:C_cvv]        = credit_card.verification_value if credit_card.verification_value?
+      end
+      
+      def parse(data)
+        response = {}
+        response[:success]          = data[1,1]
+        response[:code]             = data[2,6]
+        response[:message]          = data[8,32].strip
+        response[:front_end]        = data[40, 2]
+        response[:cvv_result]       = data[42, 1]
+        response[:avs_result]       = data[43, 1].strip
+        response[:risk]             = data[44, 2]
+        response[:reference]        = data[46, 10]
+        
+        response[:order_number], response[:recurring] = data[57...-1].split("\034")
+        response
+      end
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/sage/sage_core.rb

@@ -0,0 +1,115 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module SageCore #:nodoc:
+      def self.included(base)
+        base.cattr_accessor :source
+        base.supported_countries = ['US', 'CA']
+        base.homepage_url = 'http://www.sagepayments.com'
+        base.display_name = 'Sage Payment Solutions'
+      end
+      
+      # Transactions types:
+      # <tt>01</tt> - Sale
+      # <tt>02</tt> - AuthOnly 
+      # <tt>03</tt> - Force/PriorAuthSale 
+      # <tt>04</tt> - Void 
+      # <tt>06</tt> - Credit 
+      # <tt>11</tt> - PriorAuthSale by Reference*
+      TRANSACTIONS = {
+        :purchase           => '01',
+        :authorization      => '02',
+        :capture            => '11',
+        :void               => '04',
+        :credit             => '06'
+      }
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      private
+      def add_invoice(post, options)
+        post[:T_ordernum] = options[:order_id].slice(0, 20)
+        post[:T_tax] = amount(options[:tax]) unless options[:tax].blank?
+        post[:T_shipping] = amount(options[:shipping]) unless options[:shipping].blank?
+      end
+      
+      def add_reference(post, reference)
+        ref, source = reference.to_s.split(";")
+        post[:T_reference] = ref
+      end
+      
+      def add_amount(post, money)
+        post[:T_amt] = amount(money)
+      end
+      
+      def add_customer_data(post, options)
+        post[:T_customer_number] = options[:customer]
+      end
+
+      def add_addresses(post, options)
+        billing_address   = options[:billing_address] || options[:address] || {}
+        
+        post[:C_address]    = billing_address[:address1]
+        post[:C_city]       = billing_address[:city]
+        
+        if ['US', 'CA'].include?(billing_address[:country])
+          post[:C_state]    = billing_address[:state]
+        else
+          post[:C_state]    = "Outside of United States"
+        end
+        
+        post[:C_zip]        = billing_address[:zip]
+        post[:C_country]    = billing_address[:country] 
+        post[:C_telephone]  = billing_address[:phone]
+        post[:C_fax]        = billing_address[:fax]
+        post[:C_email]      = options[:email]
+        
+        if shipping_address = options[:shipping_address]
+          post[:C_ship_name]    = shipping_address[:name]
+          post[:C_ship_address] = shipping_address[:address1]
+          post[:C_ship_city]    = shipping_address[:city]
+          post[:C_ship_state]   = shipping_address[:state]
+          post[:C_ship_zip]     = shipping_address[:zip] 
+          post[:C_ship_country] = shipping_address[:country]
+        end
+      end
+      
+      def add_transaction_data(post, money, options)
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_addresses(post, options)        
+        add_customer_data(post, options)
+      end
+      
+      def commit(action, params)
+        response = parse(ssl_post(self.live_url, post_data(action, params)))
+        
+        Response.new(success?(response), response[:message], response, 
+          :test => test?, 
+          :authorization => authorization_from(response),
+          :avs_result => { :code => response[:avs_result] },
+          :cvv_result => response[:cvv_result]
+        )
+      end
+      
+      def authorization_from(response)
+        "#{response[:reference]};#{source}"
+      end
+            
+      def success?(response)
+        response[:success] == 'A'
+      end
+
+      def post_data(action, params = {})
+        params[:M_id]  = @options[:login]
+        params[:M_key] = @options[:password]
+        params[:T_code] = TRANSACTIONS[action]
+        
+        params.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/sage/sage_virtual_check.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/sage_core'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageVirtualCheckGateway < Gateway #:nodoc:
+      include SageCore
+      self.live_url = 'https://www.sagepayments.net/cgi-bin/eftVirtualCheck.dll?transaction'
+      self.source = 'virtual_check'
+      
+      def purchase(money, credit_card, options = {})
+        post = {}
+        add_check(post, credit_card)
+        add_check_customer_data(post, options)
+        add_transaction_data(post, money, options)
+        commit(:purchase, post)
+      end
+      
+      def void(reference, options = {})
+        post = {}
+        add_reference(post, reference)
+        commit(:void, post)
+      end
+      
+      def credit(money, credit_card, options = {})
+        post = {}
+        add_check(post, credit_card)
+        add_check_customer_data(post, options)
+        add_transaction_data(post, money, options)
+        commit(:credit, post)
+      end
+      
+      private
+      def add_check(post, check)
+        post[:C_first_name]   = check.first_name
+        post[:C_last_name]    = check.last_name
+        post[:C_rte]          = check.routing_number
+        post[:C_acct]         = check.account_number
+        post[:C_check_number] = check.number
+        post[:C_acct_type]    = account_type(check)
+      end
+      
+      def add_check_customer_data(post, options)
+        # Required  Customer Type – (NACHA Transaction Class)
+        # CCD for Commercial, Merchant Initiated 
+        # PPD for Personal, Merchant Initiated
+        # WEB for Internet, Consumer Initiated 
+        # RCK for Returned Checks 
+        # ARC for Account Receivable Entry 
+        # TEL for TelephoneInitiated
+        post[:C_customer_type] = "WEB"
+
+        # Optional  10  Digit Originator  ID – Assigned  By for  each transaction  class  or  business  purpose. If  not provided, the default Originator ID for the specific  Customer Type will be applied.  
+        post[:C_originator_id] = options[:originator_id]
+
+        # Optional  Transaction Addenda
+        post[:T_addenda] = options[:addenda]
+
+        # Required  Check  Writer  Social  Security  Number  (  Numbers Only, No Dashes )  
+        post[:C_ssn] = options[:ssn].to_s.gsub(/[^\d]/, '')
+
+        post[:C_dl_state_code] = options[:drivers_license_state]
+        post[:C_dl_number]     = options[:drivers_license_number]
+        post[:C_dob]           = format_birth_date(options[:date_of_birth])
+      end
+      
+      def format_birth_date(date)
+        date.respond_to?(:strftime) ? date.strftime("%m/%d/%Y") : date
+      end
+
+      # DDA for Checking 
+      # SAV for Savings  
+      def account_type(check)
+        case check.account_type
+        when 'checking' then 'DDA'
+        when 'savings'  then 'SAV'
+        else raise ArgumentError, "Unknown account type #{check.account_type}"
+        end
+      end
+      
+      def parse(data)
+        response = {}
+        response[:success]          = data[1,1]
+        response[:code]             = data[2,6].strip
+        response[:message]          = data[8,32].strip
+        response[:risk]             = data[40, 2]
+        response[:reference]        = data[42, 10]
+        
+        extra_data = data[53...-1].split("\034")
+        response[:order_number] = extra_data[0]
+        response[:authentication_indicator] = extra_data[1]
+        response[:authentication_disclosure] = extra_data[2]
+        response
+      end
+    end
+  end
+end
+