aktivemerchant 2.0.0

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

@@ -0,0 +1,30 @@
+module ActiveMerchant
+  module Billing
+    module PaypalExpressCommon
+      def self.included(base)
+        if base.respond_to?(:class_attribute)
+          base.class_attribute :test_redirect_url
+          base.class_attribute :live_redirect_url
+        else
+          base.class_inheritable_accessor :test_redirect_url
+          base.class_inheritable_accessor :live_redirect_url
+        end
+        base.live_redirect_url = 'https://www.paypal.com/cgi-bin/webscr'
+      end
+      
+      def redirect_url
+        test? ? test_redirect_url : live_redirect_url
+      end
+      
+      def redirect_url_for(token, options = {})
+        options = {:review => true, :mobile => false}.update(options)
+
+        cmd  = options[:mobile] ? '_express-checkout-mobile' : '_express-checkout'
+        url  = "#{redirect_url}?cmd=#{cmd}&token=#{token}"
+        url += '&useraction=commit' unless options[:review]
+
+        url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,162 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayscoutGateway < Gateway
+      self.live_url = self.test_url = 'https://secure.payscout.com/api/transact.php'
+
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.default_currency = 'USD'
+      self.homepage_url = 'http://www.payscout.com/'
+      self.display_name = 'Payscout'
+
+      def initialize(options = {})
+        requires!(options, :username, :password)
+        super
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_currency(post, money, options)
+        add_address(post, options)
+
+        commit('auth', money, post)
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_currency(post, money, options)
+        add_address(post, options)
+
+        commit('sale', money, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        post[:transactionid] = authorization
+
+        commit('capture', money, post)
+      end
+
+
+      def refund(money, authorization, options = {})
+        post = {}
+        post[:transactionid] = authorization
+
+        commit('refund', money, post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        post[:transactionid] = authorization
+
+        commit('void', nil, post)
+      end
+
+      private
+
+      def add_address(post, options)
+        if address = options[:billing_address] || options[:address]
+          post[:address1] = address[:address1].to_s
+          post[:address2] = address[:address2].to_s
+          post[:city]     = address[:city].to_s
+          post[:state]    = (address[:state].blank?  ? 'n/a' : address[:state])
+          post[:zip]      = address[:zip].to_s
+          post[:country]  = address[:country].to_s
+          post[:phone]    = address[:phone].to_s
+          post[:fax]      = address[:fax].to_s
+          post[:email]    = address[:email].to_s
+        end
+
+        if address = options[:shipping_address]
+          post[:shipping_firstname] = address[:first_name].to_s
+          post[:shipping_lastname]  = address[:last_name].to_s
+          post[:shipping_company]   = address[:company].to_s
+          post[:shipping_address1]  = address[:address1].to_s
+          post[:shipping_address2]  = address[:address2].to_s
+          post[:shipping_city]      = address[:city].to_s
+          post[:shipping_country]   = address[:country].to_s
+          post[:shipping_state]     = (address[:state].blank?  ? 'n/a' : address[:state])
+          post[:shipping_zip]       = address[:zip].to_s
+          post[:shipping_email]     = address[:email].to_s
+        end
+      end
+
+      def add_currency(post, money, options)
+        post[:currency] = options[:currency] || currency(money)
+      end
+
+      def add_invoice(post, options)
+        post[:orderdescription] = options[:description]
+        post[:orderid]          = options[:order_id]
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:ccnumber]  = creditcard.number
+        post[:cvv]       = creditcard.verification_value if creditcard.verification_value?
+        post[:ccexp]     = expdate(creditcard)
+        post[:firstname] = creditcard.first_name
+        post[:lastname]  = creditcard.last_name
+      end
+
+      def parse(body)
+        Hash[body.split('&').map{|x|x.split('=')}]
+      end
+
+      def commit(action, money, parameters)
+        parameters[:amount] = amount(money) unless action == 'void'
+        url = (test? ? self.test_url : self.live_url)
+        data = ssl_post(url, post_data(action, parameters))
+
+        response          = parse(data)
+        response[:action] = action
+
+        message = message_from(response)
+        test_mode = (test? || message =~ /TESTMODE/)
+        Response.new(success?(response), message, response,
+          :test => test_mode,
+          :authorization => response['transactionid'],
+          :fraud_review => fraud_review?(response),
+          :avs_result => { :code => response['avsresponse'] },
+          :cvv_result => response['cvvresponse']
+        )
+      end
+
+      def message_from(response)
+        case response['response']
+        when '1'
+          'The transaction has been approved'
+        when '2'
+          'The transaction has been declined'
+        when '3'
+          response['responsetext']
+        else
+          'There was an error processing the transaction'
+        end
+      end
+
+      def fraud_review?(response)
+        false
+      end
+
+      def success?(response)
+        (response['response'] == '1')
+      end
+
+      def post_data(action, parameters = {})
+        post = {}
+
+        post[:username]       = @options[:username]
+        post[:password]       = @options[:password]
+        post[:type]           = action
+
+        request = post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        request
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,199 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PaystationGateway < Gateway
+
+      self.live_url = self.test_url = "https://www.paystation.co.nz/direct/paystation.dll"
+
+      # an "error code" of "0" means "No error - transaction successful"
+      SUCCESSFUL_RESPONSE_CODE = '0'
+
+      # an "error code" of "34" means "Future Payment Stored OK"
+      SUCCESSFUL_FUTURE_PAYMENT = '34'
+
+      # TODO: check this with paystation
+      self.supported_countries = ['NZ']
+
+      # TODO: check this with paystation (amex and diners need to be enabled)
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club ]
+
+      self.homepage_url        = 'http://paystation.co.nz'
+      self.display_name        = 'Paystation'
+
+      self.default_currency    = 'NZD'
+      self.money_format        = :cents
+
+      def initialize(options = {})
+        requires!(options, :paystation_id, :gateway_id)
+        super
+      end
+
+      def authorize(money, credit_card, options = {})
+        post = new_request
+
+        add_invoice(post, options)
+        add_amount(post, money, options)
+
+        add_credit_card(post, credit_card)
+
+        add_authorize_flag(post, options)
+
+        commit(post)
+      end
+
+      def capture(money, authorization_token, options = {})
+        post = new_request
+
+        add_invoice(post, options)
+        add_amount(post, money, options)
+
+        add_authorization_token(post, authorization_token, options[:credit_card_verification])
+
+        commit(post)
+      end
+
+      def purchase(money, payment_source, options = {})
+        post = new_request
+
+        add_invoice(post, options)
+        add_amount(post, money, options)
+
+        if payment_source.is_a?(String)
+          add_token(post, payment_source)
+        else
+          add_credit_card(post, payment_source)
+        end
+
+        add_customer_data(post, options) if options.has_key?(:customer)
+
+        commit(post)
+      end
+
+      def store(credit_card, options = {})
+        post = new_request
+
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        store_credit_card(post, options)
+
+        commit(post)
+      end
+
+      private
+
+        def new_request
+          {
+            :pi    => @options[:paystation_id], # paystation account id
+            :gi    => @options[:gateway_id],    # paystation gateway id
+            "2p"   => "t",                      # two-party transaction type
+            :nr    => "t",                      # -- redirect??
+            :df    => "yymm"                    # date format: optional sometimes, required others
+          }
+        end
+
+        def add_customer_data(post, options)
+          post[:mc] = options[:customer]
+        end
+
+        def add_invoice(post, options)
+          requires!(options, :order_id)
+
+          post[:ms] = options[:order_id]     # "Merchant Session", must be unique per request
+          post[:mo] = options[:invoice]      # "Order Details", displayed in Paystation Admin
+          post[:mr] = options[:description]  # "Merchant Reference Code", seen from Paystation Admin
+        end
+
+        def add_credit_card(post, credit_card)
+
+          post[:cn] = credit_card.number
+          post[:ct] = credit_card.brand
+          post[:ex] = format_date(credit_card.month, credit_card.year)
+          post[:cc] = credit_card.verification_value if credit_card.verification_value?
+
+        end
+
+        # bill a token (stored via "store") rather than a Credit Card
+        def add_token(post, token)
+          post[:fp] = "t"    # turn on "future payments" - what paystation calls Token Billing
+          post[:ft] = token
+        end
+
+        def store_credit_card(post, options)
+
+          post[:fp] = "t"                                # turn on "future payments" - what paystation calls Token Billing
+          post[:fs] = "t"                                # tells paystation to store right now, not bill
+          post[:ft] = options[:token] if options[:token] # specify a token to use that, or let Paystation generate one
+
+        end
+
+        def add_authorize_flag(post, options)
+          post[:pa] = "t" # tells Paystation that this is a pre-auth authorisation payment (account must be in pre-auth mode)
+        end
+
+        def add_authorization_token(post, auth_token, verification_value = nil)
+          post[:cp] = "t" # Capture Payment flag – tells Paystation this transaction should be treated as a capture payment
+          post[:cx] = auth_token
+          post[:cc] = verification_value
+        end
+
+        def add_amount(post, money, options)
+
+          post[:am] = amount(money)
+          post[:cu] = options[:currency] || currency(money)
+
+        end
+
+        def parse(xml_response)
+          response = {}
+
+          xml = REXML::Document.new(xml_response)
+
+          # for normal payments, the root node is <Response>
+          # for "future payments", it's <PaystationFuturePaymentResponse>
+          xml.elements.each("#{xml.root.name}/*") do |element|
+            response[element.name.underscore.to_sym] = element.text
+          end
+
+          response
+        end
+
+        def commit(post)
+
+          post[:tm] = "T" if test? # test mode
+
+          pstn_prefix_params = post.collect { |key, value| "pstn_#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+
+          # need include paystation param as "initiator flag for payment engine"
+          data     = ssl_post(self.live_url, "#{pstn_prefix_params}&paystation=_empty")
+          response = parse(data)
+          message  = message_from(response)
+
+          PaystationResponse.new(success?(response), message, response,
+              :test          => (response[:tm] && response[:tm].downcase == "t"),
+              :authorization => response[:paystation_transaction_id]
+          )
+        end
+
+        def success?(response)
+          (response[:ec] == SUCCESSFUL_RESPONSE_CODE) || (response[:ec] == SUCCESSFUL_FUTURE_PAYMENT)
+        end
+
+        def message_from(response)
+          response[:em]
+        end
+
+        def format_date(month, year)
+          "#{format(year, :two_digits)}#{format(month, :two_digits)}"
+        end
+
+    end
+
+    class PaystationResponse < Response
+      # add a method to response so we can easily get the token
+      # for Validate transactions
+      def token
+        @params["future_payment_token"]
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,207 @@
+module ActiveMerchant
+  module Billing
+    class PaywayGateway < Gateway
+      self.live_url = self.test_url = 'https://ccapi.client.qvalent.com/payway/ccapi'
+
+      self.supported_countries = [ 'AU' ]
+      self.supported_cardtypes = [ :visa, :master, :diners_club, :american_express, :bankcard ]
+      self.display_name        = 'Pay Way'
+      self.homepage_url        = 'http://www.payway.com.au'
+      self.default_currency    = 'AUD'
+      self.money_format        = :cents
+
+      SUMMARY_CODES = {
+        '0' => 'Approved',
+        '1' => 'Declined',
+        '2' => 'Erred',
+        '3' => 'Rejected'
+      }
+
+      RESPONSE_CODES= {
+        '00' => 'Completed Successfully',
+        '01' => 'Refer to card issuer',
+        '03' => 'Invalid merchant',
+        '04' => 'Pick-up card',
+        '05' => 'Do not honour',
+        '08' => 'Honour only with identification',
+        '12' => 'Invalid transaction',
+        '13' => 'Invalid amount',
+        '14' => 'Invalid card number (no such number)',
+        '30' => 'Format error',
+        '36' => 'Restricted card',
+        '41' => 'Lost card',
+        '42' => 'No universal card',
+        '43' => 'Stolen card',
+        '51' => 'Not sufficient funds',
+        '54' => 'Expired card',
+        '61' => 'Exceeds withdrawal amount limits',
+        '62' => 'Restricted card',
+        '65' => 'Exceeds withdrawal frequency limit',
+        '91' => 'Issuer or switch is inoperative',
+        '92' => 'Financial institution or intermediate network facility cannot be found for routing',
+        '94' => 'Duplicate transmission',
+        'Q1' => 'Unknown Buyer',
+        'Q2' => 'Transaction Pending',
+        'Q3' => 'Payment Gateway Connection Error',
+        'Q4' => 'Payment Gateway Unavailable',
+        'Q5' => 'Invalid Transaction',
+        'Q6' => 'Duplicate Transaction - requery to determine status',
+        'QA' => 'Invalid parameters or Initialisation failed',
+        'QB' => 'Order type not currently supported',
+        'QC' => 'Invalid Order Type',
+        'QD' => 'Invalid Payment Amount - Payment amount less than minimum/exceeds maximum allowed limit',
+        'QE' => 'Internal Error',
+        'QF' => 'Transaction Failed',
+        'QG' => 'Unknown Customer Order Number',
+        'QH' => 'Unknown Customer Username or Password',
+        'QI' => 'Transaction incomplete - contact Westpac to confirm reconciliation',
+        'QJ' => 'Invalid Client Certificate',
+        'QK' => 'Unknown Customer Merchant',
+        'QL' => 'Business Group not configured for customer',
+        'QM' => 'Payment Instrument not configured for customer',
+        'QN' => 'Configuration Error',
+        'QO' => 'Missing Payment Instrument',
+        'QP' => 'Missing Supplier Account',
+        'QQ' => 'Invalid Credit Card Verification Number',
+        'QR' => 'Transaction Retry',
+        'QS' => 'Transaction Successful',
+        'QT' => 'Invalid currency',
+        'QU' => 'Unknown Customer IP Address',
+        'QV' => 'Invalid Original Order Number specified for Refund, Refund amount exceeds capture amount, or Previous capture was not approved',
+        'QW' => 'Invalid Reference Number',
+        'QX' => 'Network Error has occurred',
+        'QY' => 'Card Type Not Accepted',
+        'QZ' => 'Zero value transaction'
+      }
+
+      TRANSACTIONS  = {
+        :authorize  => 'preauth',
+        :purchase   => 'capture',
+        :capture    => 'captureWithoutAuth',
+        :status     => 'query',
+        :refund     => 'refund',
+        :store      => 'registerAccount'
+      }
+
+      def initialize(options={})
+        @options = options
+
+        @options[:merchant] ||= 'TEST' if test?
+        requires!(options, :username, :password, :merchant, :pem)
+
+        @options[:eci] ||= 'SSL'
+      end
+
+      def authorize(amount, payment_method, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_payment_method(post, payment_method)
+        add_order(post, amount, options)
+        commit(:authorize, post)
+      end
+
+      def capture(amount, authorization, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_reference(post, authorization)
+        add_order(post, amount, options)
+        commit(:capture, post)
+      end
+
+      def purchase(amount, payment_method, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_payment_method(post, payment_method)
+        add_order(post, amount, options)
+        commit(:purchase, post)
+      end
+
+      def refund(amount, authorization, options={})
+        requires!(options, :order_id)
+
+        post = {}
+        add_reference(post, authorization)
+        add_order(post, amount, options)
+        commit(:refund, post)
+      end
+
+      def store(credit_card, options={})
+        requires!(options, :billing_id)
+
+        post = {}
+        add_payment_method(post, credit_card)
+        add_payment_method(post, options[:billing_id])
+        commit(:store, post)
+      end
+
+      def status(options={})
+        requires!(options, :order_id)
+
+        commit(:status, 'customer.orderNumber' => options[:order_id])
+      end
+
+      private
+
+      def add_payment_method(post, payment_method)
+        if payment_method.respond_to?(:number)
+          post['card.cardHolderName'] = "#{payment_method.first_name} #{payment_method.last_name}"
+          post['card.PAN']            = payment_method.number
+          post['card.CVN']            = payment_method.verification_value
+          post['card.expiryYear']     = payment_method.year.to_s[-2,2]
+          post['card.expiryMonth']    = sprintf('%02d', payment_method.month)
+        else
+          post['customer.customerReferenceNumber'] = payment_method
+        end
+      end
+
+      def add_reference(post, reference)
+        post['customer.originalOrderNumber'] = reference
+      end
+
+      def add_order(post, amount, options)
+        post['order.ECI']            = @options[:eci]
+        post['order.amount']         = amount
+        post['card.currency']        = (options[:currency] || currency(amount))
+        post['customer.orderNumber'] = options[:order_id][0...20]
+      end
+
+      def add_auth(post)
+        post['customer.username'] = @options[:username]
+        post['customer.password'] = @options[:password]
+        post['customer.merchant'] = @options[:merchant]
+      end
+
+      # Creates the request and returns the summarized result
+      def commit(action, post)
+        add_auth(post)
+        post.merge!('order.type' => TRANSACTIONS[action])
+
+        request = post.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
+        response = ssl_post(self.live_url, request)
+
+        params = {}
+        CGI.parse(response).each_pair do |key, value|
+          actual_key = key.split(".").last
+          params[actual_key.underscore.to_sym] = value[0]
+        end
+
+        message = "#{SUMMARY_CODES[params[:summary_code]]} - #{RESPONSE_CODES[params[:response_code]]}"
+
+        success = (params[:summary_code] ? (params[:summary_code] == "0") : (params[:response_code] == "00"))
+
+        Response.new(success, message, params,
+          :test => (@options[:merchant].to_s == "TEST"),
+          :authorization => post[:order_number]
+        )
+      rescue ActiveMerchant::ResponseError => e
+        raise unless e.response.code == '403'
+        return Response.new(false, "Invalid credentials", {}, :test => test?)
+      rescue ActiveMerchant::ClientCertificateError
+        return Response.new(false, "Invalid certificate", {}, :test => test?)
+      end
+    end
+  end
+end