activemerchant 1.28.0 → 1.29.1

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

@@ -8,7 +8,7 @@ module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     # TO USE:
     # First, make sure you have everything setup correctly and all of your dependencies in place with:
-    # 
+    #
     #   require 'rubygems'
     #   require 'active_merchant'
     #
@@ -63,12 +63,12 @@ module ActiveMerchant #:nodoc:
     #
     # This should be enough to get you started with Trust Commerce and active_merchant. For further information, review the methods
     # below and the rest of active_merchant's documentation, as well as Trust Commerce's user and developer documentation.
-    
+
     class TrustCommerceGateway < Gateway
       self.live_url = self.test_url = 'https://vault.trustcommerce.com/trans/'
-      
+
       SUCCESS_TYPES = ["approved", "accepted"]
-      
+
       DECLINE_CODES = {
         "decline"       => "The credit card was declined",
         "avs"           => "AVS failed; the address entered does not match the billing address on file at the bank",
@@ -78,13 +78,13 @@ module ActiveMerchant #:nodoc:
         "carderror"     => "Card number is invalid",
         "authexpired"   => "Attempt to postauth an expired (more than 14 days old) preauth",
         "fraud"         => "CrediGuard fraud score was below requested threshold",
-        "blacklist"     => "CrediGuard blacklist value was triggered", 
+        "blacklist"     => "CrediGuard blacklist value was triggered",
         "velocity"      => "CrediGuard velocity control value was triggered",
         "dailylimit"    => "Daily limit in transaction count or amount as been reached",
         "weeklylimit"   => "Weekly limit in transaction count or amount as been reached",
         "monthlylimit"  => "Monthly limit in transaction count or amount as been reached"
       }
-      
+
       BADDATA_CODES = {
         "missingfields"       => "One or more parameters required for this transaction type were not sent",
         "extrafields"         => "Parameters not allowed for this transaction type were sent",
@@ -93,32 +93,32 @@ module ActiveMerchant #:nodoc:
         "merchantcantaccept"  => "The merchant can't accept data passed in this field",
         "mismatch"            => "Data in one of the offending fields did not cross-check with the other offending field"
       }
-      
+
       ERROR_CODES = {
         "cantconnect"   => "Couldn't connect to the TrustCommerce gateway",
         "dnsfailure"    => "The TCLink software was unable to resolve DNS hostnames",
         "linkfailure"   => "The connection was established, but was severed before the transaction could complete",
         "failtoprocess" => "The bank servers are offline and unable to authorize transactions"
       }
-      
+
       TEST_LOGIN = 'TestMerchant'
       TEST_PASSWORD = 'password'
-      
+
       self.money_format = :cents
       self.supported_cardtypes = [:visa, :master, :discover, :american_express, :diners_club, :jcb]
       self.supported_countries = ['US']
       self.homepage_url = 'http://www.trustcommerce.com/'
       self.display_name = 'TrustCommerce'
-      
+
       def self.tclink?
         defined?(TCLink)
       end
-      
+
       # Creates a new TrustCommerceGateway
-      # 
+      #
       # The gateway requires that a valid login and password be passed
       # in the +options+ hash.
-      # 
+      #
       # ==== Options
       #
       # * <tt>:login</tt> -- The TrustCommerce account login.
@@ -130,44 +130,42 @@ module ActiveMerchant #:nodoc:
       # * <tt>:password</tt> -- password
       def initialize(options = {})
         requires!(options, :login, :password)
-      
-        @options = options
+
         super
       end
-      
+
       def tclink?
         self.class.tclink?
       end
-      
+
       def test?
-        @options[:login] == TEST_LOGIN &&
-          @options[:password] == TEST_PASSWORD || @options[:test] || super
+        ((@options[:login] == TEST_LOGIN && @options[:password] == TEST_PASSWORD) || super)
       end
-      
+
       # authorize() is the first half of the preauth(authorize)/postauth(capture) model. The TC API docs call this
       # preauth, we preserve active_merchant's nomenclature of authorize() for consistency with the rest of the library. This
       # method simply checks to make sure funds are available for a transaction, and returns a transid that can be used later to
       # postauthorize (capture) the funds.
-      
+
       def authorize(money, creditcard_or_billing_id, options = {})
         parameters = {
           :amount => amount(money),
-        }                                                             
-        
+        }
+
         add_order_id(parameters, options)
         add_customer_data(parameters, options)
         add_payment_source(parameters, creditcard_or_billing_id)
         add_addresses(parameters, options)
         commit('preauth', parameters)
       end
