yetanothernguyen-activemerchant 1.16.0 → 1.21.0

data/CHANGELOG

@@ -1,5 +1,100 @@
 = ActiveMerchant CHANGELOG
 
+== Version 1.21.0 (March 7, 2012)
+
+* Stripe: Add support for passing IP [collision]
+* Merchant e-Solutions: pass expiration date when purchasing with a stored credit card [chrisyoung]
+* Braintree: Fix passing custom processor ids to old accounts [maxsilver]
+* Authorize.net CIM: Add validation mode option to create_customer_profile_request [jwood]
+* eWay Managed: Include transaction number in response params [jamsi]
+* Fix various hash ordering issues exposed by Ruby 1.8 [ntalbott]
+* Authorize.Net CIM: Add WEB echeck type [deathbob]
+* Move Braintree from the gemspec to the Gemfile [ntalbott]
+* Add CertoDirect gateway [hron]
+* Authorize.Net CIM: Add option for setting a custom delimiter [bmorton]
+* Authorize.Net CIM: Add 3.1 response fields [bmorton]
+* Authorize.Net CIM: Misc fixes and doc improvements [bmorton]
+* Authorize.Net CIM: Fix error when order is blank [KeeperPat]
+* Beanstream: Add recurring payments support [castiglione]
+* Make ePay password optional [ePay]
+* Quickpay: skip testmode if transaction provided [brentmc79]
+* Payflow: add additional fields [thorstadt]
+* Authorize.Net CIM: Add get_customer_profile_ids [howaboutwe]
+* PayPal Express: Add support for BrandName and Custom fields [exviva]
+* Payflow: Handle dates with leading zeros [jcoleman]
+* Authorize.Net CIM: Add CCV code support & improve tests [tgarnett]
+* Add Authorize.Net SIM integration [courtland & rdp]
+* Secure Pay AU: Handle periodic payments [tommeier]
+* Viaklix: Add discover as a supported card type [waelchatila]
+* Improvements to testing infrastructure for integrations [jduff]
+* Add NAB Transact (AU) Gateway [tommeier]
+
+== Version 1.20.4 (February 22, 2012)
+
+* Fix json dependency
+
+== Version 1.20.3 (February 7, 2012)
+
+* Various fixes to support Ruby 1.9 [wisq]
+* SkipJack: Fix partial capture [jduff]
+* Optimal Payments: submit region when outside North America [jduff]
+* USA ePay: Add void and refund support [duff/ntalbott]
+* Add first digits to credit card [codyfauser]
+* Orbital: fixes to authentication and order id [Soleone]
+* Stripe: fixes to purchase method [duff/ntalbott]
+
+== Version 1.20.2 (January 16, 2012)
+
+* Remove authorize/capture support for Stripe [gdb]
+
+== Version 1.20.1 (December 22, 2011)
+
+* PayflowExpressUk: Fix parsing street2 from response [odorcicd]
+* AuthorizeNet: Support tracking id [odorcicd]
+* SagePay Form: Map billing address to shipping address [jduff]
+
+== Version 1.20.0 (November 14, 2011)
+
+* Add support for USA ePay Advanced SOAP interface [matthewcalebsmith/jduff]
+* Beanstram: fix purchase with Secure Profile [pitr/jduff]
+* Orbital: various fixes [Soleone]
+* Add Samuari gateway by Fee Fighters [jkrall/odorcicd]
+* Lock money gem to 3.7.1 or less since newer versions break in 1.9 [jduff]
+* Braintree: handle gateway rejected transactions gracefully [braintreeps/jduff]
+* Ogone: support different signature encryptors, custom currency and eci [ZenCocoon/rymai/jduff]
+* Payflow Link: use secure token [jduff]
+* Added refund method to Exact, Pay Junction and Skip Jack gateways [jduff]
+* Elavon: added test url [kylekeesling/jduff]
+* Fix redundent errors when credit card is expired [castiglione/jduff]
+* Two Checkout: update service url [vampirechicken/jduff]
+
+== Version 1.18.1 (September 23, 2011)
+
+* Braintree: allow setting merchant_account_id on initialize [jduff]
+* Realex: only send letters and numbers in shipping code field [Soleone]
+
+== Version 1.18.0 (September 23, 2011)
+
+* NoChex: Update the URL that payment requests are posted to [caseywhalen/jduff]
+* QBMS: fixed test mode check [Soleone]
+* Realex: encode avs info with shipping address [Soleone]
+* Add Dwolla offsite gateway [armsteadj1/jduff]
+* Eway: pass email, customer, description and options to store [moklett/tobi]
+* New dependency: active_utils gem [odorcicd]
+* Optimal Payments: fix test mode check [jduff]
+
+== Version 1.17.0 (August 23, 2011)
+
+* Add Payflow Link integration [jduff]
+* Add CardSave gateway [MrJaba/jduff]]
+* Quickpay: Support protocal version 4 and fraud parameters [anderslemke/jduff]
+* Authorize.net: Add status_recurring [mm1/jduff]
+* Paypal Express: Support specifying :items with purchase [sivabudh/jduff]
+* ePay: Add Sweden and Norway to supported countries [ePay/jduff]
+* Brainreee: Support passing merchant_account_id parameter [braintreeps/jduff]
+* Paypal Express: Remove deprecated Address field in favor of ShipToAddress[jduff]
+* Add Optimal Payments gateway [jamie/jduff]
+* Documentation improvements [dasch/nhemsley/jstorimer/jduff]
 * Authorize.Net: Pass through first name, last name, and zip for refunds. [ntalbott]
 
 == Version 1.16.0 (July 18, 2011)

