geocoder 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69826a3c50884c70a7a937f80f1280f234687e2f
-  data.tar.gz: 4bcdee80b4db4db6c7efbd2886d9fab96b4976bf
+  metadata.gz: 80ea51ef32a14fb44a364344b6475fecbf9713df
+  data.tar.gz: 1a6900cbcfc8cd21151da45fc55f94805c6adc51
 SHA512:
-  metadata.gz: c9d0cbaa046ebc593590340937a29b687e98107ea87606b4fc10ab3bd000376471f4b940f3848bd68a75e1e8f273843e29278ca4449e8ce5219a46ed9daf468e
-  data.tar.gz: ed245fd8affec37d6f60f54bedf3fb35a704cf6f4f134537bdcac5356bd245c64df0f707b690990585deae794d24bf30c16aaa0f754ee52b8a09c2b79236a509
+  metadata.gz: ac94efc831b73cb9639fa49fdc7957d95de7d3b8250b4477744141267d30ead2315397c5ffe9b73df17bd86a51bdebf736a23bf46dd2f552d16e215329dc0e01
+  data.tar.gz: 22bc25f4cd0c191ed23df83716efa803ab4d0dd21c12717dbe6dfee99917bdf21850e4ec6e2c4e0a1f79e57d1d75b4154d3bccfb1f4c1f490358d68ce50d9d1e

data/CHANGELOG.md

@@ -3,6 +3,13 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.2.10 (2015 Aug 7)
+-----------------
+* Force Yandex to use HTTPS (thanks github.com/donbobka).
+* Force :google to use HTTPS if API key set.
+* Fix out-of-the-box verbosity issues (GH #881).
+* Deprecate .near and #nearbys for MongoDB-backed models.
+
 1.2.9 (2015 Jun 12)
 -------------------
 * Don't cache unsuccessful responses from Bing (thanks github.com/peteb).

data/README.md

@@ -381,19 +381,26 @@ The above combines global and service-specific options and could be useful if yo
 
 The following is a comparison of the supported geocoding APIs. The "Limitations" listed for each are a very brief and incomplete summary of some special limitations beyond basic data source attribution. Please read the official Terms of Service for a service before using it.
 
-#### Google (`:google`, `:google_premier`)
+#### Google (`:google`)
 
-* **API key**: required for Premier, optional for the free service (if using the free service with API key, https is required. Add `:use_https  => true` to `Geocoder.configure`)
-* **Key signup**: https://developers.google.com/maps/documentation/business/
-* **Quota**: 2,500 requests/day, 100,000 with Google Maps API Premier
+* **API key**: optional, but quota is higher if key is used (use of key requires HTTPS so be sure to set: `:use_https => true` in `Geocoder.configure`)
+* **Key signup**: https://console.developers.google.com//flows/enableapi?apiid=geocoding_backend&keyType=SERVER_SIDE
+* **Quota**: 2,500 requests/24 hrs, 5 requests/second
 * **Region**: world
-* **SSL support**: yes
-* **Languages**: ar, eu, bg, bn, ca, cs, da, de, el, en, en-AU, en-GB, es, eu, fa, fi, fil, fr, gl, gu, hi, hr, hu, id, it, iw, ja, kn, ko, lt, lv, ml, mr, nl, no, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, tl, ta, te, th, tr, uk, vi, zh-CN, zh-TW (see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1)
+* **SSL support**: yes (required if key is used)
+* **Languages**: see https://developers.google.com/maps/faq#languagesupport
 * **Extra options**: `:bounds` - pass SW and NE coordinates as an array of two arrays to bias results towards a viewport
-* **Documentation**: http://code.google.com/apis/maps/documentation/geocoding/#JSON
+* **Documentation**: https://developers.google.com/maps/documentation/geocoding/intro
 * **Terms of Service**: http://code.google.com/apis/maps/terms.html#section_10_12
 * **Limitations**: "You must not use or display the Content without a corresponding Google map, unless you are explicitly permitted to do so in the Maps APIs Documentation, or through written permission from Google." "You must not pre-fetch, cache, or store any Content, except that you may store: (i) limited amounts of Content for the purpose of improving the performance of your Maps API Implementation..."
-* **Notes**: To use Google Premier set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`.
+
+#### Google Maps API for Work (`:google_premier`)
+
+Similar to `:google`, with the following differences:
+
+* **API key**: required, plus client and channel (set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`)
+* **Key signup**: https://developers.google.com/maps/documentation/business/
+* **Quota**: 100,000 requests/24 hrs, 10 requests/second
 
 #### Google Places Details (`:google_places_details`)
 
