activemerchant 1.16.0 → 1.17.0

data/CHANGELOG

@@ -1,6 +1,20 @@
 = ActiveMerchant CHANGELOG
 
-== Version 1.16.0 (May 12, 2011)
+== 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)
 
 * Bogus: Support referenced transactions for #authorize, #purchase, #recurring and
 #credit [dasch/jduff]

data/CONTRIBUTORS

@@ -243,3 +243,11 @@ Paystation (July, 2011)
 ePaymentPlans offsite gatway (June, 2011)
 
 * Roberto Miranda (robertomiranda)
+
+Optimal Payments (August, 2011)
+
+* Jamie Macey (jamie)
+
+CardSave (August 2011,)
+
+* Tom Crinson (MrJaba)

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,7 +160,16 @@ 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
@@ -99,6 +178,9 @@ module ActiveMerchant #:nodoc:
         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
 

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
@@ -149,12 +150,20 @@ module ActiveMerchant #:nodoc:
       # ==== Options
       #
       # * <tt>:card_number</tt> -- The credit card number the refund is being issued to. (REQUIRED)
+      # * <tt>:first_name</tt> -- The first name of the account being refunded.
+      # * <tt>:last_name</tt> -- The last name of the account being refunded.
+      # * <tt>:zip</tt> -- The postal code of the account being refunded.
       def refund(money, identification, options = {})
         requires!(options, :card_number)
 
         post = { :trans_id => identification,
                  :card_num => options[:card_number]
                }
+
+        post[:first_name] = options[:first_name] if options[:first_name]
+        post[:last_name] = options[:last_name] if options[:last_name]
+        post[:zip] = options[:zip] if options[:zip]
+
         add_invoice(post, options)
         add_duplicate_window(post)
 
@@ -234,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)
@@ -447,6 +469,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

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

@@ -158,36 +158,10 @@ module ActiveMerchant #:nodoc:
       end
 
       def create_transaction(transaction_type, money, credit_card_or_vault_id, options)
-        parameters = {
-          :amount => amount(money).to_s,
-          :order_id => options[:order_id],
-          :customer => {
-            :id => options[:store] == true ? "" : options[:store],
-            :email => options[:email]
-          },
-          :options => {
-            :store_in_vault => options[:store] ? true : false,
-            :submit_for_settlement => options[:submit_for_settlement]
-          }
-        }
-        if credit_card_or_vault_id.is_a?(String) || credit_card_or_vault_id.is_a?(Integer)
-          parameters[:customer_id] = credit_card_or_vault_id
-        else
-          parameters[:customer].merge!(
-            :first_name => credit_card_or_vault_id.first_name,
-            :last_name => credit_card_or_vault_id.last_name
-          )
-          parameters[:credit_card] = {
-            :number => credit_card_or_vault_id.number,
-            :cvv => credit_card_or_vault_id.verification_value,
-            :expiration_month => credit_card_or_vault_id.month.to_s.rjust(2, "0"),
-            :expiration_year => credit_card_or_vault_id.year.to_s
-          }
-        end
-        parameters[:billing] = map_address(options[:billing_address]) if options[:billing_address]
-        parameters[:shipping] = map_address(options[:shipping_address]) if options[:shipping_address]
+        transaction_params = create_transaction_parameters(money, credit_card_or_vault_id, options)
+
         commit do
-          result = Braintree::Transaction.send(transaction_type, parameters)
+          result = Braintree::Transaction.send(transaction_type, transaction_params)
           response_params, response_options, avs_result, cvv_result = {}, {}, {}, {}
           if result.success?
             response_params[:braintree_transaction] = transaction_hash(result.transaction)
@@ -201,7 +175,7 @@ module ActiveMerchant #:nodoc:
               :postal_match => result.transaction.avs_postal_code_response_code
             }
             response_options[:cvv_result] = result.transaction.cvv_response_code
-            message = result.transaction.processor_response_code + " " + result.transaction.processor_response_text
+            message = "#{result.transaction.processor_response_code} #{result.transaction.processor_response_text}"
           else
             message = message_from_result(result)
           end