data/CONTRIBUTORS

@@ -243,3 +243,32 @@ Paystation (July, 2011)
 ePaymentPlans offsite gatway (June, 2011)
 
 * Roberto Miranda (robertomiranda)
+
+Optimal Payments (August, 2011)
+
+* Jamie Macey (jamie)
+
+CardSave (August, 2011)
+
+* Tom Crinson (MrJaba)
+
+Dwolla (September, 2011)
+
+* James Armstead (armsteadj1)
+
+Samurai (November, 2011)
+
+* Joshua Krall (jkrall)
+
+CertoDirect Gateway (February, 2012)
+
+* Aleksei Gusev (hron)
+
+Authorize.Net SIM Integration (February, 2012)
+
+* Roger Pack (rdp)
+* Nick Rogers (courtland)
+
+NAB Transact (AU) Gateway (February, 2012)
+
+* Tom Meier (tommeier)

data/lib/active_merchant/billing/credit_card.rb

@@ -4,22 +4,34 @@ require 'active_merchant/billing/expiry_date'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # == Description
-    # This credit card object can be used as a stand alone object. It acts just like an ActiveRecord object
-    # but doesn't support the .save method as its not backed by a database.
+    # A +CreditCard+ object represents a physical credit card, and is capable of validating the various
+    # data associated with these.
     #
-    # For testing purposes, use the 'bogus' credit card type. This card skips the vast majority of
-    # validations. This allows you to focus on your core concerns until you're ready to be more concerned
-    # with the details of particular creditcards or your gateway.
+    # At the moment, the following credit card types are supported:
+    #
+    # * Visa
+    # * MasterCard
+    # * Discover
+    # * American Express
+    # * Diner's Club
+    # * JCB
+    # * Switch
+    # * Solo
+    # * Dankort
+    # * Maestro
+    # * Forbrugsforeningen
+    # * Laser
+    #
+    # For testing purposes, use the 'bogus' credit card type. This skips the vast majority of
+    # validations, allowing you to focus on your core concerns until you're ready to be more concerned
+    # with the details of particular credit cards or your gateway.
     #
     # == Testing With CreditCard
     # Often when testing we don't care about the particulars of a given card type. When using the 'test'
-    # mode in your Gateway, there are six different valid card numbers: 1, 2, 3, 'success', 'fail',
+    # mode in your {Gateway}, there are six different valid card numbers: 1, 2, 3, 'success', 'fail',
     # and 'error'.
     #
-    #--
-    # For details, see CreditCardMethods#valid_number?
-    #++
+    # For details, see {CreditCardMethods::ClassMethods#valid_number?}
     #
     # == Example Usage
     #   cc = CreditCard.new(
