Class: Spree::PaymentSource
- Defined in:
- app/models/spree/payment_source.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#imported ⇒ Object
Returns the value of attribute imported.
Instance Method Summary collapse
-
#actions ⇒ Array<String>
The actions available on this payment source.
-
#can_capture?(payment) ⇒ Boolean
True when the payment is in the pending or checkout states.
-
#can_credit?(payment) ⇒ Boolean
Indicates whether its possible to credit the payment.
-
#can_void?(payment) ⇒ Boolean
True when the payment is not failed or voided.
-
#reusable? ⇒ Boolean
Indicates whether this payment source can be used more than once.
Methods inherited from Base
display_includes, #initialize_preference_defaults, page, preference
Methods included from Spree::Preferences::Preferable
#admin_form_preference_names, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Instance Attribute Details
#imported ⇒ Object
Returns the value of attribute imported.
12 13 14 |
# File 'app/models/spree/payment_source.rb', line 12 def imported @imported end |
Instance Method Details
#actions ⇒ Array<String>
Returns the actions available on this payment source.
15 16 17 |
# File 'app/models/spree/payment_source.rb', line 15 def actions %w(capture void credit) end |
#can_capture?(payment) ⇒ Boolean
Returns true when the payment is in the pending or checkout states.
21 22 23 |
# File 'app/models/spree/payment_source.rb', line 21 def can_capture?(payment) payment.pending? || payment.checkout? end |
#can_credit?(payment) ⇒ Boolean
Indicates whether its possible to credit the payment. Note that most gateways require that the payment be settled first which generally happens within 12-24 hours of the transaction.
37 38 39 |
# File 'app/models/spree/payment_source.rb', line 37 def can_credit?(payment) payment.completed? && payment.credit_allowed > 0 end |
#can_void?(payment) ⇒ Boolean
Returns true when the payment is not failed or voided.
27 28 29 |
# File 'app/models/spree/payment_source.rb', line 27 def can_void?(payment) !payment.failed? && !payment.void? end |
#reusable? ⇒ Boolean
Indicates whether this payment source can be used more than once. E.g. a credit card with a ‘payment profile’.
43 44 45 |
# File 'app/models/spree/payment_source.rb', line 43 def reusable? false end |