Formally deprecate Money objects. Clean up contributor comments

CHANGELOG

@@ -1,5 +1,6 @@
 = ActiveMerchant CHANGELOG
 
+* Deprecate Money objects [cody]
 * Update JCB rejex to catch all valid PANs [pjhyett]
 * Remove old TransaXGateway constant [cody]
 * Remove old ProtxGateway constant [cody]

CONTRIBUTORS

@@ -39,6 +39,14 @@ NetRegistry Gateway
 
 * Originally contributed by George Ogata (mailto: george.ogata@gmail.com)
 
+DataCash Gateway (March 2, 2007)
+
+* MoneySpyder, http://moneyspyder.co.uk and E-consultancy, http://www.e-consultancy.com
+
+PSL Card Gateway (March 27, 2007)
+
+* MoneySpyder, http://moneyspyder.co.uk
+
 Viaklix Gateway (Sep 3, 2007)
 
 * Originally contributed by Sal Scotto

lib/active_merchant/billing/gateway.rb

@@ -132,10 +132,15 @@ def name
 
       def amount(money)
         return nil if money.nil?
-        cents = money.respond_to?(:cents) ? money.cents : money 
+        cents = if money.respond_to?(:cents)
+          warn "Support for Money objects is deprecated and will be removed from a future release of ActiveMerchant. Please use an Integer value in cents"
+          money.cents
+        else
+          money
+        end
 
         if money.is_a?(String) or cents.to_i < 0
-          raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.' 
+          raise ArgumentError, 'money amount must be a positive Integer in cents.' 
         end
 
         if self.money_format == :cents

lib/active_merchant/billing/gateways/authorize_net.rb