-      
+
       # purchase() is a simple sale. This is one of the most common types of transactions, and is extremely simple. All that you need
       # to process a purchase are an amount in cents or a money object and a creditcard object or billingid string.
-      def purchase(money, creditcard_or_billing_id, options = {})        
+      def purchase(money, creditcard_or_billing_id, options = {})
         parameters = {
           :amount => amount(money),
-        }                                                             
-        
+        }
+
         add_order_id(parameters, options)
         add_customer_data(parameters, options)
         add_payment_source(parameters, creditcard_or_billing_id)
@@ -183,62 +181,62 @@ module ActiveMerchant #:nodoc:
           :amount => amount(money),
           :transid => authorization,
         }
-                                                  
+
         commit('postauth', parameters)
       end
-      
+
       # refund() allows you to return money to a card that was previously billed. You need to supply the amount, in cents or a money object,
       # that you want to refund, and a TC transid for the transaction that you are refunding.
-      def refund(money, identification, options = {})  
+      def refund(money, identification, options = {})
         parameters = {
           :amount => amount(money),
           :transid => identification
         }
-                                                  
+
         commit('credit', parameters)
       end
 
-      def credit(money, identification, options = {})  
+      def credit(money, identification, options = {})
         deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options)
       end
-      
+
       # void() clears an existing authorization and releases the reserved fund
-      # s back to the cardholder. The TC API refers to this transaction as a 
-      # reversal. After voiding, you will no longer be able to capture funds 
-      # from this authorization. TrustCommerce seems to always return a status 
-      # of "accepted" even if the transid you are trying to deauthorize has 
-      # already been captured. Note: Your account needs to be configured by 
-      # TrustCommerce to allow for reversal transactions before you can use this 
-      # method. 
-      # 
-      # NOTE: AMEX preauth's cannot be reversed. If you want to clear it more 
-      # quickly than the automatic expiration (7-10 days), you will have to 
-      # capture it and then immediately issue a credit for the same amount 
+      # s back to the cardholder. The TC API refers to this transaction as a
+      # reversal. After voiding, you will no longer be able to capture funds
+      # from this authorization. TrustCommerce seems to always return a status
+      # of "accepted" even if the transid you are trying to deauthorize has
+      # already been captured. Note: Your account needs to be configured by
+      # TrustCommerce to allow for reversal transactions before you can use this
+      # method.
+      #
+      # NOTE: AMEX preauth's cannot be reversed. If you want to clear it more
+      # quickly than the automatic expiration (7-10 days), you will have to
+      # capture it and then immediately issue a credit for the same amount
       # which should clear the customers credit card with 48 hours according to
       # TC.
       def void(authorization, options = {})
         parameters = {
           :transid => authorization,
         }
-        
+
         commit('reversal', parameters)
       end
-      
+
       # recurring() a TrustCommerce account that is activated for Citatdel, TrustCommerce's
       # hosted customer billing info database.
       #
       # Recurring billing uses the same TC action as a plain-vanilla 'store', but we have a separate method for clarity. It can be called
       # like store, with the addition of a required 'periodicity' parameter:
-      # 
+      #
       # The parameter :periodicity should be specified as either :bimonthly, :monthly, :biweekly, :weekly, :yearly or :daily
       #
       #   gateway.recurring(tendollar, creditcard, :periodicity => :weekly)
       #
       # You can optionally specify how long you want payments to continue using 'payments'
-      def recurring(money, creditcard, options = {})        
+      def recurring(money, creditcard, options = {})
         requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily] )
-      
+
         cycle = case options[:periodicity]
         when :monthly
           '1m'
@@ -253,7 +251,7 @@ module ActiveMerchant #:nodoc:
         when :daily
           '1d'
         end
-        
+
         parameters = {
           :amount => amount(money),
           :cycle => cycle,
@@ -261,37 +259,37 @@ module ActiveMerchant #:nodoc:
           :billingid => options[:billingid] || nil,
           :payments => options[:payments] || nil,
         }
-        
+
         add_creditcard(parameters, creditcard)
-                                                  
+
         commit('store', parameters)
-      end      
-      
+      end
+
       # store() requires a TrustCommerce account that is activated for Citatdel. You can call it with a credit card and a billing ID
       # you would like to use to reference the stored credit card info for future captures. Use 'verify' to specify whether you want
       # to simply store the card in the DB, or you want TC to verify the data first.
-      
-      def store(creditcard, options = {})   
+
+      def store(creditcard, options = {})
         parameters = {
           :verify => options[:verify] || 'y',
           :billingid => options[:billingid] || options[:billing_id] || nil,
         }
