activemerchant 1.18.1 → 1.20.0

data.tar.gz.sig

@@ -0,0 +1,5 @@
+n�j�����c��;7r7x�@�����:v&�

�!O7���%�K�wB�����B���
+
+O����(��<?�@K�O�����17���C�p��g�_
U�1�b�p.�
+e9u�*_"'�`J��J�(��V��ݙ0�U�8�$Th@I3C	A[>�	^z]�x�`�=��W�TEK8o!��`�ݛ�+nz�l}�G�@TS!M^ӥ�`J�w(�p_2�������C�=wV2��$$�
+�����_.���*��]���

data/CHANGELOG

@@ -1,5 +1,20 @@
 = ActiveMerchant CHANGELOG
 
+== 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]

data/CONTRIBUTORS

@@ -255,3 +255,7 @@ CardSave (August, 2011)
 Dwolla (September, 2011)
 
 * James Armstead (armsteadj1)
+
+Samurai (November, 2011)
+
+* Joshua Krall (jkrall)

data/lib/active_merchant.rb

@@ -25,6 +25,7 @@ require 'active_support'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/object/conversions'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/class/delegating_attributes'

data/lib/active_merchant/billing/credit_card.rb

@@ -236,7 +236,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/gateways/beanstream/beanstream_core.rb

@@ -90,7 +90,11 @@ module ActiveMerchant #:nodoc:
     
       private
       def purchase_action(source)
-        (card_brand(source) == "check") ? :check_purchase : :purchase
+        if source.is_a?(Check)
+          :check_purchase
+        else
+          :purchase
+        end
       end
       
       def void_action(original_transaction_type)

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

@@ -22,7 +22,7 @@ module ActiveMerchant #:nodoc:
         Braintree::Configuration.merchant_id = options[:merchant_id]
         Braintree::Configuration.public_key = options[:public_key]
         Braintree::Configuration.private_key = options[:private_key]
-        Braintree::Configuration.environment = test? ? :sandbox : :production
+        Braintree::Configuration.environment = (options[:environment] || (test? ? :sandbox : :production)).to_sym
         Braintree::Configuration.logger.level = Logger::ERROR if Braintree::Configuration.logger
         Braintree::Configuration.custom_user_agent = "ActiveMerchant #{ActiveMerchant::VERSION}"
         super
@@ -176,7 +176,11 @@ 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}"
+            if result.transaction.status == "gateway_rejected"
+              message = "Transaction declined - gateway rejected"
+            else
+              message = "#{result.transaction.processor_response_code} #{result.transaction.processor_response_text}"
+            end
           else
             message = message_from_result(result)
           end

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

@@ -30,7 +30,8 @@ module ActiveMerchant #:nodoc:
     #   puts response.authorization # Retrieve the unique transaction ID returned by Elavon
     #
     class ElavonGateway < ViaklixGateway
-      self.test_url = self.live_url = 'https://www.myvirtualmerchant.com/VirtualMerchant/process.do'
+      self.test_url = 'https://demo.myvirtualmerchant.com/VirtualMerchantDemo/process.do'
+      self.live_url = 'https://www.myvirtualmerchant.com/VirtualMerchant/process.do'
 
       self.display_name = 'Elavon MyVirtualMerchant'
       self.supported_countries = ['US', 'CA']

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

@@ -68,6 +68,11 @@ module ActiveMerchant #:nodoc:
       end
 
       def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def refund(money, authorization, options = {})
         commit(:credit, build_capture_or_credit_request(money, authorization, options))
       end
          

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

@@ -78,6 +78,10 @@ module ActiveMerchant #:nodoc:
       def refund(money, authorization, options = {})
         commit 'refund', crediting_params(authorization, :amount => amount(money))
       end
+
+      def test?
+        @options[:test] || super
+      end
     private # :nodoc: all
     
       def expdate(creditcard)

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

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
@@ -8,27 +9,32 @@ module ActiveMerchant #:nodoc:
     # communication between Ogone systems and your e-commerce website.
     #
     # This implementation follows the specification provided in the DirectLink integration
