activemerchant 1.25.0 → 1.26.0

data/CHANGELOG

@@ -1,5 +1,16 @@
 = ActiveMerchant CHANGELOG
 
+== Version 1.26.0 (July 6, 2012)
+
+* Orbital gateway: fix broken requests by ensuring the order of XML elements matches their DTD [Soleone]
+* CyberSource gateway: clean up formatting [ntalbott]
+* Netbilling gateway: Add refund/credit/void support [ntalbott]
+* Add PayGate XML gateway [rubyisbeautiful]
+* Add PayWay gateway [BenZhang]
+* PayWay gateway: Tweaks to make more ActiveMerchant like [ntalbott]
+* Netbilling gateway: Fix error handling [ntalbott]
+* Netbilling gateway: Add refund/credit/void support [zenom, ntalbott]
+
 == Version 1.25.0 (July 3, 2012)
 
 * eWAY gateway: Add support for Diners Club cards [Soleone]

data/CONTRIBUTORS

@@ -317,3 +317,11 @@ Metrics Global gateway (June 2012)
 EasyPay integration (July 2012)
 
 * Vasiliy Ermolovich (nashby)
+
+PayGateXML gateway (July 2012)
+
+* bryan (rubyisbeautiful)
+
+PayWay gateway (July 2012)
+
+* Ben Zhang (BenZhang)

data/README.md

@@ -45,18 +45,18 @@ credit card details.
 
 	require 'rubygems'
 	require 'active_merchant'
-	
+
 	# Use the TrustCommerce test servers
 	ActiveMerchant::Billing::Base.mode = :test
 
 	gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
 	            :login => 'TestMerchant',
 	            :password => 'password')
-	
+
 	# ActiveMerchant accepts all amounts as Integer values in cents
 	amount = 1000  # $10.00
-	
-	# The card verification value is also known as CVV2, CVC2, or CID 
+
+	# The card verification value is also known as CVV2, CVC2, or CID
 	credit_card = ActiveMerchant::Billing::CreditCard.new(
 	                :first_name         => 'Bob',
 	                :last_name          => 'Bobsen',
@@ -64,16 +64,16 @@ credit card details.
 	                :month              => '8',
 	                :year               => '2012',
 	                :verification_value => '123')
-	
+
 	# Validating the card automatically detects the card type
 	if credit_card.valid?
 	  # Capture $10 from the credit card
 	  response = gateway.purchase(amount, credit_card)
-	
+
 	  if response.success?
 	    puts "Successfully charged $#{sprintf("%.2f", amount / 100)} to the credit card #{credit_card.display_number}"
 	  else
-	    raise StandardError, response.message 
+	    raise StandardError, response.message
 	  end
 	end
 
