Class: Spree::Order
- Inherits:
-
Base
- Object
- ActiveRecord::Base
- Base
- Spree::Order
show all
- Includes:
- Checkout, CurrencyUpdater
- Defined in:
- app/models/spree/order.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/currency_updater.rb
Defined Under Namespace
Modules: Checkout, CurrencyUpdater
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!
Methods included from Checkout
included
Methods inherited from Base
page
#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Instance Attribute Details
#coupon_code ⇒ Object
Returns the value of attribute coupon_code.
18
19
20
|
# File 'app/models/spree/order.rb', line 18
def coupon_code
@coupon_code
end
|
#temporary_address ⇒ Object
Returns the value of attribute temporary_address.
19
20
21
|
# File 'app/models/spree/order.rb', line 19
def temporary_address
@temporary_address
end
|
#use_billing ⇒ Object
Returns the value of attribute use_billing.
68
69
70
|
# File 'app/models/spree/order.rb', line 68
def use_billing
@use_billing
end
|
Class Method Details
.by_customer(customer) ⇒ Object
96
97
98
|
# File 'app/models/spree/order.rb', line 96
def self.by_customer(customer)
joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
end
|
.by_number(number) ⇒ Object
87
88
89
|
# File 'app/models/spree/order.rb', line 87
def self.by_number(number)
where(number: number)
end
|
.by_state(state) ⇒ Object
100
101
102
|
# File 'app/models/spree/order.rb', line 100
def self.by_state(state)
where(state: state)
end
|
.complete ⇒ Object
104
105
106
|
# File 'app/models/spree/order.rb', line 104
def self.complete
where.not(completed_at: nil)
end
|
.incomplete ⇒ Object
108
109
110
|
# File 'app/models/spree/order.rb', line 108
def self.incomplete
where(completed_at: nil)
end
|
.register_update_hook(hook) ⇒ Object
Use this method in other gems that wish to register their own custom logic that should be called after Order#update
114
115
116
|
# File 'app/models/spree/order.rb', line 114
def self.register_update_hook(hook)
self.update_hooks.add(hook)
end
|
Instance Method Details
#all_adjustments ⇒ Object
118
119
120
121
|
# File 'app/models/spree/order.rb', line 118
def all_adjustments
Adjustment.where("order_id = :order_id OR (adjustable_id = :order_id AND adjustable_type = 'Spree::Order')",
order_id: self.id)
end
|
#allow_cancel? ⇒ Boolean
232
233
234
235
|
# File 'app/models/spree/order.rb', line 232
def allow_cancel?
return false unless completed? and state != 'canceled'
shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end
|
#amount ⇒ Object
For compatiblity with Calculator::PriceSack
124
125
126
|
# File 'app/models/spree/order.rb', line 124
def amount
line_items.inject(0.0) { |sum, li| sum + li.amount }
end
|
#approve! ⇒ Object
569
570
571
|
# File 'app/models/spree/order.rb', line 569
def approve!
update_column(:considered_risky, false)
end
|
#approved? ⇒ Boolean
551
552
553
|
# File 'app/models/spree/order.rb', line 551
def approved?
!!self.approved_at
end
|
#approved_by(user) ⇒ Object
541
542
543
544
545
546
547
548
549
|
# File 'app/models/spree/order.rb', line 541
def approved_by(user)
self.transaction do
approve!
self.update_columns(
approver_id: user.id,
approved_at: Time.now,
)
end
end
|
#associate_user!(user, override_email = true) ⇒ Object
Associates the specified user with the order.
246
247
248
249
250
251
252
253
254
255
256
257
|
# File 'app/models/spree/order.rb', line 246
def associate_user!(user, override_email = true)
self.user = user
attrs_to_set = { user_id: user.id }
attrs_to_set[:email] = user.email if override_email
attrs_to_set[:created_by_id] = user.id if self.created_by.blank?
assign_attributes(attrs_to_set)
if persisted?
self.class.unscoped.where(id: id).update_all(attrs_to_set)
end
end
|
#available_payment_methods ⇒ Object
#awaiting_returns? ⇒ Boolean
237
238
239
|
# File 'app/models/spree/order.rb', line 237
def awaiting_returns?
return_authorizations.any? { |return_authorization| return_authorization.authorized? }
end
|
#backordered? ⇒ Boolean
200
201
202
|
# File 'app/models/spree/order.rb', line 200
def backordered?
shipments.any?(&:backordered?)
end
|
#billing_firstname ⇒ Object
399
400
401
|
# File 'app/models/spree/order.rb', line 399
def billing_firstname
bill_address.try(:firstname)
end
|
#billing_lastname ⇒ Object
403
404
405
|
# File 'app/models/spree/order.rb', line 403
def billing_lastname
bill_address.try(:lastname)
end
|
#can_add_coupon? ⇒ Boolean
#can_approve? ⇒ Boolean
555
556
557
|
# File 'app/models/spree/order.rb', line 555
def can_approve?
!approved?
end
|
#can_ship? ⇒ Boolean
317
318
319
|
# File 'app/models/spree/order.rb', line 317
def can_ship?
self.complete? || self.resumed? || self.awaiting_return? || self.returned?
end
|
#checkout_allowed? ⇒ Boolean
Indicates whether or not the user is allowed to proceed to checkout. Currently this is implemented as a check for whether or not there is at least one LineItem in the Order. Feel free to override this logic in your own application if you require additional steps before allowing a checkout.
181
182
183
|
# File 'app/models/spree/order.rb', line 181
def checkout_allowed?
line_items.count > 0
end
|
#clone_billing_address ⇒ Object
223
224
225
226
227
228
229
230
|
# File 'app/models/spree/order.rb', line 223
def clone_billing_address
if bill_address and self.ship_address.nil?
self.ship_address = bill_address.clone
else
self.ship_address.attributes = bill_address.attributes.except('id', 'updated_at', 'created_at')
end
true
end
|
#completed? ⇒ Boolean
173
174
175
|
# File 'app/models/spree/order.rb', line 173
def completed?
completed_at.present?
end
|
#confirmation_required? ⇒ Boolean
If true, causes the confirmation step to happen during the checkout process
191
192
193
194
195
196
197
198
|
# File 'app/models/spree/order.rb', line 191
def confirmation_required?
Spree::Config[:always_include_confirm_step] ||
payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
state == 'confirm'
end
|
#consider_risk ⇒ Object
559
560
561
562
563
|
# File 'app/models/spree/order.rb', line 559
def consider_risk
if is_risky? && !approved?
considered_risky!
end
end
|
#considered_risky! ⇒ Object
565
566
567
|
# File 'app/models/spree/order.rb', line 565
def considered_risky!
update_column(:considered_risky, true)
end
|
#contains?(variant) ⇒ Boolean
277
278
279
|
# File 'app/models/spree/order.rb', line 277
def contains?(variant)
find_line_item_by_variant(variant).present?
end
|
#contents ⇒ Object
241
242
243
|
# File 'app/models/spree/order.rb', line 241
def contents
@contents ||= Spree::OrderContents.new(self)
end
|
#create_proposed_shipments ⇒ Object
484
485
486
487
488
489
490
491
492
493
494
|
# File 'app/models/spree/order.rb', line 484
def create_proposed_shipments
adjustments.shipping.delete_all
shipments.destroy_all
packages = Spree::Stock::Coordinator.new(self).packages
packages.each do |package|
shipments << package.to_shipment
end
shipments
end
|
#create_tax_charge! ⇒ Object
Creates new tax charges if there are any applicable rates. If prices already include taxes then price adjustments are created instead.
292
293
294
295
296
297
|
# File 'app/models/spree/order.rb', line 292
def create_tax_charge!
order_tax_zone = self.tax_zone
Spree::TaxRate.adjust(order_tax_zone, line_items)
Spree::TaxRate.adjust(order_tax_zone, shipments) if shipments.any?
end
|
#credit_cards ⇒ Object
321
322
323
324
|
# File 'app/models/spree/order.rb', line 321
def credit_cards
credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|
#currency ⇒ Object
128
129
130
|
# File 'app/models/spree/order.rb', line 128
def currency
self[:currency] || Spree::Config[:currency]
end
|
#deliver_order_confirmation_email ⇒ Object
350
351
352
353
|
# File 'app/models/spree/order.rb', line 350
def deliver_order_confirmation_email
OrderMailer.confirm_email(self.id).deliver
update_column(:confirmation_delivered, true)
end
|
#display_additional_tax_total ⇒ Object
148
149
150
|
# File 'app/models/spree/order.rb', line 148
def display_additional_tax_total
Spree::Money.new(additional_tax_total, { currency: currency })
end
|
#display_adjustment_total ⇒ Object
140
141
142
|
# File 'app/models/spree/order.rb', line 140
def display_adjustment_total
Spree::Money.new(adjustment_total, { currency: currency })
end
|
#display_included_tax_total ⇒ Object
144
145
146
|
# File 'app/models/spree/order.rb', line 144
def display_included_tax_total
Spree::Money.new(included_tax_total, { currency: currency })
end
|
#display_item_total ⇒ Object
136
137
138
|
# File 'app/models/spree/order.rb', line 136
def display_item_total
Spree::Money.new(item_total, { currency: currency })
end
|
#display_outstanding_balance ⇒ Object
132
133
134
|
# File 'app/models/spree/order.rb', line 132
def display_outstanding_balance
Spree::Money.new(outstanding_balance, { currency: currency })
end
|
#display_shipment_total ⇒ Object
Also known as:
display_ship_total
156
157
158
|
# File 'app/models/spree/order.rb', line 156
def display_shipment_total
Spree::Money.new(shipment_total, { currency: currency })
end
|
#display_tax_total ⇒ Object
152
153
154
|
# File 'app/models/spree/order.rb', line 152
def display_tax_total
Spree::Money.new(included_tax_total + additional_tax_total, { currency: currency })
end
|
#display_total ⇒ Object
161
162
163
|
# File 'app/models/spree/order.rb', line 161
def display_total
Spree::Money.new(total, { currency: currency })
end
|
#empty! ⇒ Object
441
442
443
444
445
446
447
448
449
|
# File 'app/models/spree/order.rb', line 441
def empty!
line_items.destroy_all
updater.update_item_count
adjustments.destroy_all
shipments.destroy_all
update_totals
persist_totals
end
|
#ensure_line_items_are_in_stock ⇒ Object
411
412
413
414
415
|
# File 'app/models/spree/order.rb', line 411
def ensure_line_items_are_in_stock
if insufficient_stock_lines.present?
errors.add(:base, Spree.t(:insufficient_stock_lines_present)) and return false
end
end
|
#ensure_updated_shipments ⇒ Object
Clean shipments and make order back to address state
At some point the might need to force the order to transition from address to delivery again so that proper updated shipments are created. e.g. customer goes back from payment step and changes order items
508
509
510
511
512
513
514
|
# File 'app/models/spree/order.rb', line 508
def ensure_updated_shipments
if shipments.any? && !self.completed?
self.shipments.destroy_all
self.update_column(:shipment_total, 0)
restart_checkout_flow
end
end
|
#finalize! ⇒ Object
Finalizes an in progress order after checkout is complete. Called after transition to complete state when payments will have been processed
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
# File 'app/models/spree/order.rb', line 328
def finalize!
all_adjustments.each{|a| a.close}
updater.update_payment_state
shipments.each do |shipment|
shipment.update!(self)
shipment.finalize!
end
updater.update_shipment_state
save
updater.run_hooks
touch :completed_at
deliver_order_confirmation_email unless confirmation_delivered?
consider_risk
end
|
#find_line_item_by_variant(variant) ⇒ Object
286
287
288
|
# File 'app/models/spree/order.rb', line 286
def find_line_item_by_variant(variant)
line_items.detect { |line_item| line_item.variant_id == variant.id }
end
|
#generate_order_number(digits = 9) ⇒ Object
259
260
261
262
263
264
265
266
267
268
269
270
271
|
# File 'app/models/spree/order.rb', line 259
def generate_order_number(digits = 9)
self.number ||= loop do
random = "R#{Array.new(digits){rand(10)}.join}"
if self.class.exists?(number: random)
digits += 1 if self.class.count > (10 ** digits / 2)
else
break random
end
end
end
|
#has_step?(step) ⇒ Boolean
451
452
453
|
# File 'app/models/spree/order.rb', line 451
def has_step?(step)
checkout_steps.include?(step)
end
|
#insufficient_stock_lines ⇒ Object
407
408
409
|
# File 'app/models/spree/order.rb', line 407
def insufficient_stock_lines
line_items.select(&:insufficient_stock?)
end
|
#is_risky? ⇒ Boolean
537
538
539
|
# File 'app/models/spree/order.rb', line 537
def is_risky?
self.payments.risky.count > 0
end
|
#merge!(order, user = nil) ⇒ Object
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
# File 'app/models/spree/order.rb', line 417
def merge!(order, user = nil)
order.line_items.each do |line_item|
next unless line_item.currency == currency
current_line_item = self.line_items.find_by(variant: line_item.variant)
if current_line_item
current_line_item.quantity += line_item.quantity
current_line_item.save
else
line_item.order_id = self.id
line_item.save
end
end
self.associate_user!(user) if !self.user && !user.blank?
updater.update_item_count
updater.update_item_total
updater.persist_totals
order.line_items.reload
order.destroy
end
|
#name ⇒ Object
311
312
313
314
315
|
# File 'app/models/spree/order.rb', line 311
def name
if (address = bill_address || ship_address)
"#{address.firstname} #{address.lastname}"
end
end
|
#outstanding_balance ⇒ Object
299
300
301
302
303
304
305
|
# File 'app/models/spree/order.rb', line 299
def outstanding_balance
if self.state == 'canceled' && self.payments.present? && self.payments.completed.size > 0
-1 * payment_total
else
total - payment_total
end
end
|
#outstanding_balance? ⇒ Boolean
307
308
309
|
# File 'app/models/spree/order.rb', line 307
def outstanding_balance?
self.outstanding_balance != 0
end
|
#paid? ⇒ Boolean
Helper methods for checkout steps
356
357
358
|
# File 'app/models/spree/order.rb', line 356
def paid?
payment_state == 'paid' || payment_state == 'credit_owed'
end
|
#payment_required? ⇒ Boolean
Is this a free order in which case the payment step should be skipped
186
187
188
|
# File 'app/models/spree/order.rb', line 186
def payment_required?
total.to_f > 0.0
end
|
#pending_payments ⇒ Object
364
365
366
|
# File 'app/models/spree/order.rb', line 364
def pending_payments
payments.select { |payment| payment.checkout? || payment.pending? }
end
|
#process_payments! ⇒ Object
processes any pending payments and must return a boolean as it’s return value is used by the checkout state_machine to determine success or failure of the ‘complete’ event for the order
Returns:
-
true if all pending_payments processed successfully
-
true if a payment failed, ie. raised a GatewayError which gets rescued and converted to TRUE when :allow_checkout_gateway_error is set to true
-
false if a payment failed, ie. raised a GatewayError which gets rescued and converted to FALSE when :allow_checkout_on_gateway_error is set to false
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
# File 'app/models/spree/order.rb', line 384
def process_payments!
pending_payments.each do |payment|
break if payment_total >= total
payment.process!
if payment.completed?
self.payment_total += payment.amount
end
end
rescue Core::GatewayError => e
result = !!Spree::Config[:allow_checkout_on_gateway_error]
errors.add(:base, e.message) and return result
end
|
#quantity ⇒ Object
595
596
597
|
# File 'app/models/spree/order.rb', line 595
def quantity
line_items.sum(:quantity)
end
|
#quantity_of(variant) ⇒ Object
281
282
283
284
|
# File 'app/models/spree/order.rb', line 281
def quantity_of(variant)
line_item = find_line_item_by_variant(variant)
line_item ? line_item.quantity : 0
end
|
#refresh_shipment_rates ⇒ Object
523
524
525
|
# File 'app/models/spree/order.rb', line 523
def refresh_shipment_rates
shipments.map &:refresh_rates
end
|
#reload(options = nil) ⇒ Object
586
587
588
589
|
# File 'app/models/spree/order.rb', line 586
def reload(options=nil)
remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
super
end
|
#restart_checkout_flow ⇒ Object
516
517
518
519
520
521
|
# File 'app/models/spree/order.rb', line 516
def restart_checkout_flow
self.update_columns(
state: checkout_steps.first,
updated_at: Time.now,
)
end
|
#set_shipments_cost ⇒ Object
531
532
533
534
535
|
# File 'app/models/spree/order.rb', line 531
def set_shipments_cost
shipments.each(&:update_amounts)
updater.update_shipment_total
persist_totals
end
|
#shipped? ⇒ Boolean
480
481
482
|
# File 'app/models/spree/order.rb', line 480
def shipped?
%w(partial shipped).include?(shipment_state)
end
|
#shipped_shipments ⇒ Object
273
274
275
|
# File 'app/models/spree/order.rb', line 273
def shipped_shipments
shipments.shipped
end
|
#shipping_discount ⇒ Object
165
166
167
|
# File 'app/models/spree/order.rb', line 165
def shipping_discount
shipment_adjustments.eligible.sum(:amount) * - 1
end
|
#shipping_eq_billing_address? ⇒ Boolean
527
528
529
|
# File 'app/models/spree/order.rb', line 527
def shipping_eq_billing_address?
(bill_address.empty? && ship_address.empty?) || bill_address.same_as?(ship_address)
end
|
#state_changed(name) ⇒ Object
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
# File 'app/models/spree/order.rb', line 455
def state_changed(name)
state = "#{name}_state"
if persisted?
old_state = self.send("#{state}_was")
new_state = self.send(state)
unless old_state == new_state
self.state_changes.create(
previous_state: old_state,
next_state: new_state,
name: name,
user_id: self.user_id
)
end
end
end
|
#tax_address ⇒ Object
Returns the address for taxation based on configuration
211
212
213
|
# File 'app/models/spree/order.rb', line 211
def tax_address
Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end
|
#tax_total ⇒ Object
591
592
593
|
# File 'app/models/spree/order.rb', line 591
def tax_total
included_tax_total + additional_tax_total
end
|
#tax_zone ⇒ Object
Returns the relevant zone (if any) to be used for taxation purposes. Uses default tax zone unless there is a specific match
206
207
208
|
# File 'app/models/spree/order.rb', line 206
def tax_zone
@tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end
|
#to_param ⇒ Object
169
170
171
|
# File 'app/models/spree/order.rb', line 169
def to_param
number.to_s.to_url.upcase
end
|
#update! ⇒ Object
219
220
221
|
# File 'app/models/spree/order.rb', line 219
def update!
updater.update
end
|
#update_line_items(line_item_params) ⇒ Object
moved from api order_decorator. This is a better place for it.
574
575
576
577
578
579
580
581
582
583
584
|
# File 'app/models/spree/order.rb', line 574
def update_line_items(line_item_params)
return if line_item_params.blank?
line_item_params.each_value do |attributes|
if attributes[:id].present?
self.line_items.find(attributes[:id]).update_attributes!(attributes)
else
self.line_items.create!(attributes)
end
end
self.ensure_updated_shipments
end
|
#updater ⇒ Object
215
216
217
|
# File 'app/models/spree/order.rb', line 215
def updater
@updater ||= OrderUpdater.new(self)
end
|