geocoder 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e80b63580339ffae3893ed71c9cb97081c2b63eb
-  data.tar.gz: a133f7574566f3dccca311af4cac43a9e661533a
+  metadata.gz: d961c40e5dd577d90ddac243ccb32889ef88414e
+  data.tar.gz: 275e6174c8aa69f413e5fea4cda24c92110fcc49
 SHA512:
-  metadata.gz: b1302d7eabd3c367075ae4af684833e9cbb5af3dcce856716ece5bbb5eba4933fc001235b2638861943362678a6187a029c2f6184f285ab4ed525b2d68b9eca4
-  data.tar.gz: 94690e53ca9f0b17f0b56a96b2eb4184c5fe96f2ee769eefc1f5f6ecc07c7a334d9fa6cf6a5ef3f986771c5aeaeae1c8566d21b2fbbaebf4c75e6b62a963836f
+  metadata.gz: 56be16e5480d37be9acfe3b5b7014ac218c11d82f9a559bd5047e1a93e6a0401230fb66d303d949d3d297464c101f18ecb8dc258395230f76641e195f8be982d
+  data.tar.gz: 881e348fa2484ee731b3c0b7c53564c9ce6413d7772e9fe6e5bfa9501fae4162e95f3d08b0c033016c50cd39b2d9a70b855d17f071d83a83f8d5cf1539c6e17f

data/CHANGELOG.md

@@ -3,6 +3,15 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.2.8 (2015 Mar 21)
+-------------------
+* Add :maxmind_geoip2 lookup (thanks github.com/TrangPham).
+* Add ability to force/specify query type (street or IP address) (thanks github.com/TrangPham).
+* Add :basic_auth configuration (thanks github.com/TrangPham).
+* Add `paranoid_location` method for Rails controllers (thanks github.com/edslocomb).
+* Add :logger configuration (thanks github.com/TrangPham).
+* Improve error condition handling with Bing (thanks github.com/TrangPham).
+
 1.2.7 (2015 Jan 24)
 -------------------
 * DROP SUPPORT for Ruby 1.9.2.
@@ -14,7 +23,6 @@ Major changes to Geocoder for each release. Please see the Git log for complete
 * Add ability to raise exception when response parsing fails (thanks github.com/spiderpug).
 * Fix double-loading of Railtie (thanks github.com/wfleming and zhouguangming).
 
-
 1.2.6 (2014 Nov 8)
 ------------------
 * Add :geoip2 lookup (thanks github.com/ChristianHoj).

data/README.md

@@ -1,7 +1,9 @@
 Geocoder
 ========
 
-Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding (by street or IP address), reverse geocoding (find street address based on given coordinates), and distance queries. It's as simple as calling `geocode` on your objects, and then using a scope like `Venue.near("Billings, MT")`.
+Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding (by street or IP address), reverse geocoding (finding street address based on given coordinates), and distance queries. It's as simple as calling `geocode` on your objects, and then using a scope like `Venue.near("Billings, MT")`.
+
+_Please note that this README is for the current `HEAD` and may document features not present in the latest gem release. For this reason, you may want to instead view the README for your particular version._
 
 
 Compatibility
@@ -123,12 +125,14 @@ The exact code will vary depending on the method you use for your geocodable str
 Request Geocoding by IP Address
 -------------------------------
 
-Geocoder adds a `location` method to the standard `Rack::Request` object so you can easily look up the location of any HTTP request by IP address. For example, in a Rails controller or a Sinatra app:
+Geocoder adds `location` and `safe_location` methods to the standard `Rack::Request` object so you can easily look up the location of any HTTP request by IP address. For example, in a Rails controller or a Sinatra app:
 
     # returns Geocoder::Result object
     result = request.location
 
-Note that this will usually return `nil` in your test and development environments because things like "localhost" and "0.0.0.0" are not an Internet IP addresses.
+**The `location` method is vulnerable to trivial IP address spoofing via HTTP headers.**  If that's a problem for your application, use `safe_location` instead, but be aware that `safe_location` will *not* try to trace a request's originating IP through proxy headers; you will instead get the location of the last proxy the request passed through, if any (excepting any proxies you have explicitly whitelisted in your Rack config).
+
+Note that these methods will usually return `nil` in your test and development environments because things like "localhost" and "0.0.0.0" are not an Internet IP addresses.
 
 See _Advanced Geocoding_ below for more information about `Geocoder::Result` objects.
 