-        
+
         add_creditcard(parameters, creditcard)
-        add_addresses(parameters, options)                              
+        add_addresses(parameters, options)
         commit('store', parameters)
       end
-      
+
       # To unstore a creditcard stored in Citadel using store() or recurring(), all that is required is the billing id. When you run
       # unstore() the information will be removed and a Response object will be returned indicating the success of the action.
       def unstore(identification, options = {})
         parameters = {
           :billingid => identification,
         }
-                                                  
+
         commit('unstore', parameters)
-      end      
-          
+      end
+
       private
       def add_payment_source(params, source)
         if source.is_a?(String)
@@ -300,39 +298,39 @@ module ActiveMerchant #:nodoc:
           add_creditcard(params, source)
         end
       end
-      
+
       def expdate(creditcard)
         year  = sprintf("%.4i", creditcard.year)
         month = sprintf("%.2i", creditcard.month)
 
         "#{month}#{year[-2..-1]}"
       end
-      
+
       def add_creditcard(params, creditcard)
         params[:media]     = "cc"
         params[:name]      = creditcard.name
-        params[:cc]        = creditcard.number      
+        params[:cc]        = creditcard.number
         params[:exp]       = expdate(creditcard)
         params[:cvv]       = creditcard.verification_value if creditcard.verification_value?
       end
-      
+
       def add_order_id(params, options)
         params[:ticket] = options[:order_id] unless options[:order_id].blank?
       end
-      
+
       def add_billing_id(params, billingid)
         params[:billingid] = billingid
       end
-      
+
       def add_customer_data(params, options)
         params[:email] = options[:email] unless options[:email].blank?
         params[:ip] = options[:ip] unless options[:ip].blank?
       end
-      
+
       def add_addresses(params, options)
         address = options[:billing_address] || options[:address]
-        
-        if address          
+
+        if address
           params[:address1]  = address[:address1] unless address[:address1].blank?
           params[:address2]  = address[:address2] unless address[:address2].blank?
           params[:city]      = address[:city]     unless address[:city].blank?
@@ -341,7 +339,7 @@ module ActiveMerchant #:nodoc:
           params[:country]   = address[:country]  unless address[:country].blank?
           params[:avs]       = 'n'
         end
-        
+
         if shipping_address = options[:shipping_address]
           params[:shipto_name]     = shipping_address[:name]     unless shipping_address[:name].blank?
           params[:shipto_address1] = shipping_address[:address1] unless shipping_address[:address1].blank?
@@ -352,7 +350,7 @@ module ActiveMerchant #:nodoc:
           params[:shipto_country]  = shipping_address[:country]  unless shipping_address[:country].blank?
         end
       end
-      
+
       def clean_and_stringify_params(parameters)
         # TCLink wants us to send a hash with string keys, and activemerchant pushes everything around with
         # symbol keys. Before sending our input to TCLink, we convert all our keys to strings and dump the symbol keys.
@@ -364,50 +362,50 @@ module ActiveMerchant #:nodoc:
           parameters.delete(key)
         end
       end
-      
+
       def post_data(parameters)
         parameters.collect { |key, value| "#{key}=#{ CGI.escape(value.to_s)}" }.join("&")
       end
-  
+
       def commit(action, parameters)
         parameters[:custid]      = @options[:login]
         parameters[:password]    = @options[:password]
         parameters[:demo]        = test? ? 'y' : 'n'
         parameters[:action]      = action
-                
+
         clean_and_stringify_params(parameters)
-        
+
         data = if tclink?
           TCLink.send(parameters)
         else
           parse( ssl_post(self.live_url, post_data(parameters)) )
         end
-        
+
         # to be considered successful, transaction status must be either "approved" or "accepted"
         success = SUCCESS_TYPES.include?(data["status"])
         message = message_from(data)
