shipment 0.0.3 → 0.0.4

data/features/shipment_committees.feature

@@ -24,23 +24,44 @@ Feature: Shipment Committee Calculations
     When the "mode" committee is calculated
     Then the committee should have used quorum "default"
     And the conclusion of the committee should be a fallback
+
+  Scenario Outline: Distance from same locality
+    Given a shipment emitter
+    And a characteristic "origin_zip_code.name" of "<origin>"
+    And a characteristic "destination_zip_code.name" of "<destination>"
+    When the "distance" committee is calculated
+    Then the conclusion of the committee should be "<distance>"
+    Examples:
+      | origin | destination | distance |
+      | 05753  | 05753       | 0        |
+      | 05753  | 05401       |          |
   
-  Scenario: Segment count from nothing
+  Scenario Outline: Distance from mapquest
     Given a shipment emitter
-    When the "segment_count" committee is calculated
-    Then the committee should have used quorum "default"
-    And the conclusion of the committee should be "5"
+    And a characteristic "origin_zip_code.name" of "<origin>"
+    And a characteristic "destination_zip_code.name" of "<destination>"
+    And a characteristic "mode.name" of "ground"
+    And a characteristic "mapquest_api_key" of "ABC123"
+    And mapquest determines the distance to be "<mapquest_distance>"
+    When the "distance" committee is calculated
+    Then the committee should have used quorum "from mapquest"
+    And the conclusion of the committee should be "<distance>"
+    Examples:
+      | origin | destination | mapquest_distance | distance |
+      | 05753  | 05401       | 53                | 53       |
+      | 05753  | 05401       | 33                | 33       |
 
-  Scenario Outline: Distance from origin zip code and destination zip code
+  Scenario Outline: Distance from direct path
     Given a shipment emitter
     And a characteristic "origin_zip_code.name" of "<origin>"
     And a characteristic "destination_zip_code.name" of "<destination>"
+    And a characteristic "mode.name" of "air"
+    And a characteristic "mapquest_api_key" of "ABC123"
     When the "distance" committee is calculated
-    Then the committee should have used quorum "from origin zip code and destination zip code"
+    Then the committee should have used quorum "from direct path"
     And the conclusion of the committee should be "<distance>"
     Examples:
       | origin | destination | distance |
-      | 05753  | 05753       | 0        |
       | 05753  | 05401       | 53       |
 
   Scenario Outline: Distance from zip codes not in database or missing lat/lng
@@ -73,12 +94,11 @@ Feature: Shipment Committee Calculations
       | ground  | 1.0    |
       | air     | 1.1    |
 
-  Scenario: Dogleg factor from default segment count
+  Scenario: Dogleg factor from nothing
     Given a shipment emitter
-    When the "segment_count" committee is calculated
-    And the "dogleg_factor" committee is calculated
+    When the "dogleg_factor" committee is calculated
     Then the committee should have used quorum "from segment count"
-    And the conclusion of the committee should be "5.0625"
+    And the conclusion of the committee should be "1.8"
 
   Scenario Outline: Dogleg factor from segment count
     Given a shipment emitter
@@ -89,7 +109,9 @@ Feature: Shipment Committee Calculations
     Examples:
       | segments | factor |
       | 1        | 1.0    |
-      | 2        | 1.5    |
+      | 2        | 1.8    |
+      | 100      | 1.8    |
+      | -20      | 1.8    |
 
   Scenario: Adjusted distance from default
     Given a shipment emitter

data/features/shipment_emissions.feature

@@ -6,7 +6,7 @@ Feature: Shipment Emissions Calculations
     When emissions are calculated
     Then the emission value should be within "0.1" kgs of "8.7"
 
-  Scenario: Calculations from weight, package count, segment count
+  Scenario: Calculations from weight, package count and segment count
     Given a shipment has "weight" of "10"
     And it has "package_count" of "2"
     And it has "segment_count" of "1"
@@ -16,12 +16,13 @@ Feature: Shipment Emissions Calculations
   Scenario Outline: Calculations from origin/destination
     Given a shipment has "origin_zip_code.name" of "<origin>"
     And it has "destination_zip_code.name" of "<destination>"
+    And mapquest determines the distance to be "<distance>"
     When emissions are calculated
     Then the emission value should be within "0.1" kgs of "<emission>"
     Examples:
-      | origin | destination | emission |
-      | 05401  | 05401       | 0.3      |
-      | 05401  | 94128       | 57.8     |
+      | origin | destination | mapquest_distance | emission |
+      | 05401  | 05401       |                   | 0.3      |
+      | 05401  | 94128       | 30                | 20.8     |
 
   Scenario: Calculations from carrier
     Given a shipment has "carrier.name" of "FedEx"
@@ -50,5 +51,5 @@ Feature: Shipment Emissions Calculations
       | ground  | 05401  | 05401       | 0.3      |
       | air     | 05401  | 05401       | 0.3      |
       | courier | 05401  | 94128       | 2.3      |