@@ -212,11 +216,6 @@ You are not stuck with using the `latitude` and `longitude` database column name
     geocoded_by :address, :latitude  => :lat, :longitude => :lon # ActiveRecord
     geocoded_by :address, :coordinates => :coords                # MongoDB
 
-This means you can geocode multiple addresses as well:
-
-    geocoded_by :start_address, latitude: :start_latitude, longitude: :start_longitude
-    geocoded_by :end_address, latitude: :end_latitude, longitude: :end_longitude
-
 The `address` method can return any string you'd use to search Google Maps. For example, any of the following are acceptable:
 
 * "714 Green St, Big Town, MO"
@@ -304,7 +303,7 @@ Every `Geocoder::Result` object, `result`, provides the following data:
 * `result.country` - string
 * `result.country_code` - string
 
-If you're familiar with the results returned by the geocoding service you're using you can access even more data, but you'll need to be familiar with the particular `Geocoder::Result` object you're using and the structure of your geocoding service's responses. (See below for links to geocoding service documentation.)
+If you're familiar with the results returned by the geocoding service you're using you can access even more data (call the `#data` method of any Geocoder::Result object to get the full parsed response), but you'll need to be familiar with the particular `Geocoder::Result` object you're using and the structure of your geocoding service's responses. (See below for links to geocoding service documentation.)
 
 
 Geocoding Service ("Lookup") Configuration
@@ -653,18 +652,33 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 * **Terms of Service**: ?
 * **Limitations**: ?
 
-#### MaxMind Web Services (`:maxmind`)
+#### MaxMind Legacy Web Services (`:maxmind`)
 
 * **API key**: required
 * **Quota**: Request Packs can be purchased
 * **Region**: world
 * **SSL support**: yes
 * **Languages**: English
-* **Documentation**: http://www.maxmind.com/app/web_services
+* **Documentation**: http://dev.maxmind.com/geoip/legacy/web-services/
 * **Terms of Service**: ?
 * **Limitations**: ?
 * **Notes**: You must specify which MaxMind service you are using in your configuration. For example: `Geocoder.configure(:maxmind => {:service => :omni})`.
 
+#### Baidu IP (`:baidu_ip`)
+
+* **API key**: required
+* **Quota**: No quota limits for geocoding
+* **Region**: China
+* **SSL support**: no
+* **Languages**: Chinese (Simplified)
+* **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm
+* **Terms of Service**: http://developer.baidu.com/map/law.htm
+* **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013
+* **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu_ip, :api_key => "your_api_key")`.
+
+
+### IP Address Local Database Services
+
 #### MaxMind Local (`:maxmind_local`) - EXPERIMENTAL
 
 This lookup provides methods for geocoding IP addresses without making a call to a remote API (improves speed and availability). It works, but support is new and should not be considered production-ready. Please [report any bugs](https://github.com/alexreisner/geocoder/issues) you encounter.
@@ -697,23 +711,11 @@ You can generate ActiveRecord migrations and download and import data via provid
 
 You can replace `city` with `country` in any of the above tasks, generators, and configurations.
 
-#### Baidu IP (`:baidu_ip`)
-
-* **API key**: required
-* **Quota**: No quota limits for geocoding
-* **Region**: China
-* **SSL support**: no
-* **Languages**: Chinese (Simplified)
-* **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm
-* **Terms of Service**: http://developer.baidu.com/map/law.htm
-* **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013
-* **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu_ip, :api_key => "your_api_key")`.
-
 #### GeoLite2 (`:geoip2`)
 
 This lookup provides methods for geocoding IP addresses without making a call to a remote API (improves speed and availability). It works, but support is new and should not be considered production-ready. Please [report any bugs](https://github.com/alexreisner/geocoder/issues) you encounter.
 
-* **API key**: none (requires a GeoIP2 or free GeoLite2 City or Country binary database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/geoip2/geoip2/))
+* **API key**: none (requires a GeoIP2 or free GeoLite2 City or Country binary database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/geoip2/))
 * **Quota**: none
 * **Region**: world
 * **SSL support**: N/A
