piggybak 0.5.5 → 0.6.0

data/README.md

@@ -11,46 +11,47 @@ Modular / mountable ecommerce gem. Features:
 
 * Fully defined backend RailsAdmin interface for adding orders on the backend
 
+
+Announcements
+========
+
+* Variants were recently changed to sellables, to provide the opportunity for advanced variant support via an extension.
+
+* Significant recent rearchitecture has been applied to the order line items. Stay tuned for the documentation.
+
+* Review the new installation process below.
+ 
+
 Installation
 ========
 
-* First, add to Gemfile (from RubyGems, with version specified, or source) with *one* of the following options:
+* First create a new rails project:
+        rails new webstore
+
+* Config your database.yml and create the databases
+		
+* Add to Gemfile:
     
         gem "piggybak"
-        gem "piggybak", '0.4.19'
-        gem "piggybak", :git => "git://github.com/stephskardal/piggybak.git"
  
-* Next, run rake task to copy migrations:
+* Next, run bundle install:
 
-        rake piggybak_engine:install:migrations
+        bundle install
 
-* Next, run rake task to run migrations:
+* Next, run the piggybak install command:
 
-        rake db:migrate
+        piggybak install
 
-* Next, mount in your application by adding:
+(NOTE: If you run into an error saying that piggybak gem is missing, use bundle exec piggybak install)
 
-        mount Piggybak::Engine => '/checkout', :as => 'piggybak'" to config/routes
-
-* Add acts_as_variant to any model that will become a sellable item.
+* Piggybak is now installed and ready to be added to whatever model class will be sold.
 
         class Product < ActiveRecord::Base
-          acts_as_variant
+          acts_as_sellable
         end
 
-* You must include jquery_ujs in your application.js file in to get the remove item from cart functionality to work.
-
-        //= require jquery_ujs
-
-* You must add the following to your application layout:
-
-        <% if "#{params[:controller]}##{params[:action]}" == "piggybak/orders#submit" -%>
-        <%= javascript_include_tag "piggybak-application" %>
-        <% end -%>
+* Piggybak checkout is located at /checkout
 
-* And you must add this to your production configuration, in order for this asset to be precompiled (and in some cases, ensure that it is served via SSL):
-
-        config.assets.precompile += %w( piggybak-application.js )
 
 More Details
 ========
@@ -62,7 +63,13 @@ Visit the project website [here][project-website] to see more documentation and
 TODO
 ========
 
-On order notes functionality, changes in addresses are not recorded. This functionality is broken and needs attention.
+* Ensure that changes in nested addresses are recorded on order notes.
+
+* Add admin side validation to limit 1 payment at a time
+
+* Add/check validation to ensure sufficient inventory
+
+* Add copy from billing above shipping address section button
 
 Copyright
 ========

data/VERSION

@@ -1 +1 @@
-0.5.5
+0.6.0

data/app/assets/javascripts/piggybak.js

