activemerchant 1.13.0 → 1.14.0

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

@@ -7,10 +7,11 @@ module ActiveMerchant #:nodoc:
       SUCCESS_MESSAGE = "Bogus Gateway: Forced success"
       FAILURE_MESSAGE = "Bogus Gateway: Forced failure"
       ERROR_MESSAGE = "Bogus Gateway: Use CreditCard number 1 for success, 2 for exception and anything else for error"
-      CREDIT_ERROR_MESSAGE = "Bogus Gateway: Use trans_id 1 for success, 2 for exception and anything else for error"
+      CREDIT_ERROR_MESSAGE = "Bogus Gateway: Use CreditCard number 1 for success, 2 for exception and anything else for error"
       UNSTORE_ERROR_MESSAGE = "Bogus Gateway: Use trans_id 1 for success, 2 for exception and anything else for error"
       CAPTURE_ERROR_MESSAGE = "Bogus Gateway: Use authorization number 1 for exception, 2 for error and anything else for success"
       VOID_ERROR_MESSAGE = "Bogus Gateway: Use authorization number 1 for exception, 2 for error and anything else for success"
+      REFUND_ERROR_MESSAGE = "Bogus Gateway: Use trans_id number 1 for exception, 2 for error and anything else for success"
       
       self.supported_countries = ['US']
       self.supported_cardtypes = [:bogus]
@@ -41,11 +42,28 @@ module ActiveMerchant #:nodoc:
         end
       end
  
-      def credit(money, ident, options = {})
+      def credit(money, creditcard, options = {})
+        if creditcard.is_a?(String)
+          deprecated CREDIT_DEPRECATION_MESSAGE
+          return refund(money, creditcard, options)
+        end
+
         money = amount(money)
-        case ident
+        case creditcard.number
         when '1'
+          Response.new(true, SUCCESS_MESSAGE, {:paid_amount => money}, :test => true )
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:paid_amount => money, :error => FAILURE_MESSAGE }, :test => true)
+        else
           raise Error, CREDIT_ERROR_MESSAGE
+        end
+      end
+
+      def refund(money, ident, options = {})
+        money = amount(money)
+        case ident
+        when '1'
+          raise Error, REFUND_ERROR_MESSAGE
         when '2'
           Response.new(false, FAILURE_MESSAGE, {:paid_amount => money, :error => FAILURE_MESSAGE }, :test => true)
         else

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

@@ -128,10 +128,14 @@ module ActiveMerchant #:nodoc:
         commit(build_void_request(identification, options), options)
       end
 
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         commit(build_credit_request(money, identification, options), options)
       end
       
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
 
       # CyberSource requires that you provide line item information for tax calculations
       # If you do not have prices for each item or want to simplify the situation then pass in one fake line item that costs the subtotal of the order

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

@@ -139,7 +139,7 @@ module ActiveMerchant
       #   * <tt>:address</tt>:: billing address for card
       def credit(money, reference_or_credit_card, options = {})
         if reference_or_credit_card.is_a?(String)
-          warn CREDIT_DEPRECATION_MESSAGE
+          deprecated CREDIT_DEPRECATION_MESSAGE
           refund(money, reference_or_credit_card)
         else
           request = build_refund_request(money, reference_or_credit_card, options)

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

@@ -41,7 +41,7 @@ module ActiveMerchant #:nodoc:
 
       def credit(money, identification_or_credit_card, options = {})
         if identification_or_credit_card.is_a?(String)
-          warn CREDIT_DEPRECATION_MESSAGE
+          deprecated CREDIT_DEPRECATION_MESSAGE
           # Perform authorization reversal
           refund(money, identification_or_credit_card, options)
         else

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

@@ -97,7 +97,7 @@ module ActiveMerchant #:nodoc:
         commit(:void, post)
       end
 
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         post = {}
 
         add_amount_without_currency(post, money)
@@ -106,6 +106,10 @@ module ActiveMerchant #:nodoc:
         commit(:credit, post)
       end
 
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
 
       private
 

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

@@ -272,6 +272,10 @@ module ActiveMerchant #:nodoc:
         end
       end
       
+      def test?
+        @options[:test] || super
+      end
+      
     end
   end
 end

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

