yahoo-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,6 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/yahoo/geocode.rb
+test/test_geocode.rb

data/README

@@ -0,0 +1,35 @@
+= yahoo-geocode
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools/
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/yahoo-geocode/
+
+== About
+
+yahoo-geocode implements version 1 of Yahoo's Maps Web Services Geocoding API.
+
+== Installing yahoo-geocode
+
+Just install the gem:
+
+  $ sudo gem install yahoo-geocode
+
+== Using yahoo-geocode
+
+First you'll need a Yahoo Application ID.  You can register for one here:
+
+http://api.search.yahoo.com/webservices/register_application
+
+Then you create a Yahoo::Geocode object and start locating addresses:
+
+  require 'rubygems'
+  require 'yahoo/geocode'
+  
+  yg = Yahoo::Geocode.new application_id
+  locations = yg.locate '701 First Street, Sunnyvale, CA'
+  p location.first.coordinates
+

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'yahoo-geocode'
+  s.version = '1.0.0'
+  s.summary = 'A Ruby Yahoo Geocoder Library'
+  s.description = 'An interface to Yahoo\'s Geocoder service.
+
+http://developer.yahoo.com/maps/rest/V1/geocode.html'
+
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+
+  s.add_dependency 'yahoo', '1.0.0'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.libs << '../yahoo'
+  t.libs << '../yahoo/lib'
+  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 Yahoo Maps Web Services Geocoding API'
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/yahoo-geocode'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Yahoo Maps Web Services Geocoding API'
+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/yahoo/geocode.rb

@@ -0,0 +1,103 @@
+require 'yahoo'
+
+##
+# Yahoo geocoding API.
+#
+# http://developer.yahoo.com/maps/rest/V1/geocode.html
+
+class Yahoo::Geocode < Yahoo
+
+  ##
+  # Location result Struct.
+
+  Location = Struct.new :latitude, :longitude, :address, :city, :state, :zip,
+                        :country, :precision, :warning
+
+  def initialize(*args) # :nodoc:
+    @host = 'api.local.yahoo.com'
+    @service_name = 'MapsService'
+    @version = 'V1'
+    @method = 'geocode'
+    super
+  end
+
+  ##
+  # Returns a Location for +address+.
+  #
+  # The +address+ can be any of:
+  # * city, state
+  # * city, state, zip
+  # * zip
+  # * street, city, state
+  # * street, city, state, zip
+  # * street, zip
+
+  def locate(address)
+    get :location => address
+  end
+
+  def parse_response(xml) # :nodoc:
+    addresses = []
+
+    xml.elements['ResultSet'].each do |r|
+      address = Location.new
+
+      address.precision = r.attributes['precision']
+
+      if r.attributes.include? 'warning' then
+        address.warning = r.attributes['warning']
+      end
+
+      address.latitude = r.elements['Latitude'].text.to_f
+      address.longitude = r.elements['Longitude'].text.to_f
+
+      address.address = r.elements['Address'].text
+      address.city = r.elements['City'].text
+      address.state = r.elements['State'].text
+      address.zip = r.elements['Zip'].text
+      address.country = r.elements['Country'].text
+
+      addresses << address
+    end
+
+    return addresses
+  end
+
+end
+
+##
+# A Location contains the following fields:
+#
+# +latitude+:: Latitude of the location
+# +longitude+:: Longitude of the location
+# +address+:: Street address of the result, if a specific location could be
+#             determined
+# +city+:: City in which the result is located
+# +state+:: State in which the result is located
+# +zip+:: Zip code, if known
+# +country+:: Country in which the result is located
+# +precision+:: The precision of the address used for geocoding
+# +warning+:: If the exact address was not found, the closest available match
+#
+# Precision can be one of the following, from most specific to most general:
+#
+# * address
+# * street
+# * zip+4
+# * zip+2
+# * zip
+# * city
+# * state
+# * country
+
+class Yahoo::Geocode::Location
+
+  ##
+  # Returns an Array with latitude and longitude.
+
+  def coordinates
+    [latitude, longitude]
+  end
+
+end
+

data/test/test_geocode.rb

@@ -0,0 +1,61 @@
+require 'test/unit'
+require 'test/uri_stub'
+require 'yahoo/geocode'
+
+class Yahoo::TestGeocode < Test::Unit::TestCase
+
+  def setup
+    URI::HTTP.responses = []
+    URI::HTTP.uris = []
+
+    @g = Yahoo::Geocode.new 'APP_ID'
+    @location = '701 First Street, Sunnyvale, CA'
+  end
+
+  def test_locate
+    URI::HTTP.responses << <<-EOF.strip
+<?xml version="1.0"?>
+<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:maps" xsi:schemaLocation="urn:yahoo:maps http://api.local.yahoo.com/MapsService/V1/GeocodeResponse.xsd"><Result precision="address" warning="The exact location could not be found, here is the closest match: 701 First Ave, Sunnyvale, CA 94089"><Latitude>37.416384</Latitude><Longitude>-122.024853</Longitude><Address>701 FIRST AVE</Address><City>SUNNYVALE</City><State>CA</State><Zip>94089-1019</Zip><Country>US</Country></Result></ResultSet>
+<!-- ws02.search.scd.yahoo.com compressed/chunked Thu Jun  8 15:20:46 PDT 2006 -->
+    EOF
+
+    assert_equal [37.416384, -122.024853],
+                 @g.locate('701 First Street, Sunnyvale, CA').first.coordinates
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://api.local.yahoo.com/MapsService/V1/geocode?appid=APP_ID&location=701%20First%20Street,%20Sunnyvale,%20CA&output=xml',
+                 URI::HTTP.uris.first
+  end
+
+  def test_locate_bad_address
+    URI::HTTP.responses << <<-EOF.strip
+<?xml version="1.0" encoding="UTF-8"?>	<Error xmlns="urn:yahoo:api">
+		The following errors were detected:
+		<Message>unable to parse location</Message></Error>
+<!-- ws02.search.scd.yahoo.com uncompressed/chunked Thu Jun  8 15:53:20 PDT 2006 -->
+    EOF
+
+    assert_raise Yahoo::Error do
+      @g.locate 'yucksthoeusthaoeusnhtaosu'
+    end
+
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://api.local.yahoo.com/MapsService/V1/geocode?appid=APP_ID&location=yucksthoeusthaoeusnhtaosu&output=xml',
+                 URI::HTTP.uris.first
+  end
+
+end
+
+class Yahoo::Geocode::TestLocation < Test::Unit::TestCase
+
+  def test_coordinates
+    loc = Yahoo::Geocode::Location.new
+    loc.latitude = Math::E
+    loc.longitude = Math::PI
+
+    assert_equal [Math::E, Math::PI], loc.coordinates
+  end
+
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.15
+specification_version: 1
+name: yahoo-geocode
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-06-10 00:00:00 -07:00
+summary: A Ruby Yahoo Geocoder Library
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: An interface to Yahoo's Geocoder service.  http://developer.yahoo.com/maps/rest/V1/geocode.html
+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/yahoo/geocode.rb
+- test/test_geocode.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yahoo
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: