maedana-activemerchant 1.9.1.1

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.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,116 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module SageCore #:nodoc:
+      def self.included(base)
+        base.cattr_accessor :url
+        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(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.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
+

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

@@ -0,0 +1,315 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SagePayGateway < Gateway  
+      cattr_accessor :simulate
+      self.simulate = false
+      
+      TEST_URL = 'https://test.sagepay.com/gateway/service'
+      LIVE_URL = 'https://live.sagepay.com/gateway/service'
+      SIMULATOR_URL = 'https://test.sagepay.com/Simulator'
+      
+      APPROVED = 'OK'
+    
+      TRANSACTIONS = {
+        :purchase => 'PAYMENT',
+        :credit => 'REFUND',
+        :authorization => 'DEFERRED',
+        :capture => 'RELEASE',
+        :void => 'VOID',
+        :abort => 'ABORT'
+      }
+      
+      CREDIT_CARDS = {
+        :visa => "VISA",
+        :master => "MC",
+        :delta => "DELTA",
+        :solo => "SOLO",
+        :switch => "MAESTRO",
+        :maestro => "MAESTRO",
+        :american_express => "AMEX",
+        :electron => "UKE",
+        :diners_club => "DC",
+        :jcb => "JCB"
+      }
+
+      ELECTRON = /^(424519|42496[23]|450875|48440[6-8]|4844[1-5][1-5]|4917[3-5][0-9]|491880)\d{10}(\d{3})?$/
+      
+      AVS_CVV_CODE = {
+        "NOTPROVIDED" => nil, 
+        "NOTCHECKED" => 'X',
+        "MATCHED" => 'Y',
+        "NOTMATCHED" => 'N'
+      }
+    
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :switch, :solo, :maestro, :diners_club]
+      self.supported_countries = ['GB']
+      self.default_currency = 'GBP'
+      
+      self.homepage_url = 'http://www.sagepay.com'
+      self.display_name = 'SagePay'
+
+      def initialize(options = {})
+        requires!(options, :login)
+        @options = options
+        super
+      end
+      
+      def test?
+        @options[:test] || super
+      end
+      
+      def purchase(money, credit_card, options = {})
+        requires!(options, :order_id)
+        
+        post = {}
+        
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+
+        commit(:purchase, post)
+      end
+      
+      def authorize(money, credit_card, options = {})
+        requires!(options, :order_id)
+        
+        post = {}
+        
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+
+        commit(:authorization, post)
+      end
+      
+      # You can only capture a transaction once, even if you didn't capture the full amount the first time.
+      def capture(money, identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        add_release_amount(post, money, options)
+        
+        commit(:capture, post)
+      end
+      
+      def void(identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        action = abort_or_void_from(identification)
+
+        commit(action, post)
+      end
+
+      # Crediting requires a new order_id to passed in, as well as a description
+      def credit(money, identification, options = {})
+        requires!(options, :order_id, :description)
+        
+        post = {}
+        
+        add_credit_reference(post, identification)
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        
+        commit(:credit, post)
+      end
+      
+      private
+      def add_reference(post, identification)
+        order_id, transaction_id, authorization, security_key = identification.split(';') 
+        
+        add_pair(post, :VendorTxCode, order_id)
+        add_pair(post, :VPSTxId, transaction_id)
+        add_pair(post, :TxAuthNo, authorization)
+        add_pair(post, :SecurityKey, security_key)
+      end
+      
+      def add_credit_reference(post, identification)
+        order_id, transaction_id, authorization, security_key = identification.split(';') 
+        
+        add_pair(post, :RelatedVendorTxCode, order_id)
+        add_pair(post, :RelatedVPSTxId, transaction_id)
+        add_pair(post, :RelatedTxAuthNo, authorization)
+        add_pair(post, :RelatedSecurityKey, security_key)
+      end
+      
+      def add_amount(post, money, options)
+        currency = options[:currency] || currency(money)
+        add_pair(post, :Amount, localized_amount(money, currency), :required => true)
+        add_pair(post, :Currency, currency, :required => true)
+      end
+
+      # doesn't actually use the currency -- dodgy!
+      def add_release_amount(post, money, options)
+        add_pair(post, :ReleaseAmount, amount(money), :required => true)
+      end
+
+      def add_customer_data(post, options)
+        add_pair(post, :CustomerEMail, options[:email][0,255]) unless options[:email].blank?
+        add_pair(post, :BillingPhone, options[:phone].gsub(/[^0-9+]/, '')[0,20]) unless options[:phone].blank?
+        add_pair(post, :ClientIPAddress, options[:ip])
+      end
+
+      def add_address(post, options)
+        if billing_address = options[:billing_address] || options[:address]
+          first_name, last_name = parse_first_and_last_name(billing_address[:name])
+          add_pair(post, :BillingSurname, last_name)
+          add_pair(post, :BillingFirstnames, first_name)
+          add_pair(post, :BillingAddress1, billing_address[:address1])
+          add_pair(post, :BillingAddress2, billing_address[:address2])
+          add_pair(post, :BillingCity, billing_address[:city])
+          add_pair(post, :BillingState, billing_address[:state]) if billing_address[:country] == 'US'
+          add_pair(post, :BillingCountry, billing_address[:country])
+          add_pair(post, :BillingPostCode, billing_address[:zip])
+        end
+        
+        if shipping_address = options[:shipping_address] || billing_address
+          first_name, last_name = parse_first_and_last_name(shipping_address[:name])
+          add_pair(post, :DeliverySurname, last_name)
+          add_pair(post, :DeliveryFirstnames, first_name)
+          add_pair(post, :DeliveryAddress1, shipping_address[:address1])
+          add_pair(post, :DeliveryAddress2, shipping_address[:address2])
+          add_pair(post, :DeliveryCity, shipping_address[:city])
+          add_pair(post, :DeliveryState, shipping_address[:state]) if shipping_address[:country] == 'US'
+          add_pair(post, :DeliveryCountry, shipping_address[:country])
+          add_pair(post, :DeliveryPostCode, shipping_address[:zip])
+        end
+      end
+
+      def add_invoice(post, options)
+        add_pair(post, :VendorTxCode, sanitize_order_id(options[:order_id]), :required => true)
+        add_pair(post, :Description, options[:description] || options[:order_id])
+      end
+
+      def add_credit_card(post, credit_card)
+        add_pair(post, :CardHolder, credit_card.name, :required => true)
+        add_pair(post, :CardNumber, credit_card.number, :required => true)
+         
+        add_pair(post, :ExpiryDate, format_date(credit_card.month, credit_card.year), :required => true)
+         
+        if requires_start_date_or_issue_number?(credit_card)
+          add_pair(post, :StartDate, format_date(credit_card.start_month, credit_card.start_year))
+          add_pair(post, :IssueNumber, credit_card.issue_number)
+        end
+        add_pair(post, :CardType, map_card_type(credit_card))
+        
+        add_pair(post, :CV2, credit_card.verification_value)
+      end
+      
+      def sanitize_order_id(order_id)
+        order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
+      end
+      
+      def map_card_type(credit_card)
+        raise ArgumentError, "The credit card type must be provided" if card_brand(credit_card).blank?
+        
+        card_type = card_brand(credit_card).to_sym
+        
+        # Check if it is an electron card
+        if card_type == :visa && credit_card.number =~ ELECTRON 
+          CREDIT_CARDS[:electron]
+        else  
+          CREDIT_CARDS[card_type]
+        end
+      end
+      
+      # MMYY format
+      def format_date(month, year)
+        return nil if year.blank? || month.blank?
+        
+        year  = sprintf("%.4i", year)
+        month = sprintf("%.2i", month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+      
+      def commit(action, parameters)
+        response = parse( ssl_post(url_for(action), post_data(action, parameters)) )
+          
+        Response.new(response["Status"] == APPROVED, message_from(response), response,
+          :test => test?,
+          :authorization => authorization_from(response, parameters, action),
+          :avs_result => { 
+            :street_match => AVS_CVV_CODE[ response["AddressResult"] ],
+            :postal_match => AVS_CVV_CODE[ response["PostCodeResult"] ],
+          },
+          :cvv_result => AVS_CVV_CODE[ response["CV2Result"] ]
+        )
+      end
+      
+      def authorization_from(response, params, action)
+         [ params[:VendorTxCode],
+           response["VPSTxId"],
+           response["TxAuthNo"],
+           response["SecurityKey"],
+           action ].join(";")
+      end
+
+      def abort_or_void_from(identification)
+        original_transaction = identification.split(';').last
+        original_transaction == 'authorization' ? :abort : :void
+      end
+
+      def url_for(action)
+        simulate ? build_simulator_url(action) : build_url(action)
+      end
+      
+      def build_url(action)
+        endpoint = [ :purchase, :authorization ].include?(action) ? "vspdirect-register" : TRANSACTIONS[action].downcase
+        "#{test? ? TEST_URL : LIVE_URL}/#{endpoint}.vsp"
+      end
+      
+      def build_simulator_url(action)
+        endpoint = [ :purchase, :authorization ].include?(action) ? "VSPDirectGateway.asp" : "VSPServerGateway.asp?Service=Vendor#{TRANSACTIONS[action].capitalize}Tx"
+        "#{SIMULATOR_URL}/#{endpoint}"
+      end
+
+      def message_from(response)
+        response['Status'] == APPROVED ? 'Success' : (response['StatusDetail'] || 'Unspecified error')    # simonr 20080207 can't actually get non-nil blanks, so this is shorter
+      end
+
+      def post_data(action, parameters = {})
+        parameters.update(
+          :Vendor => @options[:login],
+          :TxType => TRANSACTIONS[action],
+          :VPSProtocol => "2.23"
+        )
+        
+        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+      
+      # SagePay returns data in the following format
+      # Key1=value1
+      # Key2=value2
+      def parse(body)
+        result = {}
+        body.to_s.each_line do |pair|
+          result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im
+        end
+        result
+      end
+
+      def add_pair(post, key, value, options = {})
+        post[key] = value if !value.blank? || options[:required]
+      end
+
+      def parse_first_and_last_name(value)
+        name = value.to_s.split(' ')
+        
+        last_name = name.pop || ''
+        first_name = name.join(' ')
+        [ first_name[0,20], last_name[0,20] ]
+      end
+      
+      def localized_amount(money, currency)
+        amount = amount(money)
+        CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s) ? amount.split('.').first : amount
+      end
+    end
+  end
+end
+