graticule 0.1.3 → 0.2.0

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: graticule
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2007-02-14 00:00:00 -05:00
+  version: 0.2.0
+date: 2007-03-17 00:00:00 -04:00
 summary: API for using all the popular geocoding services.
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Brandon Keepers
 files: 
@@ -42,12 +43,16 @@ files:
 - lib/graticule/distance/spherical.rb
 - lib/graticule/distance/vincenty.rb
 - lib/graticule/geocoder.rb
-- lib/graticule/geocoders/bogus.rb
-- lib/graticule/geocoders/geocoder_us.rb
-- lib/graticule/geocoders/google.rb
-- lib/graticule/geocoders/meta_carta.rb
-- lib/graticule/geocoders/rest.rb
-- lib/graticule/geocoders/yahoo.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/meta_carta.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
 - test/fixtures/responses/geocoder_us/success.xml
@@ -59,29 +64,43 @@ files:
 - 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/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/postcode_anywhere_test.rb
+- test/unit/graticule/geocoder/yahoo_test.rb
 - test/unit/graticule/geocoder_test.rb
-- test/unit/graticule/geocoders/geocoder_us_test.rb
-- test/unit/graticule/geocoders/geocoders.rb
-- test/unit/graticule/geocoders/google_test.rb
-- test/unit/graticule/geocoders/meta_carta_test.rb
-- test/unit/graticule/geocoders/yahoo_test.rb
 - test/unit/graticule/location_test.rb
 test_files: 
 - test/unit/graticule/distance_test.rb
 - test/unit/graticule/geocoder_test.rb
 - test/unit/graticule/location_test.rb
-- test/unit/graticule/geocoders/geocoder_us_test.rb
-- test/unit/graticule/geocoders/google_test.rb
-- test/unit/graticule/geocoders/meta_carta_test.rb
-- test/unit/graticule/geocoders/yahoo_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/postcode_anywhere_test.rb
+- test/unit/graticule/geocoder/yahoo_test.rb
 rdoc_options: []
 
 extra_rdoc_files: []

data/lib/graticule/geocoders/bogus.rb

@@ -1,11 +0,0 @@
-module Graticule #:nodoc:
-
-  # Bogus geocoder that can be used for test purposes
-  class BogusGeocoder < Geocoder
-    
-    def locate(address)
-      Location.new :street => address
-    end
-    
-  end
-end

data/lib/graticule/geocoders/geocoder_us.rb

@@ -1,45 +0,0 @@
-module Graticule #:nodoc:
-
-  # A library for lookup up coordinates with geocoder.us' API.
-  #
-  # http://geocoder.us/help/
-  class GeocoderUsGeocoder < RestGeocoder
-
-    # Creates a new GeocoderUs object optionally using +username+ and
-    # +password+.
-    #
-    # You can sign up for a geocoder.us account here:
-    #
-    # http://geocoder.us/user/signup
-    def initialize(user = nil, password = nil)
-      if user and password then
-        @url = URI.parse 'http://geocoder.us/member/service/rest/geocode'
-        @url.user = user
-        @url.password = password
-      else
-        @url = URI.parse 'http://rpc.geocoder.us/service/rest/geocode'
-      end
-    end
-
-    # Locates +address+ and returns the address' latitude and longitude or
-    # raises an AddressError.
-    def locate(address)
-      get :address => address
-    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
-    end
-
-    def check_error(xml) #:nodoc:
-      raise AddressError, xml.text if xml.text == 'couldn\'t find this address! sorry'
-    end
-
-  end
-end

data/lib/graticule/geocoders/google.rb

@@ -1,99 +0,0 @@
-
-module Graticule
-  
-  # First you need a Google Maps API key.  You can register for one here:
-  # http://www.google.com/apis/maps/signup.html
-  # 
-  # Then you create a GoogleGeocode object and start locating addresses:
-  # 
-  #   require 'rubygems'
-  #   require 'graticule'
-  # 
-  #   gg = Graticule.service(:google).new(:key => MAPS_API_KEY)
-  #   location = gg.locate '1600 Amphitheater Pkwy, Mountain View, CA'
-  #   p location.coordinates
-  # 
-  class GoogleGeocoder < RestGeocoder
-    # http://www.google.com/apis/maps/documentation/#Geocoding_HTTP_Request
-    
-    # http://www.google.com/apis/maps/documentation/reference.html#GGeoAddressAccuracy
-    PRECISION = {
-      0 => :unknown,      # Unknown location. (Since 2.59)
-      1 => :country,      # Country level accuracy. (Since 2.59)
-      2 => :state,        # Region (state, province, prefecture, etc.) level accuracy. (Since 2.59)
-      3 => :state,        # Sub-region (county, municipality, etc.) level accuracy. (Since 2.59)
-      4 => :city,         # Town (city, village) level accuracy. (Since 2.59)
-      5 => :zip,          # Post code (zip code) level accuracy. (Since 2.59)
-      6 => :street,       # Street level accuracy. (Since 2.59)
-      7 => :street,       # Intersection level accuracy. (Since 2.59)
-      8 => :address       # Address level accuracy. (Since 2.59)
-    }
-
-    # Creates a new GoogleGeocode that will use Google Maps API key +key+.  You
-    # can sign up for an API key here:
-    #
-    # http://www.google.com/apis/maps/signup.html
-    def initialize(key)
-      @key = key
-      @url = URI.parse 'http://maps.google.com/maps/geo'
-    end
-
-    # Locates +address+ returning a Location
-    def locate(address)
-      get :q => address
-    end
-
-    # Extracts a Location from +xml+.
-    def parse_response(xml) #:nodoc:
-      address = REXML::XPath.first(xml, '//xal:AddressDetails', 'xal' => "urn:oasis:names:tc:ciq:xsdschema:xAL:2.0")
-
-      longitude, latitude, = xml.elements['/kml/Response/Placemark/Point/coordinates'].text.split(',').map { |v| v.to_f }
-      
-      Location.new \
-        :street => address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/Thoroughfare/ThoroughfareName/text()'].value,
-        :city => address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/LocalityName/text()'].value,
-        :state => address.elements['Country/AdministrativeArea/AdministrativeAreaName/text()'].value,
-        :zip => address.elements['Country/AdministrativeArea/SubAdministrativeArea/Locality/PostalCode/PostalCodeNumber/text()'].value,
-        :country => address.elements['Country/CountryNameCode/text()'].value,
-        :latitude => latitude,
-        :longitude => longitude,
-        :precision => PRECISION[address.attribute('Accuracy').value.to_i] || :unknown
-    end
-
-    # Extracts and raises an error from +xml+, if any.
-    def check_error(xml) #:nodoc:
-      status ||= xml.elements['/kml/Response/Status/code'].text.to_i
-      case status
-      when 200 then # ignore, ok
-      when 500 then
-        raise Error, 'server error'
-      when 601 then
-        raise AddressError, 'missing address'
-      when 602 then
-        raise AddressError, 'unknown address'
-      when 603 then
-        raise AddressError, 'unavailable address'
-      when 610 then
-        raise CredentialsError, 'invalid key'
-      when 620 then
-        raise CredentialsError, 'too many queries'
-      else
-        raise Error, "unknown error #{status}"
-      end
-    end
-
-    # Creates a URL from the Hash +params+.  Automatically adds the key and
-    # sets the output type to 'xml'.
-    def make_url(params) #:nodoc:
-      params[:key] = @key
-      params[:output] = 'xml'
-
-      super params
-    end
-    
-    private
-      def text(element)
-        element.text if element
-      end
-  end
-end

