graticule 0.2.12 → 1.0.0.pre

data/.autotest

@@ -0,0 +1,13 @@
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+
+  at.add_mapping %r%^lib/(.*)\.rb$% do |_, m|
+    at.files_matching %r%^test/#{m[1]}_test.rb$%
+  end
+
+  at.add_mapping(%r%^test/.*\.rb$%) {|filename, _| filename }
+
+  at.add_mapping %r%^test/fixtures/(.*)s.yml% do |_, _|
+    at.files_matching %r%^test/.*\.rb$%
+  end
+end

data/.gitignore

@@ -1,4 +1,5 @@
 test/config.yml
 *.gem
 pkg
-coverage
+coverage
+rdoc

data/CHANGELOG.txt

@@ -1,3 +1,5 @@
+* Added freethepostcode.org geocoder [Chris Lowis]
+
 0.2.12 (2009-09-06)
 * Fixed geocoder_us [Aubrey Holland]
 

data/README.txt

@@ -1,6 +1,6 @@
 = 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.
+Graticule is a geocoding API for looking up address coordinates.  It supports many popular APIs, including Yahoo, Google, Geocoder.ca and Geocoder.us.
 
 = Usage
 
@@ -24,6 +24,10 @@ Graticule includes a command line interface (CLI).
   Washington, DC US
   latitude: 38.895222, longitude: -77.036758
 
+= Mailing List
+
+Join us on the mailing list at http://groups.google.com/group/graticule
+
 = How to contribute
 
 If you find what you might think is a bug:

data/Rakefile

@@ -4,23 +4,26 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
   exit 1
 end
+require 'rubygems'
+require 'activesupport'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rcov/rcovtask'
 
 Jeweler::Tasks.new do |s|
-  s.name = "graticule"
+  s.name              = "graticule"
   s.rubyforge_project = "graticule"
-  s.author = 'Brandon Keepers'
-  s.email = 'brandon@opensoul.org'
-  s.summary = "API for using all the popular geocoding services."
-  s.description = 'Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.'
-  s.homepage = "http://github.com/collectiveidea/graticule"
-  s.add_dependency "activesupport"
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.txt"]
-  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
-  s.test_files = Dir['test/**/*.{yml,rb}']
+  s.author            = 'Brandon Keepers'
+  s.email             = 'brandon@opensoul.org'
+  s.summary           = "API for using all the popular geocoding services."
+  s.description       = 'Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.'
+  s.homepage          = "http://github.com/collectiveidea/graticule"
+  s.add_dependency    "activesupport"
+  s.add_dependency    'happymapper', '>=0.3.0'
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ["README.txt"]
+  s.rdoc_options      = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+  s.test_files        = Dir['test/**/*']
 end
 
 desc 'Default: run unit tests.'
@@ -28,7 +31,7 @@ task :default => :test
 
 desc 'Run the unit tests'
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
+  t.libs << 'lib' << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
@@ -75,44 +78,6 @@ namespace :rubyforge do
   end
 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 'active_support'
 require 'net/http'
 require 'uri'
@@ -140,4 +105,19 @@ def update_placeholders!(config, thing)
   config.each do |option, value|
     thing.gsub!(":#{option}", value) if value.is_a?(String)
   end
-end
+end
+
+namespace :test do
+  namespace :cache do
+    desc 'Cache test responses from all the geocoders'
+    task :all => test_config.keys
+
+    test_config.keys.each do |service|
+      desc "Cache test responses for #{service}"
+      task service do
+        cache_responses(service)
+      end
+    end
+  end
+end
+

data/VERSION

@@ -1 +1 @@
-0.2.12
+1.0.0.pre

data/graticule.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{graticule}
-  s.version = "0.2.12"
+  s.version = "1.0.0.pre"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Keepers"]
-  s.date = %q{2009-09-06}
+  s.date = %q{2009-12-05}
   s.default_executable = %q{geocode}
   s.description = %q{Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.}
   s.email = %q{brandon@opensoul.org}
