google_directions 0.1.0 → 0.1.1

data/Manifest

@@ -1,5 +1,9 @@
 Manifest
 README.textile
 Rakefile
+google_directions.gemspec
 init.rb
 lib/google_directions.rb
+test/mocks/google_directions_samle_xml.xml
+test/test_helper.rb
+test/unit/google_directions_test.rb

data/README.textile

@@ -1,16 +1,54 @@
 h2. Usage
 
+Get a google maps API key, and store in your app under GOOGLE_MAPS_API_KEY
+<pre>GOOGLE_MAPS_API_KEY = 'your_api_key'</pre>
+
+<pre>directions = GoogleDirections.new(origin, destination)</pre>
+where _origin_ and _destination_ are strings of addresses or places that Google can find an address for.  Example: "816 Meridian St., 37207"
+
+Get drive time or distance of whole trip
+<pre>
+drive_time_in_minutes = directions.drive_time_in_minutes
+distance_in_miles = directions.distance_in_miles
+</pre>
+
+Get the XML Google returns with every turn, or the API call URL
+<pre>
+xml = directions.xml  
+xml_call = directions.xml_call
+</pre>
+
+h3. Error situations
+
+If Google can't recognize your places, the distance_in_miles and drive_time_in_minutes will each return 0.  You can call <pre>directions.status</pre> and it should return "NOT_FOUND" (directions.status will also return any other Google API call statuses)
+
+TODO: handle QUERY_OVER_LIMIT
 
 h2. Installation
 
 h3. gem
+
+rails 2.3
 # gem install google_directions
 # add config.gem "google_directions" to your environment.rb file
 
-Or do Bundler's Gemfile
+rails 3.0
+# gem 'google_directions' in your Gemfile
+# <pre>bundle install</pre> from command line
 
-h3. Rails 2.3.8 compatible
-Not yet tested on Rails 3
+h3. Rails plugin
+
+Rails 2.3
+<pre>script/plugin install git://github.com/joshcrews/google-directions-ruby.git</pre>
+
+Rails 3.0
+<pre>rails plugin install git://github.com/joshcrews/google-directions-ruby.git</pre>
+
+h3. Compatibility
+
+Tested on Rails 2.3.8
+
+Not yet tested on Rails 3.  It probably is Rails 3 compatible, because it's just a single class with a few methods.  It's probably compatible with every ruby project ever.
 
 h3. Google maps API key
 
@@ -18,4 +56,5 @@ You'll need a Google Map API key
 
 http://code.google.com/apis/maps/signup.html
 
-Include it as the constant GOOGLE_MAPS_API_KEY in an app configuration file (environment.rb, config/initializers/api_keys.rb)
+Include it as the constant GOOGLE_MAPS_API_KEY in an app configuration file (environment.rb, config/initializers/api_keys.rb)
+

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('google_directions', '0.1.0') do |p|
+Echoe.new('google_directions', '0.1.1') do |p|
   p.description    = "Ruby-wrapper for Google Directions API.  Can return the drive time and driving distance between to places"
   p.url            = "http://github.com/joshcrews/Google-Directions-Ruby"
   p.author         = "Josh Crews"

data/google_directions.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_directions}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Crews"]
@@ -10,13 +10,14 @@ Gem::Specification.new do |s|
   s.description = %q{Ruby-wrapper for Google Directions API.  Can return the drive time and driving distance between to places}
   s.email = %q{josh@joshcrews.com}
   s.extra_rdoc_files = ["README.textile", "lib/google_directions.rb"]
