Class: Spree::Order

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Checkout
Defined in:
app/models/spree/order.rb,
app/models/spree/order/checkout.rb

Defined Under Namespace

Modules: Checkout

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Checkout

included

Instance Attribute Details

#coupon_code ⇒ Object

Returns the value of attribute coupon_code.



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

def coupon_code
  @coupon_code
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



74
75
76
 
# File 'app/models/spree/order.rb', line 74

def use_billing
  @use_billing
end

Class Method Details

.between(start_date, end_date) ⇒ Object 



93
94
95
 
# File 'app/models/spree/order.rb', line 93

def self.between(start_date, end_date)
  where(created_at: start_date..end_date)
end

.by_customer(customer) ⇒ Object 



97
98
99
 
# File 'app/models/spree/order.rb', line 97

def self.by_customer(customer)
  joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
end

.by_number(number) ⇒ Object 



89
90
91
 
# File 'app/models/spree/order.rb', line 89

def self.by_number(number)
  where(number: number)
end

.by_state(state) ⇒ Object 



101
102
103
 
# File 'app/models/spree/order.rb', line 101

def self.by_state(state)
  where(state: state)
end

.complete ⇒ Object 



105
106
107
 
# File 'app/models/spree/order.rb', line 105

def self.complete
  where("#{quoted_table_name}.completed_at IS NOT NULL")
end

.incomplete ⇒ Object 



109
110
111
 
# File 'app/models/spree/order.rb', line 109

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



115
116
117
 
# File 'app/models/spree/order.rb', line 115

def self.register_update_hook(hook)
  self.update_hooks.add(hook)
end

Instance Method Details

#add_variant(variant, quantity = 1, currency = nil) ⇒ Object 



261
262
263
264
265
 
# File 'app/models/spree/order.rb', line 261

def add_variant(variant, quantity = 1, currency = nil)
  ActiveSupport::Deprecation.warn("[SPREE] Spree::Order#add_variant will be deprecated in Spree 2.1, please use order.contents.add instead.")
  contents.currency = currency unless currency.nil?
  contents.add(variant, quantity)
end

#allow_cancel? ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
251
 
# File 'app/models/spree/order.rb', line 248

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



120
121
122
 
# File 'app/models/spree/order.rb', line 120

def amount
  line_items.inject(0.0) { |sum, li| sum + li.amount }
end

#associate_user!(user) ⇒ Object

Associates the specified user with the order.



274
275
276
277
278
279
280
281
282
283
 
# File 'app/models/spree/order.rb', line 274

def associate_user!(user)
  self.user = user
  self.email = user.email
  self.created_by = user if self.created_by.blank?

  if persisted?
    # immediately persist the changes we just made, but don't use save since we might have an invalid address associated
    self.class.unscoped.where(id: id).update_all(email: user.email, user_id: user.id, created_by_id: self.created_by_id)
  end
end

#available_payment_methods ⇒ Object 



404
405
406
 
# File 'app/models/spree/order.rb', line 404

def available_payment_methods
  @available_payment_methods ||= (PaymentMethod.available(:front_end) + PaymentMethod.available(:both)).uniq
end

#awaiting_returns? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'app/models/spree/order.rb', line 253

def awaiting_returns?
  return_authorizations.any? { |return_authorization| return_authorization.authorized? }
end

#backordered? ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'app/models/spree/order.rb', line 188

def backordered?
  shipments.any?(&:backordered?)
end

#billing_firstname ⇒ Object 



444
445
446
 
# File 'app/models/spree/order.rb', line 444

def billing_firstname
  bill_address.try(:firstname)
end

#billing_lastname ⇒ Object 



448
449
450
 
# File 'app/models/spree/order.rb', line 448

def billing_lastname
  bill_address.try(:lastname)
end

#can_ship? ⇒ Boolean

Returns:

  • (Boolean) 


352
353
354
 
# File 'app/models/spree/order.rb', line 352

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.

Returns:

  • (Boolean) 


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

def checkout_allowed?
  line_items.count > 0
end

#clear_adjustments! ⇒ Object 



489
490
491
492
 
# File 'app/models/spree/order.rb', line 489

def clear_adjustments!
  self.adjustments.destroy_all
  self.line_item_adjustments.destroy_all
end

#clone_billing_address ⇒ Object 



239
240
241
242
243
244
245
246
 
# File 'app/models/spree/order.rb', line 239

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