@@ -18,10 +18,10 @@ Gem::Specification.new do |s|
     "README.txt"
   ]
   s.files = [
-    ".gitignore",
+    ".autotest",
+     ".gitignore",
      "CHANGELOG.txt",
      "LICENSE.txt",
-     "Manifest.txt",
      "README.txt",
      "Rakefile",
      "VERSION",
@@ -38,26 +38,30 @@ Gem::Specification.new do |s|
      "lib/graticule/geocoder.rb",
      "lib/graticule/geocoder/base.rb",
      "lib/graticule/geocoder/bogus.rb",
+     "lib/graticule/geocoder/freethepostcode.rb",
      "lib/graticule/geocoder/geocoder_ca.rb",
      "lib/graticule/geocoder/geocoder_us.rb",
+     "lib/graticule/geocoder/geonames.rb",
      "lib/graticule/geocoder/google.rb",
      "lib/graticule/geocoder/host_ip.rb",
      "lib/graticule/geocoder/local_search_maps.rb",
      "lib/graticule/geocoder/mapquest.rb",
-     "lib/graticule/geocoder/meta_carta.rb",
      "lib/graticule/geocoder/multi.rb",
      "lib/graticule/geocoder/multimap.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/freethepostcode/not_found.txt",
+     "test/fixtures/responses/freethepostcode/success.txt",
+     "test/fixtures/responses/geocoder_ca/success.xml",
      "test/fixtures/responses/geocoder_us/success.xml",
      "test/fixtures/responses/geocoder_us/unknown.xml",
+     "test/fixtures/responses/geonames/missing.xml",
+     "test/fixtures/responses/geonames/success.xml",
+     "test/fixtures/responses/geonames/unknown.xml",
      "test/fixtures/responses/google/badkey.xml",
      "test/fixtures/responses/google/limit.xml",
      "test/fixtures/responses/google/missing_address.xml",
@@ -76,72 +80,117 @@ Gem::Specification.new do |s|
      "test/fixtures/responses/local_search_maps/success.txt",
      "test/fixtures/responses/mapquest/multi_result.xml",
      "test/fixtures/responses/mapquest/success.xml",
-     "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/multimap/missing_params.xml",
      "test/fixtures/responses/multimap/no_matches.xml",
      "test/fixtures/responses/multimap/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/graticule/distance_test.rb",
+     "test/graticule/geocoder/freethepostcode_test.rb",
+     "test/graticule/geocoder/geocoder_ca_test.rb",
+     "test/graticule/geocoder/geocoder_us_test.rb",
+     "test/graticule/geocoder/geocoders.rb",
+     "test/graticule/geocoder/geonames_test.rb",
+     "test/graticule/geocoder/google_test.rb",
+     "test/graticule/geocoder/host_ip_test.rb",
+     "test/graticule/geocoder/local_search_maps_test.rb",
+     "test/graticule/geocoder/mapquest_test.rb",
+     "test/graticule/geocoder/multi_test.rb",
+     "test/graticule/geocoder/multimap_test.rb",
+     "test/graticule/geocoder/yahoo_test.rb",
+     "test/graticule/geocoder_test.rb",
+     "test/graticule/location_test.rb",
      "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/geocoders.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/mapquest_test.rb",
-     "test/unit/graticule/geocoder/meta_carta_test.rb",
-     "test/unit/graticule/geocoder/multi_test.rb",
-     "test/unit/graticule/geocoder/multimap_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"
+     "test/test_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/collectiveidea/graticule}
   s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{graticule}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{API for using all the popular geocoding services.}
   s.test_files = [
-    "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/geocoders.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/mapquest_test.rb",
-     "test/unit/graticule/geocoder/meta_carta_test.rb",
-     "test/unit/graticule/geocoder/multi_test.rb",
-     "test/unit/graticule/geocoder/multimap_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"
+    "test/config.yml",
+     "test/config.yml.default",
+     "test/fixtures",
+     "test/fixtures/responses",
+     "test/fixtures/responses/freethepostcode",
+     "test/fixtures/responses/freethepostcode/not_found.txt",
+     "test/fixtures/responses/freethepostcode/success.txt",
+     "test/fixtures/responses/geocoder_ca",
+     "test/fixtures/responses/geocoder_ca/success.xml",
+     "test/fixtures/responses/geocoder_us",
+     "test/fixtures/responses/geocoder_us/success.xml",
+     "test/fixtures/responses/geocoder_us/unknown.xml",
+     "test/fixtures/responses/geonames",
+     "test/fixtures/responses/geonames/missing.xml",
+     "test/fixtures/responses/geonames/success.xml",
+     "test/fixtures/responses/geonames/unknown.xml",
+     "test/fixtures/responses/google",
+     "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/success_multiple_results.xml",
+     "test/fixtures/responses/google/unavailable.xml",
+     "test/fixtures/responses/google/unknown_address.xml",
+     "test/fixtures/responses/host_ip",
+     "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",
+     "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/mapquest",
+     "test/fixtures/responses/mapquest/multi_result.xml",
+     "test/fixtures/responses/mapquest/success.xml",
+     "test/fixtures/responses/multimap",
+     "test/fixtures/responses/multimap/missing_params.xml",
+     "test/fixtures/responses/multimap/no_matches.xml",
+     "test/fixtures/responses/multimap/success.xml",
+     "test/fixtures/responses/yahoo",
+     "test/fixtures/responses/yahoo/success.xml",
+     "test/fixtures/responses/yahoo/unknown_address.xml",
+     "test/graticule",
+     "test/graticule/distance_test.rb",
+     "test/graticule/geocoder",
+     "test/graticule/geocoder/freethepostcode_test.rb",
+     "test/graticule/geocoder/geocoder_ca_test.rb",
+     "test/graticule/geocoder/geocoder_us_test.rb",
+     "test/graticule/geocoder/geocoders.rb",
+     "test/graticule/geocoder/geonames_test.rb",
+     "test/graticule/geocoder/google_test.rb",
+     "test/graticule/geocoder/host_ip_test.rb",
+     "test/graticule/geocoder/local_search_maps_test.rb",
+     "test/graticule/geocoder/mapquest_test.rb",
+     "test/graticule/geocoder/multi_test.rb",
+     "test/graticule/geocoder/multimap_test.rb",
+     "test/graticule/geocoder/yahoo_test.rb",
+     "test/graticule/geocoder_test.rb",
+     "test/graticule/location_test.rb",
+     "test/mocks",
+     "test/mocks/uri.rb",
+     "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<happymapper>, [">= 0.3.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<happymapper>, [">= 0.3.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<happymapper>, [">= 0.3.0"])
   end
 end
+

data/lib/graticule/geocoder/base.rb

@@ -50,7 +50,7 @@ module Graticule #:nodoc:
     #   end
     #
     class Base
-      USER_AGENT = "Mozilla/5.0 (compatible; Graticule/#{Graticule::Version::STRING}; http://graticule.rubyforge.org)"
+      USER_AGENT = "Mozilla/5.0 (compatible; Graticule; http://graticule.rubyforge.org)"
 
       def initialize
         raise NotImplementedError

data/lib/graticule/geocoder/bogus.rb

@@ -1,15 +1,17 @@
 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
+      # A queue of canned responses
+      class_inheritable_accessor :responses
+      self.responses = []
+      
+      # A default location to use if the responses queue is empty
+      class_inheritable_accessor :default
+      
       def locate(address)
-        Location.new :street => address
+        responses.shift || default || Location.new(:street => address)
       end
-    
     end
-
   end
 end

data/lib/graticule/geocoder/freethepostcode.rb

@@ -0,0 +1,38 @@
+module Graticule #:nodoc:
+  module Geocoder #:nodoc:
+    
+    #  freethepostcode.org (http://www.freethepostcode.org/) is a
+    #  free service to convert UK postcodes into geolocation data.
+    #
+    #     gg = Graticule.service(:FreeThePostcode).new
+    #     location = gg.locate 'W1A 1AA'
+    #     location.coordinates
+    #     #=> [51.52093, -0.13714]
+    class FreeThePostcode < Base
+
+      def initialize
+        @url = URI.parse 'http://www.freethepostcode.org/geocode'
+      end
+
+      def locate(postcode)
+        get :postcode => postcode
+      end
+      
+    private
+
+      def prepare_response(response)
+        response.split("\n")[1]
+      end
+      
+      def parse_response(response)
+        data = response.split
+        Location.new(:latitude => data[0].to_f, :longitude => data[1].to_f, :precision => :unknown)
+      end
+
+      def check_error(response)
+        raise AddressError, 'unknown address' if response.blank?
+      end
+      
+    end
+  end
+end

data/lib/graticule/geocoder/geocoder_ca.rb

@@ -2,7 +2,7 @@ module Graticule #:nodoc:
   module Geocoder #:nodoc:
 
     # TODO: Reverse Geocoding
-    class GeocoderCa < Rest
+    class GeocoderCa < Base
 
       def initialize(auth = nil)
         @url = URI.parse 'http://geocoder.ca/'
@@ -14,29 +14,54 @@ module Graticule #:nodoc:
       end
       
     private
-      
-      def parse_response(xml) #:nodoc:
-        returning Location.new do |location|
-          location.latitude = xml.elements['geodata/latt'].text.to_f
-          location.longitude = xml.elements['geodata/longt'].text.to_f
-          location.street = xml.elements['geodata/standard/staddress'].text
-          location.locality = xml.elements['geodata/standard/city'].text
-          location.region = xml.elements['geodata/standard/prov'].text
+    
+      class Response
+        include HappyMapper
+        tag 'geodata'
+        element :latitude, Float, :tag => 'latt'
+        element :longitude, Float, :tag => 'longt'
+        element :street_number, String, :deep => true, :tag => 'stnumber'
+        element :street_name, String, :deep => true, :tag => 'staddress'
+        element :locality, String, :deep => true, :tag => 'city'
+        element :postal_code, String, :tag => 'postal'
+        element :region, String, :deep => true, :tag => 'prov'
+        
+        class Error
+          include HappyMapper
+          tag 'error'
+          element :code, Integer
+          element :description, String
+        end
+        
+        has_one :error, Error
+        
+        def street
+          [street_number, street_name].join(' ')
         end
       end
+      
+      def prepare_response(xml)
+        Response.parse(xml, :single => true)
+      end
+      
+      def parse_response(response) #:nodoc:
+        Location.new(
+          :latitude  => response.latitude,
+          :longitude => response.longitude,
+          :street    => response.street,
+          :locality  => response.locality,
+          :region    => response.region
+        )
+      end
 
-      def check_error(xml) #:nodoc:
-        error = xml.elements['geodata/error']
-        if error
-          code = error.elements['code'].text.to_i
-          message = error.elements['description'].text
-          if (1..3).include?(code)
-            raise CredentialsError, message
-          elsif (4..8).include?(code)
-            raise AddressError, message
-          else
-            raise Error, message
+      def check_error(response) #:nodoc:
+        if response.error
+          exception = case response.error.code
+          when 1..3; CredentialsError
+          when 4..8; AddressError
+          else;      Error
           end
+          raise exception, response.error.message
         end
       end
 

data/lib/graticule/geocoder/geocoder_us.rb

@@ -4,7 +4,7 @@ module Graticule #:nodoc:
     # A library for lookup up coordinates with geocoder.us' API.
     #
     # http://geocoder.us/help/
-    class GeocoderUs < Rest
+    class GeocoderUs < Base
 
       # Creates a new GeocoderUs object optionally using +username+ and
       # +password+.
@@ -13,7 +13,7 @@ module Graticule #:nodoc:
       #
       # http://geocoder.us/user/signup
       def initialize(user = nil, password = nil)
-        if user and password then
+        if user && password
           @url = URI.parse 'http://geocoder.us/member/service/rest/geocode'
           @url.user = user
           @url.password = password
@@ -29,22 +29,34 @@ module Graticule #:nodoc:
       end
       
     private
+      class Point
+        include HappyMapper
+        tag 'Point'
+        namespace 'http://www.w3.org/2003/01/geo/wgs84_pos#'
+        
+        element :description, String, :namespace => 'http://purl.org/dc/elements/1.1/'
+        element :longitude,   Float,  :tag => 'long'
+        element :latitude,    Float,  :tag => 'lat'
+      end
 
       def parse_response(xml) #:nodoc:
-        location = Location.new
-        location.street = xml.elements['rdf:RDF/geo:Point/dc:description'].text
-
-        location.latitude = xml.elements['rdf:RDF/geo:Point/geo:lat'].text.to_f
-        location.longitude = xml.elements['rdf:RDF/geo:Point/geo:long'].text.to_f
-
-        return location
+        point = Point.parse(xml, :single => true)
+        Location.new(
+          :street    => point.description,
+          :latitude  => point.latitude,
+          :longitude => point.longitude
+        )
       end
 
-      def check_error(xml) #:nodoc:
-        text = xml.to_s
-        raise AddressError, text if text =~ /couldn't find this address! sorry/
-        raise Error, text if text =~ /Your browser sent a request that this server could not understand./
-        raise Error, text if !(text =~ /geo:Point/)
+      def check_error(response) #:nodoc:
+        case response
+        when /geo:Point/
+          # success
+        when /couldn't find this address! sorry/
+          raise AddressError, response
+        else
+          raise Error, response
+        end
       end
 
     end