@@ -4,7 +4,8 @@ var page_load = 1;
 var shipping_field;
 
 $(function() {
-	shipping_field = $('#piggybak_order_shipments_attributes_0_shipping_method_id');
+	piggybak.prevent_double_click();
+	shipping_field = $('#piggybak_order_line_items_attributes_0_shipment_attributes_shipping_method_id');
 	shipping_els = $('#piggybak_order_shipping_address_attributes_state_id,#piggybak_order_shipping_address_attributes_country_id,#piggybak_order_shipping_address_attributes_zip');
 	piggybak.initialize_listeners();
 	piggybak.update_shipping_options($('#piggybak_order_shipping_address_attributes_state_id'), function() {
@@ -14,6 +15,12 @@ $(function() {
 });
 
 var piggybak = {
+	prevent_double_click: function() {
+		$('#new_piggybak_order').find('input:submit').removeAttr('disabled');
+		$('#new_piggybak_order').submit(function() {
+			$(this).find('input:submit').attr('disabled', 'disabled');
+		});
+	},
 	initialize_listeners: function() {
 		shipping_els.live('change', function() {
 			piggybak.update_shipping_options($(this));
@@ -117,6 +124,9 @@ var piggybak = {
 		}
 		$('#shipping_total').html('$' + shipping_total.toFixed(2));
 		var order_total = subtotal + tax_total + shipping_total;
+		$.each($('.extra_totals'), function(i, el) {
+			order_total += parseFloat($(el).html().replace(/\$/, ''));
+		});	
 		$('#order_total').html('$' + order_total.toFixed(2));	
 	},
 	retrieve_shipping_data: function() {

data/app/assets/javascripts/piggybak.states.js

@@ -1,10 +1,5 @@
 var geodata;
 
-$(function() {
-	piggybak_states.populate_geodata();
-	piggybak_states.initialize_listeners();
-});
-
 var piggybak_states = {
 	initialize_listeners: function() {
 		$('#piggybak_order_shipping_address_attributes_country_id').change(function() {
@@ -53,3 +48,9 @@ var piggybak_states = {
 		return;
 	}
 };
+
+$(function() {
+	piggybak_states.populate_geodata();
+	piggybak_states.initialize_listeners();
+});
+

data/app/controllers/piggybak/orders_controller.rb

@@ -10,12 +10,14 @@ module Piggybak
         begin
           ActiveRecord::Base.transaction do
             @order = Piggybak::Order.new(params[:piggybak_order])
+            @order.create_payment_shipment
 
             if Piggybak.config.logging
-              clean_params = params[:piggybak_order].clone
-              clean_params["payments_attributes"]["0"]["number"] = clean_params["payments_attributes"]["0"]["number"].mask_cc_number
-              clean_params["payments_attributes"]["0"]["verification_value"] = clean_params["payments_attributes"]["0"]["verification_value"].mask_csv
-              logger.info "#{request.remote_ip}:#{Time.now.strftime("%Y-%m-%d %H:%M")} Order received with params #{clean_params.inspect}" 
+              # TODO: Reimplement on correctly filtered params
+              #clean_params = params[:piggybak_order].clone
+              #clean_params["payments_attributes"]["0"]["number"] = clean_params["payments_attributes"]["0"]["number"].mask_cc_number
+              #clean_params["payments_attributes"]["0"]["verification_value"] = clean_params["payments_attributes"]["0"]["verification_value"].mask_csv
+              #logger.info "#{request.remote_ip}:#{Time.now.strftime("%Y-%m-%d %H:%M")} Order received with params #{clean_params.inspect}" 
             end
             @order.initialize_user(current_user, true)
 
@@ -28,6 +30,7 @@ module Piggybak
             end
 
             if @order.save
+              # TODO: Imporant: figure out how to have notifications not trigger rollback here. Instead log failed order notification sent.
               Piggybak::Notifier.order_notification(@order).deliver
 
               if Piggybak.config.logging
@@ -52,8 +55,9 @@ module Piggybak
             @order.errors[:base] << "Your order could not go through. Please try again."
           end
         end
-	  else
+      else
         @order = Piggybak::Order.new
+        @order.create_payment_shipment
         @order.initialize_user(current_user, false)
       end
     end
@@ -95,18 +99,6 @@ module Piggybak
       redirect_to rails_admin.edit_path('Piggybak::Order', order.id)
     end
 
-    def restore
-      order = Order.find(params[:id])
-      order.recorded_changer = current_user.id
-
-      if can?(:restore, order)
-        order.status = "new"
-        order.save
-      end
-
-      redirect_to rails_admin.edit_path('Piggybak::Order', order.id)
-    end
-
     def cancel
       order = Order.find(params[:id])
 
@@ -115,18 +107,18 @@ module Piggybak
         order.disable_order_notes = true
 
         order.line_items.each do |line_item|
-          line_item.mark_for_destruction
-        end
-        order.shipments.each do |shipment|
-          shipment.mark_for_destruction
+          if line_item.line_item_type != "payment"
+            line_item.mark_for_destruction
+          end
         end
-        order.update_attribute(:tax_charge, 0.00)
         order.update_attribute(:total, 0.00)
         order.update_attribute(:to_be_cancelled, true)
 
         OrderNote.create(:order_id => order.id, :note => "Order set to cancelled. Line items, shipments, tax removed.", :user_id => current_user.id)
         
         flash[:notice] = "Order #{order.id} set to cancelled. Order is now in unbalanced state."
+      else
+        flash[:error] = "You do not have permission to cancel this order."
       end
 
       redirect_to rails_admin.edit_path('Piggybak::Order', order.id)

data/app/models/piggybak/address.rb

@@ -15,7 +15,10 @@ module Piggybak
 
     after_initialize :set_default_country
     after_save :document_address_changes
-
+    
+    attr_accessible :firstname, :lastname, :address1, :location,
+                    :address2, :city, :state_id, :zip, :country_id
+    
     def set_default_country
       self.country ||= Country.find_by_abbr(Piggybak.config.default_country)
     end

data/app/models/piggybak/adjustment.rb

@@ -1,29 +1,5 @@
 module Piggybak
   class Adjustment < ActiveRecord::Base
-    belongs_to :order
-    belongs_to :source, :polymorphic => true
-    attr_accessor :user_id
-    acts_as_changer
-
-    validates_presence_of :order_id, :total
-    validates_numericality_of :total
-    validates_presence_of :source
-
-    before_validation :set_source
-
-    def set_source
-      if self.source.nil? && self.user_id.present?
-        self.source = User.find(self.user_id)
-      end
-    end
-
-    def admin_label
-      if !self.new_record? 
-        return "Adjustment ##{self.id} (#{self.created_at.strftime("%m-%d-%Y")}): " + 
-          "$#{"%.2f" % self.total}"
-      else
-        return ""
-      end
-    end
+    #TODO: Note this is deprecated after 0.5.5
   end
 end

data/app/models/piggybak/cart.rb

@@ -4,18 +4,19 @@ module Piggybak
     attr_accessor :total
     attr_accessor :errors
     attr_accessor :extra_data
+    alias :subtotal :total
   
     def initialize(cookie='')
       self.items = []
       self.errors = []
       cookie ||= ''
       cookie.split(';').each do |item|
-        item_variant = Piggybak::Variant.find_by_id(item.split(':')[0])
-        if item_variant.present?
-          self.items << { :variant => item_variant, :quantity => (item.split(':')[1]).to_i }
+        item_sellable = Piggybak::Sellable.find_by_id(item.split(':')[0])
+        if item_sellable.present?
+          self.items << { :sellable => item_sellable, :quantity => (item.split(':')[1]).to_i }
         end
       end
-      self.total = self.items.sum { |item| item[:quantity]*item[:variant].price }
+      self.total = self.items.sum { |item| item[:quantity]*item[:sellable].price }
 
       self.extra_data = {}
     end
@@ -38,14 +39,14 @@ module Piggybak
 
     def self.add(cookie, params)
       cart = to_hash(cookie)
-      cart["#{params[:variant_id]}"] ||= 0
-      cart["#{params[:variant_id]}"] += params[:quantity].to_i
+      cart["#{params[:sellable_id]}"] ||= 0
+      cart["#{params[:sellable_id]}"] += params[:quantity].to_i
       to_string(cart)
     end
   
-    def self.remove(cookie, variant_id)
+    def self.remove(cookie, sellable_id)
       cart = to_hash(cookie)
-      cart[variant_id] = 0
+      cart[sellable_id] = 0
       to_string(cart)
     end
   
@@ -58,7 +59,7 @@ module Piggybak
     def to_cookie
       cookie = ''
       self.items.each do |item|
-        cookie += "#{item[:variant].id.to_s}:#{item[:quantity].to_s};" if item[:quantity].to_i > 0
+        cookie += "#{item[:sellable].id.to_s}:#{item[:quantity].to_s};" if item[:quantity].to_i > 0
       end
       cookie
     end
@@ -67,20 +68,20 @@ module Piggybak
       self.errors = []
       new_items = []
       self.items.each do |item|
-        if !item[:variant].active
-          self.errors << ["Sorry, #{item[:variant].description} is no longer for sale"]
-        elsif item[:variant].unlimited_inventory || item[:variant].quantity >= item[:quantity]
+        if !item[:sellable].active
+          self.errors << ["Sorry, #{item[:sellable].description} is no longer for sale"]
+        elsif item[:sellable].unlimited_inventory || item[:sellable].quantity >= item[:quantity]
           new_items << item
-        elsif item[:variant].quantity == 0
-          self.errors << ["Sorry, #{item[:variant].description} is no longer available"]
+        elsif item[:sellable].quantity == 0
+          self.errors << ["Sorry, #{item[:sellable].description} is no longer available"]
         else
-          self.errors << ["Sorry, only #{item[:variant].quantity} available for #{item[:variant].description}"]
-          item[:quantity] = item[:variant].quantity
+          self.errors << ["Sorry, only #{item[:sellable].quantity} available for #{item[:sellable].description}"]
+          item[:quantity] = item[:sellable].quantity
           new_items << item if item[:quantity] > 0
         end
       end
       self.items = new_items
-      self.total = self.items.sum { |item| item[:quantity]*item[:variant].price }
+      self.total = self.items.sum { |item| item[:quantity]*item[:sellable].price }
     end
 
     def set_extra_data(form_params)

data/app/models/piggybak/line_item.rb

@@ -2,39 +2,126 @@ module Piggybak
   class LineItem < ActiveRecord::Base
     belongs_to :order
     acts_as_changer
-    belongs_to :variant
-  
-    validates_presence_of :variant_id
-    validates_presence_of :total
-    validates_presence_of :price
-    validates_presence_of :description
-    validates_presence_of :quantity
+    belongs_to :sellable
+
+    validates_presence_of :price, :description, :quantity
     validates_numericality_of :quantity, :only_integer => true, :greater_than_or_equal_to => 0
 
-    after_create :decrease_inventory, :if => Proc.new { |line_item| !line_item.variant.unlimited_inventory }
-    after_destroy :increase_inventory, :if => Proc.new { |line_item| !line_item.variant.unlimited_inventory }
-    after_update :update_inventory, :if => Proc.new { |line_item| !line_item.variant.unlimited_inventory }
-        
+    after_create :decrease_inventory, :if => Proc.new { |line_item| line_item.line_item_type == 'sellable' && !line_item.sellable.unlimited_inventory }
+    after_destroy :increase_inventory, :if => Proc.new { |line_item| line_item.line_item_type == 'sellable' && !line_item.sellable.unlimited_inventory }
+    after_update :update_inventory, :if => Proc.new { |line_item| line_item.line_item_type == 'sellable' && !line_item.sellable.unlimited_inventory }
+
+    attr_accessible :sellable_id, :price, :unit_price, :description, :quantity, :line_item_type
+
+    after_initialize :initialize_line_item
+    before_validation :preprocess
+    before_destroy :destroy_associated_item
+
+    def initialize_line_item
+      self.quantity ||= 1
+      self.price ||= 0
+    end
+
+    def preprocess
+      # TODO: Investigate if this is unnecessary if you use reject_if on accepts_nested_attributes_for
+      Piggybak.config.line_item_types.each do |k, v|
+        if v.has_key?(:nested_attrs) && k != self.line_item_type.to_sym
+          self.send("#{k}=", nil) 
+        end
+      end
+
+      method = "preprocess_#{self.line_item_type}"
+      self.send(method) if self.respond_to?(method)
+    end
+
+    def preprocess_sellable
+      sellable = Piggybak::Sellable.find(self.sellable_id)
+
+      return if sellable.nil?
+
+      self.description = sellable.description
+      self.unit_price = sellable.price
+      self.price = self.unit_price*self.quantity.to_i 
+    end
+
+    def preprocess_shipment
+      if !self._destroy
+        if (self.new_record? || self.shipment.status != 'shipped') && self.shipment && self.shipment.shipping_method
+          calculator = self.shipment.shipping_method.klass.constantize
+          self.price = calculator.rate(self.shipment.shipping_method, self)
+          self.price = ((self.price*100).to_i).to_f/100
+          self.description = self.shipment.shipping_method.description
+        end
+        if self.shipment.nil? || self.shipment.shipping_method.nil?
+          self.price = 0.00
+          self.description = "Shipping"
+        end
+      end
+    end
+
+    def preprocess_payment
+      if self.new_record?
+        self.payment.payment_method_id ||= Piggybak::PaymentMethod.find_by_active(true).id if self.payment
+        self.description = "Payment"
+        self.price = 0
+      end
+    end
+
+    def postprocess_payment
+      return true if !self.new_record?
+
+      if self.payment.process(self.order)
+        self.price = -1*self.order.total_due
+        self.order.total_due = 0
+        return true
+      else
+        return false
+      end
+    end
+
+    # Dependent destroy is not working as expected, so this is in place
+    def destroy_associated_item
+      line_item_type_sym = self.line_item_type.to_sym
+      if Piggybak.config.line_item_types[line_item_type_sym].has_key?(:nested_attrs)
+        if Piggybak.config.line_item_types[line_item_type_sym][:nested_attrs]
+          b = self.send("#{line_item_type_sym}")
+          b.destroy if b.present?
+        end
+      end
+    end
+
+    def self.line_item_type_select
+      Piggybak.config.line_item_types.select { |k, v| v[:visible] }.collect { |k, v| [k.to_s.humanize.titleize, k] }
+    end
+
+    def sellable_id_enum
+      ::Piggybak::Sellable.all.collect { |s| ["#{s.description}: $#{s.price}", s.id ] }
+    end
+
     def admin_label
-      "#{self.quantity} x #{self.variant.description}"
+      if self.line_item_type == 'sellable'
+        "#{self.quantity} x #{self.description} ($#{sprintf("%.2f", self.unit_price)}): $#{sprintf("%.2f", self.price)}".gsub('"', '&quot;')
+      else
+        "#{self.description}: $#{sprintf("%.2f", self.price)}".gsub('"', '&quot;')
+      end
     end
 
     def decrease_inventory
-      self.variant.update_inventory(-1 * self.quantity)
+      self.sellable.update_inventory(-1 * self.quantity)
     end
 
     def increase_inventory
-      self.variant.update_inventory(self.quantity)
+      self.sellable.update_inventory(self.quantity)
     end
 
     def update_inventory
-      if self.variant_id != self.variant_id_was
-        old_variant = Variant.find(self.variant_id_was)
-        old_variant.update_inventory(self.quantity_was)
-        self.variant.update_inventory(-1*self.quantity)
+      if self.sellable_id != self.sellable_id_was
+        old_sellable = Sellable.find(self.sellable_id_was)
+        old_sellable.update_inventory(self.quantity_was)
+        self.sellable.update_inventory(-1*self.quantity)
       else
         quantity_diff = self.quantity_was - self.quantity
-        self.variant.update_inventory(quantity_diff)
+        self.sellable.update_inventory(quantity_diff)
       end
     end
   end