tanga_activemerchant 1.37.0

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

@@ -0,0 +1,297 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class OptimalPaymentGateway < Gateway
+      self.test_url = 'https://webservices.test.optimalpayments.com/creditcardWS/CreditCardServlet/v1'
+      self.live_url = 'https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['CA', 'US', 'GB']
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :solo] # :switch?
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.optimalpayments.com/'
+
+      # The name of the gateway
+      self.display_name = 'Optimal Payments'
+
+      def initialize(options = {})
+        #requires!(options, :login, :password)
+        super
+      end
+
+      def authorize(money, card_or_auth, options = {})
+        parse_card_or_auth(card_or_auth, options)
+        commit("cc#{@stored_data}Authorize", money, options)
+      end
+      alias stored_authorize authorize # back-compat
+
+      def purchase(money, card_or_auth, options = {})
+        parse_card_or_auth(card_or_auth, options)
+        commit("cc#{@stored_data}Purchase", money, options)
+      end
+      alias stored_purchase purchase # back-compat
+
+      def refund(money, authorization, options = {})
+        options[:confirmationNumber] = authorization
+        commit('ccCredit', money, options)
+      end
+
+      def void(authorization, options = {})
+        options[:confirmationNumber] = authorization
+        commit('ccAuthorizeReversal', nil, options)
+      end
+
+      def capture(money, authorization, options = {})
+        options[:confirmationNumber] = authorization
+        commit('ccSettlement', money, options)
+      end
+
+      private
+
+      def parse_card_or_auth(card_or_auth, options)
+        if card_or_auth.respond_to?(:number)
+          @credit_card = card_or_auth
+          @stored_data = ""
+        else
+          options[:confirmationNumber] = card_or_auth
+          @stored_data = "StoredData"
+        end
+      end
+
+      def parse(body)
+        REXML::Document.new(body || '')
+      end
+
+      def commit(action, money, post)
+        post[:order_id] ||= 'order_id'
+
+        xml = case action
+        when 'ccAuthorize', 'ccPurchase', 'ccVerification'
+          cc_auth_request(money, post)
+        when 'ccCredit', 'ccSettlement'
+          cc_post_auth_request(money, post)
+        when 'ccStoredDataAuthorize', 'ccStoredDataPurchase'
+          cc_stored_data_request(money, post)
+        when 'ccAuthorizeReversal'
+          cc_auth_reversal_request(post)
+        #when 'ccCancelSettle', 'ccCancelCredit', 'ccCancelPayment'
+        #  cc_cancel_request(money, post)
+        #when 'ccPayment'
+        #  cc_payment_request(money, post)
+        #when 'ccAuthenticate'
+        #  cc_authenticate_request(money, post)
+        else
+          raise 'Unknown Action'
+        end
+        txnRequest = URI.encode(xml)
+        response = parse(ssl_post(test? ? self.test_url : self.live_url, "txnMode=#{action}&txnRequest=#{txnRequest}"))
+
+        Response.new(successful?(response), message_from(response), hash_from_xml(response),
+          :test          => test?,
+          :authorization => authorization_from(response),
+          :avs_result => { :code => avs_result_from(response) },
+          :cvv_result => cvv_result_from(response)
+        )
+      end
+
+      def successful?(response)
+        REXML::XPath.first(response, '//decision').text == 'ACCEPTED' rescue false
+      end
+
+      def message_from(response)
+        REXML::XPath.each(response, '//detail') do |detail|
+          if detail.is_a?(REXML::Element) && detail.elements['tag'].text == 'InternalResponseDescription'
+            return detail.elements['value'].text
+          end
+        end
+        nil
+      end
+
+      def authorization_from(response)
+        get_text_from_document(response, '//confirmationNumber')
+      end
+
+      def avs_result_from(response)
+        get_text_from_document(response, '//avsResponse')
+      end
+
+      def cvv_result_from(response)
+        get_text_from_document(response, '//cvdResponse')
+      end
+
+      def hash_from_xml(response)
+        hsh = {}
+        %w(confirmationNumber authCode
+           decision code description
+           actionCode avsResponse cvdResponse
+           txnTime duplicateFound
+        ).each do |tag|
+          node = REXML::XPath.first(response, "//#{tag}")
+          hsh[tag] = node.text if node
+        end
+        REXML::XPath.each(response, '//detail') do |detail|
+          next unless detail.is_a?(REXML::Element)
+          tag = detail.elements['tag'].text
+          value = detail.elements['value'].text
+          hsh[tag] = value
+        end
+        hsh
+      end
+
+      def xml_document(root_tag)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag!(root_tag, schema) do
+          yield xml
+        end
+        xml.target!
+      end
+
+      def get_text_from_document(document, node)
+        node = REXML::XPath.first(document, node)
+        node && node.text
+      end
+
+      def cc_auth_request(money, opts)
+        xml_document('ccAuthRequestV1') do |xml|
+          build_merchant_account(xml, @options)
+          xml.merchantRefNum opts[:order_id]
+          xml.amount(money/100.0)
+          build_card(xml, opts)
+          build_billing_details(xml, opts)
+          build_shipping_details(xml, opts)
+        end
+      end
+
+      def cc_auth_reversal_request(opts)
+        xml_document('ccAuthReversalRequestV1') do |xml|
+          build_merchant_account(xml, @options)
+          xml.confirmationNumber opts[:confirmationNumber]
+          xml.merchantRefNum opts[:order_id]
+        end
+      end
+
+      def cc_post_auth_request(money, opts)
+        xml_document('ccPostAuthRequestV1') do |xml|
+          build_merchant_account(xml, @options)
+          xml.confirmationNumber opts[:confirmationNumber]
+          xml.merchantRefNum opts[:order_id]
+          xml.amount(money/100.0)
+        end
+      end
+
+      def cc_stored_data_request(money, opts)
+        xml_document('ccStoredDataRequestV1') do |xml|
+          build_merchant_account(xml, @options)
+          xml.merchantRefNum opts[:order_id]
+          xml.confirmationNumber opts[:confirmationNumber]
+          xml.amount(money/100.0)
+        end
+      end
+
+      # untested
+      #
+      # def cc_cancel_request(opts)
+      #   xml_document('ccCancelRequestV1') do |xml|
+      #     build_merchant_account(xml, @options)
+      #     xml.confirmationNumber opts[:confirmationNumber]
+      #   end
+      # end
+      #
+      # def cc_payment_request(money, opts)
+      #   xml_document('ccPaymentRequestV1') do |xml|
+      #     build_merchant_account(xml, @options)
+      #     xml.merchantRefNum opts[:order_id]
+      #     xml.amount(money/100.0)
+      #     build_card(xml, opts)
+      #     build_billing_details(xml, opts)
+      #   end
+      # end
+      #
+      # def cc_authenticate_request(opts)
+      #   xml_document('ccAuthenticateRequestV1') do |xml|
+      #     build_merchant_account(xml, @options)
+      #     xml.confirmationNumber opts[:confirmationNumber]
+      #     xml.paymentResponse 'myPaymentResponse'
+      #   end
+      # end
+
+      def schema
+        { 'xmlns' => 'http://www.optimalpayments.com/creditcard/xmlschema/v1',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://www.optimalpayments.com/creditcard/xmlschema/v1'
+        }
+      end
+
+      def build_merchant_account(xml, opts)
+        xml.tag! 'merchantAccount' do
+          xml.tag! 'accountNum' , opts[:account]
+          xml.tag! 'storeID'    , opts[:login]
+          xml.tag! 'storePwd'   , opts[:password]
+        end
+      end
+
+      def build_card(xml, opts)
+        xml.tag! 'card' do
+          xml.tag! 'cardNum'      , @credit_card.number
+          xml.tag! 'cardExpiry' do
+            xml.tag! 'month'      , @credit_card.month
+            xml.tag! 'year'       , @credit_card.year
+          end
+          if brand = card_type(@credit_card.brand)
+            xml.tag! 'cardType'     , brand
+          end
+          if @credit_card.verification_value
+            xml.tag! 'cvdIndicator' , '1' # Value Provided
+            xml.tag! 'cvd'          , @credit_card.verification_value
+          end
+        end
+      end
+
+      def build_billing_details(xml, opts)
+        xml.tag! 'billingDetails' do
+          xml.tag! 'cardPayMethod', 'WEB'
+          build_address(xml, opts[:billing_address], opts[:email])
+        end
+      end
+
+      def build_shipping_details(xml, opts)
+        xml.tag! 'shippingDetails' do
+          build_address(xml, opts[:shipping_address], opts[:email])
+        end if opts[:shipping_address].present?
+      end
+
+      def build_address(xml, addr, email=nil)
+        if addr[:name]
+          xml.tag! 'firstName', CGI.escape(addr[:name].split(' ').first) # TODO: parse properly
+          xml.tag! 'lastName' , CGI.escape(addr[:name].split(' ').last )
+        end
+        xml.tag! 'street' , CGI.escape(addr[:address1]) if addr[:address1].present?
+        xml.tag! 'street2', CGI.escape(addr[:address2]) if addr[:address2].present?
+        xml.tag! 'city'   , CGI.escape(addr[:city]    ) if addr[:city].present?
+        if addr[:state].present?
+          state_tag = %w(US CA).include?(addr[:country]) ? 'state' : 'region'
+          xml.tag! state_tag, CGI.escape(addr[:state])
+        end
+        xml.tag! 'country', CGI.escape(addr[:country] ) if addr[:country].present?
+        xml.tag! 'zip'    , CGI.escape(addr[:zip]     ) if addr[:zip].present?
+        xml.tag! 'phone'  , CGI.escape(addr[:phone]   ) if addr[:phone].present?
+        xml.tag! 'email', CGI.escape(email) if email
+      end
+
+      def card_type(key)
+        { 'visa'            => 'VI',
+          'master'          => 'MC',
+          'american_express'=> 'AM',
+          'discover'        => 'DI',
+          'diners_club'     => 'DC',
+          #'switch'          => '',
+          'solo'            => 'SO'
+        }[key]
+      end
+
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/orbital/avs_result.rb