@@ -442,7 +449,7 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 * **Languages**: ?
 * **Documentation**: http://wiki.openstreetmap.org/wiki/Nominatim
 * **Terms of Service**: http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy
-* **Limitations**: Please limit request rate to 1 per second and include your contact information in User-Agent headers (eg: `Geocoder.configure(:http_headers => { "User-Agent" => "your contact info" })`). Data licensed under CC-BY-SA (you must provide attribution).
+* **Limitations**: Please limit request rate to 1 per second and include your contact information in User-Agent headers (eg: `Geocoder.configure(:http_headers => { "User-Agent" => "your contact info" })`). [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright)
 
 #### OpenCageData (`:opencagedata`)
 
@@ -453,14 +460,14 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 * **SSL support**: yes
 * **Languages**: worldwide
 * **Documentation**: http://geocoder.opencagedata.com/api.html
-* **Limitations**: Data licensed under CC-BY-SA or (you must provide attribution).
+* **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright)
 
 #### Yandex (`:yandex`)
 
 * **API key**: none
 * **Quota**: 25000 requests / day
 * **Region**: world
-* **SSL support**: no
+* **SSL support**: HTTPS only
 * **Languages**: Russian, Belarusian, Ukrainian, English, Turkish (only for maps of Turkey)
 * **Documentation**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml
 * **Terms of Service**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml#rules
@@ -567,13 +574,13 @@ Data Science Toolkit provides an API whose reponse format is like Google's but w
 #### Geocodio (`:geocodio`)
 
 * **API key**: required
-* **Quota**: 2,500 free requests/day then purchase $.001 for each
+* **Quota**: 2,500 free requests/day then purchase $.001 for each, also has volume pricing and plans
 * **Region**: US
-* **SSL support**: no
+* **SSL support**: yes
 * **Languages**: en
 * **Documentation**: http://geocod.io/docs
 * **Terms of Service**: http://geocod.io/terms-of-use
-* **Limitations**: ?
+* **Limitations**: No restrictions on use
 
 #### SmartyStreets (`:smarty_streets`)
 

data/lib/geocoder.rb

@@ -1,5 +1,6 @@
 require "geocoder/configuration"
 require "geocoder/logger"
+require "geocoder/kernel_logger"
 require "geocoder/query"
 require "geocoder/calculations"
 require "geocoder/exceptions"

data/lib/geocoder/configuration.rb

@@ -57,7 +57,8 @@ module Geocoder
       :units,
       :distances,
       :basic_auth,
-      :logger
+      :logger,
+      :kernel_logger_level
     ]
 
     attr_accessor :data
@@ -100,6 +101,7 @@ module Geocoder
       @data[:cache_prefix] = "geocoder:" # prefix (string) to use for all cache keys
       @data[:basic_auth]   = {}          # user and password for basic auth ({:user => "user", :password => "password"})
       @data[:logger]       = :kernel     # :kernel or Logger instance
+      @data[:kernel_logger_level] = ::Logger::WARN # log level, if kernel logger is used
 
       # exceptions that should not be rescued by default
       # (if you want to implement custom error handling);

data/lib/geocoder/exceptions.rb

@@ -29,4 +29,7 @@ module Geocoder
   class ServiceUnavailable < Error
   end
 
+  class LookupTimeout < ::Timeout::Error
+  end
+
 end

data/lib/geocoder/kernel_logger.rb

@@ -0,0 +1,25 @@
+module Geocoder
+  class KernelLogger
+    include Singleton
+
+    def add(level, message)
+      return unless log_message_at_level?(level)
+      case level
+        when ::Logger::DEBUG, ::Logger::INFO
+          puts message
+        when ::Logger::WARN
+          warn message
+        when ::Logger::ERROR
+          raise message
+        when ::Logger::FATAL
+          fail message
+      end
+    end
+
+    private # ----------------------------------------------------------------
+
+    def log_message_at_level?(level)
+      level >= Geocoder.config.kernel_logger_level
+    end
+  end
+end

