Class: Spree::Payment

Inherits:
Base
  • Object
show all
Includes:
Processing
Defined in:
app/models/spree/payment.rb,
app/models/spree/payment/processing.rb,
app/models/spree/payment/cancellation.rb

Overview

Manage and process a payment for an order, from a specific source (e.g. `Spree::CreditCard`) using a specific payment method (e.g `Solidus::Gateway::Braintree`).

Defined Under Namespace

Modules: Processing Classes: Cancellation

Constant Summary

IDENTIFIER_CHARS =
(('A'..'Z').to_a + ('0'..'9').to_a - %w(0 1 I O)).freeze
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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Processing

#authorize!, #cancel!, #capture!, #gateway_options, #process!, #purchase!, #void_transaction!

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Spree::Preferences::Preferable

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

Instance Attribute Details

#request_envObject

Returns the value of attribute request_env



39
40
41
# File 'app/models/spree/payment.rb', line 39

def request_env
  @request_env
end

Instance Method Details

#actionsArray<String>

Returns the actions available on this payment

Returns:

  • (Array<String>)

    the actions available on this payment



150
151
152
153
154
# File 'app/models/spree/payment.rb', line 150

def actions
  sa = source_actions
  sa |= ["failure"] if processing?
  sa
end

#amount=(amount) ⇒ Object

Sets the amount, parsing it based on i18n settings if it is a string.

Parameters:

  • amount (BigDecimal, String)

    the desired new amount



119
120
121
122
123
124
125
126
127
# File 'app/models/spree/payment.rb', line 119

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

#can_credit?Boolean

Returns true when this payment can be credited

Returns:

  • (Boolean)

    true when this payment can be credited



145
146
147
# File 'app/models/spree/payment.rb', line 145

def can_credit?
  credit_allowed > 0
end

#captured_amountBigDecimal

Returns the total amount captured on this payment

Returns:

  • (BigDecimal)

    the total amount captured on this payment



177
178
179
# File 'app/models/spree/payment.rb', line 177

def captured_amount
  capture_events.sum(:amount)
end

#credit_allowedBigDecimal

The total amount this payment can be credited.

Returns:

  • (BigDecimal)

    the amount of this payment minus the offsets (old-style refunds) and refunds



140
141
142
# File 'app/models/spree/payment.rb', line 140

def credit_allowed
  amount - (offsets_total.abs + refunds.sum(:amount))
end

#currencyString

Returns this payment's currency

Returns:

  • (String)

    this payment's currency



108
# File 'app/models/spree/payment.rb', line 108

delegate :currency, to: :order

#is_avs_risky?Boolean

Returns true when this payment is risky based on address

Returns:

  • (Boolean)

    true when this payment is risky based on address



163
164
165
166
# File 'app/models/spree/payment.rb', line 163

def is_avs_risky?
  return false if avs_response.blank? || NON_RISKY_AVS_CODES.include?(avs_response)
  true
end

#is_cvv_risky?Boolean

Returns true when this payment is risky based on cvv

Returns:

  • (Boolean)

    true when this payment is risky based on cvv



169
170
171
172
173
174
# File 'app/models/spree/payment.rb', line 169

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

#moneySpree::Money Also known as: display_amount

Returns this amount of this payment as money object

Returns:

  • (Spree::Money)

    this amount of this payment as money object



111
112
113
# File 'app/models/spree/payment.rb', line 111

def money
  Spree::Money.new(amount, { currency: currency })
end

#offsets_totalBigDecimal

The total amount of the offsets (for old-style refunds) for this payment.

Returns:

  • (BigDecimal)

    the total amount of this payment's offsets



132
133
134
# File 'app/models/spree/payment.rb', line 132

def offsets_total
  offsets.pluck(:amount).sum
end

#payment_sourceObject

Returns the source of ths payment

Returns:

  • (Object)

    the source of ths payment



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

#store_credit?Boolean

Returns true when the payment method exists and is a store credit payment method

Returns:

  • (Boolean)

    true when the payment method exists and is a store credit payment method



187
188
189
# File 'app/models/spree/payment.rb', line 187

def store_credit?
  payment_method.try!(:store_credit?)
end

#transaction_idString

Returns this payment's response code

Returns:

  • (String)

    this payment's response code



103
104
105
# File 'app/models/spree/payment.rb', line 103

def transaction_id
  response_code
end

#uncaptured_amountBigDecimal

Returns the total amount left uncaptured on this payment

Returns:

  • (BigDecimal)

    the total amount left uncaptured on this payment



182
183
184
# File 'app/models/spree/payment.rb', line 182

def uncaptured_amount
  amount - captured_amount
end