aktivemerchant 2.0.0

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

@@ -0,0 +1,218 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ExactGateway < Gateway
+      self.live_url = self.test_url = 'https://secure2.e-xact.com/vplug-in/transaction/rpc-enc/service.asmx'
+
+      API_VERSION = "8.5"
+
+      TEST_LOGINS = [ {:login => "A00049-01", :password => "test1"},
+                      {:login => "A00427-01", :password => "testus"} ]
+
+      TRANSACTIONS = { :sale          => "00",
+                       :authorization => "01",
+                       :capture       => "32",
+                       :credit        => "34" }
+
+
+      ENVELOPE_NAMESPACES = { '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'
+                            }
+
+      SEND_AND_COMMIT_ATTRIBUTES = { 'xmlns:n1' => "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/Request",
+                                     'env:encodingStyle' => 'http://schemas.xmlsoap.org/soap/encoding/'
+                                   }
+
+      SEND_AND_COMMIT_SOURCE_ATTRIBUTES = { 'xmlns:n2' => 'http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/encodedTypes',
+                                            'xsi:type' => 'n2:Transaction'
+                                          }
+
+      POST_HEADERS = { 'soapAction' => "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/SendAndCommit",
+                       'Content-Type' => 'text/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.homepage_url = 'http://www.e-xact.com'
+      self.display_name = 'E-xact'
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+
+        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 credit(money, authorization, options = {})
+        ActiveMerchant.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
+
+      private
+      def build_request(action, body)
+        xml = Builder::XmlMarkup.new
+
+        xml.instruct!
+        xml.tag! 'env:Envelope', ENVELOPE_NAMESPACES do
+          xml.tag! 'env:Body' do
+            xml.tag! 'n1:SendAndCommit', SEND_AND_COMMIT_ATTRIBUTES do
+              xml.tag! 'SendAndCommitSource', SEND_AND_COMMIT_SOURCE_ATTRIBUTES do
+                add_credentials(xml)
+                add_transaction_type(xml, action)
+                xml << body
+              end
+            end
+          end
+        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
+
+        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]
+        xml.tag! 'Client_IP', options[:ip]
+        xml.tag! 'Client_Email', 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]
+      end
+
+      def expdate(credit_card)
+        "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
+      end
+
+      def commit(action, request)
+         response = parse(ssl_post(self.live_url, build_request(action, request), POST_HEADERS))
+
+         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]}"
+        else
+           ''
+        end
+      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]}" unless response[:bank_message].blank?
+          result
+        end
+      end
+
+      def parse(xml)
+        response = {}
+        xml = REXML::Document.new(xml)
+
+        if root = REXML::XPath.first(xml, "//types:TransactionResult")
+          parse_elements(response, root)
+        elsif root = REXML::XPath.first(xml, "//soap:Fault")
+          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/fat_zebra.rb

