spree 0.0.8 → 0.0.9

data/CHANGELOG

@@ -0,0 +1,47 @@
+== 0.0.9 2008-04-23
+
+* Changed source code layout.  Spree now runs in stand alone, gem and application modes. 
+* Removed dependency on Engines plugin.
+* Removed free tagging (will be made obsolete by categorization features in upcoming release)
+* #20 - Product images in arbitrary order.
+ 
+== 0.0.8 2008-03-27
+
+* Fixed a few new bugs introduced by the variant refactoring
+* Replaced some instances of the old Railscart logo
+
+== 0.0.7 2008-03-26
+
+* Fixed an error with improperly named helper in one of the mailers (this was preventing checkout)
+* Removed several trivial references to old project name 
+
+== 0.0.6 2008-03-26
+
+* Now properly requires the mini_magick dependency
+* Fixed a few minor rake task issues
+* Other very minor bug fixes
+
+== 0.0.5 2008-02-26
+
+* Test release of the newly named gem (formerly known as railscart)
+
+== 0.0.4 2008-02-12
+
+* Cookie sessions (no more db sessions)
+* Streamlined migration stuff
+* Removed database.master.yml configuration stuff (no longer really necessary)
+* Improved data model for images
+* Fixed --edge option to point to new railscart SVN location
+
+== 0.0.3 2008-02-07
+
+* Added --edge option to railscart command (which gets latest version of all plugins from SVN.)
+* Refactored the product optioning stuff.
+
+== 0.0.2 2008-01-29
+
+* Additional gem release testing.
+
+== 0.0.1 2008-01-29
+
+* Initial release.  Test of gem release mechanism.

data/CONTRIBUTORS

@@ -0,0 +1,27 @@
+== Founder
+
+Sean Schofield is the founder of the Spree project. It was originally started in July 2007 as 
+a Google Code project with the name Rails Cart. The name of the project was changed to Spree 
+in March 2008 in order to avoid any confusion about it being endorsed by the Ruby on Rails team.
+
+== Contributors
+
+The following people have submitted changes which have been applied to the
+core:
+
+* Sean Schofield
+
+== Legacy Contributors
+
+The following people have submitted changes which have been applied to the
+project previously known as Railscart:
+
+* Sean Schofield
+* snacktime
+* jawolter
+* Brett Mchargue
+* Charles Cooke
+
+== Sponsor
+
+Special thanks to End Point Corporation for their generous sponsorship of the Spree project.

data/INSTALL

