aktivemerchant 2.0.0

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

@@ -0,0 +1,398 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SagePayGateway < Gateway
+      cattr_accessor :simulate
+      self.simulate = false
+
+      class_attribute :simulator_url
+
+      self.test_url = 'https://test.sagepay.com/gateway/service'
+      self.live_url = 'https://live.sagepay.com/gateway/service'
+      self.simulator_url = 'https://test.sagepay.com/Simulator'
+
+      APPROVED = 'OK'
+
+      TRANSACTIONS = {
+        :purchase => 'PAYMENT',
+        :credit => 'REFUND',
+        :authorization => 'DEFERRED',
+        :capture => 'RELEASE',
+        :void => 'VOID',
+        :abort => 'ABORT',
+        :store => 'TOKEN',
+        :unstore => 'REMOVETOKEN'
+      }
+
+      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', 'IE']
+      self.default_currency = 'GBP'
+
+      self.homepage_url = 'http://www.sagepay.com'
+      self.display_name = 'SagePay'
+
+      def initialize(options = {})
+        requires!(options, :login)
+        super
+      end
+
+      def purchase(money, payment_method, options = {})
+        requires!(options, :order_id)
+
+        post = {}
+
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_payment_method(post, payment_method, options)
+        add_address(post, options)
+        add_customer_data(post, options)
+        add_optional_data(post, options)
+
+        commit(:purchase, post)
+      end
+
+      def authorize(money, payment_method, options = {})
+        requires!(options, :order_id)
+
+        post = {}
+
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_payment_method(post, payment_method, options)
+        add_address(post, options)
+        add_customer_data(post, options)
+        add_optional_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
+
+      # Refunding requires a new order_id to passed in, as well as a description
+      def refund(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
+
+      def credit(money, identification, options = {})
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
+      def store(credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_currency(post, 0, options)
+
+        commit(:store, post)
+      end
+
+      def unstore(token, options = {})
+        post = {}
+        add_token(post, token)
+        commit(:unstore, 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)
+        currency = options[:currency] || currency(money)
+        add_pair(post, :Amount, localized_amount(money, currency), :required => true)
+        add_pair(post, :Currency, currency, :required => true)
+      end
+
+      def add_currency(post, money, options)
+        currency = options[:currency] || currency(money)
+        add_pair(post, :Currency, currency, :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, truncate(options[:email], 255)) unless options[:email].blank?
+        add_pair(post, :ClientIPAddress, options[:ip])
+      end
+
+      def add_optional_data(post, options)
+        add_pair(post, :GiftAidPayment, options[:gift_aid_payment]) unless options[:gift_aid_payment].blank?
+        add_pair(post, :Apply3DSecure, options[:apply_3d_secure]) unless options[:apply_3d_secure].blank?
+        add_pair(post, :CreateToken, 1) unless options[:store].blank?
+        add_pair(post, :FIRecipientAcctNumber, options[:recipient_account_number])
+        add_pair(post, :FIRecipientSurname, options[:recipient_surname])
+        add_pair(post, :FIRecipientPostcode, options[:recipient_postcode])
+        add_pair(post, :FIRecipientDoB, options[:recipient_dob])
+      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, truncate(billing_address[:address1], 100))
+          add_pair(post, :BillingAddress2, truncate(billing_address[:address2], 100))
+          add_pair(post, :BillingCity, truncate(billing_address[:city], 40))
+          add_pair(post, :BillingState, truncate(billing_address[:state], 2)) if is_usa(billing_address[:country])
+          add_pair(post, :BillingCountry, truncate(billing_address[:country], 2))
+          add_pair(post, :BillingPhone, sanitize_phone(billing_address[:phone]))
+          add_pair(post, :BillingPostCode, truncate(billing_address[:zip], 10))
+        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, truncate(shipping_address[:address1], 100))
+          add_pair(post, :DeliveryAddress2, truncate(shipping_address[:address2], 100))
+          add_pair(post, :DeliveryCity, truncate(shipping_address[:city], 40))
+          add_pair(post, :DeliveryState, truncate(shipping_address[:state], 2)) if is_usa(shipping_address[:country])
+          add_pair(post, :DeliveryCountry, truncate(shipping_address[:country], 2))
+          add_pair(post, :DeliveryPhone, sanitize_phone(shipping_address[:phone]))
+          add_pair(post, :DeliveryPostCode, truncate(shipping_address[:zip], 10))
+        end
+      end
+
+      def add_invoice(post, options)
+        add_pair(post, :VendorTxCode, sanitize_order_id(options[:order_id]), :required => true)
+        add_pair(post, :Description, truncate(options[:description] || options[:order_id], 100))
+      end
+
+      def add_payment_method(post, payment_method, options)
+        if payment_method.respond_to?(:number)
+          add_credit_card(post, payment_method)
+        else
+          add_token_details(post, payment_method, options)
+        end
+      end
+
+      def add_credit_card(post, credit_card)
+        add_pair(post, :CardHolder, truncate(credit_card.name, 50), :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 add_token_details(post, token, options)
+        add_token(post, token)
+        add_pair(post, :StoreToken, options[:customer])
+      end
+
+      def add_token(post, token)
+        add_pair(post, :Token, token)
+      end
+
+      def sanitize_order_id(order_id)
+        cleansed = order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
+        truncate(cleansed, 40)
+      end
+
+      def sanitize_phone(phone)
+        return nil unless phone
+        cleansed = phone.to_s.gsub(/[^0-9+]/, '')
+        truncate(cleansed, 20)
+      end
+
+      def truncate(value, max_size)
+        return nil unless value
+        value[0, max_size]
+      end
+
+      def is_usa(country)
+        truncate(country, 2) == 'US'
+      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)
+        case action
+        when :store
+          response['Token']
+        else
+         [ params[:VendorTxCode],
+           response["VPSTxId"],
+           response["TxAuthNo"],
+           response["SecurityKey"],
+           action ].join(";")
+        end
+      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 = case action
+          when :purchase, :authorization then "vspdirect-register"
+          when :store then 'directtoken'
+          else TRANSACTIONS[action].downcase
+        end
+        "#{test? ? self.test_url : self.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"
+        "#{self.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 => "3.00"
+        )
+
+        if(application_id && (application_id != Gateway.application_id))
+          parameters.update(:ReferrerID => application_id)
+        end
+
+        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      # SagePay returns data in the following format
+      # Key1=value1
+      # Key2=value2
+      def parse(body)
+        result = {}
+        body.to_s.each_line do |pair|
+          result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im
+        end
+        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(' ')
+        [ truncate(first_name, 20), truncate(last_name, 20) ]
+      end
+
+      def localized_amount(money, currency)
+        amount = amount(money)
+        CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s) ? amount.split('.').first : amount
+      end
+    end
+
+  end
+end
+

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

