google_directions 0.1.4 → 0.1.5

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.textile

@@ -1,8 +1,5 @@
 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"
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('google_directions', '0.1.4') do |p|
+Echoe.new('google_directions', '0.1.3') 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,33 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_directions}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Crews"]
-  s.date = %q{2010-07-21}
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
   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", "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.files = Dir["README.textile", "Gemfile", "Rakefile", "google_directions.gemspec", 'init.rb', "test/**/*", "lib/**/*.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"]
+  s.test_files = Dir.glob("test/**/*_test.rb")
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<nokogiri>, [">= 1.4.1"])
-    else
-      s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
-    end
-  else
-    s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
-  end
+  s.add_dependency("nokogiri", ">=1.4.1")
+  s.add_dependency("extlib", ">=0.9.15")
 end

data/init.rb

@@ -1 +1,2 @@
-require 'google_directions'
+# encoding: UTF-8
+require 'google_directions'

data/lib/google_directions.rb

@@ -1,75 +1,99 @@
+# encoding: UTF-8
+require 'cgi'
 require 'net/http'
+require 'open-uri'
 require 'nokogiri'
-require 'google_directions'
+require 'extlib/hash'
 
 class GoogleDirections
-  
-  def initialize(location_1, location_2)
-    @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
-    @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
-  
-  def find_status
-    doc = Nokogiri::XML(xml)
-    doc.css("status").text
-  end
+  attr_reader :status, :doc, :xml, :origin, :destination, :options
 
-  def xml
-    unless @xml.nil?
-       @xml
-    else
-      @xml ||= get_url(@xml_call)
-    end
+  @@base_url = 'http://maps.googleapis.com/maps/api/directions/xml'
+
+  @@default_options = {
+    :language => :en,
+    :alternative => :true,
+    :sensor => :false,
+    :mode => :driving,
+  }
+
+  def initialize(origin, destination, opts=@@default_options)
+    @origin = origin
+    @destination = destination
+    @options = opts.merge({:origin => transcribe(@origin), :destination => transcribe(@destination)})
+
+    @url = @@base_url + '?' + @options.to_params
+    @xml = open(@url).read
+    @doc = Nokogiri::XML(@xml)
+    @status = @doc.css('status').text
   end
 
   def xml_call
-    @xml_call
+    @url
   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
+
   def drive_time_in_minutes
     if @status != "OK"
       drive_time = 0
     else
-      doc = Nokogiri::XML(xml)
-      drive_time = doc.css("duration value").last.text
+      drive_time = @doc.css("duration value").last.text
       convert_to_minutes(drive_time)
     end
   end
 
+  # the distance.value field always contains a value expressed in meters.
+  def distance
+    return @distance if @distance
+    unless @status == 'OK'
+      @distance = 0
+    else
+      @distance = @doc.css("distance value").last.text
+    end
+  end
+
+  def distance_text
+    return @distance_text if @distance_text
+    unless @status == 'OK'
+      @distance_text = "0 km"
+    else
+      @distance_text = @doc.css("distance text").last.text
+    end
+  end
+
   def distance_in_miles
     if @status != "OK"
       distance_in_miles = 0
     else
-      doc = Nokogiri::XML(xml)
-      meters = doc.css("distance value").last.text
+      meters = distance
       distance_in_miles = (meters.to_f / 1610.22).round
       distance_in_miles
     end
   end
-  
-  def status
-    @status
+
+  def public_url
+    "http://maps.google.com/maps?saddr=#{transcribe(@origin)}&daddr=#{transcribe(@destination)}&hl=#{@options[:language]}&ie=UTF8"
+  end
+
+  def steps
+    if @status == 'OK'
+      @doc.css('html_instructions').map {|a| a.text }
+    else
+      []
+    end
   end
-    
+
   private
-  
+
     def convert_to_minutes(text)
-      (text.to_i / 60).ceil
+      (text.to_f / 60).round
     end
-  
+
     def transcribe(location)
-      location.gsub(" ", "+")
+      CGI::escape(location)
     end
 
-    def get_url(url)
-      Net::HTTP.get(::URI.parse(url))
-    end
-  
-end
+end

data/test/mocks/google_directions_samle_xml.xml

@@ -7,74 +7,60 @@
       <step>
         <travel_mode>DRIVING</travel_mode>
         <start_location>
-          <lat>36.2264000</lat>
-          <lng>-85.9490200</lng>
+          <lat>36.2263600</lat>
+          <lng>-85.9490400</lng>
         </start_location>
         <end_location>
-          <lat>36.1929700</lat>
-          <lng>-85.9550000</lng>
+          <lat>36.1772300</lat>
+          <lng>-85.9476400</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>
+          <points>wmb|En|qkObGX~BGbBQhHwAnBUxB?fBZlCjAzA~At@jA|DnIbC~DnAfAfDjBpCl@zAJ~A?vC[hRmEnHmA`Z}@~ENfCTlDt@xG|BxGvDtFlEnExC`Dz@bCLlAAnBS~CgAbXgPlOyHrf@}TfAOpQHlBE</points>
+          <levels>B??????@????@???@???@??@????@??A????@??B</levels>
         </polyline>
         <duration>
-          <value>222</value>
-          <text>4 mins</text>
+          <value>354</value>
+          <text>6 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>
+        <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;&lt;div style=&quot;font-size:0.9em&quot;&gt;Destination will be on the right&lt;/div&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>
+          <value>5928</value>
+          <text>3.7 mi</text>
         </distance>
       </step>
       <duration>
-        <value>363</value>
+        <value>354</value>
         <text>6 mins</text>
       </duration>
       <distance>
