geocoder 0.9.12 → 1.0.0

data/lib/geocoder/lookups/yandex.rb

@@ -0,0 +1,39 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/yandex"
+
+module Geocoder::Lookup
+  class Yandex < Base
+
+    def map_link_url(coordinates)
+      "http://maps.yandex.ru/?ll=#{coordinates.reverse.join(',')}"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query, reverse = false)
+      return [] unless doc = fetch_data(query, reverse)
+      if err = doc['error']
+        warn "Yandex Geocoding API error: #{err['status']} (#{err['message']})."
+        return []
+      end
+      if doc = doc['response']['GeoObjectCollection']
+        meta = doc['metaDataProperty']['GeocoderResponseMetaData']
+        return meta['found'].to_i > 0 ? doc['featureMember'] : []
+      else
+        warn "Yandex Geocoding API error: unexpected response format."
+        return []
+      end
+    end
+
+    def query_url(query, reverse = false)
+      query = query.split(",").reverse.join(",") if reverse
+      params = {
+        :geocode => query,
+        :format => "json",
+        :plng => "#{Geocoder::Configuration.language}", # supports ru, uk, be
+        :key => Geocoder::Configuration.api_key
+      }
+      "http://geocode-maps.yandex.ru/1.x/?" + hash_to_query(params)
+    end
+  end
+end

data/lib/geocoder/models/base.rb

@@ -9,7 +9,11 @@ module Geocoder
     module Base
 
       def geocoder_options
-        @geocoder_options
+        if defined?(@geocoder_options)
+          @geocoder_options
+        elsif superclass.respond_to?(:geocoder_options)
+          superclass.geocoder_options
+        end
       end
 
       def geocoded_by

data/lib/geocoder/results/base.rb

@@ -32,6 +32,22 @@ module Geocoder
         coordinates[1]
       end
 
+      def state
+        fail
+      end
+
+      def province
+        state
+      end
+
+      def state_code
+        fail
+      end
+
+      def province_code
+        state_code
+      end
+
       def country
         fail
       end

data/lib/geocoder/results/bing.rb

@@ -0,0 +1,48 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Bing < Base
+
+    def address(format = :full)
+      @data['address']['formattedAddress']
+    end
+
+    def city
+      @data['address']['locality']
+    end
+
+    def state_code
+      @data['address']['adminDistrict']
+    end
+
+    alias_method :state, :state_code
+
+    def country
+      @data['address']['countryRegion']
+    end
+
+    alias_method :country_code, :country
+
+    def postal_code
+      @data['address']['postalCode']
+    end
+
+    def coordinates
+      @data['point']['coordinates']
+    end
+
+    def address_data
+      @data['address']
+    end
+
+    def self.response_attributes
+      %w[bbox name confidence entityType]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/results/freegeoip.rb

@@ -4,13 +4,21 @@ module Geocoder::Result
   class Freegeoip < Base
 
     def address(format = :full)
-      "#{city}#{', ' + region_code unless region_code == ''} #{postal_code}, #{country}"
+      "#{city}#{', ' + state_code unless state_code == ''} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
     def city
       @data['city']
     end
 
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
     def country
       @data['country_name']
     end
@@ -24,8 +32,7 @@ module Geocoder::Result
     end
 
     def self.response_attributes
-      %w[city region_code region_name metrocode
-        zipcode country_name country_code ip]
+      %w[metrocode ip]
     end
 
     response_attributes.each do |a|

data/lib/geocoder/results/geocoder_ca.rb

@@ -8,7 +8,7 @@ module Geocoder::Result
     end
 
     def address(format = :full)
-      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}"
+      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
     def street_address
@@ -23,7 +23,7 @@ module Geocoder::Result
       @data['prov']
     end
 
-    alias_method :province, :state
+    alias_method :state_code, :state
 
     def postal_code
       @data['postal']
@@ -34,19 +34,14 @@ module Geocoder::Result
     end
 
     def country_code
