activemerchant 1.29.3 → 1.30.0

data/CHANGELOG

@@ -1,7 +1,46 @@
 = ActiveMerchant CHANGELOG
 
+== Version 1.30.0 (February 13, 2013)
+
+* Add FirstData Global Gateway e4 [frobcode]
+* PaymentExpress: Add support for optional fields: ClientType and TxnData [moklett]
+* PaymentExpress: Limit MerchantReference/description to 64 chars [moklett]
+* Wirecard: description must be no more than 32 characters [moklett]
+* Litle: Add support for passing a token to the authorize and purchase methods [forest]
+* PayPal Common: Allow searching for transactions by ProfileID [aq1018]
+* Add Spreedly Core gateway [duff]
+* eWay Gateway: Return proper value for authorization [duff]
+* eWay Gateway: Add support for refunds [duff]
+* Quickpay: Add support for protocols 5 & 6 [twarberg]
+* Banwire gateway: Handle JSON::ParserError [duff]
+* Balanced gateway: Fix unspecified marketplace [duff]
+* QBMS gateway: Allow partial addresses [duff]
+* Authorize.Net CIM: Allow omitting card expiration date [shanebonham]
+* Authorize.Net CIM: Add support for extraOptions to createCustomerProfileTransaction [tpiekos]
+* Add NETPAY gateway [samlown]
+* Balanced gateway: Add amount to the refund method signature [ntalbott]
+* Orbital gateway: Fix void method signature [aprofeit, ntalbott]
+* Eway Managed: Add 'query_customer' API as #retrieve [cdaloisio]
+* NetPay: Fix the signature for void [duff]
+* Cybersource: Add check support [bowmande]
+* Moneris: Use a capture of $0 for void [ntalbott]
+* PayPal Express integration: Fix received_at time zone [ntalbott]
+* NAB Transact: Add refund capability [nagash]
+* Stripe: Add support for application_fee [duff]
+* SagePay: Add support for GiftAidPayment [duff]
+* Wirecard: Add support for partial captures [richardblair]
+* Add Pin gateway [madpilot]
+* Balanced: Added support for on_behalf_of_uri to capture [cwise]
+* Litle: Add support for passing an order_source [forest]
+* Add Merchant Warrior gateway [pronix, Fodoj, ntalbott]
+* Use v4 of the MerchantWare API for voiding transactions [melari]
+* Add support for Authorize.net in CA and GB [melari]
+* Send customer's IP to Beanstream for fraud review [melari]
+
 == Version 1.29.3 (December 7, 2012)
 
+* Braintree Blue: Better wiredump_device support [ntalbott]
+* Braintree: Store sets vault id as authorization [ntalbott]
 * WorldPay: Fix currencies without fractions like JPY and HUF by rounding down amount [Soleone]
 
 == Version 1.29.2 (December 7, 2012)

data/CONTRIBUTORS

@@ -357,3 +357,22 @@ Liqpay integration (November 2012)
 eWay Rapid 3.0 gateway (December 2012)
 
 * Nathaniel Talbott (ntalbott)
+
+FirstData Global Gateway e4 (December 2012)
+
+* Chris Sheppard (frobcode)
+
+Spreedly Core gateway (December 2012)
+
+* Duff OMelia (duff)
+
+Pin gateway (February 2013)
+
+* Myles Eftos (madpilot)
+
+Merchant Warrior
+
+* Ben Bruscella (benbruscella)
+* Дмитрий Василец (pronix)
+* Kirill Shirinkin (Fodoj)
+* Nathaniel Talbott (ntalbott)

data/README.md

