Class: ActiveMerchant::Billing::InspireGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/inspire.rb

Constant Summary

Constant Summary

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary (collapse)

Methods inherited from Gateway

card_brand, #card_brand, inherited, supports?, #test?

Methods included from CreditCardFormatting

#format

Constructor Details

- (InspireGateway) initialize(options = {})

Creates a new InspireGateway

The gateway requires that a valid login and password be passed in the options hash.

Options

  • :login – The Inspire Username.

  • :password – The Inspire Passowrd.

See the Inspire Integration Guide for details. (default: false)



22
23
24
25
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 22

def initialize(options = {})
  requires!(options, :login, :password)
  super
end

Instance Method Details

- (Object) authorize(money, creditcard, options = {})

Pass :store => true in the options to store the payment info at Inspire Gateway and get a generated customer_vault_id in the response. Pass :store => some_number_or_string to specify the customer_vault_id InspireGateway should use (make sure it's unique).



33
34
35
36
37
38
39
40
41
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 33

def authorize(money, creditcard, options = {})
  post = {}
  add_invoice(post, options)
  add_payment_source(post, creditcard,options)
  add_address(post, creditcard, options)
  add_customer_data(post, options)

  commit('auth', money, post)
end

- (Object) capture(money, authorization, options = {})



53
54
55
56
57
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 53

def capture(money, authorization, options = {})
  post ={}
  post[:transactionid] = authorization
  commit('capture', money, post)
end

- (Object) delete(vault_id) Also known as: unstore



79
80
81
82
83
84
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 79

def delete(vault_id)
  post = {}
  post[:customer_vault] = "delete_customer"
  add_customer_vault_id(post, vault_id)
  commit(nil, nil, post)
end

- (Object) purchase(money, payment_source, options = {})



43
44
45
46
47
48
49
50
51
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 43

def purchase(money, payment_source, options = {})
  post = {}
  add_invoice(post, options)
  add_payment_source(post, payment_source, options)
  add_address(post, payment_source, options)
  add_customer_data(post, options)

  commit('sale', money, post)
end

- (Object) store(creditcard, options = {})

To match the other stored-value gateways, like TrustCommerce, store and unstore need to be defined



88
89
90
91
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 88

def store(creditcard, options = {})
  billing_id = options.delete(:billing_id).to_s || true
  authorize(100, creditcard, options.merge(:store => billing_id))
end

- (Object) update(vault_id, creditcard, options = {})

Update the values (such as CC expiration) stored at InspireGateway. The CC number must be supplied in the CreditCard object.



68
69
70
71
72
73
74
75
76
77
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 68

def update(vault_id, creditcard, options = {})
  post = {}
  post[:customer_vault] = "update_customer"
  add_customer_vault_id(post, vault_id)
  add_creditcard(post, creditcard, options)
  add_address(post, creditcard, options)
  add_customer_data(post, options)

  commit(nil, nil, post)
end

- (Object) void(authorization, options = {})



59
60
61
62
63
# File 'lib/active_merchant/billing/gateways/inspire.rb', line 59

def void(authorization, options = {})
  post ={}
  post[:transactionid] = authorization
  commit('void', nil, post)
end