Class: Spree::Shipment

Inherits:
Object
  • Object
show all
Extended by:
DisplayMoney
Includes:
Metadata, NumberAsParam, NumberIdentifier, Spree::Security::Shipments, Emails, Webhooks, VendorConcern
Defined in:
app/models/spree/shipment.rb,
app/models/spree/shipment/emails.rb,
app/models/spree/shipment/webhooks.rb

Defined Under Namespace

Modules: Emails, Webhooks Classes: ManifestItem

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods included from Webhooks

#send_shipment_shipped_webhook

Methods included from Emails

#send_shipped_email

Instance Attribute Details

#special_instructions ⇒ Object

Returns the value of attribute special_instructions.



40
41
42
 
# File 'app/models/spree/shipment.rb', line 40

def special_instructions
  @special_instructions
end

Instance Method Details

#add_shipping_method(shipping_method, selected = false) ⇒ Object 



131
132
133
 
# File 'app/models/spree/shipment.rb', line 131

def add_shipping_method(shipping_method, selected = false)
  shipping_rates.create(shipping_method: shipping_method, selected: selected, cost: cost)
end

#after_cancel ⇒ Object 



135
136
137
 
# File 'app/models/spree/shipment.rb', line 135

def after_cancel
  manifest.each { |item| manifest_restock(item) }
end

#after_resume ⇒ Object 



139
140
141
 
# File 'app/models/spree/shipment.rb', line 139

def after_resume
  manifest.each { |item| manifest_unstock(item) }
end

#amount ⇒ Object 



123
124
125
 
# File 'app/models/spree/shipment.rb', line 123

def amount
  cost
end

#backordered? ⇒ Boolean

Returns true if the shipment has any backordered inventory units



146
147
148
 
# File 'app/models/spree/shipment.rb', line 146

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

#determine_state(order) ⇒ Object

Determines the appropriate state according to the following logic:

pending unless order is complete and order.payment_state is paid shipped if already shipped (ie. does not change the state) ready all other cases



179
180
181
182
183
184
185
186
 
# File 'app/models/spree/shipment.rb', line 179

def determine_state(order)
  return 'canceled' if canceled? || order.canceled?
  return 'pending' unless order.can_ship?
  return 'pending' if inventory_units.any?(&:backordered?)
  return 'shipped' if shipped?

  order.paid? || Spree::Config[:auto_capture_on_dispatch] ? 'ready' : 'pending'
end

#digital? ⇒ Boolean 



127
128
129
 
# File 'app/models/spree/shipment.rb', line 127

def digital?
  shipping_method&.digital? || false
end

#discounted_cost ⇒ Object Also known as: discounted_amount 



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

def discounted_cost
  cost + promo_total
end

#final_price ⇒ Object 



193
194
195
 
# File 'app/models/spree/shipment.rb', line 193

def final_price
  cost + adjustment_total
end

#final_price_with_items ⇒ Object 



197
198
199
 
# File 'app/models/spree/shipment.rb', line 197

def final_price_with_items
  item_cost + final_price
end

#finalize! ⇒ Object 



214
215
216
217
 
# File 'app/models/spree/shipment.rb', line 214

def finalize!
  inventory_units.finalize_units!
  after_resume
end

#free? ⇒ Boolean 



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

def free?
  return true if final_price == BigDecimal(0)

  with_free_shipping_promotion?
end

#include?(variant) ⇒ Boolean 



219
220
221
 
# File 'app/models/spree/shipment.rb', line 219

def include?(variant)
  inventory_units_for(variant).present?
end

#inventory_units_for(variant) ⇒ Object 



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

def inventory_units_for(variant)
  inventory_units.where(variant_id: variant.id)
end

#inventory_units_for_item(line_item, variant = nil) ⇒ Object 



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

def inventory_units_for_item(line_item, variant = nil)
  inventory_units.where(line_item_id: line_item.id, variant_id: line_item.variant_id || variant.id)
end

#item_cost ⇒ BigDecimal

Returns the cost of the shipment



239
240
241
 
# File 'app/models/spree/shipment.rb', line 239

def item_cost
  manifest.map { |m| (m.line_item.price + (m.line_item.adjustment_total / m.line_item.quantity)) * m.quantity }.sum
end

#item_quantity ⇒ Object

Returns the total quantity of all line items in the shipment



232
233
234
 
# File 'app/models/spree/shipment.rb', line 232

def item_quantity
  manifest.sum(&:quantity)
end

