activemerchant 1.29.1 → 1.31.0

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

@@ -2,137 +2,10 @@ require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # First, make sure you have everything setup correctly and all of your dependencies in place with:
-    #
-    #   require 'rubygems'
-    #   require 'active_merchant'
-    #
-    # ActiveMerchant expects the amounts to be given as an Integer in cents. In this case, $10 US becomes 1000.
-    #
-    #   tendollar = 1000
-    #
-    # The transaction result is based on the cent value of the transaction. $10.15 will return a failed transaction
-    # with a response code of "15 – No Issuer", while $10.00 will return "00 – Transaction Approved."
-    #
-    # Next, create a credit card object using a eWay approved test card number (4444333322221111).
-    #
-    #   creditcard = ActiveMerchant::Billing::CreditCard.new(
-    #     :number => '4444333322221111',
-    #     :month => 8,
-    #     :year => 2006,
-    #     :first_name => 'Longbob',
-    #     :last_name => 'Longsen',
-    #     :verification_value => '123'
-    #   )
-    #   options = {
-    #     :order_id => '1230123',
-    #     :email => 'bob@testbob.com',
-    #     :address => { :address1 => '47 Bobway',
-    #                   :city => 'Bobville',
-    #                   :state => 'WA',
-    #                   :country => 'Australia',
-    #                   :zip => '2000'
-    #                 },
-    #     :description => 'purchased items'
-    #   }
-    #
-    # To finish setting up, create the active_merchant object you will be using, with the eWay gateway. If you have a
-    # functional eWay account, replace :login with your Customer ID.
-    #
-    #   gateway = ActiveMerchant::Billing::Base.gateway(:eway).new(:login => '87654321')
-    #
-    # Now we are ready to process our transaction
-    #
-    #   response = gateway.purchase(tendollar, creditcard, options)
-    #
-    # Sending a transaction to eWay with active_merchant returns a Response object, which consistently allows you to:
-    #
-    # 1) Check whether the transaction was successful
-    #
-    #   response.success?
-    #
-    # 2) Retrieve any message returned by eWay, either a "transaction was successful" note or an explanation of why the
-    # transaction was rejected.
-    #
-    #   response.message
-    #
-    # 3) Retrieve and store the unique transaction ID returned by eWway, for use in referencing the transaction in the future.
-    #
-    #   response.authorization
-    #
-    # This should be enough to get you started with eWay and active_merchant. For further information, review the methods
-    # below and the rest of active_merchant's documentation.
-
+    # Public: For more information on the Eway Gateway please visit their
+    # {Developers Area}[http://www.eway.com.au/developers/api/direct-payments]
     class EwayGateway < Gateway
