shoppe 0.0.5

data/app/controllers/shoppe/product_categories_controller.rb

@@ -0,0 +1,45 @@
+class Shoppe::ProductCategoriesController < Shoppe::ApplicationController
+
+  before_filter { @active_nav = :product_categories }  
+  before_filter { params[:id] && @product_category = Shoppe::ProductCategory.find(params[:id]) }
+  
+  def index
+    @product_categories = Shoppe::ProductCategory.ordered.all
+  end
+  
+  def new
+    @product_category = Shoppe::ProductCategory.new
+  end
+  
+  def create
+    @product_category = Shoppe::ProductCategory.new(safe_params)
+    if @product_category.save
+      redirect_to :product_categories, :flash => {:notice => "Category has been created successfully"}
+    else
+      render :action => "new"
+    end
+  end
+  
+  def edit
+  end
+  
+  def update
+    if @product_category.update(safe_params)
+      redirect_to [:edit, @product_category], :flash => {:notice => "Category has been updated successfully"}
+    else
+      render :action => "edit"
+    end
+  end
+  
+  def destroy
+    @product_category.destroy
+    redirect_to :product_categories, :flash => {:notice => "Category has been removed successfully"}
+  end
+  
+  private
+  
+  def safe_params
+    params[:product_category].permit(:name, :permalink, :description, :image_file)
+  end
+  
+end

data/app/controllers/shoppe/products_controller.rb

@@ -0,0 +1,45 @@
+class Shoppe::ProductsController < Shoppe::ApplicationController
+  
+  before_filter { @active_nav = :products }
+  before_filter { params[:id] && @product = Shoppe::Product.find(params[:id]) }
+  
+  def index
+    @products = Shoppe::Product.includes(:default_image, :product_category).order(:title).group_by(&:product_category).sort_by { |cat,pro| cat.name }
+  end
+  
+  def new
+    @product = Shoppe::Product.new
+  end
+  
+  def create
+    @product = Shoppe::Product.new(safe_params)
+    if @product.save
+      redirect_to :products, :flash => {:notice => "Product has been created successfully"}
+    else
+      render :action => "new"
+    end
+  end
+  
+  def edit
+  end
+  
+  def update
+    if @product.update(safe_params)
+      redirect_to [:edit, @product], :flash => {:notice => "Product has been updated successfully"}
+    else
+      render :action => "edit"
+    end
+  end
+  
+  def destroy
+    @product.destroy
+    redirect_to :products, :flash => {:notice => "Product has been removed successfully"}
+  end
+  
+  private
+  
+  def safe_params
+    params[:product].permit(:product_category_id, :title, :sku, :permalink, :description, :short_description, :weight, :price, :tax_rate, :stock, :default_image_file, :data_sheet_file, :active, :featured, :in_the_box)
+  end
+  
+end

data/app/controllers/shoppe/sessions_controller.rb

@@ -0,0 +1,31 @@
+class Shoppe::SessionsController < Shoppe::ApplicationController
+  layout 'shoppe/sub'
+  skip_before_filter :login_required, :only => [:new, :create, :reset]
+  
+  def create
+    if user = Shoppe::User.authenticate(params[:email_address], params[:password])
+      session[:shoppe_user_id] = user.id
+      redirect_to :orders
+    else
+      flash.now[:alert] = "The email address and/or password you have entered is invalid. Please check and try again."
+      render :action => "new"
+    end
+  end
+  
+  def destroy
+    session[:shoppe_user_id] = nil
+    redirect_to :login
+  end
+  
+  def reset
+    
+    if request.post?
+      if user = Shoppe::User.find_by_email_address(params[:email_address])
+        user.reset_password!
+        redirect_to login_path(:email_address => params[:email_address]), :notice => "An e-mail has been sent to #{user.email_address} with a new password"
+      else
+        flash.now[:alert] = "No user was found matching the e-mail address"
+      end
+    end
+  end
+end

data/app/controllers/shoppe/users_controller.rb

@@ -0,0 +1,46 @@
+class Shoppe::UsersController < Shoppe::ApplicationController
+  
+  before_filter { @active_nav = :users }
+  before_filter { params[:id] && @user = Shoppe::User.find(params[:id]) }
+  
+  def index
+    @users = Shoppe::User.all
+  end
+  
+  def new
+    @user = Shoppe::User.new
+  end
+  
+  def create
+    @user = Shoppe::User.new(safe_params)
+    if @user.save
+      redirect_to :users, :flash => {:notice => "User has been created successfully"}
+    else
+      render :action => "new"
+    end
+  end
+  
+  def edit
+  end
+  
+  def update
+    if @user.update(safe_params)
+      redirect_to [:edit, @user], :flash => {:notice => "User has been updated successfully"}
+    else
+      render :action => "edit"
+    end
+  end
+  
+  def destroy
+    raise Shoppe::Error, "You cannot remove yourself" if @user == current_user
+    @user.destroy
+    redirect_to :users, :flash => {:notice => "User has been removed successfully"}
+  end
+  
+  private
+  
+  def safe_params
+    params[:user].permit(:first_name, :last_name, :email_address, :password, :password_confirmation)
+  end
+  
+end