#item_weight ⇒ BigDecimal

Returns the weight of the shipment



246
247
248
 
# File 'app/models/spree/shipment.rb', line 246

def item_weight
  manifest.map { |m| m.line_item.item_weight }.sum
end

#line_items ⇒ Object 



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

def line_items
  inventory_units.includes(:line_item).map(&:line_item).uniq
end

#manifest ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'app/models/spree/shipment.rb', line 263

def manifest
  # Grouping by the ID means that we don't have to call out to the association accessor
  # This makes the grouping by faster because it results in less SQL cache hits.
  inventory_units.group_by(&:variant_id).map do |_variant_id, units|
    units.group_by(&:line_item_id).map do |_line_item_id, units|
      states = {}
      units.group_by(&:state).each { |state, iu| states[state] = iu.sum(&:quantity) }

      line_item = units.first.line_item
      variant = units.first.variant
      ManifestItem.new(line_item, variant, units.sum(&:quantity), states)
    end
  end.flatten
end

#name ⇒ String

Returns the shipment number and shipping method name



119
120
121
 
# File 'app/models/spree/shipment.rb', line 119

def name
  [number, shipping_method&.name].compact.join(' ').strip
end

#partial? ⇒ Boolean

Returns true if not all of the shipment’s line items are fully shipped



167
168
169
170
171
172
 
# File 'app/models/spree/shipment.rb', line 167

def partial?
  manifest.any? do |manifest_item|
    line_item = manifest_item.line_item
    line_item.quantity > manifest_item.quantity
  end
end

#process_order_payments ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'app/models/spree/shipment.rb', line 278

def process_order_payments
  pending_payments = order.pending_payments.
                     sort_by(&:uncaptured_amount).reverse

  shipment_to_pay = final_price_with_items
  payments_amount = 0

  payments_pool = pending_payments.each_with_object([]) do |payment, pool|
    break if payments_amount >= shipment_to_pay

    payments_amount += payment.uncaptured_amount
    pool << payment
  end

  payments_pool.each do |payment|
    capturable_amount = if payment.amount >= shipment_to_pay
                          shipment_to_pay
                        else
                          payment.amount
                        end

    cents = (capturable_amount * 100).to_i
    payment.capture!(cents)
    shipment_to_pay -= capturable_amount
  end
end

#ready_or_pending? ⇒ Boolean 



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

def ready_or_pending?
  ready? || pending?
end

#refresh_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'app/models/spree/shipment.rb', line 309

def refresh_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
  return shipping_rates if shipped?
  return [] unless can_get_rates?

  # StockEstimator.new assignment below will replace the current shipping_method
  original_shipping_method_id = shipping_method.try(:id)

  self.shipping_rates = Stock::Estimator.new(order).
                        shipping_rates(to_package, shipping_method_filter)

  if shipping_method
    selected_rate = shipping_rates.detect do |rate|
      if original_shipping_method_id
        rate.shipping_method_id == original_shipping_method_id
      else
        rate.selected
      end
    end
    save!
    self.selected_shipping_rate_id = selected_rate.id if selected_rate
    reload
  end

  shipping_rates
end

#selected_shipping_rate_id ⇒ Object 



335
336
337
 
# File 'app/models/spree/shipment.rb', line 335

def selected_shipping_rate_id
  selected_shipping_rate.try(:id)
end

#selected_shipping_rate_id=(id) ⇒ Object 



339
340
341
342
343
344
 
# File 'app/models/spree/shipment.rb', line 339

def selected_shipping_rate_id=(id)
  # Explicitly updates the timestamp in order to bust cache dependent on "updated_at"
  shipping_rates.update_all(selected: false, updated_at: Time.current)
  shipping_rates.update(id, selected: true)
  save!
end

#set_up_inventory(state, variant, order, line_item, quantity = 1) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
 
# File 'app/models/spree/shipment.rb', line 346

def set_up_inventory(state, variant, order, line_item, quantity = 1)
  return if quantity <= 0

  inventory_units.create(
    state: state,
    variant_id: variant.id,
    order_id: order.id,
    line_item_id: line_item.id,
    quantity: quantity
  )
end

#shippable? ⇒ Boolean

Returns true if the shipment is shippable



160
161
162
 
# File 'app/models/spree/shipment.rb', line 160

def shippable?
  can_ship? && (tracked? || digital?)
end

#shipped=(value) ⇒ Object 



358
359
360
361
362
 
# File 'app/models/spree/shipment.rb', line 358