-        <value>5862</value>
-        <text>3.6 mi</text>
+        <value>5928</value>
+        <text>3.7 mi</text>
       </distance>
       <start_location>
-        <lat>36.2264000</lat>
-        <lng>-85.9490200</lng>
+        <lat>36.2263600</lat>
+        <lng>-85.9490400</lng>
       </start_location>
       <end_location>
-        <lat>36.1773300</lat>
-        <lng>-85.9475700</lng>
+        <lat>36.1772300</lat>
+        <lng>-85.9476400</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>
+    <copyrights>Map data ©2011 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>
+      <points>wmb|En|qkObGX~BGbBQhHwAnBUxB?fBZlCjAzA~At@jA|DnIbC~DnAfAfDjBpCl@zAJ~A?vC[hRmEnHmA`Z}@~ENfCTlDt@xG|BxGvDtFlEnExC`Dz@bCLlAAnBS~CgAbXgPlOyHrf@}TfAOpQHlBE</points>
+      <levels>B??????@????@???@???@??@????@??A????@??B</levels>
     </overview_polyline>
+    <bounds>
+      <southwest>
+        <lat>36.1772300</lat>
+        <lng>-85.9560100</lng>
+      </southwest>
+      <northeast>
+        <lat>36.2263600</lat>
+        <lng>-85.9476200</lng>
+      </northeast>
+    </bounds>
   </route>
 </DirectionsResponse>

data/test/test_helper.rb

@@ -1,10 +1,6 @@
+# encoding: UTF-8
 require 'rubygems'
 require 'mocha'
 require 'test/unit'
-require 'ruby-debug'
 
-$:.unshift File.expand_path('../lib', __FILE__)
 require 'google_directions'
-
-GOOGLE_MAPS_API_KEY = "afakeapithatworksanyway"
-

data/test/unit/google_directions_test.rb

@@ -1,32 +1,57 @@
-require 'test_helper'
+# encoding: UTF-8
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
 
+# TODO: mocks
 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")
+    orig = "121 Gordonsville Highway, 37030"
+    dest = "499 Gordonsville Highway, 38563"
+    directions = GoogleDirections.new(orig, dest)
     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=afakeapithatworksanyway&sensor=false&origin=121+Gordonsville+Highway,+37030&destination=499+Gordonsville+Highway,+38563", directions.xml_call)
-    assert_not_nil(directions.xml =~ /36\.1773300/)
+    assert_equal('http://maps.googleapis.com/maps/api/directions/xml?language=en&alternative=true&sensor=false&mode=driving&origin=121+Gordonsville+Highway%2C+37030&destination=499+Gordonsville+Highway%2C+38563', directions.xml_call)
+    # end_location > lat
+    assert_not_nil(directions.xml =~ /36\.1772300/)
+    assert_equal orig, directions.origin
+    assert_equal dest, directions.destination
   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
-  
+
   def test_zero_results
-    directions = GoogleDirections.new("COMMUNITY SOUTH HOSPITAL 1402 EAST COUNTY LINE ROAD, 46227", "499 Gordonsville Highway, 38563")
+    directions = GoogleDirections.new("27 Beemdenlaan, 2550 Kontich", "499 Gordonsville Highway, 38563")
     assert_equal(0, directions.distance_in_miles)
     assert_equal(0, directions.drive_time_in_minutes)
     assert_equal("ZERO_RESULTS", directions.status)
   end
-  
-  
+
+  def test_french_direction
+    assert_nothing_raised do
+      # URI::InvalidURIError
+      directions = GoogleDirections.new("15 rue poissonnière, 75002 Paris", "169 11th Street CA 94103 San Francisco United States")
+    end
+  end
+
+  def test_steps
+    directions = GoogleDirections.new("rue poissonnière, 75002 Paris", "51 rue de Turbigo, 75003 Paris France")
+    assert_equal Array, directions.steps.class
+    assert_equal 3, directions.steps.size
+  end
+
+  def test_distance_text
+    directions = GoogleDirections.new("Place du Maquis du Vercors PARIS-19EME", "rue poissoniere 75002 paris")
+    assert_equal String, directions.distance_text.class
+    assert_equal "6.7 km", directions.distance_text
+  end
+
+  def test_zero_distance_text
+    directions = GoogleDirections.new("27 Beemdenlaan, 2550 Kontich", "499 Gordonsville Highway, 38563")
+    assert_equal "0 km", directions.distance_text
+  end
 end

metadata

@@ -1,98 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google_directions
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Josh Crews
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-07-21 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70151553549100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 4
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.1
-  type: :development
-  version_requirements: *id001
-description: Ruby-wrapper for Google Directions API.  Can return the drive time and driving distance between to places
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151553549100
+- !ruby/object:Gem::Dependency
+  name: extlib
+  requirement: &70151553548140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.15
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151553548140
+description: Ruby-wrapper for Google Directions API.  Can return the drive time and
+  driving distance between to places
 email: josh@joshcrews.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.textile
 - lib/google_directions.rb
-files: 
-- Manifest
+files:
 - README.textile
+- Gemfile
 - 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
-has_rdoc: true
+- lib/google_directions.rb
 homepage: http://github.com/joshcrews/Google-Directions-Ruby
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Google_directions
 - --main
 - README.textile
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: google_directions
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 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/test_helper.rb
+summary: Ruby-wrapper for Google Directions API.  Can return the drive time and driving
+  distance between to places
+test_files:
 - test/unit/google_directions_test.rb

data/Manifest

@@ -1,9 +0,0 @@
-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