spree_active_shipping 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+spec/test_app
+*.swp

data/README.md

@@ -0,0 +1,67 @@
+Active Shipping
+===============
+
+This is a Spree extension that wraps the popular [active_shipping](http://github.com/Shopify/active_shipping/tree/master) plugin.
+
+UPS 
+---
+
+You will need a UPS developer account to get rate quotes (even in development and test mode.)  The UPS calculators also require that you set the following configuration properties. You will also need a USPS account to use USPS rate quote system. Note: acquiring the USPS developer account is easy but has a confusion activation step. Look for related sicussion in ActiveShipping's original discussion group as well as carefully read your USPS confirmation email. 
+
+<pre>
+Spree::ActiveShipping::Config[:origin_country]
+Spree::ActiveShipping::Config[:origin_city]
+Spree::ActiveShipping::Config[:origin_state]
+Spree::ActiveShipping::Config[:origin_zip]
+Spree::ActiveShipping::Config[:ups_login]
+Spree::ActiveShipping::Config[:ups_password]
+Spree::ActiveShipping::Config[:ups_key]
+Spree::ActiveShipping::Config[:usps_login]
+</pre>
+
+It will soon be possible to set these properties through a new admin configuration screen (even sooner if someone else writes the patch!)  
+
+Global Handling Fee
+-------------------
+
+<pre>
+Spree::ActiveShipping::Config[:handling_fee]
+</pre>
+
+This property allows you to set a global handling fee that will be added to all calculated shipping rates.  Specify the number of cents, not dollars.
+
+Using Migrations
+----------------
+
+If you'd like to set your shipping configuration as part of a migration you could add something like this to your site extension.
+
+<pre>
+class AddUpsConfiguration < ActiveRecord::Migration
+  def self.up
+    Spree::ActiveShipping::Config.set(:ups_login => "dpbrowning")
+    Spree::ActiveShipping::Config.set(:ups_password => "doublewide")
+    Spree::ActiveShipping::Config.set(:ups_key => "5B8DDE509EFDA5D6")
+    Spree::ActiveShipping::Config.set(:usps_login => "13658997AOE2568XOE")
+  end
+
+  def self.down
+  end
+end
+</pre> 
+
+Installation
+------------
+
+1. Add the following to your applications Gemfile
+
+    gem 'spree_active_shipping'
+
+2. Run bundler
+
+    bundle install
+
+
+Further Reading
+---------------
+
+Andrea Singh has also written an excellent [blog post](http://blog.madebydna.com/all/code/2010/05/26/setting-up-usps-shipping-with-spree.html) covering the use of this extension in detail.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+desc "Regenerates a rails 3 app for testing"
+task :test_app do
+  SPREE_PATH = ENV['SPREE_PATH']
+  raise "SPREE_PATH should be specified" unless SPREE_PATH
+  require File.join(SPREE_PATH, 'lib/generators/spree/test_app_generator')
+  class SpreeActiveShippingTestAppGenerator < Spree::Generators::TestAppGenerator
+    def tweak_gemfile
+      append_file 'Gemfile' do
+<<-gems
+gem 'spree_core', :path => '#{File.join(SPREE_PATH, 'core')}'
+gem 'spree_active_shipping', :path => '#{File.dirname(__FILE__)}'
+gems
+      end
+    end
+
+    def install_gems
+      inside "test_app" do
+        run 'rake spree_core:install'
+      end
+    end
+
+    def migrate_db
+      run_migrations
+    end
+  end
+  SpreeActiveShippingTestAppGenerator.start
+end
+
+namespace :test_app do
+  desc 'Rebuild test and cucumber databases'
+  task :rebuild_dbs do
+    system("cd spec/test_app && rake db:drop db:migrate RAILS_ENV=test && rake db:drop db:migrate RAILS_ENV=cucumber")
+  end
+end

data/app/controllers/admin/shipments_controller_decorator.rb

@@ -0,0 +1,11 @@
+# handle shipping errors gracefully on admin ui
+Admin::ShipmentsController.class_eval do
+  rescue_from Spree::ShippingError, :with => :handle_shipping_error
+
+  private
+    def handle_shipping_error(e)
+      load_object
+      flash.now[:error] = e.message
+      render :action => "edit"
+    end
+end

data/app/controllers/admin/shipping_methods_controller_decorator.rb

@@ -0,0 +1,15 @@
+Admin::ShippingMethodsController.class_eval do
+  
+  before_filter :load_data
+  
+  private
+
+  # overriding to return an array of Calculator objects instead of a Set
+  def load_data
+    @available_zones = Zone.find :all, :order => :name
+    @calculators = []
+    ShippingMethod.calculators.each {|calc|
+      @calculators << eval(calc.name).new  
+    }
+  end
+end

data/app/controllers/checkout_controller_decorator.rb

@@ -0,0 +1,11 @@
+# handle shipping errors gracefully during checkout
+CheckoutController.class_eval do
+  
+  rescue_from Spree::ShippingError, :with => :handle_shipping_error
+
+  private
+    def handle_shipping_error(e)
+      flash[:error] = e.message
+      redirect_to checkout_state_path(:address)
+    end
+end

data/app/models/calculator/active_shipping.rb

@@ -0,0 +1,126 @@
+# This is a base calculator for shipping calcualations using the ActiveShipping plugin.  It is not intended to be
+# instantiated directly.  Create sublcass for each specific shipping method you wish to support instead.
+class Calculator::ActiveShipping < Calculator
+
+  include ActiveMerchant::Shipping
+
+  def self.register
+    super
+    ShippingMethod.register_calculator(self)
+  end
+
+  def compute(object)
+    if object.is_a?(Array)
+      order = object.first.order
+    elsif object.is_a?(Shipment)
+      order = object.order
+    else
+      order = object
+    end
+    origin= Location.new(:country => Spree::ActiveShipping::Config[:origin_country],
+                         :city => Spree::ActiveShipping::Config[:origin_city],
+                         :state => Spree::ActiveShipping::Config[:origin_state],
+                         :zip => Spree::ActiveShipping::Config[:origin_zip])
+
+    addr = order.ship_address
+
+    destination = Location.new(:country => addr.country.iso,
+                              :state => (addr.state ? addr.state.abbr : addr.state_name),
+                              :city => addr.city,
+                              :zip => addr.zipcode)
+
+    rates = Rails.cache.fetch(cache_key(order)) do
+      rates = retrieve_rates(origin, destination, packages(order))
+    end
+
+    return nil if rates.empty?
+    rate = rates[self.class.description].to_f + (Spree::ActiveShipping::Config[:handling_fee].to_f || 0.0)
+    return nil unless rate
+    # divide by 100 since active_shipping rates are expressed as cents
+    return rate/100.0
+  end
+
+
+  def timing(line_items)
+    order = line_items.first.order
+    origin      = Location.new(:country => Spree::ActiveShipping::Config[:origin_country],
+                               :city => Spree::ActiveShipping::Config[:origin_city],
+                               :state => Spree::ActiveShipping::Config[:origin_state],
+                               :zip => Spree::ActiveShipping::Config[:origin_zip])
+    addr = order.ship_address
+    destination = Location.new(:country => addr.country.iso,
+                              :state => (addr.state ? addr.state.abbr : addr.state_name),
+                              :city => addr.city,
+                              :zip => addr.zipcode)
+    timings = Rails.cache.fetch(cache_key(line_items)+"-timings") do
+      timings = retrieve_timings(origin, destination, packages(order))
+    end
+    return nil if timings.nil? || !timings.is_a?(Hash) || timings.empty?
+    return timings[self.description]
+
+  end
+
+  private
+  def retrieve_rates(origin, destination, packages)
+    begin
+      response = carrier.find_rates(origin, destination, packages)
+      # turn this beastly array into a nice little hash
+      rate_hash = Hash[*response.rates.collect { |rate| [rate.service_name, rate.price] }.flatten]
+      return rate_hash
+    rescue ActiveMerchant::ActiveMerchantError => e
+
+      if [ActiveMerchant::ResponseError, ActiveMerchant::Shipping::ResponseError].include? e.class
+        params = e.response.params
+        if params.has_key?("Response") && params["Response"].has_key?("Error") && params["Response"]["Error"].has_key?("ErrorDescription")
+          message = params["Response"]["Error"]["ErrorDescription"]
+        else
+          message = e.message
+        end
+      else
+        message = e.to_s
+      end
+
+      Rails.cache.write @cache_key, {} #write empty hash to cache to prevent constant re-lookups
+
+      raise Spree::ShippingError.new("#{I18n.t('shipping_error')}: #{message}")
+    end
+
+  end
+
+
+  def retrieve_timings(origin, destination, packages)
+    begin
+      if carrier.respond_to?(:find_time_in_transit)
+        response = carrier.find_time_in_transit(origin, destination, packages)
+        return response
+      end
+    rescue ActiveMerchant::Shipping::ResponseError => re
+      params = re.response.params
+      if params.has_key?("Response") && params["Response"].has_key?("Error") && params["Response"]["Error"].has_key?("ErrorDescription")
+        message = params["Response"]["Error"]["ErrorDescription"]
+      elsee
+        message = re.message
+      end
+      Rails.cache.write @cache_key+'-', {} #write empty hash to cache to prevent constant re-lookups
+      raise Spree::ShippingError.new("#{I18n.t('shipping_error')}: #{message}")
+    end
+  end
+
+
+  private
+
+  # Generates an array of Package objects based on the quantities and weights of the variants in the line items
+  def packages(order)
+    multiplier = Spree::ActiveShipping::Config[:unit_multiplier]
+    weight = order.line_items.inject(0) do |weight, line_item|
+      weight + (line_item.variant.weight ? (line_item.quantity * line_item.variant.weight * multiplier) : 0)
+    end
+    package = Package.new(weight, [], :units => Spree::ActiveShipping::Config[:units].to_sym)
+    [package]
+  end
+
+  def cache_key(order)
+    addr = order.ship_address
+    @cache_key = "#{carrier.name}-#{order.number}-#{addr.country.iso}-#{addr.state ? addr.state.abbr : addr.state_name}-#{addr.city}-#{addr.zipcode}-#{order.line_items.map {|li| li.variant_id.to_s + "_" + li.quantity.to_s }.join("|")}".gsub(" ","")
+  end
+end

data/app/models/calculator/fedex/base.rb

@@ -0,0 +1,8 @@
+class Calculator::Fedex::Base < Calculator::ActiveShipping
+  def carrier
+    ActiveMerchant::Shipping::FedEx.new(:key => Spree::ActiveShipping::Config[:fedex_key], 
+                                        :password => Spree::ActiveShipping::Config[:fedex_password], 
+                                        :account => Spree::ActiveShipping::Config[:fedex_account],
+                                        :login => Spree::ActiveShipping::Config[:fedex_login])      
+  end
+end

data/app/models/calculator/fedex/base.rb~

@@ -0,0 +1,7 @@
+class Calculator::Fedex::Base < Calculator::ActiveShipping
+  def carrier
+    ActiveMerchant::Shipping::FEDEX.new(:login => Spree::ActiveShipping::Config[:fedex_login], 
+                                      :password => Spree::ActiveShipping::Config[:fedex_password], 
+                                      :key => Spree::ActiveShipping::Config[:fedex_key])      
+  end
+end

data/app/models/calculator/fedex/express_saver.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::ExpressSaver < Calculator::Fedex::Base
+  def self.description
+    "FedEx Express Saver"
+  end
+end

data/app/models/calculator/fedex/first_overnight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::FirstOvernight < Calculator::Fedex::Base
+  def self.description
+    "FedEx First Overnight"
+  end
+end

data/app/models/calculator/fedex/ground.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::Ground < Calculator::Fedex::Base
+  def self.description
+    "FedEx Ground"
+  end
+end

data/app/models/calculator/fedex/ground_home_delivery.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::GroundHomeDelivery < Calculator::Fedex::Base
+  def self.description
+    "FedEx Ground Home Delivery"
+  end
+end

data/app/models/calculator/fedex/international_economy.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalEconomy < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Economy"
+  end
+end

data/app/models/calculator/fedex/international_economy_freight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalEconomyFreight < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Economy Freight"
+  end
+end

data/app/models/calculator/fedex/international_first.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalFirst < Calculator::Fedex::Base
+  def self.description
+    "FedEx International First"
+  end
+end

data/app/models/calculator/fedex/international_ground.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalGround < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Ground"
+  end
+end

data/app/models/calculator/fedex/international_priority.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalPriority < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Priority"
+  end
+end

data/app/models/calculator/fedex/international_priority_freight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalPriorityFreight < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Priority Freight"
+  end
+end

data/app/models/calculator/fedex/international_priority_saturday_delivery.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::InternationalPrioritySaturdayDelivery < Calculator::Fedex::Base
+  def self.description
+    "FedEx International Priority Saturday Delivery"
+  end
+end

data/app/models/calculator/fedex/one_day_freight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::OneDayFreight < Calculator::Fedex::Base
+  def self.description
+    "FedEx 1 Day Freight"
+  end
+end

data/app/models/calculator/fedex/one_day_freight_saturday_delivery.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::OneDayFreightSaturdayDelivery < Calculator::Fedex::Base
+  def self.description
+    "FedEx 1 Day Freight Saturday Delivery"
+  end
+end

data/app/models/calculator/fedex/priority_overnight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::PriorityOvernight < Calculator::Fedex::Base
+  def self.description
+    "FedEx Priority Overnight"
+  end
+end

data/app/models/calculator/fedex/priority_overnight_saturday_delivery.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::PriorityOvernightSaturdayDelivery < Calculator::Fedex::Base
+  def self.description
+    "FedEx Priority Overnight Saturday Delivery"
+  end
+end

data/app/models/calculator/fedex/saver.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::Saver < Calculator::Fedex::Base  
+  def self.description
+    "FedEx Saver"
+  end
+end

data/app/models/calculator/fedex/saver.rb~

@@ -0,0 +1,5 @@
+class Calculator::Ups::Saver < Calculator::Ups::Base  
+  def self.description
+    "UPS Saver"
+  end
+end

data/app/models/calculator/fedex/standard_overnight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::StandardOvernight < Calculator::Fedex::Base
+  def self.description
+    "FedEx Standard Overnight"
+  end
+end

data/app/models/calculator/fedex/three_day_freight.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::ThreeDayFreight < Calculator::Fedex::Base
+  def self.description
+    "FedEx 3 Day Freight"
+  end
+end

data/app/models/calculator/fedex/three_day_freight_saturday_delivery.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::ThreeDayFreightSaturdayDelivery < Calculator::Fedex::Base
+  def self.description
+    "FedEx 3 Day Freight Saturday Delivery"
+  end
+end

data/app/models/calculator/fedex/two_day.rb

@@ -0,0 +1,5 @@
+class Calculator::Fedex::TwoDay < Calculator::Fedex::Base
+  def self.description
+    "FedEx 2 Day"
+  end
+end