Class: Spree::Payment
- Inherits:
-
Base
- Object
- ApplicationRecord
- Base
- Spree::Payment
show all
- Includes:
- NumberAsParam, Processing
- Defined in:
- app/models/spree/payment.rb,
app/models/spree/payment/processing.rb,
app/models/spree/payment/gateway_options.rb
Defined Under Namespace
Modules: Processing
Classes: GatewayOptions
Constant Summary
collapse
- NON_RISKY_AVS_CODES =
['B', 'D', 'H', 'J', 'M', 'Q', 'T', 'V', 'X', 'Y'].freeze
- RISKY_AVS_CODES =
['A', 'C', 'E', 'F', 'G', 'I', 'K', 'L', 'N', 'O', 'P', 'R', 'S', 'U', 'W', 'Z'].freeze
- INVALID_STATES =
%w(failed invalid).freeze
Instance Attribute Summary collapse
Instance Method Summary
collapse
#to_param
Methods included from Processing
#authorize!, #cancel!, #capture!, #gateway_options, #process!, #purchase!, #void_transaction!
Methods inherited from Base
belongs_to_required_by_default, page, spree_base_scopes
#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Instance Attribute Details
#capture_on_dispatch ⇒ Object
Returns the value of attribute capture_on_dispatch.
40
41
42
|
# File 'app/models/spree/payment.rb', line 40
def capture_on_dispatch
@capture_on_dispatch
end
|
#request_env ⇒ Object
Returns the value of attribute request_env.
40
41
42
|
# File 'app/models/spree/payment.rb', line 40
def request_env
@request_env
end
|
#source_attributes ⇒ Object
Returns the value of attribute source_attributes.
40
41
42
|
# File 'app/models/spree/payment.rb', line 40
def source_attributes
@source_attributes
end
|
Instance Method Details
#actions ⇒ Object
151
152
153
154
155
|
# File 'app/models/spree/payment.rb', line 151
def actions
return [] unless payment_source&.respond_to?(:actions)
payment_source.actions.select { |action| !payment_source.respond_to?("can_#{action}?") || payment_source.send("can_#{action}?", self) }
end
|
#amount=(amount) ⇒ Object
118
119
120
121
122
123
124
125
126
|
# File 'app/models/spree/payment.rb', line 118
def amount=(amount)
self[:amount] =
case amount
when String
separator = I18n.t('number.currency.format.separator')
number = amount.delete("^0-9-#{separator}\.").tr(separator, '.')
number.to_d if number.present?
end || amount
end
|
#build_source ⇒ Object
141
142
143
144
145
146
147
148
149
|
# File 'app/models/spree/payment.rb', line 141
def build_source
return unless new_record?
if source_attributes.present? && source.blank? && payment_method.try(:payment_source_class)
self.source = payment_method.payment_source_class.new(source_attributes)
source.payment_method_id = payment_method.id
source.user_id = order.user_id if order
end
end
|
#can_credit? ⇒ Boolean
136
137
138
|
# File 'app/models/spree/payment.rb', line 136
def can_credit?
credit_allowed > 0
end
|
#captured_amount ⇒ Object
176
177
178
|
# File 'app/models/spree/payment.rb', line 176
def captured_amount
capture_events.sum(:amount)
end
|
#credit_allowed ⇒ Object
132
133
134
|
# File 'app/models/spree/payment.rb', line 132
def credit_allowed
amount - (offsets_total.abs + refunds.sum(:amount))
end
|
#editable? ⇒ Boolean
184
185
186
|
# File 'app/models/spree/payment.rb', line 184
def editable?
checkout? || pending?
end
|
#is_avs_risky? ⇒ Boolean
162
163
164
165
166
|
# File 'app/models/spree/payment.rb', line 162
def is_avs_risky?
return false if avs_response.blank? || NON_RISKY_AVS_CODES.include?(avs_response)
true
end
|
#is_cvv_risky? ⇒ Boolean
168
169
170
171
172
173
174
|
# File 'app/models/spree/payment.rb', line 168
def is_cvv_risky?
return false if cvv_response_code == 'M'
return false if cvv_response_code.nil?
return false if cvv_response_message.present?
true
end
|
#money ⇒ Object
Also known as:
display_amount
113
114
115
|
# File 'app/models/spree/payment.rb', line 113
def money
Spree::Money.new(amount, currency: currency)
end
|
#offsets_total ⇒ Object
128
129
130
|
# File 'app/models/spree/payment.rb', line 128
def offsets_total
offsets.sum(:amount)
end
|
#payment_source ⇒ Object
157
158
159
160
|
# File 'app/models/spree/payment.rb', line 157
def payment_source
res = source.is_a?(Payment) ? source.source : source
res || payment_method
end
|
#transaction_id ⇒ Object
transaction_id is much easier to understand
68
69
70
|
# File 'app/models/spree/payment.rb', line 68
def transaction_id
response_code
end
|
#uncaptured_amount ⇒ Object
180
181
182
|
# File 'app/models/spree/payment.rb', line 180
def uncaptured_amount
amount - captured_amount
end
|