graticule 0.2.2 → 0.2.3

data/CHANGELOG.txt

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

data/Manifest.txt

@@ -12,6 +12,7 @@ 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
@@ -24,11 +25,16 @@ 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/partial.xml
 test/fixtures/responses/google/server_error.xml
 test/fixtures/responses/google/success.xml
 test/fixtures/responses/google/unavailable.xml
@@ -36,6 +42,8 @@ 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
@@ -59,3 +67,4 @@ 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/Rakefile

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'active_support'
 require 'hoe'
 require File.join(File.dirname(__FILE__), 'lib', 'graticule', 'version.rb')
 
@@ -15,3 +16,71 @@ Hoe.new("graticule", Graticule::Version::STRING) do |p|
   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/lib/graticule.rb

@@ -2,8 +2,10 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'active_support'
 
+require 'graticule/version'
 require 'graticule/location'
 require 'graticule/geocoder'
+require 'graticule/geocoder/base'
 require 'graticule/geocoder/bogus'
 require 'graticule/geocoder/rest'
 require 'graticule/geocoder/google'

data/lib/graticule/cli.rb

@@ -20,7 +20,7 @@ module Graticule
   #     -h, --help                       Help
   class Cli
     
-    def self.start(args)
+    def self.start(args, out = STDOUT)
       options = { :service => :yahoo, :api_key => 'YahooDemo' }
       
       OptionParser.new do |opts|
@@ -42,12 +42,14 @@ module Graticule
 
       options[:location] = args.join(" ")
       
-      result = Graticule.service(options[:service]).new(options[:api_key]).locate(options[:location])
+      result = Graticule.service(options[:service]).new(*options[:api_key].split(',')).locate(options[:location])
       location = (result.is_a?(Array) ? result.first : result)
       if location
-        puts location.to_s(:coordinates => true)
+        out << location.to_s(:coordinates => true)
+        exit 0
       else
-        puts "Location not found"
+        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. "

data/lib/graticule/geocoder/base.rb