-        Response.new(success, message, data, 
-          :test => test?, 
+        Response.new(success, message, data,
+          :test => test?,
           :authorization => data["transid"],
           :cvv_result => data["cvv"],
           :avs_result => { :code => data["avs"] }
         )
       end
-      
+
       def parse(body)
         results = {}
-        
+
         body.split(/\n/).each do |pair|
           key,val = pair.split(/=/)
           results[key] = val
         end
-        
+
         results
       end
-      
-      def message_from(data)        
+
+      def message_from(data)
         status = case data["status"]
-        when "decline" 
+        when "decline"
           return DECLINE_CODES[data["declinetype"]]
         when "baddata"
           return BADDATA_CODES[data["error"]]
@@ -417,7 +415,7 @@ module ActiveMerchant #:nodoc:
           return "The transaction was successful"
         end
       end
-      
+
     end
   end
 end

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

@@ -5,7 +5,7 @@ module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     # ==== USA ePay Advanced SOAP Interface
     #
-    # This class encapuslates USA ePay's Advanced SOAP Interface. The Advanced Soap Interface allows 
+    # This class encapuslates USA ePay's Advanced SOAP Interface. The Advanced Soap Interface allows
     # standard transactions, storing customer information, and recurring billing. Storing sensitive
     # information on USA ePay's servers can help with PCI DSS compliance, since customer and card data
     # do not need to be stored locally.
@@ -63,7 +63,7 @@ module ActiveMerchant #:nodoc:
     #
     class UsaEpayAdvancedGateway < Gateway
       API_VERSION = "1.4"
-      
+
       TEST_URL_BASE = 'https://sandbox.usaepay.com/soap/gate/' #:nodoc:
       LIVE_URL_BASE = 'https://www.usaepay.com/soap/gate/' #:nodoc:
 
@@ -71,7 +71,7 @@ module ActiveMerchant #:nodoc:
       self.live_url = LIVE_URL_BASE
 
       FAILURE_MESSAGE = "Default Failure" #:nodoc:
-      
+
       self.supported_countries = ['US']
       self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
       self.homepage_url = 'http://www.usaepay.com/'
@@ -154,7 +154,7 @@ module ActiveMerchant #:nodoc:
         :currency => [:string, 'Currency'],
         :non_tax => [:boolean, 'NonTax'],
       } #:nodoc:
