Module: WebpayRails::Base::ClassMethods

Defined in:
lib/webpay_rails/base.rb

Instance Method Summary collapse

Instance Method Details

#acknowledge_transaction(args) ⇒ Object

Reports the correct reception of the result of the transaction If fault a WebpayRails::RequestFailed exception is raised. If the SOAP response cant be verified a WebpayRails::InvalidCertificate exception is raised.

Arguments

:token

An string that responds Webpay when redirect to return_url.

NOTE: It is not necessary to use this method because it is consumed by transaction_result.



101
102
103
 
# File 'lib/webpay_rails/base.rb', line 101

def acknowledge_transaction(args)
  soap_normal.acknowledge_transaction(args)
end

#init_transaction(args) ⇒ Object

Initializes a transaction Returns a WebpayRails::Transaction if successfully initialised. If fault a WebpayRails::RequestFailed exception is raised. If the SOAP response cant be verified a WebpayRails::InvalidCertificate exception is raised.

Arguments

:amount

An integer that define the amount of the transaction.

:buy_order

An string that define the order number of the buy.

:session_id

An string that define a local variable that will be returned as part of the result of the transaction.

:return_url

An string that define the url that Webpay redirect after client is authorized (or not) by the bank for get the result of the transaction.

:final_url

An string that define the url that Webpay redirect after they show the webpay invoice, or cancel the transaction from Webpay.



64
65
66
67
68
 
# File 'lib/webpay_rails/base.rb', line 64

def init_transaction(args)
  response = soap_normal.init_transaction(args)

  WebpayRails::Transaction.new(response)
end

#nullify(args) ⇒ Object

Nullify a transaction Returns a WebpayRails::TransactionNullified if successfully initialised. If fault a WebpayRails::RequestFailed exception is raised. If the SOAP response cant be verified a WebpayRails::InvalidCertificate exception is raised.

Arguments

:authorization_code

An string that original belongs to the transaction.

:authorize_amount

An integer that define the original amount of the transaction.

:buy_order

An string that define the order number of the transaction to be nullified.

:nullify_amount

An intenger that define the amount to be nullified on the transaction.



121
122
123
124
125
 
# File 'lib/webpay_rails/base.rb', line 121

def nullify(args)
  response = soap_nullify.nullify(args)

  WebpayRails::TransactionNullified.new(response)
end

#transaction_result(args) ⇒ Object

Retrieves the result of a transaction Returns a WebpayRails::TransactionResult if successfully get a response. If fault a WebpayRails::RequestFailed exception is raised. If the SOAP response cant be verified a WebpayRails::InvalidCertificate exception is raised.

Arguments

:token

An string that responds Webpay when redirect to return_url.

:ack

An optional boolean with which you can disable the auto acknowledgement (I guess if you do this, you will know what you do).



82
83
84
85
86
87
88
 
# File 'lib/webpay_rails/base.rb', line 82

def transaction_result(args)
  response = soap_normal.get_transaction_result(args)

  acknowledge_transaction(args) if args[:ack] != false

  WebpayRails::TransactionResult.new(response)
end

#webpay_rails(args) ⇒ Object

Setup a model for use Webpay Rails.

Variations of #webpay_rails

# setup with certificates and private_key content
webpay_rails(
  commerce_code: 123456789,
  private_key: '-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----',
  public_cert: '-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----',
  webpay_cert: '-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----',
  environment: :integration,
  log: true
)

# setup with certificates and private_key files
webpay_rails(
  commerce_code: 123456789,
  private_key: 'absolute/path/to/private_key.key',
  public_cert: 'absolute/path/to/public_cert.crt',
  webpay_cert: 'absolute/path/to/webpay_cert.crt',
  environment: :integration,
  log: true
)



35
36
37
38
39
40
41
42
 
# File 'lib/webpay_rails/base.rb', line 35

def webpay_rails(args)
  class_attribute :vault, :soap_normal, :soap_nullify,
                  instance_accessor: false

  self.vault = args[:vault] = WebpayRails::Vault.new(args)
  self.soap_normal = WebpayRails::SoapNormal.new(args)
  self.soap_nullify = WebpayRails::SoapNullify.new(args)
end