@@ -38,44 +50,102 @@ module ActiveMerchant #:nodoc:
       include CreditCardMethods
       include Validateable
 
-      ## Attributes
-
       cattr_accessor :require_verification_value
       self.require_verification_value = true
 
-      # Essential attributes for a valid, non-bogus creditcards
-      attr_accessor :number, :month, :year, :type, :first_name, :last_name
+      # Returns or sets the credit card number.
+      #
+      # @return [String]
+      attr_accessor :number
+
+      # Returns or sets the expiry month for the card.
+      #
+      # @return [Integer]
+      attr_accessor :month
+
+      # Returns or sets the expiry year for the card.
+      #
+      # @return [Integer]
+      attr_accessor :year
+
+      # Returns or sets the credit card type.
+      #
+      # Valid card types are
+      #
+      # * +'visa'+
+      # * +'master'+
+      # * +'discover'+
+      # * +'american_express'+
+      # * +'diners_club'+
+      # * +'jcb'+
+      # * +'switch'+
+      # * +'solo'+
+      # * +'dankort'+
+      # * +'maestro'+
+      # * +'forbrugsforeningen'+
+      # * +'laser'+
+      #
+      # Or, if you wish to test your implementation, +'bogus'+.
+      #
+      # @return (String) the credit card type
+      attr_accessor :type
+
+      # Returns or sets the first name of the card holder.
+      #
+      # @return [String]
+      attr_accessor :first_name
+
+      # Returns or sets the last name of the card holder.
+      #
+      # @return [String]
+      attr_accessor :last_name
 
       # Required for Switch / Solo cards
       attr_accessor :start_month, :start_year, :issue_number
 
-      # Optional verification_value (CVV, CVV2 etc). Gateways will try their best to
-      # run validation on the passed in value if it is supplied
+      # Returns or sets the card verification value.
+      #
+      # This attribute is optional but recommended. The verification value is
+      # a {card security code}[http://en.wikipedia.org/wiki/Card_security_code]. If provided,
+      # the gateway will attempt to validate the value.
+      #
+      # @return [String] the verification value
       attr_accessor :verification_value
 
       alias_method :brand, :type
-      
+
       # Provides proxy access to an expiry date object
+      #
+      # @return [ExpiryDate]
       def expiry_date
         ExpiryDate.new(@month, @year)
       end
 
+      # Returns whether the credit card has expired.
+      #
+      # @return +true+ if the card has expired, +false+ otherwise
       def expired?
         expiry_date.expired?
       end
 
+      # Returns whether either the +first_name+ or the +last_name+ attributes has been set.
       def name?
         first_name? || last_name?
       end
 
+      # Returns whether the +first_name+ attribute has been set.
       def first_name?
         @first_name.present?
       end
 
+      # Returns whether the +last_name+ attribute has been set.
       def last_name?
         @last_name.present?
       end
 
+      # Returns the full name of the card holder.
+      #
+      # @return [String] the full name of the card holder
       def name
         [@first_name, @last_name].compact.join(' ')
       end
@@ -90,15 +160,31 @@ module ActiveMerchant #:nodoc:
         !@verification_value.blank?
       end
 
-      # Show the card number, with all but last 4 numbers replace with "X". (XXXX-XXXX-XXXX-4338)
+      # Returns a display-friendly version of the card number.
+      #
+      # All but the last 4 numbers are replaced with an "X", and hyphens are
+      # inserted in order to improve legibility.
+      #
+      # @example
+      #   credit_card = CreditCard.new(:number => "2132542376824338")
+      #   credit_card.display_number  # "XXXX-XXXX-XXXX-4338"
+      #
+      # @return [String] a display-friendly version of the card number
       def display_number
         self.class.mask(number)
       end
+      
+      def first_digits
+        self.class.first_digits(number)
+      end
 
       def last_digits
         self.class.last_digits(number)
       end
 
+      # Validates the credit card details.
+      #
+      # Any validation errors are added to the {#errors} attribute.
       def validate
         validate_essential_attributes
 
@@ -154,7 +240,7 @@ module ActiveMerchant #:nodoc:
         else
           errors.add :month,      "is not a valid month" unless valid_month?(@month)
           errors.add :year,       "expired"              if expired?
