activemerchant 1.29.1 → 1.31.0

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

@@ -0,0 +1,232 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class FirstdataE4Gateway < Gateway
+      self.test_url = "https://api.demo.globalgatewaye4.firstdata.com/transaction"
+      self.live_url = "https://api.globalgatewaye4.firstdata.com/transaction"
+
+      TRANSACTIONS = {
+        :sale          => "00",
+        :authorization => "01",
+        :capture       => "32",
+        :void          => "33",
+        :credit        => "34"
+      }
+
+      POST_HEADERS = {
+        "Accepts" => "application/xml",
+        "Content-Type" => "application/xml"
+      }
+
+      SUCCESS = "true"
+
+      SENSITIVE_FIELDS = [:verification_str2, :expiry_date, :card_number]
+
+      self.supported_cardtypes = [:visa, :master, :american_express, :jcb, :discover]
+      self.supported_countries = ["CA", "US"]
+      self.default_currency = "USD"
+      self.homepage_url = "http://www.firstdata.com"
+      self.display_name = "FirstData Global Gateway e4"
+
+      # Create a new FirstdataE4Gateway
+      #
+      # The gateway requires that a valid login and password be passed
+      # in the +options+ hash.
+      #
+      # ==== Options
+      #
+      # * <tt>:login</tt> --    The EXACT ID.  Also known as the Gateway ID.
+      #                         (Found in your administration terminal settings)
+      # * <tt>:password</tt> -- The terminal password (not your account password)
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+
+        super
+      end
+
+      def authorize(money, credit_card, options = {})
+        commit(:authorization, build_sale_or_authorization_request(money, credit_card, options))
+      end
+
+      def purchase(money, credit_card, options = {})
+        commit(:sale, build_sale_or_authorization_request(money, credit_card, options))
+      end
+
+      def capture(money, authorization, options = {})
+        commit(:capture, build_capture_or_credit_request(money, authorization, options))
+      end
+
+      def void(authorization, options = {})
+        commit(:void, build_capture_or_credit_request(money_from_authorization(authorization), authorization, options))
+      end
+
+      def refund(money, authorization, options = {})
+        commit(:credit, build_capture_or_credit_request(money, authorization, options))
+      end
+
+      private
+
+      def build_request(action, body)
+        xml = Builder::XmlMarkup.new
+
+        xml.instruct!
+        xml.tag! "Transaction" do
+          add_credentials(xml)
+          add_transaction_type(xml, action)
+          xml << body
+        end
+
+        xml.target!
+      end
+
+      def build_sale_or_authorization_request(money, credit_card, options)
+        xml = Builder::XmlMarkup.new
+
+        add_amount(xml, money)
+        add_credit_card(xml, credit_card)
+        add_customer_data(xml, options)
+        add_invoice(xml, options)
+
+        xml.target!
+      end
+
+      def build_capture_or_credit_request(money, identification, options)
+        xml = Builder::XmlMarkup.new
+
+        add_identification(xml, identification)
+        add_amount(xml, money)
+        add_customer_data(xml, options)
+
+        xml.target!
+      end
+
+      def add_credentials(xml)
+        xml.tag! "ExactID", @options[:login]
+        xml.tag! "Password", @options[:password]
+      end
+
+      def add_transaction_type(xml, action)
+        xml.tag! "Transaction_Type", TRANSACTIONS[action]
+      end
+
+      def add_identification(xml, identification)
+        authorization_num, transaction_tag, _ = identification.split(";")
+
+        xml.tag! "Authorization_Num", authorization_num
+        xml.tag! "Transaction_Tag", transaction_tag
+      end
+
+      def add_amount(xml, money)
+        xml.tag! "DollarAmount", amount(money)
+      end
+
+      def add_credit_card(xml, credit_card)
+        xml.tag! "Card_Number", credit_card.number
+        xml.tag! "Expiry_Date", expdate(credit_card)
+        xml.tag! "CardHoldersName", credit_card.name
+        xml.tag! "CardType", credit_card.brand
+
+        if credit_card.verification_value?
+          xml.tag! "CVD_Presence_Ind", "1"
+          xml.tag! "VerificationStr2", credit_card.verification_value
+        end
+      end
+
+      def add_customer_data(xml, options)
+        xml.tag! "Customer_Ref", options[:customer] if options[:customer]
+        xml.tag! "Client_IP", options[:ip] if options[:ip]
+        xml.tag! "Client_Email", options[:email] if options[:email]
+      end
+
+      def add_address(xml, options)
+        if address = (options[:billing_address] || options[:address])
+          xml.tag! "ZipCode", address[:zip]
+        end
+      end
+
+      def add_invoice(xml, options)
+        xml.tag! "Reference_No", options[:order_id]
+        xml.tag! "Reference_3",  options[:description] if options[:description]
+      end
+
+      def expdate(credit_card)
+        "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
+      end
+
+      def commit(action, request)
+        url = (test? ? self.test_url : self.live_url)
+        begin
+          response = parse(ssl_post(url, build_request(action, request), POST_HEADERS))
+        rescue ResponseError => e
+          response = parse_error(e.response)
+        end
+
+        Response.new(successful?(response), message_from(response), response,
+          :test => test?,
+          :authorization => authorization_from(response),
+          :avs_result => {:code => response[:avs]},
+          :cvv_result => response[:cvv2]
+        )
+      end
+
+      def successful?(response)
+        response[:transaction_approved] == SUCCESS
+      end
+
+      def authorization_from(response)
+        if response[:authorization_num] && response[:transaction_tag]
+          [
+            response[:authorization_num],
+            response[:transaction_tag],
+            (response[:dollar_amount].to_f * 100).to_i
+          ].join(";")
+        else
+          ""
+        end
+      end
+
+      def money_from_authorization(auth)
+        _, _, amount = auth.split(/;/, 3)
+        amount.to_i # return the # of cents, no need to divide
+      end
+
+      def message_from(response)
+        if(response[:faultcode] && response[:faultstring])
+          response[:faultstring]
+        elsif(response[:error_number] != "0")
+          response[:error_description]
+        else
+          result = (response[:exact_message] || "")
+          result << " - #{response[:bank_message]}" if response[:bank_message].present?
+          result
+        end
+      end
+
+      def parse_error(error)
+        {
+          :transaction_approved => "false",
+          :error_number => error.code,
+          :error_description => error.body
+        }
+      end
+
+      def parse(xml)
+        response = {}
+        xml = REXML::Document.new(xml)
+
+        if root = REXML::XPath.first(xml, "//TransactionResult")
+          parse_elements(response, root)
+        end
+
+        response.delete_if{ |k,v| SENSITIVE_FIELDS.include?(k) }
+      end
+
+      def parse_elements(response, root)
+        root.elements.to_a.each do |node|
+          response[node.name.gsub(/EXact/, "Exact").underscore.to_sym] = (node.text || "").strip
+        end
+      end
+    end
+  end
+end
+

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

