class ActiveMerchant::Billing::SagePayGateway
Constants
- APPROVED
- AVS_CODE
- CREDIT_CARDS
- CVV_CODE
- OPTIONAL_REQUEST_FIELDS
- 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 79 def initialize(options = {}) requires!(options, :login) super end
Public Instance Methods
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 115 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 146 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 84 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((past_purchase_reference?(payment_method) ? :repeat : :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 134 def refund(money, identification, options = {}) requires!(options, :order_id, :description) post = {} add_related_reference(post, identification) add_amount(post, money, options) add_invoice(post, options) commit(:credit, post) end
scrub(transcript)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 176 def scrub(transcript) transcript. gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]'). gsub(%r((&?CardNumber=)\d+(&?)), '\1[FILTERED]\2'). gsub(%r((&?CV2=)\d+(&?)), '\1[FILTERED]\2') end
store(credit_card, options = {})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 151 def store(credit_card, options = {}) post = {} add_credit_card(post, credit_card) add_currency(post, 0, options) commit(:store, post) end
supports_scrubbing()
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 172 def supports_scrubbing true end
unstore(token, options = {})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 159 def unstore(token, options = {}) post = {} add_token(post, token) commit(:unstore, post) end
verify(credit_card, options={})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 165 def verify(credit_card, options={}) MultiResponse.run(:use_first_response) do |r| r.process { authorize(100, credit_card, options) } r.process(:ignore_result) { void(r.authorization, options) } end end
void(identification, options = {})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 124 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 372 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 243 def add_address(post, options) if billing_address = options[:billing_address] || options[:address] first_name, last_name = split_names(billing_address[:name]) add_pair(post, :BillingSurname, truncate(last_name, 20)) add_pair(post, :BillingFirstnames, truncate(first_name, 20)) 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 = split_names(shipping_address[:name]) add_pair(post, :DeliverySurname, truncate(last_name, 20)) add_pair(post, :DeliveryFirstnames, truncate(first_name, 20)) 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 214 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 288 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) add_pair(post, :CardType, map_card_type(credit_card)) add_pair(post, :CV2, credit_card.verification_value) end
add_currency(post, money, options)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 220 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 230 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 271 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 235 def add_optional_data(post, options) add_pair(post, :CreateToken, 1) unless options[:store].blank? OPTIONAL_REQUEST_FIELDS.each do |gateway_option, sagepay_field| add_pair(post, sagepay_field, options[gateway_option]) end end
add_pair(post, key, value, options = {})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 424 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 276 def add_payment_method(post, payment_method, options) if payment_method.is_a?(String) if past_purchase_reference?(payment_method) add_related_reference(post, payment_method) else add_token_details(post, payment_method, options) end else add_credit_card(post, payment_method) end end
add_reference(post, identification)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 196 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 226 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 304 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 298 def add_token_details(post, token, options) add_token(post, token) add_pair(post, :StoreToken, options[:customer]) add_pair(post, :CV2, options[:verification_value]) end
build_simulator_url(action)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 390 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 381 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 345 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_CODE[response['AddressResult']], :postal_match => AVS_CODE[response['PostCodeResult']], }, :cvv_result => 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 336 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 319 def is_usa(country) truncate(country, 2) == 'US' end
map_card_type(credit_card)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 323 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 if card_type == :visa && credit_card.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 395 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 416 def parse(body) result = {} body.to_s.each_line do |pair| result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im end result end
past_purchase_reference?(payment_method)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 428 def past_purchase_reference?(payment_method) return false unless payment_method.is_a?(String) payment_method.split(';').last == 'purchase' end
post_data(action, parameters = {})
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 399 def post_data(action, parameters = {}) parameters.update( :Vendor => @options[:login], :TxType => TRANSACTIONS[action], :VPSProtocol => @options.fetch(:protocol_version, '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 308 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 313 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
Calls superclass method
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 185 def truncate(value, max_size) return nil unless value return value.to_s if CGI.escape(value.to_s).length <= max_size if value.size > max_size truncate(super(value, max_size), max_size) else truncate(value.to_s.chop, max_size) end end
url_for(action)
click to toggle source
# File lib/active_merchant/billing/gateways/sage_pay.rb, line 377 def url_for(action) simulate ? build_simulator_url(action) : build_url(action) end