-          errors.add :year,       "is not a valid year"  unless valid_expiry_year?(@year)
+          errors.add :year,       "is not a valid year"  unless expired? || valid_expiry_year?(@year)
         end
       end
 

data/lib/active_merchant/billing/credit_card_methods.rb

@@ -14,7 +14,7 @@ module ActiveMerchant #:nodoc:
         'dankort'            => /^5019\d{12}$/,
         'maestro'            => /^(5[06-8]|6\d)\d{10,17}$/,
         'forbrugsforeningen' => /^600722\d{10}$/,
-        'laser'              => /^(6304|6706|6771|6709)\d{8}(\d{4}|\d{6,7})?$/
+        'laser'              => /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
       }
     
       def self.included(base)
@@ -84,6 +84,10 @@ module ActiveMerchant #:nodoc:
           return nil
         end
         
+        def first_digits(number)
+          number.to_s.slice(0,6) 
+        end
+        
         def last_digits(number)     
           number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1) 
         end

data/lib/active_merchant/billing/gateway.rb

@@ -53,7 +53,7 @@ module ActiveMerchant #:nodoc:
     #
     # == Implmenting new gateways
     #
-    # See the {ActiveMerchant Guide to Contributing}[http://code.google.com/p/activemerchant/wiki/Contributing]
+    # See the {ActiveMerchant Guide to Contributing}[https://github.com/Shopify/active_merchant/wiki/Contributing]
     #
     class Gateway
       include PostsData

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

@@ -19,7 +19,7 @@ module ActiveMerchant #:nodoc:
     # 
     # Automated Recurring Billing (ARB) is an optional service for submitting and managing recurring, or subscription-based, transactions.
     # 
-    # To use recurring, update_recurring, and cancel_recurring ARB must be enabled for your account.
+    # To use recurring, update_recurring, cancel_recurring and status_recurring ARB must be enabled for your account.
     # 
     # Information about ARB is available on the {Authorize.Net website}[http://www.authorize.net/solutions/merchantsolutions/merchantservices/automatedrecurringbilling/].
     # Information about the ARB API is available at the {Authorize.Net Integration Center}[http://developer.authorize.net/]
@@ -55,7 +55,8 @@ module ActiveMerchant #:nodoc:
       RECURRING_ACTIONS = {
         :create => 'ARBCreateSubscription',
         :update => 'ARBUpdateSubscription',
-        :cancel => 'ARBCancelSubscription'
+        :cancel => 'ARBCancelSubscription',
+        :status => 'ARBGetSubscriptionStatus'
       }
 
       # Creates a new AuthorizeNetGateway
@@ -242,6 +243,19 @@ module ActiveMerchant #:nodoc:
         recurring_commit(:cancel, request)
       end
 
+      # Get Subscription Status of a recurring payment.
+      #
+      # This transaction gets the status of an existing Automated Recurring Billing (ARB) subscription. Your account must have ARB enabled.
+      #
+      # ==== Parameters
+      #
+      # * <tt>subscription_id</tt> -- A string containing the +subscription_id+ of the recurring payment already in place
+      #   for a given credit card. (REQUIRED)
+      def status_recurring(subscription_id)
+        request = build_recurring_request(:status, :subscription_id => subscription_id)
+        recurring_commit(:status, request)
+      end
+
       private
       
       def commit(action, money, parameters)
@@ -306,6 +320,7 @@ module ActiveMerchant #:nodoc:
         post[:delim_data]     = "TRUE"
         post[:delim_char]     = ","
         post[:encap_char]     = "$"
+        post[:solution_ID]    = application_id if application_id.present? && application_id != "ActiveMerchant"
 
         request = post.merge(parameters).collect { |key, value| "x_#{key}=#{CGI.escape(value.to_s)}" }.join("&")
         request
@@ -455,6 +470,13 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
+      # Builds body for ARBGetSubscriptionStatusRequest
+      def build_arb_status_subscription_request(xml, options)
+        xml.tag!('subscriptionId', options[:subscription_id])
+
+        xml.target!
+      end
+
       # Adds subscription information
       def add_arb_subscription(xml, options)
         xml.tag!('subscription') do