shoppe 0.0.16 → 0.0.17

data/app/models/shoppe/order/actions.rb

@@ -0,0 +1,80 @@
+module Shoppe
+  class Order < ActiveRecord::Base
+    
+    # These additional callbacks allow for applications to hook into other
+    # parts of the order lifecycle.
+    define_model_callbacks :confirmation, :acceptance, :rejection
+  
+    # This method should be called by the base application when the user has completed their 
+    # first round of entering details. This will mark the order as "confirming" which means
+    # the customer now just must confirm.
+    #
+    # @param params [Hash] a hash of order attributes
+    # @return [Boolean]
+    def proceed_to_confirm(params = {})
+      self.status = 'confirming'
+      if self.update(params)
+        true
+      else
+        false
+      end
+    end
+  
+    # This method should be executed by the application when the order should be completed
+    # by the customer. It will raise exceptions if anything goes wrong or return true if
+    # the order has been confirmed successfully
+    #
+    # @return [Boolean]
+    def confirm!
+      no_stock_of = self.order_items.select(&:validate_stock_levels)
+      unless no_stock_of.empty?
+        raise Shoppe::Errors::InsufficientStockToFulfil, :order => self, :out_of_stock_items => no_stock_of
+      end
+    
+      run_callbacks :confirmation do
+        # If we have successfully charged the card (i.e. no exception) we can go ahead and mark this
+        # order as 'received' which means it can be accepted by staff.
+        self.status = 'received'
+        self.received_at = Time.now
+        self.save!
+
+        self.order_items.each(&:confirm!)
+
+        # Send an email to the customer
+        Shoppe::OrderMailer.received(self).deliver
+      end
+    
+      # We're all good.
+      true
+    end
+  
+    # Mark order as accepted
+    #
+    # @param user [Shoppe::User] the user who carried out this action    
+    def accept!(user)
+      run_callbacks :acceptance do
+        self.accepted_at = Time.now
+        self.accepted_by = user.id
+        self.status = 'accepted'
+        self.save!
+        self.order_items.each(&:accept!)
+        Shoppe::OrderMailer.accepted(self).deliver
+      end
+    end
+  
+    # Mark order as rejected
+    #
+    # @param user [Shoppe::User] the user who carried out the action
+    def reject!(user)
+      run_callbacks :rejection do
+        self.rejected_at = Time.now
+        self.rejected_by = user.id
+        self.status = 'rejected'
+        self.save!
+        self.order_items.each(&:reject!)
+        Shoppe::OrderMailer.rejected(self).deliver
+      end
+    end
+    
+  end
+end

data/app/models/shoppe/order/billing.rb

@@ -0,0 +1,99 @@
+module Shoppe
+  class Order < ActiveRecord::Base
+    
+    # The country which this order should be billed to
+    #
+    # @return [Shoppe::Country]
+    belongs_to :billing_country, :class_name => 'Shoppe::Country', :foreign_key => 'billing_country_id'
+    
+    # Payments which have been stored for the order
+    has_many :payments, :dependent => :destroy, :class_name => 'Shoppe::Payment'
+    
+    # Validations
+    with_options :if => Proc.new { |o| !o.building? } do |order|
+      order.validates :first_name, :presence => true
+      order.validates :last_name, :presence => true
+      order.validates :billing_address1, :presence => true
+      order.validates :billing_address3, :presence => true
+      order.validates :billing_address4, :presence => true
+      order.validates :billing_postcode, :presence => true
+      order.validates :billing_country, :presence => true
+    end
+    
+    # The name for billing purposes
+    #
+    # @return [String]
+    def billing_name
+      company.blank? ? full_name : "#{full_name} (#{company})"
+    end
+    
+    # The total cost of the order
+    #
+    # @return [BigDecimal]
+    def total_cost
+      self.delivery_cost_price + 
+      order_items.inject(BigDecimal(0)) { |t, i| t + i.total_cost }
+    end
+  
+    # Return the price for the order
+    #
+    # @return [BigDecimal]
+    def profit
+      total_before_tax - total_cost
+    end
+  
+    # The total price of the order before tax
+    #
+    # @return [BigDecimal]
+    def total_before_tax
+      self.delivery_price +
+      order_items.inject(BigDecimal(0)) { |t, i| t + i.sub_total }
+    end
+  
+    # The total amount of tax due on this order
+    #
+    # @return [BigDecimal]
+    def tax
+      self.delivery_tax_amount +
+      order_items.inject(BigDecimal(0)) { |t, i| t + i.tax_amount }
+    end
+  
+    # The total of the order including tax
+    #
+    # @return [BigDecimal]
+    def total
+      self.delivery_price + 
+      self.delivery_tax_amount + 
+      order_items.inject(BigDecimal(0)) { |t, i| t + i.total }
+    end
+    
+    # The total amount due on the order
+    #
+    # @return [BigDecimal]
+    def balance
+      @balance ||= total - amount_paid
+    end
+    
+    # Is there a payment still outstanding on this order?
+    #
+    # @return [Boolean]
+    def payment_outstanding?
+      balance > BigDecimal(0)
+    end
+    
+    # Has this order been paid in full?
+    #
+    # @return [Boolean]
+    def paid_in_full?
+      !payment_outstanding?
+    end
+  
+    # Is the order invoiced?
+    #
+    # @return [Boolean]
+    def invoiced?
+      !invoice_number.blank?
+    end
+    
+  end
+end

