class ActiveMerchant::Billing::BlueSnapGateway

Constants

AVS_CODE_TRANSLATOR
BANK_ACCOUNT_TYPE_MAPPING
CVC_CODE_TRANSLATOR
STATE_CODE_COUNTRIES
TRANSACTIONS

Public Class Methods

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

Public Instance Methods

authorize(money, payment_method, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 88
def authorize(money, payment_method, options={})
  commit(:authorize) do |doc|
    add_auth_purchase(doc, money, payment_method, options)
  end
end
capture(money, authorization, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 94
def capture(money, authorization, options={})
  commit(:capture, :put) do |doc|
    add_authorization(doc, authorization)
    add_order(doc, options)
    add_amount(doc, money, options) if options[:include_capture_amount] == true
  end
end
purchase(money, payment_method, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 76
def purchase(money, payment_method, options={})
  payment_method_details = PaymentMethodDetails.new(payment_method)

  commit(:purchase, :post, payment_method_details) do |doc|
    if payment_method_details.alt_transaction?
      add_alt_transaction_purchase(doc, money, payment_method_details, options)
    else
      add_auth_purchase(doc, money, payment_method, options)
    end
  end
end
refund(money, authorization, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 102
def refund(money, authorization, options={})
  commit(:refund, :put) do |doc|
    add_authorization(doc, authorization)
    add_amount(doc, money, options)
    add_order(doc, options)
  end
end
scrub(transcript) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 162
def scrub(transcript)
  transcript.
    gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
    gsub(%r((<card-number>).+(</card-number>)), '\1[FILTERED]\2').
    gsub(%r((<security-code>).+(</security-code>)), '\1[FILTERED]\2').
    gsub(%r((<(?:public-)?account-number>).+(</(?:public-)?account-number>)), '\1[FILTERED]\2').
    gsub(%r((<(?:public-)?routing-number>).+(</(?:public-)?routing-number>)), '\1[FILTERED]\2')
end
store(payment_method, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 121
def store(payment_method, options = {})
  payment_method_details = PaymentMethodDetails.new(payment_method)

  commit(:store, :post, payment_method_details) do |doc|
    add_personal_info(doc, payment_method, options)
    add_echeck_company(doc, payment_method) if payment_method_details.check?
    doc.send('payment-sources') do
      payment_method_details.check? ? store_echeck(doc, payment_method) : store_credit_card(doc, payment_method)
    end
    add_order(doc, options)
  end
end
store_credit_card(doc, payment_method) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 134
def store_credit_card(doc, payment_method)
  doc.send('credit-card-info') do
    add_credit_card(doc, payment_method)
  end
end
store_echeck(doc, payment_method) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 140
def store_echeck(doc, payment_method)
  doc.send('ecp-info') do
    doc.send('ecp') do
      add_echeck(doc, payment_method)
    end
  end
end
supports_scrubbing?() click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 158
def supports_scrubbing?
  true
end
verify(payment_method, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 117
def verify(payment_method, options={})
  authorize(0, payment_method, options)
end
verify_credentials() click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 148
def verify_credentials
  begin
    ssl_get(url.to_s, headers)
  rescue ResponseError => e
    return false if e.response.code.to_i == 401
  end

  true
end
void(authorization, options={}) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 110
def void(authorization, options={})
  commit(:void, :put) do |doc|
    add_authorization(doc, authorization)
    add_order(doc, options)
  end
end

Private Instance Methods

add_3ds(doc, three_d_secure_options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 241
def add_3ds(doc, three_d_secure_options)
  eci = three_d_secure_options[:eci]
  cavv = three_d_secure_options[:cavv]
  xid = three_d_secure_options[:xid]
  ds_transaction_id = three_d_secure_options[:ds_transaction_id]
  version = three_d_secure_options[:version]

  doc.send('three-d-secure') do
    doc.eci(eci) if eci
    doc.cavv(cavv) if cavv
    doc.xid(xid) if xid
    doc.send('three-d-secure-version', version) if version
    doc.send('ds-transaction-id', ds_transaction_id) if ds_transaction_id
  end
end
add_address(doc, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 230
def add_address(doc, options)
  address = options[:billing_address]
  return unless address

  doc.country(address[:country]) if address[:country]
  doc.state(address[:state]) if address[:state] && STATE_CODE_COUNTRIES.include?(address[:country])
  doc.address(address[:address]) if address[:address]
  doc.city(address[:city]) if address[:city]
  doc.zip(address[:zip]) if address[:zip]
end
add_alt_transaction_purchase(doc, money, payment_method_details, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 302
def add_alt_transaction_purchase(doc, money, payment_method_details, options)
  doc.send('merchant-transaction-id', truncate(options[:order_id], 50)) if options[:order_id]
  doc.send('soft-descriptor', options[:soft_descriptor]) if options[:soft_descriptor]
  add_amount(doc, money, options)

  vaulted_shopper_id = payment_method_details.vaulted_shopper_id
  doc.send('vaulted-shopper-id', vaulted_shopper_id) if vaulted_shopper_id

  if payment_method_details.check?
    add_echeck_transaction(doc, payment_method_details.payment_method, options, vaulted_shopper_id.present?)
  end

  add_fraud_info(doc, options)
  add_description(doc, options)
end
add_amount(doc, money, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 190
def add_amount(doc, money, options)
  doc.amount(amount(money))
  doc.currency(options[:currency] || currency(money))
end
add_auth_purchase(doc, money, payment_method, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 173
def add_auth_purchase(doc, money, payment_method, options)
  doc.send('recurring-transaction', options[:recurring] ? 'RECURRING' : 'ECOMMERCE')
  add_order(doc, options)
  doc.send('store-card', options[:store_card] || false)
  add_amount(doc, money, options)
  add_fraud_info(doc, options)

  if payment_method.is_a?(String)
    doc.send('vaulted-shopper-id', payment_method)
  else
    doc.send('card-holder-info') do
      add_personal_info(doc, payment_method, options)
    end
    add_credit_card(doc, payment_method)
  end
end
add_authorization(doc, authorization) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 292
def add_authorization(doc, authorization)
  doc.send('transaction-id', authorization)
end
add_credit_card(doc, card) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 203
def add_credit_card(doc, card)
  doc.send('credit-card') do
    doc.send('card-number', card.number)
    doc.send('security-code', card.verification_value)
    doc.send('expiration-month', card.month)
    doc.send('expiration-year', card.year)
  end
end
add_description(doc, description) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 212
def add_description(doc, description)
  doc.send('transaction-meta-data') do
    doc.send('meta-data') do
      doc.send('meta-key', 'description')
      doc.send('meta-value', truncate(description, 500))
      doc.send('meta-description', 'Description')
    end
  end
end
add_echeck(doc, check) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 337
def add_echeck(doc, check)
  doc.send('account-number', check.account_number)
  doc.send('routing-number', check.routing_number)
  doc.send('account-type', BANK_ACCOUNT_TYPE_MAPPING["#{check.account_holder_type}_#{check.account_type}"])
end
add_echeck_company(doc, check) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 333
def add_echeck_company(doc, check)
  doc.send('company-name', truncate(check.name, 50)) if check.account_holder_type = 'business'
end
add_echeck_transaction(doc, check, options, vaulted_shopper) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 318
def add_echeck_transaction(doc, check, options, vaulted_shopper)
  unless vaulted_shopper
    doc.send('payer-info') do
      add_personal_info(doc, check, options)
      add_echeck_company(doc, check)
    end
  end

  doc.send('ecp-transaction') do
    add_echeck(doc, check) unless vaulted_shopper
  end

  doc.send('authorized-by-shopper', options[:authorized_by_shopper])
end
add_fraud_info(doc, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 296
def add_fraud_info(doc, options)
  doc.send('transaction-fraud-info') do
    doc.send('shopper-ip-address', options[:ip]) if options[:ip]
  end
end
add_level_3_data(doc, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 257
def add_level_3_data(doc, options)
  return unless options[:customer_reference_number]
  doc.send('level-3-data') do
    send_when_present(doc, :customer_reference_number, options)
    send_when_present(doc, :sales_tax_amount, options)
    send_when_present(doc, :freight_amount, options)
    send_when_present(doc, :duty_amount, options)
    send_when_present(doc, :destination_zip_code, options)
    send_when_present(doc, :destination_country_code, options)
    send_when_present(doc, :ship_from_zip_code, options)
    send_when_present(doc, :discount_amount, options)
    send_when_present(doc, :tax_amount, options)
    send_when_present(doc, :tax_rate, options)
    add_level_3_data_items(doc, options[:level_3_data_items]) if options[:level_3_data_items]
  end
end
add_level_3_data_items(doc, items) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 281
def add_level_3_data_items(doc, items)
  items.each do |item|
    doc.send('level-3-data-item') do
      item.each do |key, value|
        key = key.to_s.dasherize
        doc.send(key, value)
      end
    end
  end
end
add_order(doc, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 222
def add_order(doc, options)
  doc.send('merchant-transaction-id', truncate(options[:order_id], 50)) if options[:order_id]
  doc.send('soft-descriptor', options[:soft_descriptor]) if options[:soft_descriptor]
  add_description(doc, options[:description]) if options[:description]
  add_3ds(doc, options[:three_d_secure]) if options[:three_d_secure]
  add_level_3_data(doc, options)
end
add_personal_info(doc, payment_method, options) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 195
def add_personal_info(doc, payment_method, options)
  doc.send('first-name', payment_method.first_name)
  doc.send('last-name', payment_method.last_name)
  doc.send('personal-identification-number', options[:personal_identification_number]) if options[:personal_identification_number]
  doc.email(options[:email]) if options[:email]
  add_address(doc, options)
end
api_request(action, request, verb, payment_method_details) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 371
def api_request(action, request, verb, payment_method_details)
  ssl_request(verb, url(action, payment_method_details), request, headers)
rescue ResponseError => e
  e.response
end
authorization_from(action, parsed_response, payment_method_details) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 422
def authorization_from(action, parsed_response, payment_method_details)
  action == :store ? vaulted_shopper_id(parsed_response, payment_method_details) : parsed_response['transaction-id']
end
avs_lookup_key(p) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 409
def avs_lookup_key(p)
  "line1: #{p['avs-response-code-address']}, zip: #{p['avs-response-code-zip']}, name: #{p['avs-response-code-name']}"
end
avs_result(parsed) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 405
def avs_result(parsed)
  AVSResult.new(code: AVS_CODE_TRANSLATOR[avs_lookup_key(parsed)])
end
bad_authentication_response() click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 472
def bad_authentication_response
  { 'description' => 'Unable to authenticate.  Please check your credentials.' }
end
build_xml_request(action, payment_method_details) { |doc| ... } click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 454
def build_xml_request(action, payment_method_details)
  builder = Nokogiri::XML::Builder.new
  builder.__send__(root_element(action, payment_method_details), root_attributes) do |doc|
    doc.send('card-transaction-type', TRANSACTIONS[action]) if TRANSACTIONS[action] && !payment_method_details.alt_transaction?
    yield(doc)
  end
  builder.doc.root.to_xml
end
commit(action, verb = :post, payment_method_details = PaymentMethodDetails.new()) { |doc| ... } click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 377
def commit(action, verb = :post, payment_method_details = PaymentMethodDetails.new())
  request = build_xml_request(action, payment_method_details) { |doc| yield(doc) }
  response = api_request(action, request, verb, payment_method_details)
  parsed = parse(response)

  succeeded = success_from(action, response)
  Response.new(
    succeeded,
    message_from(succeeded, parsed),
    parsed,
    authorization: authorization_from(action, parsed, payment_method_details),
    avs_result: avs_result(parsed),
    cvv_result: cvv_result(parsed),
    error_code: error_code_from(parsed),
    test: test?
  )
end
cvv_result(parsed) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 401
def cvv_result(parsed)
  CVVResult.new(CVC_CODE_TRANSLATOR[parsed['cvv-response-code']])
end
error_code_from(parsed_response) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 433
def error_code_from(parsed_response)
  parsed_response['code']
end
forbidden_response(body) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 476
def forbidden_response(body)
  { 'description' => body }
end
handle_response(response) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 463
def handle_response(response)
  case response.code.to_i
  when 200...300
    response
  else
    raise ResponseError.new(response)
  end
end
headers() click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 447
def headers
  {
    'Content-Type' => 'application/xml',
    'Authorization' => ('Basic ' + Base64.strict_encode64("#{@options[:api_username]}:#{@options[:api_password]}").strip),
  }
end
message_from(succeeded, parsed_response) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 417
def message_from(succeeded, parsed_response)
  return 'Success' if succeeded
  parsed_response['description']
end
parse(response) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 343
def parse(response)
  return bad_authentication_response if response.code.to_i == 401
  return forbidden_response(response.body) if response.code.to_i == 403

  parsed = {}
  doc = Nokogiri::XML(response.body)
  doc.root.xpath('*').each do |node|
    if node.elements.empty?
      parsed[node.name.downcase] = node.text
    else
      node.elements.each do |childnode|
        parse_element(parsed, childnode)
      end
    end
  end

  parsed['content-location-header'] = response['content-location']
  parsed
end
parse_element(parsed, node) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 363
def parse_element(parsed, node)
  if !node.elements.empty?
    node.elements.each { |e| parse_element(parsed, e) }
  else
    parsed[node.name.downcase] = node.text
  end
end
root_attributes() click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 437
def root_attributes
  {
    xmlns: 'http://ws.plimus.com'
  }
end
root_element(action, payment_method_details) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 443
def root_element(action, payment_method_details)
  action == :store ? 'vaulted-shopper' : payment_method_details.root_element
end
send_when_present(doc, options_key, options, xml_element_name = nil) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 274
def send_when_present(doc, options_key, options, xml_element_name = nil)
  return unless options[options_key]
  xml_element_name ||= options_key.to_s

  doc.send(xml_element_name.dasherize, options[options_key])
end
success_from(action, response) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 413
def success_from(action, response)
  (200...300).cover?(response.code.to_i)
end
url(action = nil, payment_method_details = PaymentMethodDetails.new()) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 395
def url(action = nil, payment_method_details = PaymentMethodDetails.new())
  base = test? ? test_url : live_url
  resource = action == :store ? 'vaulted-shoppers' : payment_method_details.resource_url
  "#{base}/#{resource}"
end
vaulted_shopper_id(parsed_response, payment_method_details) click to toggle source
# File lib/active_merchant/billing/gateways/blue_snap.rb, line 426
def vaulted_shopper_id(parsed_response, payment_method_details)
  return nil unless parsed_response['content-location-header']
  vaulted_shopper_id = parsed_response['content-location-header'].split('/').last
  vaulted_shopper_id += "|#{payment_method_details.payment_method_type}" if payment_method_details.alt_transaction?
  vaulted_shopper_id
end