google-geocode 1.0.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2006 Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/google_geocode.rb
+test/test_google_geocode.rb
+test/uri_stub.rb

data/README

@@ -0,0 +1,35 @@
+= google-geocode
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/google-geocode
+
+== About
+
+google-geocode implements Google's Geocoding API.
+
+== Installing google-geocode
+
+Just install the gem:
+
+  $ sudo gem install google-geocode
+
+== Using google-geocode
+
+First you need a Google Maps API key.  Yuo can register for one here:
+
+http://www.google.com/apis/maps/signup.html
+
+Then you create a GoogleGeocode object and start locating addresses:
+
+  require 'rubygems'
+  require 'google_geocode'
+  
+  gg = GoogleGeocode.new application_id
+  location = gg.locate '1600 Amphitheater Pkwy, Mountain View, CA'
+  p location.coordinates
+

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'google-geocode'
+  s.version = '1.0.0'
+  s.summary = 'Google Geocoder API Library'
+  s.description = 'Map addresses to latitude and longitude with Google\'s Geocoder.'
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Google Geocode'
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/google-geocode'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Google Geocode'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby
+

data/lib/google_geocode.rb

@@ -0,0 +1,123 @@
+require 'open-uri'
+require 'rexml/document'
+
+##
+# Library for looking up coordinates with Google's Geocoding API.
+#
+# http://www.google.com/apis/maps/documentation/#Geocoding_HTTP_Request
+
+class GoogleGeocode
+
+  ##
+  # Base error class
+
+  class Error < RuntimeError; end
+
+  ##
+  # Raised when you try to locate an invalid address.
+
+  class AddressError < Error; end
+
+  ##
+  # Raised when you use an invalid key.
+
+  class KeyError < Error; end
+
+  ##
+  # Location struct
+
+  Location = Struct.new :address, :latitude, :longitude
+
+  ##
+  # Creates a new GoogleGeocode that will use Google Maps API key +key+.  You
+  # can sign up for an API key here:
+  #
+  # http://www.google.com/apis/maps/signup.html
+
+  def initialize(key)
+    @key = key
+    @url = URI.parse 'http://maps.google.com/maps/geo'
+  end
+
+  ##
+  # Locates +address+ returning a Location struct.
+
+  def locate(address)
+    get :q => address
+  end
+
+  private
+
+  def parse_response(xml)
+    l = Location.new
+
+    l.address   = xml.elements['/kml/Response/Placemark/address'].text
+
+    coordinates = xml.elements['/kml/Response/Placemark/Point/coordinates'].text
+    l.longitude, l.latitude, = coordinates.split(',').map { |v| v.to_f }
+
+    return l
+  end
+
+  def check_error(obj)
+    obj = REXML::Document.new obj.read unless REXML::Document === obj
+
+    status = obj.elements['/kml/Response/Status/code'].text.to_i
+    case status
+    when 200 # ignore, ok
+    when 602
+      raise AddressError, 'invalid address'
+    when 610
+      raise KeyError, 'invalid key'
+    else
+      raise Error, "unknown error #{status}"
+    end
+  end
+
+  def get(params)
+    url = make_url params
+
+    url.open do |xml|
+      res = REXML::Document.new xml.read
+
+      check_error res
+      return parse_response(res)
+    end
+  rescue OpenURI::HTTPError => e
+    check_error e.io
+    raise
+  end
+
+  def make_url(params)
+    params[:key] = @key
+    params[:output] = 'xml'
+
+    escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
+      "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
+    end
+
+    url = @url.dup
+    url.query = escaped_params.join '&'
+    return url
+  end
+
+end
+
+##
+# A Location contains the following fields:
+#
+# +latitude+:: Latitude of the location
+# +longitude+:: Longitude of the location
+# +address+:: Street address of the result.
+
+class GoogleGeocode::Location
+
+  ##
+  # The coordinates for this location.
+
+  def coordinates
+    [latitude, longitude]
+  end
+
+end
+