@@ -9,12 +9,23 @@ module ActiveMerchant #:nodoc:
     #
     # ActiveMerchant expects the amounts to be given as an Integer in cents. In this case, 10 EUR becomes 1000.
     #
+    # Create certificates for authentication:
+    #
+    # The PEM file expected should contain both the certificate and the generated PEM file.
+    # Some sample shell commands to generate the certificates:
+    #
+    #    openssl genrsa -aes128 -out priv.pem -passout pass:[YOUR PASSWORD] 1024
+    #    openssl req -x509 -new -key priv.pem -passin pass:[YOUR PASSWORD] -days 3000 -out cert.cer
+    #    cat cert.cer priv.pem > ideal.pem
+    #
+    # Following the steps above, upload cert.cer to the ideal web interface and pass the path of ideal.pem to the :pem option.
+    #
     # Configure the gateway using your iDEAL bank account info and security settings:
     #
     # Create gateway:
     #    gateway = ActiveMerchant::Billing::IdealRabobankGateway.new(
-    #      :login    => '123456789', # merchant number
-    #      :pem      => File.read(RAILS_ROOT + '/config/ideal.pem'), # put certificate and PEM in this file
+    #      :login    => '123456789', # 9 digit merchant number
+    #      :pem      => File.read(Rails.root + 'config/ideal.pem'),
     #      :password => 'password' # password for the PEM key
     #    )
     #

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

@@ -71,13 +71,13 @@ module ActiveMerchant #:nodoc:
         super
       end
 
-      def authorize(money, creditcard, options = {})
-        to_pass = create_credit_card_hash(money, creditcard, options)
+      def authorize(money, creditcard_or_token, options = {})
+        to_pass = build_authorize_request(money, creditcard_or_token, options)
         build_response(:authorization, @litle.authorization(to_pass))
       end
 
