spree 0.4.1 → 0.5.0

data/vendor/extensions/shipping/app/helpers/shipments_helper.rb

@@ -0,0 +1,20 @@
+module ShipmentsHelper
+  # Creates a radio button to represent a choice of shipping method.  The choice will be disabled if for some 
+  # reason the rate is nil (perhaps the web service didn't return a quote for that method for some reason.)
+  def shipping_radio(shipping_method, order)
+    cost = shipping_method.calculate_shipping(@order)    
+    checked = @shipment.shipping_method == shipping_method || @default_method == shipping_method
+    if cost
+      radio =  "<input type='radio' name='method_id' value='#{shipping_method.id}' #{"checked='true'" if checked} onclick='calculate_order_total(this);'/>" 
+      radio += shipping_method.name
+      radio += "&nbsp; (Cost: #{number_to_currency(cost)})"
+    else
+      radio =  "<input type='radio' name='method_id' disabled='true' onclick='calculate_order_total(this);'/>"
+      radio += "<span class='disabled'>#{shipping_method.name}</span>" 
+    end
+    
+    radio += "<script type=""text/javascript"">shipping_costs.set('#{shipping_method.id}',#{cost});</script>"
+    
+    radio
+  end
+end

data/vendor/extensions/shipping/app/models/shipment.rb

@@ -0,0 +1,11 @@
+class Shipment < ActiveRecord::Base
+  belongs_to :order
+  belongs_to :shipping_method
+  before_save :calculate_shipping
+  
+  private 
+  def calculate_shipping
+    calculator = shipping_method.shipping_calculator.constantize.new
+    order.update_attribute(:ship_amount, calculator.calculate_shipping(order))
+  end
+end

data/vendor/extensions/shipping/app/models/shipping_category.rb

@@ -0,0 +1,3 @@
+class ShippingCategory < ActiveRecord::Base
+  validates_presence_of :name
+end

data/vendor/extensions/shipping/app/models/shipping_method.rb

@@ -0,0 +1,12 @@
+class ShippingMethod < ActiveRecord::Base
+  belongs_to :zone
+
+  def available?(order)
+    zone.include?(order.address)
+  end
+  
+  def calculate_shipping(order)
+    return 0 unless zone.include?(order.address)
+    return shipping_calculator.constantize.new.send(:calculate_shipping, order)
+  end
+end

data/vendor/extensions/shipping/app/views/admin/shipping_categories/_form.html.erb

@@ -0,0 +1,6 @@
+<table>
+	<tr>
+    <td><%=t("Name")%>:</td>
+    <td><%= f.text_field :name, {"style" => "width:200px"} %></td>
+  </tr>
+</table>

data/vendor/extensions/shipping/app/views/admin/shipping_categories/edit.html.erb