-      | ground  | 05401  | 94128       | 71145.0  |
-      | air     | 05401  | 94128       | 391296.2 |
+      | ground  | 05401  | 94128       | 25296.2  |
+      | air     | 05401  | 94128       | 139127.8 |

data/features/step_definitions/shipment_steps.rb

@@ -0,0 +1,4 @@
+Given /^mapquest determines the distance to be "([^\"]*)"$/ do |distance|
+  mockquest = mock MapQuestDirections, :distance_in_miles => distance
+  MapQuestDirections.stub!(:new).and_return mockquest
+end

data/features/support/env.rb

@@ -5,6 +5,7 @@ require 'cucumber'
 require 'cucumber/formatter/unicode'
 require 'rspec'
 require 'rspec/expectations'
+require 'cucumber/rspec/doubles'
 
 require 'sniff'
 Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :cucumber => true, :earth => [:locality, :shipping]

data/lib/shipment/carbon_model.rb

@@ -2,6 +2,8 @@
 # See LICENSE for details.
 # Contact Brighter Planet for dual-license arrangements.
 
+require File.expand_path('../../vendor/plugin/mapquest/lib/mapquest_directions', File.dirname(__FILE__))
+
 ## Shipment carbon model
 # This model is used by [Brighter Planet](http://brighterplanet.com)'s carbon emission [web service](http://carbon.brighterplanet.com) to estimate the **greenhouse gas emissions of a shipment** (e.g. a FedEx package).
 #
@@ -76,14 +78,14 @@ module BrighterPlanet
               3219
             end
           end
-            
+          
           committee :dogleg_factor do
-            quorum 'from segment count', :needs => :segment_count do |characteristics|
-              if characteristics[:segment_count] > 0
-                # ASSUMED arbitrary
-                1.5 ** (characteristics[:segment_count] - 1)
+            quorum 'from segment count', :appreciates => :segment_count do |characteristics|
+              if characteristics[:segment_count] == 1
+                1.0
               else
-                raise "Invalid segment_count: #{:segment_count} (must be > 0)"
+                # based on our sample FedEx tracking numbers
+                1.8
               end
             end
           end
@@ -95,34 +97,26 @@ module BrighterPlanet
           end
           
           committee :distance do
-            quorum 'from origin zip code and destination zip code', :needs => [:origin_zip_code, :destination_zip_code], do |characteristics|
-              # Ensure both the origin and destination zip codes are in our database
-              if characteristics[:origin_zip_code] and characteristics[:destination_zip_code]
-                if characteristics[:origin_zip_code] == characteristics[:destination_zip_code]
-                  # FIXME TODO
-                  # Special calculation to deal with travel within the same zipcode
-                  0
-                # Ensure we have the lat/lng for both origin and destination
-                elsif characteristics[:origin_zip_code].latitude and characteristics[:origin_zip_code].longitude and
-                  characteristics[:destination_zip_code].latitude and characteristics[:destination_zip_code].longitude
-                    characteristics[:origin_zip_code].distance_to(characteristics[:destination_zip_code], :units => :kms)
-                    # FIXME TODO: calculate the distance via road using map directions
-                else
-                  nil
-                end
+            quorum 'from same locality', :needs => [:origin_zip_code, :destination_zip_code] do |characteristics|
+              if characteristics[:origin_zip_code] == characteristics[:destination_zip_code]
+                0
               else
                 nil
               end
             end
-          end
-          
-          committee :segment_count do
-            quorum 'default' do
-              # ASSUMED based on the fact that FedEx has a hub-spoke system with central and regional distribution centers so seems reasonable for average package to go through four FedEx facilities
-              5
+            quorum 'from mapquest', :needs => [:origin_zip_code, :destination_zip_code, :mode, :mapquest_api_key] do |characteristics|
+              unless characteristics[:mode].name == 'air'
+                mapquest = MapQuestDirections.new characteristics[:origin_zip_code].name,
+                                                  characteristics[:destination_zip_code].name,
+                                                  characteristics[:mapquest_api_key]
+                mapquest.distance_in_miles
+              end
+            end
+            quorum 'from direct path', :needs => [:origin_zip_code, :destination_zip_code, :mode] do |characteristics|
+              characteristics[:origin_zip_code].distance_to(characteristics[:destination_zip_code], :units => :kms)
             end
           end
-          
+
           committee :mode do
             quorum 'default' do
               ShipmentMode.fallback
@@ -148,6 +142,12 @@ module BrighterPlanet
               3.4
             end
           end
+
+          committee :mapquest_api_key do
+            quorum 'default' do
+              ENV['MAPQUEST_API_KEY']
+            end
+          end
         end
       end
     end

data/vendor/plugin/mapquest/init.rb

@@ -0,0 +1 @@
+require 'mapquest_directions'

data/vendor/plugin/mapquest/lib/mapquest_directions.rb