-      def purchase(money, creditcard, options = {})
-        to_pass = create_credit_card_hash(money, creditcard, options)
+      def purchase(money, creditcard_or_token, options = {})
+        to_pass = build_purchase_request(money, creditcard_or_token, options)
         build_response(:sale, @litle.sale(to_pass))
       end
 
@@ -98,7 +98,7 @@ module ActiveMerchant #:nodoc:
 
       def store(creditcard, options = {})
         to_pass = create_token_hash(creditcard, options)
-        build_response(:registerToken, @litle.register_token_request(to_pass), %w(801 802))
+        build_response(:registerToken, @litle.register_token_request(to_pass), %w(000 801 802))
       end
 
       private
@@ -142,11 +142,17 @@ module ActiveMerchant #:nodoc:
         if response['response'] == "0"
           detail = response["#{kind}Response"]
           fraud = fraud_result(detail)
+          authorization = case kind
+          when :registerToken
+            response['registerTokenResponse']['litleToken']
+          else
+            detail['litleTxnId']
+          end
           Response.new(
             valid_responses.include?(detail['response']),
             detail['message'],
             {:litleOnlineResponse => response},
-            :authorization => detail['litleTxnId'],
+            :authorization => authorization,
             :avs_result => {:code => fraud['avs']},
             :cvv_result => fraud['cvv'],
             :test => test?
@@ -156,27 +162,52 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def create_credit_card_hash(money, creditcard, options)
-        cc_type = CARD_TYPE[creditcard.brand]
+      def build_authorize_request(money, creditcard_or_token, options)
+        hash = create_hash(money, options)
+
+        add_credit_card_or_token_hash(hash, creditcard_or_token)
+
+        hash
+      end
+
+      def build_purchase_request(money, creditcard_or_token, options)
+        hash = create_hash(money, options)
+
+        add_credit_card_or_token_hash(hash, creditcard_or_token)
 
-        exp_date_yr = creditcard.year.to_s()[2..3]
+        hash
+      end
 
-        if( creditcard.month.to_s().length == 1 )
-          exp_date_mo = '0' + creditcard.month.to_s()
+      def add_credit_card_or_token_hash(hash, creditcard_or_token)
+        if creditcard_or_token.is_a?(String)
+          add_token_hash(hash, creditcard_or_token)
         else
-          exp_date_mo = creditcard.month.to_s()
+          add_credit_card_hash(hash, creditcard_or_token)
         end
+      end
 
-        exp_date = exp_date_mo + exp_date_yr
+      def add_token_hash(hash, creditcard_or_token)
+        token_info = {
+            'litleToken' => creditcard_or_token
+        }
+
+        hash['token'] = token_info
+        hash
+      end
+
+      def add_credit_card_hash(hash, creditcard)
+        cc_type     = CARD_TYPE[creditcard.brand]
+        exp_date_yr = creditcard.year.to_s[2..3]
+        exp_date_mo = '%02d' % creditcard.month.to_i
+        exp_date    = exp_date_mo + exp_date_yr
 
         card_info = {
-          'type' => cc_type,
-          'number' => creditcard.number,
-          'expDate' => exp_date,
-          'cardValidationNum' => creditcard.verification_value
+            'type'              => cc_type,
+            'number'            => creditcard.number,
+            'expDate'           => exp_date,
+            'cardValidationNum' => creditcard.verification_value
         }
 
-        hash = create_hash(money, options)
         hash['card'] = card_info
         hash
       end
@@ -258,7 +289,7 @@ module ActiveMerchant #:nodoc:
           'customerId' => options[:customer],
           'reportGroup' => (options[:merchant] || @options[:merchant]),
           'merchantId' => (options[:merchant_id] || @options[:merchant_id]),
-          'orderSource' => 'ecommerce',
+          'orderSource' => (options[:order_source] || 'ecommerce'),
           'enhancedData' => enhanced_data,
           'fraudCheckType' => fraud_check_type,
           'user' => (options[:user] || @options[:user]),

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

@@ -1,7 +1,10 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class MerchantWareGateway < Gateway
+      class_attribute :v4_live_url
+
       self.live_url = self.test_url = 'https://ps1.merchantware.net/MerchantWARE/ws/RetailTransaction/TXRetail.asmx'
+      self.v4_live_url = 'https://ps1.merchantware.net/Merchantware/ws/RetailTransaction/v4/Credit.asmx'
 
       self.supported_countries = ['US']
       self.supported_cardtypes = [:visa, :master, :american_express, :discover]
@@ -12,13 +15,19 @@ module ActiveMerchant #:nodoc:
                          "xmlns:xsd"  => "http://www.w3.org/2001/XMLSchema",
                          "xmlns:env" => "http://schemas.xmlsoap.org/soap/envelope/"
                        }