@@ -977,7 +979,7 @@ http://github.com/alexreisner/geocoder_test
 Error Handling
 --------------
 
-By default Geocoder will rescue any exceptions raised by calls to a geocoding service and return an empty array (using warn() to inform you of the error). You can override this on a per-exception basis, and also have Geocoder raise its own exceptions for certain events (eg: API quota exceeded) by using the `:always_raise` option:
+By default Geocoder will rescue any exceptions raised by calls to a geocoding service and return an empty array. You can override this on a per-exception basis, and also have Geocoder raise its own exceptions for certain events (eg: API quota exceeded) by using the `:always_raise` option:
 
     Geocoder.configure(:always_raise => [SocketError, TimeoutError])
 
@@ -993,8 +995,9 @@ The raise-able exceptions are:
     Geocoder::RequestDenied
     Geocoder::InvalidRequest
     Geocoder::InvalidApiKey
+    Geocoder::ServiceUnavailable
 
-Note that not all lookups support all exceptions.
+Note that only a few of the above exceptions are raised by any given lookup, so there's no guarantee if you configure Geocoder to raise `ServiceUnavailable` that it will actually be raised under those conditions (because most APIs don't return 503 when they should; you may get a `TimeoutError` instead). Please see the source code for your particular lookup for details.
 
 
 Troubleshooting
@@ -1034,7 +1037,7 @@ Reporting Issues
 
 When reporting an issue, please list the version of Geocoder you are using and any relevant information about your application (Rails version, database type and version, etc). Also avoid vague language like "it doesn't work." Please describe as specifically as you can what behavior your are actually seeing (eg: an error message? a nil return value?).
 
-Please DO NOT use GitHub issues to ask questions about how to use Geocoder. Sites like StackOverflow are a better forum for such discussions.
+Please DO NOT use GitHub issues to ask questions about how to use Geocoder. Sites like [StackOverflow](http://www.stackoverflow.com/) are a better forum for such discussions.
 
 
 ### Known Issue
@@ -1069,4 +1072,4 @@ Contributions are welcome via pull requests on Github. Please respect the follow
 * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
 
 
-Copyright (c) 2009-12 Alex Reisner, released under the MIT license
+Copyright (c) 2009-15 Alex Reisner, released under the MIT license

data/examples/reverse_geocode_job.rb

@@ -0,0 +1,40 @@
+# This class implements an ActiveJob job for performing reverse-geocoding
+# asynchronously. Example usage:
+
+# if @location.save && @location.address.blank?
+#   ReverseGeocodeJob.perform_later(@location)
+# end
+
+# Be sure to configure the queue adapter in config/application.rb:
+# config.active_job.queue_adapter = :sidekiq
+
+# You can read the Rails docs for more information on configuring ActiveJob:
+# http://edgeguides.rubyonrails.org/active_job_basics.html
+
+class ReverseGeocodeJob < ActiveJob::Base
+  queue_as :high
+
+  def perform(location)
+    address = address(location)
+
+    if address.present?
+      location.update(address: address)
+    end
+  end
+
+  private
+
+  def address(location)
+    Geocoder.address(location.coordinates)
+  rescue => exception
+    MonitoringService.notify(exception, location: { id: location.id })
+
+    if retryable?(exception)
+      raise exception
+    end
+  end
+
+  def retryable?(exception)
+    exception.is_a?(TimeoutError) || exception.is_a?(SocketError)
+  end
+end

data/lib/geocoder.rb

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

data/lib/geocoder/configuration.rb

@@ -55,7 +55,9 @@ module Geocoder
       :cache_prefix,
       :always_raise,
       :units,
-      :distances
+      :distances,
+      :basic_auth,
+      :logger
     ]
 
     attr_accessor :data
@@ -96,6 +98,8 @@ module Geocoder
       @data[:api_key]      = nil         # API key for geocoding service
       @data[:cache]        = nil         # cache object (must respond to #[], #[]=, and #keys)
       @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
 
       # exceptions that should not be rescued by default
       # (if you want to implement custom error handling);

