geocoder 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d961c40e5dd577d90ddac243ccb32889ef88414e
-  data.tar.gz: 275e6174c8aa69f413e5fea4cda24c92110fcc49
+  metadata.gz: 69826a3c50884c70a7a937f80f1280f234687e2f
+  data.tar.gz: 4bcdee80b4db4db6c7efbd2886d9fab96b4976bf
 SHA512:
-  metadata.gz: 56be16e5480d37be9acfe3b5b7014ac218c11d82f9a559bd5047e1a93e6a0401230fb66d303d949d3d297464c101f18ecb8dc258395230f76641e195f8be982d
-  data.tar.gz: 881e348fa2484ee731b3c0b7c53564c9ce6413d7772e9fe6e5bfa9501fae4162e95f3d08b0c033016c50cd39b2d9a70b855d17f071d83a83f8d5cf1539c6e17f
+  metadata.gz: c9d0cbaa046ebc593590340937a29b687e98107ea87606b4fc10ab3bd000376471f4b940f3848bd68a75e1e8f273843e29278ca4449e8ce5219a46ed9daf468e
+  data.tar.gz: ed245fd8affec37d6f60f54bedf3fb35a704cf6f4f134537bdcac5356bd245c64df0f707b690990585deae794d24bf30c16aaa0f754ee52b8a09c2b79236a509

data/CHANGELOG.md