@@ -0,0 +1,112 @@
+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_response(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(params = {})
+        response = prepare_response(make_url(params).open('User-Agent' => USER_AGENT).read)
+        check_error(response)
+        return parse_response(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 results from +response+ into a Location.
+      def parse_response(response)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/graticule/geocoder/geocoder_us.rb

@@ -39,7 +39,7 @@ module Graticule #:nodoc:
       end
 
       def check_error(xml) #:nodoc:
-        raise AddressError, xml.text if xml.text == 'couldn\'t find this address! sorry'
+        raise AddressError, xml.text if xml.text =~ /couldn't find this address! sorry/
       end
 
     end

data/lib/graticule/geocoder/google.rb

@@ -51,11 +51,11 @@ module Graticule #:nodoc:
         longitude, latitude, = xml.elements['/kml/Response/Placemark/Point/coordinates'].text.split(',').map { |v| v.to_f }
       
         Location.new \
-          :street => value(address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/Thoroughfare/ThoroughfareName/text()']),
-          :locality => value(address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/LocalityName/text()']),
-          :region => value(address.elements['Country/AdministrativeArea/AdministrativeAreaName/text()']),
-          :postal_code => value(address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/PostalCode/PostalCodeNumber/text()']),
-          :country => value(address.elements['Country/CountryNameCode/text()']),
+          :street => value(address.elements['//ThoroughfareName/text()']),
+          :locality => value(address.elements['//LocalityName/text()']),
+          :region => value(address.elements['//AdministrativeAreaName/text()']),
+          :postal_code => value(address.elements['//PostalCodeNumber/text()']),
+          :country => value(address.elements['//CountryNameCode/text()']),
           :latitude => latitude,
           :longitude => longitude,
           :precision => PRECISION[address.attribute('Accuracy').value.to_i] || :unknown

data/lib/graticule/geocoder/host_ip.rb

@@ -3,7 +3,7 @@ require 'yaml'
 module Graticule #:nodoc:
   module Geocoder #:nodoc:
 
-    class HostIp
+    class HostIp < Base
 
       def initialize
         @url = URI.parse 'http://api.hostip.info/get_html.php'
@@ -11,15 +11,15 @@ module Graticule #:nodoc:
 
       # Geocode an IP address using http://hostip.info
       def locate(address)
-        make_url(:ip => address, :position => true).open do |response|
-          # add new line so YAML.load doesn't puke
-          result = response.read + "\n"
-          check_error(result)
-          parse_response(YAML.load(result))
-        end
+        get :ip => address, :position => true
       end
     
     private
+    
+      def read_response(response)
+        # add new line so YAML.load doesn't puke
+        YAML.load(response + "\n")
+      end
       
       def parse_response(response) #:nodoc:
         returning Location.new do |location|
@@ -32,19 +32,10 @@ module Graticule #:nodoc:
       end
 
       def check_error(response) #:nodoc:
-        raise AddressError, 'Unknown' if response =~ /Unknown City/
-        raise AddressError, 'Private Address' if response =~ /Private Address/
+        raise AddressError, 'Unknown' if response['City'] =~ /Unknown City/
+        raise AddressError, 'Private Address' if response['City'] =~ /Private Address/
       end
 
-      def make_url(params) #:nodoc:
-        returning @url.dup do |url|
-          url.query = params.map do |k,v| 
-            "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
-          end.join('&')
-        end
-      end
-
-
     end
   end
 end

data/lib/graticule/geocoder/local_search_maps.rb

@@ -4,7 +4,7 @@ module Graticule #:nodoc:
     # A library for lookup of coordinates with http://geo.localsearchmaps.com/
     #
     # See http://emad.fano.us/blog/?p=277
-    class LocalSearchMaps < Rest
+    class LocalSearchMaps < Base
     
       def initialize
         @url = URI.parse 'http://geo.localsearchmaps.com/'
@@ -28,13 +28,13 @@ module Graticule #:nodoc:
       end
     
       def check_error(js)
-        raise AddressError, "Empty Response" if js.nil? or js.text.nil?
-        raise AddressError, 'Location not found' if js.text =~ /location not found/
+        raise AddressError, "Empty Response" if js.nil?
+        raise AddressError, 'Location not found' if js =~ /location not found/
       end
     
       def parse_response(js)
         returning Location.new do |location|
-          coordinates = js.text.match(/map.centerAndZoom\(new GPoint\((.+?), (.+?)\)/)
+          coordinates = js.match(/map.centerAndZoom\(new GPoint\((.+?), (.+?)\)/)
           location.longitude = coordinates[1].to_f
           location.latitude = coordinates[2].to_f
         end

data/lib/graticule/geocoder/meta_carta.rb

@@ -13,7 +13,7 @@ module Graticule
 
       # Finds +location+ and returns a Location object.
       def locate(location)
-        get :q => location.is_a?(String) ? location : location_from_params(location).to_s
+        get :q => location.is_a?(String) ? location : location_from_params(location).to_s, :output => 'locations'
       end
       
     private
@@ -22,11 +22,6 @@ module Graticule
         raise AddressError, 'bad location' unless xml.elements['Locations/Location']
       end
 
-      def make_url(params) # :nodoc:
-        params[:output] = 'locations'
-        super params
-      end
-
       def parse_response(xml) # :nodoc:
         result = xml.elements['/Locations/Location[1]']
         coords = result.elements['Centroid/gml:Point/gml:coordinates'].text.split ','

data/lib/graticule/geocoder/rest.rb

@@ -1,110 +1,18 @@
-require 'open-uri'
 require 'rexml/document'
 
 module Graticule #:nodoc:
   module Geocoder #:nodoc:
 
-    # Abstract class for implementing REST APIs.
-    #
-    # === 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.
-    #
-    # If you have extra URL paramaters (application id, output type) or need to
-    # perform URL customization, override +make_url+.
-    #
-    #   class FakeService < RCRest
-    #   
-    #     class Error < RCRest::Error; end
-    #   
-    #     def initialize(appid)
-    #       @appid = appid
-    #       @url = URI.parse 'http://example.com/test'
-    #     end
-    #   
-    #     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_response(xml)
-    #       # return Location
-    #     end
-    #   
-    #     def test(query)
-    #       get :q => query
-    #     end
-    #   
-    #   end
-    class Rest
+    # Abstract class for implementing REST geocoders. Passes on a REXML::Document
+    # to +check_errors+ and +parse_response+.
+    class Rest < Base
 
-      # Web services initializer.
-      #
-      # Concrete web services implementations must set the +url+ instance
-      # variable which must be a URI.
-      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
-
-      # Must extract and raise an error from +xml+, an REXML::Document, if any.
-      # Must returns if no error could be found.
-      def check_error(xml)
-        raise NotImplementedError
-      end
-
-      # Performs a GET request with +params+.  Calls the parse_response method on
-      # the concrete class with an REXML::Document instance and returns its
-      # result.
-      def get(params = {})
-        url = make_url params
-
-        url.open do |response|
-          res = REXML::Document.new response.read
-          check_error(res)
-          return parse_response(res)
-        end
-      rescue OpenURI::HTTPError => e
-        response = REXML::Document.new e.io.read
-        check_error response
-        raise
+      def prepare_response(response)
+        REXML::Document.new(response)
       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
-
-      # Must parse results from +xml+, an REXML::Document, into a Location.
-      def parse_response(xml)
-        raise NotImplementedError
-      end
-
+      
     end
   end
 end