data/test/test_google_geocode.rb

@@ -0,0 +1,74 @@
+require 'test/unit'
+require 'test/uri_stub'
+
+require 'google_geocode'
+
+class TestGoogleGeocode < Test::Unit::TestCase
+
+  def setup
+    URI::HTTP.responses = []
+    URI::HTTP.uris = []
+
+    @gg = GoogleGeocode.new 'APP_ID'
+  end
+
+  def test_locate
+    URI::HTTP.responses << <<-EOF.strip
+<?xml version="1.0" encoding="UTF-8"?><kml xmlns="http://earth.google.com/kml/2.0"><Response><name>1600 Amphitheatre Parkway, Mountain View, CA</name><Status><code>200</code><request>geocode</request></Status><Placemark><address>1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA</address><AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>CA</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Santa Clara</SubAdministrativeAreaName><Locality><LocalityName>Mountain View</LocalityName><Thoroughfare><ThoroughfareName>1600 Amphitheatre Pkwy</ThoroughfareName></Thoroughfare><PostalCode><PostalCodeNumber>94043</PostalCodeNumber></PostalCode></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><Point><coordinates>-122.083739,37.423021,0</coordinates></Point></Placemark></Response></kml>
+    EOF
+
+    location = GoogleGeocode::Location.new
+    location.address = '1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA'
+    location.latitude = 37.423021
+    location.longitude = -122.083739
+
+    assert_equal location,
+                 @gg.locate('1600 Amphitheatre Parkway, Mountain View, CA')
+
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://maps.google.com/maps/geo?key=APP_ID&output=xml&q=1600%20Amphitheatre%20Parkway,%20Mountain%20View,%20CA',
+                 URI::HTTP.uris.first
+  end
+
+  def test_locate_bad_key
+    URI::HTTP.responses << <<-EOF.strip
+<?xml version='1.0' encoding='UTF-8'?><kml xmlns='http://earth.google.com/kml/2.0'><Response><name>1600 Amphitheater Pkwy, Mountain View, CA</name><Status><code>610</code><request>geocode</request></Status></Response></kml>
+    EOF
+
+    @gg.locate 'x'
+
+  rescue GoogleGeocode::KeyError => e
+    assert_equal 'invalid key', e.message
+  else
+    flunk 'Error expected'
+  end
+
+  def test_locate_bad_address
+    URI::HTTP.responses << <<-EOF.strip
+<?xml version="1.0" encoding="UTF-8"?><kml xmlns="http://earth.google.com/kml/2.0"><Response><name>1600</name><Status><code>602</code><request>geocode</request></Status></Response></kml>
+    EOF
+
+    @gg.locate 'x'
+
+  rescue GoogleGeocode::AddressError => e
+    assert_equal 'invalid address', e.message
+  else
+    flunk 'Error expected'
+  end
+
+end
+
+class TestGoogleGeocodeLocation < Test::Unit::TestCase
+
+  def test_coordinates
+    location = GoogleGeocode::Location.new
+    location.address = '1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA'
+    location.latitude = 37.423021
+    location.longitude = -122.083739
+
+    assert_equal [37.423021, -122.083739], location.coordinates
+  end
+
+end
+

data/test/uri_stub.rb

@@ -0,0 +1,17 @@
+require 'open-uri'
+
+class URI::HTTP
+
+  class << self
+    attr_accessor :responses, :uris
+  end
+
+  alias original_open open
+
+  def open
+    self.class.uris << self.to_s
+    yield StringIO.new(self.class.responses.shift)
+  end
+
+end
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.15
+specification_version: 1
+name: google-geocode
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-06-12 00:00:00 -07:00
+summary: Google Geocoder API Library
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: Map addresses to latitude and longitude with Google's Geocoder.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/google_geocode.rb
+- test/test_google_geocode.rb
+- test/uri_stub.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+