Class: Order
- Inherits:
-
ActiveRecord::Base
- Object
- ActiveRecord::Base
- Order
- Defined in:
- app/models/order.rb
Instance Attribute Summary collapse
-
#out_of_stock_items ⇒ Object
Returns the value of attribute out_of_stock_items.
-
#use_billing ⇒ Object
Returns the value of attribute use_billing.
Class Method Summary collapse
-
.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#updat.
Instance Method Summary collapse
- #add_variant(variant, quantity = 1) ⇒ Object
- #allow_cancel? ⇒ Boolean
- #allow_resume? ⇒ Boolean
- #available_payment_methods ⇒ Object
-
#available_shipping_methods(display_on = nil) ⇒ Object
Helper methods for checkout steps.
-
#backordered? ⇒ Boolean
Indicates whether there are any backordered InventoryUnits associated with the Order.
- #billing_firstname ⇒ Object
- #billing_lastname ⇒ Object
-
#checkout_allowed? ⇒ Boolean
Indicates whether or not the user is allowed to proceed to checkout.
- #clone_billing_address ⇒ Object
- #completed? ⇒ Boolean
- #contains?(variant) ⇒ Boolean
-
#create_shipment! ⇒ Object
Creates a new shipment (adjustment is created by shipment model).
-
#create_tax_charge! ⇒ Object
Creates a new tax charge if applicable.
- #creditcards ⇒ Object
- #destroy_inapplicable_adjustments ⇒ Object
-
#finalize! ⇒ Object
Finalizes an in progress order after checkout is complete.
- #generate_order_number ⇒ Object
-
#ip_address ⇒ Object
delegate :ip_address, :to => :checkout.
-
#item_count ⇒ Object
Indicates the number of items in the order.
- #name ⇒ Object
- #outstanding_balance ⇒ Object
- #outstanding_balance? ⇒ Boolean
- #payment ⇒ Object
- #payment_method ⇒ Object
- #process_payments! ⇒ Object
- #products ⇒ Object
- #rate_hash ⇒ Object
- #restore_state ⇒ Object
- #ship_total ⇒ Object
-
#shipment ⇒ Object
convenience method since many stores will not allow user to create multiple shipments.
- #tax_total ⇒ Object
- #to_param ⇒ Object
-
#update! ⇒ Object
This is a multi-purpose method for processing logic related to changes in the Order.
Instance Attribute Details
#out_of_stock_items ⇒ Object
Returns the value of attribute out_of_stock_items.
44 45 46 |
# File 'app/models/order.rb', line 44 def out_of_stock_items @out_of_stock_items end |
#use_billing ⇒ Object
Returns the value of attribute use_billing.
172 173 174 |
# File 'app/models/order.rb', line 172 def use_billing @use_billing end |
Class Method Details
.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#updat
50 51 52 |
# File 'app/models/order.rb', line 50 def self.register_update_hook(hook) self.update_hooks.add(hook) end |
Instance Method Details
#add_variant(variant, quantity = 1) ⇒ Object
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'app/models/order.rb', line 196 def add_variant(variant, quantity = 1) current_item = contains?(variant) if current_item current_item.quantity += quantity current_item.save else current_item = LineItem.new(:quantity => quantity) current_item.variant = variant current_item.price = variant.price self.line_items << current_item end # populate line_items attributes for additional_fields entries # that have populate => [:line_item] Variant.additional_fields.select{|f| !f[:populate].nil? && f[:populate].include?(:line_item) }.each do |field| value = "" if field[:only].nil? || field[:only].include?(:variant) value = variant.send(field[:name].gsub(" ", "_").downcase) elsif field[:only].include?(:product) value = variant.product.send(field[:name].gsub(" ", "_").downcase) end current_item.update_attribute(field[:name].gsub(" ", "_").downcase, value) end current_item end |
#allow_cancel? ⇒ Boolean
185 186 187 188 |
# File 'app/models/order.rb', line 185 def allow_cancel? return false unless completed? and state != 'canceled' %w{ready backorder pending}.include? shipment_state end |
#allow_resume? ⇒ Boolean
190 191 192 193 194 |
# File 'app/models/order.rb', line 190 def allow_resume? # we shouldn't allow resume for legacy orders b/c we lack the information necessary to restore to a previous state return false if state_events.empty? || state_events.last.previous_state.nil? true end |
#available_payment_methods ⇒ Object
331 332 333 |
# File 'app/models/order.rb', line 331 def available_payment_methods @available_payment_methods ||= PaymentMethod.available(:front_end) end |
#available_shipping_methods(display_on = nil) ⇒ Object
Helper methods for checkout steps
312 313 314 315 |
# File 'app/models/order.rb', line 312 def available_shipping_methods(display_on = nil) return [] unless ship_address ShippingMethod.all_available(self, display_on) end |
#backordered? ⇒ Boolean
Indicates whether there are any backordered InventoryUnits associated with the Order.
120 121 122 123 |
# File 'app/models/order.rb', line 120 def backordered? return false unless Spree::Config[:track_inventory_levels] inventory_units.backorder.present? end |
#billing_firstname ⇒ Object
343 344 345 |
# File 'app/models/order.rb', line 343 def billing_firstname bill_address.try(:firstname) end |
#billing_lastname ⇒ Object
347 348 349 |
# File 'app/models/order.rb', line 347 def billing_lastname bill_address.try(:lastname) 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.
65 66 67 |
# File 'app/models/order.rb', line 65 def checkout_allowed? line_items.count > 0 end |
#clone_billing_address ⇒ Object
174 175 176 177 178 179 180 181 |
# File 'app/models/order.rb', line 174 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
58 59 60 |
# File 'app/models/order.rb', line 58 def completed? !! completed_at end |
#contains?(variant) ⇒ Boolean
238 239 240 |
# File 'app/models/order.rb', line 238 def contains?(variant) line_items.detect{|line_item| line_item.variant_id == variant.id} end |
#create_shipment! ⇒ Object
Creates a new shipment (adjustment is created by shipment model)
262 263 264 265 266 267 268 269 270 |
# File 'app/models/order.rb', line 262 def create_shipment! shipping_method.reload if shipment.present? shipment.update_attributes(:shipping_method => shipping_method) else self.shipments << Shipment.create(:order => self, :shipping_method => shipping_method, :address => self.ship_address) end end |
#create_tax_charge! ⇒ Object
Creates a new tax charge if applicable. Uses the highest possible matching rate and destroys any previous tax charges if they were created by rates that no longer apply.
252 253 254 255 256 257 258 259 |
# File 'app/models/order.rb', line 252 def create_tax_charge! return unless rate = TaxRate.match(bill_address) or adjustments.tax.present? if old_charge = adjustments.tax.first old_charge.destroy unless old_charge.originator == rate return end rate.create_adjustment(I18n.t(:tax), self, self, true) end |
#creditcards ⇒ Object
290 291 292 293 |
# File 'app/models/order.rb', line 290 def creditcards creditcard_ids = payments.from_creditcard.map(&:source_id).uniq Creditcard.scoped(:conditions => {:id => creditcard_ids}) end |
#destroy_inapplicable_adjustments ⇒ Object
280 281 282 283 |
# File 'app/models/order.rb', line 280 def destroy_inapplicable_adjustments destroyed = adjustments.reject(&:applicable?).map(&:destroy) adjustments.reload if destroyed.any? end |
#finalize! ⇒ Object
Finalizes an in progress order after checkout is complete. Called after transition to complete state when payments will have been processed
301 302 303 304 305 306 307 |
# File 'app/models/order.rb', line 301 def finalize! update_attribute(:completed_at, Time.now) self.out_of_stock_items = InventoryUnit.assign_opening_inventory(self) # lock any optional adjustments (coupon promotions, etc.) adjustments.optional.each { |adjustment| adjustment.update_attribute("locked", true) } OrderMailer.confirm_email(self).deliver end |
#generate_order_number ⇒ Object
224 225 226 227 228 229 230 231 |
# File 'app/models/order.rb', line 224 def generate_order_number record = true while record random = "R#{Array.new(9){rand(9)}.join}" record = Order.find(:first, :conditions => ["number = ?", random]) end self.number = random end |
#ip_address ⇒ Object
delegate :ip_address, :to => :checkout
31 32 33 |
# File 'app/models/order.rb', line 31 def ip_address '192.168.1.100' end |
#item_count ⇒ Object
Indicates the number of items in the order
70 71 72 |
# File 'app/models/order.rb', line 70 def item_count line_items.map(&:quantity).sum end |
#name ⇒ Object
285 286 287 288 |
# File 'app/models/order.rb', line 285 def name address = bill_address || ship_address "#{address.firstname} #{address.lastname}" if address end |
#outstanding_balance ⇒ Object
272 273 274 |
# File 'app/models/order.rb', line 272 def outstanding_balance total - payment_total end |
#outstanding_balance? ⇒ Boolean
276 277 278 |
# File 'app/models/order.rb', line 276 def outstanding_balance? self.outstanding_balance != 0 end |
#payment ⇒ Object
327 328 329 |
# File 'app/models/order.rb', line 327 def payment payments.first end |
#payment_method ⇒ Object
335 336 337 338 339 340 341 |
# File 'app/models/order.rb', line 335 def payment_method if payment and payment.payment_method payment.payment_method else available_payment_methods.first end end |
#process_payments! ⇒ Object
295 296 297 |
# File 'app/models/order.rb', line 295 def process_payments! ret = payments.each(&:process!) end |
#products ⇒ Object
351 352 353 |
# File 'app/models/order.rb', line 351 def products line_items.map{|li| li.variant.product} end |
#rate_hash ⇒ Object
317 318 319 320 321 322 323 324 325 |
# File 'app/models/order.rb', line 317 def rate_hash @rate_hash ||= available_shipping_methods(:front_end).collect do |ship_method| { :id => ship_method.id, :shipping_method => ship_method, :name => ship_method.name, :cost => ship_method.calculator.compute(self) } end.sort_by{|r| r[:cost]} end |
#restore_state ⇒ Object
157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'app/models/order.rb', line 157 def restore_state # pop the resume event so we can see what the event before that was state_events.pop if state_events.last.name == "resume" update_attribute("state", state_events.last.previous_state) if paid? raise "do something with inventory" #InventoryUnit.assign_opening_inventory(self) if inventory_units.empty? #shipment.inventory_units = inventory_units #shipment.ready! end end |
#ship_total ⇒ Object
242 243 244 |
# File 'app/models/order.rb', line 242 def ship_total adjustments.shipping.map(&:amount).sum end |
#shipment ⇒ Object
convenience method since many stores will not allow user to create multiple shipments
234 235 236 |
# File 'app/models/order.rb', line 234 def shipment @shipment ||= shipments.last end |
#tax_total ⇒ Object
246 247 248 |
# File 'app/models/order.rb', line 246 def tax_total adjustments.tax.map(&:amount).sum end |
#to_param ⇒ Object
54 55 56 |
# File 'app/models/order.rb', line 54 def to_param number.to_s.parameterize.upcase end |
#update! ⇒ Object
This is a multi-purpose method for processing logic related to changes in the Order. It is meant to be called from various observers so that the Order is aware of changes that affect totals and other values stored in the Order. This method should never do anything to the Order that results in a save call on the object (otherwise you will end up in an infinite recursion as the associations try to save and then in turn try to call update!
again.)
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'app/models/order.rb', line 129 def update! update_totals update_payment_state # give each of the shipments a chance to update themselves shipments.each { |shipment| shipment.update!(self) }#(&:update!) update_shipment_state update_adjustments # update totals a second time in case updated adjustments have an effect on the total update_totals update_attributes_without_callbacks({ :payment_state => payment_state, :shipment_state => shipment_state, :item_total => item_total, :adjustment_total => adjustment_total, :payment_total => payment_total, :total => total }) #ensure checkout payment always matches order total if payment and payment.checkout? and payment.amount != total payment.update_attributes_without_callbacks(:amount => total) end update_hooks.each { |hook| self.send hook } end |