toll_booth 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+features_rcov
+coverage.data

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,42 @@
+= toll_booth
+    @origin = TollBooth::Location.new("4 Yawkey Way, Boston, MA")
+    @destination = TollBooth::Location.new("1 Fleetcenter Place, Boston, MA")
+    @routes = @origin.drive_to(@destination)
+    if @routes.found?
+      @routes[0].distance              #distance in miles
+      @routes[0].drive_time            #drive time in seconds
+      @routes[0].name                  #name of route (usually specified when multiple routes are returned)
+      @routes[0].steps                 #array of TollBooth::Steps to take
+      @routes[0].steps[0].distance     #distance of step in miles
+      @routes[0].steps[0].description  #summary of step
+    else
+      puts @routes.errors.join(",")
+    end
+
+== Install
+  sudo gem install dpickett-toll_booth
+
+== Links of Interest
+* {Issue Tracker}[http://github.com/dpickett/toll_booth/issues]
+* {RDoc}[http://rdoc.info/projects/dpickett/toll_booth]
+* {WWR Profile (please recommend me if you find this software useful)}[http://workingwithrails.com/person/8076-dan-pickett]
+
+== TODO
+* Allow Configuration for Key
+* Some unit testing with FakeWeb for 100% coverage
+* Fix distance parsing for when distance is expressed in ft
+* public transit directions
+* Walking directions
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. 
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "toll_booth"
+    gem.summary = %Q{API Wrapper for Google Directions}
+    gem.description = %Q{API Wrapper for Google Directions}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/toll_booth"
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency("jnunemaker-httparty", ">= 0.4.4")  
+    gem.add_dependency("hpoydar-chronic_duration", ">= 0.7.4")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+namespace :rcov do
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new(:tests) do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.rcov_opts = %w{--aggregate coverage.data --exclude osx\/objc,gems\/,spec\/}
+    test.verbose = true
+  end  
+  
+  require 'cucumber/rake/task'  
+  Cucumber::Rake::Task.new(:cucumber) do |t|    
+    t.rcov = true
+    t.rcov_opts = %w{--aggregate coverage.data --exclude osx\/objc,gems\/,features\/,spec\/ -o "features_rcov"}
+  end
+end
+
+begin
+  require 'rcov/rcovtask'
+  desc "Run both specs and features to generate aggregated coverage"
+  task :rcov do |t|
+    rm "coverage.data" if File.exist?("coverage.data")
+    Rake::Task["rcov:cucumber"].invoke
+    Rake::Task["rcov:tests"].invoke
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "toll_booth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/get_directions.feature

@@ -0,0 +1,25 @@
+Feature: As a user of the toll_booth library
+  I want to retrieve direction data
+  So that I can interact with it
+
+  Scenario: Get Routes From a Simple Trip
+    Given I'm starting at "4 Yawkey Way, Boston, MA"
+    And I want to go to "1 Fleetcenter Place, Boston, MA"
+    When I get driving directions
+    Then I should get a list of possible routes
+    And the first route should have a "distance"
+    And the first route should have "travel_time"
+    And the first route should have a list of "steps"
+
+  Scenario: Invalid Destination
+    Given I'm starting at "4 Yawkey Way, Boston, MA"
+    And I want to go to "Foobar"
+    When I get driving directions
+    Then I should get "1" routing error
+
+  Scenario: Invalid Origin
+    Given I'm starting at "Foobar"
+    And I want to go to "1 Fleetcenter Place, Boston, MA"
+    When I get driving directions
+    Then I should get "1" routing error
+

data/features/step_definitions/direction_steps.rb

@@ -0,0 +1,22 @@
+When /^I get driving directions$/ do
+  @routes = @origin.drive_to(@destinations)
+end
+
+Then /^I should get a list of possible routes$/ do
+  assert !@routes.found?
+end
+
+Then /^the first route should have (a\s)?"(.*)"$/ do |a, attribute|
+  assert_not_nil @routes[0].send(attribute)
+end
+
+Then /^the first route should have a list of "([^\"]*)"$/ do |set|
+  assert_instance_of Array, @routes[0].send(set)
+  assert !@routes[0].send(set).empty?
+end
+
+
+Then /^I should get "([^\"]*)" routing error$/ do |error_qty|
+  assert_equal error_qty.to_i, @routes.errors.size
+end
+

data/features/step_definitions/location_steps.rb

@@ -0,0 +1,9 @@
+Given /^I'm starting at "([^\"]*)"$/ do |location|
+  @origin = TollBooth::Location.new(location)
+end
+
+Given /^I want to go to "([^\"]*)"$/ do |location|
+  @destinations ||= []
+  @destinations << TollBooth::Location.new(location)
+end
+

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'toll_booth'
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/lib/toll_booth/location.rb

@@ -0,0 +1,37 @@
+module TollBooth
+  # Represents a location that you would want directions from or to
+  # A location has the following attributes:
+  # * description
+  class Location
+    attr_accessor :description
+
+    # create a new location
+    # @param description [String] address or zipcode of the location
+    def initialize(description)
+      @description = description
+    end
+
+    # get driving routes to the destinations specified
+    # @example 
+    #   @origin = TollBooth::Location.new("4 Yawkey Way, Boston, MA")
+    #   @destination = TollBooth::Location.new("1 Fleetcenter Place, Boston, MA")
+    #   @routes = @origin.drive_to(@destination)
+    #   if @routes.found?
+    #     @routes[0].distance              #distance in miles
+    #     @routes[0].drive_time            #drive time in seconds
+    #     @routes[0].name                  #name of route (usually specified when multiple routes are returned)
+    #     @routes[0].steps                 #array of TollBooth::Steps to take
+    #     @routes[0].steps[0].distance     #distance of step in miles
+    #     @routes[0].steps[0].description  #summary of step
+    #   else
+    #     puts @routes.errors.join(",")
+    #   end
+    # @param destinations [TollBooth::Location, Array] a single location or list of locations to drive to
+    # @return [TollBooth::RouteCollection] a collection of potential routes to specified destination(s)
+    def drive_to(destinations)
+      destinations = [destinations] if !destinations.is_a?(Array)
+
+      TollBooth::Route.find(self, destinations)
+    end
+  end
+end

data/lib/toll_booth/route.rb

@@ -0,0 +1,62 @@
+module TollBooth
+  class Route
+    include HTTParty
+    attr_accessor :name, :steps, :distance, :travel_time
+
+    default_params(
+      :output => "json"
+    )
+    base_uri "http://maps.google.com/maps/nav"
+
+    class << self
+      # get driving directions from the origin to the specified destination(s)
+      # @param origin [TollBooth::Location] the starting point for the trip
+      # @param destinations [Array] a list of destinations to drive to
+      # @return [TollBooth::RouteCollection] a list of potential routes for the trip
+      def find(origin, destinations)
+        response = get("", 
+          :query => {:q => "from: #{origin.description} " + 
+            destinations.collect{|d| " to: #{d.description}"}.join("")}) 
+        routes = parse(response)
+
+        routes
+      end
+
+      # parses response from google
+      # @param the response received from google
+      # @return [TollBooth::RouteCollection] returns a route collection based on the request
+      def parse(response)
+        resp = JSON.parse(response.body)
+
+        code = response["Status"]["code"] 
+        routes = TollBooth::RouteCollection.new
+        if code == 200
+          resp["Directions"]["Routes"].each do |r|
+            route = new 
+            route.distance = r["Distance"]["html"].gsub("&nbsp;mi", "").to_f
+            route.travel_time = ChronicDuration.parse(r["Duration"]["html"])
+            route.steps = TollBooth::RouteStep.parse(r["Steps"])
+
+            routes << route
+          end 
+
+        else
+          routes.errors = [error_for(code)]
+        end
+        routes
+      end
+
+      private
+      # get a friently error message for the status code specified
+      # @param code [Integer] code to translate
+      # @return [String] a friendly error message
+      def error_for(code)
+        if code == 602
+          "Bad Address Specified"
+        elsif code == 500
+          "Server Error"
+        end
+      end
+    end
+  end
+end

data/lib/toll_booth/route_collection.rb

@@ -0,0 +1,18 @@
+module TollBooth
+  # a collection of routes received from google after requesting directions
+  # if an error occurs, the collection will be empty and the errors attribute will 
+  # be populated
+  class RouteCollection < Array
+    attr_accessor :errors
+    def initialize(size = 0, obj = nil)
+      super
+      @errors = [] 
+    end
+
+    # where routes found?
+    # @return [Boolean] whether routes were found or not
+    def found?
+      empty?
+    end
+  end
+end

data/lib/toll_booth/route_step.rb

@@ -0,0 +1,38 @@
+module TollBooth
+  #a direction to take for a given route
+  #direction steps have the following attributes
+  # * distance (in miles)
+  # * travel_time (in seconds)
+  # * latitude
+  # * longitude
+  # * html_description
+  # * description (html stripped)
+  class RouteStep
+    attr_accessor :distance, :travel_time, :latitude, :longitude, :html_description
+
+    # strips any html from the html_description_attribute
+    # @return [String]
+    def description
+      @html_description.gsub(/<\/?[^>]*>/, "")
+    end
+
+    class << self
+      # parses the step from the json supplied
+      def parse(json)
+        route_steps = []
+        json.each do |s|
+          route_step = new
+          route_step.html_description = s["descriptionHtml"]
+          route_step.travel_time = s["Duration"]["seconds"]
+          route_step.distance  = s["Distance"]["html"]
+          route_step.latitude  = s["Point"]["coordinates"][0]
+          route_step.longitude = s["Point"]["coordinates"][1]
+
+          route_steps << route_step
+        end
+
+        route_steps
+      end
+    end
+  end
+end

data/lib/toll_booth.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "httparty"
+require "json"
+require "chronic_duration"
+
+require "toll_booth/route_collection"
+require "toll_booth/route_step"
+require "toll_booth/route"
+require "toll_booth/location"

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'toll_booth'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: toll_booth
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpoydar-chronic_duration
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.4
+    version: 
+description: API Wrapper for Google Directions
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/get_directions.feature
+- features/step_definitions/direction_steps.rb
+- features/step_definitions/location_steps.rb
+- features/step_definitions/toll_booth_steps.rb
+- features/support/env.rb
+- lib/toll_booth.rb
+- lib/toll_booth/location.rb
+- lib/toll_booth/route.rb
+- lib/toll_booth/route_collection.rb
+- lib/toll_booth/route_step.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/toll_booth
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: API Wrapper for Google Directions
+test_files: 
+- test/test_helper.rb