-      prov = @data['prov']
-      return nil if prov.nil? || prov == ""
-      canadian_province_abbreviations.include?(@data['prov']) ? "CA" : "US"
-    end
-
-    def canadian_province_abbreviations
-      %w[ON QC NS NB MB BC PE SK AB NL]
+      return nil if state.nil? || state == ""
+      canadian_province_abbreviations.include?(state) ? "CA" : "US"
     end
 
     def self.response_attributes
-      %w[latt longt inlatt inlongt betweenRoad1 betweenRoad2 distance
-        stnumber staddress city prov postal
-        NearRoad NearRoadDistance intersection major_intersection]
+      %w[latt longt inlatt inlongt distance stnumber staddress prov
+        NearRoad NearRoadDistance betweenRoad1 betweenRoad2
+        intersection major_intersection]
     end
 
     response_attributes.each do |a|
@@ -54,5 +49,12 @@ module Geocoder::Result
         @data[a]
       end
     end
+
+
+    private # ---------------------------------------------------------------- 
+
+    def canadian_province_abbreviations
+      %w[ON QC NS NB MB BC PE SK AB NL]
+    end
   end
 end

data/lib/geocoder/results/google.rb

@@ -12,8 +12,9 @@ module Geocoder::Result
     end
 
     def city
-      fields = [:locality, :sublocality, :administrative_area_level_3,
-        :administrative_area_level_2, :administrative_area_level_1]
+      fields = [:locality, :sublocality,
+        :administrative_area_level_3,
+        :administrative_area_level_2]
       fields.each do |f|
         if entity = address_components_of_type(f).first
           return entity['long_name']
@@ -21,6 +22,18 @@ module Geocoder::Result
       end
     end
 
+    def state
+      if state = address_components_of_type(:administrative_area_level_1).first
+        state['long_name']
+      end
+    end
+
+    def state_code
+      if state = address_components_of_type(:administrative_area_level_1).first
+        state['short_name']
+      end
+    end
+
     def country
       if country = address_components_of_type(:country).first
         country['long_name']

data/lib/geocoder/results/yahoo.rb

@@ -11,6 +11,14 @@ module Geocoder::Result
       @data['city']
     end
 
+    def state
+      @data['state']
+    end
+
+    def state_code
+      @data['statecode']
+    end
+
     def country
       @data['country']
     end
@@ -25,8 +33,8 @@ module Geocoder::Result
 
     def self.response_attributes
       %w[quality offsetlat offsetlon radius boundingbox name
-        line1 line2 line3 line4 cross house street xstreet unittype unit postal
-        neighborhood city county state country countrycode statecode countycode
+        line1 line2 line3 line4 cross house street xstreet unittype unit
+        neighborhood county countycode
         level0 level1 level2 level3 level4 level0code level1code level2code
         timezone areacode uzip hash woeid woetype]
     end

data/lib/geocoder/results/yandex.rb

@@ -0,0 +1,48 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Yandex < Base
+
+    def coordinates
+      @data['GeoObject']['Point']['pos'].split(' ').reverse.map(&:to_f)
+    end
+
+    def address(format = :full)
+      @data['GeoObject']['metaDataProperty']['GeocoderMetaData']['text']
+    end
+
+    def city
+      address_details['Locality']['LocalityName']
+    end
+
+    def country
+      address_details['CountryName']
+    end
+
+    def country_code
+      address_details['CountryNameCode']
+    end
+
+    def state
+      ""
+    end
+
+    def state_code
+      ""
+    end
+
+    def postal_code
+      ""
+    end
+
+    def premise_name
+      address_details['Locality']['Premise']['PremiseName']
+    end
+
+    private # ----------------------------------------------------------------
+
+    def address_details
+      @data['GeoObject']['metaDataProperty']['GeocoderMetaData']['AddressDetails']['Country']
+    end
+  end
+end

data/lib/geocoder/stores/active_record.rb

@@ -1,5 +1,4 @@
 require 'geocoder/stores/base'
-require 'geocoder/stores/active_record_legacy'
 
 ##
 # Add geocoding functionality to any ActiveRecord object.
@@ -7,7 +6,6 @@ require 'geocoder/stores/active_record_legacy'
 module Geocoder::Store
   module ActiveRecord
     include Base