-      
+
       TRANSACTION_DETAIL_MONEY_OPTIONS = {
         :amount => [:double, 'Amount'],
         :tax => [:double, 'Tax'],
@@ -235,15 +235,14 @@ module ActiveMerchant #:nodoc:
       # * <tt>:soap_response</tt> -- set to +true+ to add :soap_response to the params hash containing the entire soap xml message
       #
       def initialize(options = {})
-        requires! options, :login, :password
-        @options = options
+        requires!(options, :login, :password)
 
-        if @options[:software_id]
-          self.live_url = "#{LIVE_URL_BASE}#{@options[:software_id].to_s}"
-          self.test_url = "#{TEST_URL_BASE}#{@options[:software_id].to_s}"
+        if options[:software_id]
+          self.live_url = "#{LIVE_URL_BASE}#{options[:software_id].to_s}"
+          self.test_url = "#{TEST_URL_BASE}#{options[:software_id].to_s}"
         else
-          self.live_url = @options[:live_url].to_s
-          self.test_url = @options[:test_url].to_s if @options[:test_url]
+          self.live_url = options[:live_url].to_s
+          self.test_url = options[:test_url].to_s if options[:test_url]
         end
 
         super
@@ -251,7 +250,7 @@ module ActiveMerchant #:nodoc:
 
       # Standard Gateway Methods ======================================
 
-      # Make a purchase with a credit card. (Authorize and 
+      # Make a purchase with a credit card. (Authorize and
       # capture for settlement.)
       #
       # Note: See run_transaction for additional options.
@@ -302,7 +301,7 @@ module ActiveMerchant #:nodoc:
       # * <tt>:data</tt> -- base64 data about customer
       # * <tt>:url</tt> -- customer website
       # * <tt>:billing_address</tt> -- usual options
-      # * <tt>:payment_methods</tt> -- array of payment method hashes. 
+      # * <tt>:payment_methods</tt> -- array of payment method hashes.
       #   * <tt>:method</tt> -- credit_card or check
       #   * <tt>:name</tt> -- optional name/label for the method
       #   * <tt>:sort</tt> -- optional integer value specifying the backup sort order, 0 is default
@@ -531,7 +530,7 @@ module ActiveMerchant #:nodoc:
       # Run a transaction.
       #
       # Note: run_sale, run_auth_only, run_credit, run_check_sale, run_check_credit
-      # methods are also available. Each takes the same options as 
+      # methods are also available. Each takes the same options as
       # run_transaction, but the :command option is not required.
       #
       # Recurring Note: If recurring options are included USA ePay will create a
@@ -589,7 +588,7 @@ module ActiveMerchant #:nodoc:
       end
 
       TRANSACTION_METHODS = [
-        :run_sale, :run_auth_only, :run_credit, 
+        :run_sale, :run_auth_only, :run_credit,
         :run_check_sale, :run_check_credit
       ] #:nodoc:
 
@@ -639,7 +638,7 @@ module ActiveMerchant #:nodoc:
         request = build_request(__method__, options)
         commit(__method__, request)
       end
-    
+
       # Void a transaction.
       #
       # Note: Can only be voided before being settled.
@@ -656,7 +655,7 @@ module ActiveMerchant #:nodoc:
         request = build_request(__method__, options)
         commit(__method__, request)
       end
-    
+
       # Refund transaction.
       #
       # Note: Required after a transaction has been settled. Refunds
@@ -675,7 +674,7 @@ module ActiveMerchant #:nodoc:
         request = build_request(__method__, options)
         commit(__method__, request)
       end
-    
+
       # Override transaction flagged for mananager approval.
       #
       # Note: Checks only!
@@ -812,7 +811,7 @@ module ActiveMerchant #:nodoc:
       end
 
       # Check status of a transaction (custom).
-      # 
+      #
       # ==== Required
       # * <tt>:reference_number</tt>
       # * <tt>:fields</tt> -- string array of fields to retrieve
@@ -937,7 +936,7 @@ module ActiveMerchant #:nodoc:
       end
 
       # Builders ======================================================
-      
+
       private
 
       # Build soap header, etc.
@@ -1062,7 +1061,7 @@ module ActiveMerchant #:nodoc:
       end
 
       # Transactions ==================================================
-      
+
       def build_run_transaction(soap, options)
         soap.tag! 'ns1:runTransaction' do |soap|
           build_token soap, options
@@ -1213,7 +1212,7 @@ module ActiveMerchant #:nodoc:
       def build_customer_payments(soap, options)
         if options[:payment_methods]
           length = options[:payment_methods].length
-          soap.PaymentMethods 'SOAP-ENC:arrayType' => "ns1:PaymentMethod[#{length}]", 
+          soap.PaymentMethods 'SOAP-ENC:arrayType' => "ns1:PaymentMethod[#{length}]",
             'xsi:type' =>"ns1:PaymentMethodArray" do |soap|
             build_customer_payment_methods soap, options
           end
@@ -1239,7 +1238,7 @@ module ActiveMerchant #:nodoc:
         case
         when payment_method[:method].kind_of?(ActiveMerchant::Billing::CreditCard)
           build_tag soap, :string, 'CardNumber', payment_method[:method].number
-          build_tag soap, :string, 'CardExpiration', 
+          build_tag soap, :string, 'CardExpiration',
             "#{"%02d" % payment_method[:method].month}#{payment_method[:method].year}"
           if options[:billing_address]
             build_tag soap, :string, 'AvsStreet', options[:billing_address][:address1]
@@ -1319,7 +1318,7 @@ module ActiveMerchant #:nodoc:
       def build_credit_card_data(soap, options)
         soap.CreditCardData 'xsi:type' => "ns1:CreditCardData" do |soap|
           build_tag soap, :string, 'CardNumber', options[:payment_method].number
-          build_tag soap, :string, 'CardExpiration', 
+          build_tag soap, :string, 'CardExpiration',
             "#{"%02d" % options[:payment_method].month}#{options[:payment_method].year}"
           if options[:billing_address]
             build_tag soap, :string, 'AvsStreet', options[:billing_address][:address1]
@@ -1397,7 +1396,7 @@ module ActiveMerchant #:nodoc:
 
       def build_line_items(soap, options) # TODO
       end
-      
+
       def build_custom_fields(soap, options) # TODO
       end
 
@@ -1444,7 +1443,7 @@ module ActiveMerchant #:nodoc:
         fault = (!response) || (response.length < 1) || response.has_key?('faultcode')
         return [response, success, response['faultstring'], authorization, avs, cvv] if fault
 
-        if response.respond_to?(:[]) && p = response["#{action}_return"] 
+        if response.respond_to?(:[]) && p = response["#{action}_return"]
           if p.respond_to?(:key?) && p.key?('result_code')
             success = p['result_code'] == 'A' ? true : false
             authorization = p['ref_num']
@@ -1481,8 +1480,8 @@ module ActiveMerchant #:nodoc:
                 response[key] = [response[key], value]
               end
             else
-              response[key] = parse_element(e) 
-            end 
+              response[key] = parse_element(e)
+            end
           end
         else
           response = node.text

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

@@ -19,7 +19,6 @@ module ActiveMerchant #:nodoc:
 
       def initialize(options = {})
         requires!(options, :login)
-        @options = options
         super
       end
 
@@ -66,10 +65,6 @@ module ActiveMerchant #:nodoc:
         commit(:void, post)
       end
 
-      def test?
-        @options[:test] || super
-      end
-
       private
 
       def add_amount(post, money)