geocoder 0.1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+= 0.1.0 
+== February 8, 2006
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Paul Smith <paul@cnt.org>
+
+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

@@ -0,0 +1,122 @@
+= Geocoder: Geocoding library for Ruby and command-line utility
+
+Author:: Paul Smith <paul@cnt.org>
+License:: MIT
+
+Geocoder helps in converting street addresses to coordinate pairs,
+specifically latitude and longitude (in degrees decimal). It also
+provides address normalization.
+
+It comes with a library so that Ruby developers can include geocoding
+in their applications. It also comes with a command-line application,
+<tt>geocode</tt>, that is useful for one-offs, shell scripts, and non-Ruby
+applications.
+
+== How it works
+
+The Geocoder is basically a wrapper for geocoding web services.
+Currently, two services are utilized: {Yahoo! Maps Geocoding
+API}[http://developer.yahoo.net/maps/rest/V1/geocode.html], which
+is an interface to their proprietary geocoding system; and
+Geocoder.us[http://www.geocoder.us], which is basically a Perl
+frontend to the TIGER/Line file from the US Census Bureau.
+
+Unless the user or developer indicates otherwise, the Yahoo! Maps
+API is used by default.
+
+== Example: library
+
+If you are going to use this library with the Yahoo! Maps Geocoding
+service, you need to get yourself an {Application
+ID}[http://developer.yahoo.net/faq/index.html#appid].
+
+The very simplest use of the library would just instantiate a
+Geocoder object and call the <tt>#geocode</tt> method, grab the
+result, and get the values directly:
+
+  require 'geocoder'
+  geocoder = Geocoder::Yahoo.new "my_app_id" # => #<Geocoder::Yahoo:0x36b77c @appid="my_app_id">
+  result = geocoder.geocode "1600 pennsylvania ave nw washington dc"
+  result.lat # => "38.8987"
+  result.lng # => "-77.037223"
+  result.address # => "1600 PENNSYLVANIA AVE NW"
+  result.city # => "WASHINGTON"
+  result.state # => "DC"
+  result.zip # => "20502-0001"
+
+The result that the <tt>geocode</tt> method returns is a subclass
+of Array; each element contains the "closest match" for ambiguous
+addresses, as determined by the remote geocoding service.
+
+Any sort of production-level code would want to check for success
+and watch for exceptions. Geocoding is an inexact science, so you
+would want to check for success, and iterate over the refinements
+or closest matches that the service returns:
+
+  require 'geocoder'
+  geocoder = Geocoder::Yahoo.new "my_app_id" # => #<Geocoder::Yahoo:0x36ae44 @appid="my_app_id">
+  result = geocoder.geocode "2038 damen ave chicago il"
+  result.success? # => false
+  result.each do |r|
+    r.lat # => "41.854524", "41.918759"
+    r.lng # => "-87.676083", "-87.67763"
+    r.address # => "2038 S DAMEN AVE", "2038 N DAMEN AVE"
+    r.city # => "CHICAGO", "CHICAGO"
+    r.state # => "IL", "IL"
+    r.zip # => "60608-2625", "60647-4564"
+  end
+
+<tt>#success?</tt> is defined by a single result returned from the
+geocoding service (and in the case of the Y! API, with no warning)
+
+  require 'geocoder'
+  geocoder = Geocoder::Yahoo.new "my_app_id"
+  begin
+    result = geocoder.geocode "thisisnotreal"
+  rescue Geocoder::GeocodingError
+    # do something appropriate to your application here
+  end
+
+The Geocoder module defines 2 exception classes:
+
+1. BlankLocationString, thrown if a nil or a empty String is given to the geocode method;
+2. GeocodingError, thrown if the remote service indicates an error, for instance, on an ungeocodeable location
+
+== Example: command-line utility
+
+  % geocode 2125 W North Ave, Chicago IL
+  Found 1 result(s).
+  ------------------
+  Latitude: 41.910263
+  Longitude: -87.680696
+  Address: 2125 W NORTH AVE
+  City: CHICAGO
+  State: IL
+  ZIP Code: 60647-5415
+
+Notice that the geocoder normalizes the address, including city,
+state, and ZIP Code.
+
+You can also throw some switches on it. Try <tt>-q</tt> for quieter, CSV output:
+
+  % geocode -q 1600 pennsylvania ave nw washington dc
+  38.8987,-77.037223,1600 PENNSYLVANIA AVE NW,WASHINGTON,DC,20502-0001
+
+The order of the fields in the CSV output is:
+
+1. latitude (degrees decimal)
+2. longitude (degrees decimal)
+3. street address
+4. city
+5. state
+6. ZIP Code
+
+== Usage: command-line utility
+
+  % geocode -h
+  Options:
+      -a, --appid appid                Yahoo! Application ID
+      -s, --service service            `yahoo' or `geocoderus'
+      -t, --timeout secs               Timeout in seconds
+      -q, --quiet                      Quiet output
+      -h, --help                       Show this message

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems'
+
+GEOCODER_VERSION = "0.1.0"
+
+PKG_FILES = FileList["lib/**/*", "bin/**/*", "[A-Z]*",
+  "test/**/*"].exclude(/\b\.svn\b/)
+
+desc "Run all tests"
+task :default => [ :test ]
+
+desc "Run all tests"
+task :test do
+  ruby "test/ts_geocoder.rb"
+end
+
+desc "Generate documentation"
+task :docs do
+  sh "rdoc -S -N -o doc -t \"Geocoder Documentation\" README TODO lib"
+end
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Geocoding library and CLI."
+  s.name = "geocoder"
+  s.version = GEOCODER_VERSION
+  s.requirements << "none"
+  s.require_path = "lib"
+  s.author = "Paul Smith"
+  s.files = PKG_FILES
+  s.email = "paul@cnt.org"
+  s.rubyforge_project = "geocoder"
+  s.homepage = "http://geocoder.rubyforge.org"
+  s.bindir = "bin"
+  s.executables = ["geocode"]
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/TODO

@@ -0,0 +1,10 @@
+= Geocoder To-Do list
+
+Send suggestions to Paul Smith <paul@cnt.org>.
+
+* unit tests for CLI
+* many more tests of known and unknown addresses
+* caching
+* more services (c'mon, Google!)
+* Rails plugin
+* option to "average" results from more than one service

data/bin/geocode

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'geocoder'
+cli = Geocoder::Cli.new ARGV
+cli.go!

data/lib/geocoder.rb

@@ -0,0 +1,327 @@
+#--
+# Copyright (c) 2006 Paul Smith <paul@cnt.org>
+#
+# 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.
+#++
+#
+# = Geocoder -- Geocoding library for Ruby
+#
+require 'cgi'
+require 'net/http'
+require 'rexml/document'
+require 'timeout'
+
+module Geocoder
+
+  class BlankLocationString < Exception; end
+  class GeocodingError < Exception; end
+
+  FIELDS = [ ["latitude", "Latitude"],
+             ["longitude", "Longitude"],
+             ["address", "Address"],
+             ["city", "City"],
+             ["state", "State"], 
+             ["zip", "ZIP Code"] ].freeze
+
+  class Base
+    # +location+ is a string, any of the following:
+    # * city, state
+    # * city, state, zip
+    # * zip
+    # * street, city, state
+    # * street, city, state, zip
+    # * street, zip
+    def geocode location, *args
+      options = { :timeout => nil }
+      options.update(args.pop) if args.last.is_a?(Hash)
+      @options = options
+      if location.nil? or location.empty?
+        raise BlankLocationString
+      end
+      location = String location
+      results = parse request(location)
+      create_response results
+    end
+          
+    def create_response results
+      Response.new results
+    end
+
+    # Makes an HTTP GET request on URL and returns the body
+    # of the response
+    def get url, timeout=5
+      url = URI.parse url
+      http = Net::HTTP.new url.host, url.port
+      res = Timeout::timeout(timeout) {
+        http.get url.request_uri
+      }
+      res.body
+    end
+
+    def request location
+      get url(location), @options[:timeout]
+    end
+  end
+
+  class GeoCoderUs < Base
+    def initialize *args
+      #
+    end
+
+    private
+
+    def parse csv_text
+      if csv_text =~ /^2: /
+        raise GeocodingError, csv_text.split(": ")[1]
+      end
+      results = []
+      csv_text.split("\n").each do |line|
+        latitude, longitude, address, city, state, zip = line.split ","
+        result = Result.new
+        result.latitude = latitude
+        result.longitude = longitude
+        result.address = address
+        result.city = city
+        result.state = state
+        result.zip = zip
+        results << result
+      end
+      results
+    end
+
+    # Returns URL of geocoder.us web service
+    def url address
+      "http://rpc.geocoder.us/service/csv?address=#{CGI.escape address}"
+    end
+  end
+
+  class Yahoo < Base
+    include REXML
+    # Requires a Y! Application ID
+    # http://developer.yahoo.net/faq/index.html#appid
+    def initialize appid
+      @appid = appid
+    end
+
+    private
+
+    # return array of results
+    def parse xml
+      # Create a new REXML::Document object from the raw XML text
+      xml = Document.new xml
+      # 
+      # Normally, Y! will return an XML document with the root node
+      # <ResultSet>; if the request bombs, they return one with the
+      # root node <Error>
+      if is_error? xml
+        msgs = []
+        # Bubble up an exception using the error messages from Y!
+        xml.root.elements.each("Message") { |e| msgs << e.get_text.value }
+        raise GeocodingError, msgs.join(", ")
+      else
+        results = []
+        xml.root.elements.each "Result" do |e|
+          result = Result.new
+          # add fields
+          fields.each do |field|
+            text = e.elements[field.capitalize].get_text
+            if text.respond_to? :value
+              result.send "#{field}=", text.value
+            end
+          end
+          # add attributes
+          attributes.each do |attribute|
+            result.send "#{attribute}=", e.attributes[attribute]
+          end
+          results << result
+        end
+        results
+      end
+    end
+
+    def fields
+      %w| latitude longitude address city state zip country |
+    end
+
+    def attributes
+      %w| precision warning |
+    end
+
+    def is_error? document
+      document.root.name == "Error"
+    end
+
+    # Returns URL of Y! Geocoding web service
+    def url location
+      "http://api.local.yahoo.com/MapsService/V1/geocode?appid=#{@appid}&location=#{CGI.escape location}"
+    end
+  end
+
+  SERVICES = { :yahoo => Yahoo,
+               :geocoderus => GeoCoderUs }.freeze
+
+  class Result < Struct.new :latitude, :longitude, :address, :city,
+                            :state, :zip, :country, :precision,
+                            :warning
+    alias :lat :latitude
+    alias :lng :longitude
+  end
+
+  # A Response is a representation of the entire response from the
+  # Y! Geocoding web service, which may include multiple results,
+  # as well as warnings and errors
+  class Response < Array
+    def initialize results
+      results.each do |result|
+        self << result
+      end
+    end
+
+    # Geocoding was an unqualified success if one result in the result 
+    # set is retured and there is no warning attribute in that result
+    def success?
+      size == 1 and self[0].warning.nil?
+    end
+
+    def bullseye?
+      success?
+    end
+
+    # Returns latitude in degrees decimal
+    def latitude
+      self[0].latitude if bullseye?
+    end
+
+    # Returns longitude in degrees decimal
+    def longitude
+      self[0].longitude if bullseye?
+    end
+
+    # Returns normalized street address, capitalized
+    def address
+      self[0].address if bullseye?
+    end
+
+    # Returns normalized city name, capitalized
+    def city
+      self[0].city if bullseye?
+    end
+
+    # Returns normalized two-letter USPS state abbreviation
+    def state
+      self[0].state if bullseye?
+    end
+
+    alias_method :array_zip, :zip
+   
+    # Returns normalized ZIP Code, or postal code
+    def zip
+      self[0].zip if bullseye?
+    end
+
+    # Returns two-letter country code abbreviation
+    def country
+      self[0].country if bullseye?
+    end
+
+    alias :lat :latitude
+    alias :lng :longitude
+  end
+
+  class Cli
+    require 'optparse'
+    require 'ostruct'
+
+    def self.parse args
+      options = OpenStruct.new
+      # default values
+      options.appid = "YahooDemo"
+      options.service = Yahoo
+      options.timeout = 5
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: geocode [options] location"
+        opts.separator ""
+        opts.separator "Options:"
+        opts.on "-a appid", "--appid appid", "Yahoo! Application ID" do |a|
+          options.appid = a
+        end
+        opts.on "-s service", "--service service", "`yahoo' or `geocoderus'" do |s|
+          options.service = SERVICES[s]
+        end
+        opts.on "-t secs", "--timeout secs", Integer, "Timeout in seconds" do |t|
+          options.timeout = t
+        end
+        opts.on "-q", "--quiet", "Quiet output" do |q|
+          options.quiet = q
+        end
+        opts.on_tail "-h", "--help", "Show this message" do
+          puts opts
+          exit
+        end
+        opts.parse! args
+      end
+      [options, opts]
+    end
+
+    def initialize cli_args
+      @options, @opt_parser = Cli::parse cli_args
+      @location = cli_args.join " "
+    end
+
+    def report result
+      buffer = []
+      if @options.quiet
+        result.each do |r|
+          buffer << FIELDS.collect do |k,v|
+            r.send k
+          end.join(",")
+        end
+      else
+        buffer << "Found #{result.size} result(s)."
+        buffer << buffer.last.gsub(/./, "-")
+        buffer << result.collect do |r|
+          FIELDS.collect do |k,v|
+            "#{v}: #{r.send k}"
+          end.join("\n")
+        end.join("\n- - - -\n")
+      end
+      puts buffer.join("\n")
+    end
+
+    def go!
+      g = @options.service.new @options.appid
+      begin
+        result = g.geocode @location, :timeout => @options.timeout
+        report result
+      rescue BlankLocationString
+        STDERR.puts "You have to give an address to geocode!"
+        puts
+        puts @opt_parser
+        exit
+      rescue Timeout::Error
+        STDERR.puts "The remote geocoding service timed-out. Try increasing the timeout value (-t)."
+        exit
+      rescue Geocoder::GeocodingError => e
+        STDERR.puts "Geocoder: #{e}"
+        exit
+      end
+    end
+  end
+end

data/test/mocks/csv?address=2038+damen+ave+chicago+il

@@ -0,0 +1,2 @@
+41.854436,-87.675853,2038 S Damen Ave,Chicago,IL,60608
+41.918850,-87.677800,2038 N Damen Ave,Chicago,IL,60647

data/test/mocks/csv?address=2125+w+north+ave+chicago+il

@@ -0,0 +1 @@
+41.910408,-87.680592,2125 W North Ave,Chicago,IL,60647

data/test/mocks/csv?address=donotleaveitisnotreal

@@ -0,0 +1 @@
+2: couldn't find this address! sorry

data/test/mocks/geocode?appid=YahooDemo&location=

@@ -0,0 +1,4 @@
+<?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 Fri Feb  3 16:08:33 PST 2006 -->

data/test/mocks/geocode?appid=YahooDemo&location=2038+damen+ave+chicago+il

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?><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: 2038 S Damen Ave, Chicago, IL 60608"><Latitude>41.854524</Latitude><Longitude>-87.676083</Longitude><Address>2038 S DAMEN AVE</Address><City>CHICAGO</City><State>IL</State><Zip>60608-2625</Zip><Country>US</Country></Result><Result precision="address" warning="The exact location could not be found, here is the closest match: 2038 N Damen Ave, Chicago, IL 60647"><Latitude>41.918759</Latitude><Longitude>-87.67763</Longitude><Address>2038 N DAMEN AVE</Address><City>CHICAGO</City><State>IL</State><Zip>60647-4564</Zip><Country>US</Country></Result></ResultSet>
+<!-- ws01.search.scd.yahoo.com uncompressed Fri Feb  3 14:49:21 PST 2006 -->

data/test/mocks/geocode?appid=YahooDemo&location=2125+w+north+ave+chicago+il

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?><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"><Latitude>41.910263</Latitude><Longitude>-87.680696</Longitude><Address>2125 W NORTH AVE</Address><City>CHICAGO</City><State>IL</State><Zip>60647-5415</Zip><Country>US</Country></Result></ResultSet>
+<!-- ws01.search.scd.yahoo.com uncompressed Fri Feb  3 14:49:43 PST 2006 -->

data/test/mocks/geocode?appid=YahooDemo&location=donotleaveitisnotreal

@@ -0,0 +1,4 @@
+<?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 Tue Feb  7 14:52:36 PST 2006 -->

data/test/mocks/http.rb

@@ -0,0 +1,19 @@
+require 'net/http'
+
+module Net
+  class HTTP
+    alias_method :old_get, :get
+    def get(path, *args)
+      begin
+        filename = File.dirname(__FILE__) + "/" + File.basename(path)
+        return File.open(filename)
+      rescue Errno::ENOENT
+        old_get(path, *args)
+      end
+    end
+  end
+end
+
+class File
+  alias_method :body, :read
+end

data/test/sample.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?><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"><Latitude>41.910263</Latitude><Longitude>-87.680696</Longitude><Address>2125 W NORTH AVE</Address><City>CHICAGO</City><State>IL</State><Zip>60647-5415</Zip><Country>US</Country></Result></ResultSet>
+<!-- ws02.search.re2.yahoo.com uncompressed Wed Jan 25 14:06:31 PST 2006 -->

data/test/tc_geocoderus.rb

@@ -0,0 +1,105 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/geocoder'
+require File.dirname(__FILE__) + '/mocks/http'
+
+class TC_GeoCoderUsSuccess < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = GeoCoderUs.new
+    @response = @geocoder.geocode "2125 w north ave chicago il"
+  end
+
+  def test_success
+    assert_equal true, @response.success?
+  end
+
+  def test_latitude
+    assert_in_delta 41.910408, @response.latitude, 0.0005
+  end
+
+  def test_longitude
+    assert_in_delta -87.680592, @response.longitude, 0.0005
+  end
+
+  def test_address
+    assert_equal "2125 W North Ave", @response.address
+  end
+
+  def test_city
+    assert_equal "Chicago", @response.city
+  end
+
+  def test_state
+    assert_equal "IL", @response.state
+  end
+
+  def test_zip
+    assert_equal "60647", @response.zip
+  end
+
+  def test_lat
+    assert_respond_to @response, :lat
+    assert_same @response.lat, @response.latitude
+  end
+
+  def test_lng
+    assert_respond_to @response, :lng
+    assert_same @response.lng, @response.lng
+  end
+end
+
+class TC_GeoCoderUsAmbiguous < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = GeoCoderUs.new
+    @response = @geocoder.geocode "2038 damen ave chicago il"
+  end
+
+  def test_success
+    assert_equal false, @response.success?
+  end
+
+  def test_matches
+    assert_equal 2, @response.size
+  end
+
+  def test_warning
+    @response.each do |result|
+      assert_nil result.warning
+    end
+  end
+
+  def test_precision
+    @response.each do |result|
+      assert_nil result.precision
+    end
+  end
+end
+
+class TC_GeoCoderUsExceptions < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = GeoCoderUs.new
+  end
+
+  def test_throws_on_nil
+    assert_raise(Geocoder::BlankLocationString) {
+      @geocoder.geocode nil
+    }
+  end
+  
+  def test_throws_on_empty_string
+    assert_raise(Geocoder::BlankLocationString) {
+      @geocoder.geocode ""
+    }
+  end
+
+  def test_throws_on_ungeocodeable
+    assert_raise(Geocoder::GeocodingError) {
+      @geocoder.geocode "donotleaveitisnotreal"
+    }
+  end
+end

data/test/tc_yahoo.rb

@@ -0,0 +1,110 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/geocoder'
+require File.dirname(__FILE__) + '/mocks/http'
+
+class TC_YahooGeocoderSuccess < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = Yahoo.new "YahooDemo"
+    @response = @geocoder.geocode "2125 w north ave chicago il"
+  end
+
+  def test_success
+    assert_equal true, @response.success?
+  end
+
+  def test_latitude
+    assert_in_delta 41.910263, @response.latitude, 0.0005
+  end
+
+  def test_longitude
+    assert_in_delta -87.680696, @response.longitude, 0.0005
+  end
+
+  def test_address
+    assert_equal "2125 W NORTH AVE", @response.address
+  end
+
+  def test_city
+    assert_equal "CHICAGO", @response.city
+  end
+
+  def test_state
+    assert_equal "IL", @response.state
+  end
+
+  def test_zip
+    assert_equal "60647-5415", @response.zip
+  end
+
+  def test_country
+    assert_equal "US", @response.country
+  end
+
+  def test_lat
+    assert_respond_to @response, :lat
+    assert_same @response.lat, @response.latitude
+  end
+
+  def test_lng
+    assert_respond_to @response, :lng
+    assert_same @response.lng, @response.lng
+  end
+end
+
+class TC_YahooGeocoderAmbiguous < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = Yahoo.new "YahooDemo"
+    @response = @geocoder.geocode "2038 damen ave chicago il"
+  end
+
+  def test_success
+    assert_equal false, @response.success?
+  end
+
+  def test_matches
+    assert_equal 2, @response.size
+  end
+
+  def test_warning
+    @response.each do |result|
+      assert_match %r{^The exact location could not be found, here is the closest match:},
+        result.warning
+    end
+  end
+
+  def test_precision
+    @response.each do |result|
+      assert_equal "address", result.precision
+    end
+  end
+end
+
+class TC_YahooGeocoderExceptions < Test::Unit::TestCase
+  include Geocoder
+
+  def setup
+    @geocoder = Yahoo.new "YahooDemo"
+  end
+
+  def test_throws_on_nil
+    assert_raise(Geocoder::BlankLocationString) {
+      @geocoder.geocode nil
+    }
+  end
+  
+  def test_throws_on_empty_string
+    assert_raise(Geocoder::BlankLocationString) {
+      @geocoder.geocode ""
+    }
+  end
+  
+  def test_throws_on_ungeocodeable
+    assert_raise(Geocoder::GeocodingError) {
+      @geocoder.geocode "donotleaveitisnotreal"
+    }
+  end
+end

data/test/ts_geocoder.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+%w{ tc_yahoo tc_geocoderus }.each { |tc|
+  require File.dirname(__FILE__) + "/#{tc}"
+}

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: geocoder
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-02-08 00:00:00 -06:00
+summary: Geocoding library and CLI.
+require_paths: 
+- lib
+email: paul@cnt.org
+homepage: http://geocoder.rubyforge.org
+rubyforge_project: geocoder
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Paul Smith
+files: 
+- lib/geocoder.rb
+- bin/geocode
+- CHANGELOG
+- LICENSE
+- Rakefile
+- README
+- TODO
+- test/mocks
+- test/sample.xml
+- test/tc_geocoderus.rb
+- test/tc_yahoo.rb
+- test/ts_geocoder.rb
+- test/mocks/csv?address=2038+damen+ave+chicago+il
+- test/mocks/csv?address=2125+w+north+ave+chicago+il
+- test/mocks/csv?address=donotleaveitisnotreal
+- test/mocks/geocode?appid=YahooDemo&location=
+- test/mocks/geocode?appid=YahooDemo&location=2038+damen+ave+chicago+il
+- test/mocks/geocode?appid=YahooDemo&location=2125+w+north+ave+chicago+il
+- test/mocks/geocode?appid=YahooDemo&location=donotleaveitisnotreal
+- test/mocks/http.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- geocode
+extensions: []
+
+requirements: 
+- none
+dependencies: []
+