Class: Spree::StoreCredit

Inherits:
Object
  • Object
show all
Extended by:
DisplayMoney
Includes:
Metadata, SingleStoreResource, Webhooks::HasWebhooks
Defined in:
app/models/spree/store_credit.rb

Constant Summary collapse

VOID_ACTION = 
'void'.freeze
CANCEL_ACTION = 
'cancel'.freeze
CREDIT_ACTION = 
'credit'.freeze
CAPTURE_ACTION = 
'capture'.freeze
ELIGIBLE_ACTION = 
'eligible'.freeze
AUTHORIZE_ACTION = 
'authorize'.freeze
ALLOCATION_ACTION = 
'allocation'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



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

def action
  @action
end

#action_amount ⇒ Object

Returns the value of attribute action_amount.



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

def action_amount
  @action_amount
end

#action_authorization_code ⇒ Object

Returns the value of attribute action_authorization_code.



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

def action_authorization_code
  @action_authorization_code
end

#action_originator ⇒ Object

Returns the value of attribute action_originator.



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

def action_originator
  @action_originator
end

Class Method Details

.default_created_by ⇒ Object 



187
188
189
190
191
 
# File 'app/models/spree/store_credit.rb', line 187

def default_created_by
  Spree::Deprecation.warn('StoreCredit#default_created_by is deprecated and will be removed in Spree 6.0. Please use store.users.first instead.')

  Spree::Store.current.users.first
end

Instance Method Details

#actions ⇒ Object 



158
159
160
 
# File 'app/models/spree/store_credit.rb', line 158

def actions
  [CAPTURE_ACTION, VOID_ACTION, CREDIT_ACTION]
end

#amount_remaining ⇒ Object 



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

def amount_remaining
  amount - amount_used - amount_authorized
end

#authorize(amount, order_currency, options = {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'app/models/spree/store_credit.rb', line 62

def authorize(amount, order_currency, options = {})
  authorization_code = options[:action_authorization_code]
  if authorization_code
    if store_credit_events.find_by(action: AUTHORIZE_ACTION, authorization_code: authorization_code)
      # Don't authorize again on capture
      return true
    end
  else
    authorization_code = generate_authorization_code
  end
  if validate_authorization(amount, order_currency)
    update!(
      action: AUTHORIZE_ACTION,
      action_amount: amount,
      action_originator: options[:action_originator],
      action_authorization_code: authorization_code,
      amount_authorized: amount_authorized + amount
    )
    authorization_code
  else
    errors.add(:base, Spree.t('store_credit_payment_method.insufficient_authorized_amount'))
    false
  end
end

#can_be_deleted? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'app/models/spree/store_credit.rb', line 178

def can_be_deleted?
  amount_used.zero? && amount_authorized.zero?
end

#can_capture?(payment) ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'app/models/spree/store_credit.rb', line 162

def can_capture?(payment)
  payment.pending? || payment.checkout?
end

#can_credit?(payment) ⇒ Boolean

Returns:

  • (Boolean) 


170
171
172
 
# File 'app/models/spree/store_credit.rb', line 170

def can_credit?(payment)
  payment.completed? && payment.credit_allowed > 0
end

#can_void?(payment) ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
 
# File 'app/models/spree/store_credit.rb', line 166

def can_void?(payment)
  payment.pending? || (payment.checkout? && !payment.order.completed?)
end

#capture(amount, authorization_code, order_currency, options = {}) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'app/models/spree/store_credit.rb', line 96

def capture(amount, authorization_code, order_currency, options = {})
  return false unless authorize(amount, order_currency, action_authorization_code: authorization_code)

  if amount <= amount_authorized
    if currency != order_currency
      errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
      false
    else
      update!(
        action: CAPTURE_ACTION,
        action_amount: amount,
        action_originator: options[:action_originator],
        action_authorization_code: authorization_code,
        amount_used: amount_used + amount,
        amount_authorized: amount_authorized - amount
      )
      authorization_code
    end
  else
    errors.add(:base, Spree.t('store_credit_payment_method.insufficient_authorized_amount'))
    false
  end
end

#credit(amount, authorization_code, order_currency, options = {}) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'app/models/spree/store_credit.rb', line 136

def credit(amount, authorization_code, order_currency, options = {})
  # Find the amount related to this authorization_code in order to add the store credit back
  capture_event = store_credit_events.find_by(action: CAPTURE_ACTION, authorization_code: authorization_code)

  if currency != order_currency # sanity check to make sure the order currency hasn't changed since the auth
    errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
    false
  elsif capture_event && amount <= capture_event.amount
    action_attributes = {
      action: CREDIT_ACTION,
      action_amount: amount,
      action_originator: options[:action_originator],
      action_authorization_code: authorization_code
    }
    create_credit_record(amount, action_attributes)
    true
  else
    errors.add(:base, Spree.t('store_credit_payment_method.unable_to_credit', auth_code: authorization_code))
    false
  end
end

#editable? ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'app/models/spree/store_credit.rb', line 174

def editable?
  amount_used.zero? && amount_authorized.zero?
end

#generate_authorization_code ⇒ Object 



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

def generate_authorization_code
  "#{id}-SC-#{Time.now.utc.strftime('%Y%m%d%H%M%S%6N')}"
end

#validate_authorization(amount, order_currency) ⇒ Object 



87
88
89
90
91
92
93
94
 
# File 'app/models/spree/store_credit.rb', line 87

def validate_authorization(amount, order_currency)
  if BigDecimal(amount_remaining, 3) < BigDecimal(amount, 3)
    errors.add(:base, Spree.t('store_credit_payment_method.insufficient_funds'))
  elsif currency != order_currency
    errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
  end
  errors.blank?
end

#void(authorization_code, options = {}) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'app/models/spree/store_credit.rb', line 120

def void(authorization_code, options = {})
  if auth_event = store_credit_events.find_by(action: AUTHORIZE_ACTION, authorization_code: authorization_code)
    update!(
      action: VOID_ACTION,
      action_amount: auth_event.amount,
      action_authorization_code: authorization_code,
      action_originator: options[:action_originator],
      amount_authorized: amount_authorized - auth_event.amount
    )
    true
  else
    errors.add(:base, Spree.t('store_credit_payment_method.unable_to_void', auth_code: authorization_code))
    false
  end
end