@@ -0,0 +1,8 @@
+<h1><%= t("Editing Shipping Category") %></h1>
+<%= error_messages_for :shipping_category %>
+<% form_for(:shipping_category, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag t("Update")%>
+  </p>
+<% end %>

data/vendor/extensions/shipping/app/views/admin/shipping_categories/index.html.erb

@@ -0,0 +1,24 @@
+<h1><%=t("Shipping Categories") %></h1>
+<table class="admin-report" width="545">
+  <thead>
+    <tr>
+	    <th><%=t("Name")%></th>
+      <th><%=t("Action")%></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @shipping_categories.each do |shipping_category| %>
+      <tr class="<%= cycle('even', 'odd') %>">
+        <td><%=shipping_category.name %></td>
+        <td>
+          <%=link_to t("Edit"), edit_object_url(shipping_category) %> |
+          <%=link_to t("Delete"), object_url(shipping_category), :method => :delete %>
+        </td>
+      </tr>
+    <% end %>
+    <% if @shipping_categories.empty? %>
+      <tr><td colspan="5">None.</td></tr>
+    <% end %>
+  </tbody>
+</table>
+<%= link_to t("New Shipping Category"), new_object_url %>

data/vendor/extensions/shipping/app/views/admin/shipping_categories/new.html.erb

@@ -0,0 +1,10 @@
+<h1><%= t("New Shipping Category") %></h1>
+
+<%= error_messages_for :shipping_category %>
+
+<% form_for(:shipping_category, :url => collection_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%= submit_tag t("Create") %>
+  </p>
+<% end %>

data/vendor/extensions/shipping/app/views/admin/shipping_methods/_form.html.erb

@@ -0,0 +1,14 @@
+<table>
+	<tr>
+    <td><%=t("Name")%>:</td>
+    <td><%= f.text_field :name, {"style" => "width:200px"} %></td>
+  </tr>
+  <tr>
+    <td><%=t("Zone")%>:</td>
+    <td><%= collection_select(:shipping_method, :zone_id, @available_zones, :id, :name, {}, {"style" => "width:200px"}) %></td>
+  </tr>
+	<tr>
+    <td><%=t("Shipping Calculator")%>:</td>
+    <td><%= f.text_field :shipping_calculator, {"style" => "width:200px"} %></td>
+  </tr>
+</table>

data/vendor/extensions/shipping/app/views/admin/shipping_methods/edit.html.erb

@@ -0,0 +1,8 @@
+<h1><%= t("Editing Shipping Method") %></h1>
+<%= error_messages_for :shipping_rate %>
+<% form_for(:shipping_method, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag t("Update")%>
+  </p>
+<% end %>

data/vendor/extensions/shipping/app/views/admin/shipping_methods/index.html.erb

@@ -0,0 +1,28 @@
+<h1><%=t("Shipping Methods") %></h1>
+<table class="admin-report" width="545">
+  <thead>
+    <tr>
+	    <th><%=t("Name")%></th>
+      <th><%=t("Zone")%></th>
+      <th><%=t("Calculator")%></th>
+      <th><%=t("Action")%></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @shipping_methods.each do |shipping_method| %>
+      <tr class="<%= cycle('even', 'odd') %>">
+        <td><%=shipping_method.name %></td>
+        <td><%=shipping_method.zone.name %></td>
+        <td><%=shipping_method.shipping_calculator %></td>
+        <td>
+          <%=link_to t("Edit"), edit_object_url(shipping_method) %> |
+          <%=link_to t("Delete"), object_url(shipping_method), :method => :delete %>
+        </td>
+      </tr>
+    <% end %>
+    <% if @shipping_methods.empty? %>
+      <tr><td colspan="5">None.</td></tr>
+    <% end %>
+  </tbody>
+</table>
+<%= link_to t("New Shipping Method"), new_object_url %>

data/vendor/extensions/shipping/app/views/admin/shipping_methods/new.html.erb

@@ -0,0 +1,10 @@
+<h1><%= t("New Shipping Method") %></h1>
+
+<%= error_messages_for :shipping_method %>
+
+<% form_for(:shipping_method, :url => collection_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%= submit_tag t("Create") %>
+  </p>
+<% end %>

data/vendor/extensions/shipping/app/views/orders/fatal_shipping.html.erb

@@ -0,0 +1,6 @@
+<!-- NOTE: Hopefull this page is never seen.  Its suggested that you customize it for each application anyways so we're 
+not bothering with translation (the flash error message will be translated.)_ -->
+<p>
+  We are experiencing technical difficulties obtaining a shipping quote from one or more carriers.  Your order has been 
+  saved and we hope to resolve the issue shortly.  We appologize for the inconvenience.
+</p>

data/vendor/extensions/shipping/app/views/shipments/_form.html.erb

@@ -0,0 +1,46 @@
+<table class="order-summary" style="width:100%;">
+  <tr>
+    <th><%= t('Item Description') %></th>
+    <th><%= t('Price') %></th>
+    <th><%= t('Qty') %></th>
+    <th width="250" align="right"><%= t('Total') %></th>
+  </tr>
+  <% @order.line_items.each do |item| %>
+  <tr >
+    <td width="300"><%=item.variant.product.name-%> <%= "(" + variant_options(item.variant) + ")" unless item.variant .option_values.empty? %></td>
+    <td valign="top"><%= number_to_currency item.price -%></td>
+    <td valign="top"><%=item.quantity-%></td>
+    <td valign="top" align="right"><%= number_to_currency (item.price * item.quantity)-%></td>
+  </tr>
+  <% end %>      
+  <tr id="subtotal-row">
+    <td colspan="3" align="right"><b><%= t('Subtotal') %>:</b></td>
+    <td align="right"><%= number_to_currency @order.item_total -%></td>
+  </tr>
+  <tr>
+    <td colspan="3" align="right"><b><%= t('Tax') %>:</b></td>
+    <td align="right"><%= number_to_currency @order.tax_amount -%></td>
+  </tr>
+  <tr><th colspan="4"/></tr>
+  <tr>
+    <th colspan="4"><%= t('Select preferred shipping option') %></th>
+  </tr>
+  <tr>
+    <td class="simple-radios">
+    	<% @shipping_methods.each do |shipping_method| %>
+		  	<li>
+		  	  <%= shipping_radio(shipping_method, @order) %>
+		  	</li>
+		  <% end%>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="3" align="right"><b><%= t('Order Total') %>:</b></td>
+    <td id="order_total_cell" align="right"><%= number_to_currency(@order.total + @default_method.calculate_shipping(@order))%></td>
+  </tr>
+</table>
+<script type="text/javascript">
+	var order_total_without_shipping = <%= @order.total %>;
+</script>
+
+ 

data/vendor/extensions/shipping/app/views/shipments/edit.html.erb

@@ -0,0 +1,8 @@
+<%= error_messages_for :shipment %>
+<h1><%= t("Shipment") %></h1>
+<% form_for(:shipment, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <div align="right">
+    <%= submit_tag t('Continue') %>
+  </div>
+<% end %>

data/vendor/extensions/shipping/app/views/shipments/new.html.erb

@@ -0,0 +1,8 @@
+<%=error_messages_for :shipment%>
+<h1><%= t("Shipment")%></h1>
+<% form_for(:shipment, :url => order_shipments_url(@order)) do |f| %>
+  <%= render :partial => 'form', :locals => {:f => f} %>
+  <div align="right">
+    <%= submit_tag t('Continue') %>
+  </div>
+<% end %>

data/vendor/extensions/shipping/db/migrate/20081003211336_create_shipping_methods.rb

@@ -0,0 +1,14 @@
+class CreateShippingMethods < ActiveRecord::Migration
+  def self.up
+    create_table :shipping_methods do |t|
+      t.references :zone
+      t.string :shipping_calculator
+      t.string :name
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :shipping_methods
+  end
+end

data/vendor/extensions/shipping/db/migrate/20081003233427_create_shipping_categories.rb

@@ -0,0 +1,15 @@
+class CreateShippingCategories < ActiveRecord::Migration
+  def self.up
+    create_table :shipping_categories do |t|
+      t.string :name
+      t.timestamps
+    end
+    
+    add_column :products, :shipping_category_id, :integer, :default => nil
+  end
+
+  def self.down
+    drop_table :shipping_categories
+    remove_column :products, :shipping_category_id
+  end
+end

data/vendor/extensions/shipping/db/migrate/20081015001711_create_shipments.rb

@@ -0,0 +1,14 @@
+class CreateShipments < ActiveRecord::Migration
+  def self.up
+    create_table :shipments do |t|
+      t.references :order
+      t.references :shipping_method
+      t.string :tracking
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :shipments
+  end
+end

data/vendor/extensions/shipping/db/migrate/20081023134446_add_product_dimensions.rb

@@ -0,0 +1,19 @@
+class AddProductDimensions < ActiveRecord::Migration
+  def self.up
+    change_table :variants do |t|
+      t.decimal :weight, :precision => 8, :scale => 2
+      t.decimal :height, :precision => 8, :scale => 2
+      t.decimal :width, :precision => 8, :scale => 2
+      t.decimal :depth, :precision => 8, :scale => 2
+    end
+  end
+
+  def self.down
+    change_table :variants do |t|
+      t.remove :weight
+      t.remove :height
+      t.remove :width
+      t.remove :depth
+    end
+  end
+end

data/vendor/extensions/shipping/db/sample/shipping_categories.yml

@@ -0,0 +1,2 @@
+default_shipping:
+  name: Default Shipping

data/vendor/extensions/shipping/db/sample/shipping_methods.yml

@@ -0,0 +1,12 @@
+ups_ground:
+  name: UPS Ground
+  zone: available_shipping
+  shipping_calculator: Spree::FlatRateShipping::Calculator
+ups_two_day:
+  name: UPS Two Day
+  zone: available_shipping
+  shipping_calculator: Spree::FlatRateShipping::Calculator
+ups_one_day:
+  name: UPS One Day
+  zone: available_shipping
+  shipping_calculator: Spree::FlatRateShipping::Calculator

data/vendor/extensions/shipping/db/sample/zone_members.yml

@@ -0,0 +1,8 @@
+usa_member:
+  parent: available_shipping
+  member_id: 214
+  member_type: Country
+canada_member:
+  parent: available_shipping
+  member_id: 35
+  member_type: Country

data/vendor/extensions/shipping/db/sample/zones.yml

@@ -0,0 +1,3 @@
+available_shipping:
+  name: North America
+  description: USA + Canada

data/vendor/extensions/shipping/lang/en-US.yml

@@ -0,0 +1,9 @@
+ext_shipping_shipping_methods: Shipping Methods
+ext_shipping_shipping_methods_description: Manage shipping methods
+ext_shipping_calculator: Calculator
+ext_shipping_new_shipping_method: New Shipping Method
+ext_shipping_editing_shipping_method: Editing Shipping Method
+ext_shipping_shipping_categories: Shipping Categories
+ext_shipping_shipping_categories_description: Manage shipping categories to identify which products can be shipped via which method
+ext_shipping_new_shipping_category: New Shipping Category
+ext_shipping_editing_shipping_category: Editing Shipping Category

data/vendor/extensions/shipping/lib/spree/shipping_calculator.rb

@@ -0,0 +1,37 @@
+module Spree #:nodoc:
+  module ShippingCalculator
+
+    # modify the transitions in core - go to shipping after address (instead of cc payment)
+    Order.state_machines['state'].states << "shipment"
+    Order.state_machines['state'].events['next'].transitions.delete_if { |t| t.options[:to] == "creditcard_payment" && t.options[:from] == "address" }
+    Order.state_machines['state'].events['next'].transition(:to => 'shipment', :from => 'address')
+    Order.state_machines['state'].events['next'].transition(:to => 'creditcard_payment', :from => 'shipment')
+    Order.state_machines['state'].events['previous'].transition(:to => 'address', :from => 'shipment')
+    Order.state_machines['state'].after_transition :to => 'shipment', :do => :before_shipment
+    Order.state_machines['state'].events['edit'].transition(:to => 'in_progress', :from => 'shipment')
+    Order.state_machines['state'].after_transition(:to => 'shipment', :do => lambda {|order| order.update_attribute(:tax_amount, order.calculate_tax)})
+
+    def shipping_methods
+      methods = ShippingMethod.all
+      methods.select { |method| method.zone.include?(address) }
+    end
+    
+    # collection of available shipping countries
+    def shipping_countries
+      ShippingMethod.all.collect { |method| method.zone.country_list }.flatten.uniq.sort_by {|item| item.send 'name'}
+    end
+    
+    private
+    def before_shipment
+      # skip this step if there are no shipping methods
+      update_attribute(:state, "creditcard_payment") if shipping_methods.empty?
+      # automatically calculate shipping if there is only a single shipping method
+      if shipping_methods.size == 1
+        self.shipments << Shipment.create(:order => self, :shipping_method => shipping_methods.first)
+        self.state = "creditcard_payment"
+        save
+      end
+    end
+
+  end
+end

data/vendor/extensions/shipping/lib/spree/shipping_error.rb

@@ -0,0 +1,3 @@
+module Spree
+  class ShippingError < RuntimeError; end
+end

data/vendor/extensions/shipping/lib/tasks/shipping_extension_tasks.rake

@@ -0,0 +1,29 @@
+namespace :db do
+  desc "Bootstrap your database for Spree."
+  task :bootstrap  => :environment do
+    # load initial database fixtures (in db/sample/*.yml) into the current environment's database
+    ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+    Dir.glob(File.join(ShippingExtension.root, "db", 'sample', '*.{yml,csv}')).each do |fixture_file|
+      Fixtures.create_fixtures("#{ShippingExtension.root}/db/sample", File.basename(fixture_file, '.*'))
+    end
+
+  end
+end
+
+namespace :spree do
+  namespace :extensions do
+    namespace :shipping do
+      desc "Copies public assets of the Shipping to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[ShippingExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(ShippingExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end