-    include ActiveRecord::Legacy
 
     ##
     # Implementation of 'included' hook method.
@@ -180,9 +178,6 @@ module Geocoder::Store
           conditions[0] << " AND #{table_name}.id != ?"
           conditions << obj.id
         end
-        if options[:limit] || options[:offset]
-          warn "DEPRECATION WARNING: The :limit and :offset options to Geocoder's 'near' method are deprecated and will be removed in Geocoder v1.0. Please specify these options using ARel relations instead, for example: Place.near(...).limit(10).offset(20)."
-        end
         {
           :group  => columns.map{ |c| "#{table_name}.#{c.name}" }.join(','),
           :order  => options[:order],
@@ -208,7 +203,7 @@ module Geocoder::Store
       end
     end
 
-    #alias_method :fetch_coordinates, :geocode
+    alias_method :fetch_coordinates, :geocode
 
     ##
     # Look up address and assign to +address+ attribute (or other as specified
@@ -224,6 +219,6 @@ module Geocoder::Store
       end
     end
 
-    #alias_method :fetch_address, :reverse_geocode
+    alias_method :fetch_address, :reverse_geocode
   end
 end

data/lib/geocoder/stores/base.rb

@@ -22,14 +22,10 @@ module Geocoder
       # the point. Also takes a symbol specifying the units
       # (:mi or :km; default is :mi).
       #
-      def distance_to(point, *args)
-        if point.is_a?(Numeric) and args[0].is_a?(Numeric)
-          warn "DEPRECATION WARNING: Instead of passing latitude/longitude as separate arguments to the distance_to/from method, please pass an array [#{point},#{args[0]}], a geocoded object, or a geocodable address (string). The old argument format will not be supported in Geocoder v.1.0."
-          point = [point, args.shift]
-        end
+      def distance_to(point, units = :mi)
         return nil unless geocoded?
         Geocoder::Calculations.distance_between(
-          to_coordinates, point, :units => args.pop || :mi)
+          to_coordinates, point, :units => units)
       end
 
       alias_method :distance_from, :distance_to
@@ -62,10 +58,6 @@ module Geocoder
       #
       def nearbys(radius = 20, options = {})
         return [] unless geocoded?
-        if options.is_a?(Symbol)
-          options = {:units => options}
-          warn "DEPRECATION WARNING: The units argument to the nearbys method has been replaced with an options hash (same options hash as the near scope). You should instead call: obj.nearbys(#{radius}, :units => #{options[:units]}). The old syntax will not be supported in Geocoder v1.0."
-        end
         options.merge!(:exclude => self)
         self.class.near(self, radius, options)
       end

data/lib/geocoder/stores/mongoid.rb

@@ -19,11 +19,17 @@ module Geocoder::Store
           coords  = Geocoder::Calculations.extract_coordinates(location)
           radius  = args.size > 0 ? args.shift : 20
           options = args.size > 0 ? args.shift : {}
-          conds   = {:coordinates => {
-            "$nearSphere" => coords.reverse,
-            "$maxDistance" => Geocoder::Calculations.distance_to_radians(
-              radius, options[:units] || :mi)
-          }}
+
+          # Use BSON::OrderedHash if Ruby's hashes are unordered.
+          # Conditions must be in order required by indexes (see mongo gem).
+          empty = RUBY_VERSION.split('.')[1].to_i < 9 ? BSON::OrderedHash.new : {}
+
+          conds = empty.clone
+          conds[:coordinates] = empty.clone
+          conds[:coordinates]["$nearSphere"]  = coords.reverse
+          conds[:coordinates]["$maxDistance"] = \
+            Geocoder::Calculations.distance_to_radians(radius, options[:units] || :mi)
+
           if obj = options[:exclude]
             conds[:_id.ne] = obj.id
           end

data/lib/geocoder/version.rb

@@ -0,0 +1,3 @@
+module Geocoder
+  VERSION = "1.0.0"
+end

data/lib/geocoder.rb

@@ -11,32 +11,8 @@ module Geocoder
   ##
   # Search for information about an address or a set of coordinates.
   #