@@ -279,13 +253,49 @@ module ActiveMerchant #:nodoc:
         }
 
         {
-          "order_id"         => transaction.order_id,
-          "status"           => transaction.status,
-          "customer_details" => customer_details,
-          "billing_details"  => billing_details,
-          "shipping_details" => shipping_details,
-          "vault_customer"   => vault_customer
+          "order_id"            => transaction.order_id,
+          "status"              => transaction.status,
+          "customer_details"    => customer_details,
+          "billing_details"     => billing_details,
+          "shipping_details"    => shipping_details,
+          "vault_customer"      => vault_customer,
+          "merchant_account_id" => transaction.merchant_account_id
+        }
+      end
+
+      def create_transaction_parameters(money, credit_card_or_vault_id, options)
+        parameters = {
+          :amount => amount(money).to_s,
+          :order_id => options[:order_id],
+          :customer => {
+            :id => options[:store] == true ? "" : options[:store],
+            :email => options[:email]
+          },
+          :options => {
+            :store_in_vault => options[:store] ? true : false,
+            :submit_for_settlement => options[:submit_for_settlement]
+          }
         }
+        if options.has_key?(:merchant_account_id)
+          parameters[:merchant_account_id] = options[:merchant_account_id]
+        end
+        if credit_card_or_vault_id.is_a?(String) || credit_card_or_vault_id.is_a?(Integer)
+          parameters[:customer_id] = credit_card_or_vault_id
+        else
+          parameters[:customer].merge!(
+            :first_name => credit_card_or_vault_id.first_name,
+            :last_name => credit_card_or_vault_id.last_name
+          )
+          parameters[:credit_card] = {
+            :number => credit_card_or_vault_id.number,
+            :cvv => credit_card_or_vault_id.verification_value,
+            :expiration_month => credit_card_or_vault_id.month.to_s.rjust(2, "0"),
+            :expiration_year => credit_card_or_vault_id.year.to_s
+          }
+        end
+        parameters[:billing] = map_address(options[:billing_address]) if options[:billing_address]
+        parameters[:shipping] = map_address(options[:shipping_address]) if options[:shipping_address]
+        parameters
       end
     end
   end

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

@@ -0,0 +1,23 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CardSaveGateway < IridiumGateway
+      #CardSave lets you handle failovers on payments by providing 3 gateways in case one happens to be down
+      #URLS = ['https://gw1.cardsaveonlinepayments.com:4430/','https://gw2.cardsaveonlinepayments.com:4430/','https://gw3.cardsaveonlinepayments.com:4430/']      
+      
+      self.money_format = :cents
+      self.default_currency = 'GBP'
+      self.supported_cardtypes = [ :visa, :switch, :maestro, :master, :solo, :american_express, :jcb ]
+      self.supported_countries = [ 'GB' ]
+      self.homepage_url = 'http://www.cardsave.net/'
+      self.display_name = 'CardSave'
+      
+      def initialize(options={})
+        super
+        @test_url = 'https://gw1.cardsaveonlinepayments.com:4430/'
+        @live_url = 'https://gw1.cardsaveonlinepayments.com:4430/'
+      end
+      
+    end
+  end
+end
+

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

@@ -8,7 +8,7 @@ module ActiveMerchant #:nodoc:
       self.money_format = :cents
       self.supported_cardtypes = [:dankort, :forbrugsforeningen, :visa, :master,
                                   :american_express, :diners_club, :jcb, :maestro]
-      self.supported_countries = ['DK']
+      self.supported_countries = ['DK', 'SE', 'NO']
       self.homepage_url = 'http://epay.dk/'
       self.display_name = 'ePay'
 

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

@@ -7,8 +7,6 @@ module ActiveMerchant #:nodoc:
     # login to the Iridium Merchant Management System. Instead, you will 
     # use the API username and password you were issued separately.
     class IridiumGateway < Gateway
-      TEST_URL = 'https://gw1.iridiumcorp.net/'
-      LIVE_URL = 'https://gw1.iridiumcorp.net/'
       
       # The countries the gateway supports merchants from as 2 digit ISO country codes
       self.supported_countries = ['GB', 'ES']
@@ -37,6 +35,8 @@ module ActiveMerchant #:nodoc:
       def initialize(options = {})
         requires!(options, :login, :password)
         @options = options
+        @test_url = 'https://gw1.iridiumcorp.net/'
+        @live_url = 'https://gw1.iridiumcorp.net/'
         super
       end  
       
@@ -172,7 +172,7 @@ module ActiveMerchant #:nodoc:
 
       def commit(request, options)
         requires!(options, :action)
-        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, request,
+        response = parse(ssl_post(test? ? @test_url : @live_url, request,
                               {"SOAPAction" => "https://www.thepaymentgateway.net/#{options[:action]}",
                                "Content-Type" => "text/xml; charset=utf-8" }))