data/lib/geocoder/exceptions.rb

@@ -26,4 +26,7 @@ module Geocoder
   class InvalidApiKey < Error
   end
 
+  class ServiceUnavailable < Error
+  end
+
 end

data/lib/geocoder/ip_address.rb

@@ -1,3 +1,4 @@
+require 'resolv'
 module Geocoder
   class IpAddress < String
 
@@ -6,16 +7,7 @@ module Geocoder
     end
 
     def valid?
-      ipregex = %r{
-        \A(                                     # String Starts
-        ((::ffff:)?((\d{1,3})\.){3}\d{1,3})     # Check for IPv4
-        |                                       # .... Or
-        (\S+?(:\S+?){6}\S+)                     # Check for IPv6
-        |                                       # .... Or
-        (::1)                                   # IPv6 loopback
-        )\z                                     
-      }x
-      !!self.match(ipregex)
+      !!((self =~ Resolv::IPv4::Regex) || (self =~ Resolv::IPv6::Regex))
     end
   end
 end

data/lib/geocoder/logger.rb

@@ -0,0 +1,55 @@
+require 'logger'
+
+module Geocoder
+
+  def self.log(level, message)
+    Logger.instance.log(level, message)
+  end
+
+  class Logger
+    include Singleton
+
+    SEVERITY = {
+      debug: ::Logger::DEBUG,
+      info: ::Logger::INFO,
+      warn: ::Logger::WARN,
+      error: ::Logger::ERROR,
+      fatal: ::Logger::FATAL
+    }
+
+    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)
+      else
+        raise Geocoder::ConfigurationError, "Please specify valid logger for Geocoder. " +
+        "Logger specified must be :kernel or must respond to `add(level, message)`."
+      end
+      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
+      end
+    end
+
+    def valid_level?(level)
+      [:debug, :info, :warn, :error, :fatal].include? level
+    end
+  end
+end

data/lib/geocoder/lookup.rb

@@ -56,7 +56,8 @@ module Geocoder
         :maxmind,
         :maxmind_local,
         :telize,
-        :pointpin
+        :pointpin,
+        :maxmind_geoip2
       ]
     end
 

data/lib/geocoder/lookups/baidu.rb

@@ -25,19 +25,19 @@ module Geocoder::Lookup
         return [doc['result']] unless doc['result'].blank?
       when 1, 3, 4
         raise_error(Geocoder::Error, "server error.") ||
-          warn("Baidu Geocoding API error: server error.")
+          Geocoder.log(:warn, "Baidu Geocoding API error: server error.")
       when 2
         raise_error(Geocoder::InvalidRequest, "invalid request.") ||
-          warn("Baidu Geocoding API error: invalid request.")
+          Geocoder.log(:warn, "Baidu Geocoding API error: invalid request.")
       when 5
         raise_error(Geocoder::InvalidApiKey, "invalid api key") ||
-          warn("Baidu Geocoding API error: invalid api key.")
+          Geocoder.log(:warn, "Baidu Geocoding API error: invalid api key.")
       when 101, 102, 200..299
         raise_error(Geocoder::RequestDenied, "request denied") ||
-          warn("Baidu Geocoding API error: request denied.")
+          Geocoder.log(:warn, "Baidu Geocoding API error: request denied.")
       when 300..399
         raise_error(Geocoder::OverQueryLimitError, "over query limit.") ||
-          warn("Baidu Geocoding API error: over query limit.")
+          Geocoder.log(:warn, "Baidu Geocoding API error: over query limit.")
       end
       return []
     end

data/lib/geocoder/lookups/baidu_ip.rb

@@ -25,19 +25,19 @@ module Geocoder::Lookup
         return [doc['content']] unless doc['content'].blank?
       when 1, 3, 4
         raise_error(Geocoder::Error, "server error.") ||
-          warn("Baidu IP Geocoding API error: server error.")
+          Geocoder.log(:warn, "Baidu IP Geocoding API error: server error.")
       when 2
         raise_error(Geocoder::InvalidRequest, "invalid request.") ||
