spree-point-of-sale 1.0.0

data/.gitignore

@@ -0,0 +1,16 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+tmp
+nbproject
+*.swp
+log/
+config/initializers/spree.rb
+config/environment.rb
+config/database.yml
+app/controllers/application_controller.rb
+coverage/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+gem 'rails', '3.2.16'
+gem 'mysql2'
+
+
+gem 'spree', :git => 'git://github.com/spree/spree.git', :tag => 'v2.0.3'
+gem 'spree_html_invoice' , :git => 'git://github.com/dancinglightning/spree-html-invoice.git'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', :branch => '2-0-stable'
+
+gemspec
+
+group :test do
+  gem 'rspec-rails', '~> 2.10'
+  gem 'shoulda-matchers', '2.2.0'
+  gem 'simplecov', :require => false
+  gem 'database_cleaner'
+  gem 'rspec-html-matchers'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,71 @@
+SpreePos
+===============
+SpreePos hooks into the Admin Tab and is meant to be used to sell at a shop.
+
+Allows you to search and add items available at the selected stock location. 
+Apply discount on items, associate the order to customer email and save the details of payment to finally finish the order with an invoice ready to print.
+
+
+Dependencies
+============
+1)spree_html_invoice(optional)
+
+By default POS relies on html-invoice to print a receipt. You can configure this away by setting :pos_printing to the url where you want to redirect after print. 
+
+2)barby
+
+3)prawn
+
+4)chunky_png
+
+
+SET UP
+=======
+To your Gemfile add:
+
+  1) gem "spree_pos", :git => "git://github.com/vinsol/spree-point-of-sale.git"
+
+  2) If you DONT change the :pos_printing config as described above, you must also add 
+
+  gem 'spree_html_invoice' , :git => 'git://github.com/dancinglightning/spree-html-invoice.git'
+
+and run bundler.
+
+Finally for migrations, css and javascript do
+
+  bundle exec rails g spree_pos:install
+
+
+Configure
+=========
+You must configure:
+
+1)ShippingMethod : Create a shipping method for pos and set it from the admin end via general settings. 
+Usually something like "pickup" with cost 0.
+
+2)Payment Methods : They can be added under PointOfSale payment method from admin end itself.
+
+3)Store : Make sure atleast one of your stock locations is marked as store.
+
+
+Order
+=========
+The order is linked to the admin creating the order to keep a track of pos orders initiated by a particular admin.
+
+Admin won't be allowed to update a paid order or even to create a new order when there is an order pending to be paid.
+
+
+Stock Location and Inventory
+=========
+By default the first active stock location is picked up considering a single stock location. In case of multiple stock locations you can easily switch them.
+
+Stock Locations available to be selected can be easily configured by re-defining user_stock_locations for pos_controller.
+
+The inventory is updated along with addition and removal of items from the order.
+
+
+Barcode printing and SKU
+========
+Barcode printing relies on sku to be provided for variants.
+
+There are links provided to print barcodes for individual variants in the variants index for a product or barcodes for all variants can be printed from the product listings as well.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree_core/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec, :cucumber ]
+
+spec = eval(File.read('spree_pos.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Release to gemcutter"
+task :release => :package do
+  require 'rake/gemcutter'
+  Rake::Gemcutter::Tasks.new(spec).define
+  Rake::Task['gem:push'].invoke
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_pos'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,11 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+"0.70.x" => { :ref => "793ca3ad2822877babf60c5e3d3bd7b3f39be3db"}
+# note: the 1.0 version was in never in production use as I had server crashes with 1.0 and upgraded immediately to 1.1
+"1.0.x" => { :ref => "7075b1b483faa183679761f060072515e45dcaf7"}
+
+"1.1.x" => { :branch => "master" }
+
+
+

data/app/assets/javascripts/admin/spree_pos.js

@@ -0,0 +1,20 @@
+$( document ).ready(function() {
+  $('#sku').focus();
+  $( "#pos-tabs" ).tabs();
+
+  $( "#associate_user_toggle" ).click(function() {
+    $( "#associate_user" ).slideToggle( "slow", function() {
+    });
+  });
+
+  $('#update_payment input[type=radio]').click(function() {
+    $('#card_name_options').val('');
+    $('#card_name_options').hide();
+  });
+
+  $('#update_payment input[type=radio][data-name ~= card],#update_payment input[type=radio][data-name ~= Card]').click(function() {
+    $('#card_name_options').show();
+  });
+  $("#update_payment input[name='payment_method_id']:first").click();
+  $( "#associate_user" ).toggle();
+});

data/app/assets/stylesheets/admin/html-label.css

@@ -0,0 +1,20 @@
+@page  { 
+	margin-left:1mm;
+	margin-right:1mm;
+	margin-top:1mm;
+	margin-bottom:1mm;
+	 }
+
+body {
+    font-family:"Helvetica";
+	color:#000000;
+	width:200px;
+}
+
+.label-name {
+	font-size:13px;
+}
+
+.label-price {
+	font-size:13px;
+}

data/app/assets/stylesheets/admin/spree_pos.css

@@ -0,0 +1,25 @@
+#pos-tabs { border:none; padding:20px 0px; float:left; width:100%; }
+#pos-tabs .ui-tabs-nav { display:inline-block; width:100%;  border:none; background:none; border-radius:3px; background:#5498DA;}
+#pos-tabs .ui-tabs-nav .ui-state-default { float:left; width:50%; text-align:center; border:none; background:none;}
+#pos-tabs .ui-tabs-nav .ui-state-default .ui-tabs-anchor { display:block; padding:10px; font-weight:normal; text-transform:uppercase; font-size:11px;  color:#fff !important; position:relative;}
+#pos-tabs .ui-tabs-nav .ui-state-active .ui-tabs-anchor { background:#9FC820; border-radius:3px;}
+#pos-tabs .ui-tabs-nav .ui-state-active .ui-tabs-anchor:after {
+  content: '';
+  position: absolute;
+  border-left: 10px solid transparent;
+  border-right: 10px solid transparent;
+  border-top: 5px solid #9fc820;
+  bottom: 0px;
+  margin-bottom: -5px;
+  left: 50%;
+  margin-left: -10px;
+  z-index: 1;
+  }
+#pos-tabs .commonfieldset .row { margin:0;}
+#pos-tabs .commonfieldset  p { padding-bottom:10px;}
+#pos-tabs .ui-widget-content { border:none; }
+table#pos-order-table th { border-top: 1px solid #cee1f4;}
+table#pos-order-table { padding-top: 10px;}
+table#pos-order-table td.discount input.submit{ margin: 2px 0 0 10px;}
+fieldset.no-bottom-margin { margin-bottom: 0px;}
+a#create_pos_order { float:right; padding:4px 9px;}

data/app/controllers/spree/admin/barcode_controller.rb

@@ -0,0 +1,49 @@
+require 'barby'
+require 'prawn'
+require 'prawn/measurement_extensions'
+require 'barby/barcode/code_128'
+require 'barby/barcode/ean_13'
+require 'barby/outputter/png_outputter'
+
+class Spree::Admin::BarcodeController < Spree::Admin::BaseController
+  include Admin::BarcodeHelper
+  
+  before_filter :load, :only => [:print]
+  before_filter :load_product_and_variants, :only => [:print_variants_barcodes]
+  layout :false
+  
+  def print_variants_barcodes
+    if @variants.present?
+      pdf = @variants.inject(empty_pdf({:height => 120})) { |pdf, variant| append_barcode_to_pdf_for_variant(variant, pdf) }
+      send_data pdf.render , :type => "application/pdf" , :filename => "#{@product.name}.pdf"
+    else
+      #just to have @variant so that print can be called directly without a request skipping load method
+      @variant = @product.master
+      print
+    end
+  end
+  
+  # moved to pdf as html has uncontrollable margins
+  def print
+    pdf = append_barcode_to_pdf_for_variant(@variant)
+    send_data pdf.render , :type => "application/pdf" , :filename => "#{@variant.name}.pdf"
+  end
+  
+  private
+
+  # leave this in here maybe for later, not used anymore
+  # def code
+  #   barcode = get_barcode
+  #   return unless barcode
+  #   send_data barcode.to_png(:xdim => 5) , :type => 'image/png', :disposition => 'inline'
+  # end
+
+  def load
+    @variant = Spree::Variant.where(:id => params[:id]).first
+  end
+
+  def load_product_and_variants
+    @product = Spree::Product.where(:id => params[:id]).first
+    @variants = @product.variants
+  end
+end

data/app/controllers/spree/admin/checkout_controller_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Admin::GeneralSettingsController.class_eval do
+  before_filter :update_pos_config, :only => :update
+
+  def update_pos_config
+    SpreePos::Config[:pos_shipping] = params[:pos_shipping]
+  end
+end

data/app/controllers/spree/admin/pos_controller.rb

@@ -0,0 +1,205 @@
+class Spree::Admin::PosController < Spree::Admin::BaseController
+  before_filter :load_order, :ensure_pos_order, :ensure_unpaid_order, :except => [:new]
+  helper_method :user_stock_locations
+  before_filter :load_variant, :only => [:add, :remove]
+  before_filter :ensure_pos_shipping_method, :only => [:new]
+  before_filter :ensure_payment_method, :only => [:update_payment]
+  before_filter :ensure_existing_user, :only => [:associate_user]
+  before_filter :check_unpaid_pos_order, :only => :new
+  before_filter :check_discount_request, :only => :apply_discount
+  before_filter :load_line_item, :only => [:update_line_item_quantity, :apply_discount]
+  before_filter :clean_and_reload_order, :only => [:update_stock_location]
+  
+  def new
+    init_pos
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  def find
+    init_search
+
+    stock_location = @order.shipment.stock_location
+    @search = Spree::Variant.includes([:product]).available_at_stock_location(stock_location.id).ransack(params[:q])
+    @variants = @search.result(:distinct => true).page(params[:page]).per(PRODUCTS_PER_SEARCH_PAGE)
+  end
+
+  def add
+    @item = add_variant(@variant) if @variant.present?
+    flash[:notice] = Spree.t('product_added') if @item.errors.blank?
+    flash[:error] = @item.errors.full_messages.to_sentence if @item.errors.present?
+    redirect_to admin_pos_show_order_path(:number => @order.number) 
+  end
+
+  def remove
+    line_item = @order.contents.remove(@variant, 1, @order.shipment)
+    @order.assign_shipment_for_pos if @order.reload.shipments.blank?
+    flash.notice = line_item.quantity.zero? ? Spree.t('product_removed') : 'Quantity Updated' 
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  def update_line_item_quantity
+    @item.quantity = params[:quantity]
+    @item.save
+
+    flash[:notice] = 'Quantity Updated' if @item.errors.blank?
+    flash[:error] = @item.errors.full_messages.to_sentence if @item.errors.present?
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  def apply_discount
+    @item.price = @item.variant.price * ( 1.0 - @discount/100.0 )
+    @item.save
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  def clean_order
+    @order.clean!
+    redirect_to admin_pos_show_order_path(:number => @order.number), :notice => "Removed all items"
+  end
+
+  def associate_user
+    @user = @order.associate_user_for_pos(params[:email].present? ? params[:email] : params[:new_email])
+    if @user.errors.present?
+      add_error "Could not add the user:#{@user.errors.full_messages.to_sentence}"
+    else
+      @order.save!
+      flash[:notice] = 'Successfully Associated User'
+    end
+
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  def update_payment
+    @payment_method_id = params[:payment_method_id]
+    @payment = @order.save_payment_for_pos(params[:payment_method_id], params[:card_name])
+    if @payment.errors.blank?
+      print
+    else
+      add_error @payment.errors.full_messages.to_sentence
+      redirect_to admin_pos_show_order_path(:number => @order.number)
+    end
+  end
+
+  def update_stock_location
+    @order.shipment.stock_location = user_stock_locations(spree_current_user).where(:id => params[:stock_location_id]).first
+    if @order.shipment.save
+      flash[:notice] = "Updated Successfully"
+    else
+      flash[:error] = @order.shipment.errors.full_messages.to_sentence
+    end
+    redirect_to admin_pos_show_order_path(:number => @order.number)
+  end
+
+  private 
+
+  def clean_and_reload_order
+    @order.clean!
+    load_order
+  end
+
+  def check_discount_request
+    @discount = params[:discount].try(:to_f)
+    redirect_to admin_pos_show_order_path(:number => @order.number), :flash => { :error => 'Please enter a valid discount' } unless VALID_DISCOUNT_REGEX.match(params[:discount]) || @discount >= 100
+  end
+
+  def ensure_pos_order
+    unless @order.is_pos?
+      flash[:error] = 'This is not a pos order'
+      render :show
+    end
+  end
+
+  def ensure_unpaid_order
+    if @order.paid?
+      flash[:error] = 'This order is already completed. Please use a new one.'
+      render :show
+    end
+  end
+
+  def load_line_item
+    @item = @order.line_items.where(:id => params[:line_item_id]).first
+  end
+
+  def check_unpaid_pos_order
+    if spree_current_user.unpaid_pos_orders.present?
+      add_error("You have an unpaid/empty order. Please either complete it or update items in the same order.")
+      redirect_to admin_pos_show_order_path(:number => spree_current_user.unpaid_pos_orders.first.number)
+    end
+  end
+
+  def ensure_existing_user 
+    invalid_user_message = "No user with email #{params[:email]}" if params[:email].present? && Spree::User.where(:email => params[:email]).blank?
+    invalid_user_message = "User Already exists for the email #{params[:new_email]}" if params[:new_email].present? && Spree::User.where(:email => params[:new_email]).present?
+    redirect_to admin_pos_show_order_path(:number => @order.number), :flash => { :error => invalid_user_message } if invalid_user_message
+  end
+
+  def ensure_pos_shipping_method
+    redirect_to '/', :flash => { :error => 'No shipping method available for POS orders. Please assign one.'} and return unless Spree::ShippingMethod.where(:name => SpreePos::Config[:pos_shipping]).first
+  end
+
+  def load_order
+    @order = Spree::Order.by_number(params[:number]).includes([{ :line_items => [{ :variant => [:default_price, { :product => [:master] } ] }] } , { :adjustments => :adjustable }] ).first
+    raise "No order found for -#{params[:number]}-" unless @order
+  end
+  
+  def load_variant
+    @variant = Spree::Variant.where(:id => params[:item]).first
+    unless @variant
+      flash[:error] = "No variant"
+      render :show
+    end
+  end
+
+  def check_valid_order
+    if @order.paid? || !@order.is_pos?
+      flash[:error] = 'This order is already completed. Please use a new one.' if @order.paid?
+      flash[:error] = 'This is not a pos order' unless @order.is_pos?
+      render :show
+    end
+  end
+
+  def ensure_payment_method
+    if Spree::PaymentMethod.where(:id => params[:payment_method_id]).blank?
+      flash[:error] = 'Please select a payment method'
+      redirect_to admin_pos_show_order_path(:number => @order.number)
+    end
+  end
+
+  def init_pos
+    @order = Spree::Order.new(:state => "complete", :is_pos => true, :completed_at => Time.current, :payment_state => 'balance_due')
+    @order.associate_user!(spree_current_user)
+    @order.save!
+    @order.assign_shipment_for_pos
+    @order.save!
+    session[:pos_order] = @order.number
+  end
+
+  def add_error error_message
+    flash[:error] = "" unless flash[:error]
+    flash[:error] << error_message
+  end
+
+  def add_variant var , quant = 1
+    line_item = @order.contents.add(var, quant, nil, @order.shipment)
+    var.product.save
+    line_item
+  end
+
+  def user_stock_locations(user)
+    # use this code when stock managers implemented
+    # @stock_location ||= (user.has_spree_role?('pos_admin') ? Spree::StockLocation.active.stores : user.stock_locations.active.store)
+    Spree::StockLocation.active.stores
+  end
+  
+  def init_search
+    params[:q] ||= {}
+    params[:q].merge!(:meta_sort => "product_name asc", :deleted_at_null => "1", :product_deleted_at_null => "1", :published_at_not_null => "1")
+    params[:q][:product_name_cont].try(:strip!)
+  end
+
+  def print
+    @order.complete_via_pos
+    url = SpreePos::Config[:pos_printing].sub("number" , @order.number.to_s)
+    redirect_to url
+  end
+end