@@ -0,0 +1,27 @@
+
+== Installation and Setup
+
+Once you have extracted the files into the directory where you would like to
+install Spree:
+
+1. Create the MySQL/PostgreSQL/SQLite databases for your Web site. You only
+   need to create the "production" database, but you may also want to create
+   the "development" and "test" databases if you are developing extensions
+   or running tests.
+
+2. Edit config/database.yml to taste.
+
+3. Run the database bootstrap rake task:
+   
+     $ rake production db:bootstrap
+   
+   (If you would like bootstrap your development database just run `rake
+   development db:bootstrap` or simply `rake db:bootstrap`.)
+
+4. Start it like a normal Rails application. To test execute:
+   
+     $ script/server -e production
+   
+   And open your Web browser on port 3000 (http://localhost:3000). The
+   administrative interface is available at /admin/. By default the bootstrap
+   rake task creates a user called "admin" with a password of "spree".

data/Rakefile

@@ -1,4 +1,11 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'
+
+unless Rake::Task.task_defined? "spree:release"
+  Dir["#{SPREE_ROOT}/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+end

data/app/controllers/admin/inventory_units_controller.rb

@@ -0,0 +1,27 @@
+class Admin::InventoryUnitsController < Admin::BaseController
+  require_role "admin"
+  
+  def adjust
+    @variant = Variant.find(params[:id])
+    if request.post?
+      @level = InventoryLevel.new(params[:level])
+      @level.on_hand = @variant.inventory(InventoryUnit::Status::ON_HAND)
+
+      begin
+        #throw "Invalid Adjustment Quantity" unless @level.valid?
+        InventoryUnit.create_on_hand(@variant, @level.adjustment) if @level.adjustment > 0
+        InventoryUnit.destroy_on_hand(@variant, @level.adjustment.abs) if @level.adjustment < 0
+        flash.now[:notice] = "Inventory level has been adjusted."
+        @variant.reload
+        @level = InventoryLevel.new(:adjustment => 0)
+      rescue 
+        flash.now[:error] = "Error occurred while updating inventory."
+        flash.now[:error] = "Invalid adjustment quantity" unless @level.errors.empty?
+      end
+    else
+      @level = InventoryLevel.new(:adjustment => 0)
+    end
+  end
+  
+end
+

data/app/controllers/admin/orders_controller.rb

@@ -0,0 +1,272 @@
+class Admin::OrdersController < Admin::BaseController
+  require_role "admin"
+  
+  in_place_edit_for :address, :firstname
+  in_place_edit_for :address, :lastname
+  in_place_edit_for :address, :address1
+  in_place_edit_for :address, :address2
+  in_place_edit_for :address, :city
+  in_place_edit_for :address, :zipcode
+  in_place_edit_for :address, :phone
+  in_place_edit_for :user, :email
+  
+  def index
+    @status_options = Order::Status.constants
+    if params[:search]
+      @search = SearchCriteria.new(params[:search])
+      if @search.valid?
+        p = {}
+        conditions = build_conditions(p)
+        if p.empty? 
+          @orders = Order.find(:all, :order => "created_at DESC", :page => {:size => 15, :current =>params[:page], :first => 1})          
+        else 
+          @orders = Order.find(:all, 
+                               :order => "orders.created_at DESC",
+                               :joins => "as orders inner join addresses as a on orders.bill_address_id = a.id",
+                               :conditions => [conditions, p],
+                               :select => "orders.*",
+                               :page => {:size => 15, :current =>params[:page], :first => 1})
+        end
+      else
+        @orders = []
+        flash.now[:error] = "Invalid search criteria.  Please check your results."      
+      end
+    else
+      @search = SearchCriteria.new
+      @orders = Order.find(:all, 
+                           :order => "created_at DESC",
+                           :conditions => ["status != ?", Order::Status::INCOMPLETE],
+                           :page => {:size => 15, :current =>params[:page], :first => 1})
+    end
+  end
+  
+  def show
+    @order = Order.find(params[:id])
+    @user = @order.user
+    @states = State.find(:all)
+    @countries = Country.find(:all)
+  end
+
+  def capture
+    order = Order.find(params[:id])
+
+    response = gateway_capture(order)
+    unless response.success?
+      flash[:error] = "Problem capturing credit card ... \n#{response.params['error']}"   
+      redirect_to :back and return
+    end
+
+    order.status = Order::Status::CAPTURED
+    order.order_operations << OrderOperation.new(
+      :operation_type => OrderOperation::OperationType::CAPTURE,
+      :user => current_user
+    )
+
+    if order.save
+      flash[:notice] = "Order has been captured."    
+    else
+      logger.error "unable to update order status: " + order.inspect
+      flash[:error] = "Order was captured but database update has failed.  Please ask your administrator to manually adjust order status."
+    end
+    redirect_to :back
+  end
+  
+  def ship
+    order = Order.find(params[:id])
+    
+    # if the current status is AUTHORIZED then we need to CAPTURE as well
+    if order.status == Order::Status::AUTHORIZED
+      response = gateway_capture(order)
+      unless response.success?
+        flash[:error] = "Problem capturing credit card ... \n#{response.params['error']}"   
+        redirect_to :back and return
+      end
+    end
+    
+    order.status = Order::Status::SHIPPED
+    order.order_operations << OrderOperation.new(
+      :operation_type => OrderOperation::OperationType::SHIP,
+      :user => current_user
+    )
+
+    begin 
+      Order.transaction do
+        order.save!
+        # now update the inventory to reflect the new shipped status
+        order.inventory_units.each do |unit|     
+          unit.update_attributes(:status => InventoryUnit::Status::SHIPPED)
+        end
+      end
+      flash[:notice] = "Order has been shipped."    
+    rescue
+      logger.error "unable to ship order: " + order.inspect
+      flash[:error] = "Unable to ship order.  Please contact your administrator."
+    end    
+    
+    redirect_to :back
+    
+  end
+  
+  def cancel
+    order = Order.find(params[:id])
+    response = gateway_void(order)
+
+    unless response.success?
+      flash[:error] = "Problem voiding credit card authorization ... \n#{response.params['error']}"   
+      redirect_to :back and return
+    end
+
+    order.order_operations << OrderOperation.new(
+      :operation_type => OrderOperation::OperationType::CANCEL,
+      :user => current_user
+    )
+    order.status = Order::Status::CANCELED
+    
+    begin 
+      Order.transaction do
+        order.save!
+        # now update the inventory to reflect the new on hand status
+        order.inventory_units.each do |unit|     
+          unit.update_attributes(:status => InventoryUnit::Status::ON_HAND)
+        end
+        flash[:notice] = "Order cancelled successfully."    
+      end
+    rescue
+      logger.error "unable to cancel order: " + order.inspect
+      flash[:error] = "Unable to cancel order."
+    end    
+    # send email confirmation
+    OrderMailer.deliver_cancel(order)
+    
+    redirect_to :back
+  end
+
+  def return
+    order = Order.find(params[:id])
+    
+    # TODO - consider making the credit an option since it may not be supported by some gateways
+    response = gateway_credit(order)
+
+    unless response.success?
+      flash[:error] = "Problem crediting the credit card ... \n#{response.params['error']}"   
+      redirect_to :back and return
+    end
+
+    order.order_operations << OrderOperation.new(
+      :operation_type => OrderOperation::OperationType::RETURN,
+      :user => current_user
+    )
+    order.status = Order::Status::RETURNED
+    
+    begin
+      Order.transaction do
+        order.save!
+        # now update the inventory to reflect the new on hand status
+        order.inventory_units.each do |unit|     
+          unit.update_attributes(:status => InventoryUnit::Status::ON_HAND)
+        end
+        flash[:notice] = "Order successfully returned."    
+      end
+    rescue
+      logger.error "unable to return order: " + order.inspect
+      flash[:error] = "Order payment was credited but database update has failed.  Please ask your administrator to manually adjust order status."
+    end
+    
+    redirect_to :back
+  end
+  
+  def resend
+    # resend the order receipt
+    @order = Order.find(params[:id])
+    OrderMailer.deliver_confirm(@order, true)
+    flash[:notice] = "Confirmation message was resent successfully."
+    redirect_to :back
+  end
+
+  def delete
+    # delete an incomplete order from the system
+    order = Order.find(params[:id])
+    if order.destroy
+      flash[:notice] = "Order successfully deleted."    
+    else
+      logger.error "unable to delete order: " + order.inspect
+      flash[:error] = "Unable to delete order."
+    end
+    redirect_to :back
+  end
+
+  private
+      def gateway_capture(order)
+        authorization = find_authorization(order)
+        gw = payment_gateway
+        response = gw.capture(order.total * 100, authorization.response_code, Order.minimal_gateway_options(order))
+        return unless response.success?
+        order.credit_card.txns << Txn.new(
+          :amount => order.total,
+          :response_code => response.authorization,
+          :txn_type => Txn::TxnType::CAPTURE
+        )
+        order.save
+        response
+      end
+      
+      def gateway_void(order)
+        authorization = find_authorization(order)
+        gw = payment_gateway
+        response = gw.void(authorization.response_code, Order.minimal_gateway_options(order))
+        return unless response.success?
+        order.credit_card.txns << Txn.new(
+          :amount => order.total,
+          :response_code => response.authorization,
+          :txn_type => Txn::TxnType::VOID
+        )
+        order.save
+        response
+      end
+     
+      def gateway_credit(order)
+        authorization = find_authorization(order)
+        gw = payment_gateway
+        response = gw.credit(order.total, authorization.response_code, Order.minimal_gateway_options(order))
+        return unless response.success?
+        order.credit_card.txns << Txn.new(
+          :amount => order.total,
+          :response_code => response.authorization,
+          :txn_type => Txn::TxnType::CREDIT
+        )
+        order.save
+        response
+      end
+
+      def find_authorization(order)
+        #find the transaction associated with the original authorization/capture 
+        cc = order.credit_card
+        cc.txns.find(:first, 
+                     :conditions => ["txn_type = ? or txn_type = ?", Txn::TxnType::AUTHORIZE, Txn::TxnType::CAPTURE],
+                     :order => 'created_at DESC')
+      end
+
+      def build_conditions(p)
+        c = []
+        if not @search.start.blank?
+          c << "(orders.created_at between :start and :stop)"
+          p.merge! :start => @search.start.to_date
+          @search.stop = Date.today + 1 if @search.stop.blank?
+          p.merge! :stop => @search.stop.to_date + 1.day 
+        end
+        unless @search.order_num.blank?
+          c << "number like :order_num"
+          p.merge! :order_num => @search.order_num + "%"
+        end
+        unless @search.customer.blank?
+          c << "(firstname like :customer or lastname like :customer)"
+          p.merge! :customer => @search.customer + "%"
+        end
+        if @search.status
+          c << "status = :status"
+          p.merge! :status => @search.status
+        end
+        (c.to_sentence :skip_last_comma=>true).gsub(",", " and ")
+      end
+
+end

data/app/controllers/admin/products_controller.rb

@@ -0,0 +1,169 @@
+class Admin::ProductsController < Admin::BaseController
+  require_role "admin"
+  
+  def index
+    if params[:search]
+      @search = SearchCriteria.new(params[:search])
+      if @search.valid?
+        p = {}
+        conditions = build_conditions(p)
+        if p.empty? 
+          @products = Product.find(:all, :order => "created_at DESC", :page => {:size => 10, :current =>params[:page], :first => 1})          
+        else
+          @products = Product.find(:all, 
+                                   :order => "products.name",
+                                   :conditions => [conditions, p],
+                                   :include => :variants,
+                                   :page => {:size => 10, :current =>params[:page], :first => 1})
+        end
+      else
+        @orders = []
+        flash.now[:error] = "Invalid search criteria.  Please check your results."      
+      end
+    else
+      @search = SearchCriteria.new
+      @products =  Product.find(:all, :page => {:size => 10, :current =>params[:page], :first => 1})
+    end
+  end
+
+  def show
+    @product = Product.find(params[:id])
+  end
+
+  def new
+    load_data
+    if request.post?
+      @product = Product.new(params[:product])
+      @product.category = Category.find(params[:category]) unless params[:category].blank?
+
+      @sku = params[:sku]
+      @on_hand = params[:on_hand]
+
+      if @product.save
+        # create a sku (if one has been supplied)
+        @product.variants.first.update_attributes(:sku => @sku) if @sku
+        InventoryUnit.create_on_hand(@product.variants.first, @on_hand.to_i) if @on_hand
+        flash[:notice] = 'Product was successfully created.'
+        redirect_to :action => :edit, :id => @product      
+      else
+        flash.now[:error] = "Problem saving new product #{@product}"
+      end
+    else
+      @product = Product.new
+    end
+  end
+
+  def edit
+    if request.post?
+      load_data
+      @product = Product.find(params[:id])
+      category_id = params[:category]
+      @product.category = (category_id.blank? ? nil : Category.find(params[:category]))
+
+      if params[:variant]
+        @product.variants.update params[:variant].keys, params[:variant].values
+      end
+
+      if params[:image]
+        @product.images << Image.new(params[:image])
+      end
+      
+      @product.tax_treatments = TaxTreatment.find(params[:tax_treatments]) if params[:tax_treatments]
+      @product.save
+      
+      if @product.update_attributes(params[:product])
+        flash[:notice] = 'Product was successfully updated.'
+        redirect_to :action => 'edit', :id => @product
+      else
+        flash.now[:error] = 'Problem updating product.'
+      end
+    else
+      @product = Product.find(params[:id])
+      load_data
+      @selected_category = @product.category.id if @product.category
+    end
+  end
+  
+  def destroy
+    flash[:notice] = 'Product was successfully deleted.'
+    @product = Product.find(params[:id])
+    @product.destroy
+    redirect_to :action => 'index'
+  end
+
+  #AJAX support method
+  def add_option_type
+    @product = Product.find(params[:id])
+    pot = ProductOptionType.new(:product => @product, :option_type => OptionType.find(params[:option_type_id]))
+    @product.selected_options << pot
+    @product.save
+    render  :partial => 'option_types', 
+            :locals => {:product => @product},
+            :layout => false
+  end  
+
+  #AJAX support method
+  def remove_option_type
+    ProductOptionType.delete(params[:product_option_type_id])
+    @product = Product.find(params[:id])
+    render  :partial => 'option_types', 
+            :locals => {:product => @product},
+            :layout => false
+  end  
+
+  # AJAX method to show tax treatments based on change in category
+  def tax_treatments
+    product = Product.find_or_initialize_by_id(params[:id])
+    if params[:category_id].blank?
+      product.category = nil
+    else
+      product.category = Category.find(params[:category_id])
+    end
+    @all_tax_treatments = TaxTreatment.find(:all)
+    render  :partial => 'shared/tax_treatments', 
+            :locals => {:tax_treatments => @all_tax_treatments, :selected_treatments => product.tax_treatments},
+            :layout => false
+  end
+    
+  #AJAX method   
+  def new_variant
+    @product = Product.find(params[:id])
+    @variant = Variant.new    
+    render  :partial => 'new_variant', 
+            :locals => {:product => @product},
+            :layout => false    
+  end
+  
+  #AJAX method
+  def delete_variant
+    @product = Product.find(params[:id])
+    Variant.destroy(params[:variant_id])
+    flash.now[:notice] = 'Variant successfully removed.'
+    render  :partial => 'variants', 
+            :locals => {:product => @product},
+            :layout => false    
+  end
+
+  protected
+      def load_data
+        @all_categories = Category.find(:all, :order=>"name")  
+        @all_categories.unshift Category.new(:name => "<None>")
+        @all_tax_treatments = TaxTreatment.find(:all, :order=>"name")
+      end
+  
+  private
+  
+      def build_conditions(p)
+        c = []
+        unless @search.name.blank?
+          c << "products.name like :name"
+          p.merge! :name => "%" + @search.name + "%"
+        end
+        unless @search.sku.blank?
+          c << "variants.sku like :sku"
+          p.merge! :sku => "%" + @search.sku + "%"
+        end
+        (c.to_sentence :skip_last_comma=>true).gsub(",", " and ")
+      end
+  
+end