@@ -0,0 +1,51 @@
+require 'net/http'
+require 'nokogiri'
+
+class MapQuestDirections
+  class Failure < StandardError; end
+
+  attr_accessor :location_1, :location_2, :xml_call, :doc
+  
+  def initialize(location_1, location_2, api_key)
+    @base_url = "http://www.mapquestapi.com/directions/v1/route?key=#{api_key}&outFormat=xml&"    
+    @location_1 = location_1
+    @location_2 = location_2
+    options = "from=#{transcribe(@location_1)}&to=#{transcribe(@location_2)}"
+    @xml_call = @base_url + options
+  end
+  
+  def doc
+    @doc ||= begin
+      xml = get_url(xml_call)
+      noko = Nokogiri::XML(xml)
+      status = noko.css("statusCode").text
+      unless status == '0'
+        errors = noko.css("message").map(&:text).join(', ')
+        raise Failure, "Could not calculate directions between #{location_1} and #{location_2}: #{errors}"
+      end
+      noko
+    end
+  end
+
+  def drive_time_in_minutes
+    drive_time = doc.css("time").first.text
+    convert_to_minutes(drive_time)
+  end
+
+  def distance_in_miles
+    distance_in_miles = doc.css("distance").first.text.to_i
+  end
+    
+private
+  def convert_to_minutes(text)
+    (text.to_i / 60).ceil
+  end
+
+  def transcribe(location)
+    location.gsub(" ", "+")
+  end
+
+  def get_url(url)
+    Net::HTTP.get(::URI.parse(url))
+  end
+end

data/vendor/plugin/mapquest/spec/lib/mapquest_directions_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+context "Mapquest API" do
+  before(:all) do
+    @origin = "816 Meridian St., 37207"
+    @destination = "1963 Canary Dr., 36830"
+  end
+  
+  context "API working" do
+    
+    describe "directions work" do
+
+      before(:each) do
+        MapQuestDirections.any_instance.stubs(:xml).returns(File.read("spec/lib/mapquest_directions.xml"))
+        @directions = MapQuestDirections.new(@origin, @destination)
+      end
+
+      it "should return distance in miles" do
+        @directions.distance_in_miles.should == 310
+      end
+
+      it "should return drive time in minutes" do
+        @directions.drive_time_in_minutes.should == 303
+      end   
+      
+      it "should have a status code of 0" do
+        @directions.status.should == "0"
+      end
+
+    end #describe
+  end # API working
+  
+  context "API not working" do
+    
+    describe "Geocode distance estimation work" do
+
+      before(:each) do
+        MapQuestDirections.any_instance.stubs(:xml).returns(File.read("spec/lib/mapquest_directions_fail.xml"))
+        @directions = MapQuestDirections.new(@origin, @destination)
+      end
+
+      it "should return distance in miles" do
+        @directions.distance_in_miles.should == 0
+      end
+
+      it "should return drive time in minutes" do
+        @directions.drive_time_in_minutes.should == 0
+      end
+      
+      it "should have a status code other than 0" do
+        @directions.status.should_not == "0"
+      end   
+
+    end #describe
+  end # API not working
+  
+
+end

data/vendor/plugin/mapquest/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'mocha'
+require 'ruby-debug'
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'mapquest_directions'
+
+MAPQUEST_KEY = "replace_me"
+# http://developer.mapquest.com/
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shipment
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -19,102 +18,96 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -05:00
+date: 2010-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 3
         - 0
         - 1
         version: 3.0.1
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sniff
-  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 0
         - 4
         - 3
         version: 0.4.3
   type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: emitter
-  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 0
         - 3
         - 0
         version: 0.3.0
   type: :runtime
+  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: earth
-  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         - 3
         - 8
         version: 0.3.8
   type: :runtime
+  prerelease: false
   version_requirements: *id006
 description: A software model in Ruby for the greenhouse gas emissions of a shipment
 email: andy@rossmeissl.net
@@ -137,8 +130,13 @@ files:
 - lib/shipment/summarization.rb
 - lib/test_support/shipment_record.rb
 - features/support/env.rb
+- features/step_definitions/shipment_steps.rb
 - features/shipment_committees.feature
 - features/shipment_emissions.feature
+- vendor/plugin/mapquest/spec/lib/mapquest_directions_spec.rb
+- vendor/plugin/mapquest/spec/spec_helper.rb
+- vendor/plugin/mapquest/init.rb
+- vendor/plugin/mapquest/lib/mapquest_directions.rb
 has_rdoc: true
 homepage: http://brighterplanet.github.com/shipment
 licenses: []
@@ -153,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 774422413
       segments: 
       - 0
       version: "0"
@@ -162,7 +160,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -175,6 +172,11 @@ specification_version: 3
 summary: A carbon model for a shipment
 test_files: 
 - features/support/env.rb
+- features/step_definitions/shipment_steps.rb
 - features/shipment_committees.feature
 - features/shipment_emissions.feature
 - lib/test_support/shipment_record.rb
+- vendor/plugin/mapquest/spec/lib/mapquest_directions_spec.rb
+- vendor/plugin/mapquest/spec/spec_helper.rb
+- vendor/plugin/mapquest/init.rb
+- vendor/plugin/mapquest/lib/mapquest_directions.rb