@@ -0,0 +1,173 @@
+require 'json'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class FatZebraGateway < Gateway
+      self.live_url    = "https://gateway.fatzebra.com.au/v1.0"
+      self.test_url = "https://gateway.sandbox.fatzebra.com.au/v1.0"
+
+      self.supported_countries = ['AU']
+      self.default_currency = 'AUD'
+      self.money_format = :cents
+      self.supported_cardtypes = [:visa, :master, :american_express, :jcb]
+
+      self.homepage_url = 'https://www.fatzebra.com.au/'
+      self.display_name = 'Fat Zebra'
+
+      # Setup a new instance of the gateway.
+      #
+      # The options hash should include :username and :token
+      # You can find your username and token at https://dashboard.fatzebra.com.au
+      # Under the Your Account section
+      def initialize(options = {})
+        requires!(options, :username, :token)
+        @username = options[:username]
+        @token    = options[:token]
+        super
+      end
+
+      # To create a purchase on a credit card use:
+      #
+      #   purchase(money, creditcard)
+      #
+      # To charge a tokenized card
+      #
+      #   purchase(money, "abzy87u", :cvv => "123")
+      def purchase(money, creditcard, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard, options)
+        post[:reference] = options[:order_id]
+        post[:customer_ip] = options[:ip]
+
+        commit(:post, 'purchases', post)
+      end
+
+      # Refund a transaction
+      #
+      # amount - Integer - the amount to refund
+      # txn_id - String - the original transaction to be refunded
+      # reference - String - your transaction reference
+      def refund(money, txn_id, reference)
+        post = {}
+
+        post[:amount] = money
+        post[:transaction_id] = txn_id
+        post[:reference] = reference
+
+        commit(:post, "refunds", post)
+      end
+
+      # Tokenize a credit card
+      #
+      # The token is returned in the Response#authorization
+      def store(creditcard)
+        post = {}
+        add_creditcard(post, creditcard)
+
+        commit(:post, "credit_cards", post)
+      end
+
+      private
+
+      # Add the money details to the request
+      def add_amount(post, money, options)
+        post[:amount] = money
+      end
+
+      # Add the credit card details to the request
+      def add_creditcard(post, creditcard, options = {})
+        if creditcard.respond_to?(:number)
+          post[:card_number] = creditcard.number
+          post[:card_expiry] = "#{creditcard.month}/#{creditcard.year}"
+          post[:cvv] = creditcard.verification_value if creditcard.verification_value?
+          post[:card_holder] = creditcard.name if creditcard.name
+        elsif creditcard.is_a?(String)
+          post[:card_token] = creditcard
+          post[:cvv] = options[:cvv]
+        elsif creditcard.is_a?(Hash)
+          ActiveMerchant.deprecated "Passing the credit card as a Hash is deprecated. Use a String and put the (optional) CVV in the options hash instead."
+          post[:card_token] = creditcard[:token]
+          post[:cvv] = creditcard[:cvv]
+        else
+          raise ArgumentError.new("Unknown credit card format #{creditcard.inspect}")
+        end
+      end
+
+      # Post the data to the gateway
+      def commit(method, uri, parameters=nil)
+        response = begin
+          parse(ssl_request(method, get_url(uri), parameters.to_json, headers))
+        rescue ResponseError => e
+          return Response.new(false, "Invalid Login") if(e.response.code == "401")
+          parse(e.response.body)
+        end
+
+        success = success_from(response)
+        Response.new(
+          success,
+          message_from(response),
+          response,
+          :test => response["test"],
+          :authorization => authorization_from(response, success)
+        )
+      end
+
+      def success_from(response)
+        (
+          response["successful"] &&
+          response["response"] &&
+          (response["response"]["successful"] || response["response"]["token"])
+        )
+      end
+
+      def authorization_from(response, success)
+        if success
+          (response["response"]["id"] || response["response"]["token"])
+        else
+          nil
+        end
+      end
+
+      def message_from(response)
+        if !response["errors"].empty?
+          response["errors"].join(", ")
+        elsif response["response"]["message"]
+          response["response"]["message"]
+        else
+          "Unknown Error"
+        end
+      end
+
+      # Parse the returned JSON, if parse errors are raised then return a detailed error.
+      def parse(response)
+        begin
+          JSON.parse(response)
+        rescue JSON::ParserError
+          msg = 'Invalid JSON response received from Fat Zebra. Please contact support@fatzebra.com.au if you continue to receive this message.'
+          msg += "  (The raw response returned by the API was #{response.inspect})"
+          {
+            "successful" => false,
+            "response" => {},
+            "errors" => [msg]
+          }
+        end
+      end
+
+      # Build the URL based on the AM mode and the URI
+      def get_url(uri)
+        base = test? ? self.test_url : self.live_url
+        base + "/" + uri
+      end
+
+      # Builds the auth and U-A headers for the request
+      def headers
+        {
+          "Authorization" => "Basic " + Base64.strict_encode64(@username.to_s + ":" + @token.to_s).strip,
+          "User-Agent" => "Fat Zebra v1.0/ActiveMerchant #{ActiveMerchant::VERSION}"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class FederatedCanadaGateway < Gateway
+      # Same URL for both test and live, testing is done by using the test username (demo) and password (password).
+      self.live_url = self.test_url = 'https://secure.federatedgateway.com/api/transact.php'
+
+      APPROVED, DECLINED, ERROR = 1, 2, 3
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['CA']
+
+      self.default_currency = 'CAD'
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.federatedcanada.com/'
+
+      # The name of the gateway
+      self.display_name = 'Federated Canada'
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('sale', money, post)
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('auth', money, post)
+      end
+
+      def capture(money, authorization, options = {})
+        options[:transactionid] = authorization
+        commit('capture', money, options)
+      end
+
+      def void(authorization, options = {})
+        options[:transactionid] = authorization
+        commit('void', nil, options)
+      end
+
+      def refund(money, authorization, options = {})
+        commit('refund', money, options.merge(:transactionid => authorization))
+      end
+
+      def credit(money, authorization, options = {})
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      private
+
+      def add_customer_data(post, options)
+        post[:firstname] = options[:first_name]
+        post[:lastname] = options[:last_name]
+
+        post[:email] = options[:email]
+      end
+
+      def add_address(post, options)
+        if address = (options[:billing_address] || options[:address])
+          post[:company] = address[:company]
+          post[:address1] = address[:address1]
+          post[:address2] = address[:address2]
+          post[:city]    = address[:city]
+          post[:state]   = address[:state]
+          post[:zip]     = address[:zip]
+          post[:country] = address[:country]
+          post[:phone] = address[:phone]
+        end
+        if address = options[:shipping_address]
+          post[:shipping_firstname] = address[:first_name]
+          post[:shipping_lastname] = address[:last_name]
+          post[:shipping_company] = address[:company]
+          post[:shipping_address1] = address[:address1]
+          post[:shipping_address2] = address[:address2]
+          post[:shipping_city]    = address[:city]
+          post[:shipping_state]   = address[:state]
+          post[:shipping_zip]     = address[:zip]
+          post[:shipping_country] = address[:country]
+          post[:shipping_email]   = address[:email]
+        end
+      end
+
+      def add_invoice(post, options)
+        post[:orderid] = options[:order_id]
+        post[:orderdescription] = options[:description]
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:ccnumber] = creditcard.number
+        post[:ccexp] = expdate(creditcard)
+        post[:cvv] = creditcard.verification_value
+      end
+
+      def parse(body)
+        body.split('&').inject({}) do |memo, x|
+          k, v = x.split('=')
+          memo[k] = v
+          memo
+        end
+      end
+
+      def commit(action, money, parameters)
+        parameters[:amount] = amount(money)
+        data = ssl_post(self.live_url, post_data(action, parameters))
+        response = parse(data)
+        message = message_from(response)
+
+        Response.new(success?(response), message, response,
+          :test => test?,
+          :authorization => response['transactionid'],
+          :avs_result => {:code =>  response['avsresponse']},
+          :cvv_result => response['cvvresponse']
+        )
+      end
+
+      def success?(response)
+        response['response'] == '1'
+      end
+
+      def test?
+        (@options[:login].eql?('demo')) && (@options[:password].eql?('password'))
+      end
+
+      def message_from(response)
+        case response['response'].to_i
+        when APPROVED
+          "Transaction Approved"
+        when DECLINED
+          "Transaction Declined"
+        else
+          "Error in transaction data or system error"
+        end
+      end
+
+      def post_data(action, parameters = {})
+        parameters[:type] = action
+        parameters[:username] = @options[:login]
+        parameters[:password] = @options[:password]
+        parameters.map{|k, v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+      end
+    end
+  end
+end
+