tanga_activemerchant 1.37.0

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

@@ -0,0 +1,261 @@
+require 'digest/md5'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # This gateway accepts the following arguments:
+    #   :login    => your PayJunction username
+    #   :password => your PayJunction pass
+    # Example use:
+    #
+    #   gateway = ActiveMerchant::Billing::Base.gateway(:pay_gate_xml).new(
+    #               :login => "my_account",
+    #               :password => "my_pass"
+    #            )
+    #
+    #   # set up credit card obj as in main ActiveMerchant example
+    #   creditcard = ActiveMerchant::Billing::CreditCard.new(
+    #     :type       => 'visa',
+    #     :number     => '4242424242424242',
+    #     :month      => 8,
+    #     :year       => 2009,
+    #     :first_name => 'Bob',
+    #     :last_name  => 'Bobsen'
+    #   )
+    #
+    #   # run request
+    #   response = gateway.purchase(1000, creditcard) # charge 10 dollars
+    #
+    # 1) Check whether the transaction was successful
+    #
+    #   response.success?
+    #
+    # 2) Retrieve the message returned by PayJunction
+    #
+    #   response.message
+    #
+    # 3) Retrieve the unique transaction ID returned by PayGateXML
+    #
+    #   response.authorization
+    #
+    # This gateway has many other features which are not implemented here yet
+    # The basic setup here only supports auth/capture transactions.
+    #
+    # Test Transactions
+    #
+    # PayGateXML has a global test user/pass, but you can also sign up for your own.
+    # The class and the test come equipped with the global test creds
+    #
+    # Usage Details
+    #
+    # Below is a map of only SOME of the values accepted by PayGateXML and how you should submit
+    # each to ActiveMerchant
+    #
+    # PayGateXML Field        ActiveMerchant Use
+    #
+    # pgid                    use :login value to gateway instantation
+    # pwd                     use :password value to gateway instantiation
+    #
+    # cname                   credit_card.name
+    # cc                      credit_card.number
+    # exp                     credit_card values formatted to YYYYMMDD
+    # budp                    South Africa only - set to 0 if purchase is not on budget
+    # amt                     include as argument to method for your transaction type
+    # ver                     do nothing, always set to current API version
+    #
+    # cref                    provide as :invoice in options, varchar(80)
+    # cur                     3 char field, currently only ZAR
+    # cvv                     credit_card.verification
+    # bno                     batch processing number, i.e. you supply this
+    #
+    # others -- not used in this implementation
+    # nurl, rurl - must remain blank or absent or they will use an alternative authentication mechanism
+    # email, ip  - must remain blank or absent or they will use a PayGate extra service call PayProtector
+    # threed     - must remain blank unless you are using your own 3D Secure server
+    #
+    class PayGateXmlGateway < Gateway
+      self.live_url = 'https://www.paygate.co.za/payxml/process.trans'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['US', 'ZA']
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://paygate.co.za/'
+
+      # The name of the gateway
+      self.display_name = 'PayGate PayXML'
+
+      # PayGate only supports Rands
+      self.default_currency = 'ZAR'
+
+      # PayGate accepts only lowest denomination
+      self.money_format = :cents
+
+      # PayGateXML public test account - you can get a private one too
+      TEST_ID_3DSECURE  = '10011013800'
+      TEST_ID           = '10011021600'
+      TEST_PWD          = 'test'
+
+      API_VERSION = '4.0'
+
+      DECLINE_CODES = {
+        # Credit Card Errors - These RESULT_CODEs are returned if the transaction cannot be authorized due to a problem with the card.  The TRANSACTION_STATUS will be 2
+        900001  => "Call for Approval",
+        900002  => "Card Expired",
+        900003  => "Insufficient Funds",
+        900004  => "Invalid Card Number",
+        900005  => "Bank Interface Timeout",  # indicates a communications failure between the banks systems
+        900006  => "Invalid Card",
+        900007  => "Declined",
+        900009  => "Lost Card",
+        900010  => "Invalid Card Length",
+        900011  => "Suspected Fraud",
+        900012  => "Card Reported As Stolen",
+        900013  => "Restricted Card",
+        900014  => "Excessive Card Usage",
+        900015  => "Card Blacklisted",
+
+        900207  => "Declined; authentication failed",  # indicates the cardholder did not enter their MasterCard SecureCode / Verified by Visa password correctly
+
+        990020  => "Auth Declined",
+
+        991001  => "Invalid expiry date",
+        991002  => "Invalid amount",
+
+        # Communication Errors - These RESULT_CODEs are returned if the transaction cannot be completed due to an unexpected error.  TRANSACTION_STATUS will be 0.
+        900205  => "Unexpected authentication result (phase 1)",
+        900206  => "Unexpected authentication result (phase 1)",
+
+        990001  => "Could not insert into Database",
+
+        990022  => "Bank not available",
+
+        990053  => "Error processing transaction",
+
+        # Miscellaneous - Unless otherwise noted, the TRANSACTION_STATUS will be 0.
+        900209  => "Transaction verification failed (phase 2)",  # Indicates the verification data returned from MasterCard SecureCode / Verified by Visa has been altered
+        900210  => "Authentication complete; transaction must be restarted",  # Indicates that the MasterCard SecuerCode / Verified by Visa transaction has already been completed.  Most likely caused by the customer clicking the refresh button
+
+        990024  => "Duplicate Transaction Detected.  Please check before submitting",
+
+        990028  => "Transaction cancelled"  # Customer clicks the 'Cancel' button on the payment page
+      }
+
+      SUCCESS_CODES = %w( 990004 990005 990017 990012 990018 990031 )
+
+      TRANSACTION_CODES = {
+        0 => 'Not Done',
+        1 => 'Approved',
+        2 => 'Declined',
+        3 => 'Paid',
+        4 => 'Refunded',
+        5 => 'Received by PayGate',
+        6 => 'Replied to Client'
+      }
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      def purchase(money, creditcard, options = {})
+        MultiResponse.run do |r|
+          r.process{authorize(money, creditcard, options)}
+          r.process{capture(money, r.authorization, options)}
+        end
+      end
+
+      def authorize(money, creditcard, options = {})
+        action = 'authtx'
+
+        options.merge!(:money => money, :creditcard => creditcard)
+        commit(action, build_request(action, options))
+      end
+
+      def capture(money, authorization, options = {})
+        action = 'settletx'
+
+        options.merge!(:money => money, :authorization => authorization)
+        commit(action, build_request(action, options))
+      end
+
+      private
+
+      def successful?(response)
+        SUCCESS_CODES.include?(response[:res])
+      end
+
+      def build_request(action, options={})
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+
+        xml.tag! 'protocol', :ver => API_VERSION, :pgid => (test? ? TEST_ID : @options[:login]), :pwd => @options[:password] do |protocol|
+          case action
+            when 'authtx'
+              money       = options.delete(:money)
+              creditcard  = options.delete(:creditcard)
+              build_authorization(protocol, money, creditcard, options)
+            when 'settletx'
+              money           = options.delete(:money)
+              authorization   = options.delete(:authorization)
+              build_capture(protocol, money, authorization, options)
+          else
+            raise "no action specified for build_request"
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_authorization(xml, money, creditcard, options={})
+        xml.tag! 'authtx', {
+          :cref  => options[:order_id],
+          :cname => creditcard.name,
+          :cc    => creditcard.number,
+          :exp   => "#{format(creditcard.month, :two_digits)}#{format(creditcard.year, :four_digits)}",
+          :budp  => 0,
+          :amt   => amount(money),
+          :cur   => (options[:currency] || currency(money)),
+          :cvv   => creditcard.verification_value
+        }
+      end
+
+      def build_capture(xml, money, authorization, options={})
+        xml.tag! 'settletx', {
+          :tid => authorization
+        }
+      end
+
+      def parse(action, body)
+        hash  = {}
+        xml   = REXML::Document.new(body)
+
+        response_action = action.gsub(/tx/, 'rx')
+        root  = REXML::XPath.first(xml.root, response_action)
+        # we might have gotten an error
+        if root.nil?
+          root  = REXML::XPath.first(xml.root, 'errorrx')
+        end
+        root.attributes.each do |name, value|
+          hash[name.to_sym] = value
+        end
+        hash
+      end
+
+      def commit(action, request)
+        response = parse(action, ssl_post(self.live_url, request))
+        Response.new(successful?(response), message_from(response), response,
+          :test           => test?,
+          :authorization  => response[:tid]
+        )
+      end
+
+      def message_from(response)
+        (response[:rdesc] || response[:edesc])
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,396 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # PayJunction Gateway
+    #
+    # This gateway accepts the following arguments:
+    #   :login    => your PayJunction username
+    #   :password => your PayJunction pass
+    #
+    # Example use:
+    #
+    #   gateway = ActiveMerchant::Billing::Base.gateway(:pay_junction).new(
+    #               :login => "my_account",
+    #               :password => "my_pass"
+    #            )
+    #
+    #   # set up credit card obj as in main ActiveMerchant example
+    #   creditcard = ActiveMerchant::Billing::CreditCard.new(
+    #     :type       => 'visa',
+    #     :number     => '4242424242424242',
+    #     :month      => 8,
+    #     :year       => 2009,
+    #     :first_name => 'Bob',
+    #     :last_name  => 'Bobsen'
+    #   )
+    #
+    #   # optionally specify address if using AVS
+    #   address = { :address1 => '101 Test Ave', :city => 'Test', :state => 'TS',
+    #               :zip  => '10101', :country => 'US' }
+    #
+    #   # run request
+    #   response = gateway.purchase(1000, creditcard, :address => address) # charge 10 dollars
+    #
+    # 1) Check whether the transaction was successful
+    #
+    #   response.success?
+    #
+    # 2) Retrieve the message returned by PayJunction
+    #
+    #   response.message
+    #
+    # 3) Retrieve the unique transaction ID returned by PayJunction
+    #
+    #   response.authorization
+    #
+    # This gateway supports "instant" transactions. These transactions allow you
+    # to execute an operation on a previously run card without card information
+    # provided you have the transaction id from a previous transaction with the
+    # same card. All functions that take a credit card object for this gateway
+    # can take a transaction id string instead.
+    #
+    # Test Transactions
+    #
+    # See the source for initialize() for test account information. Note that
+    # PayJunction does not allow test transactions on your account, so if the
+    # gateway is running in :test mode your transaction will be run against
+    # PayJunction's global test account and will not show up in your account.
+    #
+    # Transactions ran on this account go through a test processor, so there is no
+    # need to void or otherwise cancel transactions. However, for further safety,
+    # please use the special card numbers 4433221111223344 or 4444333322221111 and
+    # keep transaction amounts below $4.00 when testing.
+    #
+    # Also note, transactions ran for an amount between $0.00 and $1.99 will likely
+    # result in denial. To demonstrate approvals, use amounts between $2.00 and $4.00.
+    #
+    # Test transactions can be checked by logging into
+    # PayJunction Web Login with username 'pj-cm-01' and password 'pj-cm-01p'
+    #
+    # Usage Details
+    #
+    # Below is a map of values accepted by PayJunction and how you should submit
+    # each to ActiveMerchant
+    #
+    # PayJunction Field       ActiveMerchant Use
+    #
+    # dc_logon                provide as :login value to gateway instantation
+    # dc_password             provide as :password value to gateway instantiation
+    #
+    # dc_name                 will be retrieved from credit_card.name
+    # dc_first_name           :first_name on CreditCard object instantation
+    # dc_last_name            :last_name  on CreditCard object instantation
+    # dc_number               :number     on CreditCard object instantation
+    # dc_expiration_month     :month      on CreditCard object instantation
+    # dc_expiration_year      :year       on CreditCard object instantation
+    # dc_verification_number  :verification_value on CC object instantation
+    #
+    # dc_transaction_amount   include as argument to method for your transaction type
+    # dc_transaction_type     do nothing, set by your transaction type
+    # dc_version              do nothing, always "1.2"
+    #
+    # dc_transaction_id       submit as a string in place of CreditCard obj for
+    #                         "instant" transactions.
+    #
+    # dc_invoice              :order_id in options for transaction method
+    # dc_notes                :description in options for transaction method
+    #
+    # See example use above for address AVS fields
+    # See #recurring for periodic transaction fields
+    class PayJunctionGateway < Gateway
+      API_VERSION   = '1.2'
+
+      class_attribute :test_url, :live_url
+
+      self.test_url = "https://www.payjunctionlabs.com/quick_link"
+      self.live_url = "https://payjunction.com/quick_link"
+
+      TEST_LOGIN = 'pj-ql-01'
+      TEST_PASSWORD = 'pj-ql-01p'
+
+      SUCCESS_CODES = ["00", "85"]
+      SUCCESS_MESSAGE = 'The transaction was approved.'
+
+      FAILURE_MESSAGE = 'The transaction was declined.'
+
+      DECLINE_CODES = {
+        "AE"  => 'Address verification failed because address did not match.',
+        'ZE'  => 'Address verification failed because zip did not match.',
+        'XE'  => 'Address verification failed because zip and address did not match.',
+        'YE'  => 'Address verification failed because zip and address did not match.',
+        'OE'  => 'Address verification failed because address or zip did not match.',
+        'UE'  => 'Address verification failed because cardholder address unavailable.',
+        'RE'  => 'Address verification failed because address verification system is not working.',
+        'SE'  => 'Address verification failed because address verification system is unavailable.',
+        'EE'  => 'Address verification failed because transaction is not a mail or phone order.',
+        'GE'  => 'Address verification failed because international support is unavailable.',
+        'CE'  => 'Declined because CVV2/CVC2 code did not match.',
+        '04'  => 'Declined. Pick up card.',
+        '07'  => 'Declined. Pick up card (Special Condition).',
+        '41'  => 'Declined. Pick up card (Lost).',
+        '43'  => 'Declined. Pick up card (Stolen).',
+        '13'  => 'Declined because of the amount is invalid.',
+        '14'  => 'Declined because the card number is invalid.',
+        '80'  => 'Declined because of an invalid date.',
+        '05'  => 'Declined. Do not honor.',
+        '51'  => 'Declined because of insufficient funds.',
+        'N4'  => 'Declined because the amount exceeds issuer withdrawal limit.',
+        '61'  => 'Declined because the amount exceeds withdrawal limit.',
+        '62'  => 'Declined because of an invalid service code (restricted).',
+        '65'  => 'Declined because the card activity limit exceeded.',
+        '93'  => 'Declined because there a violation (the transaction could not be completed).',
+        '06'  => 'Declined because address verification failed.',
+        '54'  => 'Declined because the card has expired.',
+        '15'  => 'Declined because there is no such issuer.',
+        '96'  => 'Declined because of a system error.',
+        'N7'  => 'Declined because of a CVV2/CVC2 mismatch.',
+        'M4'  => 'Declined.',
+        "FE"  => "There was a format error with your Trinity Gateway Service (API) request.",
+        "LE"  => "Could not log you in (problem with dc_logon and/or dc_password).",
+        'NL'  => 'Aborted because of a system error, please try again later. ',
+        'AB'  => 'Aborted because of an upstream system error, please try again later.'
+      }
+
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_countries = ['US']
+      self.homepage_url = 'http://www.payjunction.com/'
+      self.display_name = 'PayJunction'
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      # The first half of the preauth(authorize)/postauth(capture) model.
+      # Checks to make sure funds are available for a transaction, and returns a
+      # transaction_id that can be used later to postauthorize (capture) the funds.
+      def authorize(money, payment_source, options = {})
+        parameters = {
+          :transaction_amount => amount(money),
+        }
+
+        add_payment_source(parameters, payment_source)
+        add_address(parameters, options)
+        add_optional_fields(parameters, options)
+        commit('AUTHORIZATION', parameters)
+      end
+
+      # A simple sale, capturing funds immediately.
+      # Execute authorization and capture in a single step.
+      def purchase(money, payment_source, options = {})
+        parameters = {
+          :transaction_amount => amount(money),
+        }
+
+        add_payment_source(parameters, payment_source)
+        add_address(parameters, options)
+        add_optional_fields(parameters, options)
+        commit('AUTHORIZATION_CAPTURE', parameters)
+      end
+
+      # The second half of the preauth(authorize)/postauth(capture) model.
+      # Retrieve funds that have been previously authorized with _authorization_
+      def capture(money, authorization, options = {})
+        parameters = {
+          :transaction_id => authorization,
+          :posture => 'capture'
+        }
+
+        add_optional_fields(parameters, options)
+        commit('update', parameters)
+      end
+
+      # Return money to a card that was previously billed.
+      # _authorization_ should be the transaction id of the transaction we are returning.
+      def refund(money, authorization, options = {})
+        parameters = {
+          :transaction_amount => amount(money),
+          :transaction_id => authorization
+        }
+
+        commit('CREDIT', parameters)
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      # Cancel a transaction that has been charged but has not yet made it
+      # through the batch process.
+      def void(authorization, options = {})
+        parameters = {
+          :transaction_id => authorization,
+          :posture => 'void'
+        }
+
+        add_optional_fields(parameters, options)
+        commit('update', parameters)
+      end
+
+      # Set up a sale that will be made on a regular basis for the same amount
+      # (ex. $20 a month for 12 months)
+      #
+      # The parameter :periodicity should be specified as either :monthly, :weekly, or :daily
+      # The parameter :payments should be the number of payments to be made
+      #
+      #   gateway.recurring('2000', creditcard, :periodicity => :monthly, :payments => 12)
+      #
+      # The optional parameter :starting_at takes a date or time argument or a string in
+      # YYYYMMDD format and can be used to specify when the first charge will be made.
+      # If omitted the first charge will be immediate.
+      def recurring(money, payment_source, options = {})
+        requires!(options, [:periodicity, :monthly, :weekly, :daily], :payments)
+
+        periodic_type = case options[:periodicity]
+        when :monthly
+          'month'
+        when :weekly
+          'week'
+        when :daily
+          'day'
+        end
+
+        if options[:starting_at].nil?
+          start_date = Time.now.strftime('%Y-%m-%d')
+        elsif options[:starting_at].is_a?(String)
+          sa = options[:starting_at]
+          start_date = "#{sa[0..3]}-#{sa[4..5]}-#{sa[6..7]}"
+        else
+          start_date = options[:starting_at].strftime('%Y-%m-%d')
+        end
+
+        parameters = {
+          :transaction_amount => amount(money),
+          :schedule_periodic_type => periodic_type,
+          :schedule_create => 'true',
+          :schedule_limit => options[:payments].to_i > 1 ? options[:payments] : 1,
+          :schedule_periodic_number => 1,
+          :schedule_start => start_date
+        }
+
+        add_payment_source(parameters, payment_source)
+        add_optional_fields(parameters, options)
+        add_address(parameters, options)
+        commit('AUTHORIZATION_CAPTURE', parameters)
+      end
+
+      def test?
+        (test_login? || super)
+      end
+
+      private
+
+      def test_login?
+        @options[:login] == TEST_LOGIN && @options[:password] == TEST_PASSWORD
+      end
+
+      # add fields depending on payment source selected (cc or transaction id)
+      def add_payment_source(params, source)
+        if source.is_a?(String)
+          add_billing_id(params, source)
+        else
+          add_creditcard(params, source)
+        end
+      end
+
+      # add fields for credit card
+      def add_creditcard(params, creditcard)
+        params[:name]                 = creditcard.name
+        params[:number]               = creditcard.number
+        params[:expiration_month]     = creditcard.month
+        params[:expiration_year]      = creditcard.year
+        params[:verification_number]  = creditcard.verification_value if creditcard.verification_value?
+      end
+
+      # add field for "instant" transaction, using previous transaction id
+      def add_billing_id(params, billingid)
+        params[:transaction_id] = billingid
+      end
+
+      # add address fields if present
+      def add_address(params, options)
+        address = options[:billing_address] || options[:address]
+
+        if address
+          params[:address]  = address[:address1] unless address[:address1].blank?
+          params[:city]      = address[:city]     unless address[:city].blank?
+          params[:state]     = address[:state]    unless address[:state].blank?
+          params[:zipcode]   = address[:zip]      unless address[:zip].blank?
+          params[:country]   = address[:country]  unless address[:country].blank?
+        end
+      end
+
+      def add_optional_fields(params, options)
+        params[:notes] = options[:description] unless options[:description].blank?
+        params[:invoice] = options[:order_id].to_s.gsub(/[^-\/\w.,']/, '') unless options[:order_id].blank?
+      end
+
+      def commit(action, parameters)
+        url = test? ? self.test_url : self.live_url
+
+        response = parse( ssl_post(url, post_data(action, parameters)) )
+
+        Response.new(successful?(response), message_from(response), response,
+          :test => test?,
+          :authorization => response[:transaction_id] || parameters[:transaction_id]
+        )
+      end
+
+      def successful?(response)
+        SUCCESS_CODES.include?(response[:response_code]) || response[:query_status] == true
+      end
+
+      def message_from(response)
+        if successful?(response)
+          SUCCESS_MESSAGE
+        else
+          DECLINE_CODES[response[:response_code]] || FAILURE_MESSAGE
+        end
+      end
+
+      def post_data(action, params)
+        if test?
+          # test requests must use global test account
+          params[:logon]      = TEST_LOGIN
+          params[:password]   = TEST_PASSWORD
+        else
+          params[:logon]      = @options[:login]
+          params[:password]   = @options[:password]
+        end
+        params[:version] = API_VERSION
+        params[:transaction_type] = action
+
+        params.reject{|k,v| v.blank?}.collect{ |k, v| "dc_#{k.to_s}=#{CGI.escape(v.to_s)}" }.join("&")
+      end
+
+      def parse(body)
+        # PayJunction uses the Field Separator ASCII character to separate key/val
+        # pairs in the response. The <FS> character's octal value is 034.
+        #
+        # Sample response:
+        #
+        # transaction_id=44752<FS>response_code=M4<FS>response_message=Declined (INV TEST CARD).
+
+        pairs = body.chomp.split("\034")
+        response = {}
+        pairs.each do |pair|
+          key, val = pair.split('=')
+          response[key[3..-1].to_sym] = val ? normalize(val) : nil
+        end
+        response
+      end
+
+      # Make a ruby type out of the response string
+      def normalize(field)
+        case field
+        when "true"   then true
+        when "false"  then false
+        when ""       then nil
+        when "null"   then nil
+        else field
+        end
+      end
+
+    end
+  end
+end