Returns:

  • (Boolean) 


156
157
158
 
# File 'app/models/spree/order.rb', line 156

def completed?
  completed_at.present? || complete?
end

#confirmation_required? ⇒ Boolean

If true, causes the confirmation step to happen during the checkout process

Returns:

  • (Boolean) 


174
175
176
177
178
179
180
181
 
# File 'app/models/spree/order.rb', line 174

def confirmation_required?
  Spree::Config[:always_include_confirm_step] ||
    payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
    # Little hacky fix for #4117
    # If this wasn't here, order would transition to address state on confirm failure
    # because there would be no valid payments any more.
    state == 'confirm'
end

#contains?(variant) ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
 
# File 'app/models/spree/order.rb', line 305

def contains?(variant)
  find_line_item_by_variant(variant).present?
end

#contents ⇒ Object 



257
258
259
 
# File 'app/models/spree/order.rb', line 257

def contents
  @contents ||= Spree::OrderContents.new(self)
end

#create_proposed_shipments ⇒ Object 



536
537
538
539
540
541
542
543
544
545
546
 
# File 'app/models/spree/order.rb', line 536

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.



334
335
336
 
# File 'app/models/spree/order.rb', line 334

def create_tax_charge!
  Spree::TaxRate.adjust(self)
end

#credit_cards ⇒ Object 



356
357
358
359
 
# File 'app/models/spree/order.rb', line 356

def credit_cards
  credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
  CreditCard.scoped(conditions: { id: credit_card_ids })
end

#currency ⇒ Object 



124
125
126
 
# File 'app/models/spree/order.rb', line 124

def currency
  self[:currency] || Spree::Config[:currency]
end

#deliver_order_confirmation_email ⇒ Object 



390
391
392
393
394
395
396
397
 
# File 'app/models/spree/order.rb', line 390

def deliver_order_confirmation_email
  begin
    OrderMailer.confirm_email(self.id).deliver
  rescue Exception => e
    logger.error("#{e.class.name}: #{e.message}")
    logger.error(e.backtrace * "\n")
  end
end

#display_adjustment_total ⇒ Object 



136
137
138
 
# File 'app/models/spree/order.rb', line 136

def display_adjustment_total
  Spree::Money.new(adjustment_total, { currency: currency })
end

#display_item_total ⇒ Object 



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

def display_item_total
  Spree::Money.new(item_total, { currency: currency })
end

#display_outstanding_balance ⇒ Object 



128
129
130
 
# File 'app/models/spree/order.rb', line 128

def display_outstanding_balance
  Spree::Money.new(outstanding_balance, { currency: currency })
end

#display_ship_total ⇒ Object 



144
145
146
 
# File 'app/models/spree/order.rb', line 144

def display_ship_total
  Spree::Money.new(ship_total, { currency: currency })
end

#display_tax_total ⇒ Object 



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

def display_tax_total
  Spree::Money.new(tax_total, { currency: currency })
end

#display_total ⇒ Object 



148
149
150
 
# File 'app/models/spree/order.rb', line 148

def display_total
  Spree::Money.new(total, { currency: currency })
end

#empty! ⇒ Object 



484
485
486
487
 
# File 'app/models/spree/order.rb', line 484

def empty!
  adjustments.destroy_all
  line_items.destroy_all
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



553
554
555
556
557
558
 
# File 'app/models/spree/order.rb', line 553

def ensure_updated_shipments
  if shipments.any?
    self.shipments.destroy_all
    self.update_column(:state, "address")
  end
end

#exclude_tax? ⇒ Boolean

Indicates whether tax should be backed out of the price calcualtions in cases where prices include tax but the customer is not required to pay taxes in that case.

Returns:

  • (Boolean) 


202
203
204
205
 
# File 'app/models/spree/order.rb', line 202

def exclude_tax?
  return false unless Spree::Config[:prices_inc_tax]
  return tax_zone != Zone.default_tax
end

#finalize! ⇒ Object

Finalizes an in progress order after checkout is complete. Called after transition to complete state when payments will have been processed



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'app/models/spree/order.rb', line 363

def finalize!
  touch :completed_at

  # lock all adjustments (coupon promotions, etc.)
  adjustments.update_all state: 'closed'

  # update payment and shipment(s) states, and save
  updater.update_payment_state
  shipments.each do |shipment|
    shipment.update!(self)
    shipment.finalize!
  end

  updater.update_shipment_state
  save
  updater.run_hooks

  deliver_order_confirmation_email

  self.state_changes.create({
    previous_state: 'cart',
    next_state:     'complete',
    name:           'order' ,
    user_id:        self.user_id
  }, without_protection: true)