-    # guide version 2.4 (December 2008), available here:
+    # guide version 4.2.0 (26 October 2011), available here:
     # https://secure.ogone.com/ncol/Ogone_DirectLink_EN.pdf
     #
     # It also features aliases, which allow to store/unstore credit cards, as specified in
-    # the Alias Manager Option guide version 2.2 available here:
+    # the Alias Manager Option guide version 3.2.0 (26 October 2011) available here:
     # https://secure.ogone.com/ncol/Ogone_Alias_EN.pdf
     #
-    # It was last tested on Release 04.79 of Ogone e-Commerce (dated 11/02/2009).
+    # It was last tested on Release 4.89 of Ogone DirectLink + AliasManager (26 October 2011).
     #
-    # For any questions or comments, please contact Nicolas Jacobeus (nj@belighted.com).
+    # For any questions or comments, please contact one of the following:
+    # - Nicolas Jacobeus (nj@belighted.com),
+    # - Sébastien Grosjean (public@zencocoon.com),
+    # - Rémy Coutable (remy@jilion.com).
     #
-    # == Example use:
+    # == Usage
     #
     #   gateway = ActiveMerchant::Billing::OgoneGateway.new(
-    #               :login     => "my_ogone_psp_id",
-    #               :user      => "my_ogone_user_id",
-    #               :password  => "my_ogone_pswd",
-    #               :signature => "my_ogone_sha1_signature" # extra security, only if you configured your Ogone environment so
+    #               :login                     => "my_ogone_psp_id",
+    #               :user                      => "my_ogone_user_id",
+    #               :password                  => "my_ogone_pswd",
+    #               :signature                 => "my_ogone_sha_signature", # Only if you configured your Ogone environment so.
+    #               :signature_encryptor       => "sha512", # Can be "sha1" (default), "sha256" or "sha512".
+    #                                                       # Must be the same as the one configured in your Ogone account.
     #            )
     #
-    #   # set up credit card obj as in main ActiveMerchant example
+    #   # set up credit card object as in main ActiveMerchant example
     #   creditcard = ActiveMerchant::Billing::CreditCard.new(
     #     :type       => 'visa',
     #     :number     => '4242424242424242',
@@ -47,18 +53,21 @@ module ActiveMerchant #:nodoc:
     #   puts response.message       # Retrieve the message returned by Ogone
     #   puts response.authorization # Retrieve the unique transaction ID returned by Ogone
     #
-    #   To use the alias feature, simply add :alias in the options hash:
+    # == Alias feature
     #