data/lib/graticule/geocoders/meta_carta.rb

@@ -1,102 +0,0 @@
-
-module Graticule
-
-  # Library for looking up coordinates with MetaCarta's GeoParser API.
-  #
-  # http://labs.metacarta.com/GeoParser/documentation.html
-  class MetaCartaGeocoder < RestGeocoder
-    Location = Struct.new :name, :type, :population, :hierarchy,
-                          :latitude, :longitude, :confidence, :viewbox
-
-    def initialize # :nodoc:
-      @url = URI.parse 'http://labs.metacarta.com/GeoParser/'
-    end
-
-    # Locates +place+ and returns a Location object.
-    def locate(place)
-      locations, = get :q => place
-      return locations.first
-    end
-
-    # Retrieve all locations matching +place+.
-    #
-    # Returns an Array of Location objects and a pair of coordinates that will
-    # surround them.
-    def locations(place)
-      get :loc => place
-    end
-
-    def check_error(xml) # :nodoc:
-      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:
-      locations = []
-
-      xml.elements['/Locations'].each do |l|
-        next if REXML::Text === l or l.name == 'ViewBox'
-        location = Location.new
-
-        location.viewbox = viewbox_coords l.elements['ViewBox/gml:Box/gml:coordinates']
-
-        location.name = l.attributes['Name']
-        location.type = l.attributes['Type']
-        population = l.attributes['Population'].to_i
-        location.population = population > 0 ? population : nil
-        location.hierarchy = l.attributes['Hierarchy']
-
-        coords = l.elements['Centroid/gml:Point/gml:coordinates'].text.split ','
-        location.latitude = coords.first.to_f
-        location.longitude = coords.last.to_f
-
-        confidence = l.elements['Confidence']
-        location.confidence = confidence.text.to_f if confidence
-
-        locations << location
-      end
-
-      query_viewbox = xml.elements['/Locations/ViewBox/gml:Box/gml:coordinates']
-
-      return locations, viewbox_coords(query_viewbox)
-    end
-
-    # Turns a element containing a pair of coordinates into a pair of coordinate
-    # Arrays.
-    def viewbox_coords(viewbox) # :nodoc:
-      return viewbox.text.split(' ').map do |coords|
-        coords.split(',').map { |c| c.to_f }
-      end
-    end
-
-  end
-
-  # A Location contains the following fields:
-  #
-  # +name+:: The name of this location
-  # +type+:: The type of this location (no clue what it means)
-  # +population+:: The number of people who live here or nil
-  # +hierarchy+:: The places above this place
-  # +latitude+:: Latitude of the location
-  # +longitude+:: Longitude of the location
-  # +confidence+:: Accuracy confidence (if any)
-  # +viewbox+:: Pair of coordinates forming a box around this place
-  # 
-  # viewbox runs from lower left to upper right.
-  class MetaCartaGeocoder::Location
-
-    ##
-    # The latitude and longitude for this location.
-
-    def coordinates
-      [latitude, longitude]
-    end
-
-  end
-
-end

data/lib/graticule/geocoders/rest.rb

@@ -1,98 +0,0 @@
-require 'open-uri'
-require 'rexml/document'
-
-module Graticule #: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 xml
-  #     end
-  #   
-  #     def test(query)
-  #       get :q => query
-  #     end
-  #   
-  #   end
-  class RestGeocoder < Geocoder
-
-    # Web services initializer.
-    #
-    # Concrete web services implementations must set the +url+ instance
-    # variable which must be a URI.
-    def initialize
-      raise NotImplementedError
-    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
-    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 something sensible
-    # for the API.
-    def parse_response(xml)
-      raise NotImplementedError
-    end
-
-  end
-end