+      ENV_NAMESPACES_V4 = { "xmlns:xsi"  => "http://www.w3.org/2001/XMLSchema-instance",
+                            "xmlns:xsd"  => "http://www.w3.org/2001/XMLSchema",
+                            "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/"
+                          }
+
       TX_NAMESPACE = "http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail"
+      TX_NAMESPACE_V4 = "http://schemas.merchantwarehouse.com/merchantware/40/Credit/"
 
       ACTIONS = {
         :purchase  => "IssueKeyedSale",
         :authorize => "IssueKeyedPreAuth",
         :capture   => "IssuePostAuth",
-        :void      => "IssueVoid",
+        :void      => "VoidPreAuthorization",
         :credit    => "IssueKeyedRefund",
         :reference_credit => "IssueRefundByReference"
       }
@@ -80,11 +89,10 @@ module ActiveMerchant #:nodoc:
       # * <tt>authorization</tt> - The authorization string returned from the initial authorization or purchase.
       def void(authorization, options = {})
         reference, options[:order_id] = split_reference(authorization)
-
-        request = soap_request(:void) do |xml|
-          add_reference(xml, reference)
+        request = v4_soap_request(:void) do |xml|
+          add_reference_token(xml, reference)
         end
-        commit(:void, request)
+        commit(:void, request, true)
       end
 
       # Refund an amount back a cardholder
@@ -108,7 +116,6 @@ module ActiveMerchant #:nodoc:
         perform_reference_credit(money, reference, options)
       end
 
-
       private
 
       def soap_request(action)
@@ -125,6 +132,22 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
+      def v4_soap_request(action)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! "soap:Envelope", ENV_NAMESPACES_V4 do
+          xml.tag! "soap:Body" do
+            xml.tag! ACTIONS[:void], "xmlns" => TX_NAMESPACE_V4 do
+              xml.tag! "merchantName", @options[:name]
+              xml.tag! "merchantSiteId", @options[:login]
+              xml.tag! "merchantKey", @options[:password]
+              yield xml
+            end
+          end
+        end
+        xml.target!
+      end
+
       def build_purchase_request(action, money, credit_card, options)
         requires!(options, :order_id)
 
@@ -195,6 +218,10 @@ module ActiveMerchant #:nodoc:
         xml.tag! "strReferenceCode", reference
       end
 
+      def add_reference_token(xml, reference)
+        xml.tag! "token", reference
+      end
+
       def add_address(xml, options)
         if address = options[:billing_address] || options[:address]
           xml.tag! "strAVSStreetAddress", address[:address1]
@@ -258,11 +285,19 @@ module ActiveMerchant #:nodoc:
         response
       end
 
-      def commit(action, request)
+      def soap_action(action, v4 = false)
+        v4 ? "#{TX_NAMESPACE_V4}#{ACTIONS[action]}" : "#{TX_NAMESPACE}/#{ACTIONS[action]}"
+      end
+
+      def url(v4 = false)
+        v4 ? v4_live_url : live_url
+      end
+
+      def commit(action, request, v4 = false)
         begin