data/app/helpers/shoppe/application_helper.rb

@@ -0,0 +1,10 @@
+module Shoppe::ApplicationHelper
+  
+  # Return all currencies with the currency provided by the Shoppe
+  # configuration file.
+  def number_to_currency(number, options = {})
+    options[:unit] ||= Shoppe.config[:currency_unit]
+    super
+  end
+  
+end

data/app/helpers/shoppe/shoppe_helper.rb

@@ -0,0 +1,28 @@
+module Shoppe::ShoppeHelper
+
+  def status_tag(status)
+    content_tag :span, status, :class => "status-tag #{status}"
+  end
+  
+  def attachment_preview(attachment)
+    if attachment
+      String.new.tap do |s|
+        if attachment.image?
+          style = "style='background-image:url(#{attachment.path})'"
+        else
+          style = ''
+        end
+        s << "<div class='attachmentPreview #{attachment.image? ? 'image' : 'doc'}'>"
+        s << "<div class='imgContainer'><div class='img' #{style}></div></div>"
+        s << "<div class='desc'>"
+        s << "<span class='filename'><a href='#{attachment_path(attachment)}'>#{attachment.file_name}</a></span>"
+        s << "<span class='delete'>"
+        s << link_to("Delete this file?", attachment_path(attachment), :method => :delete, :data => {:confirm => "Are you sure you wish to remove this attachment?"})
+        s << "</span>"
+        s << "</div>"
+        s << "</div>"
+      end.html_safe
+    end
+  end
+  
+end

data/app/mailers/shoppe/order_mailer.rb

@@ -0,0 +1,25 @@
+class Shoppe::OrderMailer < ActionMailer::Base
+  
+  default :from => "#{Shoppe.config[:store_name]} <#{Shoppe.config[:email_address]}>"
+  
+  def received(order)
+    @order = order
+    mail :to => order.email_address, :subject => I18n.t('shoppe.order_mailer.received.subject', :default => "Order Confirmation")
+  end
+  
+  def accepted(order)
+    @order = order
+    mail :to => order.email_address, :subject => I18n.t('shoppe.order_mailer.received.accepted', :default => "Order Accepted")
+  end
+  
+  def rejected(order)
+    @order = order
+    mail :to => order.email_address, :subject => I18n.t('shoppe.order_mailer.received.rejected', :default => "Order Rejected")
+  end
+  
+  def shipped(order)
+    @order = order
+    mail :to => order.email_address, :subject => I18n.t('shoppe.order_mailer.received.shipped', :default => "Order Shipped")
+  end
+  
+end

data/app/mailers/shoppe/user_mailer.rb

@@ -0,0 +1,10 @@
+module Shoppe
+  class UserMailer < ActionMailer::Base
+    default :from => "#{Shoppe.config[:store_name]} <#{Shoppe.config[:email_address]}>"
+
+    def new_password(user)
+      @user = user
+      mail :to => user.email_address, :subject => "Your new Shoppe password"
+    end
+  end
+end

data/app/models/shoppe/delivery_service.rb

@@ -0,0 +1,22 @@
+class Shoppe::DeliveryService < ActiveRecord::Base
+  
+  # Set the table name
+  self.table_name = 'shoppe_delivery_services'
+  
+  # Validations
+  validates :name, :presence => true
+  validates :courier, :presence => true
+  
+  # Relationships
+  has_many :orders, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Order'
+  has_many :delivery_service_prices, :dependent => :destroy, :class_name => 'Shoppe::DeliveryServicePrice'
+  
+  # Scopes
+  scope :active, -> { where(:active => true)}
+  
+  # Return the tracking URL for the given consignment number
+  def tracking_url_for(consignment_number)
+    tracking_url.gsub("{{consignment_number}}", consignment_number)
+  end
+  
+end

data/app/models/shoppe/delivery_service_price.rb

