class ActiveMerchant::Billing::SagePayGateway

Constants

APPROVED
AVS_CVV_CODE
CREDIT_CARDS
ELECTRON
TRANSACTIONS

Public Class Methods

new(options = {}) click to toggle source
Calls superclass method ActiveMerchant::Billing::Gateway::new
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 55
def initialize(options = {})
  requires!(options, :login)
  super
end

Public Instance Methods

authorize(money, payment_method, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 75
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
capture(money, identification, options = {}) click to toggle source

You can only capture a transaction once, even if you didn’t capture the full amount the first time.

# File lib/active_merchant/billing/gateways/sage_pay.rb, line 91
def capture(money, identification, options = {})
  post = {}

  add_reference(post, identification)
  add_release_amount(post, money, options)

  commit(:capture, post)
end
credit(money, identification, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 122
def credit(money, identification, options = {})
  ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, identification, options)
end
purchase(money, payment_method, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 60
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
refund(money, identification, options = {}) click to toggle source

Refunding requires a new order_id to passed in, as well as a description

# File lib/active_merchant/billing/gateways/sage_pay.rb, line 110
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
store(credit_card, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 127
def store(credit_card, options = {})
  post = {}
  add_credit_card(post, credit_card)
  add_currency(post, 0, options)

  commit(:store, post)
end
unstore(token, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 135
def unstore(token, options = {})
  post = {}
  add_token(post, token)
  commit(:unstore, post)
end
void(identification, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 100
def void(identification, options = {})
  post = {}

  add_reference(post, identification)
  action = abort_or_void_from(identification)

  commit(action, post)
end

Private Instance Methods

abort_or_void_from(identification) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 326
def abort_or_void_from(identification)
  original_transaction = identification.split(';').last
  original_transaction == 'authorization' ? :abort : :void
end
add_address(post, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 191
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
add_amount(post, money, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 160
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
add_credit_card(post, credit_card) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 232
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
add_credit_reference(post, identification) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 151
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
add_currency(post, money, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 166
def add_currency(post, money, options)
  currency = options[:currency] || currency(money)
  add_pair(post, :Currency, currency, :required => true)
end
add_customer_data(post, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 176
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
add_invoice(post, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 219
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
add_optional_data(post, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 181
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
add_pair(post, key, value, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 378
def add_pair(post, key, value, options = {})
  post[key] = value if !value.blank? || options[:required]
end
add_payment_method(post, payment_method, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 224
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
add_reference(post, identification) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 142
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
add_release_amount(post, money, options) click to toggle source

doesn’t actually use the currency – dodgy!

# File lib/active_merchant/billing/gateways/sage_pay.rb, line 172
def add_release_amount(post, money, options)
  add_pair(post, :ReleaseAmount, amount(money), :required => true)
end
add_token(post, token) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 252
def add_token(post, token)
  add_pair(post, :Token, token)
end
add_token_details(post, token, options) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 247
def add_token_details(post, token, options)
  add_token(post, token)
  add_pair(post, :StoreToken, options[:customer])
end
authorization_from(response, params, action) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 313
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
build_simulator_url(action) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 344
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
build_url(action) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 335
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
commit(action, parameters) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 299
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
format_date(month, year) click to toggle source

MMYY format

# File lib/active_merchant/billing/gateways/sage_pay.rb, line 290
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
is_usa(country) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 272
def is_usa(country)
  truncate(country, 2) == 'US'
end
localized_amount(money, currency) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 390
def localized_amount(money, currency)
  amount = amount(money)
  CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s) ? amount.split('.').first : amount
end
map_card_type(credit_card) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 276
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
message_from(response) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 349
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
parse(body) click to toggle source

SagePay returns data in the following format Key1=value1 Key2=value2

# File lib/active_merchant/billing/gateways/sage_pay.rb, line 370
def parse(body)
  result = {}
  body.to_s.each_line do |pair|
    result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im
  end
  result
end
parse_first_and_last_name(value) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 382
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
post_data(action, parameters = {}) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 353
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
sanitize_order_id(order_id) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 256
def sanitize_order_id(order_id)
  cleansed = order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
  truncate(cleansed, 40)
end
sanitize_phone(phone) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 261
def sanitize_phone(phone)
  return nil unless phone
  cleansed = phone.to_s.gsub(/[^0-9+]/, '')
  truncate(cleansed, 20)
end
truncate(value, max_size) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 267
def truncate(value, max_size)
  return nil unless value
  value[0, max_size]
end
url_for(action) click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 331
def url_for(action)
  simulate ? build_simulator_url(action) : build_url(action)
end