def shipped=(value)
  return unless value == '1' && shipped_at.nil?

  self.shipped_at = Time.current
end

#shipping_method ⇒ Spree::ShippingMethod

Returns the shipping method of the selected shipping rate



367
368
369
 
# File 'app/models/spree/shipment.rb', line 367

def shipping_method
  selected_shipping_rate&.shipping_method || shipping_rates.first&.shipping_method
end

#tax_category ⇒ Spree::TaxCategory

Returns the tax category of the selected shipping rate



374
375
376
 
# File 'app/models/spree/shipment.rb', line 374

def tax_category
  selected_shipping_rate.try(:tax_rate).try(:tax_category)
end

#tax_category_id ⇒ Integer

Returns the tax category ID of the selected shipping rate



381
382
383
 
# File 'app/models/spree/shipment.rb', line 381

def tax_category_id
  selected_shipping_rate.try(:tax_rate).try(:tax_category_id)
end

#tax_total ⇒ Object

Only one of either included_tax_total or additional_tax_total is set This method returns the total of the two. Saves having to check if tax is included or additional.



388
389
390
 
# File 'app/models/spree/shipment.rb', line 388

def tax_total
  included_tax_total + additional_tax_total
end

#to_package ⇒ Object 



392
393
394
395
396
397
398
 
# File 'app/models/spree/shipment.rb', line 392

def to_package
  package = Stock::Package.new(stock_location)
  inventory_units.includes(:variant).joins(:variant).group_by(&:state).each do |state, state_inventory_units|
    package.add_multiple state_inventory_units, state.to_sym
  end
  package
end

#tracked? ⇒ Boolean

Returns true if the shipment is tracked



153
154
155
 
# File 'app/models/spree/shipment.rb', line 153

def tracked?
  tracking.present? || tracking_url.present?
end

#tracking_url ⇒ Object 



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

def tracking_url
  @tracking_url ||= shipping_method&.build_tracking_url(tracking)
end

#transfer_to_location(variant, quantity, stock_location) ⇒ Object 



431
432
433
434
435
436
437
 
# File 'app/models/spree/shipment.rb', line 431

def transfer_to_location(variant, quantity, stock_location)
  transfer_to_shipment(
    variant,
    quantity,
    order.shipments.build(stock_location: stock_location)
  )
end

#transfer_to_shipment(variant, quantity, shipment_to_transfer_to) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
 
# File 'app/models/spree/shipment.rb', line 439

def transfer_to_shipment(variant, quantity, shipment_to_transfer_to)
  Spree::FulfilmentChanger.new(
    current_stock_location: stock_location,
    desired_stock_location: shipment_to_transfer_to.stock_location,
    current_shipment: self,
    desired_shipment: shipment_to_transfer_to,
    variant: variant,
    quantity: quantity
  )
end

#update!(order) ⇒ Object

Updates various aspects of the Shipment while bypassing any callbacks. Note that this method takes an explicit reference to the Order object. This is necessary because the association actually has a stale (and unsaved) copy of the Order and so it will not yield the correct results.



421
422
423
424
425
426
427
428
429
 
# File 'app/models/spree/shipment.rb', line 421

def update!(order)
  old_state = state
  new_state = determine_state(order)
  update_columns(
    state: new_state,
    updated_at: Time.current
  )
  after_ship if new_state == 'shipped' && old_state != 'shipped'
end

#update_amounts ⇒ Object 



404
405
406
407
408
409
410
411
412
 
# File 'app/models/spree/shipment.rb', line 404

def update_amounts
  if selected_shipping_rate
    update_columns(
      cost: selected_shipping_rate.cost,
      adjustment_total: adjustments.additional.map(&:update!).compact.sum,
      updated_at: Time.current
    )
  end
end

#update_attributes_and_order(params = {}) ⇒ Object 



414
415
416
 
# File 'app/models/spree/shipment.rb', line 414

def update_attributes_and_order(params = {})
  Shipments::Update.call(shipment: self, shipment_attributes: params).success?
end

#weight_unit ⇒ String

Returns the weight unit of the shipment



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

def weight_unit
  manifest.first.line_item.weight_unit
end

#with_free_shipping_promotion? ⇒ Boolean

Returns true if the shipment has a free shipping promotion applied



210
211
212
 
# File 'app/models/spree/shipment.rb', line 210

def with_free_shipping_promotion?
  adjustments.promotion.includes(:source).any? { |p| p.source.respond_to?(:free_shipping?) && p.source.free_shipping? }
end