Active Shipping
This is a Spree extension that wraps the popular active_shipping plugin.
Installation
- Add this extension to your Gemfile with this line:
Spree >= 3.1
gem 'spree_active_shipping', github: 'spree-contrib/spree_active_shipping'Spree 3.0 and Spree 2.x
gem 'spree_active_shipping', github: 'spree-contrib/spree_active_shipping', branch: 'X-X-stable'The branch option is important: it must match the version of Spree you're using.
For example, use 3-0-stable if you're using Spree 3-0-stable or any 3.0.x version.
- Install the gem using Bundler:
bundle install- Copy & run migrations
bundle exec rake railties:install:migrations
bundle exec rake db:migrate- Restart your server
If your server was running, restart it so that it can find the assets properly.
Rate quotes from carriers
So far, this gem supports getting quotes from UPS, USPS, Canada Post, and FedEx. In general, you will need a developer account to get rates. Please contact the shipping vendor that you wish to use about generating a developer account.
Once you have an account, you can go to the active shipping settings admin configuration screen to set the right fields. You need to set all of the Origin Address fields and the fields for the carrier you wish to use. To set the settings through a config file, you can assign values to the settings like so:
Spree::ActiveShipping::Config[:ups_login]
Spree::ActiveShipping::Config[:ups_password]
Spree::ActiveShipping::Config[:ups_key]
Spree::ActiveShipping::Config[:usps_login]NOTE: When setting up FedEx credentials, :fedex_login is the "Meter Number" that FedEx supplies you with.
It is important to note how this wrapper matches the calculators to the services available from the carrier API's, by default the base calculator matches the service name to the calculator class and returns the rate, this magic happens as follows:
- inside the calculator class
Spree::Calculator::Shipping::Fedex::GroundHomeDelivery::description #holds the service name- inside the calculator base
rates_result = retrieve_rates_from_cache(package, origin, destination) # <- holds the rates for given package in a parsed hash (see sample response below)
rate = rates_result[self.class.description] # <- matches with the description as the keythis means that the calculator Fedex::GroundHomeDelivery will hit FedEx Servers and try to get the rates for the given package, since FedEx returns rates for package and returns all of its available services for the given shipment we need to identify which service we are targeting ( see caching results below ) the calculator will only pick the rates from a service that matches the "FedEx Ground Home Delivery" string, you can see how it works below:
a sample rate response already parsed looks like this:
{
"FedEx First Overnight" => 5886,
"FedEx Priority Overnight" => 2924,
"FedEx Standard Overnight" => 2529,
"FedEx 2 Day Am" => 1987,
"FedEx 2 Day" => 1774,
"FedEx Ground Home Delivery" => 925
}the rate hash that is parsed by the calculator has service descriptions as keys, this makes it easier to get the rates you need.
- getting the rates (all the above together)
calculator = Spree::Calculator::Shipping::Fedex::GroundHomeDelivery.new
calculator.description # "FedEx Ground Home Delivery"
rate = calculator.compute(<Package>)
rate # $9.25you can see the rates are given in cents from FedEx (in the rate hash example above), spree_active_shipping converts them dividing them by 100 before sending them to you
Note: if you want to integrate to a new carrier service that is not listed below please take care when trying to match the service name key to theirs, there are times when they create dynamic naming conventions, please take as an example USPS, you can see the implementation of USPS has the compute_packages method overridden to match against a service_code key that had to be added to calculator services ( Issue #103 )
Global Handling Fee
Spree::ActiveShipping::Config[:handling_fee]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. You can either set it manually or through the admin interface.
Weights
Global weight default
This property allows you to set a default weight that will be substituted for products lacking defined weights. You can either set it manually or through the admin interface.
Spree::ActiveShipping::Config[:default_weight]Weight units
Weights are expected globally inside spree_active_shipping to be entered in a unit that can be divided to oz and a global variable was added to help with unit conversion
Spree::ActiveShipping::Config[:unit_multiplier]It is important to note that by default this variable is set to have a value of 16 expecting weights to be entered in lbs
Example of converting from metric system to oz
Say you have your weights in kg you would have to set the multiplier to 35.274
Spree::ActiveShipping::Config[:unit_multiplier] = 35.274Cache
When Spree tries to get rates for a given shipment it calls Spree::Stock::Estimator, this class is in charge of getting the rates back from any calculator active for a shipment, the way the estimator determines the shipping methods that will apply to the shipment varies from within spree versions but the general idea is this:
NOTE: Shipping methods are tied to calculators
private
def shipping_methods(package)
shipping_methods = package.shipping_methods
shipping_methods.delete_if { |ship_method| !ship_method.calculator.available?(package) }
shipping_methods.delete_if { |ship_method| !ship_method.include?(order.ship_address) }
shipping_methods.delete_if { |ship_method| !(ship_method.calculator.preferences[:currency].nil? || ship_method.calculator.preferences[:currency] == currency) }
shipping_methods
endThe money line for spree_active_shipping is when it calls the calculator's available? method, this method is actually calling the carrier services, and it checks for rates or errors in the form of Spree::ShippingError, if the rates are there for the specified shipment, the calculator will store the parsed rates with a specific key for each package inside the cache, consider the following example to see why this works and why this is necessary:
- User orders N amount of products
- All of the products from this order are stored in Stock Location 1
- Once the order creates shipments you will end up with 1 shipment
- Calculators are active for the following services: FedEx Ground Home Delivery, FedEx 2 Day, FedEx International Priority
- Order calls the estimator for rates:
- Estimator will try to get the active shipping methods for this package, it will call available? on all of the active calculators to determine if they are all available for this shipment
- once it calls it for the first calculator (FedEx Ground Home Delivery) it will get the following rates back from FedEx
{
"FedEx First Overnight" => 5886,
"FedEx Priority Overnight" => 2924,
"FedEx Standard Overnight" => 2529,
"FedEx 2 Day Am" => 1987,
"FedEx 2 Day" => 1774,
"FedEx Ground Home Delivery" => 925
}- when it tries to get rates for the 2nd calculator (FedEx 2 Day) it will check the cache first and will find that for this package and stock location it already has rates stored in the cache and it won't call FedEx again, using this same rates
- when it hits the last calculator (FedEx International Priority) it will find that the cache doesn't have any rates for the given key, and the method
available?called from the Estimator will return false thus removing the calculator's shipping method from the list of available calculators and won't return any rates back for it - Consequently since this 3rd calculator (FedEx International Priority) is an international calculator it would have been removed as well by the line that checks if any shipping method is allowed in already defined Zones.
Testing
Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
$ bundle
$ bundle exec rake test_app
$ bundle exec rspec spec
Further Reading
Andrea Singh has also written an excellent blog post covering the use of this extension in detail. It is rather old and somewhat outdated.