@@ -4,11 +4,13 @@ Active Merchant is an extraction from the e-commerce system [Shopify](http://www
 Shopify's requirements for a simple and unified API to access dozens of different payment
 gateways with very different internal APIs was the chief principle in designing the library.
 
-Active Merchant has been in production use since June 2006 and is now used in most modern
-Ruby applications which deal with financial transactions.
-
 It was developed for usage in Ruby on Rails web applications and integrates seamlessly
-as a plugin but it also works excellently as a stand alone library.
+as a Rails plugin, but it also works excellently as a stand alone Ruby library.
+
+Active Merchant has been in production use since June 2006 and is now used in most modern
+Ruby applications which deal with financial transactions. It is maintained by the
+[Shopify](http://www.shopify.com) and [Spreedly](https://spreedly.com) teams, with much help
+from an ever-growing set of contributors.
 
 See {file:GettingStarted.md} if you want to learn more about using Active Merchant in your
 applications.
@@ -21,61 +23,54 @@ You can check out the latest source from git:
 
     git clone git://github.com/Shopify/active_merchant.git
 
-### As a Rails plugin
-
-ActiveMerchant includes an init.rb file. This means that Rails will automatically load ActiveMerchant on startup. Run
-the following command from the root directory of your Rails project to install ActiveMerchant as a Rails plugin:
-
-    script/plugin install git://github.com/Shopify/active_merchant.git
-
 ### From RubyGems
 
-Installation from RubyGems
+Installation from RubyGems:
 
     gem install activemerchant
 
-Alternatively, add the following to your Gemfile
+Or, if you're using Bundler, just add the following to your Gemfile:
 
-    gem 'activemerchant', :require => 'active_merchant'
+    gem 'activemerchant'
 
 ## Usage
 
 This simple example demonstrates how a purchase can be made using a person's
 credit card details.
 
-	require 'rubygems'
-	require 'active_merchant'
+    require 'rubygems'
+    require 'active_merchant'
 
-	# Use the TrustCommerce test servers
-	ActiveMerchant::Billing::Base.mode = :test
+    # Use the TrustCommerce test servers
+    ActiveMerchant::Billing::Base.mode = :test
 
-	gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
-	            :login => 'TestMerchant',
-	            :password => 'password')
+    gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
+                :login => 'TestMerchant',
+                :password => 'password')
 
-	# ActiveMerchant accepts all amounts as Integer values in cents
-	amount = 1000  # $10.00
+    # 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
-	credit_card = ActiveMerchant::Billing::CreditCard.new(
-	                :first_name         => 'Bob',
-	                :last_name          => 'Bobsen',
-	                :number             => '4242424242424242',
-	                :month              => '8',
-	                :year               => '2012',
-	                :verification_value => '123')
+    # The card verification value is also known as CVV2, CVC2, or CID
+    credit_card = ActiveMerchant::Billing::CreditCard.new(
+                    :first_name         => 'Bob',
+                    :last_name          => 'Bobsen',
+                    :number             => '4242424242424242',
+                    :month              => '8',
+                    :year               => Time.now.year+1,
+                    :verification_value => '000')
 