@@ -3,12 +3,19 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.2.9 (2015 Jun 12)
+-------------------
+* Don't cache unsuccessful responses from Bing (thanks github.com/peteb).
+* Show API response when not valid JSON.
+* Log each API request.
+* Force all SmartyStreets requests to use HTTPS.
+
 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 `safe_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).
 

data/README.md

@@ -163,9 +163,9 @@ Some utility methods are also available:
     Geocoder.coordinates("25 Main St, Cooperstown, NY")
      => [42.700149, -74.922767]
 
-    # distance (in miles) between Eiffel Tower and Empire State Building
+    # distance between Eiffel Tower and Empire State Building
     Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
-     => 3619.77359999382
+     => 3619.77359999382 # in configured units (default miles)
 
     # find the geographic center (aka center of gravity) of objects or points
     Geocoder::Calculations.geographic_center([city1, city2, [40.22,-73.99], city4])
@@ -424,8 +424,8 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 #### Bing (`:bing`)
 
 * **API key**: required (set `Geocoder.configure(:lookup => :bing, :api_key => key)`)
-* **Key signup**: http://www.bingmapsportal.com
-* **Quota**: 50,000 requests/24 hrs
+* **Key signup**: https://www.microsoft.com/maps/create-a-bing-maps-key.aspx
+* **Quota**: 50,0000 requests/day (Windows app), 125,000 requests/year (non-Windows app)
 * **Region**: world
 * **SSL support**: no
 * **Languages**: ?
@@ -494,16 +494,15 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 * **API key**: required
 * **Key signup**: http://developer.mapquest.com/web/products/open
 * **Quota**: ?
-* **HTTP Headers**: in order to use the licensed API you can configure the http_headers to include a referer as so:
+* **HTTP Headers**: when using the licensed API you can specify a referer like so:
     `Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })`
-  You can also allow a blank referer from the API management console via mapquest but it is potentially a security risk that someone else could use your API key from another domain.
 * **Region**: world
 * **SSL support**: no
 * **Languages**: English
 * **Documentation**: http://www.mapquestapi.com/geocoding/
 * **Terms of Service**: http://info.mapquest.com/terms-of-use/
 * **Limitations**: ?
-* **Notes**: You can specify the licensed API by setting: `Geocoder.configure(:mapquest => {:licensed => true})` (defaults to free "open" version)
+* **Notes**: You can use the open (non-licensed) API by setting: `Geocoder.configure(:mapquest => {:open => true})` (defaults to licensed version)
 
 #### Ovi/Nokia (`:ovi`)
 
@@ -518,7 +517,7 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 
 #### Here/Nokia (`:here`)
 
-* **API key**: required
+* **API key**: required (set `Geocoder.configure(:api_key => [app_id, app_code])`)
 * **Quota**: Depending on the API key
 * **Region**: world
 * **SSL support**: yes
@@ -581,7 +580,7 @@ Data Science Toolkit provides an API whose reponse format is like Google's but w
 * **API key**: requires auth_id and auth_token (set `Geocoder.configure(:api_key => [id, token])`)
 * **Quota**: 10,000 free, 250/month then purchase at sliding scale.
 * **Region**: US
-* **SSL support**: yes
+* **SSL support**: yes (required)
 * **Languages**: en
 * **Documentation**: http://smartystreets.com/kb/liveaddress-api/rest-endpoint
 * **Terms of Service**: http://smartystreets.com/legal/terms-of-service
@@ -867,7 +866,7 @@ When writing tests for an app that uses Geocoder it may be useful to avoid netwo
       ]
     )
 
-Now, any time Geocoder looks up "New York, NY" its results array will contain one result with the above attributes. You can also set a default stub:
+Now, any time Geocoder looks up "New York, NY" its results array will contain one result with the above attributes. You can also set a default stub, to be returned when no other stub is found for a given query:
 
     Geocoder.configure(:lookup => :test)
 
@@ -885,7 +884,6 @@ Now, any time Geocoder looks up "New York, NY" its results array will contain on
       ]
     )
 
-Any query that hasn't been explicitly stubbed will return that result.
 
 Command Line Interface
 ----------------------

data/lib/geocoder/lookups/baidu.rb

@@ -16,6 +16,11 @@ module Geocoder::Lookup
       "http://api.map.baidu.com/geocoder/v2/?" + url_query_string(query)
     end
 
+    # HTTP only
+    def supported_protocols
+      [:http]
+    end
+
     private # ---------------------------------------------------------------
 
     def results(query, reverse = false)
@@ -52,4 +57,3 @@ module Geocoder::Lookup
 
   end
 end
-

data/lib/geocoder/lookups/baidu_ip.rb

@@ -16,6 +16,11 @@ module Geocoder::Lookup
       "http://api.map.baidu.com/location/ip?" + url_query_string(query)
     end
 
+    # HTTP only
+    def supported_protocols
+      [:http]
+    end
+
     private # ---------------------------------------------------------------
 
     def results(query, reverse = false)

data/lib/geocoder/lookups/base.rb

@@ -86,6 +86,15 @@ module Geocoder
         @cache
       end
 
+      ##
+      # Array containing the protocols supported by the api.
+      # Should be set to [:http] if only HTTP is supported
+      # or [:https] if only HTTPS is supported.
+      #
+      def supported_protocols
+        [:http, :https]
+      end
+
       private # -------------------------------------------------------------
 
       ##
@@ -99,7 +108,6 @@ module Geocoder
       # Object used to make HTTP requests.
       #
       def http_client
-        protocol = "http#{'s' if use_ssl?}"
         proxy_name = "#{protocol}_proxy"
         if proxy = configuration.send(proxy_name)
           proxy_url = !!(proxy =~ /^#{protocol}/) ? proxy : protocol + '://' + proxy
@@ -183,7 +191,7 @@ module Geocoder
           JSON.parse(data)
         end
       rescue => err
-        raise_error(ResponseParseError.new(data)) or Geocoder.log(: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: #{data}")
       end
 
       ##
@@ -265,6 +273,7 @@ module Geocoder
       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]
@@ -279,7 +288,13 @@ module Geocoder
       end
 
       def use_ssl?
-        configuration.use_https
+        if supported_protocols == [:https]
+          true
+        elsif supported_protocols == [:http]
+          false
+        else
+          configuration.use_https
+        end
       end
 
       def check_api_key_configuration!(query)

data/lib/geocoder/lookups/bing.rb

@@ -58,15 +58,23 @@ module Geocoder::Lookup
 
     def check_response_for_errors!(response)
       super
-      if response['x-ms-bm-ws-info'].to_i == 1
-        # Occasionally, the servers processing service requests can be overloaded,
-        # and you may receive some responses that contain no results for queries that
-        # you would normally receive a result. To identify this situation,
-        # check the HTTP headers of the response. If the HTTP header X-MS-BM-WS-INFO is set to 1,
-        # it is best to wait a few seconds and try again.
+      if server_overloaded?(response)
         raise_error(Geocoder::ServiceUnavailable) ||
           Geocoder.log(:warn, "Bing Geocoding API error: Service Unavailable")
       end
     end
+
+    def valid_response?(response)
+      super(response) and not server_overloaded?(response)
+    end
+
+    def server_overloaded?(response)
+      # Occasionally, the servers processing service requests can be overloaded,
+      # and you may receive some responses that contain no results for queries that
+      # you would normally receive a result. To identify this situation,
+      # check the HTTP headers of the response. If the HTTP header X-MS-BM-WS-INFO is set to 1,
+      # it is best to wait a few seconds and try again.
+      response['x-ms-bm-ws-info'].to_i == 1
+    end
   end
 end

data/lib/geocoder/lookups/google_places_details.rb

@@ -12,8 +12,8 @@ module Geocoder
         ["key"]
       end
 
-      def use_ssl?
-        true
+      def supported_protocols
+        [:https]
       end
 
       def query_url(query)

data/lib/geocoder/lookups/here.rb

@@ -9,7 +9,7 @@ module Geocoder::Lookup
     end
 
     def required_api_key_parts
-      []
+      ["app_id", "app_code"]
     end
 
     def query_url(query)

data/lib/geocoder/lookups/mapquest.rb

@@ -15,8 +15,7 @@ module Geocoder::Lookup
 
     def query_url(query)
       domain = configuration[:open] ? "open" : "www"
-      version = configuration[:version] || 1
-      url = "#{protocol}://#{domain}.mapquestapi.com/geocoding/v#{version}/#{search_type(query)}?"
+      url = "#{protocol}://#{domain}.mapquestapi.com/geocoding/v1/#{search_type(query)}?"
       url + url_query_string(query)
     end
 

data/lib/geocoder/lookups/maxmind_geoip2.rb

@@ -8,10 +8,10 @@ module Geocoder::Lookup
       "MaxMind GeoIP2"
     end
 
-    def use_ssl?
-      # Maxmind's GeoIP2 Precision Services only supports HTTPS,
-      # otherwise a `404 Not Found` HTTP response will be returned
-      true
+    # Maxmind's GeoIP2 Precision Services only supports HTTPS,
+    # otherwise a `404 Not Found` HTTP response will be returned
+    def supported_protocols
+      [:https]
     end
 
     def query_url(query)

data/lib/geocoder/lookups/smarty_streets.rb

@@ -16,6 +16,11 @@ module Geocoder::Lookup
       "#{protocol}://api.smartystreets.com/#{path}?#{url_query_string(query)}"
     end
 
+    # required by API as of 26 March 2015
+    def supported_protocols
+      [:https]
+    end
+
     private # ---------------------------------------------------------------
 
     def zipcode_only?(query)

data/lib/geocoder/lookups/telize.rb

@@ -9,16 +9,16 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      #currently doesn't support HTTPS
       "http://www.telize.com/geoip/#{query.sanitized_text}"
     end
 
-    private # ---------------------------------------------------------------
-
-    def use_ssl?
-      false
+    # currently doesn't support HTTPS
+    def supported_protocols
+      [:http]
     end
 
+    private # ---------------------------------------------------------------
+
     def results(query)
       # don't look up a loopback address, just return the stored result
       return [reserved_result(query.text)] if query.loopback_ip_address?

data/lib/geocoder/models/mongo_base.rb

@@ -1,5 +1,3 @@
-require 'geocoder'
-
 module Geocoder
 
   ##

data/lib/geocoder/results/geoip2.rb

@@ -13,35 +13,35 @@ module Geocoder
       end
 
       def latitude
-        @data.fetch('location',{}).fetch('latitude',0.0)
+        data.fetch('location',{}).fetch('latitude',0.0)
       end
 
       def longitude
-        @data.fetch('location',{}).fetch('longitude',0.0)
+        data.fetch('location',{}).fetch('longitude',0.0)
       end
 
       def city
-        @data.fetch('city', {}).fetch('names', {}).fetch('en', '')
+        data.fetch('city', {}).fetch('names', {}).fetch('en', '')
       end
 
       def state
-        @data.fetch('subdivisions',[]).fetch(0,{}).fetch('names',{}).fetch('en','')
+        data.fetch('subdivisions',[]).fetch(0,{}).fetch('names',{}).fetch('en','')
       end
 
       def state_code
-        @data.fetch('subdivisions',[]).fetch(0,{}).fetch('iso_code','')
+        data.fetch('subdivisions',[]).fetch(0,{}).fetch('iso_code','')
       end
 
       def country
-        @data.fetch('country', {}).fetch('names',{}).fetch('en','')
+        data.fetch('country', {}).fetch('names',{}).fetch('en','')
       end
 
       def country_code
-        @data.fetch('country',{}).fetch('iso_code','')
+        data.fetch('country',{}).fetch('iso_code','')
       end
 
       def postal_code
-        @data.fetch('postal',{}).fetch('code','')
+        data.fetch('postal',{}).fetch('code','')
       end
 
       def self.response_attributes
@@ -53,6 +53,12 @@ module Geocoder
           @data[a]
         end
       end
+
+      private
+
+      def data
+        @data.to_hash
+      end
     end
   end
 end

data/lib/geocoder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-06-12 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,