piggybak 0.1.1 → 0.2.0

data/Gemfile

@@ -11,3 +11,5 @@ group :development do
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end
+
+gem "countries"

data/Gemfile.lock

@@ -1,6 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    countries (0.8.1)
+      currencies (= 0.4.0)
+      currencies (>= 0.2.0)
+    currencies (0.4.0)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
@@ -14,5 +18,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  countries
   jeweler (~> 1.6.4)
   rcov

data/README.md

@@ -0,0 +1,117 @@
+Piggybak Gem (Engine)
+========
+
+Modular / mountable ecommerce gem. Features:
+
+* Configurable tax methods, shipping methods, payment methods
+
+* One page checkout, with AJAX for shipping and tax calculations
+
+* Order processing completed in transaction, minimizing orphan data created 
+
+* Fully defined backend RailsAdmin interface for adding orders on the backend
+
+This engine explicitly excludes:
+
+* SSL configuration (to be handled in your parent application)
+
+* Redirects on login / logout (see recipe below)
+
+* Coupons and Gift cerficates (May be added later)
+
+* Per unit inventory tracking
+
+* Downloadable products
+
+This engine is highly dependent on: 
+
+* Rails 3.1 (Assets, Engines)
+
+* RailsAdmin (Admin UI) 
+
+* Devise (User Authentication)
+
+* CanCan (User Authorization)
+
+Installation
+========
+
+* First, add to Gemfile:
+    
+        gem "piggybak", :git => "git://github.com/stephskardal/demo.git"
+
+* Next, run rake task to copy migrations:
+
+        rake piggybak_engine:install:migrations
+
+* Next, run rake task to run migrations:
+
+        rake db:migrate
+
+* Next, mount in your application by adding:
+
+        mount Piggybak::Engine => '/checkout', :as => 'piggybak'" to config/routes
+
+Integration Components
+========
+
+* Add acts_as_variant to models that will be sellable
+* Add acts_as_orderer to user model (or model that devise hooks into as authenticated user)
+* Add <%= cart_form(@some_item) %> to view to display cart form
+* Add <%= cart_link %> to display link to cart
+* Add <%= orders_link %> to display link to user orders
+
+Recipes
+========
+
+* Redirect after login / logout
+
+        before_filter :set_last_page
+        def set_last_page
+            if !request.xhr? && !request.url.match(/users\/sign_in/) && !request.url.match(/users\/sign_out/)
+            session[:return_to] = request.url
+            end 
+        end 
+        def after_sign_in_path_for(resource_or_scope)
+            session[:return_to] || root_url
+        end 
+        def after_sign_out_path_for(resource_or_scope)
+            session[:return_to] || root_url
+        end
+
+* Cancan access control
+
+        class Ability
+            include CanCan::Ability
+            def initialize(user)
+                if user && user.roles.include?(Role.find_by_name("admin"))
+                    can :access, :rails_admin
+                    can :manage, [ #Insert your app models here
+                                  ::Piggybak::Variant,
+                                  ::Piggybak::ShippingMethod,
+                                  ::Piggybak::PaymentMethod,
+                                  ::Piggybak::TaxMethod,
+                                  ::Piggybak::State,
+                                  ::Piggybak::Country]
+                   can [:download, :email, :read, :create, :update, :history, :export], ::Piggybak::Order
+                end
+            end
+        end
+
+
+Roadmap / TODOs
+========
+
+* Figure out how to make entire payments section read only, except for ability to refund
+* Add refunds: Add actionable link under payments
+* Handle state options in admin: selected state or free text
+
+* Create rake task for copying over views, and make sure app views will override gems
+* Test email send functionality
+* Test a different user model
+* Add unit testing
+
+Copyright
+========
+
+Copyright (c) 2011 Steph Skardal. See LICENSE.txt for further details.

data/Rakefile

@@ -20,11 +20,12 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Mountable ecommerce}
   gem.description = %Q{Mountable ecommerce}
   gem.email = "steph@endpoint.com"
-  gem.authors = ["Steph Skardal"]
+  gem.authors = ["Steph Skardal", "Brian Buchalter"]
 
   gem.add_dependency "rails_admin"
   gem.add_dependency "devise"
   gem.add_dependency "activemerchant"
+  gem.add_dependency "countries"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/app/assets/javascripts/piggybak.js

@@ -1,13 +1,54 @@
 var tax_total = 0;
