graticule 2.2.0 → 2.3.0

data/CHANGELOG.txt

@@ -1,3 +1,12 @@
+2.3.0 (2013-04-01)
+* Google v3 API [Adamlb]
+* Escape XML entities in GeoCoder::MapQuest queries [Simon Coffey]
+
+2.2.0 (2011-09-14)
+* Added yandex geocoder
+* Lots of other changes since September 2009.
+  Check https://github.com/collectiveidea/graticule/compare/v0.2.12...master for more info
+
 * Added freethepostcode.org geocoder [Chris Lowis]
 
 0.2.12 (2009-09-06)

data/lib/graticule/distance/spherical.rb

@@ -38,16 +38,15 @@ module Graticule
           :latitude_column => 'latitude',
           :longitude_column => 'longitude'
         }.merge(options)
-        %{(ACOS(
+        %{(ACOS(LEAST(1,
             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]})
+          )) * #{Graticule::Distance::EARTH_RADIUS[options[:units].to_sym]})
         }.gsub("\n", '').squeeze(" ")
       end
-
     end
   end
 end

data/lib/graticule/geocoder/base.rb

@@ -81,6 +81,7 @@ module Graticule #:nodoc:
         check_error(response)
         return parse_response(response)
       rescue OpenURI::HTTPError => e
+        raise e.inspect
         check_error(prepare_response(e.io.read))
         raise
       end
@@ -91,7 +92,6 @@ module Graticule #:nodoc:
         escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
           "#{escape k.to_s}=#{escape v.to_s}"
         end
-
         url = @url.dup
         url.query = escaped_params.join '&'
         return url

data/lib/graticule/geocoder/google.rb

@@ -1,93 +1,102 @@
 # encoding: UTF-8
+require 'json'
 module Graticule #:nodoc:
   module Geocoder #:nodoc:
-
-    # First you need a Google Maps API key.  You can register for one here:
-    # http://www.google.com/apis/maps/signup.html
-    #
-    #   gg = Graticule.service(:google).new(MAPS_API_KEY)
+    #   gg = Graticule.service(:google).new(MAPS_API_KEY) API Key is not required
     #   location = gg.locate '1600 Amphitheater Pkwy, Mountain View, CA'
     #   p location.coordinates
     #   #=> [37.423111, -122.081783
     #
     class Google < Base
-      # http://www.google.com/apis/maps/documentation/#Geocoding_HTTP_Request
-
-      # http://www.google.com/apis/maps/documentation/reference.html#GGeoAddressAccuracy
-      PRECISION = {
-        0 => Precision::Unknown,      # Unknown location.
-        1 => Precision::Country,      # Country level accuracy.
-        2 => Precision::Region,       # Region (state, province, prefecture, etc.) level accuracy.
-        3 => Precision::Region,       # Sub-region (county, municipality, etc.) level accuracy.
-        4 => Precision::Locality,     # Town (city, village) level accuracy.
-        5 => Precision::PostalCode,   # Post code (zip code) level accuracy.
-        6 => Precision::Street,       # Street level accuracy.
-        7 => Precision::Street,       # Intersection level accuracy.
-        8 => Precision::Address,      # Address level accuracy.
-        9 => Precision::Premise       # Premise (building name, property name, shopping center, etc.) level accuracy.
-      }
+      # https://developers.google.com/maps/documentation/geocoding/
 
       def initialize(key)
         @key = key
-        @url = URI.parse 'http://maps.google.com/maps/geo'
+        @url = URI.parse 'http://maps.googleapis.com/maps/api/geocode/json'
       end
 
       # Locates +address+ returning a Location
       def locate(address)
-        get :q => address.is_a?(String) ? address : location_from_params(address).to_s
+        get :address => address.is_a?(String) ? address : location_from_params(address).to_s
       end
 
     private
-      class Address
-        include HappyMapper
-        tag 'AddressDetails'
-        namespace 'urn:oasis:names:tc:ciq:xsdschema:xAL:2.0'
-
-        attribute :accuracy, Integer, :tag => 'Accuracy'
-      end
-
-      class Placemark
-        include HappyMapper
-        tag 'Placemark'
-        element :coordinates, String, :deep => true
-        has_one :address, Address
-
-        attr_reader :longitude, :latitude
-
-        with_options :deep => true, :namespace => 'urn:oasis:names:tc:ciq:xsdschema:xAL:2.0' do |map|
-          map.element :street,      String, :tag => 'ThoroughfareName'
-          map.element :locality,    String, :tag => 'LocalityName'
-          map.element :region,      String, :tag => 'AdministrativeAreaName'
-          map.element :postal_code, String, :tag => 'PostalCodeNumber'
-          map.element :country,     String, :tag => 'CountryNameCode'
+      class Result
+        attr_accessor :latitude, :longitude, :street_number, :route, :locality, :region, :postal_code, :country, :precision, :formatted_address
+        def initialize(attribs)
+          @latitude = attribs["geometry"]["location"]["lat"]
+          @longitude = attribs["geometry"]["location"]["lng"]
+          @formatted_address = attribs["formatted_address"]
+          @precision = determine_precision(attribs["types"])
+          parse_address_components(attribs["address_components"])
         end
 
-        def coordinates=(coordinates)
-          @longitude, @latitude, _ = coordinates.split(',').map { |v| v.to_f }
+        def parse_address_components(components)
+          components.each do |component|
+            component["types"].each do |type|
+              case type
+              when "street_number"
+                @street_number = component["short_name"]
+              when "route"
+                @route = component["short_name"]
+              when "locality"
+                @locality = component["long_name"]
+              when "administrative_area_level_1"
+                @region = component["short_name"]
+              when "country"
+                @country = component["short_name"]
+              when "postal_code"
+                @postal_code = component["long_name"]
+              end
+            end
+          end
         end
 
-        def accuracy
-          address.accuracy if address
+        def street
+          "#{@street_number.to_s}#{" " unless @street_number.blank? || @route.blank?}#{@route.to_s}"
         end
 
-        def precision
-          PRECISION[accuracy] || :unknown
+        def determine_precision(types)
+          precision = Precision::Unknown
+          types.each do |type|
+            precision = case type
+            when "premise", "subpremise"
+              Precision::Premise
+            when "street_address"
+              Precision::Address
+            when "route", "intersection"
+              Precision::Street
+            when "postal_code"
+              Precision::PostalCode
+            when "locality","sublocality","neighborhood"
+              Precision::Locality
+            when "administrative_area_level_1", "administrative_area_level_2","administrative_area_level_3"
+              Precision::Region
+            when "country"
+              Precision::Country
+            else
+              precision
+            end
+          end
+          return precision
         end
       end
 
       class Response
-        include HappyMapper
-        tag 'Response'
-        element :code, Integer, :tag => 'code', :deep => true
-        has_many :placemarks, Placemark
+        attr_reader :results, :status
+        def initialize(json)
+          result = JSON.parse(json)
+          @results = result["results"].collect{|attribs| Result.new(attribs)}
+          @status = result["status"]
+        end
       end
 
-      def prepare_response(xml)
-        Response.parse(xml, :single => true)
+      def prepare_response(json)
+        Response.new(json)
       end
 
       def parse_response(response) #:nodoc:
-        result = response.placemarks.first
+        result = response.results.first
         Location.new(
           :latitude    => result.latitude,
           :longitude   => result.longitude,
@@ -100,31 +109,28 @@ module Graticule #:nodoc:
         )
       end
 
-      # Extracts and raises an error from +xml+, if any.
+      # Extracts and raises an error from +json+, if any.
       def check_error(response) #:nodoc:
-        case response.code
-        when 200 then # ignore, ok
-        when 500 then
-          raise Error, 'server error'
-        when 601 then
-          raise AddressError, 'missing address'
-        when 602 then
+        case response.status
+        when "OK" then # ignore, ok
+        when "ZERO_RESULTS" 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'
+        when "OVER_QUERY_LIMIT"
+          raise CredentialsError, 'over query limit'
+        when "REQUEST_DENIED"
+          raise CredentialsError, 'request denied'
+        when "INVALID_REQUEST"
+          raise AddressError, 'missing address'
+        when "UNKNOWN_ERROR"
+          raise Error, "unknown server error. Try again."
         else
-          raise Error, "unknown error #{response.code}"
+          raise Error, "unkown error #{response.status}"
         end
       end
 
-      # Creates a URL from the Hash +params+.
-      # sets the output type to 'xml'.
+      # Creates a URL from the Hash +params+..
       def make_url(params) #:nodoc:
-        super params.merge(:key => @key, :oe => 'utf8', :output => 'xml', :sensor => false)
+        super params.merge(:key => @key, :sensor => false)
       end
     end
   end

data/lib/graticule/geocoder/mapquest.rb

@@ -1,3 +1,5 @@
+require 'htmlentities'
+
 # encoding: UTF-8
 module Graticule #:nodoc:
   module Geocoder #:nodoc:
@@ -43,13 +45,36 @@ module Graticule #:nodoc:
       protected
 
       def make_url(params) #:nodoc
-        query = "e=5&<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?><Geocode Version=\"1\"> \
-          #{address_string(params[:q])}#{authentication_string}</Geocode>"
+        request = Mapquest::Request.new(params[:q], @client_id, @password)
         url = @url.dup
-        url.query = escape(query)
+        url.query = escape(request.query)
         url
       end
 
+      class Request
+        def initialize(address, client_id, password)
+          @address = address
+          @client_id = client_id
+          @password = password
+        end
+
+        def query
+          "e=5&<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?><Geocode Version=\"1\">#{address_string}#{authentication_string}</Geocode>"
+        end
+
+        def address_string
+          "<Address><Street>#{escaped_address}</Street></Address><GeocodeOptionsCollection Count=\"0\"/>"
+        end
+        
+        def authentication_string
+          "<Authentication Version=\"2\"><Password>#{@password}</Password><ClientId>#{@client_id}</ClientId></Authentication>"
+        end
+
+        def escaped_address
+          HTMLEntities.new.encode(@address, :basic)
+        end
+      end
+
       class Address
         include HappyMapper
         tag 'GeoAddress'
@@ -96,13 +121,6 @@ module Graticule #:nodoc:
       def check_error(xml) #:nodoc
       end
 
-      def authentication_string
-        "<Authentication Version=\"2\"><Password>#{@password}</Password><ClientId>#{@client_id}</ClientId></Authentication>"
-      end
-
-      def address_string(query)
-        "<Address><Street>#{query}</Street></Address><GeocodeOptionsCollection Count=\"0\"/>"
-      end
     end
   end
 end

data/lib/graticule/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module Graticule
-  VERSION = '2.2.0' unless defined?(::Graticule::VERSION)
+  VERSION = '2.3.0' unless defined?(::Graticule::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graticule
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-14 00:00:00.000000000Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70276838707980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70276838707980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70276838705640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70276838705640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70276838703420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +70,15 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70276838703420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70276838701800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +86,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70276838701800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70276838699580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +102,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70276838699580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70276838697520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +118,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70276838697520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Graticule is a geocoding API that provides a common interface to all
   the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.
 email: brandon@opensoul.org
@@ -135,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 473484385783211524
+      hash: 3804880588215325222
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -144,10 +190,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 473484385783211524
+      hash: 3804880588215325222
 requirements: []
 rubyforge_project: graticule
-rubygems_version: 1.8.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: API for using all the popular geocoding services.