@@ -0,0 +1,231 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class EwayManagedGateway < Gateway
+      TEST_URL = 'https://www.eway.com.au/gateway/ManagedPaymentService/test/managedCreditCardPayment.asmx'
+      LIVE_URL = 'https://www.eway.com.au/gateway/ManagedPaymentService/managedCreditCardPayment.asmx'
+      
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['AU']
+      
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master]
+      
+      self.default_currency = 'AUD'
+      
+      #accepted money format
+      self.money_format = :cents
+      
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.eway.com.au/'
+      
+      # The name of the gateway
+      self.display_name = 'eWay Managed Payments'
+      
+      def initialize(options = {})
+        requires!(options, :login, :username, :password)
+        @options = options
+
+        # eWay returns 500 code for faults, which AM snaffles.
+        # So, we tell it to allow them.
+        @options[:ignore_http_status]=true
+        super
+      end  
+      
+      # add a new customer CC to your eway account and return unique ManagedCustomerID
+      # supports storing details required by eway see "add_creditcard" and "add_address"
+      def store(creditcard, options = {})
+        post = {}
+        
+        # Handle our required fields
+        requires!(options, :billing_address)
+
+        # Handle eWay specific required fields.
+        billing_address = options[:billing_address]
+        eway_requires!(billing_address)
+        
+        add_creditcard(post, creditcard)
+        add_address(post, billing_address)
+        add_misc_fields(post, billing_address)
+             
+        commit("CreateCustomer", post)
+      end
+      
+      def update(billing_id, creditcard, options={})
+        post = {}
+        
+        # Handle our required fields
+        requires!(options, :billing_address)
+
+        # Handle eWay specific required fields.
+        billing_address = options[:billing_address]
+        eway_requires!(billing_address)
+        
+        post[:managedCustomerID]=billing_id
+        add_creditcard(post, creditcard)
+        add_address(post, billing_address)
+        add_misc_fields(post, billing_address)
+             
+        commit("UpdateCustomer", post)
+      end
+      
+      #process payment for given amount from stored CC "ManagedCustomerID = billing_id"
+      def purchase(money, billing_id, options={})        
+        post = {}  
+        post[:managedCustomerID] = billing_id.to_s
+        post[:amount]=money
+             
+        commit("ProcessPayment", post)
+      end
+      
+      # TODO: eWay API also provides QueryCustomer
+      # TODO: eWay API also provides QueryPayment
+    
+      def test?
+        @options[:test] || Base.gateway_mode == :test
+      end
+private                       
+
+      def eway_requires!(hash)
+        raise ArgumentError.new("Missing eWay required parameter in `billing_address`: title") unless hash.has_key?(:title)
+        raise ArgumentError.new("Missing eWay required parameter in `billing_address`: country") unless hash.has_key?(:country)
+      end
+      
+      def add_address(post, address) 
+        post[:Address]  = address[:address1].to_s
+        post[:Phone]    = address[:phone].to_s
+        post[:PostCode] = address[:zip].to_s       
+        post[:Suburb]   = address[:city].to_s
+        post[:Country]  = address[:country].to_s.downcase
+        post[:State]    = address[:state].to_s  
+        post[:Mobile]   = address[:mobile].to_s
+        post[:Fax]      = address[:fax].to_s
+      end
+      
+      def add_misc_fields(post, options)
+        post[:CustomerRef]=options[:customer_ref].to_s
+        post[:Title]=options[:title]
+        post[:Company]=options[:company]
+        post[:JobDesc]=options[:job_desc]
+        post[:Email]=options[:email]
+        post[:URL]=options[:url]
+      end
+      
+      # add credit card details to be stored by eway. NOTE eway requires "title" field
+      def add_creditcard(post, creditcard)
+        post[:CCNumber]  = creditcard.number
+        post[:CCExpiryMonth]  = sprintf("%.2i", creditcard.month)
+        post[:CCExpiryYear] = sprintf("%.4i", creditcard.year)[-2..-1]
+        post[:CCNameOnCard] = creditcard.name
+        post[:FirstName] = creditcard.first_name
+        post[:LastName]  = creditcard.last_name
+      end
+      
+      def parse(body)
+        reply = {}
+        xml = REXML::Document.new(body)
+         if root = REXML::XPath.first(xml, "//soap:Fault") then
+           reply=parse_fault(root)
+        else
+          if root = REXML::XPath.first(xml, '//ProcessPaymentResponse/ewayResponse') then
+            # Successful payment
+            reply=parse_purchase(root)
+          else
+            if root = REXML::XPath.first(xml, '//CreateCustomerResult') then
+              reply[:message]='OK'
+              reply[:CreateCustomerResult]=root.text
+              reply[:success]=true
+            else
+              if root = REXML::XPath.first(xml, '//UpdateCustomerResult') then
+                if root.text.downcase == 'true' then
+                  reply[:message]='OK'
+                  reply[:success]=true
+                else
+                  # ERROR: This state should never occur. If there is a problem,
+                  #        a soap:Fault will be returned. The presence of this
+                  #        element always means a success.
+                  raise StandardError, "Unexpected \"false\" in UpdateCustomerResult"
+                end
+              else
+                # ERROR: This state should never occur currently. We have handled
+                #        responses for all the methods which we support.
+                raise StandardError, "Unexpected response"
+              end
+            end
+          end
+        end
+        return reply
+      end
+      
+      def parse_fault(node)
+        reply={}
+        reply[:message]=REXML::XPath.first(node, '//soap:Reason/soap:Text').text
+        reply[:success]=false
+        reply
+      end
+      
+      def parse_purchase(node)
+        reply={}
+        reply[:message]=REXML::XPath.first(node, '//ewayTrxnError').text
+        reply[:success]=(REXML::XPath.first(node, '//ewayTrxnStatus').text == 'True')
+        reply[:auth_code]=REXML::XPath.first(node, '//ewayAuthCode').text
+        reply
+      end
+      
+      def commit(action, post)
+        raw = begin
+          ssl_post(test? ? TEST_URL : LIVE_URL, soap_request(post, action), 'Content-Type' => 'application/soap+xml; charset=utf-8')
+        rescue ResponseError => e
+          e.response.body
+        end
+        response = parse(raw)
+                                        
+        EwayResponse.new(response[:success], response[:message], response, 
+          :test => test?,
+          :authorization => response[:auth_code]
+        )
+      end
+      
+      # Where we build the full SOAP 1.2 request using builder
+      def soap_request(arguments, action)
+        # eWay demands all fields be sent, but contain an empty string if blank
+        post=default_fields.merge(arguments)
+        
+        xml = Builder::XmlMarkup.new :indent => 2
+          xml.instruct!
+          xml.tag! 'soap12:Envelope', {'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', 'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema', 'xmlns:soap12' => 'http://www.w3.org/2003/05/soap-envelope'} do
+            xml.tag! 'soap12:Header' do
+              xml.tag! 'eWAYHeader', {'xmlns' => 'https://www.eway.com.au/gateway/managedpayment'} do
+                xml.tag! 'eWAYCustomerID', @options[:login]
+                xml.tag! 'Username', @options[:username]
+                xml.tag! 'Password', @options[:password]
+              end
+            end
+            xml.tag! 'soap12:Body' do |x|
+              x.tag! "#{action}", {'xmlns' => 'https://www.eway.com.au/gateway/managedpayment'} do |y|
+                post.each do |key, value|
+                  y.tag! "#{key}", "#{value}"
+                end 
+              end
+            end
+          end
+        xml.target!
+      end
+      
+      def default_fields
+        hash={}
+        %w( CustomerRef Title FirstName LastName Company JobDesc Email Address Suburb State PostCode Country Phone Mobile Fax URL Comments CCNumber CCNameOnCard CCExpiryMonth CCExpiryYear ).each do |field|
+          hash[field.to_sym]=''
+        end
+        return hash
+      end
+      
+      class EwayResponse < Response
+        # add a method to response so we can easily get the eway token "ManagedCustomerID"
+        def token
+          @params['CreateCustomerResult']
+        end
+      end
+      
+    end
+  end
+end

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