+var geodata;
 
 $(function() {
-	piggybak.update_shipping_options($('#piggybak_order_shipping_address_attributes_state_id'));
+	piggybak.populate_geodata();
 	piggybak.initialize_listeners();
+	piggybak.update_shipping_options($('#piggybak_order_shipping_address_attributes_state_id'));
 	piggybak.update_tax();
 });
 
 var piggybak = {
+	populate_geodata: function() {
+		$.ajax({
+			url: geodata_lookup,
+			cached: false,
+			dataType: "JSON",
+			success: function(data) {
+				geodata = data;
+			}
+		});
+	},
+	update_state_option: function(type, block) {
+		var country_field = $('#piggybak_order_' + type + '_address_attributes_country_id');
+		var country_id = country_field.val();
+		var new_field;
+
+		if(geodata.countries["country_" + country_id].length > 0) {
+			new_field = $('<select>');
+			$.each(geodata.countries["country_" + country_id], function(i, j) {
+				new_field.append($('<option>').val(j.id).html(j.name));
+			});	
+		} else {
+			new_field = $('<input>');
+		}
+		var old_field = $('#piggybak_order_' + type + '_address_attributes_state_id');
+		new_field.attr('name', old_field.attr('name'));
+		new_field.attr('id', old_field.attr('id'));
+		old_field.replaceWith(new_field);
+
+		if(block) {
+			block();
+		}
+		return;
+	},
 	initialize_listeners: function() {
+		$('#piggybak_order_shipping_address_attributes_country_id').change(function() {
+			piggybak.update_state_option('shipping');
+		});
+		$('#piggybak_order_billing_address_attributes_country_id').change(function() {
+			piggybak.update_state_option('billing');
+		});
 		$('#piggybak_order_shipping_address_attributes_state_id').change(function() {
 			piggybak.update_shipping_options($(this));
 		});
@@ -17,8 +58,24 @@ var piggybak = {
 		$('#shipping select').change(function() {
 			piggybak.update_totals();
 		});
+		$('#shipping_address #copy').click(function() {
+			piggybak.copy_from_billing();
+			return false;
+		});
 		return;
 	},
+	copy_from_billing: function() {
+		$('#billing_address input').each(function(i, j) {
+			var id = $(j).attr('id').replace(/billing_address/, 'shipping_address');
+			$('#' + id).val($(j).val());	
+		});
+		var country = $('#piggybak_order_billing_address_attributes_country_id').val();
+		$('#piggybak_order_shipping_address_attributes_country_id').val(country);
+		piggybak.update_state_option('shipping', function() {
+			var state = $('#piggybak_order_billing_address_attributes_state_id').val();
+			$('#piggybak_order_shipping_address_attributes_state_id').val(state);
+		});
+	},
 	update_shipping_options: function(field) {
 		var shipping_field = $('#piggybak_order_shipments_attributes_0_shipping_method_id');
 		shipping_field.hide();
@@ -64,7 +121,10 @@ var piggybak = {
 	update_totals: function() {
 		var subtotal = $('#subtotal_total').data('total');
 		$('#tax_total').html('$' + tax_total.toFixed(2));
-		var shipping_total = $('#shipping select option:selected').data('rate');
+		var shipping_total = 0;
+		if($('#shipping select option:selected').length) {
+			shipping_total = $('#shipping select option:selected').data('rate');
+		}
 		$('#shipping_total').html('$' + shipping_total.toFixed(2));
 		var order_total = subtotal + tax_total + shipping_total;
 		$('#order_total').html('$' + order_total.toFixed(2));	

data/app/controllers/piggybak/orders_controller.rb

@@ -42,7 +42,6 @@ module Piggybak
           end
         end
       rescue Exception => e
-        @message = e.message 
         @cart = Piggybak::Cart.new(request.cookies["cart"])
 
         if current_user
@@ -63,18 +62,31 @@ module Piggybak
     end
 
     def list
-      @user = current_user
-      redirect_to root if @user.nil?
+      redirect_to root if current_user.nil?
+    end
+
+    def download
+      @order = Piggybak::Order.find(params[:id])
+
+      if can?(:download, @order)
+        render :layout => false
+      else
+        render "no_access"
+      end
     end
 
     def email
       order = Order.find(params[:id])
-      Piggybak::Notifier.order_notification(order)
-      flash[:notice] = "Email notification sent."
+
+      if can?(:email, order)
+        Piggybak::Notifier.order_notification(order)
+        flash[:notice] = "Email notification sent."
+      end
 
       redirect_to rails_admin.edit_path('Piggybak::Order', order.id)
     end
 
+    # AJAX Actions from checkout
     def shipping
       cart = Piggybak::Cart.new(request.cookies["cart"])
       cart.extra_data = params
@@ -88,5 +100,14 @@ module Piggybak
       total_tax = Piggybak::TaxMethod.calculate_tax(cart)
       render :json => { :tax => total_tax }
     end
+
+    def geodata
+      countries = ::Piggybak::Country.find(:all, :include => :states)
+      data = countries.inject({}) do |h, country|
+        h["country_#{country.id}"] = country.states
+        h
+      end
+      render :json => { :countries => data }
+    end
   end
 end

data/{lib/application_helper.rb → app/helpers/piggybak_helper.rb}

@@ -1,4 +1,4 @@
-module ApplicationHelper
+module PiggybakHelper
   def cart_form(object)
     render "piggybak/cart/form", :object => object
   end
@@ -9,4 +9,9 @@ module ApplicationHelper
       link_to  "#{pluralize(nitems, 'item')}: #{number_to_currency(cart.total)}", piggybak.cart_url
     end
   end
+  def orders_link(text)
+    if current_user
+      link_to text, piggybak.orders_list_url
+    end
+  end
 end

data/app/models/piggybak/address.rb

@@ -1,13 +1,25 @@
 module Piggybak 
   class Address < ActiveRecord::Base
     belongs_to :state
+    belongs_to :country
 
     validates_presence_of :firstname
     validates_presence_of :lastname
     validates_presence_of :address1
     validates_presence_of :city
     validates_presence_of :state_id
+    validates_presence_of :country_id
     validates_presence_of :zip
+
+    after_initialize :set_default_country
+
+    def set_default_country
+      self.country ||= Address.DEFAULT_COUNTRY
+    end
+
+    def self.DEFAULT_COUNTRY
+      Country.find_by_abbr("US")
+    end
       
     def admin_label
       address = "#{self.firstname} #{self.lastname}<br />"
@@ -15,7 +27,8 @@ module Piggybak
       if self.address2 && self.address2 != ''
         address += "#{self.address2}<br />"
       end
-      address += "#{self.city}, #{self.state.abbr} #{self.zip}"
+      address += "#{self.city}, #{self.state ? self.state.name : self.state_id} #{self.zip}<br />"
+      address += "#{self.country.name}"
       address
     end
     alias :display :admin_label  

data/app/models/piggybak/cart.rb

@@ -10,9 +10,12 @@ module Piggybak
       self.errors = []
       cookie ||= ''
       cookie.split(';').each do |item|
-        self.items << { :product => Piggybak::Product.find(item.split(':')[0]), :quantity => (item.split(':')[1]).to_i }
+	    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 }
+        end
       end
-      self.total = self.items.sum { |item| item[:quantity]*item[:product].price }
+      self.total = self.items.sum { |item| item[:quantity]*item[:variant].price }
     end
   
     def self.to_hash(cookie)
@@ -33,14 +36,14 @@ module Piggybak
 
     def self.add(cookie, params)
       cart = to_hash(cookie)
-      cart["#{params[:product_id]}"] ||= 0
-      cart["#{params[:product_id]}"] += params[:quantity].to_i
+      cart["#{params[:variant_id]}"] ||= 0
+      cart["#{params[:variant_id]}"] += params[:quantity].to_i
       to_string(cart)
     end
   
-    def self.remove(cookie, product_id)
+    def self.remove(cookie, variant_id)
       cart = to_hash(cookie)
-      cart[product_id] = 0
+      cart[variant_id] = 0
       to_string(cart)
     end
   
@@ -53,7 +56,7 @@ module Piggybak
     def to_cookie
       cookie = ''
       self.items.each do |item|
-        cookie += "#{item[:product].id.to_s}:#{item[:quantity].to_s};" if item[:quantity].to_i > 0
+        cookie += "#{item[:variant].id.to_s}:#{item[:quantity].to_s};" if item[:quantity].to_i > 0
       end
       cookie
     end
@@ -62,16 +65,20 @@ module Piggybak
       self.errors = []
       new_items = []
       self.items.each do |item|
-        if item[:product].unlimited_inventory || item[:product].quantity >= item[:quantity]
+        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]
           new_items << item
+        elsif item[:variant].quantity == 0
+          self.errors << ["Sorry, #{item[:variant].description} is no longer available"]
         else
-          self.errors << ["Adjusting quantity for #{item[:product].description}"]
-          item[:quantity] = item[:product].quantity
-          new_items << item
+          self.errors << ["Sorry, only #{item[:variant].quantity} available for #{item[:variant].description}"]
+          item[:quantity] = item[:variant].quantity
+          new_items << item if item[:quantity] > 0
         end
       end
       self.items = new_items
-      self.total = self.items.sum { |item| item[:quantity]*item[:product].price }
+      self.total = self.items.sum { |item| item[:quantity]*item[:variant].price }
     end
   end
 end

data/app/models/piggybak/country.rb

@@ -0,0 +1,5 @@
+module Piggybak
+  class Country < ActiveRecord::Base
+    has_many :states
+  end
+end

data/app/models/piggybak/credit.rb

@@ -0,0 +1,8 @@
+module Piggybak
+  class Credit < ActiveRecord::Base
+    belongs_to :order
+    belongs_to :source, :polymorphic => true
+
+    validates_presence_of :total
+  end
+end