Class: Spree::PaymentMethod

Inherits:
ActiveRecord::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

Class Method Details

.active? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'app/models/spree/payment_method.rb', line 34

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

.available(display_on = 'both') ⇒ Object 



26
27
28
29
30
31
32
 
# File 'app/models/spree/payment_method.rb', line 26

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 



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

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

.providers ⇒ Object 



11
12
13
 
# File 'app/models/spree/payment_method.rb', line 11

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

Instance Method Details

#auto_capture? ⇒ Boolean

Returns:

  • (Boolean) 


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

def auto_capture?
  Spree::Config[:auto_capture]
end

#destroy ⇒ Object 



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

def destroy
  touch :deleted_at
end

#method_type ⇒ Object 



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

def method_type
  type.demodulize.downcase
end

#payment_profiles_supported? ⇒ Boolean

Returns:

  • (Boolean) 


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

def payment_profiles_supported?
  false
end

#payment_source_class ⇒ Object

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



22
23
24
 
# File 'app/models/spree/payment_method.rb', line 22

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

#provider_class ⇒ Object 



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

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

#source_required? ⇒ Boolean

Returns:

  • (Boolean) 


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

def source_required?
  true
end

#supports?(source) ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports?(source)
  true
end