@@ -126,6 +126,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [Optimal Payments](http://www.optimalpayments.com/) - CA, US, UK
 * [Orbital Paymentech](http://chasepaymentech.com/) - CA, US
 * [PayBox Direct](http://www.paybox.com) - FR
+* [PayGate PayXML](http://paygate.co.za/) - US, ZA
 * [PayJunction](http://www.payjunction.com/) - US
 * [PaymentExpress](http://www.paymentexpress.com/) - AU, MY, NZ, SG, ZA, UK, US
 * [PayPal Express Checkout](https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside) - US, CA, SG, AU
@@ -135,6 +136,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [PayPal Express Checkout](https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside) - US
 * [PayPal Website Payments Pro (US)](https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside) - US
 * [PaySecure](http://www.commsecure.com.au/paysecure.shtml) - AU
+* [PayWay](https://www.payway.com.au) - AU
 * [Plug'n Pay](http://www.plugnpay.com/) - US
 * [Psigate](http://www.psigate.com/) - CA
 * [PSL Payment Solutions](http://www.paymentsolutionsltd.com/) - UK

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

@@ -1,39 +1,48 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # See the remote and mocked unit test files for example usage.  Pay special attention to the contents of the options hash.
+    # See the remote and mocked unit test files for example usage.  Pay special
+    # attention to the contents of the options hash.
     #
-    # Initial setup instructions can be found in http://cybersource.com/support_center/implementation/downloads/soap_api/SOAP_toolkits.pdf
-    # 
-    # Debugging 
-    # If you experience an issue with this gateway be sure to examine the transaction information from a general transaction search inside the CyberSource Business
-    # Center for the full error messages including field names.   
+    # Initial setup instructions can be found in
+    # http://cybersource.com/support_center/implementation/downloads/soap_api/SOAP_toolkits.pdf
+    #
+    # Debugging
+    # If you experience an issue with this gateway be sure to examine the
+    # transaction information from a general transaction search inside the
+    # CyberSource Business Center for the full error messages including field
+    # names.
     #
     # Important Notes
-    # * AVS and CVV only work against the production server.  You will always get back X for AVS and no response for CVV against the test server. 
-    # * Nexus is the list of states or provinces where you have a physical presence.  Nexus is used to calculate tax.  Leave blank to tax everyone.  
-    # * If you want to calculate VAT for overseas customers you must supply a registration number in the options hash as vat_reg_number. 
-    # * productCode is a value in the line_items hash that is used to tell CyberSource what kind of item you are selling.  It is used when calculating tax/VAT.
+    # * AVS and CVV only work against the production server.  You will always
+    #   get back X for AVS and no response for CVV against the test server.
+    # * Nexus is the list of states or provinces where you have a physical
+    #   presence.  Nexus is used to calculate tax.  Leave blank to tax everyone.
+    # * If you want to calculate VAT for overseas customers you must supply a
+    #   registration number in the options hash as vat_reg_number.
+    # * productCode is a value in the line_items hash that is used to tell
+    #   CyberSource what kind of item you are selling.  It is used when
+    #   calculating tax/VAT.
     # * All transactions use dollar values.
     class CyberSourceGateway < Gateway
       TEST_URL = 'https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor'
       LIVE_URL = 'https://ics2ws.ic3.com/commerce/1.x/transactionProcessor'
 
       XSD_VERSION = "1.69"
-          
+
       # visa, master, american_express, discover
       self.supported_cardtypes = [:visa, :master, :american_express, :discover]
       self.supported_countries = ['US']
       self.default_currency = 'USD'
       self.homepage_url = 'http://www.cybersource.com'
       self.display_name = 'CyberSource'
-  
+
       # map credit card to the CyberSource expected representation
       @@credit_card_codes = {
         :visa  => '001',
         :master => '002',
         :american_express => '003',
         :discover => '004'
-      } 
+      }
 
       # map response codes to something humans can read
       @@response_codes = {
@@ -45,17 +54,17 @@ module ActiveMerchant #:nodoc:
         :r152 => "The request was received, but a service timed out",
         :r200 => "The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the AVS check",
         :r201 => "The issuing bank has questions about the request",
-        :r202 => "Expired card", 
-        :r203 => "General decline of the card", 
-        :r204 => "Insufficient funds in the account", 
-        :r205 => "Stolen or lost card", 
-        :r207 => "Issuing bank unavailable", 
-        :r208 => "Inactive card or card not authorized for card-not-present transactions", 
-        :r209 => "American Express Card Identifiction Digits (CID) did not match", 
-        :r210 => "The card has reached the credit limit", 
-        :r211 => "Invalid card verification number", 
-        :r221 => "The customer matched an entry on the processor's negative file", 
-        :r230 => "The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the card verification check", 
+        :r202 => "Expired card",
+        :r203 => "General decline of the card",
+        :r204 => "Insufficient funds in the account",
+        :r205 => "Stolen or lost card",
+        :r207 => "Issuing bank unavailable",
+        :r208 => "Inactive card or card not authorized for card-not-present transactions",
+        :r209 => "American Express Card Identifiction Digits (CID) did not match",
+        :r210 => "The card has reached the credit limit",
+        :r211 => "Invalid card verification number",
+        :r221 => "The customer matched an entry on the processor's negative file",
+        :r230 => "The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the card verification check",
         :r231 => "Invalid account number",
         :r232 => "The card type is not accepted by the payment processor",
         :r233 => "General decline by the processor",
@@ -74,44 +83,48 @@ module ActiveMerchant #:nodoc:
         :r247 => "You requested a credit for a capture that was previously voided",
         :r250 => "The request was received, but a time-out occurred with the payment processor",
         :r254 => "Your CyberSource account is prohibited from processing stand-alone refunds",
-        :r255 => "Your CyberSource account is not configured to process the service in the country you specified" 
+        :r255 => "Your CyberSource account is not configured to process the service in the country you specified"
       }
 
-      # These are the options that can be used when creating a new CyberSource Gateway object.
-      # 
-      # :login =>  your username 
+      # These are the options that can be used when creating a new CyberSource
+      # Gateway object.
       #
-      # :password =>  the transaction key you generated in the Business Center       
+      # :login =>  your username
+      #
+      # :password =>  the transaction key you generated in the Business Center
       #
       # :test => true   sets the gateway to test mode
       #
-      # :vat_reg_number => your VAT registration number  
+      # :vat_reg_number => your VAT registration number
       #
-      # :nexus => "WI CA QC" sets the states/provinces where you have a physical presense for tax purposes
+      # :nexus => "WI CA QC" sets the states/provinces where you have a physical
+      #           presense for tax purposes
       #
-      # :ignore_avs => true   don't want to use AVS so continue processing even if AVS would have failed 
+      # :ignore_avs => true   don't want to use AVS so continue processing even
+      #                       if AVS would have failed
       #
-      # :ignore_cvv => true   don't want to use CVV so continue processing even if CVV would have failed 
+      # :ignore_cvv => true   don't want to use CVV so continue processing even
+      #                       if CVV would have failed
       def initialize(options = {})
         requires!(options, :login, :password)
         @options = options
         super
-      end  
+      end
 
       # Should run against the test servers or not?
       def test?
         @options[:test] || Base.gateway_mode == :test
       end
-      
-      # Request an authorization for an amount from CyberSource 
+
+      # Request an authorization for an amount from CyberSource
       #
-      # You must supply an :order_id in the options hash 
+      # You must supply an :order_id in the options hash
       def authorize(money, creditcard_or_reference, options = {})
         requires!(options,  :order_id)
         setup_address_hash(options)
         commit(build_auth_request(money, creditcard_or_reference, options), options )
       end
-      
+
       def auth_reversal(money, identification, options = {})
         commit(build_auth_reversal_request(money, identification, options), options)
       end
@@ -123,13 +136,13 @@ module ActiveMerchant #:nodoc:
       end
 
       # Purchase is an auth followed by a capture
-      # You must supply an order_id in the options hash  
+      # You must supply an order_id in the options hash
       def purchase(money, creditcard_or_reference, options = {})
         requires!(options, :order_id)
         setup_address_hash(options)
         commit(build_purchase_request(money, creditcard_or_reference, options), options)
       end
-      
+
       def void(identification, options = {})
         commit(build_void_request(identification, options), options)
       end
@@ -137,14 +150,15 @@ module ActiveMerchant #:nodoc:
       def refund(money, identification, options = {})
         commit(build_credit_request(money, identification, options), options)
       end
-      
+
       def credit(money, identification, options = {})
         deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options)
       end
 
       # Stores a customer subscription/profile with type "on-demand".
-      # To charge the card while creating a profile, pass options[:setup_fee] => money
+      # To charge the card while creating a profile, pass
+      # options[:setup_fee] => money
       def store(creditcard, options = {})
         requires!(options, :order_id)
         setup_address_hash(options)
@@ -170,11 +184,13 @@ module ActiveMerchant #:nodoc:
         commit(build_retrieve_subscription_request(reference, options), options)
       end
 
-      # CyberSource requires that you provide line item information for tax calculations
-      # If you do not have prices for each item or want to simplify the situation then pass in one fake line item that costs the subtotal of the order
+      # CyberSource requires that you provide line item information for tax
+      # calculations. If you do not have prices for each item or want to
+      # simplify the situation then pass in one fake line item that costs the
+      # subtotal of the order
+      #
+      # The line_item hash goes in the options hash and should look like
       #
-      # The line_item hash goes in the options hash and should look like 
-      # 
       #         :line_items => [
       #           {
       #             :declared_value => '1',
@@ -197,17 +213,18 @@ module ActiveMerchant #:nodoc:
       def calculate_tax(creditcard, options)
         requires!(options,  :line_items)
         setup_address_hash(options)
-        commit(build_tax_calculation_request(creditcard, options), options)	  
+        commit(build_tax_calculation_request(creditcard, options), options)
       end
-      
+
       private
 
-      # Create all address hash key value pairs so that we still function if we were only provided with one or two of them 
+      # Create all address hash key value pairs so that we still function if we
+      # were only provided with one or two of them
       def setup_address_hash(options)
         options[:billing_address] = options[:billing_address] || options[:address] || {}
         options[:shipping_address] = options[:shipping_address] || {}
       end
-      
+
       def build_auth_request(money, creditcard_or_reference, options)
         xml = Builder::XmlMarkup.new :indent => 2
         add_creditcard_or_subscription(xml, money, creditcard_or_reference, options)
@@ -226,7 +243,7 @@ module ActiveMerchant #:nodoc:
         add_business_rules_data(xml)
         xml.target!
       end
- 
+
       def build_capture_request(money, authorization, options)
         order_id, request_id, request_token = authorization.split(";")
         options[:order_id] = order_id
@@ -236,7 +253,7 @@ module ActiveMerchant #:nodoc:
         add_capture_service(xml, request_id, request_token)
         add_business_rules_data(xml)
         xml.target!
-      end 
+      end
 
       def build_purchase_request(money, creditcard_or_reference, options)
         xml = Builder::XmlMarkup.new :indent => 2
@@ -245,11 +262,11 @@ module ActiveMerchant #:nodoc:
         add_business_rules_data(xml)
         xml.target!
       end
-      
+
       def build_void_request(identification, options)
         order_id, request_id, request_token = identification.split(";")
         options[:order_id] = order_id
-        
+
         xml = Builder::XmlMarkup.new :indent => 2
         add_void_service(xml, request_id, request_token)
         xml.target!
@@ -267,11 +284,11 @@ module ActiveMerchant #:nodoc:
       def build_credit_request(money, identification, options)
         order_id, request_id, request_token = identification.split(";")
         options[:order_id] = order_id
-        
+
         xml = Builder::XmlMarkup.new :indent => 2
         add_purchase_data(xml, money, true, options)
         add_credit_service(xml, request_id, request_token)
-        
+
         xml.target!
       end
 
@@ -320,13 +337,13 @@ module ActiveMerchant #:nodoc:
         xml.tag! 'businessRules' do
           xml.tag!('ignoreAVSResult', 'true') if @options[:ignore_avs]
           xml.tag!('ignoreCVResult', 'true') if @options[:ignore_cvv]
-        end 
+        end
       end
-      
+
       def add_line_item_data(xml, options)
         options[:line_items].each_with_index do |value, index|
           xml.tag! 'item', {'id' => index} do
-            xml.tag! 'unitPrice', amount(value[:declared_value])  
+            xml.tag! 'unitPrice', amount(value[:declared_value])
             xml.tag! 'quantity', value[:quantity]
             xml.tag! 'productCode', value[:code] || 'shipping_only'
             xml.tag! 'productName', value[:description]
@@ -334,7 +351,7 @@ module ActiveMerchant #:nodoc:
           end
         end
       end
-      
+
       def add_merchant_data(xml, options)
         xml.tag! 'merchantID', @options[:login]
         xml.tag! 'merchantReferenceCode', options[:order_id]
@@ -346,7 +363,7 @@ module ActiveMerchant #:nodoc:
       def add_purchase_data(xml, money = 0, include_grand_total = false, options={})
         xml.tag! 'purchaseTotals' do
           xml.tag! 'currency', options[:currency] || currency(money)
-          xml.tag!('grandTotalAmount', amount(money))  if include_grand_total 
+          xml.tag!('grandTotalAmount', amount(money))  if include_grand_total
         end
       end
 
@@ -368,10 +385,10 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'email',                 options[:email]
           xml.tag! 'driversLicenseNumber',  options[:drivers_license_number]  unless options[:drivers_license_number].blank?
           xml.tag! 'driversLicenseState',   options[:drivers_license_state]   unless options[:drivers_license_state].blank?
-        end 
+        end
       end
 
-      def add_creditcard(xml, creditcard)      
+      def add_creditcard(xml, creditcard)
         xml.tag! 'card' do
           xml.tag! 'accountNumber', creditcard.number
           xml.tag! 'expirationMonth', format(creditcard.month, :two_digits)
@@ -389,7 +406,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_auth_service(xml)
-        xml.tag! 'ccAuthService', {'run' => 'true'} 
+        xml.tag! 'ccAuthService', {'run' => 'true'}
       end
 
       def add_capture_service(xml, request_id, request_token)
@@ -446,7 +463,7 @@ module ActiveMerchant #:nodoc:
 
         xml.tag! 'recurringSubscriptionInfo' do
           if reference
-            reference_code, subscription_id, request_token = reference.split(";")
+            _, subscription_id, _ = reference.split(";")
             xml.tag! 'subscriptionID',  subscription_id
           end
 
@@ -479,7 +496,7 @@ module ActiveMerchant #:nodoc:
           add_creditcard(xml, creditcard_or_reference)
         end
       end
-      
+
       # Where we actually build the full SOAP request using builder
       def build_request(body, options)
         xml = Builder::XmlMarkup.new :indent => 2
@@ -500,25 +517,26 @@ module ActiveMerchant #:nodoc:
               end
             end
           end
-        xml.target! 
+        xml.target!
       end
-      
-      # Contact CyberSource, make the SOAP request, and parse the reply into a Response object
+
+      # Contact CyberSource, make the SOAP request, and parse the reply into a
+      # Response object
       def commit(request, options)
-	      response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, build_request(request, options)))
-        
-	      success = response[:decision] == "ACCEPT"
-	      message = @@response_codes[('r' + response[:reasonCode]).to_sym] rescue response[:message] 
+        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, build_request(request, options)))
+
+        success = response[:decision] == "ACCEPT"
+        message = @@response_codes[('r' + response[:reasonCode]).to_sym] rescue response[:message]
         authorization = success ? [ options[:order_id], response[:requestID], response[:requestToken] ].compact.join(";") : nil
-        
-        Response.new(success, message, response, 
-          :test => test?, 
+
+        Response.new(success, message, response,
+          :test => test?,
           :authorization => authorization,
           :avs_result => { :code => response[:avsCode] },
           :cvv_result => response[:cvCode]
         )
       end
-      
+
       # Parse the SOAP response
       # Technique inspired by the Paypal Gateway
       def parse(xml)
@@ -526,19 +544,19 @@ module ActiveMerchant #:nodoc:
         xml = REXML::Document.new(xml)
         if root = REXML::XPath.first(xml, "//c:replyMessage")
           root.elements.to_a.each do |node|
-            case node.name  
+            case node.name
             when 'c:reasonCode'
               reply[:message] = reply(node.text)
             else
               parse_element(reply, node)
             end
           end
-        elsif root = REXML::XPath.first(xml, "//soap:Fault") 
+        elsif root = REXML::XPath.first(xml, "//soap:Fault")
           parse_element(reply, root)
           reply[:message] = "#{reply[:faultcode]}: #{reply[:faultstring]}"
         end
         return reply
-      end     
+      end
 
       def parse_element(reply, node)
         if node.has_elements?
@@ -547,12 +565,12 @@ module ActiveMerchant #:nodoc:
           if node.parent.name =~ /item/
             parent = node.parent.name + (node.parent.attributes["id"] ? "_" + node.parent.attributes["id"] : '')
             reply[(parent + '_' + node.name).to_sym] = node.text
-          else  
+          else
             reply[node.name.to_sym] = node.text
           end
         end
         return reply
       end
-    end 
-  end 
-end 
+    end
+  end
+end