@@ -49,19 +49,18 @@ module ActiveMerchant #:nodoc:
         commit('capture', money, options)
       end
 
-      def credit(money, identification, options = {}) # also referred to as refund
-        post = { :transactionid => identification}
-        commit('refund', money, post)
-      end
-
       def void(authorization, options = {})
         options[:transactionid] = authorization
         commit('void', nil, options)
       end
 
       def refund(money, authorization, options = {})
-        options[:transactionid] = authorization
-        commit('refund', money, options)
+        commit('refund', money, options.merge(:transactionid => authorization))
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
       end
 
       private

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

@@ -47,8 +47,8 @@ module ActiveMerchant #:nodoc:
         commit('sale', money, post)
       end                       
       
-      def credit(money, reference, options = {})
-        raise ArgumentError, "Both TransactionID and CreditCard are required" unless reference.is_a?(String) && options[:credit_card]
+      def refund(money, reference, options = {})
+        requires!(options, :credit_card)
 
         post = FirstPayPostData.new
         add_invoice(post, options)
@@ -59,6 +59,11 @@ module ActiveMerchant #:nodoc:
       
         commit('credit', money, post)
       end
+
+      def credit(money, reference, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, reference, options)
+      end
       
       def void(money, creditcard, options = {})
         post = FirstPayPostData.new

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

@@ -59,7 +59,7 @@ module ActiveMerchant #:nodoc:
       end
       
       def credit(money, authorization, options={})
-        warn CREDIT_DEPRECATION_MESSAGE
+        deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 

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

@@ -58,7 +58,8 @@ module ActiveMerchant #:nodoc:
         "025" =>  "Transaction Not Found.",
         "981" =>  "AVS Error.",
         "913" =>  "Invalid Card Type.",
-        "996" =>  "Terminal ID Not Found."
+        "996" =>  "Terminal ID Not Found.",
+        nil   =>  "No response returned (missing credentials?)."
       }
       
       def initialize(options = {})
@@ -86,7 +87,7 @@ module ActiveMerchant #:nodoc:
 
       def credit(money, transaction_id_or_card, options = {})
         if transaction_id_or_card.is_a?(String)
-          warn CREDIT_DEPRECATION_MESSAGE
+          deprecated CREDIT_DEPRECATION_MESSAGE
           refund(money, transaction_id_or_card, options)
         else
           commit(money, build_credit_request('CREDIT', money, nil, transaction_id_or_card))
@@ -180,6 +181,8 @@ module ActiveMerchant #:nodoc:
       end
       
       def parse(body)
+        return {} if body.blank?
+
         xml = REXML::Document.new(body)
         
         response = {}

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

@@ -233,13 +233,18 @@ module ActiveMerchant #:nodoc:
       # 
       # identification must be a valid order id previously submitted by SALE
       #
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         options.update(
           :ordertype => "CREDIT",
           :order_id => identification
         )
         commit(money, nil, options)
       end
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
     
       def test?
         @options[:test] || super