@@ -1,5 +1,7 @@
Flexi Rate Shipping
===================
+**Now Supports Spree: 0.7.1**
+
Flexi Rate Shipping is an extension to Spree (a complete open source commerce solution for Ruby on Rails) that uses predefined values to calculate shipping. This extension is designed to be used when a traditional UPS / FedEx API approach in unavailable or unsuitable.
When installed, a new "Flexi Shipping Rates" link is added to the Configuration area in the Spree administration interface. Here you can define as many different rates as required, and link them to the relevant Shipping Categories and Zones.
README.markdown
@@ -1,10 +1,8 @@
-class Admin::FlexiShippingRatesController < ApplicationController
+class Admin::FlexiShippingRatesController < Admin::BaseController
resource_controller
before_filter :load_data
layout 'admin'
- require_role :admin
-
update.response do |wants|
wants.html { redirect_to collection_url }
end
@@ -14,8 +12,12 @@ class Admin::FlexiShippingRatesController < ApplicationController
end
private
- def load_data
- @available_categories = ShippingCategory.find :all, :order => :name
- @available_zones = Zone.find :all, :order => :name
- end
+ def collection
+ @collection ||= end_of_association_chain.order_by_zone_and_category
+ end
+
+ def load_data
+ @available_categories = ShippingCategory.find :all, :order => :name
+ @available_zones = Zone.find :all, :order => :name
+ end
end
app/controllers/admin/flexi_shipping_rates_controller.rb
@@ -5,5 +5,7 @@ class FlexiShippingRate < ActiveRecord::Base
validates_presence_of :first_item_price, :max_items, :shipping_category, :zone
validates_uniqueness_of :shipping_category_id, :scope => :zone_id
+
+ named_scope :order_by_zone_and_category, :order => "zone_id, shipping_category_id"
end
app/models/flexi_shipping_rate.rb
@@ -1,4 +1,4 @@
-<h1><%= "#{t("edit")} #{FlexiShippingRate.human_name}" %></h1>
+<h1><%= "#{t("editing")} #{FlexiShippingRate.human_name}" %></h1>
<%= error_messages_for :flexi_shipping_rate %>
<% form_for(:flexi_shipping_rate, :url => object_url, :html => { :method => :put }) do |f| %>
<%= render :partial => "form", :locals => { :f => f } %>
app/views/admin/flexi_shipping_rates/edit.html.erb
@@ -1,5 +1,15 @@
+<div class='toolbar'>
+ <ul class='actions'>
+ <li>
+ <%= button_link_to t("new_flexi_shipping_rate"), new_object_url, :icon => 'add' %>
+ </li>
+ </ul>
+ <br class='clear' />
+</div>
+
<h1><%= FlexiShippingRate.human_name(:count => 2) %></h1>
-<table class="admin-report" width="545">
+
+<table class="index">
<thead>
<tr>
<th><%= FlexiShippingRate.human_attribute_name("shipping_category") %></th>
@@ -12,15 +22,15 @@
</thead>
<tbody>
<% @flexi_shipping_rates.each do |flexi_shipping_rate| %>
- <tr class="<%= cycle('even', 'odd') %>">
+ <tr>
<td><%=flexi_shipping_rate.shipping_category.name %></td>
<td><%=flexi_shipping_rate.zone.name %></td>
<td><%=number_to_currency(flexi_shipping_rate.first_item_price) %></td>
<td><%=number_to_currency(flexi_shipping_rate.additional_item_price) %></td>
<td><%=flexi_shipping_rate.max_items %></td>
<td>
- <%=link_to t("edit"), edit_object_url(flexi_shipping_rate) %> |
- <%=link_to t("delete"), object_url(flexi_shipping_rate), :method => :delete %>
+ <%= link_to_edit flexi_shipping_rate %>
+ <%= link_to_delete flexi_shipping_rate %>
</td>
</tr>
<% end %>
@@ -28,5 +38,4 @@
<tr><td colspan="5">None.</td></tr>
<% end %>
</tbody>
-</table>
-<%= link_to "#{t("actions.new")} #{FlexiShippingRate.human_name}", new_object_url %>
\ No newline at end of file
+</table>
\ No newline at end of file
app/views/admin/flexi_shipping_rates/index.html.erb
@@ -14,3 +14,5 @@ en-GB:
flexi_shipping_rate:
taken: "already exists for the specified Zone."
flexi_shipping_rates_description: Manage rates and associated Shipping Categories for use with the FlexiRate Shipping Extension
+ new_flexi_shipping_rate: "New Flexi Shipping Rate"
+ editing: "Editing"
\ No newline at end of file
config/locales/en-GB.yml
@@ -14,3 +14,5 @@ en-US:
flexi_shipping_rate:
taken: "already exists for the specified Zone."
flexi_shipping_rates_description: Manage rates and associated Shipping Categories for use with the FlexiRate Shipping Extension
+ new_flexi_shipping_rate: "New Flexi Shipping Rate"
+ editing: "Editing"
\ No newline at end of file
config/locales/en-US.yml
@@ -2,9 +2,9 @@
# require_dependency 'application'
class FlexiRateShippingExtension < Spree::Extension
- version "1.0"
- description "Describe your extension here"
- url "http://yourwebsite.com/flexi_rate_shipping"
+ version "0.7.1"
+ description "Calculates shipping using predefined rates."
+ url "http://github.com/BDQ/spree-flexi-rate-shipping/tree/master"
define_routes do |map|
map.namespace :admin do |admin|
flexi_rate_shipping_extension.rb
@@ -1,17 +1,17 @@
module Spree
module FlexiRateShipping
class Calculator
- def calculate_shipping(order)
+ def calculate_shipping(shipment)
rates = {}
rate_count = {}
- order.line_items.each do |li|
+ shipment.order.line_items.each do |li|
li.quantity.times do
sc = li.variant.product.shipping_category
sc ||= ShippingCategory.new()
flexi_rates = sc.flexi_shipping_rates
- fsr = flexi_rates.detect{ | rate | rate.zone.include?(order.address) }
+ fsr = flexi_rates.detect{ | rate | rate.zone.include?(shipment.address) }
fsr ||= FlexiShippingRate.new(:id => 'default', :first_item_price => 0, :max_items => 1)
rate_count.has_key?(fsr.id) ? rate_count[fsr.id] += 1 : rate_count[fsr.id] = 1
lib/spree/flexi_rate_shipping/calculator.rb
@@ -3,27 +3,32 @@ require File.dirname(__FILE__) + '/../spec_helper'
describe Spree::FlexiRateShipping::Calculator do
before(:each) do
- @flexi_shipping_rate1 = mock_model(FlexiShippingRate, :first_item_price => 10.0, :additional_item_price => 2.0, :max_items => 6)
- @shipping_category1 = mock_model(ShippingCategory, :flexi_shipping_rate => @flexi_shipping_rate1)
+ @zone = mock_model(Zone, :name => "North America", :include? => true)
+
+ @flexi_shipping_rate1 = mock_model(FlexiShippingRate, :first_item_price => 10.0, :additional_item_price => 2.0, :max_items => 6, :zone => @zone)
+
+ @shipping_category1 = mock_model(ShippingCategory, :flexi_shipping_rates => [@flexi_shipping_rate1])
@product1 = mock_model(Product, :shipping_category => @shipping_category1)
@variant1 = mock_model(Variant, :product => @product1)
+ @address = mock_model(Address, :zone => @zone)
end
it "should calculate shipping with no flexi shipping rate" do
- @shipping_category1 = mock_model(ShippingCategory, :flexi_shipping_rate => nil)
+ @shipping_category1 = mock_model(ShippingCategory, :flexi_shipping_rates => [])
@product1 = mock_model(Product, :shipping_category => @shipping_category1)
@variant1 = mock_model(Variant, :product => @product1)
@line_item1 = mock_model(LineItem, :variant => @variant1, :quantity => 1)
@line_items = [@line_item1]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 0.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 0.0
end
it "should calculate shipping with one product with no flexi shipping rate" do
- @no_rate_shipping_category = mock_model(ShippingCategory, :flexi_shipping_rate => nil)
+ @no_rate_shipping_category = mock_model(ShippingCategory, :flexi_shipping_rates => [])
@product1 = mock_model(Product, :shipping_category => @no_rate_shipping_category)
@variant1 = mock_model(Variant, :product => @product1)
@@ -35,8 +40,9 @@ describe Spree::FlexiRateShipping::Calculator do
@line_items = [@line_item1, @line_item2]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 12.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 12.0
end
@@ -52,8 +58,9 @@ describe Spree::FlexiRateShipping::Calculator do
@line_items = [@line_item1, @line_item2]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 12.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 12.0
end
it "should calculate shipping with no shipping category" do
@@ -63,16 +70,18 @@ describe Spree::FlexiRateShipping::Calculator do
@line_item1 = mock_model(LineItem, :variant => @variant1, :quantity => 7)
@line_items = [@line_item1]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 0.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 0.0
end
it "should calculate shipping correctly using one flexi shipping rate and one product" do
@line_item1 = mock_model(LineItem, :variant => @variant1, :quantity => 7)
@line_items = [@line_item1]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 30.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 30.0
end
it "should calculate shipping correctly using one flexi shipping rate and multiple products" do
@@ -88,14 +97,15 @@ describe Spree::FlexiRateShipping::Calculator do
@line_items = [@line_item1, @line_item2, @line_item3]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 34.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 34.0
end
it "should calculate shipping correctly using two different flexi shipping rates" do
- @flexi_shipping_rate2 = mock_model(FlexiShippingRate, :first_item_price => 50, :additional_item_price => 10, :max_items => 10)
- @shipping_category2 = mock_model(ShippingCategory, :flexi_shipping_rate => @flexi_shipping_rate2)
+ @flexi_shipping_rate2 = mock_model(FlexiShippingRate, :first_item_price => 50, :additional_item_price => 10, :max_items => 10, :zone => @zone)
+ @shipping_category2 = mock_model(ShippingCategory, :flexi_shipping_rates => [@flexi_shipping_rate2])
@product2 = mock_model(Product, :shipping_category => @shipping_category2)
@variant2 = mock_model(Variant, :product => @product2)
@@ -103,15 +113,16 @@ describe Spree::FlexiRateShipping::Calculator do
@line_item2 = mock_model(LineItem, :variant => @variant2, :quantity => 3)
@line_items = [@line_item1, @line_item2]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 90.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 90.0
end
it "should calculate shipping correctly using two different flexi shipping rates, one with no addition_item_price" do
- @flexi_shipping_rate2 = mock_model(FlexiShippingRate, :first_item_price => 50, :additional_item_price => nil, :max_items => 1)
- @shipping_category2 = mock_model(ShippingCategory, :flexi_shipping_rate => @flexi_shipping_rate2)
+ @flexi_shipping_rate2 = mock_model(FlexiShippingRate, :first_item_price => 50, :additional_item_price => nil, :max_items => 1, :zone => @zone)
+ @shipping_category2 = mock_model(ShippingCategory, :flexi_shipping_rates => [@flexi_shipping_rate2])
@product2 = mock_model(Product, :shipping_category => @shipping_category2)
@variant2 = mock_model(Variant, :product => @product2)
@@ -119,8 +130,9 @@ describe Spree::FlexiRateShipping::Calculator do
@line_item2 = mock_model(LineItem, :variant => @variant2, :quantity => 1)
@line_items = [@line_item1, @line_item2]
@order = mock_model(Order, :line_items => @line_items)
+ @shipment = mock_model(Shipment, :order => @order, :address => @address)
- Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@order).should == 70.0
+ Spree::FlexiRateShipping::Calculator.new().calculate_shipping(@shipment).should == 70.0
end
spec/models/flexi_shipping_calculator_spec.rb
@@ -5,7 +5,7 @@ describe FlexiShippingRate do
@flexi_shipping_rate = FlexiShippingRate.new
end
- ['first item price', 'max items'].each do |field|
+ ['first item price', 'max. number of items'].each do |field|
it "should require #{field}" do
@flexi_shipping_rate.max_items = nil
@flexi_shipping_rate.valid?.should be_false
spec/models/flexi_shipping_rate_spec.rb
112c70a9d7f285b3b0cc6a08f447c61b4decf4d3
Brian Quinn
briandquinn@gmail.com
http://github.com/BDQ/spree-flexi-rate-shipping/commit/059636709243b7b3166016cec65e2094c90a35a8
059636709243b7b3166016cec65e2094c90a35a8
2009-04-24T09:53:45-07:00
2009-04-24T09:53:45-07:00
Updated to now support Spree 0.7.1 (shipments)
93767c39bf16f133bc999ff8f46e9c8c6e49fc50
Brian Quinn
briandquinn@gmail.com