-    #   gateway.purchase(1000, creditcard, :order_id => "1", :alias => "myawesomecustomer") # associates the alias to that creditcard
-    #   gateway.purchase(2000, nil,        :order_id => "2", :alias => "myawesomecustomer") # don't need to know the creditcard for subsequent orders
+    #   To use the alias feature, simply add :store in the options hash:
+    #
+    #   # Associate the alias to that credit card
+    #   gateway.purchase(1000, creditcard, :order_id => "1", :store => "myawesomecustomer")
+    #
+    #   # You can use the alias instead of the credit card for subsequent orders
+    #   gateway.purchase(2000, "myawesomecustomer", :order_id => "2")
     #
     class OgoneGateway < Gateway
 
       URLS = {
-        :test =>       { :order => 'https://secure.ogone.com/ncol/test/orderdirect.asp',
-                         :maintenance => 'https://secure.ogone.com/ncol/test/maintenancedirect.asp' },
-        :production => { :order => 'https://secure.ogone.com/ncol/prod/orderdirect.asp',
-                         :maintenance => 'https://secure.ogone.com/ncol/prod/maintenancedirect.asp' }
+        :order       => 'https://secure.ogone.com/ncol/%s/orderdirect.asp',
+        :maintenance => 'https://secure.ogone.com/ncol/%s/maintenancedirect.asp'
       }
 
       CVV_MAPPING = { 'OK' => 'M',
@@ -68,8 +77,12 @@ module ActiveMerchant #:nodoc:
       AVS_MAPPING = { 'OK' => 'M',
                       'KO' => 'N',
                       'NO' => 'R' }
+
       SUCCESS_MESSAGE = "The transaction was successful"
 
+      OGONE_NO_SIGNATURE_DEPRECATION_MESSAGE   = "Signature usage will be required from a future release of ActiveMerchant's Ogone Gateway. Please update your Ogone account to use it."
+      OGONE_LOW_ENCRYPTION_DEPRECATION_MESSAGE = "SHA512 signature encryptor will be required from a future release of ActiveMerchant's Ogone Gateway. Please update your Ogone account to use it."
+
       self.supported_countries = ['BE', 'DE', 'FR', 'NL', 'AT', 'CH']
       # also supports Airplus and UATP
       self.supported_cardtypes = [:visa, :master, :american_express, :diners_club, :discover, :jcb, :maestro]
@@ -108,7 +121,7 @@ module ActiveMerchant #:nodoc:
 
       # Complete a previously authorized transaction.
       def capture(money, authorization, options = {})
-        post = {}        
+        post = {}
         add_authorization(post, reference_from(authorization))
         add_invoice(post, options)
         add_customer_data(post, options)
@@ -124,7 +137,7 @@ module ActiveMerchant #:nodoc:
       end
 
       # Credit the specified account by a specific amount.
-      def credit(money, identification_or_credit_card, options = {})        
+      def credit(money, identification_or_credit_card, options = {})
         if reference_transaction?(identification_or_credit_card)
           deprecated CREDIT_DEPRECATION_MESSAGE
           # Referenced credit: refund of a settled transaction
@@ -133,34 +146,35 @@ module ActiveMerchant #:nodoc:
           perform_non_referenced_credit(money, identification_or_credit_card, options)
         end
       end
-      
+
       # Refund of a settled transaction
-      def refund(money, reference, options = {})        
+      def refund(money, reference, options = {})
         perform_reference_credit(money, reference, options)
       end
 
       def test?
         @options[:test] || super
       end
-      
+
       private
+
       def reference_from(authorization)
         authorization.split(";").first
       end
-      
+
       def reference_transaction?(identifier)
-        return false unless identifier.is_a?(String) 
+        return false unless identifier.is_a?(String)
         reference, action = identifier.split(";")
         !action.nil?
       end
-      
+
       def perform_reference_credit(money, payment_target, options = {})
         post = {}
         add_authorization(post, reference_from(payment_target))
         add_money(post, money, options)
-        commit('RFD', post)        
+        commit('RFD', post)
       end
-      
+
       def perform_non_referenced_credit(money, payment_target, options = {})
         # Non-referenced credit: acts like a reverse purchase
         post = {}
@@ -171,31 +185,32 @@ module ActiveMerchant #:nodoc:
         add_money(post, money, options)
         commit('RFD', post)
       end
-      
+
       def add_payment_source(post, payment_source, options)
         if payment_source.is_a?(String)
           add_alias(post, payment_source)
-          add_eci(post, '9')
+          add_eci(post, options[:eci] || '9')
         else
           add_alias(post, options[:store])
+          add_eci(post, options[:eci] || '7')
           add_creditcard(post, payment_source)
         end
-      end  
-      
+      end
+
       def add_eci(post, eci)
-        add_pair post, 'ECI', eci
+        add_pair post, 'ECI', eci.to_s
       end
-      
+
       def add_alias(post, _alias)
-        add_pair post, 'ALIAS',   _alias
+        add_pair post, 'ALIAS', _alias
       end
 
       def add_authorization(post, authorization)
-        add_pair post, 'PAYID',   authorization
+        add_pair post, 'PAYID', authorization
       end
 
       def add_money(post, money, options)
-        add_pair post, 'currency', options[:currency] || currency(money)
+        add_pair post, 'currency', options[:currency] || @options[:currency] || currency(money)
         add_pair post, 'amount',   amount(money)
       end
 
@@ -226,35 +241,39 @@ module ActiveMerchant #:nodoc:
       end
 
       def parse(body)
-        xml = REXML::Document.new(body)
-        convert_attributes_to_hash(xml.root.attributes)
+        xml_root = REXML::Document.new(body).root
+        convert_attributes_to_hash(xml_root.attributes)
       end
 
       def commit(action, parameters)
-        add_pair parameters, 'PSPID',      @options[:login]
-        add_pair parameters, 'USERID',     @options[:user]
-        add_pair parameters, 'PSWD',       @options[:password]
-        url = URLS[test? ? :test : :production][parameters['PAYID'] ? :maintenance : :order ]
+        add_pair parameters, 'PSPID',  @options[:login]
+        add_pair parameters, 'USERID', @options[:user]
+        add_pair parameters, 'PSWD',   @options[:password]
+
+        url = URLS[parameters['PAYID'] ? :maintenance : :order] % [test? ? "test" : "prod"]
         response = parse(ssl_post(url, post_data(action, parameters)))
-        options = { :authorization => [response["PAYID"], action].join(";"),
-                    :test => test?,
-                    :avs_result => { :code => AVS_MAPPING[response["AAVCheck"]] },
-                    :cvv_result => CVV_MAPPING[response["CVCCheck"]] }
+
+        options = {
+          :authorization => [response["PAYID"], action].join(";"),
+          :test          => test?,
+          :avs_result    => { :code => AVS_MAPPING[response["AAVCheck"]] },
+          :cvv_result    => CVV_MAPPING[response["CVCCheck"]]
+        }
         Response.new(successful?(response), message_from(response), response, options)
       end
-      
+
       def successful?(response)
         response["NCERROR"] == "0"
       end
 
       def message_from(response)
-        if successful?(response) 
+        if successful?(response)
           SUCCESS_MESSAGE
         else
           format_error_message(response["NCERRORPLUS"])
         end
       end
-      
+
       def format_error_message(message)
         raw_message = message.to_s.strip
         case raw_message
@@ -268,16 +287,35 @@ module ActiveMerchant #:nodoc:
       end
 
       def post_data(action, parameters = {})
-        add_pair parameters, 'Operation' , action
-        if @options[:signature] # the user wants a SHA-1 signature
-          string = ['orderID','amount','currency','CARDNO','PSPID','Operation','ALIAS'].map{|s|parameters[s]}.join + @options[:signature]
-          add_pair parameters, 'SHASign' , Digest::SHA1.hexdigest(string)
+        add_pair parameters, 'Operation', action
+        @options[:signature] ? add_signature(parameters) : deprecated(OGONE_NO_SIGNATURE_DEPRECATION_MESSAGE)
+        parameters.to_query
+      end
+
+      def add_signature(parameters)
+        deprecated(OGONE_LOW_ENCRYPTION_DEPRECATION_MESSAGE) unless @options[:signature_encryptor] == 'sha512'
+
+        sha_encryptor = case @options[:signature_encryptor]
+                        when 'sha256'
+                          Digest::SHA256
+                        when 'sha512'
+                          Digest::SHA512
+                        else
+                          Digest::SHA1
+                        end
+
+        string_to_digest = if @options[:signature_encryptor]
+          parameters.sort { |a, b| a[0].upcase <=> b[0].upcase }.map { |k, v| "#{k.upcase}=#{v}" }.join(@options[:signature])
+        else
+          %w[orderID amount currency CARDNO PSPID Operation ALIAS].map { |key| parameters[key] }.join
         end
-        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        string_to_digest << @options[:signature]
+
+        add_pair parameters, 'SHASign', sha_encryptor.hexdigest(string_to_digest).upcase
       end
 
-      def add_pair(post, key, value, options = {})
-        post[key] = value if !value.blank? || options[:required]
+      def add_pair(post, key, value)
+        post[key] = value if !value.blank?
       end
 
       def convert_attributes_to_hash(rexml_attributes)

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

@@ -122,8 +122,8 @@ module ActiveMerchant #:nodoc:
       end
       
       # setting money to nil will perform a full void
-      def void(money, authorization, options = {})
-        order = build_void_request_xml(money, authorization, options)
+      def void(authorization, options = {})
+        order = build_void_request_xml(authorization, options)
         commit(order)
       end
     
@@ -167,7 +167,7 @@ module ActiveMerchant #:nodoc:
         xml.tag! :CurrencyCode, currency_code(currency)
         xml.tag! :CurrencyExponent, '2' # Will need updating to support currencies such as the Yen.
         
-        xml.tag! :CardSecValInd, 1 if creditcard.verification_value? && %w( visa discover ).include?(creditcard.type)
+        xml.tag! :CardSecValInd, 1 if creditcard.verification_value? && %w( visa discover ).include?(creditcard.brand)
         xml.tag! :CardSecVal,  creditcard.verification_value if creditcard.verification_value?
       end
       
@@ -242,17 +242,13 @@ module ActiveMerchant #:nodoc:
 
       def build_new_order_xml(action, money, parameters = {})
         requires!(parameters, :order_id)
-        xml = Builder::XmlMarkup.new(:indent => 2)
-        xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+        xml = xml_envelope
         xml.tag! :Request do
           xml.tag! :NewOrder do
-            xml.tag! :OrbitalConnectionUsername, @options[:login] unless ip_authentication?
-            xml.tag! :OrbitalConnectionPassword, @options[:password] unless ip_authentication?
+            add_xml_credentials(xml)
             xml.tag! :IndustryType, parameters[:industry_type] || "EC"
             xml.tag! :MessageType, action
-            xml.tag! :BIN, '000002' # PNS Tampa
-            xml.tag! :MerchantID, @options[:merchant_id]
-            xml.tag! :TerminalID, parameters[:terminal_id] || '001'            
+            add_bin_merchant_and_terminal(xml, parameters)
             
             yield xml if block_given?
             
@@ -272,38 +268,29 @@ module ActiveMerchant #:nodoc:
       
       def build_mark_for_capture_xml(money, authorization, parameters = {})
         tx_ref_num, order_id = authorization.split(';')
-        xml = Builder::XmlMarkup.new(:indent => 2)
-        xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+        xml = xml_envelope
         xml.tag! :Request do
           xml.tag! :MarkForCapture do
-            xml.tag! :OrbitalConnectionUsername, @options[:login] unless ip_authentication?
-            xml.tag! :OrbitalConnectionPassword, @options[:password] unless ip_authentication?
+            add_xml_credentials(xml)
             xml.tag! :OrderID, order_id
             xml.tag! :Amount, amount(money)
-            xml.tag! :BIN, '000002' # PNS Tampa
-            xml.tag! :MerchantID, @options[:merchant_id]
-            xml.tag! :TerminalID, parameters[:terminal_id] || '001'
+            add_bin_merchant_and_terminal(xml, parameters)
             xml.tag! :TxRefNum, tx_ref_num
           end
         end
         xml.target!
       end
       
-      def build_void_request_xml(money, authorization, parameters = {})
+      def build_void_request_xml(authorization, parameters = {})
         tx_ref_num, order_id = authorization.split(';')
-        xml = Builder::XmlMarkup.new(:indent => 2)
-        xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+        xml = xml_envelope
         xml.tag! :Request do
           xml.tag! :Reversal do
-            xml.tag! :OrbitalConnectionUsername, @options[:login] unless ip_authentication?
-            xml.tag! :OrbitalConnectionPassword, @options[:password] unless ip_authentication?
+            add_xml_credentials(xml)
             xml.tag! :TxRefNum, tx_ref_num
             xml.tag! :TxRefIdx, parameters[:transaction_index]
-            xml.tag! :AdjustedAmt, amount(money)
             xml.tag! :OrderID, order_id
-            xml.tag! :BIN, '000002' # PNS Tampa
-            xml.tag! :MerchantID, @options[:merchant_id]
-            xml.tag! :TerminalID, parameters[:terminal_id] || '001'
+            add_bin_merchant_and_terminal(xml, parameters)
           end
         end
         xml.target!
@@ -316,6 +303,27 @@ module ActiveMerchant #:nodoc:
       def expiry_date(credit_card)
         "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
       end
+
+      def bin
+        @options[:bin] || '000001' # default is Salem Global
+      end
+
+      def xml_envelope
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+        xml
+      end
+
+      def add_xml_credentials(xml)
+        xml.tag! :OrbitalConnectionUsername, @options[:login] unless ip_authentication?
+        xml.tag! :OrbitalConnectionPassword, @options[:password] unless ip_authentication?
+      end
+
+      def add_bin_merchant_and_terminal(xml, parameters)
+        xml.tag! :BIN, bin
+        xml.tag! :MerchantID, @options[:merchant_id]
+        xml.tag! :TerminalID, parameters[:terminal_id] || '001'
+      end
     end
   end
 end