@@ -0,0 +1,143 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SallieMaeGateway < Gateway
+      self.live_url = self.test_url = 'https://trans.salliemae.com/cgi-bin/process.cgi'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['US']
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.salliemae.com/'
+
+      # The name of the gateway
+      self.display_name = 'Sallie Mae'
+
+      def initialize(options = {})
+        requires!(options, :login)
+        super
+      end
+
+      def test?
+        @options[:login] == "TEST0"
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = PostData.new
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+
+        commit(:authonly, money, post)
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = PostData.new
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+
+        commit(:sale, money, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = PostData.new
+        post[:postonly] = authorization
+        commit(:capture, money, post)
+      end
+
+      private
+
+      def add_customer_data(post, options)
+        if address = options[:billing_address] || options[:shipping_address] || options[:address]
+          post[:ci_phone] = address[:phone].to_s
+        end
+
+        post[:ci_email] = options[:email].to_s unless options[:email].blank?
+        post[:ci_IP]    = options[:ip].to_s unless options[:ip].blank?
+      end
+
+      def add_address(post, creditcard, options)
+        if address = options[:billing_address] || options[:address]
+          post[:ci_billaddr1] = address[:address1].to_s
+          post[:ci_billaddr2] = address[:address2].to_s unless address[:address2].blank?
+          post[:ci_billcity]  = address[:city].to_s
+          post[:ci_billstate] = address[:state].to_s
+          post[:ci_billzip]   = address[:zip].to_s
+        end
+
+        if shipping_address = options[:shipping_address] || options[:address]
+          post[:ci_shipaddr1] = shipping_address[:address1].to_s
+          post[:ci_shipaddr2] = shipping_address[:address2].to_s unless shipping_address[:address2].blank?
+          post[:ci_shipcity]  = shipping_address[:city].to_s
+          post[:ci_shipstate] = shipping_address[:state].to_s
+          post[:ci_shipzip]   = shipping_address[:zip].to_s
+        end
+      end
+
+      def add_invoice(post, options)
+        memo = "OrderID: #{options[:order_id]}\nDescription: #{options[:description]}"
+        post[:ci_memo] = memo
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:ccnum]   = creditcard.number.to_s
+        post[:ccname]  = creditcard.name.to_s
+        post[:cvv2]    = creditcard.verification_value.to_s if creditcard.verification_value?
+        post[:expmon]  = creditcard.month.to_s
+        post[:expyear] = creditcard.year.to_s
+      end
+
+      def parse(body)
+        h = {}
+        body.gsub!("<html><body><plaintext>", "")
+        body.
+          split("\r\n").
+          map do |i|
+            a = i.split("=")
+            h[a.first] = a.last unless a.first.nil?
+          end
+        h
+      end
+
+      def commit(action, money, parameters)
+        parameters[:acctid] = @options[:login].to_s
+        parameters[:subid]  = @options[:sub_id].to_s unless @options[:sub_id].blank?
+        parameters[:amount] = amount(money)
+
+        case action
+        when :sale
+          parameters[:action] = "ns_quicksale_cc"
+        when :authonly
+          parameters[:action] = "ns_quicksale_cc"
+          parameters[:authonly] = 1
+        when :capture
+          parameters[:action] = "ns_quicksale_cc"
+        end
+
+        response = parse(ssl_post(self.live_url, parameters.to_post_data) || "")
+        Response.new(successful?(response), message_from(response), response,
+          :test => test?,
+          :authorization => response["refcode"]
+        )
+      end
+
+      def successful?(response)
+        response["Status"] == "Accepted"
+      end
+
+      def message_from(response)
+        if successful?(response)
+          "Accepted"
+        else
+          response["Reason"].split(":")[2].capitalize unless response["Reason"].nil?
+        end
+      end
+    end
+  end
+end
+