data/lib/geocoder/logger.rb

@@ -18,14 +18,11 @@ module Geocoder
     }
 
     def log(level, message)
-      return nil unless valid_level?(level)
-
-      logger = Geocoder.config[:logger]
-
-      if logger == :kernel
-        kernel_log(level, message)
-      elsif logger.kind_of? ::Logger
-        logger.add(SEVERITY[level], message)
+      unless valid_level?(level)
+        raise StandardError, "Geocoder tried to log a message with an invalid log level."
+      end
+      if current_logger.respond_to? :add
+        current_logger.add(SEVERITY[level], message)
       else
         raise Geocoder::ConfigurationError, "Please specify valid logger for Geocoder. " +
         "Logger specified must be :kernel or must respond to `add(level, message)`."
@@ -33,23 +30,18 @@ module Geocoder
       nil
     end
 
-    private
-
-    def kernel_log(level, message)
-      case level
-      when :debug, :info
-        puts message
-      when :warn
-        warn message
-      when :error
-        raise message
-      when :fatal
-        fail message
+    private # ----------------------------------------------------------------
+
+    def current_logger
+      logger = Geocoder.config[:logger]
+      if logger == :kernel
+        logger = Geocoder::KernelLogger.instance
       end
+      logger
     end
 
     def valid_level?(level)
-      [:debug, :info, :warn, :error, :fatal].include? level
+      SEVERITY.keys.include?(level)
     end
   end
 end

data/lib/geocoder/lookups/baidu.rb

@@ -13,7 +13,7 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      "http://api.map.baidu.com/geocoder/v2/?" + url_query_string(query)
+      "#{protocol}://api.map.baidu.com/geocoder/v2/?" + url_query_string(query)
     end
 
     # HTTP only

data/lib/geocoder/lookups/baidu_ip.rb

@@ -13,7 +13,7 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      "http://api.map.baidu.com/location/ip?" + url_query_string(query)
+      "#{protocol}://api.map.baidu.com/location/ip?" + url_query_string(query)
     end
 
     # HTTP only

data/lib/geocoder/lookups/base.rb

@@ -271,20 +271,20 @@ module Geocoder
       # return the response object.
       #
       def make_api_request(query)
-        timeout(configuration.timeout) do
-          uri = URI.parse(query_url(query))
-          Geocoder.log(:debug, "Geocoder: HTTP request being made for #{uri.to_s}")
-          http_client.start(uri.host, uri.port, use_ssl: use_ssl?) do |client|
-            req = Net::HTTP::Get.new(uri.request_uri, configuration.http_headers)
-            if configuration.basic_auth[:user] and configuration.basic_auth[:password]
-              req.basic_auth(
-                configuration.basic_auth[:user],
-                configuration.basic_auth[:password]
-              )
-            end
-            client.request(req)
+        uri = URI.parse(query_url(query))
+        Geocoder.log(:debug, "Geocoder: HTTP request being made for #{uri.to_s}")
+        http_client.start(uri.host, uri.port, use_ssl: use_ssl?, open_timeout: configuration.timeout, read_timeout: configuration.timeout) do |client|
+          req = Net::HTTP::Get.new(uri.request_uri, configuration.http_headers)
+          if configuration.basic_auth[:user] and configuration.basic_auth[:password]
+            req.basic_auth(
+              configuration.basic_auth[:user],
+              configuration.basic_auth[:password]
+            )
           end
+          client.request(req)
         end
+      rescue Net::OpenTimeout, Net::ReadTimeout
+        raise Geocoder::LookupTimeout
       end
 
       def use_ssl?

data/lib/geocoder/lookups/geocoder_us.rb

@@ -8,11 +8,15 @@ module Geocoder::Lookup
       "Geocoder.us"
     end
 
+      def supported_protocols
+        [:http]
+      end
+
     def query_url(query)
       if configuration.api_key
-        "http://#{configuration.api_key}@geocoder.us/member/service/csv/geocode?" + url_query_string(query)
+        "#{protocol}://#{configuration.api_key}@geocoder.us/member/service/csv/geocode?" + url_query_string(query)
       else
-        "http://geocoder.us/service/csv/geocode?" + url_query_string(query)
+        "#{protocol}://geocoder.us/service/csv/geocode?" + url_query_string(query)
       end
     end
 

data/lib/geocoder/lookups/google.rb