-          data = ssl_post(self.live_url, request,
+          data = ssl_post(url(v4), request,
                    "Content-Type" => 'text/xml; charset=utf-8',
-                   "SOAPAction"   => "http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail/#{ACTIONS[action]}"
+                   "SOAPAction"   => soap_action(action, v4)
                  )
           response = parse(action, data)
         rescue ActiveMerchant::ResponseError => e

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

@@ -0,0 +1,190 @@
+require 'digest/md5'
+require 'rexml/document'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class MerchantWarriorGateway < Gateway
+      TOKEN_TEST_URL = 'https://base.merchantwarrior.com/token/'
+      TOKEN_LIVE_URL = 'https://api.merchantwarrior.com/token/'
+
+      POST_TEST_URL = 'https://base.merchantwarrior.com/post/'
+      POST_LIVE_URL = 'https://api.merchantwarrior.com/post/'
+
+      self.supported_countries = ['AU']
+      self.supported_cardtypes = [:visa, :master, :american_express,
+                                  :diners_club, :discover]
+      self.homepage_url = 'http://www.merchantwarrior.com/'
+      self.display_name = 'MerchantWarrior'
+
+      self.money_format = :dollars
+      self.default_currency = 'AUD'
+
+      def initialize(options = {})
+        requires!(options, :merchant_uuid, :api_key, :api_passphrase)
+        super
+      end
+
+      def authorize(money, payment_method, options = {})
+        post = {}
+        add_amount(post, money, options)
+        add_product(post, options)
+        add_address(post, options)
+        add_payment_method(post, payment_method)
+        commit('processAuth', post)
+      end
+
+      def purchase(money, payment_method, options = {})
+        post = {}
+        add_amount(post, money, options)
+        add_product(post, options)
+        add_address(post, options)
+        add_payment_method(post, payment_method)
+        commit('processCard', post)
+      end
+
+      def capture(money, identification)
+        post = {}
+        add_amount(post, money, options)
+        add_transaction(post, identification)
+        post.merge!('captureAmount' => money.to_s)
+        commit('processCapture', post)
+      end
+
+      def refund(money, identification)
+        post = {}
+        add_amount(post, money, options)
+        add_transaction(post, identification)
+        post['refundAmount'] = money
+        commit('refundCard', post)
+      end
+
+      def store(creditcard, options = {})
+        post = {
+          'cardName' => creditcard.name,
+          'cardNumber' => creditcard.number,
+          'cardExpiryMonth' => sprintf('%02d', creditcard.month),
+          'cardExpiryYear' => sprintf('%02d', creditcard.year)
+        }
+        commit('addCard', post)
+      end
+
+      private
+
+      def add_transaction(post, identification)
+        post['transactionID'] = identification
+      end
+
+      def add_address(post, options)
+        return unless(address = options[:address])
+
+        post['customerName'] = address[:name]
+        post['customerCountry'] = address[:country]
+        post['customerState'] = address[:state]
+        post['customerCity'] = address[:city]
+        post['customerAddress'] = address[:address1]
+        post['customerPostCode'] = address[:zip]
+      end
+
+      def add_product(post, options)
+        post['transactionProduct'] = options[:transaction_product]
+      end
+
+      def add_payment_method(post, payment_method)
+        if payment_method.respond_to?(:number)
+          add_creditcard(post, payment_method)
+        else
+          add_token(post, payment_method)
+        end
+      end
+
+      def add_token(post, token)
+        post['cardID'] = token
+      end
+
+      def add_creditcard(post, creditcard)
+        post['paymentCardNumber'] = creditcard.number
+        post['paymentCardName'] = creditcard.name
+        post['paymentCardExpiry'] = creditcard.expiry_date.expiration.strftime("%m%y")
+      end
+
+      def add_amount(post, money, options)
+        currency = (options[:currency] || currency(money))
+
+        post['transactionAmount'] = money.to_s
+        post['transactionCurrency'] = currency
+        post['hash'] = verification_hash(money, currency)
+      end
+
+      def verification_hash(money, currency)
+        Digest::MD5.hexdigest(
+          (
+            @options[:api_passphrase].to_s +
+            @options[:merchant_uuid].to_s +
+            money.to_s +
+            currency
+          ).downcase
+        )
+      end
+
+      def parse(body)
+        xml = REXML::Document.new(body)
+
+        response = {}
+        xml.root.elements.to_a.each do |node|
+          parse_element(response, node)
+        end
+        response
+      end
+
+      def parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|element| parse_element(response, element)}
+        else
+          response[node.name.underscore.to_sym] = node.text
+        end
+      end
+
+      def commit(action, post)
+        add_auth(action, post)
+
+        response = parse(ssl_post(url_for(action, post), post_data(post)))
+
+        Response.new(
+          success?(response),
+          response[:response_message],
+          response,
+          :test => test?,
+          :authorization => (response[:card_id] || response[:transaction_id])
+        )
+      end
+
+      def add_auth(action, post)
+        post['merchantUUID'] = @options[:merchant_uuid]
+        post['apiKey'] = @options[:api_key]
+        unless token?(post)
+          post['method'] = action
+        end
+      end
+
+      def url_for(action, post)
+        if token?(post)
+          [(test? ? TOKEN_TEST_URL : TOKEN_LIVE_URL), action].join("/")
+        else
+          (test? ? POST_TEST_URL : POST_LIVE_URL)
+        end
+      end
+
+      def token?(post)
+        (post["cardID"] || post["cardName"])
+      end
+
+      def success?(response)
+        (response[:response_code] == '0')
+      end
+
+      def post_data(post)
+        post.collect{|k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
+      end
+    end
+  end
+end