-	# Validating the card automatically detects the card type
-	if credit_card.valid?
-	  # Capture $10 from the credit card
-	  response = gateway.purchase(amount, credit_card)
+    # 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
-	  end
-	end
+      if response.success?
+        puts "Successfully charged $#{sprintf("%.2f", amount / 100)} to the credit card #{credit_card.display_number}"
+      else
+        raise StandardError, response.message
+      end
+    end
 
 For more in-depth documentation and tutorials, see {file:GettingStarted.md} and the
 [API documentation](http://rubydoc.info/github/Shopify/active_merchant/master/file/README.md).
@@ -104,6 +99,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [E-xact](http://www.e-xact.com) - CA, US
 * [Fat Zebra](https://www.fatzebra.com.au) - AU
 * [Federated Canada](http://www.federatedcanada.com/) - CA
+* [FirstData Global Gateway e4](http://www.firstdata.com) - CA, US
 * [FirstPay](http://www.first-pay.com) - US
 * [Garanti Sanal POS](https://ccpos.garanti.com.tr/ccRaporlar/garanti/ccReports) - US, TR
 * [HDFC](http://www.hdfcbank.com/sme/sme-details/merchant-services/guzh6m0i) - IN
@@ -116,6 +112,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [Litle](http://www.litle.com/) - US
 * [Merchant e-Solutions](http://merchante-solutions.com/) - US
 * [MerchantWare](http://merchantwarehouse.com/merchantware) - US
+* [Merchant Warrior] (http://merchantwarrior.com) - AU
 * [Mercury](http://www.mercurypay.com) - US
 * [MasterCard Internet Gateway Service (MiGS)](http://mastercard.com/mastercardsps) - AU, AE, BD, BN, EG, HK, ID, IN, JO, KW, LB, LK, MU, MV, MY, NZ, OM, PH, QA, SA, SG, TT, VN
 * [Modern Payments](http://www.modpay.com) - US
@@ -125,6 +122,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [NELiX TransaX Gateway](http://www.nelixtransax.com) - US
 * [Netaxept](http://www.betalingsterminal.no/Netthandel-forside) - NO, DK, SE, FI
 * [NETbilling](http://www.netbilling.com) - US
+* [NetPay](http://www.netpay.com.mx) - MX
 * [NetRegistry](http://www.netregistry.com.au) - AU
 * [NMI](http://nmi.com/) - US
 * [Ogone DirectLink](http://www.ogone.com) - BE, DE, FR, NL, AT, CH
@@ -142,6 +140,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [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
+* [Pin](http://www.pin.net.au/) - AU
 * [Plug'n Pay](http://www.plugnpay.com/) - US
 * [Psigate](http://www.psigate.com/) - CA
 * [PSL Payment Solutions](http://www.paymentsolutionsltd.com/) - UK
@@ -159,6 +158,7 @@ The [ActiveMerchant Wiki](http://github.com/Shopify/active_merchant/wikis) conta
 * [SecurePay](http://www.securepay.com/) - US
 * [SecurePayTech](http://www.securepaytech.com/) - NZ
 * [SkipJack](http://www.skipjack.com/) - US, CA
+* [Spreedly Core](https://spreedlycore.com/) - AD, AE, AT, AU, BD, BE, BG, BN, CA, CH, CY, CZ, DE, DK, EE, EG, ES, FI, FR, GB, GI, GR, HK, HU, ID, IE, IL, IM, IN, IS, IT, JO, KW, LB, LI, LK, LT, LU, LV, MC, MT, MU, MV, MX, MY, NL, NO, NZ, OM, PH, PL, PT, QA, RO, SA, SE, SG, SI, SK, SM, TR, TT, UM, US, VA, VN, ZA
 * [Stripe](https://stripe.com/) - US
 * [TransFirst](http://www.transfirst.com/) - US
 * [TrustCommerce](http://www.trustcommerce.com/) - US
@@ -211,3 +211,5 @@ Please don't touch the CHANGELOG in your pull requests, we'll add the appropriat
 at release time.
 
 [![Build Status](https://secure.travis-ci.org/Shopify/active_merchant.png)](http://travis-ci.org/Shopify/active_merchant)
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Shopify/active_merchant)

data/lib/active_merchant/billing/check.rb

@@ -3,21 +3,21 @@ module ActiveMerchant #:nodoc:
     # The Check object is a plain old Ruby object, similar to CreditCard. It supports validation
     # of necessary attributes such as checkholder's name, routing and account numbers, but it is
     # not backed by any database.
-    # 
+    #
     # You may use Check in place of CreditCard with any gateway that supports it. Currently, only
     # +BraintreeGateway+ supports the Check object.
     class Check
       include Validateable
-      
+
       attr_accessor :first_name, :last_name, :routing_number, :account_number, :account_holder_type, :account_type, :number
-      
+
       # Used for Canadian bank accounts
       attr_accessor :institution_number, :transit_number
-      
+
       def name
         @name ||= "#{@first_name} #{@last_name}".strip
       end
-      
+
       def name=(value)
         return if value.blank?
 
@@ -26,25 +26,29 @@ module ActiveMerchant #:nodoc:
         @last_name = segments.pop
         @first_name = segments.join(' ')
       end
-      
+
       def validate
         [:name, :routing_number, :account_number].each do |attr|
           errors.add(attr, "cannot be empty") if self.send(attr).blank?
         end
-        
+
         errors.add(:routing_number, "is invalid") unless valid_routing_number?
-        
+
         errors.add(:account_holder_type, "must be personal or business") if
             !account_holder_type.blank? && !%w[business personal].include?(account_holder_type.to_s)
-        
+
         errors.add(:account_type, "must be checking or savings") if
             !account_type.blank? && !%w[checking savings].include?(account_type.to_s)
       end
-      
+
       def type
         'check'
       end
-      
+
+      def check?
+        true
+      end
+
       # Routing numbers may be validated by calculating a checksum and dividing it by 10. The
       # formula is:
       #   (3(d1 + d4 + d7) + 7(d2 + d5 + d8) + 1(d3 + d6 + d9))mod 10 = 0

data/lib/active_merchant/billing/credit_card.rb

@@ -181,7 +181,7 @@ module ActiveMerchant #:nodoc:
       def display_number
         self.class.mask(number)
       end
-      
+
       def first_digits
         self.class.first_digits(number)
       end
@@ -209,6 +209,10 @@ module ActiveMerchant #:nodoc:
         require_verification_value
       end
 
+      def check?
+        false
+      end
+
       private
 
       def before_validate #:nodoc:

data/lib/active_merchant/billing/credit_card_formatting.rb

@@ -1,21 +1,21 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     module CreditCardFormatting
-      
-      # This method is used to format numerical information pertaining to credit cards. 
-      # 
+
+      # This method is used to format numerical information pertaining to credit cards.
+      #
       #   format(2005, :two_digits)  # => "05"
       #   format(05,   :four_digits) # => "0005"
       def format(number, option)
         return '' if number.blank?
-        
+
         case option
-          when :two_digits  ; sprintf("%.2i", number)[-2..-1]
-          when :four_digits ; sprintf("%.4i", number)[-4..-1]
+          when :two_digits  ; sprintf("%.2i", number.to_i)[-2..-1]
+          when :four_digits ; sprintf("%.4i", number.to_i)[-4..-1]
           else number
         end
       end
-      
+
     end
   end
-end
+end

data/lib/active_merchant/billing/gateway.rb

@@ -62,7 +62,7 @@ module ActiveMerchant #:nodoc:
       include Utils
 
       DEBIT_CARDS = [ :switch, :solo ]
-      CURRENCIES_WITHOUT_FRACTIONS = [ 'JPY', 'HUF' ]
+      CURRENCIES_WITHOUT_FRACTIONS = [ 'JPY', 'HUF', 'TWD' ]
       CREDIT_DEPRECATION_MESSAGE = "Support for using credit to refund existing transactions is deprecated and will be removed from a future release of ActiveMerchant. Please use the refund method instead."
 
       cattr_reader :implementations

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

@@ -41,7 +41,9 @@ module ActiveMerchant #:nodoc:
       RESPONSE_CODE, RESPONSE_REASON_CODE, RESPONSE_REASON_TEXT = 0, 2, 3
       AVS_RESULT_CODE, TRANSACTION_ID, CARD_CODE_RESPONSE_CODE  = 5, 6, 38
 
-      self.supported_countries = ['US']
+      self.default_currency = 'USD'
+
+      self.supported_countries = ['US', 'CA', 'GB']
       self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
       self.homepage_url = 'http://www.authorize.net/'
       self.display_name = 'Authorize.Net'
@@ -85,6 +87,7 @@ module ActiveMerchant #:nodoc:
       # * <tt>options</tt> -- A hash of optional parameters.
       def authorize(money, creditcard, options = {})
         post = {}
+        add_currency_code(post, money, options)
         add_invoice(post, options)
         add_creditcard(post, creditcard)
         add_address(post, options)
@@ -103,6 +106,7 @@ module ActiveMerchant #:nodoc:
       # * <tt>options</tt> -- A hash of optional parameters.
       def purchase(money, creditcard, options = {})
         post = {}
+        add_currency_code(post, money, options)
         add_invoice(post, options)
         add_creditcard(post, creditcard)
         add_address(post, options)
@@ -328,6 +332,10 @@ module ActiveMerchant #:nodoc:
         request
       end
 
+      def add_currency_code(post, money, options)
+        post[:currency_code] = options[:currency] || currency(money)
+      end
+
       def add_invoice(post, options)
         post[:invoice_num] = options[:order_id]
         post[:description] = options[:description]

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

@@ -93,8 +93,8 @@ module ActiveMerchant #:nodoc:
       # * <tt>:login</tt> -- The Authorize.Net API Login ID (REQUIRED)
       # * <tt>:password</tt> -- The Authorize.Net Transaction Key. (REQUIRED)
       # * <tt>:test</tt> -- +true+ or +false+. If true, perform transactions against the test server.
-      # * <tt>:delimiter</tt> -- The delimiter used in the direct response.  Default is ',' (comma).
       #   Otherwise, perform transactions against the production server.
+      # * <tt>:delimiter</tt> -- The delimiter used in the direct response.  Default is ',' (comma).
       def initialize(options = {})
         requires!(options, :login, :password)
         super
@@ -468,7 +468,11 @@ module ActiveMerchant #:nodoc:
       private
 
       def expdate(credit_card)
-        sprintf('%04d-%02d', credit_card.year, credit_card.month)
+        if credit_card.year.present? && credit_card.month.present?
+          sprintf('%04d-%02d', credit_card.year, credit_card.month)
+        else
+          'XXXX'
+        end
       end
 
       def build_request(action, options = {})
@@ -599,8 +603,11 @@ module ActiveMerchant #:nodoc:
       end
 
       def build_create_customer_profile_transaction_request(xml, options)
+        options[:extra_options] ||= {}
+        options[:extra_options].merge!('x_test_request' => 'TRUE') if @options[:test]
+
         add_transaction(xml, options[:transaction])
-        xml.tag!('extraOptions', "x_test_request=TRUE") if @options[:test]
+        tag_unless_blank(xml, 'extraOptions', format_extra_options(options[:extra_options]))
 
         xml.target!
       end
@@ -652,7 +659,7 @@ module ActiveMerchant #:nodoc:
                 tag_unless_blank(xml,'customerShippingAddressId', transaction[:customer_shipping_address_id])
                 xml.tag!('transId', transaction[:trans_id])
               when :refund
-                #TODO - add lineItems and extraOptions fields
+                #TODO - add lineItems field
                 xml.tag!('amount', transaction[:amount])
                 tag_unless_blank(xml, 'customerProfileId', transaction[:customer_profile_id])
                 tag_unless_blank(xml, 'customerPaymentProfileId', transaction[:customer_payment_profile_id])
@@ -849,6 +856,10 @@ module ActiveMerchant #:nodoc:
         xml.tag!(tag_name, data) unless data.blank? || data.nil?
       end
 
+      def format_extra_options(options)
+        options.map{ |k, v| "#{k}=#{v}" }.join(',') unless options.nil?
+      end
+
       def parse_direct_response(params)
         delimiter = @options[:delimiter] || ','
         direct_response = {'raw' => params}

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

@@ -91,8 +91,8 @@ module ActiveMerchant #:nodoc:
       # * <tt>:login</tt> -- The Balanced API Secret (REQUIRED)
       def initialize(options = {})
         requires!(options, :login)
-        initialize_marketplace(options[:marketplace] || load_marketplace)
         super
+        initialize_marketplace(options[:marketplace] || load_marketplace)
       end
 
       # Performs an authorization (Hold in Balanced nonclementure), which
@@ -197,6 +197,7 @@ module ActiveMerchant #:nodoc:
         post[:hold_uri] = authorization
         post[:amount] = money if money
         post[:description] = options[:description] if options[:description]
+        post[:on_behalf_of_uri] = options[:on_behalf_of_uri] if options[:on_behalf_of_uri]
 
         create_transaction(:post, @debits_uri, post)
       rescue Error => ex
@@ -234,11 +235,16 @@ module ActiveMerchant #:nodoc:
       # * <tt>`:amount`<tt> -- specify an amount if you want to perform a
       #   partial refund. This value will default to the total amount of the
       #   debit that has not been refunded so far.
-      def refund(debit_uri, options = {})
+      def refund(amount, debit_uri = "deprecated", options = {})
+        if(debit_uri == "deprecated" || debit_uri.kind_of?(Hash))
+          deprecated "Calling the refund method without an amount parameter is deprecated and will be removed in a future version."
+          return refund(options[:amount], amount, options)
+        end
+
         requires!(debit_uri)
         post = {}
         post[:debit_uri] = debit_uri
-        post[:amount] = options[:amount] if options[:amount]
+        post[:amount] = amount
         post[:description] = options[:description]
         create_transaction(:post, @refunds_uri, post)
       rescue Error => ex