-  def search(query, *args)
-    # convert coordinates as separate arguments to an array
-    if query.is_a?(Numeric) and args.first.is_a?(Numeric)
-      warn "DEPRECATION WARNING: Instead of passing latitude/longitude as separate arguments to the search method, please pass an array: [#{query},#{args.first}]. The old argument format will not be supported in Geocoder v.1.0."
-      query = [query, args.first]
-    end
-    if blank_query?(query)
-      results = []
-    else
-      results = lookup(ip_address?(query)).search(query)
-    end
-    results.instance_eval do
-      def warn_search_deprecation(attr)
-        warn "DEPRECATION WARNING: Geocoder.search now returns an array of Geocoder::Result objects. " +
-          "Calling '%s' directly on the returned array will cause an exception in Geocoder v1.0." % attr
-      end
-
-      def coordinates; warn_search_deprecation('coordinates'); first.coordinates if first; end
-      def latitude; warn_search_deprecation('latitude'); first.latitude if first; end
-      def longitude; warn_search_deprecation('longitude'); first.longitude if first; end
-      def address; warn_search_deprecation('address'); first.address if first; end
-      def city; warn_search_deprecation('city'); first.city if first; end
-      def country; warn_search_deprecation('country'); first.country if first; end
-      def country_code; warn_search_deprecation('country_code'); first.country_code if first; end
-    end
-    return results
+  def search(query)
+    blank_query?(query) ? [] : lookup(query).search(query)
   end
 
   ##
@@ -52,11 +28,7 @@ module Geocoder
   # Look up the address of the given coordinates ([lat,lon])
   # or IP address (string).
   #
-  def address(query, *args)
-    if lon = args.first
-      warn "DEPRECATION WARNING: Instead of passing latitude/longitude as separate arguments to the address method, please pass an array: [#{query},#{args.first}]. The old argument format will not be supported in Geocoder v.1.0."
-      query = [query, lon]
-    end
+  def address(query)
     if (results = search(query)).size > 0
       results.first.address
     end
@@ -72,6 +44,27 @@ module Geocoder
     @cache
   end
 
+  ##
+  # Array of valid Lookup names.
+  #
+  def valid_lookups
+    street_lookups + ip_lookups
+  end
+
+  ##
+  # All street address lookups, default first.
+  #
+  def street_lookups
+    [:google, :yahoo, :bing, :geocoder_ca, :yandex]
+  end
+
+  ##
+  # All IP address lookups, default first.
+  #
+  def ip_lookups
+    [:freegeoip]
+  end
+
 
   # exception classes
   class Error < StandardError; end
@@ -82,13 +75,14 @@ module Geocoder
 
   ##
   # Get a Lookup object (which communicates with the remote geocoding API).
-  # Returns an IP address lookup if +ip+ parameter true.
+  # Takes a search query and returns an IP or street address Lookup
+  # depending on the query contents.
   #
-  def lookup(ip = false)
-    if ip
-      get_lookup :freegeoip
+  def lookup(query)
+    if ip_address?(query)
+      get_lookup(ip_lookups.first)
     else
-      get_lookup Configuration.lookup || :google
+      get_lookup(Configuration.lookup || street_lookups.first)
     end
   end
 
@@ -121,13 +115,6 @@ module Geocoder
     end
   end
 
-  ##
-  # Array of valid Lookup names.
-  #
-  def valid_lookups
-    [:google, :yahoo, :geocoder_ca, :freegeoip]
-  end
-
   ##
   # Does the given value look like an IP address?
   #

data/test/fixtures/bing_madison_square_garden.json

