norman-graticule 0.2.7

data/CHANGELOG.txt

@@ -0,0 +1,46 @@
+0.2.7
+* Added MapQuest geocoder [Andrew Selder]
+* Fix google geocoder for responses that only return coordinates [Andrew Selder]
+
+0.2.5
+* fixed address mapping for local search maps (again)
+
+0.2.4 (2007-05-15)
+* fixed address mapping for local search maps (Tom Taylor)
+
+0.2.3 (2007-04-27)
+* fixed Google for less precise queries
+* added User-Agent to coerce Google into returning UTF-8 (Jonathan Tron)
+
+0.2.2 (2007-03-27)
+* fixed LocalSearchMaps
+
+0.2.1 (2007-03-19)
+* fixed error in command line interface
+
+0.2.0 (2007-03-17)
+* changed city to locality, state to region, and zip to postal_code
+* added support for PostcodeAnywhere
+* added support for Local Search Maps (James Stewart)
+* added IP-based geocoder
+* moved geocoders to Graticule::Geocoder namespace
+* fixed Google geocoder (again)
+* made Yahoo geocoder consistent with others by returning 1 result
+* geocoders can how take a Hash (:street, :locality, :region, :postal_code, :country)
+  or a Graticule::Location for the #locate call
+
+0.1.3 (2007-02-14)
+* fixed Google geocoder
+* fixed CLI
+
+0.1.2 (2007-02-12)
+* added "geocode" executable. See "geocode --help" for more information
+* declared dependency on ActiveSupport
+
+0.1.1 (2006-12-16)
+* fixed bug in Yahoo that raised error when street address not returned
+* migrated to Hoe (http://seattlerb.rubyforge.org/hoe/)
+* added Haversine, Spherical and Vincenty distance calculations
+
+0.1 (2006-10-31)
+* Initial release

data/LICENSE.txt

@@ -0,0 +1,30 @@
+Copyright 2006 Brandon Keepers, Collective Idea.  All rights reserved.
+
+Original geocoding code:
+  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,73 @@
+CHANGELOG.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/geocode
+init.rb
+lib/graticule.rb
+lib/graticule/cli.rb
+lib/graticule/distance.rb
+lib/graticule/distance/haversine.rb
+lib/graticule/distance/spherical.rb
+lib/graticule/distance/vincenty.rb
+lib/graticule/geocoder.rb
+lib/graticule/geocoder/base.rb
+lib/graticule/geocoder/bogus.rb
+lib/graticule/geocoder/geocoder_ca.rb
+lib/graticule/geocoder/geocoder_us.rb
+lib/graticule/geocoder/google.rb
+lib/graticule/geocoder/host_ip.rb
+lib/graticule/geocoder/local_search_maps.rb
+lib/graticule/geocoder/map_quest.rb
+lib/graticule/geocoder/meta_carta.rb
+lib/graticule/geocoder/multi.rb
+lib/graticule/geocoder/postcode_anywhere.rb
+lib/graticule/geocoder/rest.rb
+lib/graticule/geocoder/yahoo.rb
+lib/graticule/location.rb
+lib/graticule/version.rb
+site/index.html
+site/plugin.html
+site/stylesheets/style.css
+test/config.yml.default
+test/fixtures/responses/geocoder_us/success.xml
+test/fixtures/responses/geocoder_us/unknown.xml
+test/fixtures/responses/google/badkey.xml
+test/fixtures/responses/google/limit.xml
+test/fixtures/responses/google/missing_address.xml
+test/fixtures/responses/google/only_coordinates.xml
+test/fixtures/responses/google/partial.xml
+test/fixtures/responses/google/server_error.xml
+test/fixtures/responses/google/success.xml
+test/fixtures/responses/google/unavailable.xml
+test/fixtures/responses/google/unknown_address.xml
+test/fixtures/responses/host_ip/private.txt
+test/fixtures/responses/host_ip/success.txt
+test/fixtures/responses/host_ip/unknown.txt
+test/fixtures/responses/local_search_maps/empty.txt
+test/fixtures/responses/local_search_maps/not_found.txt
+test/fixtures/responses/local_search_maps/success.txt
+test/fixtures/responses/meta_carta/bad_address.xml
+test/fixtures/responses/meta_carta/multiple.xml
+test/fixtures/responses/meta_carta/success.xml
+test/fixtures/responses/postcode_anywhere/badkey.xml
+test/fixtures/responses/postcode_anywhere/canada.xml
+test/fixtures/responses/postcode_anywhere/empty.xml
+test/fixtures/responses/postcode_anywhere/success.xml
+test/fixtures/responses/postcode_anywhere/uk.xml
+test/fixtures/responses/yahoo/success.xml
+test/fixtures/responses/yahoo/unknown_address.xml
+test/mocks/uri.rb
+test/test_helper.rb
+test/unit/graticule/distance_test.rb
+test/unit/graticule/geocoder/geocoder_us_test.rb
+test/unit/graticule/geocoder/google_test.rb
+test/unit/graticule/geocoder/host_ip_test.rb
+test/unit/graticule/geocoder/local_search_maps_test.rb
+test/unit/graticule/geocoder/meta_carta_test.rb
+test/unit/graticule/geocoder/multi_test.rb
+test/unit/graticule/geocoder/postcode_anywhere_test.rb
+test/unit/graticule/geocoder/yahoo_test.rb
+test/unit/graticule/geocoder_test.rb
+test/unit/graticule/location_test.rb

data/README.txt

@@ -0,0 +1,29 @@
+= Graticule
+
+Graticule is a geocoding API for looking up address coordinates.  It supports many popular APIs, including Yahoo, Google, Geocoder.ca, Geocoder.us, PostcodeAnywhere and MetaCarta.
+
+= Usage
+
+  require 'rubygems'
+  require 'graticule'
+  geocoder = Graticule.service(:google).new "api_key"
+  location = geocoder.locate "61 East 9th Street, Holland, MI"
+
+= Distance Calculation
+
+Graticule includes 3 different distance formulas, Spherical (simplest but least accurate), Vincenty (most accurate and most complicated), and Haversine (somewhere inbetween).
+
+  geocoder.locate("Holland, MI").distance_to(geocoder.locate("Chicago, IL"))
+  #=> 101.997458788177
+  
+= Command Line
+
+Graticule includes a command line interface (CLI).
+
+  $ geocode -s yahoo -a yahookey Washington, DC
+  Washington, DC US
+  latitude: 38.895222, longitude: -77.036758
+
+= Source
+
+The source code for Graticule is available at http://source.collectiveidea.com/public/geocode/trunk

data/Rakefile

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'active_support'
+require 'hoe'
+require File.join(File.dirname(__FILE__), 'lib', 'graticule', 'version.rb')
+
+Hoe.new("graticule", Graticule::Version::STRING) do |p|
+  p.rubyforge_name = "graticule"
+  p.author = 'Brandon Keepers'
+  p.email = 'brandon@opensoul.org'
+  p.summary = "API for using all the popular geocoding services."
+  p.description = 'Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.'
+  p.url = 'http://graticule.rubyforge.org'
+  p.need_tar = true
+  p.need_zip = true
+  p.test_globs = ['test/**/*_test.rb']
+  p.changes = p.paragraphs_of('CHANGELOG.txt', 0..1).join("\n\n")
+  p.extra_deps << ['activesupport']
+end
+
+
+
+namespace :test do
+  namespace :cache do
+    desc 'Cache test responses from all the free geocoders'
+    task :free => [:google, :geocoder_us, :host_ip, :local_search_maps, :meta_carta, :yahoo]
+    
+    desc 'Cache test responses from Google'
+    task :google do
+      cache_responses('google')
+    end
+    
+    desc 'Cache test responses from Geocoder.us'
+    task :geocoder_us do
+      cache_responses('geocoder_us')
+    end
+    
+    desc 'Cache test responses from HostIP'
+    task :host_ip do
+      cache_responses('host_ip')
+    end
+
+    desc 'Cache test responses from Local Search Maps'
+    task :local_search_maps do
+      cache_responses('local_search_maps')
+    end
+
+    desc 'Cache test responses from Meta Carta'
+    task :meta_carta do
+      cache_responses('meta_carta')
+    end
+
+    desc 'Cache test responses from Yahoo'
+    task :yahoo do
+      cache_responses('yahoo')
+    end
+
+  end
+end
+
+require 'net/http'
+require 'uri'
+RESPONSES_PATH = File.dirname(__FILE__) + '/test/fixtures/responses'
+
+def cache_responses(service)
+  test_config[service.to_s]['responses'].each do |file,url|
+    File.open("#{RESPONSES_PATH}/#{service}/#{file}", 'w') do |f|
+      f.puts Net::HTTP.get(URI.parse(url))
+    end
+  end
+end
+
+def test_config
+  file = File.dirname(__FILE__) + '/test/config.yml'
+  raise "Copy config.yml.default to config.yml and set the API keys" unless File.exists?(file)
+  @test_config ||= returning(YAML.load(File.read(file))) do |config|
+    config.each do |service,values|
+      values['responses'].each {|file,url| update_placeholders!(values, url) }
+    end
+  end
+end
+
+def update_placeholders!(config, thing)
+  config.each do |option, value|
+    thing.gsub!(":#{option}", value) if value.is_a?(String)
+  end
+end

data/bin/geocode

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'graticule/cli'
+
+Graticule::Cli.start ARGV

data/init.rb

@@ -0,0 +1,2 @@
+
+require 'graticule'

data/lib/graticule/cli.rb

@@ -0,0 +1,64 @@
+require 'graticule'
+require 'optparse'
+
+module Graticule
+  
+  # A command line interface for geocoding.  From the command line, run:
+  #
+  #   geocode 49423 
+  #
+  # Outputs:
+  #
+  #   # Holland, MI 49423 US
+  #   # latitude: 42.7654, longitude: -86.1085
+  #
+  # == Usage: geocode [options] location
+  # 
+  # Options: 
+  #     -s, --service service            Geocoding service
+  #     -a, --apikey apikey              API key for the selected service
+  #     -h, --help                       Help
+  class Cli
+    
+    def self.start(args, out = STDOUT)
+      options = { :service => :yahoo, :api_key => 'YahooDemo' }
+      
+      OptionParser.new do |opts|
+        opts.banner = "Usage: geocode [options] location"
+        opts.separator ""
+        opts.separator "Options: "
+
+        opts.on("-s service", %w(yahoo google geocoder_us metacarta), "--service service", "Geocoding service") do |service|
+          options[:service] = service
+        end
+        
+        opts.on("-a apikey", "--apikey apikey", "API key for the selected service")
+        
+        opts.on_tail("-h", "--help", "Help") do
+          puts opts
+          exit
+        end
+      end.parse! args
+
+      options[:location] = args.join(" ")
+      
+      result = Graticule.service(options[:service]).new(*options[:api_key].split(',')).locate(options[:location])
+      location = (result.is_a?(Array) ? result.first : result)
+      if location
+        out << location.to_s(:coordinates => true)
+        exit 0
+      else
+        out << "Location not found"
+        exit 1
+      end
+    rescue Graticule::CredentialsError
+      $stderr.puts "Invalid API key. Pass your #{options[:service]} API key using the -a option. "
+    rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
+        Graticule::Error => error
+      $stderr.puts error.message
+    end
+    
+    
+  end
+end
+

data/lib/graticule/distance/haversine.rb

@@ -0,0 +1,40 @@
+module Graticule
+  module Distance
+    #
+    # The Haversine Formula works better at small distances than the Spherical Law of Cosines
+    #
+    # Thanks to Chris Veness (http://www.movable-type.co.uk/scripts/LatLong.html)
+    # for distance formulas.
+    #
+    class Haversine < DistanceFormula
+      
+      # Calculate the distance between two Locations using the Haversine formula
+      #
+      #   Graticule::Distance::Haversine.distance(
+      #     Graticule::Location.new(:latitude => 42.7654, :longitude => -86.1085),
+      #     Graticule::Location.new(:latitude => 41.849838, :longitude => -87.648193)
+      #   )
+      #   #=> 101.061720831836
+      #
+      def self.distance(from, to, units = :miles)
+        from_longitude  = deg2rad(from.longitude)
+        from_latitude   = deg2rad(from.latitude)
+        to_longitude    = deg2rad(to.longitude)
+        to_latitude     = deg2rad(to.latitude)
+
+        latitude_delta  = to_latitude - from_latitude
+        longitude_delta = to_longitude - from_longitude
+
+        a = sin(latitude_delta/2)**2 + 
+            cos(from_latitude) * 
+            cos(to_latitude) * 
+            sin(longitude_delta/2)**2
+
+        c = 2 * atan2(sqrt(a), sqrt(1-a))
+
+        d = EARTH_RADIUS[units.to_sym] * c
+      end
+
+    end
+  end
+end

data/lib/graticule/distance/spherical.rb

@@ -0,0 +1,52 @@
+module Graticule
+  module Distance
+
+    #
+    # The Spherical Law of Cosines is the simplist though least accurate distance
+    # formula (earth isn't a perfect sphere).
+    #
+    class Spherical < DistanceFormula
+
+      # Calculate the distance between two Locations using the Spherical formula
+      #
+      #   Graticule::Distance::Spherical.distance(
+      #     Graticule::Location.new(:latitude => 42.7654, :longitude => -86.1085),
+      #     Graticule::Location.new(:latitude => 41.849838, :longitude => -87.648193)
+      #   )
+      #   #=> 101.061720831853
+      #
+      def self.distance(from, to, units = :miles)
+        from_longitude   = deg2rad(from.longitude)
+        from_latitude    = deg2rad(from.latitude)
+        to_longitude  = deg2rad(to.longitude)
+        to_latitude   = deg2rad(to.latitude)
+
+        Math.acos(
+            Math.sin(from_latitude) *
+            Math.sin(to_latitude) +
+
+            Math.cos(from_latitude) * 
+            Math.cos(to_latitude) *
+            Math.cos(to_longitude - from_longitude)
+        ) * EARTH_RADIUS[units.to_sym]
+      end
+
+      def self.to_sql(options)
+        options = {
+          :units => :miles,
+          :latitude_column => 'latitude',
+          :longitude_column => 'longitude'
+        }.merge(options)
+        %{(ACOS(
+            SIN(RADIANS(#{options[:latitude]})) *
+            SIN(RADIANS(#{options[:latitude_column]})) +
+            COS(RADIANS(#{options[:latitude]})) *
+            COS(RADIANS(#{options[:latitude_column]})) *
+            COS(RADIANS(#{options[:longitude_column]}) - RADIANS(#{options[:longitude]}))
+          ) * #{Graticule::Distance::EARTH_RADIUS[options[:units].to_sym]})
+        }.gsub("\n", '').squeeze(" ")
+      end
+  
+    end
+  end
+end

data/lib/graticule/distance/vincenty.rb

@@ -0,0 +1,76 @@
+module Graticule
+  module Distance
+
+    #
+    # The Vincenty Formula uses an ellipsoidal model of the earth, which is very accurate.
+    #
+    # Thanks to Chris Veness (http://www.movable-type.co.uk/scripts/LatLongVincenty.html)
+    # for distance formulas.
+    #
+    class Vincenty < DistanceFormula
+
+      # Calculate the distance between two Locations using the Vincenty formula
+      #
+      #   Graticule::Distance::Vincenty.distance(
+      #     Graticule::Location.new(:latitude => 42.7654, :longitude => -86.1085),
+      #     Graticule::Location.new(:latitude => 41.849838, :longitude => -87.648193)
+      #   )
+      #   #=> 101.070118000159
+      #
+      def self.distance(from, to, units = :miles)
+        from_longitude   = deg2rad(from.longitude)
+        from_latitude    = deg2rad(from.latitude)
+        to_longitude  = deg2rad(to.longitude)
+        to_latitude   = deg2rad(to.latitude)
+        
+        earth_major_axis_radius = EARTH_MAJOR_AXIS_RADIUS[units.to_sym]
+        earth_minor_axis_radius = EARTH_MINOR_AXIS_RADIUS[units.to_sym]
+
+        f = (earth_major_axis_radius - earth_minor_axis_radius) / earth_major_axis_radius
+
+        l = to_longitude - from_longitude
+        u1 = atan((1-f) * tan(from_latitude))
+        u2 = atan((1-f) * tan(to_latitude))
+        sin_u1 = sin(u1)
+        cos_u1 = cos(u1)
+        sin_u2 = sin(u2)
+        cos_u2 = cos(u2)
+
+        lambda = l
+        lambda_p = 2 * PI
+        iteration_limit = 20
+        while (lambda-lambda_p).abs > 1e-12 && (iteration_limit -= 1) > 0
+          sin_lambda = sin(lambda)
+          cos_lambda = cos(lambda)
+          sin_sigma = sqrt((cos_u2*sin_lambda) * (cos_u2*sin_lambda) + 
+            (cos_u1*sin_u2-sin_u1*cos_u2*cos_lambda) * (cos_u1*sin_u2-sin_u1*cos_u2*cos_lambda))
+          return 0 if sin_sigma == 0  # co-incident points
+          cos_sigma = sin_u1*sin_u2 + cos_u1*cos_u2*cos_lambda
+          sigma = atan2(sin_sigma, cos_sigma)
+          sin_alpha = cos_u1 * cos_u2 * sin_lambda / sin_sigma
+          cosSqAlpha = 1 - sin_alpha*sin_alpha
+          cos2SigmaM = cos_sigma - 2*sin_u1*sin_u2/cosSqAlpha
+
+          cos2SigmaM = 0 if cos2SigmaM.nan?  # equatorial line: cosSqAlpha=0 (§6)
+
+          c = f/16*cosSqAlpha*(4+f*(4-3*cosSqAlpha))
+          lambda_p = lambda
+          lambda = l + (1-c) * f * sin_alpha *
+            (sigma + c*sin_sigma*(cos2SigmaM+c*cos_sigma*(-1+2*cos2SigmaM*cos2SigmaM)))
+       end
+       # formula failed to converge (happens on antipodal points)
+       # We'll call Haversine formula instead.
+       return Haversine.distance(from, to, units) if iteration_limit == 0 
+
+       uSq = cosSqAlpha * (earth_major_axis_radius**2 - earth_minor_axis_radius**2) / (earth_minor_axis_radius**2)
+       a = 1 + uSq/16384*(4096+uSq*(-768+uSq*(320-175*uSq)))
+       b = uSq/1024 * (256+uSq*(-128+uSq*(74-47*uSq)))
+       delta_sigma = b*sin_sigma*(cos2SigmaM+b/4*(cos_sigma*(-1+2*cos2SigmaM*cos2SigmaM)-
+         b/6*cos2SigmaM*(-3+4*sin_sigma*sin_sigma)*(-3+4*cos2SigmaM*cos2SigmaM)))
+         
+        earth_minor_axis_radius * a * (sigma-delta_sigma)
+      end
+  
+    end
+  end
+end

data/lib/graticule/distance.rb

@@ -0,0 +1,29 @@
+module Graticule
+  module Distance
+    
+    EARTH_RADIUS = { :kilometers => 6378.135, :miles => 3963.1676 }
+    # WGS-84 numbers
+    EARTH_MAJOR_AXIS_RADIUS = { :kilometers => 6378.137, :miles => 3963.19059 }
+    EARTH_MINOR_AXIS_RADIUS = { :kilometers => 6356.7523142, :miles => 3949.90276 }
+
+    class DistanceFormula
+      include Math
+      extend Math
+       
+      def initialize
+        raise NotImplementedError
+      end
+      
+      # Convert from degrees to radians
+      def self.deg2rad(deg)
+      	(deg * PI / 180)
+      end
+
+      # Convert from radians to degrees
+      def self.rad2deg(rad)
+      	(rad * 180 / PI)
+      end
+
+    end
+  end
+end

data/lib/graticule/geocoder/base.rb

@@ -0,0 +1,113 @@
+require 'open-uri'
+
+module Graticule #:nodoc:
+  module Geocoder
+
+    # Abstract class for implementing geocoders.
+    #
+    # === Example
+    #
+    # The following methods must be implemented in sublcasses:
+    #
+    # * +initialize+:: Sets @url to the service enpoint.
+    # * +check_error+:: Checks for errors in the server response.
+    # * +parse_response+:: Extracts information from the server response.
+    #
+    # Optionally, you can also override
+    #
+    # * +prepare_response+:: Convert the string response into a different format
+    #   that gets passed on to +check_error+ and +parse_response+.
+    #
+    # If you have extra URL paramaters (application id, output type) or need to
+    # perform URL customization, override +make_url+.
+    #
+    #   class FakeGeocoder < Base
+    #   
+    #     def initialize(appid)
+    #       @appid = appid
+    #       @url = URI.parse 'http://example.com/test'
+    #     end
+    #
+    #     def locate(query)
+    #       get :q => query
+    #     end
+    #   
+    #   private
+    #   
+    #     def check_error(xml)
+    #       raise Error, xml.elements['error'].text if xml.elements['error']
+    #     end
+    #   
+    #     def make_url(params)
+    #       params[:appid] = @appid
+    #       super params
+    #     end
+    #   
+    #     def parse_first(response)
+    #       # return Location
+    #     end
+    #   
+    #   end
+    #
+    class Base
+      USER_AGENT = "Mozilla/5.0 (compatible; Graticule/#{Graticule::Version::STRING}; http://graticule.rubyforge.org)"
+
+      def initialize
+        raise NotImplementedError
+      end
+      
+    private
+    
+      def location_from_params(params)
+        case params
+        when Location then params
+        when Hash then Location.new params
+        else
+          raise ArgumentError, "Expected a Graticule::Location or a hash with :street, :locality, :region, :postal_code, and :country attributes"
+        end
+      end
+
+      # Check for errors in +response+ and raise appropriate error, if any.
+      # Must return if no error could be found.
+      def check_error(response)
+        raise NotImplementedError
+      end
+
+      # Performs a GET request with +params+. Calls +check_error+ and returns
+      # the result of +parse_response+.
+      def get(*args)
+        params = args.last.is_a?(::Hash) ? args.pop : args
+        response = prepare_response(make_url(params).open('User-Agent' => USER_AGENT).read)
+        check_error(response)
+        parse_response(args.first, response)
+      rescue OpenURI::HTTPError => e
+        check_error(prepare_response(e.io.read))
+        raise
+      end
+
+      # Creates a URI from the Hash +params+.  Override this then call super if
+      # you need to add extra params like an application id or output type.
+      def make_url(params)
+        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
+      
+      # Override to convert the response to something besides a String, which
+      # will get passed to +check_error+ and +parse_response+.
+      def prepare_response(response)
+        response
+      end
+
+      # Must parse :first or :all results from +response+ into a Location.
+      def parse_response(parse_type, response)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/graticule/geocoder/bogus.rb

@@ -0,0 +1,15 @@
+module Graticule #:nodoc:
+  module Geocoder #:nodoc:
+
+    # Bogus geocoder that can be used for test purposes
+    class Bogus
+    
+      # returns a new location with the address set to the original query string
+      def locate(address)
+        Location.new :street => address
+      end
+    
+    end
+
+  end
+end