@@ -79,7 +79,7 @@ def initialize(options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be authorized. Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> -- The amount to be authorized as an Integer value in cents.
       # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
       # * <tt>options</tt> -- A hash of optional parameters.
       def authorize(money, creditcard, options = {})
@@ -97,7 +97,7 @@ def authorize(money, creditcard, options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be purchased. Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> -- The amount to be purchased as an Integer value in cents.
       # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
       # * <tt>options</tt> -- A hash of optional parameters.
       def purchase(money, creditcard, options = {})
@@ -115,7 +115,7 @@ def purchase(money, creditcard, options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be captured.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> -- The amount to be captured as an Integer value in cents.
       # * <tt>authorization</tt> -- The authorization returned from the previous authorize request.
       def capture(money, authorization, options = {})
         post = {:trans_id => authorization}
@@ -140,7 +140,7 @@ def void(authorization, options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be credited to the customer. Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> -- The amount to be credited to the customer as an Integer value in cents.
       # * <tt>identification</tt> -- The ID of the original transaction against which the credit is being issued.
       # * <tt>options</tt> -- A hash of parameters.
       #
@@ -164,8 +164,7 @@ def credit(money, identification, options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be charged to the customer at each interval. Either an Integer value in cents or
-      #   a Money object.
+      # * <tt>money</tt> -- The amount to be charged to the customer at each interval as an Integer value in cents.
       # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
       # * <tt>options</tt> -- A hash of parameters.
       #

lib/active_merchant/billing/gateways/data_cash.rb

@@ -1,5 +1,3 @@
-# Authors::    MoneySpyder, http://moneyspyder.co.uk and E-consultancy, http://www.e-consultancy.com
-
 module ActiveMerchant
   module Billing
     class DataCashGateway < Gateway
@@ -58,7 +56,7 @@ def initialize(options = {})
       # Perform a purchase, which is essentially an authorization and capture in a single operation.
       # 
       # ==== Parameters
-      # * <tt>money</tt> The amount to be authorized.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> The amount to be authorized as an Integer value in cents.
       # * <tt>authorization_or_credit_card</tt>:: The continuous authority reference or CreditCard details for the transaction.
       # * <tt>options</tt> A hash of optional parameters.
       #   * <tt>:order_id</tt> A unique reference for this order (corresponds to merchantreference in datacash documentation)
@@ -86,7 +84,7 @@ def purchase(money, authorization_or_credit_card, options = {})
       #
       # ==== Parameters
       #
-      # * <tt>money</tt> The amount to be authorized.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> The amount to be authorized as an Integer value in cents.
       # * <tt>authorization_or_credit_card</tt>:: The continuous authority reference or CreditCard details for the transaction.
       # * <tt>options</tt> A hash of optional parameters.
       #   * <tt>:order_id</tt> A unique reference for this order (corresponds to merchantreference in datacash documentation)
@@ -113,7 +111,7 @@ def authorize(money, authorization_or_credit_card, options = {})
       # 
       # ==== Parameters
       #
-      # * <tt>money</tt> -- The amount to be captured.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> -- The amount to be captured as anInteger value in cents.
       # * <tt>authorization</tt> -- The authorization returned from the previous authorize request.   
       def capture(money, authorization, options = {})
         commit(build_void_or_capture_request(FULFILL_TYPE, money, authorization, options))
@@ -134,7 +132,7 @@ def void(authorization, options = {})
       # 
       # ==== Parameters
       #
-      # * <tt>money</tt> The amount to be refunded. Either an Integer value in cents or a Money object. Set to nil for a full refund on existing transaction.
+      # * <tt>money</tt> The amount to be refunded as an Integer value in cents. Set to nil for a full refund on existing transaction.
       # * <tt>reference_or_credit_card</tt> The credit card you want to refund OR the datacash_reference for the existing transaction you are refunding
       # * <tt>options</tt> Are ignored when refunding via reference to an existing transaction, otherwise
       #   * <tt>:order_id</tt> A unique reference for this order (corresponds to merchantreference in datacash documentation)
@@ -177,7 +175,7 @@ def test?
       # 
       # Parameters:
       # * <tt>type</tt> must be FULFILL_TYPE or CANCEL_TYPE
-      # * <tt>money</tt> - optional - Money object or value in cents
+      # * <tt>money</tt> - optional - Integer value in cents
       # * <tt>authorization</tt> - the Datacash authorization from a previous succesful authorize transaction
       # * <tt>options</tt>
       #   * <tt>order_id</tt> - A unique reference for the transaction

lib/active_merchant/billing/gateways/elavon.rb

@@ -48,7 +48,7 @@ class ElavonGateway < ViaklixGateway
       # Authorize a credit card for a given amount.
       # 
       # ==== Parameters
-      # * <tt>money</tt> - The amount to be authorized.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be authorized as an Integer value in cents.
       # * <tt>credit_card</tt> - The CreditCard details for the transaction.
       # * <tt>options</tt>
       #   * <tt>:billing_address</tt> - The billing address for the cardholder.      
@@ -64,7 +64,7 @@ def authorize(money, creditcard, options = {})
       # Capture authorized funds from a credit card.
       # 
       # ==== Parameters
-      # * <tt>money</tt> - The amount to be captured.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be captured as an Integer value in cents.
       # * <tt>authorization</tt> - The approval code returned from the initial authorization.
       # * <tt>options</tt>
       #   * <tt>:credit_card</tt> - The CreditCard details from the initial transaction (required).

lib/active_merchant/billing/gateways/merchant_ware.rb

@@ -42,7 +42,7 @@ def initialize(options = {})
       # Authorize a credit card for a given amount.
       # 
       # ==== Parameters
-      # * <tt>money</tt> - The amount to be authorized.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be authorized as an Integer value in cents.
       # * <tt>credit_card</tt> - The CreditCard details for the transaction.
       # * <tt>options</tt>
       #   * <tt>:order_id</tt> - A unique reference for this order (required).
@@ -55,7 +55,7 @@ def authorize(money, credit_card, options = {})
       # Authorize and immediately capture funds from a credit card.
       # 
       # ==== Parameters
-      # * <tt>money</tt> - The amount to be authorized.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be authorized as anInteger value in cents.
       # * <tt>credit_card</tt> - The CreditCard details for the transaction.
       # * <tt>options</tt>
       #   * <tt>:order_id</tt> - A unique reference for this order (required).
@@ -68,7 +68,7 @@ def purchase(money, credit_card, options = {})
       # Capture authorized funds from a credit card.
       # 
       # ==== Parameters
-      # * <tt>money</tt> - The amount to be captured.  Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be captured as anInteger value in cents.
       # * <tt>authorization</tt> - The authorization string returned from the initial authorization.
       def capture(money, authorization, options = {})
         request = build_capture_request(:capture, money, authorization, options)
@@ -92,7 +92,7 @@ def void(authorization, options = {})
       # 
       # ==== Parameters
       #
-      # * <tt>money</tt> - The amount to be refunded. Either an Integer value in cents or a Money object.
+      # * <tt>money</tt> - The amount to be refunded as an Integer value in cents.
       # * <tt>identification</tt> - The credit card you want to refund or the authorization for the existing transaction you are refunding.
       # * <tt>options</tt>
       #   * <tt>:order_id</tt> - A unique reference for this order (required when performing a non-referenced credit)

lib/active_merchant/billing/gateways/psl_card.rb

@@ -1,5 +1,3 @@
-# Author::    MoneySpyder, http://moneyspyder.co.uk
-
 module ActiveMerchant
   module Billing
     #
@@ -99,7 +97,7 @@ def initialize(options = {})
       # Purchase the item straight away
       # 
       # Parameters:
-      #   -money: Money object for the total to be charged
+      #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: the PSL cross reference from the previous authorization
       #   -options:
       #
@@ -127,7 +125,7 @@ def purchase(money, credit_card, options = {})
       # is available and only 'reserves' the nominal amount (currently a pound and a penny)
       # 
       # Parameters:
-      #   -money: Money object for the total to be charged
+      #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: the PSL cross reference from the previous authorization
       #   -options:
       #
@@ -151,7 +149,7 @@ def authorize(money, credit_card, options = {})
       # Captures the funds from an authorized transaction. 
       # 
       # Parameters:
-      #   -money: Money object for the total to be charged
+      #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: The PSL Cross Reference
       #   -options:
       #
@@ -230,7 +228,7 @@ def add_purchase_details(post)
       # however PSL requires the ISO 4217:2001 Numeric code.
       # 
       # Parameters:
-      #   -money: Money object with the amount and currency
+      #   -money: Integer value in cents
       #   
       # Returns:
       #   -the ISO 4217:2001 Numberic currency code

test/remote/gateways/remote_data_cash_test.rb

@@ -1,4 +1,3 @@
-# Author::    MoneySpyder, www.moneyspyder.co.uk
 require 'test_helper'
 
 class RemoteDataCashTest < Test::Unit::TestCase

test/remote/gateways/remote_psl_card_test.rb

@@ -1,5 +1,3 @@
-# Author::    MoneySpyder, http://moneyspyder.co.uk
-
 require 'test_helper'
 
 class RemotePslCardTest < Test::Unit::TestCase