@@ -0,0 +1,40 @@
+{
+   "authenticationResultCode":"ValidCredentials",
+   "brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png",
+   "copyright":"Copyright © 2011 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
+   "resourceSets":[
+      {
+         "estimatedTotal":1,
+         "resources":[
+            {
+               "__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",
+               "bbox":[
+                  40.744944289326668,
+                  -74.002353921532631,
+                  40.755675807595253,
+                  -73.983625397086143
+               ],
+               "name":"Madison Square Garden, NY",
+               "point":{
+                  "type":"Point",
+                  "coordinates":[
+                     40.75031,
+                     -73.99299
+                  ]
+               },
+               "address":{
+                  "adminDistrict":"NY",
+                  "countryRegion":"United States",
+                  "formattedAddress":"Madison Square Garden, NY",
+                  "locality":"New York"
+               },
+               "confidence":"High",
+               "entityType":"Stadium"
+            }
+         ]
+      }
+   ],
+   "statusCode":200,
+   "statusDescription":"OK",
+   "traceId":"55094ee53c8d45e789794014666328cd|CH1M001466|02.00.82.2800|CH1MSNVM001396, CH1MSNVM001370, CH1MSNVM001397"
+}

data/test/fixtures/bing_no_results.json

@@ -0,0 +1,16 @@
+{
+   "authenticationResultCode":"ValidCredentials",
+   "brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png",
+   "copyright":"Copyright © 2011 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
+   "resourceSets":[
+      {
+         "estimatedTotal":0,
+         "resources":[
+
+         ]
+      }
+   ],
+   "statusCode":200,
+   "statusDescription":"OK",
+   "traceId":"907b76a307bc49129a489de3d4c992ea|CH1M001463|02.00.82.2800|CH1MSNVM001383, CH1MSNVM001358, CH1MSNVM001397"
+}

data/test/fixtures/bing_reverse.json

@@ -0,0 +1,42 @@
+{
+   "authenticationResultCode":"ValidCredentials",
+   "brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png",
+   "copyright":"Copyright © 2011 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
+   "resourceSets":[
+      {
+         "estimatedTotal":1,
+         "resources":[
+            {
+               "__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",
+               "bbox":[
+                  45.419835111675845,
+                  -75.683656128790716,
+                  45.4275605468172,
+                  -75.66898098334994
+               ],
+               "name":"291 Rue Somerset E, Ottawa, ON, K1N",
+               "point":{
+                  "type":"Point",
+                  "coordinates":[
+                     45.423697829246521,
+                     -75.676318556070328
+                  ]
+               },
+               "address":{
+                  "addressLine":"291 Rue Somerset E",
+                  "adminDistrict":"ON",
+                  "countryRegion":"Canada",
+                  "formattedAddress":"291 Rue Somerset E, Ottawa, ON, K1N",
+                  "locality":"Ottawa",
+                  "postalCode":"K1N"
+               },
+               "confidence":"Medium",
+               "entityType":"Address"
+            }
+         ]
+      }
+   ],
+   "statusCode":200,
+   "statusDescription":"OK",
+   "traceId":"27bd5ed659e64ba6970c4144f1d4ea94|CH1M001470|02.00.82.2800|CH1MSNVM001396, CH1MSNVM001374"
+}

data/test/fixtures/yandex_invalid_key.json

@@ -0,0 +1 @@
+{"error":{"status":401,"message":"invalid key"}}

data/test/fixtures/yandex_kremlin.json

@@ -0,0 +1,48 @@
+{
+    "response": {
+        "GeoObjectCollection": {
+            "metaDataProperty": {
+                "GeocoderResponseMetaData": {
+                    "request": "Кремль, Moscow, Russia",
+                    "found": "1",
+                    "results": "10"
+                }
+            },
+            "featureMember": [
+                {
+                    "GeoObject": {
+                        "metaDataProperty": {
+                            "GeocoderMetaData": {
+                                "kind": "vegetation",
+                                "text": "Россия, Москва, Московский Кремль",
+                                "precision": "other",
+                                "AddressDetails": {
+                                    "Country": {
+                                        "CountryNameCode": "RU",
+                                        "CountryName": "Россия",
+                                        "Locality": {
+                                            "LocalityName": "Москва",
+                                            "Premise": {
+                                                "PremiseName": "Московский Кремль"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "name": "Московский Кремль",
+                        "boundedBy": {
+                            "Envelope": {
+                                "lowerCorner": "37.584182 55.733361",
+                                "upperCorner": "37.650064 55.770517"
+                            }
+                        },
+                        "Point": {
+                            "pos": "37.617123 55.751943"
+                        }
+                    }
+                }
+            ]
+        }
+    }
+}