johnreitano-activemerchant 1.5.2

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

@@ -0,0 +1,283 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class MerchantWareGateway < Gateway
+      URL = 'https://ps1.merchantware.net/MerchantWARE/ws/RetailTransaction/TXRetail.asmx'
+      
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://merchantwarehouse.com/merchantware'
+      self.display_name = 'MerchantWARE'
+      
+      ENV_NAMESPACES = { "xmlns:xsi"  => "http://www.w3.org/2001/XMLSchema-instance",
+                         "xmlns:xsd"  => "http://www.w3.org/2001/XMLSchema",
+                         "xmlns:env" => "http://schemas.xmlsoap.org/soap/envelope/"
+                       }
+      TX_NAMESPACE = "http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail"
+      
+      ACTIONS = {
+        :purchase  => "IssueKeyedSale",
+        :authorize => "IssueKeyedPreAuth",
+        :capture   => "IssuePostAuth",
+        :void      => "IssueVoid",
+        :credit    => "IssueKeyedRefund",
+        :reference_credit => "IssueRefundByReference"
+      }
+      
+      # Creates a new MerchantWareGateway
+      # 
+      # The gateway requires that a valid login, password, and name be passed
+      # in the +options+ hash.
+      # 
+      # ==== Options
+      #
+      # * <tt>:login</tt> - The MerchantWARE SiteID.
+      # * <tt>:password</tt> - The MerchantWARE Key.
+      # * <tt>:name</tt> - The MerchantWARE Name.
+      def initialize(options = {})
+        requires!(options, :login, :password, :name)
+        @options = options
+        super
+      end
+
+      # Authorize a credit card for a given amount.
+      # 
+      # ==== Parameters
+      # * <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).
+      #   * <tt>:billing_address</tt> - The billing address for the cardholder.      
+      def authorize(money, credit_card, options = {})
+        request = build_purchase_request(:authorize, money, credit_card, options)
+        commit(:authorize, request)
+      end
+      
+      # Authorize and immediately capture funds from a credit card.
+      # 
+      # ==== Parameters
+      # * <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).
+      #   * <tt>:billing_address</tt> - The billing address for the cardholder.
+      def purchase(money, credit_card, options = {})
+        request = build_purchase_request(:purchase, money, credit_card, options)
+        commit(:purchase, request)
+      end                       
+
+      # Capture authorized funds from a credit card.
+      # 
+      # ==== Parameters
+      # * <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)
+        commit(:capture, request)
+      end
+
+      # Void a transaction.
+      # 
+      # ==== Parameters
+      # * <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)
+        end
+        commit(:void, request)
+      end
+      
+      # Refund an amount back a cardholder
+      # 
+      # ==== Parameters
+      #
+      # * <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)
+      def credit(money, identification, options = {})
+        if identification.is_a?(String)          
+          perform_reference_credit(money, identification, options)
+        else
+          perform_credit(money, identification, options)
+        end
+      end
+    
+      private
+      
+      def soap_request(action)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! "env:Envelope", ENV_NAMESPACES do
+          xml.tag! "env:Body" do
+            xml.tag! ACTIONS[action], "xmlns" => TX_NAMESPACE do
+              add_credentials(xml)
+              yield xml
+            end
+          end
+        end
+        xml.target!
+      end
+      
+      def build_purchase_request(action, money, credit_card, options)
+        requires!(options, :order_id)
+        
+        request = soap_request(action) do |xml|
+          add_invoice(xml, options)
+          add_amount(xml, money)
+          add_credit_card(xml, credit_card)
+          add_address(xml, options)
+        end
+      end
+      
+      def build_capture_request(action, money, identification, options)
+        reference, options[:order_id] = split_reference(identification)
+        
+        request = soap_request(action) do |xml|
+          add_reference(xml, reference)
+          add_invoice(xml, options)
+          add_amount(xml, money)
+        end
+      end
+      
+      def perform_reference_credit(money, identification, options)
+        reference, options[:order_id] = split_reference(identification)
+
+        request = soap_request(:reference_credit) do |xml|
+          add_reference(xml, reference)
+          add_invoice(xml, options)
+          add_amount(xml, money, "strOverrideAmount")
+        end
+        
+        commit(:reference_credit, request)
+      end
+      
+      def perform_credit(money, credit_card, options)
+        requires!(options, :order_id)
+        
+        request = soap_request(:credit) do |xml|
+          add_invoice(xml, options)
+          add_amount(xml, money)
+          add_credit_card(xml, credit_card)
+        end
+        
+        commit(:credit, request)
+      end
+
+      def add_credentials(xml)
+        xml.tag! "strSiteId", @options[:login]
+        xml.tag! "strKey", @options[:password]
+        xml.tag! "strName", @options[:name]
+      end
+      
+      def expdate(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+      
+      def add_invoice(xml, options)
+        xml.tag! "strOrderNumber", options[:order_id].to_s.gsub(/[^\w]/, '').slice(0, 25)
+      end
+      
+      def add_amount(xml, money, tag = "strAmount")
+        xml.tag! tag, amount(money)
+      end
+
+      def add_reference(xml, reference)
+        xml.tag! "strReferenceCode", reference
+      end
+      
+      def add_address(xml, options)
+        if address = options[:billing_address] || options[:address]
+          xml.tag! "strAVSStreetAddress", address[:address1]
+          xml.tag! "strAVSZipCode", address[:zip]
+        end
+      end
+      
+      def add_credit_card(xml, credit_card)
+        xml.tag! "strPAN", credit_card.number
+        xml.tag! "strExpDate", expdate(credit_card)
+        xml.tag! "strCardHolder", credit_card.name
+        xml.tag! "strCVCode", credit_card.verification_value if credit_card.verification_value?
+      end
+      
+      def split_reference(reference)
+        reference.to_s.split(";")
+      end
+      
+      def parse(action, data)
+        response = {}
+        xml = REXML::Document.new(data)
+      
+        root = REXML::XPath.first(xml, "//#{ACTIONS[action]}Response/#{ACTIONS[action]}Result")
+
+        root.elements.each do |element|
+          response[element.name] = element.text
+        end
+        
+        status, code, message = response["ApprovalStatus"].split(";")
+        response[:status] = status
+        
+        if response[:success] = status == "APPROVED"          
+          response[:message] = status
+        else
+          response[:message] = message
+          response[:failure_code] = code
+        end
+
+        response        
+      end
+      
+      def parse_error(http_response)
+        response = {}
+        response[:http_code] = http_response.code
+        response[:http_message] = http_response.message
+        response[:success] = false
+
+        document = REXML::Document.new(http_response.body)
+
+        node     = REXML::XPath.first(document, "//soap:Fault")
+        
+        node.elements.each do |element|
+          response[element.name] = element.text
+        end
+        
+        response[:message] = response["faultstring"].to_s.gsub("\n", " ")
+        response
+      rescue REXML::ParseException => e
+        response[:http_body]        = http_response.body
+        response[:message]          = "Failed to parse the failed response"
+        response
+      end
+            
+      def commit(action, request)
+        begin
+          data = ssl_post(URL, request, 
+                   "Content-Type" => 'text/xml; charset=utf-8',
+                   "SOAPAction"   => "http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail/#{ACTIONS[action]}"
+                 )
+          response = parse(action, data)
+        rescue ActiveMerchant::ResponseError => e
+          response = parse_error(e.response)
+        end
+        
+        Response.new(response[:success], response[:message], response, 
+          :test => test?, 
+          :authorization => authorization_from(response),
+          :avs_result => { :code => response["AVSResponse"] },
+          :cvv_result => response["CVResponse"]
+        )
+      end
+      
+      def authorization_from(response)
+        if response[:success]
+          [ response["ReferenceID"], response["OrderNumber"] ].join(";")
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/modern_payments_cim'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ModernPaymentsGateway < Gateway
+      self.supported_countries = ModernPaymentsCimGateway.supported_countries
+      self.supported_cardtypes = ModernPaymentsCimGateway.supported_cardtypes
+      self.homepage_url = ModernPaymentsCimGateway.homepage_url
+      self.display_name = ModernPaymentsCimGateway.display_name
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      def purchase(money, credit_card, options = {})
+        customer_response = cim.create_customer(options)
+        return customer_response unless customer_response.success?
+        
+        customer_id = customer_response.params["create_customer_result"]
+        
+        card_response = cim.modify_customer_credit_card(customer_id, credit_card)
+        return card_response unless card_response.success?
+        
+        cim.authorize_credit_card_payment(customer_id, money)
+      end
+      
+      private
+      def cim
+        @cim ||= ModernPaymentsCimGateway.new(@options)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,220 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ModernPaymentsCimGateway < Gateway #:nodoc:
+      TEST_URL = "https://secure.modpay.com/netservices/test/ModpayTest.asmx"
+      LIVE_URL = 'https://secure.modpay.com/ws/modpay.asmx'
+      
+      LIVE_XMLNS = "https://secure.modpay.com/ws/"
+      TEST_XMLNS = "https://secure.modpay.com/netservices/test/"
+      
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.modpay.com'
+      self.display_name = 'Modern Payments'
+      
+      SUCCESS_MESSAGE = "Transaction accepted"
+      FAILURE_MESSAGE = "Transaction failed"
+      ERROR_MESSAGE   = "Transaction error"
+      
+      PAYMENT_METHOD = {
+        :check => 1,
+        :credit_card => 2
+      }
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end  
+      
+      def create_customer(options = {})
+        post = {}
+        add_customer_data(post, options)
+        add_address(post, options)
+        
+        commit('CreateCustomer', post)
+      end
+      
+      def modify_customer_credit_card(customer_id, credit_card)
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_credit_card(post, credit_card)
+        
+        commit('ModifyCustomerCreditCard', post)
+      end
+      
+      def authorize_credit_card_payment(customer_id, amount)
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_amount(post, amount)
+        
+        commit('AuthorizeCreditCardPayment', post)
+      end
+      
+      def create_payment(customer_id, amount, options = {})
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_amount(post, amount)
+        add_payment_details(post, options)
+        
+        commit('CreatePayment', post)
+      end
+
+      private
+      def add_payment_details(post, options)
+        post[:pmtDate] = (options[:payment_date] || Time.now.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
+        post[:pmtType] = PAYMENT_METHOD[options[:payment_method] || :credit_card]
+      end
+      
+      def add_amount(post, money)
+        post[:pmtAmount] = amount(money)
+      end
+      
+      def add_customer_id(post, customer_id)
+        post[:custId] = customer_id
+      end
+      
+      def add_customer_data(post, options)
+        post[:acctNum]   = options[:customer]
+      end
+      
+      def add_address(post, options)
+        address = options[:billing_address] || options[:address] || {}
+        
+        if name = address[:name]
+          segments = name.split(' ')
+          post[:lastName] = segments.pop
+          post[:firstName] = segments.join(' ')
+        else
+          post[:firstName] = address[:first_name]
+          post[:lastName]  = address[:last_name]
+        end
+        
+        post[:address]   = address[:address1]
+        post[:city]      = address[:city]
+        post[:state]     = address[:state]
+        post[:zip]       = address[:zip]
+        post[:phone]     = address[:phone]
+        post[:fax]       = address[:fax]
+        post[:email]     = options[:email]
+      end
+      
+      def add_credit_card(post, credit_card)
+        post[:ccName] = credit_card.name
+        post[:ccNum]  = credit_card.number
+        post[:expMonth] = credit_card.month
+        post[:expYear]  = credit_card.year
+      end
+                
+      def build_request(action, params)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! 'env:Envelope',
+          { 'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+            'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+            'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance' } do
+
+          xml.tag! 'env:Body' do
+            xml.tag! action, { "xmlns" => xmlns(action) } do
+              xml.tag! "clientId", @options[:login]
+              xml.tag! "clientCode", @options[:password]
+              params.each {|key, value| xml.tag! key, value }
+            end
+          end
+        end
+        xml.target!
+      end
+      
+      def xmlns(action)
+        if test? && action == 'AuthorizeCreditCardPayment'
+          TEST_XMLNS
+        else
+          LIVE_XMLNS
+        end
+      end
+      
+      def url(action)
+        if test? && action == 'AuthorizeCreditCardPayment'
+          TEST_URL
+        else
+          LIVE_URL
+        end
+      end
+      
+      def commit(action, params)
+        data = ssl_post(url(action), build_request(action, params), 
+                 { 'Content-Type' =>'text/xml; charset=utf-8', 
+                   'SOAPAction' => "#{xmlns(action)}#{action}" }
+                )
+
+        response = parse(action, data)
+        Response.new(successful?(action, response), message_from(action, response), response, 
+          :test => test?, 
+          :authorization => authorization_from(action, response),
+          :avs_result => { :code => response[:avs_code] }
+        )
+      end
+      
+      def authorization_from(action, response)
+        response[authorization_key(action)]
+      end
+      
+      def authorization_key(action)
+        action == "AuthorizeCreditCardPayment" ? :trans_id : "#{action.underscore}_result".to_sym
+      end
+      
+      def successful?(action, response)
+        key = authorization_key(action)
+        
+        if key == :trans_id
+          response[:approved] == "true"
+        else
+          response[key].to_i > 0
+        end
+      end
+      
+      def message_from(action, response)
+        if response[:faultcode]
+          ERROR_MESSAGE
+        elsif successful?(action, response)
+          SUCCESS_MESSAGE
+        else
+          FAILURE_MESSAGE
+        end
+      end
+      
+      def parse(action, xml)
+        response = {}
+        response[:action] = action
+        
+        xml = REXML::Document.new(xml)
+        if root = REXML::XPath.first(xml, "//#{action}Response")
+          root.elements.to_a.each do |node|
+            parse_element(response, node)
+          end
+        elsif root = REXML::XPath.first(xml, "//soap:Fault")
+          root.elements.to_a.each do |node|
+            response[node.name.underscore.to_sym] = node.text
+          end
+        end
+
+        response
+      end
+      
+      def parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|e| parse_element(response, e) }
+        else
+          response[node.name.underscore.to_sym] = node.text.to_s.strip
+        end
+      end
+    end
+  end
+end
+