activemerchant 1.1.0 → 1.2.0

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

@@ -0,0 +1,285 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ProtxGateway < Gateway  
+      cattr_accessor :simulate
+      self.simulate = false
+      
+      TEST_URL = 'https://ukvpstest.protx.com/vspgateway/service'
+      LIVE_URL = 'https://ukvps.protx.com/vspgateway/service'
+      SIMULATOR_URL = 'https://ukvpstest.protx.com/VSPSimulator'
+    
+      APPROVED = 'OK'
+    
+      TRANSACTIONS = {
+        :purchase => 'PAYMENT',
+        :credit => 'REFUND',
+        :authorization => 'DEFERRED',
+        :capture => 'RELEASE',
+        :void => 'VOID'
+      }
+      
+      CREDIT_CARDS = {
+        :visa => "VISA",
+        :master => "MC",
+        :delta => "DELTA",
+        :solo => "SOLO",
+        :maestro => "MAESTRO",
+        :american_express => "AMEX",
+        :electron => "UKE",
+        :diners_club => "DC",
+        :jcb => "JCB"
+      }
+      
+      ELECTRON = /^(424519|42496[23]|450875|48440[6-8]|4844[1-5][1-5]|4917[3-5][0-9]|491880)\d{10}(\d{3})?$/
+      
+      POST_HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      attr_reader :url
+      attr_reader :response
+      attr_reader :options
+
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :solo, :maestro, :diners_club]
+      self.supported_countries = ['GB']
+      self.default_currency = 'GBP'
+      
+      self.homepage_url = 'http://www.protx.com'
+      self.display_name = 'Protx'
+
+      def initialize(options = {})
+        requires!(options, :login)
+        @options = options
+        super
+      end
+      
+      def test?
+        @options[:test] || Base.gateway_mode == :test
+      end
+      
+      def purchase(money, credit_card, options = {})
+        requires!(options, :order_id)
+        
+        post = {}
+        
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+
+        commit(:purchase, post)
+      end
+      
+      def authorize(money, credit_card, options = {})
+        requires!(options, :order_id)
+        
+        post = {}
+        
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+
+        commit(:authorization, post)
+      end
+      
+      # Only supports capturing the original amount of the transaction
+      def capture(money, identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        commit(:capture, post)
+      end
+      
+      def void(identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        commit(:void, post)
+      end
+      
+      # Crediting requires a new order_id to passed in, as well as a description
+      def credit(money, identification, options = {})
+        requires!(options, :order_id, :description)
+        
+        post = {}
+        
+        add_credit_reference(post, identification)
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        
+        commit(:credit, post)
+      end
+      
+      private
+      def add_reference(post, identification)
+        order_id, transaction_id, authorization, security_key = identification.split(';') 
+        
+        add_pair(post, :VendorTxCode, order_id)
+        add_pair(post, :VPSTxId, transaction_id)
+        add_pair(post, :TxAuthNo, authorization)
+        add_pair(post, :SecurityKey, security_key)
+      end
+      
+      def add_credit_reference(post, identification)
+        order_id, transaction_id, authorization, security_key = identification.split(';') 
+        
+        add_pair(post, :RelatedVendorTxCode, order_id)
+        add_pair(post, :RelatedVPSTxId, transaction_id)
+        add_pair(post, :RelatedTxAuthNo, authorization)
+        add_pair(post, :RelatedSecurityKey, security_key)
+      end
+      
+      def add_amount(post, money, options)
+        add_pair(post, :Amount, amount(money), :required => true)
+        add_pair(post, :Currency, options[:currency] || currency(money), :required => true)
+      end
+
+      def add_customer_data(post, options)
+        add_pair(post, :BillingEmail, options[:email])
+        add_pair(post, :ContactNumber, options[:phone])
+        add_pair(post, :ContactFax, options[:fax])
+        add_pair(post, :ClientIPAddress, options[:ip])
+      end
+
+      def add_address(post, options)
+        address = options[:billing_address] || options[:address]
+        shipping_address = options[:shipping_address] || ''
+        
+        return if address.blank?
+
+        billing = "#{address[:address1]}\n#{address[:address2]}\n#{address[:city]}\n#{address[:state]}"
+
+        add_pair(post, :BillingAddress, billing)
+        add_pair(post, :BillingPostcode, address[:zip])
+
+        return if shipping_address.blank?
+
+        shipping = "#{shipping_address[:address1]}\n#{shipping_address[:address2]}\n#{shipping_address[:city]}\n#{shipping_address[:state]}"
+
+        add_pair(post, :DeliveryAddress, shipping)
+        add_pair(post, :DeliveryPostcode, shipping_address[:zip])
+      end
+
+      def add_invoice(post, options)
+        add_pair(post, :VendorTxCode, sanitize_order_id(options[:order_id]), :required => true)
+        add_pair(post, :Description, options[:description] || options[:order_id])
+      end
+
+      def add_credit_card(post, credit_card)
+        add_pair(post, :CardHolder, credit_card.name, :required => true)
+        add_pair(post, :CardNumber, credit_card.number, :required => true)
+         
+        add_pair(post, :ExpiryDate, format_expiry_date(credit_card), :required => true)
+         
+        if requires_start_date_or_issue_number?(credit_card)
+          add_pair(post, :StartDate, format(credit_card.start_year, :four_digits))
+          
+          add_pair(post, :IssueNumber, format_issue_number(credit_card))
+        end
+        add_pair(post, :CardType, map_card_type(credit_card))
+        
+        add_pair(post, :CV2, credit_card.verification_value)
+      end
+      
+      def sanitize_order_id(order_id)
+        order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
+      end
+      
+      def map_card_type(credit_card)
+        raise ArgumentError, "The credit card type must be provided" if credit_card.type.blank?
+        
+        card_type = credit_card.type.to_sym
+        
+        # Check if it is an electron card
+        if card_type == :visa && credit_card.number =~ ELECTRON 
+          CREDIT_CARDS[:electron]
+        else  
+          CREDIT_CARDS[card_type]
+        end
+      end
+      
+      # MMYY format
+      def format_expiry_date(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+      
+      def format_issue_number(credit_card)
+        credit_card.type.to_s == 'solo' ? format(credit_card.issue_number, :two_digits) : credit_card.issue_number
+      end
+
+      def commit(action, parameters)
+        if result = test_result_from_cc_number(parameters[:CardNumber])
+          return result
+        end
+        
+        data = ssl_post(build_endpoint_url(action), post_data(action, parameters), POST_HEADERS)
+         
+        @response = parse(data)
+          
+        success = @response["Status"] == APPROVED
+        message = message_from(@response)
+        
+        authorization = [ parameters[:VendorTxCode],
+                          @response["VPSTxId"],
+                          @response["TxAuthNo"],
+                          @response["SecurityKey"] ].compact.join(";")
+
+        Response.new(success, message, @response,
+          :test => test?,
+          :authorization => authorization
+        )
+      end
+      
+      def build_endpoint_url(action)
+        simulate ? build_simulator_url(action) : build_url(action)
+      end
+      
+      def build_url(action)
+        endpoint = [ :purchase, :authorization ].include?(action) ? "vspdirect-register" : TRANSACTIONS[action].downcase
+        "#{test? ? TEST_URL : LIVE_URL}/#{endpoint}.vsp"
+      end
+      
+      def build_simulator_url(action)
+        endpoint = [ :purchase, :authorization ].include?(action) ? "VSPDirectGateway.asp" : "VSPServerGateway.asp?Service=Vendor#{TRANSACTIONS[action].capitalize}Tx"
+        "#{SIMULATOR_URL}/#{endpoint}"
+      end
+
+      def message_from(results)
+        if response["Status"] == APPROVED
+          return 'Success'
+        else
+          return 'Unspecified error' if response["StatusDetail"].blank?
+          return response["StatusDetail"]
+        end
+      end
+
+      def post_data(action, parameters = {})
+        parameters.update(
+          :Vendor => @options[:login],
+          :TxType => TRANSACTIONS[action],
+          :VPSProtocol => "2.22"
+        )
+        
+        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+      
+      # Protx returns data in the following format
+      # Key1=value1
+      # Key2=value2
+      def parse(body)
+        result = {}
+        body.to_a.collect {|v| c=v.split('='); result[c[0]] = c[1].chomp if !c[1].blank? }
+        result
+      end
+
+      def add_pair(post, key, value, options = {})
+        post[key] = value if !value.blank? || options[:required]
+      end
+    end
+  end
+end
+

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

@@ -7,19 +7,19 @@
 #  
 #  Usage for a PreAuth (authorize) is as follows:
 #  
-#  twenty = Money.ca_dollar(2000)
-#  gateway = PsigateGateway.new({
+#  twenty = 2000
+#  gateway = PsigateGateway.new(
 #    :store_id => 'teststore',
-#    :password => 'psigate1234',
-#  })
+#    :password => 'psigate1234'
+#  )
 #  
-#  creditcard = CreditCard.new({
+#  creditcard = CreditCard.new(
 #    :number => '4242424242424242',
 #    :month => 8,
 #    :year => 2006,
 #    :first_name => 'Longbob',
 #    :last_name => 'Longsen'
-#  })
+#  )
 #  response = @gateway.authorize(twenty, creditcard, {:order_id =>  1234,
 #     :billing_address => {
 #  	  :address1 => '123 fairweather Lane',
@@ -46,6 +46,12 @@ module ActiveMerchant #:nodoc:
       TEST_URL  = 'https://dev.psigate.com:7989/Messenger/XMLMessenger'
       LIVE_URL  = 'https://secure.psigate.com:7934/Messenger/XMLMessenger'
       
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.supported_countries = ['CA']
+      self.homepage_url = 'http://www.psigate.com/'
+      self.display_name = 'Psigate'
+      
+      
       def initialize(options = {})
         requires!(options, :login, :password)
       
@@ -85,12 +91,7 @@ module ActiveMerchant #:nodoc:
         options.update({ :CardAction => "3", :order_id => authorization })
         commit(money, nil, options)
       end
- 
-      # We support visa and master card
-      def self.supported_cardtypes
-        [:visa, :master]
-      end
-         
+
       private                       
     
       def commit(money, creditcard, options = {}) 

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

@@ -0,0 +1,297 @@
+# Author::    MoneySpyder, http://moneyspyder.co.uk
+
+module ActiveMerchant
+  module Billing
+    #
+    # ActiveMerchant PSL Card Gateway
+    # 
+    # Notes:
+    #   -To be able to use the capture function, the IP address of the machine must be
+    #    registered with PSL
+    #   -ESALE_KEYED should only be used in situations where the cardholder perceives the 
+    #    transaction to be Internet-based, such as purchasing from a web site/on-line store.  
+    #    If the Internet is used purely for the transport of information from the merchant 
+    #    directly to the gateway then the appropriate cardholder present or not present message 
+    #    type should be used rather than the ‘E’ equivalent.
+    #   -The CV2 / AVS policies are set up with the account settings when signing up for an account
+    #   
+    #
+    class PslCardGateway < Gateway
+      self.money_format = :cents
+      self.default_currency = 'GBP'
+      
+      self.supported_countries = ['GB']
+      # Visa Credit, Visa Debit, Mastercard, Maestro, Solo, Electron,
+      # American Express, Diners Club, JCB, International Maestro,
+      # Style, Clydesdale Financial Services, Other
+         
+      self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :jcb, :switch, :solo, :maestro ]
+      self.homepage_url = 'http://www.paymentsolutionsltd.com/'
+      self.display_name = 'PSL Payment Solutions'
+      
+      # Default ISO 3166 country code (GB)
+      cattr_accessor :location
+      self.location = 826
+      
+      # PslCard server URL - The url is the same whether testing or live - use
+      # the test account when testing...
+      URL = 'https://pslcard3.paymentsolutionsltd.com/secure/transact.asp?'
+      
+      attr_reader :url 
+      attr_reader :response
+      attr_reader :options
+      
+      # eCommerce sale transaction, details keyed by merchant or cardholder
+      MESSAGE_TYPE = 'ESALE_KEYED' 
+      
+      # The type of response that we want to get from PSL, options are HTML, XML or REDIRECT
+      RESPONSE_ACTION = 'HTML'
+      
+      # Currency Codes
+      CURRENCY_CODES = {
+        'AUD' => 036,
+        'GBP' => 826,
+        'USD' => 840
+      }
+      
+      #The terminal used - only for swipe transactions, so hard coded to 32 for online
+      EMV_TERMINAL_TYPE = 32
+      
+      #Different Dispatch types
+      DISPATCH_LATER  = 'LATER'
+      DISPATCH_NOW    = 'NOW'
+      
+      # Return codes
+      APPROVED = '00'
+      
+      #Nominal amount to authorize for a 'dispatch later' type
+      #The nominal amount is held straight away, when the goods are ready
+      #to be dispatched, PSL is informed and the full amount is the
+      #taken.
+      NOMINAL_AMOUNT = 101
+      
+      # Create a new PslCardGateway
+      # 
+      # The gateway requires that a valid :login be passed in the options hash
+      # 
+      # Paramaters:
+      #   -options:
+      #     :login -    the PslCard account login (required)
+      def initialize(options = {})
+        requires!(options, :login)
+              
+        @options = options
+        super
+      end
+
+      # Purchase the item straight away
+      # 
+      # Parameters:
+      #   -money: Money object for the total to be charged
+      #   -authorization: the PSL cross reference from the previous authorization
+      #   -options:
+      #
+      # Returns:
+      #   -ActiveRecord::Billing::Response object
+      #   
+      def purchase(money, credit_card, options = {})
+        post = {}
+        
+        add_amount(post, money, DISPATCH_NOW, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_invoice(post, options)
+        add_purchase_details(post)
+        
+        commit(post)
+      end
+      
+      # Authorize the transaction
+      # 
+      # Reserves the funds on the customer's credit card, but does not 
+      # charge the card.
+      #
+      # This implementation does not authorize the full amount, rather it checks that the full amount
+      # is available and only 'reserves' the nominal amount (currently a pound and a penny)
+      # 
+      # Parameters:
+      #   -money: Money object for the total to be charged
+      #   -authorization: the PSL cross reference from the previous authorization
+      #   -options:
+      #
+      # Returns:
+      #   -ActiveRecord::Billing::Response object
+      #   
+      def authorize(money, credit_card, options = {})
+        post = {}
+      
+        add_amount(post, money, DISPATCH_LATER, options)
+        add_credit_card(post, credit_card)
+        add_address(post, options)
+        add_invoice(post, options)
+        add_purchase_details(post)
+              
+        commit(post)
+      end
+      
+      # Post an authorization. 
+      #
+      # Captures the funds from an authorized transaction. 
+      # 
+      # Parameters:
+      #   -money: Money object for the total to be charged
+      #   -authorization: The PSL Cross Reference
+      #   -options:
+      #
+      # Returns:
+      #   -ActiveRecord::Billing::Response object
+      #
+      def capture(money, authorization, options = {})
+        post = {}
+      
+        add_amount(post, money, DISPATCH_NOW, options)
+        add_reference(post, authorization)
+
+        commit(post)
+      end
+
+      private
+    
+      def add_credit_card(post, credit_card)
+        post[:QAName] = credit_card.name
+        post[:CardNumber] = credit_card.number
+        post[:EMVTerminalType] = EMV_TERMINAL_TYPE
+        post[:ExpMonth] = credit_card.month
+        post[:ExpYear] = credit_card.year
+        post[:IssueNumber] = credit_card.issue_number unless credit_card.issue_number.blank?
+        post[:StartMonth] = credit_card.start_month unless credit_card.start_month.blank?
+        post[:StartYear] = credit_card.start_year unless credit_card.start_year.blank?
+        
+        # CV2 check
+        post[:AVSCV2Check] = credit_card.verification_value? ? 'YES' : 'NO'
+        post[:CV2] = credit_card.verification_value if credit_card.verification_value?
+      end
+      
+      def add_address(post, options)
+        address = options[:billing_address] || options[:address]
+        return if address.nil?
+      
+        post[:QAAddress] = [:address1, :address2, :city, :state].collect{|a| address[a]}.reject{|a| a.blank?}.join(' ')
+        post[:QAPostcode] = address[:zip]
+      end
+        
+      def add_invoice(post, options)
+        post[:MerchantName] = options[:merchant] || 'Merchant Name' # May use this as the order_id field
+        post[:OrderID] = options[:order_id] unless options[:order_id].blank?
+      end
+    
+      def add_reference(post, authorization)
+        post[:CrossReference] = authorization
+      end
+      
+      def add_amount(post, money, dispatch_type, options)
+        post[:CurrencyCode] = currency_code(options[:currency] || currency(money))
+        
+        if dispatch_type == DISPATCH_LATER
+          post[:amount] = amount(NOMINAL_AMOUNT)
+          post[:DispatchLaterAmount] = amount(money)
+        else
+          post[:amount] = amount(money)
+        end
+        
+        post[:Dispatch] = dispatch_type
+      end
+      
+      def add_purchase_details(post)
+        post[:EchoAmount] = 'YES'
+        post[:SCBI] = 'YES'                   # Return information about the transaction
+        post[:MessageType] = MESSAGE_TYPE
+      end
+    
+      # Get the currency code for the passed money object
+      # 
+      # The money class stores the currency as an ISO 4217:2001 Alphanumeric,
+      # however PSL requires the ISO 4217:2001 Numeric code.
+      # 
+      # Parameters:
+      #   -money: Money object with the amount and currency
+      #   
+      # Returns:
+      #   -the ISO 4217:2001 Numberic currency code
+      #   
+      def currency_code(currency)
+        CURRENCY_CODES[currency]
+      end
+      
+      # Parse the PSL response and create a Response object
+      #
+      # Parameters:
+      #   -body:  The response string returned from PSL, Formatted:
+      #           Key=value&key=value...
+      # 
+      # Returns:
+      #   -a hash with all of the values returned in the PSL response
+      #
+      def parse(body)
+
+        fields = {}
+        for line in body.split('&')
+          key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+          fields[key] = CGI.unescape(value)
+        end
+        fields.symbolize_keys
+      end
+      
+      # Send the passed data to PSL for processing
+      #
+      # Parameters:
+      #   -request: The data that is to be sent to PSL
+      #
+      # Returns:
+      #   - ActiveMerchant::Billing::Response object
+      #
+      def commit(request)
+        if result = test_result_from_cc_number(request[:CardNumber])
+          return result
+        end
+        
+        result = ssl_post(URL, post_data(request))
+        
+        @response = parse(result)
+        
+        success = @response[:ResponseCode] == APPROVED
+        message = @response[:Message]
+        
+        Response.new(success, message, @response, 
+            :test => test?, 
+            :authorization => @response[:CrossReference]
+        )
+      end
+      
+      # Put the passed data into a format that can be submitted to PSL
+      # Key=Value&Key=Value...
+      #
+      # Any ampersands and equal signs are removed from the data being posted
+      # as PSL puts them back into the response string which then cannot be parsed. 
+      # This is after escaping before sending the request to PSL - this is a work
+      # around for the time being
+      # 
+      # Parameters:
+      #   -post: Hash of all the data to be sent
+      #
+      # Returns:
+      #   -String: the data to be sent
+      #
+      def post_data(post)
+        post[:CountryCode] = self.location
+        post[:MerchantID] = @options[:login]
+        post[:ValidityID] = @options[:password]
+        post[:ResponseAction] = RESPONSE_ACTION
+        
+        post.collect { |key, value|
+          "#{key}=#{CGI.escape(value.to_s.tr('&=', ' '))}"
+        }.join("&")
+      end
+    end
+  end
+end