@@ -12,6 +12,15 @@ module Geocoder::Lookup
       "http://maps.google.com/maps?q=#{coordinates.join(',')}"
     end
 
+    def supported_protocols
+      # Google requires HTTPS if an API key is used.
+      if configuration.api_key
+        [:https]
+      else
+        [:http, :https]
+      end
+    end
+
     def query_url(query)
       "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
     end

data/lib/geocoder/lookups/telize.rb

@@ -9,7 +9,7 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      "http://www.telize.com/geoip/#{query.sanitized_text}"
+      "#{protocol}://www.telize.com/geoip/#{query.sanitized_text}"
     end
 
     # currently doesn't support HTTPS

data/lib/geocoder/lookups/yandex.rb

@@ -15,6 +15,10 @@ module Geocoder::Lookup
     def query_url(query)
       "#{protocol}://geocode-maps.yandex.ru/1.x/?" + url_query_string(query)
     end
+    
+    def supported_protocols
+      [:https]
+    end
 
     private # ---------------------------------------------------------------
 

data/lib/geocoder/stores/active_record.rb

@@ -251,6 +251,17 @@ module Geocoder::Store
       end
     end
 
+    ##
+    # Get nearby geocoded objects.
+    # Takes the same options hash as the near class method (scope).
+    # Returns nil if the object is not geocoded.
+    #
+    def nearbys(radius = 20, options = {})
+      return nil unless geocoded?
+      options.merge!(:exclude => self) unless send(self.class.primary_key).nil?
+      self.class.near(self, radius, options)
+    end
+
     ##
     # Look up coordinates and assign to +latitude+ and +longitude+ attributes
     # (or other as specified in +geocoded_by+). Returns coordinates (array).

data/lib/geocoder/stores/base.rb

@@ -55,17 +55,6 @@ module Geocoder
           point, to_coordinates, options)
       end
 
-      ##
-      # Get nearby geocoded objects.
-      # Takes the same options hash as the near class method (scope).
-      # Returns nil if the object is not geocoded.
-      #
-      def nearbys(radius = 20, options = {})
-        return nil unless geocoded?
-        options.merge!(:exclude => self) unless send(self.class.primary_key).nil?
-        self.class.near(self, radius, options)
-      end
-
       ##
       # Look up coordinates and assign to +latitude+ and +longitude+ attributes
       # (or other as specified in +geocoded_by+). Returns coordinates (array).

data/lib/geocoder/stores/mongo_base.rb

@@ -13,6 +13,7 @@ module Geocoder::Store
         }
 
         scope :near, lambda{ |location, *args|
+          warn "DEPRECATION WARNING: The .near method will be removed for MongoDB-backed models in Geocoder 1.3.0. Please use MongoDB's built-in query language instead."
           coords  = Geocoder::Calculations.extract_coordinates(location)
 
           # no results if no lat/lon given
@@ -55,6 +56,18 @@ module Geocoder::Store
       coords.is_a?(Array) ? coords.reverse : []
     end
 
+    ##
+    # Get nearby geocoded objects.
+    # Takes the same options hash as the near class method (scope).
+    # Returns nil if the object is not geocoded.
+    #
+    def nearbys(radius = 20, options = {})
+      warn "DEPRECATION WARNING: The #nearbys method will be removed for MongoDB-backed models in Geocoder 1.3.0. Please use MongoDB's built-in query language instead."
+      return nil unless geocoded?
+      options.merge!(:exclude => self) unless send(self.class.primary_key).nil?
+      self.class.near(self, radius, options)
+    end
+
     ##
     # Look up coordinates and assign to +latitude+ and +longitude+ attributes
     # (or other as specified in +geocoded_by+). Returns coordinates (array).

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.2.9"
+  VERSION = "1.2.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies: []
 description: Provides object geocoding (by street or IP address), reverse geocoding
   (coordinates to street address), distance queries for ActiveRecord and Mongoid,
@@ -43,6 +43,7 @@ files:
 - lib/geocoder/configuration_hash.rb
 - lib/geocoder/exceptions.rb
 - lib/geocoder/ip_address.rb
+- lib/geocoder/kernel_logger.rb
 - lib/geocoder/logger.rb
 - lib/geocoder/lookup.rb
 - lib/geocoder/lookups/baidu.rb