-  s.files = ["Manifest", "README.textile", "Rakefile", "init.rb", "lib/google_directions.rb", "google_directions.gemspec"]
+  s.files = ["Manifest", "README.textile", "Rakefile", "google_directions.gemspec", "init.rb", "lib/google_directions.rb", "test/mocks/google_directions_samle_xml.xml", "test/test_helper.rb", "test/unit/google_directions_test.rb"]
   s.homepage = %q{http://github.com/joshcrews/Google-Directions-Ruby}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Google_directions", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{google_directions}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby-wrapper for Google Directions API.  Can return the drive time and driving distance between to places}
+  s.test_files = ["test/test_helper.rb", "test/unit/google_directions_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/google_directions.rb

@@ -8,40 +8,52 @@ class GoogleDirections
     @base_url = "http://maps.google.com/maps/api/directions/xml?key=#{GOOGLE_MAPS_API_KEY}&sensor=false&"
     @location_1 = location_1
     @location_2 = location_2
+    options = "origin=#{transcribe(@location_1)}&destination=#{transcribe(@location_2)}"
+    @xml_call = @base_url + options
+    @xml = get_url(@xml_call)
+    @status = find_status
   end
+
+  # an example URL to be generated
+  #http://maps.google.com/maps/api/directions/xml?origin=St.+Louis,+MO&destination=Nashville,+TN&sensor=false&key=ABQIAAAAINgf4OmAIbIdWblvypOUhxSQ8yY-fgrep0oj4uKpavE300Q6ExQlxB7SCyrAg2evsxwAsak4D0Liiv
   
- # an example URL to be generated
- #http://maps.google.com/maps/api/directions/xml?origin=St.+Louis,+MO&destination=Nashville,+TN&sensor=false&key=ABQIAAAAINgf4OmAIbIdWblvypOUhxSQ8yY-fgrep0oj4uKpavE300Q6ExQlxB7SCyrAg2evsxwAsak4D0Liiv
- 
+  def find_status
+    doc = Nokogiri::XML(@xml)
+    doc.css("status").text
+  end
+
    def xml
-     full_url = xml_call
-     Rails.logger.info "Hit Google maps: #{full_url}"
-     @xml = get_url(full_url)
+     @xml
    end
-  
-    def xml_call
-      options = "origin=#{transcribe(@location_1)}&destination=#{transcribe(@location_2)}"
-      full_url = @base_url + options
-    end
-    
-    def drive_time_in_minutes
-      @xml ||= xml
+
+  def xml_call
+    @xml_call
+  end
+
+  def drive_time_in_minutes
+    if @status == "NOT_FOUND"
+      drive_time = 0
+    else
       doc = Nokogiri::XML(@xml)
-      raise "Google returned nothing" if doc.nil?
-      debugger if drive_time = doc.css("duration value").last.nil?
       drive_time = doc.css("duration value").last.text
-      Rails.logger.info "Hit Google maps: drive time: #{drive_time}"
       convert_to_minutes(drive_time)
     end
+  end
 
-    def distance_in_miles
-      @xml ||= xml
-      doc = Nokogiri::XML(xml)
+  def distance_in_miles
+    if @status == "NOT_FOUND"
+      distance_in_miles = 0
+    else
+      doc = Nokogiri::XML(@xml)
       meters = doc.css("distance value").last.text
-      miles = (meters.to_f / 1610.22).round
-      Rails.logger.info "Hit Google maps: #{miles} miles"
-      miles
+      distance_in_miles = (meters.to_f / 1610.22).round
+      distance_in_miles
     end
+  end
+  
+  def status
+    @status
+  end
     
   private
   

data/test/mocks/google_directions_samle_xml.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<DirectionsResponse>
+  <status>OK</status>
+  <route>
+    <summary>TN-53 S/Gordonsville Hwy</summary>
+    <leg>
+      <step>
+        <travel_mode>DRIVING</travel_mode>
+        <start_location>
+          <lat>36.2264000</lat>
+          <lng>-85.9490200</lng>
+        </start_location>
+        <end_location>
+          <lat>36.1929700</lat>
+          <lng>-85.9550000</lng>
+        </end_location>
+        <polyline>
+          <points>_nb|Ej|qkOfCFhH_@dEc@rE?nDb@vEjCjHxFzBtBpKnDlD|@bEPbGv@pFiArF?pHyDzDQHF~AExGz@dE?zE`@~@l@zDHbBf@lEf@pAZlG|FrC|@bGfFvBv@vLDfFoD`BO</points>
+          <levels>B????@??@???@???@??????@??@???@@?B</levels>
+        </polyline>
+        <duration>
+          <value>222</value>
+          <text>4 mins</text>
+        </duration>
+        <html_instructions>Head &lt;b&gt;south&lt;/b&gt; on &lt;b&gt;TN-53 S/Gordonsville Hwy&lt;/b&gt; toward &lt;b&gt;Riverwood Cir&lt;/b&gt;</html_instructions>
+        <distance>
+          <value>3950</value>
+          <text>2.5 mi</text>
+        </distance>
+      </step>
+      <step>
+        <travel_mode>DRIVING</travel_mode>
+        <start_location>
+          <lat>36.1929700</lat>
+          <lng>-85.9550000</lng>
+        </start_location>
+        <end_location>
+          <lat>36.1773300</lat>
+          <lng>-85.9475700</lng>
+        </end_location>
+        <polyline>
+          <points>a}{{EvaskOTw@zPiJPU~@QxCyA|C_BbBoAvCa@vI}F^q@xBg@~LmGbC{@|Be@rQFvAW</points>
+          <levels>B???????????@???B</levels>
+        </polyline>
+        <duration>
+          <value>141</value>
+          <text>2 mins</text>
+        </duration>
+        <html_instructions>Turn &lt;b&gt;left&lt;/b&gt; at &lt;b&gt;TN-53 S&lt;/b&gt; &lt;div style="font-size:0.9em"&gt;Destination will be on the right&lt;/div&gt;</html_instructions>
+        <distance>
+          <value>1912</value>
+          <text>1.2 mi</text>
+        </distance>
+      </step>
+      <duration>
+        <value>363</value>
+        <text>6 mins</text>
+      </duration>
+      <distance>
+        <value>5862</value>
+        <text>3.6 mi</text>
+      </distance>
+      <start_location>
+        <lat>36.2264000</lat>
+        <lng>-85.9490200</lng>
+      </start_location>
+      <end_location>
+        <lat>36.1773300</lat>
+        <lng>-85.9475700</lng>
+      </end_location>
+      <start_address>121 Gordonsville Hwy, Carthage, TN 37030, USA</start_address>
+      <end_address>499 Gordonsville Hwy, Gordonsville, TN 38563, USA</end_address>
+    </leg>
+    <copyrights>Map data ©2010 Google</copyrights>
+    <overview_polyline>
+      <points>_nb|Ej|qkOfCFhH_@dEc@rE?nDb@vEjCjHxFzBtBpKnDlD|@bEPbGv@pFiArF?pHyDzDQHF~AExGz@dE?zE`@~@l@zDHbBf@lEf@pAZlG|FrC|@bGfFvBv@vLDfFoD`BOTw@zPiJPU~@QxCyA|C_BbBoAvCa@vI}F^q@xBg@~LmGbC{@|Be@rQFvAW</points>
+      <levels>B????@??@???@??@?????@????@???@A?????????????@???B</levels>
+    </overview_polyline>
+  </route>
+</DirectionsResponse>

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'mocha'
+require 'test/unit'
+require 'ruby-debug'
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'google_directions'
+
+GOOGLE_MAPS_API_KEY = "ABQIAAAAj_VbPHmedky6mQd2p37p9xQbL-Ke6g7EfeqhfwcS7ZnhWLsBVxQA3yWKTKM9MVa31hYIhxsKffu7Pw"
+

data/test/unit/google_directions_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class GoogleDirectionsTest < Test::Unit::TestCase
+
+  def test_the_truth
+    assert true
+  end
+  
+  def test_happy_case
+    directions = GoogleDirections.new("121 Gordonsville Highway, 37030", "499 Gordonsville Highway, 38563")
+    assert_equal(4, directions.distance_in_miles)
+    assert_equal(6, directions.drive_time_in_minutes)
+      assert_equal("http://maps.google.com/maps/api/directions/xml?key=ABQIAAAAj_VbPHmedky6mQd2p37p9xQbL-Ke6g7EfeqhfwcS7ZnhWLsBVxQA3yWKTKM9MVa31hYIhxsKffu7Pw&sensor=false&origin=121+Gordonsville+Highway,+37030&destination=499+Gordonsville+Highway,+38563", directions.xml_call)
+    assert_not_nil(directions.xml =~ /36\.1773300/)
+  end
+  
+  def test_directions_not_found
+    directions = GoogleDirections.new("fasfefasdfdfsd", "499 Gordonsville Highway, 38563")
+    assert_equal(0, directions.distance_in_miles)
+    assert_equal(0, directions.drive_time_in_minutes)
+    assert_equal("NOT_FOUND", directions.status)
+  end
+  
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google_directions
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Josh Crews
@@ -47,9 +47,12 @@ files:
 - Manifest
 - README.textile
 - Rakefile
+- google_directions.gemspec
 - init.rb
 - lib/google_directions.rb
-- google_directions.gemspec
+- test/mocks/google_directions_samle_xml.xml
+- test/test_helper.rb
+- test/unit/google_directions_test.rb
 has_rdoc: true
 homepage: http://github.com/joshcrews/Google-Directions-Ruby
 licenses: []
@@ -90,5 +93,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby-wrapper for Google Directions API.  Can return the drive time and driving distance between to places
-test_files: []
-
+test_files: 
+- test/test_helper.rb
+- test/unit/google_directions_test.rb