@@ -0,0 +1,93 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class OrbitalGateway < Gateway
+      # Unfortunately, Orbital uses their own special codes for AVS responses
+      # that are different than the standard codes defined in
+      # <tt>ActiveMerchant::Billing::AVSResult</tt>.
+      #
+      # This class encapsulates the response codes shown on page 240 of their spec:
+      # http://download.chasepaymentech.com/docs/orbital/orbital_gateway_xml_specification.pdf
+      #
+      class AVSResult < ActiveMerchant::Billing::AVSResult
+        CODES = {
+            '1'  => 'No address supplied',
+            '2'  => 'Bill-to address did not pass Auth Host edit checks',
+            '3'  => 'AVS not performed',
+            '4'  => 'Issuer does not participate in AVS',
+            '5'  => 'Edit-error - AVS data is invalid',
+            '6'  => 'System unavailable or time-out',
+            '7'  => 'Address information unavailable',
+            '8'  => 'Transaction Ineligible for AVS',
+            '9'  => 'Zip Match/Zip 4 Match/Locale match',
+            'A'  => 'Zip Match/Zip 4 Match/Locale no match',
+            'B'  => 'Zip Match/Zip 4 no Match/Locale match',
+            'C'  => 'Zip Match/Zip 4 no Match/Locale no match',
+            'D'  => 'Zip No Match/Zip 4 Match/Locale match',
+            'E'  => 'Zip No Match/Zip 4 Match/Locale no match',
+            'F'  => 'Zip No Match/Zip 4 No Match/Locale match',
+            'G'  => 'No match at all',
+            'H'  => 'Zip Match/Locale match',
+            'J'  => 'Issuer does not participate in Global AVS',
+            'JA' => 'International street address and postal match',
+            'JB' => 'International street address match. Postal code not verified',
+            'JC' => 'International street address and postal code not verified',
+            'JD' => 'International postal code match. Street address not verified',
+            'M1' => 'Merchant Override Decline',
+            'M2' => 'Cardholder name, billing address, and postal code matches',
+            'M3' => 'Cardholder name and billing code matches',
+            'M4' => 'Cardholder name and billing address matches',
+            'M5' => 'Cardholder name incorrect, billing address and postal code match',
+            'M6' => 'Cardholder name incorrect, billing address matches',
+            'M7' => 'Cardholder name incorrect, billing address matches',
+            'M8' => 'Cardholder name, billing address and postal code are all incorrect',
+            'N3' => 'Address matches, ZIP not verified',
+            'N4' => 'Address and ZIP code not verified due to incompatible formats',
+            'N5' => 'Address and ZIP code match (International only)',
+            'N6' => 'Address not verified (International only)',
+            'N7' => 'ZIP matches, address not verified',
+            'N8' => 'Address and ZIP code match (International only)',
+            'N9' => 'Address and ZIP code match (UK only)',
+            'R'  => 'Issuer does not participate in AVS',
+            'UX' => 'Unknown',
+            'X'  => 'Zip Match/Zip 4 Match/Address Match',
+            'Z'  => 'Zip Match/Locale no match',
+        }
+
+        # Map vendor's AVS result code to a postal match code
+        ORBITAL_POSTAL_MATCH_CODE = {
+            'Y' => %w( 9 A B C H JA JD M2 M3 M5 N5 N8 N9 X Z ),
+            'N' => %w( D E F G M8 ),
+            'X' => %w( 4 J R ),
+            nil => %w( 1 2 3 5 6 7 8 JB JC M1 M4 M6 M7 N3 N4 N6 N7 UX )
+        }.inject({}) do |map, (type, codes)|
+          codes.each { |code| map[code] = type }
+          map
+        end
+
+        # Map vendor's AVS result code to a street match code
+        ORBITAL_STREET_MATCH_CODE = {
+            'Y' => %w( 9 B D F H JA JB M2 M4 M5 M6 M7 N3 N5 N7 N8 N9 X ),
+            'N' => %w( A C E G M8 Z ),
+            'X' => %w( 4 J R ),
+            nil => %w( 1 2 3 5 6 7 8 JC JD M1 M3 N4 N6 UX )
+        }.inject({}) do |map, (type, codes)|
+          codes.each { |code| map[code] = type }
+          map
+        end
+
+        def self.messages
+          CODES
+        end
+
+        def initialize(code)
+          @code = code.to_s.strip.upcase unless code.blank?
+          if @code
+            @message      = CODES[@code]
+            @postal_match = ORBITAL_POSTAL_MATCH_CODE[@code]
+            @street_match = ORBITAL_STREET_MATCH_CODE[@code]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/orbital/orbital_soft_descriptors.rb