data/app/models/shoppe/order/delivery.rb

@@ -0,0 +1,196 @@
+module Shoppe
+  class Order < ActiveRecord::Base
+    
+    # The associated delivery service
+    #
+    # @return [Shoppe::DeliveryService]
+    belongs_to :delivery_service, :class_name => 'Shoppe::DeliveryService'
+    
+    # The country where this order is being delivered to (if one has been provided)
+    #
+    # @return [Shoppe::Country]
+    belongs_to :delivery_country, :class_name => 'Shoppe::Country', :foreign_key => 'delivery_country_id'
+    
+    # The user who marked the order has shipped
+    #
+    # @return [Shoppe::User]
+    belongs_to :shipper, :class_name => 'Shoppe::User', :foreign_key => 'shipped_by'
+    
+    # Set up a callback for use when an order is shipped
+    define_model_callbacks :ship
+    
+    # Validations
+    with_options :if => :separate_delivery_address? do |order|
+      order.validates :delivery_name, :presence => true
+      order.validates :delivery_address1, :presence => true
+      order.validates :delivery_address3, :presence => true
+      order.validates :delivery_address4, :presence => true
+      order.validates :delivery_postcode, :presence => true
+      order.validates :delivery_country, :presence => true
+    end
+    validate do
+      unless available_delivery_services.include?(self.delivery_service)
+        errors.add :delivery_service_id, "is not suitable for this order"
+      end
+    end
+    
+    before_confirmation do
+      # Ensure that before we confirm the order that the delivery service which has been selected
+      # is appropritae for the contents of the order.
+      unless self.valid_delivery_service?
+        raise Shoppe::Errors::InappropriateDeliveryService, :order => self
+      end
+      
+      # Store the delivery prices with the order
+      if self.delivery_service
+        write_attribute :delivery_service_id, self.delivery_service.id
+        write_attribute :delivery_price, self.delivery_price
+        write_attribute :delivery_cost_price, self.delivery_cost_price
+        write_attribute :delivery_tax_amount, self.delivery_tax_amount
+        write_attribute :delivery_tax_rate, self.delivery_tax_rate
+      end
+    end
+    
+    # If there isn't a seperate address needed, clear all the fields back to nil
+    before_validation do
+      unless separate_delivery_address?
+        self.delivery_name = nil
+        self.delivery_address1 = nil
+        self.delivery_address2 = nil
+        self.delivery_address3 = nil
+        self.delivery_address4 = nil
+        self.delivery_postcode = nil
+        self.delivery_country = nil
+      end
+    end
+    
+    # Create some delivery_ methods which will mimic the billing methods if the order does
+    # not need a seperate address.
+    [:delivery_name, :delivery_address1, :delivery_address2, :delivery_address3, :delivery_address4, :delivery_postcode, :delivery_country].each do |f|
+      define_method(f) do
+        separate_delivery_address? ? super() : send(f.to_s.gsub('delivery_', 'billing_'))
+      end
+    end
+    
+    # Has this order been shipped?
+    #
+    # @return [Boolean]
+    def shipped?
+      !!self.shipped_at?
+    end
+    
+    # The total weight of the order
+    #
+    # @return [BigDecimal]
+    def total_weight
+      order_items.inject(BigDecimal(0)) { |t,i| t + i.weight}
+    end
+    
+    # An array of all the delivery services which are suitable for this order in it's
+    # current state (based on its current weight)
+    #
+    # @return [Array] an array of Shoppe::DeliveryService objects
+    def available_delivery_services
+      @available_delivery_services ||= begin
+        delivery_service_prices.map(&:delivery_service).uniq
+      end
+    end
+    
+    # An array of all the delivery service prices which can be applied to this order.
+    #
+    # @return [Array] an array of Shoppe:DeliveryServicePrice objects
+    def delivery_service_prices
+      @delivery_service_prices ||= begin
+        prices = Shoppe::DeliveryServicePrice.joins(:delivery_service).where(:shoppe_delivery_services => {:active => true}).order("`default` desc, price asc").for_weight(total_weight)
+        prices = prices.select { |p| p.countries.empty? || p.country?(self.delivery_country) }
+        prices
+      end
+    end
+
+    # The recommended delivery service for this order
+    #
+    # @return [Shoppe::DeliveryService]
+    def delivery_service
+      super || available_delivery_services.first
+    end
+  
+    # Return the delivery price for this order in its current state
+    #
+    # @return [BigDecimal]
+    def delivery_service_price
+      @delivery_service_price ||= self.delivery_service && self.delivery_service.delivery_service_prices.for_weight(self.total_weight).first
+    end
+  
+    # The price for delivering this order in its current state
+    #
+    # @return [BigDecimal]
+    def delivery_price
+      @delivery_price ||= read_attribute(:delivery_price) || delivery_service_price.try(:price) || 0.0
+    end
+  
+    # The cost of delivering this order in its current state
+    #
+    # @return [BigDecimal]
+    def delivery_cost_price
+      @delivery_cost_price ||= read_attribute(:delivery_cost_price) || delivery_service_price.try(:cost_price) || 0.0
+    end
+  
+    # The tax amount due for the delivery of this order in its current state
+    #
+    # @return [BigDecimal]
+    def delivery_tax_amount
+      @delivery_tax_amount ||= begin
+        read_attribute(:delivery_tax_amount) ||
+        delivery_price / BigDecimal(100) * delivery_tax_rate ||
+        0.0
+      end
+    end
+  
+    # The tax rate for the delivery of this order in its current state
+    #
+    # @return [BigDecimal]
+    def delivery_tax_rate
+      @delivery_tax_rate ||= begin
+        read_attribute(:delivery_tax_rate) ||
+        delivery_service_price.try(:tax_rate).try(:rate_for, self) ||
+        0.0
+      end
+    end
+  
+    # Is the currently assigned delivery service appropriate for this order?
+    #
+    # @return [Boolean]
+    def valid_delivery_service?
+      self.delivery_service && self.available_delivery_services.include?(self.delivery_service)
+    end
+  
+    # Remove the associated delivery service if it's invalid
+    def remove_delivery_service_if_invalid
+      unless self.valid_delivery_service?
+        self.delivery_service = nil
+        self.save
+      end
+    end
+  
+    # The URL which can be used to track the delivery of this order
+    #
+    # @return [String]
+    def courier_tracking_url
+      return nil if self.shipped_at.blank? || self.consignment_number.blank?
+      @courier_tracking_url ||= self.delivery_service.tracking_url_for(self)
+    end
+    
+    # Mark this order as shipped
+    def ship!(user, consignment_number)
+      run_callbacks :ship do
+        self.shipped_at = Time.now
+        self.shipped_by = user.id
+        self.status = 'shipped'
+        self.consignment_number = consignment_number
+        self.save!
+        Shoppe::OrderMailer.shipped(self).deliver
+      end
+    end
+    
+  end
+end