-      self.test_url = 'https://www.eway.com.au/gateway/xmltest/testpage.asp'
-      self.live_url = 'https://www.eway.com.au/gateway/xmlpayment.asp'
-
-      class_attribute :test_cvn_url, :live_cvn_url
-      self.test_cvn_url = 'https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp'
-      self.live_cvn_url = 'https://www.eway.com.au/gateway_cvn/xmlpayment.asp'
-
-      MESSAGES = {
-        "00" => "Transaction Approved",
-        "01" => "Refer to Issuer",
-        "02" => "Refer to Issuer, special",
-        "03" => "No Merchant",
-        "04" => "Pick Up Card",
-        "05" => "Do Not Honour",
-        "06" => "Error",
-        "07" => "Pick Up Card, Special",
-        "08" => "Honour With Identification",
-        "09" => "Request In Progress",
-        "10" => "Approved For Partial Amount",
-        "11" => "Approved, VIP",
-        "12" => "Invalid Transaction",
-        "13" => "Invalid Amount",
-        "14" => "Invalid Card Number",
-        "15" => "No Issuer",
-        "16" => "Approved, Update Track 3",
-        "19" => "Re-enter Last Transaction",
-        "21" => "No Action Taken",
-        "22" => "Suspected Malfunction",
-        "23" => "Unacceptable Transaction Fee",
-        "25" => "Unable to Locate Record On File",
-        "30" => "Format Error",
-        "31" => "Bank Not Supported By Switch",
-        "33" => "Expired Card, Capture",
-        "34" => "Suspected Fraud, Retain Card",
-        "35" => "Card Acceptor, Contact Acquirer, Retain Card",
-        "36" => "Restricted Card, Retain Card",
-        "37" => "Contact Acquirer Security Department, Retain Card",
-        "38" => "PIN Tries Exceeded, Capture",
-        "39" => "No Credit Account",
-        "40" => "Function Not Supported",
-        "41" => "Lost Card",
-        "42" => "No Universal Account",
-        "43" => "Stolen Card",
-        "44" => "No Investment Account",
-        "51" => "Insufficient Funds",
-        "52" => "No Cheque Account",
-        "53" => "No Savings Account",
-        "54" => "Expired Card",
-        "55" => "Incorrect PIN",
-        "56" => "No Card Record",
-        "57" => "Function Not Permitted to Cardholder",
-        "58" => "Function Not Permitted to Terminal",
-        "59" => "Suspected Fraud",
-        "60" => "Acceptor Contact Acquirer",
-        "61" => "Exceeds Withdrawal Limit",
-        "62" => "Restricted Card",
-        "63" => "Security Violation",
-        "64" => "Original Amount Incorrect",
-        "66" => "Acceptor Contact Acquirer, Security",
-        "67" => "Capture Card",
-        "75" => "PIN Tries Exceeded",
-        "82" => "CVV Validation Error",
-        "90" => "Cutoff In Progress",
-        "91" => "Card Issuer Unavailable",
-        "92" => "Unable To Route Transaction",
-        "93" => "Cannot Complete, Violation Of The Law",
-        "94" => "Duplicate Transaction",
-        "96" => "System Error"
-      }
+      self.live_url = 'https://www.eway.com.au'
 
       self.money_format = :cents
       self.supported_countries = ['AU']
@@ -140,28 +13,46 @@ module ActiveMerchant #:nodoc:
       self.homepage_url = 'http://www.eway.com.au/'
       self.display_name = 'eWAY'
 
+      # Public: Create a new Eway Gateway.
+      # options - A hash of options:
+      #           :login     - Your Customer ID.
+      #           :password  - Your XML Refund Password that you
+      #                        specified on the Eway site. (optional)
       def initialize(options = {})
         requires!(options, :login)
         super
       end
 
-      # ewayCustomerEmail, ewayCustomerAddress, ewayCustomerPostcode
       def purchase(money, creditcard, options = {})
         requires_address!(options)
 
         post = {}
         add_creditcard(post, creditcard)
         add_address(post, options)
-        add_customer_data(post, options)
+        add_customer_id(post)
         add_invoice_data(post, options)
-        # The request fails if all of the fields aren't present
-        add_optional_data(post)
+        add_non_optional_data(post)
+        add_amount(post, money)
+        post[:CustomerEmail] = options[:email]
 
-        commit(money, post)
+        commit(purchase_url(post[:CVN]), money, post)
       end
 
-      private
+      def refund(money, authorization, options={})
+        post = {}
 
+        add_customer_id(post)
+        add_amount(post, money)
+        add_non_optional_data(post)
+        post[:OriginalTrxnNumber] = authorization
+        post[:RefundPassword] = @options[:password]
+        post[:CardExpiryMonth] = nil
+        post[:CardExpiryYear] = nil
+
+        commit(refund_url, money, post)
+      end
+
+      private
       def requires_address!(options)
         raise ArgumentError.new("Missing eWay required parameters: address or billing_address") unless (options.has_key?(:address) or options.has_key?(:billing_address))
       end
@@ -184,8 +75,8 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def add_customer_data(post, options)
-        post[:CustomerEmail] = options[:email]
+      def add_customer_id(post)
+        post[:CustomerID] = @options[:login]
       end
 
       def add_invoice_data(post, options)
@@ -193,21 +84,26 @@ module ActiveMerchant #:nodoc:
         post[:CustomerInvoiceDescription] = options[:description]
       end
 
-      def add_optional_data(post)
-        post[:TrxnNumber] = nil
+      def add_amount(post, money)
+        post[:TotalAmount] = amount(money)
+      end
+
+      def add_non_optional_data(post)
         post[:Option1] = nil
         post[:Option2] = nil
         post[:Option3] = nil
+        post[:TrxnNumber] = nil
       end
 