@@ -0,0 +1,19 @@
+class Shoppe::DeliveryServicePrice < ActiveRecord::Base
+
+  # Set the table name
+  self.table_name = 'shoppe_delivery_service_prices'
+  
+  # Relationships
+  belongs_to :delivery_service, :class_name => 'Shoppe::DeliveryService'
+  
+  # Validations
+  validates :price, :numericality => true
+  validates :tax_rate, :numericality => true
+  validates :min_weight, :numericality => true
+  validates :max_weight, :numericality => true
+  
+  # Scopes
+  scope :ordered, -> { order('price asc')}
+  scope :for_weight, -> weight { where("min_weight <= ? AND max_weight >= ?", weight, weight) }
+  
+end

data/app/models/shoppe/order.rb

@@ -0,0 +1,325 @@
+class Shoppe::Order < ActiveRecord::Base
+
+  # Set the table name
+  self.table_name = 'shoppe_orders'
+  
+  # An array of all the available statuses for an order
+  STATUSES = ['building', 'confirming', 'received', 'accepted', 'rejected', 'shipped']
+  
+  # Order's implement a key value store for storing arbitary properties which 
+  # may be useful (for example payment configuraiton)
+  key_value_store :properties
+  
+  # These additional callbacks allow for applications to hook into other
+  # parts of the order lifecycle.
+  define_model_callbacks :confirmation, :payment, :acceptance, :rejection, :ship
+  
+  # Relationships
+  belongs_to :delivery_service, :class_name => 'Shoppe::DeliveryService'
+  belongs_to :accepter, :class_name => 'Shoppe::User', :foreign_key => 'accepted_by'
+  belongs_to :rejecter, :class_name => 'Shoppe::User', :foreign_key => 'rejected_by'
+  belongs_to :shipper, :class_name => 'Shoppe::User', :foreign_key => 'shipped_by'
+  has_many :order_items, :dependent => :destroy, :class_name => 'Shoppe::OrderItem'
+  has_many :products, :through => :order_items, :class_name => 'Shoppe::Product'
+  
+  # Validations
+  validates :token, :presence => true
+  validates :status, :inclusion => {:in => STATUSES}
+  with_options :if => Proc.new { |o| !o.building? } do |order|
+    order.validates :first_name, :presence => true
+    order.validates :last_name, :presence => true
+    order.validates :address1, :presence => true
+    order.validates :address2, :presence => true
+    order.validates :postcode, :presence => true
+    order.validates :country, :presence => true
+    order.validates :email_address, :format => {:with => /\A\b[A-Z0-9\.\_\%\-\+]+@(?:[A-Z0-9\-]+\.)+[A-Z]{2,6}\b\z/i}
+    order.validates :phone_number, :format => {:with => /\A[\d\ ]{7,}\z/}
+  end
+  
+  # Scopes
+  scope :received, -> {where("received_at is not null")}
+  scope :pending, -> { where(:status => 'received') }
+  scope :ordered, -> { order('id desc')}
+  
+  # Set some defaults
+  before_validation do
+    self.status = 'building' if self.status.blank?
+    self.token = SecureRandom.uuid if self.token.blank?
+  end
+  
+  # Is this order still being built by the user?
+  def building?
+    self.status == 'building'
+  end
+  
+  # Is this order in the user confirmation step?
+  def confirming?
+    self.status == 'confirming'
+  end
+  
+  # Has this order been rejected?
+  def rejected?
+    !!self.rejected_at
+  end
+  
+  # Has this order been accepted?
+  def accepted?
+    !!self.accepted_at
+  end
+  
+  # Has this order been shipped?
+  def shipped?
+    !!self.shipped_at?
+  end
+  
+  # Has the order been received?
+  def received?
+    !!self.received_at?
+  end
+  
+  # The order number
+  def number
+    id.to_s.rjust(6, '0')
+  end
+  
+  # The length of time the customer spent building the order before submitting it to us.
+  # The time from first item in basket to received.
+  def build_time
+    return nil if self.received_at.blank?
+    self.created_at - self.received_at
+  end
+  
+  # The name of the customer
+  def customer_name
+    company.blank? ? "#{first_name} #{last_name}" : "#{company} (#{first_name} #{last_name})"
+  end
+  
+  # Is this order empty? (i.e. doesn't have any items associated with it)
+  def empty?
+    order_items.empty?
+  end
+  
+  # Does this order have items?
+  def has_items?
+    total_items > 0
+  end
+  
+  # Return the number of items in the order?
+  def total_items
+    @total_items ||= order_items.inject(0) { |t,i| t + i.quantity }
+  end
+  
+  # The total price of the order before tax
+  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
+  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
+  def total
+    self.delivery_price + 
+    self.delivery_tax_amount + 
+    order_items.inject(BigDecimal(0)) { |t, i| t + i.total }
+  end
+  
+  # The total of the order including tax in pence
+  def total_in_pence
+    (total * BigDecimal(100)).to_i
+  end
+  
+  # The total weight of the order
+  def total_weight
+    order_items.inject(BigDecimal(0)) { |t,i| t + i.weight}
+  end
+  
+  # An array of all the delivery service prices which can be applied to this order.
+  def delivery_service_prices
+    @delivery_service_prices ||= begin
+      Shoppe::DeliveryServicePrice.joins(:delivery_service).where(:shoppe_delivery_services => {:active => true}).order("`default` desc, price asc").for_weight(total_weight)
+    end
+  end
+  
+  # An array of all the delivery services which are suitable for this order in it's
+  # current state (based on its current weight)
+  def available_delivery_services
+    @available_delivery_services ||= begin
+      delivery_service_prices.map(&:delivery_service).uniq
+    end
+  end
+  
+  # The recommended delivery service for this order
+  def delivery_service
+    super || available_delivery_services.first
+  end
+  
+  # Return the delivery price for this order in its current state
+  def delivery_service_price
+    @delivery_service_price ||= self.delivery_service && self.delivery_service.delivery_service_prices.for_weight(self.total_weight).first
+  end
+  
+  # The cost of delivering this order in its current state
+  def delivery_price
+    @delivery_price ||= read_attribute(:delivery_price) || delivery_service_price.try(:price) || 0.0
+  end
+  
+  # The tax amount due for the delivery of this order in its current state
+  def delivery_tax_amount
+    @delivery_tax_amount ||= begin
+      read_attribute(:delivery_tax_amount) ||
+      (delivery_service_price ? delivery_price / BigDecimal(100) * delivery_service_price.tax_rate : 0.0) ||
+      0.0
+    end
+  end
+  
+  # The tax rate for the delivery of this order in its current state
+  def delivery_tax_rate
+    @delivery_tax_rate ||= begin
+      read_attribute(:delivery_tax_rate) ||
+      delivery_service_price.try(:tax_rate) ||
+      0.0
+    end
+  end
+  
+  # Is the currently assigned delivery service appropriate for this order?
+  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
+  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.consignment_number)
+  end
+  
+  # Has this order been fully paid for?
+  def paid?
+    !paid_at.blank?
+  end
+  
+  # This method is called by the customer when they submit their details in the first step of
+  # the checkout process. It will update the status to 'confirmed' as well as updating their 
+  # details. Any issues with validation will cause false to be returned otherwise true. Any
+  # more serious issues will be raised as exceptions.
+  def proceed_to_confirm(params = {})
+    self.status = 'confirming'
+    if self.update(params)
+      true
+    else
+      false
+    end
+  end
+  
+  # This method will confirm the order If there are any issues with  the order an exception 
+  # should be raised.
+  def confirm!
+    
+    # Ensure that we have the stock to fulfil this order at the current time. We may have had it when
+    # it was placed int he basket and if we don't now, we should let the user know so they can
+    # rethink.
+    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
+    
+    # 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_tax_amount, self.delivery_tax_amount
+      write_attribute :delivery_tax_rate, self.delivery_tax_rate
+    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
+  
+  # This method will mark an order as paid.
+  def pay!(reference, method)
+    run_callbacks :payment do
+      self.paid_at = Time.now.utc
+      self.payment_reference = reference
+      self.payment_method = method
+      self.save!
+    end
+  end
+  
+  # This method will accept the this order. It is called by a user (which is the only
+  # parameter).
+  def accept!(user)
+    run_callbacks :acceptance do
+      self.accepted_at = Time.now
+      self.accepted_by = user.id
+      self.status = 'accepted'
+      self.save!
+      Shoppe::OrderMailer.accepted(self).deliver
+    end
+  end
+  
+  # This method will reject the order. It is called by a user (which is the only parameter).
+  def reject!(user)
+    run_callbacks :rejection do
+      self.rejected_at = Time.now
+      self.rejected_by = user.id
+      self.status = 'rejected'
+      self.save!
+      Shoppe::OrderMailer.rejected(self).deliver
+    end
+  end
+  
+  # This method will mark an order as shipped and store the given consignment number with the
+  # order for use later in tracking.
+  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
+  
+  # Specify which attributes can be searched
+  def self.ransackable_attributes(auth_object = nil) 
+    ["id", "postcode", "address1", "address2", "address3", "address4", "first_name", "last_name", "company", "email_address", "phone_number", "consignment_number", "status", "received_at"] + _ransackers.keys
+  end
+  
+  # Specify which associations can be searched
+  def self.ransackable_associations(auth_object = nil)
+    ['products']
+  end
+  
+end