Class: Spree::PaymentMethod

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/payment_method.rb

Direct Known Subclasses

BillingIntegration, Gateway, Check

Defined Under Namespace

Classes: Check

Constant Summary collapse

DISPLAY =
[:both, :front_end, :back_end]

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Spree::Preferences::Preferable

#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Class Method Details

.active?Boolean


37
38
39
# File 'app/models/spree/payment_method.rb', line 37

def self.active?
  where(type: self.to_s, environment: Rails.env, active: true).count > 0
end

.available(display_on = 'both') ⇒ Object


29
30
31
32
33
34
35
# File 'app/models/spree/payment_method.rb', line 29

def self.available(display_on = 'both')
  all.select do |p|
    p.active &&
    (p.display_on == display_on.to_s || p.display_on.blank?) &&
    (p.environment == Rails.env || p.environment.blank?)
  end
end

.find_with_destroyed(*args) ⇒ Object


45
46
47
# File 'app/models/spree/payment_method.rb', line 45

def self.find_with_destroyed *args
  unscoped { find(*args) }
end

.providersObject


14
15
16
# File 'app/models/spree/payment_method.rb', line 14

def self.providers
  Rails.application.config.spree.payment_methods
end

Instance Method Details

#auto_capture?Boolean


63
64
65
# File 'app/models/spree/payment_method.rb', line 63

def auto_capture?
  self.auto_capture.nil? ? Spree::Config[:auto_capture] : self.auto_capture
end

#cancel(response) ⇒ Object

Raises:

  • (::NotImplementedError)

71
72
73
# File 'app/models/spree/payment_method.rb', line 71

def cancel(response)
  raise ::NotImplementedError, 'You must implement cancel method for this payment method.'
end

#method_typeObject


41
42
43
# File 'app/models/spree/payment_method.rb', line 41

def method_type
  type.demodulize.downcase
end

#payment_profiles_supported?Boolean


49
50
51
# File 'app/models/spree/payment_method.rb', line 49

def payment_profiles_supported?
  false
end

#payment_source_classObject

The class that will process payments for this payment type, used for @payment.source e.g. CreditCard in the case of a the Gateway payment type nil means the payment method doesn't require a source e.g. check

Raises:

  • (::NotImplementedError)

25
26
27
# File 'app/models/spree/payment_method.rb', line 25

def payment_source_class
  raise ::NotImplementedError, 'You must implement payment_source_class method for this gateway.'
end

#provider_classObject

Raises:

  • (::NotImplementedError)

18
19
20
# File 'app/models/spree/payment_method.rb', line 18

def provider_class
  raise ::NotImplementedError, 'You must implement provider_class method for this gateway.'
end

#reusable_sources(order) ⇒ Object

Custom gateways should redefine this method. See Gateway implementation as an example


59
60
61
# File 'app/models/spree/payment_method.rb', line 59

def reusable_sources(order)
  []
end

#source_required?Boolean


53
54
55
# File 'app/models/spree/payment_method.rb', line 53

def source_required?
  true
end

#supports?(source) ⇒ Boolean


67
68
69
# File 'app/models/spree/payment_method.rb', line 67

def supports?(source)
  true
end