data/app/models/shoppe/order/states.rb

@@ -0,0 +1,69 @@
+module Shoppe
+  class Order < ActiveRecord::Base
+    
+    # An array of all the available statuses for an order
+    STATUSES = ['building', 'confirming', 'received', 'accepted', 'rejected', 'shipped']
+    
+    # The Shoppe::User who accepted the order
+    #
+    # @return [Shoppe::User]
+    belongs_to :accepter, :class_name => 'Shoppe::User', :foreign_key => 'accepted_by'
+    
+    # The Shoppe::User who rejected the order
+    #
+    # @return [Shoppe::User]
+    belongs_to :rejecter, :class_name => 'Shoppe::User', :foreign_key => 'rejected_by'
+    
+    # Validations
+    validates :status, :inclusion => {:in => STATUSES}
+    
+    # Set the status to building if we don't have a status
+    before_validation { self.status = 'building' if self.status.blank? }
+    
+    # All orders which have been received
+    scope :received, -> {where("received_at is not null")}
+    
+    # All orders which are currently pending acceptance/rejection
+    scope :pending, -> { where(:status => 'received') }
+    
+    # All ordered ordered by their ID desending
+    scope :ordered, -> { order('id desc')}
+    
+    # Is this order still being built by the user?
+    #
+    # @return [Boolean]
+    def building?
+      self.status == 'building'
+    end
+  
+    # Is this order in the user confirmation step?
+    #
+    # @return [Boolean]
+    def confirming?
+      self.status == 'confirming'
+    end
+  
+    # Has this order been rejected?
+    #
+    # @return [Boolean]
+    def rejected?
+      !!self.rejected_at
+    end
+  
+    # Has this order been accepted?
+    #
+    # @return [Boolean]
+    def accepted?
+      !!self.accepted_at
+    end
+  
+    # Has the order been received?
+    #
+    # @return [Boolean]
+    def received?
+      !!self.received_at?
+    end
+  
+    
+  end
+end