end

#find_line_item_by_variant(variant) ⇒ Object 



314
315
316
 
# File 'app/models/spree/order.rb', line 314

def find_line_item_by_variant(variant)
  line_items.detect { |line_item| line_item.variant_id == variant.id }
end

#generate_order_number ⇒ Object

FIXME refactor this method and implement validation using validates_* utilities



286
287
288
289
290
291
292
293
294
 
# File 'app/models/spree/order.rb', line 286

def generate_order_number
  record = true
  while record
    random = "R#{Array.new(9){rand(9)}.join}"
    record = self.class.where(number: random).first
  end
  self.number = random if self.number.blank?
  self.number
end

#has_step?(step) ⇒ Boolean

Returns:

  • (Boolean) 


494
495
496
 
# File 'app/models/spree/order.rb', line 494

def has_step?(step)
  checkout_steps.include?(step)
end

#insufficient_stock_lines ⇒ Object 



460
461
462
 
# File 'app/models/spree/order.rb', line 460

def insufficient_stock_lines
 @insufficient_stock_lines ||= line_items.select(&:insufficient_stock?)
end

#item_count ⇒ Object

Indicates the number of items in the order



184
185
186
 
# File 'app/models/spree/order.rb', line 184

def item_count
  line_items.inject(0) { |sum, li| sum + li.quantity }
end

#line_item_adjustment_totals ⇒ Object

Array of totals grouped by Adjustment#label. Useful for displaying line item adjustments on an invoice. For example, you can display tax breakout for cases where tax is included in price.



215
216
217
218
219
220
 
# File 'app/models/spree/order.rb', line 215

def line_item_adjustment_totals
  Hash[self.line_item_adjustments.eligible.group_by(&:label).map do |label, adjustments|
    total = adjustments.sum(&:amount)
    [label, Spree::Money.new(total, { currency: currency })]
  end]
end

#merge!(order, user = nil) ⇒ Object 



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'app/models/spree/order.rb', line 464

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_id(line_item.variant_id)
    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?

  # So that the destroy doesn't take out line items which may have been re-assigned
  order.line_items.reload
  order.destroy
end

#name ⇒ Object 



346
347
348
349
350
 
# File 'app/models/spree/order.rb', line 346

def name
  if (address = bill_address || ship_address)
    "#{address.firstname} #{address.lastname}"
  end
end

#outstanding_balance ⇒ Object 



338
339
340
 
# File 'app/models/spree/order.rb', line 338

def outstanding_balance
  total - payment_total
end

#outstanding_balance? ⇒ Boolean

Returns:

  • (Boolean) 


342
343
344
 
# File 'app/models/spree/order.rb', line 342

def outstanding_balance?
 self.outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps

Returns:

  • (Boolean) 


400
401
402
 
# File 'app/models/spree/order.rb', line 400

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

Returns:

  • (Boolean) 


169
170
171
 
# File 'app/models/spree/order.rb', line 169

def payment_required?
  total.to_f > 0.0
end

#pending_payments ⇒ Object 



408
409
410
 
# File 'app/models/spree/order.rb', line 408

def pending_payments
  payments.select(&:checkout?)
end

#price_adjustment_totals ⇒ Object 



222
223
224
225
 
# File 'app/models/spree/order.rb', line 222

def price_adjustment_totals
  ActiveSupport::Deprecation.warn("Order#price_adjustment_totals will be deprecated in Spree 2.1, please use Order#line_item_adjustment_totals instead.")
  self.line_item_adjustment_totals
end

#price_adjustments ⇒ Object 



207
208
209
210
 
# File 'app/models/spree/order.rb', line 207

def price_adjustments
  ActiveSupport::Deprecation.warn("Order#price_adjustments will be deprecated in Spree 2.1, please use Order#line_item_adjustments instead.")
  self.line_item_adjustments
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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'app/models/spree/order.rb', line 425

def process_payments!
  if pending_payments.empty?
    raise Core::GatewayError.new Spree.t(:no_pending_payments)
  else
    pending_payments.each do |payment|
      break if payment_total >= total

      payment.process!

      if payment.completed?
        self.payment_total += payment.amount
      end
    end
  end
