johnideal-activemerchant 1.4.4

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

@@ -0,0 +1,292 @@
+module ActiveMerchant
+  module Billing
+        
+    class PlugnpayGateway < Gateway
+      class PlugnpayPostData < PostData
+        # Fields that will be sent even if they are blank
+        self.required_fields = [ :publisher_name, :publisher_password, 
+          :card_amount, :card_name, :card_number, :card_exp, :orderID ]
+      end                                                  
+                                                           
+      URL = 'https://pay1.plugnpay.com/payment/pnpremote.cgi'
+                                                        
+      CARD_CODE_MESSAGES = {
+        "M" => "Card verification number matched",
+        "N" => "Card verification number didn't match",
+        "P" => "Card verification number was not processed",
+        "S" => "Card verification number should be on card but was not indicated",
+        "U" => "Issuer was not certified for card verification"
+      }
+
+      CARD_CODE_ERRORS = %w( N S )
+      
+      AVS_MESSAGES = {
+        "A" => "Street address matches billing information, zip/postal code does not",
+        "B" => "Address information not provided for address verification check",
+        "E" => "Address verification service error",
+        "G" => "Non-U.S. card-issuing bank",
+        "N" => "Neither street address nor zip/postal match billing information",
+        "P" => "Address verification not applicable for this transaction",
+        "R" => "Payment gateway was unavailable or timed out",
+        "S" => "Address verification service not supported by issuer",
+        "U" => "Address information is unavailable",
+        "W" => "9-digit zip/postal code matches billing information, street address does not",
+        "X" => "Street address and 9-digit zip/postal code matches billing information",
+        "Y" => "Street address and 5-digit zip/postal code matches billing information",
+        "Z" => "5-digit zip/postal code matches billing information, street address does not",
+      }
+      
+      AVS_ERRORS = %w( A E N R W Z )
+      
+      PAYMENT_GATEWAY_RESPONSES = {
+        "P01" => "AVS Mismatch Failure",
+        "P02" => "CVV2 Mismatch Failure",
+        "P21" => "Transaction may not be marked",
+        "P30" => "Test Tran. Bad Card",
+        "P35" => "Test Tran. Problem",
+        "P40" => "Username already exists",
+        "P41" => "Username is blank",
+        "P50" => "Fraud Screen Failure",
+        "P51" => "Missing PIN Code",
+        "P52" => "Invalid Bank Acct. No.",
+        "P53" => "Invalid Bank Routing No.",
+        "P54" => "Invalid/Missing Check No.",
+        "P55" => "Invalid Credit Card No.",
+        "P56" => "Invalid CVV2/CVC2 No.",
+        "P57" => "Expired. CC Exp. Date",
+        "P58" => "Missing Data",
+        "P59" => "Missing Email Address",
+        "P60" => "Zip Code does not match Billing State.",
+        "P61" => "Invalid Billing Zip Code",
+        "P62" => "Zip Code does not match Shipping State.",
+        "P63" => "Invalid Shipping Zip Code",
+        "P64" => "Invalid Credit Card CVV2/CVC2 Format.",
+        "P65" => "Maximum number of attempts has been exceeded.",
+        "P66" => "Credit Card number has been flagged and can not be used to access this service.",
+        "P67" => "IP Address is on Blocked List.",
+        "P68" => "Billing country does not match ipaddress country.",
+        "P69" => "US based ipaddresses are currently blocked.",
+        "P70" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P71" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P72" => "Daily volume exceeded.",
+        "P73" => "Too many transactions within allotted time.",
+        "P91" => "Missing/incorrect password",
+        "P92" => "Account not configured for mobil administration",
+        "P93" => "IP Not registered to username.",
+        "P94" => "Mode not permitted for this account.",
+        "P95" => "Currently Blank",
+        "P96" => "Currently Blank",
+        "P97" => "Processor not responding",
+        "P98" => "Missing merchant/publisher name",
+        "P99" => "Currently Blank"
+      }
+      
+      TRANSACTIONS = {
+        :authorization => 'auth',
+        :purchase => 'auth',
+        :capture => 'mark',
+        :void => 'void',
+        :refund => 'return',
+        :credit => 'newreturn'
+      }
+     
+      SUCCESS_CODES = [ 'pending', 'success' ]
+      FAILURE_CODES = [ 'badcard', 'fraud' ]
+     
+      self.default_currency = 'USD'
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.plugnpay.com/'
+      self.display_name = "Plug'n Pay"
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      def purchase(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+        
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)
+        add_addresses(post, options)
+        add_invoice_data(post, options)
+        add_customer_data(post, options)
+         
+        post[:authtype] = 'authpostauth'
+        commit(:authorization, post)
+      end  
+      
+      def authorize(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+        
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)        
+        add_addresses(post, options)
+        add_invoice_data(post, options)        
+        add_customer_data(post, options)
+        
+        post[:authtype] = 'authonly'
+        commit(:authorization, post)
+      end                  
+
+      def capture(money, authorization, options = {})
+        post = PlugnpayPostData.new
+        
+        post[:orderID] = authorization
+        
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+         
+        commit(:capture, post)
+      end
+      
+      def void(authorization, options = {})
+        post = PlugnpayPostData.new
+        
+        post[:orderID] = authorization
+        post[:txn_type] = 'auth'
+        
+        commit(:void, post)
+      end
+      
+      def credit(money, identification_or_creditcard, options = {})
+        post = PlugnpayPostData.new
+        add_amount(post, money, options)
+       
+        if identification_or_creditcard.is_a?(String)
+          post[:orderID] = identification_or_creditcard
+          
+          commit(:refund, post)
+        else
+          add_creditcard(post, identification_or_creditcard)        
+          add_addresses(post, options)   
+          add_customer_data(post, options) 
+          
+          commit(:credit, post)
+        end
+      end
+      
+      private                                 
+      def commit(action, post)
+        response = parse( ssl_post(URL, post_data(action, post)) )
+        
+        success = SUCCESS_CODES.include?(response[:finalstatus])
+        message = success ? 'Success' : message_from(response)
+            
+        Response.new(success, message, response, 
+          :test => test?, 
+          :authorization => response[:orderid],
+          :avs_result => { :code => response[:avs_code] },
+          :cvv_result => response[:cvvresp]
+        )
+      end
+                                               
+      def parse(body)
+        body = CGI.unescape(body)
+        results = {}
+        body.split('&').collect { |e| e.split('=') }.each do |key,value|
+          results[key.downcase.to_sym] = normalize(value.to_s.strip)
+        end
+        
+        results.delete(:publisher_password)
+        results[:avs_message] = AVS_MESSAGES[results[:avs_code]] if results[:avs_code]
+        results[:card_code_message] = CARD_CODE_MESSAGES[results[:cvvresp]] if results[:cvvresp]
+        
+        results
+      end     
+
+      def post_data(action, post)
+        post[:mode]               = TRANSACTIONS[action]
+        post[:convert]            = 'underscores'
+        post[:app_level]          = 0
+        post[:publisher_name]     = @options[:login]
+        post[:publisher_password] = @options[:password]
+      
+        post.to_s
+      end
+      
+      def add_creditcard(post, creditcard)      
+        post[:card_number]  = creditcard.number
+        post[:card_cvv]     = creditcard.verification_value
+        post[:card_exp]     = expdate(creditcard)
+        post[:card_name]    = creditcard.name.slice(0..38)
+      end
+      
+      def add_customer_data(post, options)
+        post[:email] = options[:email]
+        post[:dontsndmail]        = 'yes' unless options[:send_email_confirmation]
+        post[:ipaddress] = options[:ip]
+      end
+      
+      def add_invoice_data(post, options)
+        post[:shipping] = amount(options[:shipping]) unless options[:shipping].blank?
+        post[:tax] = amount(options[:tax]) unless options[:tax].blank?  
+      end
+
+      def add_addresses(post, options)      
+        if address = options[:billing_address] || options[:address]
+          post[:card_address1] = address[:address1]
+          post[:card_zip]      = address[:zip]     
+          post[:card_city]     = address[:city]    
+          post[:card_country]  = address[:country]
+          post[:phone]         = address[:phone]
+
+          case address[:country]
+          when 'US', 'CA'
+            post[:card_state] = address[:state]
+          else
+            post[:card_state] = 'ZZ' 
+            post[:card_prov]  = address[:state]
+          end
+        end
+        
+        if shipping_address = options[:shipping_address] || address
+          post[:shipname] = shipping_address[:name]
+          post[:address1] = shipping_address[:address1]
+          post[:address2] = shipping_address[:address2]
+          post[:city] = shipping_address[:city]
+          
+          case shipping_address[:country]
+          when 'US', 'CA'
+            post[:state] = shipping_address[:state]
+          else
+            post[:state] = 'ZZ' 
+            post[:province]  = shipping_address[:state]
+          end
+          
+          post[:country] = shipping_address[:country]
+          post[:zip] = shipping_address[:zip]
+        end        
+      end
+      
+      def add_amount(post, money, options)
+        post[:card_amount] = amount(money)
+        post[:currency] = options[:currency] || currency(money)
+      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          
+      
+      def message_from(results)
+        PAYMENT_GATEWAY_RESPONSES[results[:resp_code]]
+      end
+        
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{month}/#{year[-2..-1]}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,307 @@
+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',
+        :abort => 'ABORT'
+      }
+      
+      CREDIT_CARDS = {
+        :visa => "VISA",
+        :master => "MC",
+        :delta => "DELTA",
+        :solo => "SOLO",
+        :switch => "MAESTRO",
+        :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})?$/
+      
+      AVS_CVV_CODE = {
+        "NOTPROVIDED" => nil, 
+        "NOTCHECKED" => 'X',
+        "MATCHED" => 'Y',
+        "NOTMATCHED" => 'N'
+      }
+    
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :switch, :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] || super
+      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
+      
+      # You can only capture a transaction once, even if you didn't capture the full amount the first time.
+      def capture(money, identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        add_release_amount(post, money, options)
+        
+        commit(:capture, post)
+      end
+      
+      def void(identification, options = {})
+        post = {}
+        
+        add_reference(post, identification)
+        action = abort_or_void_from(identification)
+
+        commit(action, 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
+
+      # doesn't actually use the currency -- dodgy!
+      def add_release_amount(post, money, options)
+        add_pair(post, :ReleaseAmount, amount(money), :required => true)
+      end
+
+      def add_customer_data(post, options)
+        add_pair(post, :CustomerEMail, options[:email][0,255]) unless options[:email].blank?
+        add_pair(post, :BillingPhone, options[:phone].gsub(/[^0-9+]/, '')[0,20]) unless options[:phone].blank?
+        add_pair(post, :ClientIPAddress, options[:ip])
+      end
+
+      def add_address(post, options)
+        if billing_address = options[:billing_address] || options[:address]
+          first_name, last_name = parse_first_and_last_name(billing_address[:name])
+          add_pair(post, :BillingSurname, last_name)
+          add_pair(post, :BillingFirstnames, first_name)
+          add_pair(post, :BillingAddress1, billing_address[:address1])
+          add_pair(post, :BillingAddress2, billing_address[:address2])
+          add_pair(post, :BillingCity, billing_address[:city])
+          add_pair(post, :BillingState, billing_address[:state]) if billing_address[:country] == 'US'
+          add_pair(post, :BillingCountry, billing_address[:country])
+          add_pair(post, :BillingPostCode, billing_address[:zip])
+        end
+        
+        if shipping_address = options[:shipping_address] || billing_address
+          first_name, last_name = parse_first_and_last_name(shipping_address[:name])
+          add_pair(post, :DeliverySurname, last_name)
+          add_pair(post, :DeliveryFirstnames, first_name)
+          add_pair(post, :DeliveryAddress1, shipping_address[:address1])
+          add_pair(post, :DeliveryAddress2, shipping_address[:address2])
+          add_pair(post, :DeliveryCity, shipping_address[:city])
+          add_pair(post, :DeliveryState, shipping_address[:state]) if shipping_address[:country] == 'US'
+          add_pair(post, :DeliveryCountry, shipping_address[:country])
+          add_pair(post, :DeliveryPostCode, shipping_address[:zip])
+        end
+      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_date(credit_card.month, credit_card.year), :required => true)
+         
+        if requires_start_date_or_issue_number?(credit_card)
+          add_pair(post, :StartDate, format_date(credit_card.start_month, credit_card.start_year))
+          add_pair(post, :IssueNumber, credit_card.issue_number)
+        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 card_brand(credit_card).blank?
+        
+        card_type = card_brand(credit_card).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_date(month, year)
+        return nil if year.blank? || month.blank?
+        
+        year  = sprintf("%.4i", year)
+        month = sprintf("%.2i", month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+      
+      def commit(action, parameters)
+        response = parse( ssl_post(url_for(action), post_data(action, parameters)) )
+          
+        Response.new(response["Status"] == APPROVED, message_from(response), response,
+          :test => test?,
+          :authorization => authorization_from(response, parameters, action),
+          :avs_result => { 
+            :street_match => AVS_CVV_CODE[ response["AddressResult"] ],
+            :postal_match => AVS_CVV_CODE[ response["PostCodeResult"] ],
+          },
+          :cvv_result => AVS_CVV_CODE[ response["CV2Result"] ]
+        )
+      end
+      
+      def authorization_from(response, params, action)
+         [ params[:VendorTxCode],
+           response["VPSTxId"],
+           response["TxAuthNo"],
+           response["SecurityKey"],
+           action ].join(";")
+      end
+
+      def abort_or_void_from(identification)
+        original_transaction = identification.split(';').last
+        original_transaction == 'authorization' ? :abort : :void
+      end
+
+      def url_for(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(response)
+        response['Status'] == APPROVED ? 'Success' : (response['StatusDetail'] || 'Unspecified error')    # simonr 20080207 can't actually get non-nil blanks, so this is shorter
+      end
+
+      def post_data(action, parameters = {})
+        parameters.update(
+          :Vendor => @options[:login],
+          :TxType => TRANSACTIONS[action],
+          :VPSProtocol => "2.23"
+        )
+        
+        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.each { |pair| result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im }
+        result
+      end
+
+      def add_pair(post, key, value, options = {})
+        post[key] = value if !value.blank? || options[:required]
+      end
+
+      def parse_first_and_last_name(value)
+        name = value.to_s.split(' ')
+        
+        last_name = name.pop || ''
+        first_name = name.join(' ')
+        [ first_name[0,20], last_name[0,20] ]
+      end
+    end
+  end
+end
+