@@ -0,0 +1,46 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class OrbitalSoftDescriptors
+      include Validateable
+      
+      PHONE_FORMAT_1 = /\A\d{3}-\d{3}-\d{4}\z/
+      PHONE_FORMAT_2 = /\A\d{3}-\w{7}\z/
+      
+      # ==== Tampa PNS Soft Descriptors
+      # The support for Soft Descriptors via the PNS Host is only for customers processing through Chase 
+      # Paymentech Canada. 
+
+      # Unlike Salem, the only value that gets passed on the cardholder statement is the Merchant Name field.  
+      # And for these customers, it is a maximum of 25 bytes of data. 
+      # 
+      # All other Soft Descriptor fields can optionally be sent, but will not be submitted to the settlement host 
+      # and will not display on the cardholder statement.
+      
+      attr_accessor :merchant_name, :product_description, :merchant_city, :merchant_phone, :merchant_url, :merchant_email
+      
+      def initialize(options = {})
+        self.merchant_name = options[:merchant_name]
+        self.merchant_city = options[:merchant_city]
+        self.merchant_phone = options[:merchant_phone]
+        self.merchant_url = options[:merchant_url]
+        self.merchant_email = options[:merchant_email]
+      end
+      
+      def validate
+        errors.add(:merchant_name, "is required") if self.merchant_name.blank?
+        errors.add(:merchant_name, "is required to be 25 bytes or less") if self.merchant_name.bytesize > 25
+        
+        unless self.merchant_phone.blank? || self.merchant_phone.match(PHONE_FORMAT_1) || self.merchant_phone.match(PHONE_FORMAT_2)
+          errors.add(:merchant_phone, "is required to follow \"NNN-NNN-NNNN\" or \"NNN-AAAAAAA\" format")
+        end
+        
+        [:merchant_email, :merchant_url].each do |attr|
+          unless self.send(attr).blank?
+            errors.add(attr, "is required to be 13 bytes or less") if self.send(attr).bytesize > 13
+          end
+        end
+      end
+      
+    end
+  end
+end