rescue Core::GatewayError => e
  result = !!Spree::Config[:allow_checkout_on_gateway_error]
  errors.add(:base, e.message) and return result
end

#products ⇒ Object 



452
453
454
 
# File 'app/models/spree/order.rb', line 452

def products
  line_items.map(&:product)
end

#promo_total ⇒ Object 



528
529
530
 
# File 'app/models/spree/order.rb', line 528

def promo_total
  adjustments.eligible.promotion.map(&:amount).sum
end

#promotion_credit_exists?(originator) ⇒ Boolean

Tells us if there if the specified promotion is already associated with the order regardless of whether or not its currently eligible. Useful because generally you would only want a promotion action to apply to order no more than once.

Receives an adjustment originator (here a PromotionAction object) and tells if the order has adjustments from that already

Returns:

  • (Boolean) 


524
525
526
 
# File 'app/models/spree/order.rb', line 524

def promotion_credit_exists?(originator)
  !! adjustments.includes(:originator).promotion.reload.detect { |credit| credit.originator.id == originator.id }
end

#quantity_of(variant) ⇒ Object 



309
310
311
312
 
# File 'app/models/spree/order.rb', line 309

def quantity_of(variant)
  line_item = find_line_item_by_variant(variant)
  line_item ? line_item.quantity : 0
end

#refresh_shipment_rates ⇒ Object 



560
561
562
 
# File 'app/models/spree/order.rb', line 560

def refresh_shipment_rates
  shipments.map &:refresh_rates
end

#remove_invalid_shipments! ⇒ Object

Clear shipment when transitioning to delivery step of checkout if the current shipping address is not eligible for the existing shipping method



328
329
330
 
# File 'app/models/spree/order.rb', line 328

def remove_invalid_shipments!
  shipments.each { |s| s.destroy unless s.shipping_method.available_to_order?(self) }
end

#remove_variant(variant, quantity = 1) ⇒ Object 



268
269
270
271
 
# File 'app/models/spree/order.rb', line 268

def remove_variant(variant, quantity = 1)
  ActiveSupport::Deprecation.warn("[SPREE] Spree::Order#remove_variant will be deprecated in Spree 2.1, please use order.contents.remove instead.")
  contents.remove(variant, quantity)
end

#ship_total ⇒ Object 



318
319
320
 
# File 'app/models/spree/order.rb', line 318

def ship_total
  adjustments.shipping.map(&:amount).sum
end

#shipment ⇒ Object 



296
297
298
299
 
# File 'app/models/spree/order.rb', line 296

def shipment
  ActiveSupport::Deprecation.warn("[SPREE] Spree::Order#shipment is typically incorrect due to multiple shipments and will be deprecated in Spree 2.1, please process Spree::Order#shipments instead.")
  @shipment ||= shipments.last
end

#shipped? ⇒ Boolean

Returns:

  • (Boolean) 


532
533
534
 
# File 'app/models/spree/order.rb', line 532

def shipped?
  %w(partial shipped).include?(shipment_state)
end

#shipped_shipments ⇒ Object 



301
302
303
 
# File 'app/models/spree/order.rb', line 301

def shipped_shipments
  shipments.shipped
end

#state_changed(name) ⇒ Object 



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'app/models/spree/order.rb', line 498

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
      }, :without_protection => true)
    end
  end
end

#tax_total ⇒ Object 



322
323
324
 
# File 'app/models/spree/order.rb', line 322

def tax_total
  adjustments.tax.map(&:amount).sum
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



194
195
196
197
 
# File 'app/models/spree/order.rb', line 194

def tax_zone
  zone_address = Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
  Zone.match(zone_address) || Zone.default_tax
end

#to_param ⇒ Object 



152
153
154
 
# File 'app/models/spree/order.rb', line 152

def to_param
  number.to_s.to_url.upcase
end

#update! ⇒ Object 



231
232
233
 
# File 'app/models/spree/order.rb', line 231

def update!
  updater.update
end

#update_totals ⇒ Object 



235
236
237
 
# File 'app/models/spree/order.rb', line 235

def update_totals
  updater.update_totals
end

#updater ⇒ Object 



227
228
229
 
# File 'app/models/spree/order.rb', line 227

def updater
  @updater ||= OrderUpdater.new(self)
end

#variants ⇒ Object 



456
457
458
 
# File 'app/models/spree/order.rb', line 456

def variants
  line_items.map(&:variant)
end