-      def commit(money, parameters)
-        parameters[:TotalAmount] = amount(money)
+      def commit(url, money, parameters)
+        raw_response = ssl_post(url, post_data(parameters))
+        response = parse(raw_response)
 
-        response = parse( ssl_post(gateway_url(parameters[:CVN], test?), post_data(parameters)) )
-
-        Response.new(success?(response), message_from(response[:ewaytrxnerror]), response,
-          :authorization => response[:ewayauthcode],
-          :test => /\(Test( CVN)? Gateway\)/ === response[:ewaytrxnerror]
+        Response.new(success?(response),
+          message_from(response[:ewaytrxnerror]),
+          response,
+          :authorization => response[:ewaytrxnnumber],
+          :test => test?
         )
       end
 
@@ -215,35 +111,17 @@ module ActiveMerchant #:nodoc:
         response[:ewaytrxnstatus] == "True"
       end
 
-      # Parse eway response xml into a convinient hash
       def parse(xml)
-        #  "<?xml version=\"1.0\"?>".
-        #  <ewayResponse>
-        #  <ewayTrxnError></ewayTrxnError>
-        #  <ewayTrxnStatus>True</ewayTrxnStatus>
-        #  <ewayTrxnNumber>10002</ewayTrxnNumber>
-        #  <ewayTrxnOption1></ewayTrxnOption1>
-        #  <ewayTrxnOption2></ewayTrxnOption2>
-        #  <ewayTrxnOption3></ewayTrxnOption3>
-        #  <ewayReturnAmount>10</ewayReturnAmount>
-        #  <ewayAuthCode>123456</ewayAuthCode>
-        #  <ewayTrxnReference>987654321</ewayTrxnReference>
-        #  </ewayResponse>
-
         response = {}
         xml = REXML::Document.new(xml)
         xml.elements.each('//ewayResponse/*') do |node|
-
           response[node.name.downcase.to_sym] = normalize(node.text)
-
         end unless xml.root.nil?
 
         response
       end
 
       def post_data(parameters = {})
-        parameters[:CustomerID] = @options[:login]
-
         xml   = REXML::Document.new
         root  = xml.add_element("ewaygateway")
 
@@ -269,14 +147,79 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def gateway_url(cvn, test)
-        if cvn
-          test ? self.test_cvn_url : self.live_cvn_url
-        else
-          test ? self.test_url : self.live_url
-        end
+      def purchase_url(cvn)
+        suffix = test? ? 'xmltest/testpage.asp' : 'xmlpayment.asp'
+        gateway_part = cvn ? 'gateway_cvn' : 'gateway'
+        "#{live_url}/#{gateway_part}/#{suffix}"
       end
 
+      def refund_url
+        suffix = test? ? 'xmltest/refund_test.asp' : 'xmlpaymentrefund.asp'
+        "#{live_url}/gateway/#{suffix}"
+      end
+
+      MESSAGES = {
+        "00" => "Transaction Approved",
+        "01" => "Refer to Issuer",
+        "02" => "Refer to Issuer, special",
+        "03" => "No Merchant",
+        "04" => "Pick Up Card",
+        "05" => "Do Not Honour",
+        "06" => "Error",
+        "07" => "Pick Up Card, Special",
+        "08" => "Honour With Identification",
+        "09" => "Request In Progress",
+        "10" => "Approved For Partial Amount",
+        "11" => "Approved, VIP",
+        "12" => "Invalid Transaction",
+        "13" => "Invalid Amount",
+        "14" => "Invalid Card Number",
+        "15" => "No Issuer",
+        "16" => "Approved, Update Track 3",
+        "19" => "Re-enter Last Transaction",
+        "21" => "No Action Taken",
+        "22" => "Suspected Malfunction",
+        "23" => "Unacceptable Transaction Fee",
+        "25" => "Unable to Locate Record On File",
+        "30" => "Format Error",
+        "31" => "Bank Not Supported By Switch",
+        "33" => "Expired Card, Capture",
+        "34" => "Suspected Fraud, Retain Card",
+        "35" => "Card Acceptor, Contact Acquirer, Retain Card",
+        "36" => "Restricted Card, Retain Card",
+        "37" => "Contact Acquirer Security Department, Retain Card",
+        "38" => "PIN Tries Exceeded, Capture",
+        "39" => "No Credit Account",
+        "40" => "Function Not Supported",
+        "41" => "Lost Card",
+        "42" => "No Universal Account",
+        "43" => "Stolen Card",
+        "44" => "No Investment Account",
+        "51" => "Insufficient Funds",
+        "52" => "No Cheque Account",
+        "53" => "No Savings Account",
+        "54" => "Expired Card",
+        "55" => "Incorrect PIN",
+        "56" => "No Card Record",
+        "57" => "Function Not Permitted to Cardholder",
+        "58" => "Function Not Permitted to Terminal",
+        "59" => "Suspected Fraud",
+        "60" => "Acceptor Contact Acquirer",
+        "61" => "Exceeds Withdrawal Limit",
+        "62" => "Restricted Card",
+        "63" => "Security Violation",
+        "64" => "Original Amount Incorrect",
+        "66" => "Acceptor Contact Acquirer, Security",
+        "67" => "Capture Card",
+        "75" => "PIN Tries Exceeded",
+        "82" => "CVV Validation Error",
+        "90" => "Cutoff In Progress",
+        "91" => "Card Issuer Unavailable",
+        "92" => "Unable To Route Transaction",
+        "93" => "Cannot Complete, Violation Of The Law",
+        "94" => "Duplicate Transaction",
+        "96" => "System Error"
+      }
     end
   end
 end

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

@@ -89,7 +89,18 @@ module ActiveMerchant #:nodoc:
         commit("ProcessPayment", post)
       end
 
-      # TODO: eWay API also provides QueryCustomer
+      # Get customer's stored credit card details given by billing_id
+      #
+      # ==== Parameters
+      #
+      # * <tt>billing_id</tt> -- The eWay provided card/customer token to charge (managedCustomerID)
+      def retrieve(billing_id)
+        post = {}
+        post[:managedCustomerID] = billing_id.to_s
+
+        commit("QueryCustomer", post)
+      end
+
       # TODO: eWay API also provides QueryPayment
 
       private
@@ -146,25 +157,29 @@ module ActiveMerchant #:nodoc:
             # 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
+            if root = REXML::XPath.first(xml, '//QueryCustomerResult') then
+              reply=parse_query_customer(root)
             else
-              if root = REXML::XPath.first(xml, '//UpdateCustomerResult') then
-                if root.text.downcase == 'true' then
-                  reply[:message]='OK'
-                  reply[:success]=true
+              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. 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"
+                  # ERROR: This state should never occur currently. We have handled
+                  #        responses for all the methods which we support.
+                  raise StandardError, "Unexpected response"
                 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
@@ -188,6 +203,17 @@ module ActiveMerchant #:nodoc:
         reply
       end
 
+      def parse_query_customer(node)
+        reply={}
+        reply[:message]='OK'
+        reply[:success]=true
+        reply[:CCNumber]=REXML::XPath.first(node, '//CCNumber').text
+        reply[:CCName]=REXML::XPath.first(node, '//CCName').text
+        reply[:CCExpiryMonth]=REXML::XPath.first(node, '//CCExpiryMonth').text
+        reply[:CCExpiryYear]=REXML::XPath.first(node, '//CCExpiryYear').text
+        reply
+      end
+
       def commit(action, post)
         raw = begin
           ssl_post(test? ? self.test_url : self.live_url, soap_request(post, action), 'Content-Type' => 'application/soap+xml; charset=utf-8')
@@ -206,11 +232,15 @@ module ActiveMerchant #:nodoc:
       def soap_request(arguments, action)
         # eWay demands all fields be sent, but contain an empty string if blank
         post = case action
-        when 'ProcessPayment'
-          default_payment_fields.merge(arguments)
-        else
-          default_customer_fields.merge(arguments)
-        end
+                when 'QueryCustomer'
+                  arguments
+                when 'ProcessPayment'
+                  default_payment_fields.merge(arguments)
+                when 'CreateCustomer'
+                  default_customer_fields.merge(arguments)
+                when 'UpdateCustomer'
+                  default_customer_fields.merge(arguments)
+               end
 
         xml = Builder::XmlMarkup.new :indent => 2
           xml.instruct!