-          warn("Baidu IP Geocoding API error: invalid request.")
+          Geocoder.log(:warn, "Baidu IP Geocoding API error: invalid request.")
       when 5
         raise_error(Geocoder::InvalidApiKey, "invalid api key.") ||
-          warn("Baidu IP Geocoding API error: invalid api key.")
+          Geocoder.log(:warn, "Baidu IP Geocoding API error: invalid api key.")
       when 101, 102, 200..299
         raise_error(Geocoder::RequestDenied, "request denied.") ||
-          warn("Baidu IP Geocoding API error: request denied.")
+          Geocoder.log(:warn, "Baidu IP Geocoding API error: request denied.")
       when 300..399
         raise_error(Geocoder::OverQueryLimitError, "over query limit") ||
-          warn("Baidu IP Geocoding API error: over query limit.")
+          Geocoder.log(:warn, "Baidu IP Geocoding API error: over query limit.")
       end
       return []
     end

data/lib/geocoder/lookups/base.rb

@@ -168,12 +168,12 @@ module Geocoder
       def fetch_data(query)
         parse_raw_data fetch_raw_data(query)
       rescue SocketError => err
-        raise_error(err) or warn "Geocoding API connection cannot be established."
+        raise_error(err) or Geocoder.log(:warn, "Geocoding API connection cannot be established.")
       rescue Errno::ECONNREFUSED => err
-        raise_error(err) or warn "Geocoding API connection refused."
+        raise_error(err) or Geocoder.log(:warn, "Geocoding API connection refused.")
       rescue TimeoutError => err
-        raise_error(err) or warn "Geocoding API not responding fast enough " +
-          "(use Geocoder.configure(:timeout => ...) to set limit)."
+        raise_error(err) or Geocoder.log(:warn, "Geocoding API not responding fast enough " +
+          "(use Geocoder.configure(:timeout => ...) to set limit).")
       end
 
       def parse_json(data)
@@ -183,7 +183,7 @@ module Geocoder
           JSON.parse(data)
         end
       rescue => err
-        raise_error(ResponseParseError.new(data)) or warn "Geocoding API's response was not valid JSON."
+        raise_error(ResponseParseError.new(data)) or Geocoder.log(:warn, "Geocoding API's response was not valid JSON.")
       end
 
       ##
@@ -242,16 +242,19 @@ module Geocoder
       def check_response_for_errors!(response)
         if response.code.to_i == 400
           raise_error(Geocoder::InvalidRequest) ||
-            warn("Geocoding API error: 400 Bad Request")
+            Geocoder.log(:warn, "Geocoding API error: 400 Bad Request")
         elsif response.code.to_i == 401
           raise_error(Geocoder::RequestDenied) ||
-            warn("Geocoding API error: 401 Unauthorized")
+            Geocoder.log(:warn, "Geocoding API error: 401 Unauthorized")
         elsif response.code.to_i == 402
           raise_error(Geocoder::OverQueryLimitError) ||
-            warn("Geocoding API error: 402 Payment Required")
+            Geocoder.log(:warn, "Geocoding API error: 402 Payment Required")
         elsif response.code.to_i == 429
           raise_error(Geocoder::OverQueryLimitError) ||
-            warn("Geocoding API error: 429 Too Many Requests")
+            Geocoder.log(:warn, "Geocoding API error: 429 Too Many Requests")
+        elsif response.code.to_i == 503
+          raise_error(Geocoder::ServiceUnavailable) ||
+            Geocoder.log(:warn, "Geocoding API error: 503 Service Unavailable")
         end
       end
 
@@ -262,13 +265,15 @@ module Geocoder
       def make_api_request(query)
         timeout(configuration.timeout) do
           uri = URI.parse(query_url(query))
-          args = [uri.host, uri.port]
-          args = args.push(uri.user, uri.password) unless uri.user.nil? or uri.password.nil?
-          opts = {}
-          opts[:use_ssl] = use_ssl?
-
-          http_client.start(*args, opts) do |client|
-            client.get(uri.request_uri, configuration.http_headers)
+          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)
           end
         end
       end