geocoder 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a73d81025d3d5faa23e10ae7db3c1d25e9825e
-  data.tar.gz: 740a6672d7cbfd97dc9c1e22a84473007674d4c5
+  metadata.gz: e80b63580339ffae3893ed71c9cb97081c2b63eb
+  data.tar.gz: a133f7574566f3dccca311af4cac43a9e661533a
 SHA512:
-  metadata.gz: 9ae067878ed711962248b7a63bd8e322f3f0529cef013eb667f96b2c7b51b1f2a59c0ec9437fc79fb6a7338dc569c834abae6c903cf28339562ce6a4ff8db7f6
-  data.tar.gz: 44af9419d97670067cfde24878a7b893d2f0fa6b784102277089f53c9b43d796cf90a755c261851d23b268b902f48a2217147fdff935719d3574cf4b5915ea38
+  metadata.gz: b1302d7eabd3c367075ae4af684833e9cbb5af3dcce856716ece5bbb5eba4933fc001235b2638861943362678a6187a029c2f6184f285ab4ed525b2d68b9eca4
+  data.tar.gz: 94690e53ca9f0b17f0b56a96b2eb4184c5fe96f2ee769eefc1f5f6ecc07c7a334d9fa6cf6a5ef3f986771c5aeaeae1c8566d21b2fbbaebf4c75e6b62a963836f

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
+  - 2.2.0
   - jruby-19mode
   - rbx-2
 gemfile:

data/CHANGELOG.md

@@ -3,8 +3,20 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
-1.2.6 (2014 Nov 8)
+1.2.7 (2015 Jan 24)
 -------------------
+* DROP SUPPORT for Ruby 1.9.2.
+* Use UTF-8 encoding for maxmind_local results (thanks github.com/ellmo).
+* Update freegeoip response handling (thanks github.com/hosamaly).
+* Update nominatim response handling (thanks github.com/jsantos).
+* Update yandex response handling (thanks github.com/wfleming).
+* Update geocodio response handling (thanks github.com/getsidewalk).
+* 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).
 * Add :okf lookup (thanks github.com/kakoni).
 * Add :postcode_anywhere_uk lookup (thanks github.com/rob-murray).

data/README.md

@@ -7,7 +7,7 @@ Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding
 Compatibility
 -------------
 
-* Supports multiple Ruby versions: Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.0, JRuby and Rubinius.
+* Supports multiple Ruby versions: Ruby 1.9.3, 2.0.x, 2.1.x, JRuby, and Rubinius.
 * Supports multiple databases: MySQL, PostgreSQL, SQLite, and MongoDB (1.7.0 and higher).
 * Supports Rails 3 and 4. If you need to use it with Rails 2 please see the `rails2` branch (no longer maintained, limited feature set).
 * Works very well outside of Rails, you just need to install either the `json` (for MRI) or `json_pure` (for JRuby) gem.
@@ -28,7 +28,7 @@ Install Geocoder like any other Ruby gem:
 
 Or, if you're using Rails/Bundler, add this to your Gemfile:
 
-    gem "geocoder"
+    gem 'geocoder'
 
 and run at the command prompt:
 
@@ -139,8 +139,8 @@ Location-Aware Database Queries
 To find objects by location, use the following scopes:
 
     Venue.near('Omaha, NE, US', 20)    # venues within 20 miles of Omaha
-    Venue.near([40.71, 100.23], 20)    # venues within 20 miles of a point
-    Venue.near([40.71, 100.23], 20, :units => :km)
+    Venue.near([40.71, -100.23], 20)    # venues within 20 miles of a point
+    Venue.near([40.71, -100.23], 20, :units => :km)
                                        # venues within 20 kilometres of a point
     Venue.geocoded                     # venues with coordinates
     Venue.not_geocoded                 # venues without coordinates
@@ -690,7 +690,7 @@ This lookup provides methods for geocoding IP addresses without making a call to
 You can generate ActiveRecord migrations and download and import data via provided rake tasks:
 
     # generate migration to create tables
-    rails generate geocoder:maxmind:geolite PACKAGE=city
+    rails generate geocoder:maxmind:geolite_city
 
     # download, unpack, and import data
     rake geocoder:maxmind:geolite:load PACKAGE=city
@@ -733,7 +733,7 @@ This lookup provides methods for geocoding IP addresses without making a call to
 You must add either the *[hive_geoip2](https://rubygems.org/gems/hive_geoip2)* gem (native extension that relies on libmaxminddb) or the *[maxminddb](http://rubygems.org/gems/maxminddb)* gem (pure Ruby implementation) to your Gemfile or have it installed in your system. The pure Ruby gem (maxminddb) will be used by default. To use `hive_geoip2`:
 
     Geocoder.configure(
-      ip_lookup: :geoip2, 
+      ip_lookup: :geoip2,
       geoip2: {
         lib: 'hive_geoip2',
         file: File.join('folder', 'GeoLite2-City.mmdb')
@@ -1034,9 +1034,10 @@ 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.
+
 
-Known Issue
------------
+### Known Issue
 
 You cannot use the `near` scope with another scope that provides an `includes` option because the `SELECT` clause generated by `near` will overwrite it (or vice versa).
 
@@ -1064,7 +1065,6 @@ Contributions are welcome via pull requests on Github. Please respect the follow
 * Do not add dependencies on other gems.
 * Do not add unnecessary `require` statements which could cause LoadErrors on certain systems.
 * Remember: Geocoder needs to run outside of Rails. Don't assume things like ActiveSupport are available.
-* Do not add to base configuration options; instead document required lookup-specific options in the README.
 * Be willing to accept criticism and work on improving your code; Geocoder is used by thousands of developers and care must be taken not to introduce bugs.
 * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
 

data/examples/sidekiq_worker.rb

@@ -0,0 +1,16 @@
+# This class implements a Sidekiq worker for performing geocoding
+# asynchronously. Do something like this in your controller:
+#
+# if @object.save
+#   GeocoderWorker.perform_async(@object.id)
+# end
+#
+class GeocoderWorker
+  include Sidekiq::Worker
+
+  def perform(object_id)
+    object = Object.find(object_id)
+    object.geocode
+    object.save!
+  end
+end

data/lib/geocoder.rb

@@ -43,5 +43,4 @@ end
 # load Railtie if Rails exists
 if defined?(Rails)
   require "geocoder/railtie"
-  Geocoder::Railtie.insert
 end

data/lib/geocoder/exceptions.rb

@@ -9,6 +9,14 @@ module Geocoder
   class OverQueryLimitError < Error
   end
 
+  class ResponseParseError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
   class RequestDenied < Error
   end
 

data/lib/geocoder/lookup.rb

@@ -20,7 +20,7 @@ module Geocoder
     # All street address lookup services, default first.
     #
     def street_services
-      [
+      @street_services ||= [
         :dstk,
         :esri,
         :google,
@@ -49,7 +49,7 @@ module Geocoder
     # All IP address lookup services, default first.
     #
     def ip_services
-      [
+      @ip_services ||= [
         :baidu_ip,
         :freegeoip,
         :geoip2,
@@ -60,6 +60,8 @@ module Geocoder
       ]
     end
 
+    attr_writer :street_services, :ip_services
+
     ##
     # Retrieve a Lookup object from the store.
     # Use this instead of Geocoder::Lookup::X.new to get an

data/lib/geocoder/lookups/base.rb

@@ -182,6 +182,8 @@ module Geocoder
         else
           JSON.parse(data)
         end
+      rescue => err
+        raise_error(ResponseParseError.new(data)) or warn "Geocoding API's response was not valid JSON."
       end
 
       ##
@@ -189,8 +191,6 @@ module Geocoder
       #
       def parse_raw_data(raw_data)
         parse_json(raw_data)
-      rescue
-        warn "Geocoding API's response was not valid JSON."
       end
 
       ##

data/lib/geocoder/lookups/google.rb

@@ -19,7 +19,8 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
 
     def valid_response?(response)
-      status = parse_json(response.body)["status"]
+      json = parse_json(response.body)
+      status = json["status"] if json
       super(response) and ['OK', 'ZERO_RESULTS'].include?(status)
     end
 

data/lib/geocoder/lookups/maxmind_local.rb

@@ -31,7 +31,7 @@ module Geocoder::Lookup
       if configuration[:file]
         geoip_class = RUBY_PLATFORM == "java" ? JGeoIP : GeoIP
         result = geoip_class.new(configuration[:file]).city(query.to_s)
-        result.nil? ? [] : [result.to_hash]
+        result.nil? ? [] : [encode_hash(result.to_hash)]
       elsif configuration[:package] == :city
         addr = IPAddr.new(query.text).to_i
         q = "SELECT l.country, l.region, l.city, l.latitude, l.longitude
@@ -46,6 +46,13 @@ module Geocoder::Lookup
       end
     end
 
+    def encode_hash(hash, encoding = "UTF-8")
+      hash.inject({}) do |h,i|
+        h[i[0]] = i[1].is_a?(String) ? i[1].encode(encoding) : i[1]
+        h
+      end
+    end
+
     def format_result(query, attr_names)
       if r = ActiveRecord::Base.connection.execute(query).first
         r = r.values if r.is_a?(Hash) # some db adapters return Hash, some Array

data/lib/geocoder/lookups/okf.rb

@@ -15,7 +15,8 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
 
     def valid_response?(response)
-      status = parse_json(response.body)["status"]
+      json = parse_json(response.body)
+      status = json["status"] if json
       super(response) and ['OK', 'ZERO_RESULTS'].include?(status)
     end
 

data/lib/geocoder/results/freegeoip.rb

@@ -29,7 +29,7 @@ module Geocoder::Result
     end
 
     def postal_code
-      @data['zipcode']
+      @data['zipcode'] || @data['zip_code']
     end
 
     def self.response_attributes

data/lib/geocoder/results/geocodio.rb

@@ -14,6 +14,10 @@ module Geocoder::Result
       address_components["suffix"]
     end
 
+    def street_address
+      [number, address_components["formatted_street"]].compact.join(' ')
+    end
+
     def state
       address_components["state"]
     end

data/lib/geocoder/results/nominatim.rb

@@ -4,7 +4,7 @@ module Geocoder::Result
   class Nominatim < Base
 
     def poi
-      %w[stadium bus_stop tram_stop].each do |key|
+      %w[building university school hospital mall hotel restaurant stadium bus_stop tram_stop].each do |key|
         return @data['address'][key] if @data['address'].key?(key)
       end
       return nil

data/lib/geocoder/results/yandex.rb

@@ -14,7 +14,8 @@ module Geocoder::Result
     def city
       if state.empty? and address_details.has_key? 'Locality'
         address_details['Locality']['LocalityName']
-      elsif sub_state.empty? and address_details['AdministrativeArea'].has_key? 'Locality'
+      elsif sub_state.empty? and address_details.has_key? 'AdministrativeArea' and
+          address_details['AdministrativeArea'].has_key? 'Locality'
         address_details['AdministrativeArea']['Locality']['LocalityName']
       elsif not sub_state_city.empty?
         sub_state_city

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 end

data/test/fixtures/geocodio_1101_pennsylvania_ave

@@ -1 +1 @@
-{"input":{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","city":"Washington","state":"DC"},"formatted_address":"1101 Pennsylvania Ave NW, Washington DC"},"results":[{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","city":"Washington","state":"DC","zip":"20004"},"formatted_address":"1101 Pennsylvania Ave NW, Washington DC, 20004","location":{"lat":"38.895019","lng":"-77.028095"},"accuracy":1},{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","city":"Washington","state":"DC","zip":"20004"},"formatted_address":"1101 Pennsylvania Ave NW, Washington DC, 20004","location":{"lat":"38.895016122449","lng":"-77.028084377551"},"accuracy":0.8}]}
+{"input":{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","formatted_street":"Pennsylvania Ave NW","city":"Washington","state":"DC"},"formatted_address":"1101 Pennsylvania Ave NW, Washington, DC"},"results":[{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","formatted_street":"Pennsylvania Ave NW","city":"Washington","county":"District of Columbia","state":"DC","zip":"20004"},"formatted_address":"1101 Pennsylvania Ave NW, Washington, DC 20004","location":{"lat":38.895019,"lng":-77.028095},"accuracy":1,"accuracy_type":"range_interpolation"},{"address_components":{"number":"1101","street":"Pennsylvania","suffix":"Ave","postdirectional":"NW","formatted_street":"Pennsylvania Ave NW","city":"Washington","county":"District of Columbia","state":"DC","zip":"20004"},"formatted_address":"1101 Pennsylvania Ave NW, Washington, DC 20004","location":{"lat":38.895016122449,"lng":-77.028084377551},"accuracy":0.8,"accuracy_type":"range_interpolation"}]}

data/test/fixtures/yandex_no_administrative_area

@@ -0,0 +1,53 @@
+{
+   "response":{
+      "GeoObjectCollection":{
+         "metaDataProperty":{
+            "GeocoderResponseMetaData":{
+               "request":"13.813139,100.560291",
+               "found":"1",
+               "results":"1",
+               "Point":{
+                  "pos":"13.813139 100.560291"
+               }
+            }
+         },
+         "featureMember":[
+            {
+               "GeoObject":{
+                  "metaDataProperty":{
+                     "GeocoderMetaData":{
+                        "kind":"house",
+                        "text":"Thailand, Phahon Yothin Road, 1130/5",
+                        "precision":"exact",
+                        "AddressDetails":{
+                           "Country":{
+                              "AddressLine":"Phahon Yothin Road, 1130/5",
+                              "CountryNameCode":"TH",
+                              "CountryName":"Thailand",
+                              "Thoroughfare":{
+                                 "ThoroughfareName":"Phahon Yothin Road",
+                                 "Premise":{
+                                    "PremiseNumber":"1130/5"
+                                 }
+                              }
+                           }
+                        }
+                     }
+                  },
+                  "description":"Thailand",
+                  "name":"Phahon Yothin Road, 1130/5",
+                  "boundedBy":{
+                     "Envelope":{
+                        "lowerCorner":"100.552005 13.805102",
+                        "upperCorner":"100.568462 13.821184"
+                     }
+                  },
+                  "Point":{
+                     "pos":"100.560234 13.813143"
+                  }
+               }
+            }
+         ]
+      }
+   }
+}

data/test/test_helper.rb

@@ -67,6 +67,9 @@ end
 require 'geocoder'
 require "geocoder/lookups/base"
 
+# and initialize Railtie manually (since Rails::Railtie doesn't exist)
+Geocoder::Railtie.insert
+
 ##
 # Mock HTTP request to geocoding service.
 #
@@ -81,11 +84,7 @@ module Geocoder
       def read_fixture(file)
         filepath = File.join("test", "fixtures", file)
         s = File.read(filepath).strip.gsub(/\n\s*/, "")
-        s.instance_eval do
-          def body; self; end
-          def code; "200"; end
-        end
-        s
+        MockHttpResponse.new(body: s, code: "200")
       end
 
       ##
@@ -111,6 +110,10 @@ module Geocoder
         raise TimeoutError if query.text == "timeout"
         raise SocketError if query.text == "socket_error"
         raise Errno::ECONNREFUSED if query.text == "connection_refused"
+        if query.text == "invalid_json"
+          return MockHttpResponse.new(:body => 'invalid json', :code => 200)
+        end
+
         read_fixture fixture_for_query(query)
       end
     end
@@ -413,4 +416,8 @@ class MockHttpResponse
     @code = options[:code].to_s
     @body = options[:body]
   end
+
+  def [](key)
+    send key if respond_to?(key)
+  end
 end

data/test/unit/error_handling_test.rb

@@ -18,6 +18,29 @@ class ErrorHandlingTest < GeocoderTestCase
     end
   end
 
+  def test_always_raise_response_parse_error
+    Geocoder.configure(:always_raise => [Geocoder::ResponseParseError])
+    [:freegeoip, :google, :okf].each do |l|
+      lookup = Geocoder::Lookup.get(l)
+      set_api_key!(l)
+      assert_raises Geocoder::ResponseParseError do
+        lookup.send(:results, Geocoder::Query.new("invalid_json"))
+      end
+    end
+  end
+
+  def test_never_raise_response_parse_error
+    [:freegeoip, :google, :okf].each do |l|
+      lookup = Geocoder::Lookup.get(l)
+      set_api_key!(l)
+      silence_warnings do
+        assert_nothing_raised do
+          lookup.send(:results, Geocoder::Query.new("invalid_json"))
+        end
+      end
+    end
+  end
+
   def test_always_raise_timeout_error
     Geocoder.configure(:always_raise => [TimeoutError])
     Geocoder::Lookup.all_services_except_test.each do |l|

data/test/unit/lookups/geocodio_test.rb

@@ -13,13 +13,14 @@ class GeocodioTest < GeocoderTestCase
     result = Geocoder.search("1101 Pennsylvania Ave NW, Washington DC").first
     assert_equal 1.0, result.accuracy
     assert_equal "1101", result.number
+    assert_equal "1101 Pennsylvania Ave NW", result.street_address
     assert_equal "Ave", result.suffix
     assert_equal "DC", result.state
     assert_equal "20004", result.zip
     assert_equal "NW", result.postdirectional
     assert_equal "Washington", result.city
-    assert_equal "1101 Pennsylvania Ave NW, Washington DC, 20004", result.formatted_address
-    assert_equal({ "lat" => "38.895019", "lng" => "-77.028095" }, result.location)
+    assert_equal "1101 Pennsylvania Ave NW, Washington, DC 20004", result.formatted_address
+    assert_equal({ "lat" => 38.895019, "lng" => -77.028095 }, result.location)
   end
 
   def test_no_results

data/test/unit/result_test.rb

@@ -22,6 +22,15 @@ class ResultTest < GeocoderTestCase
     end
   end
 
+  def test_yandex_result_without_admin_area_no_exception
+    assert_nothing_raised do
+      Geocoder.configure(:lookup => :yandex)
+      set_api_key!(:yandex)
+      result = Geocoder.search("no administrative area").first
+      assert_equal "", result.city
+    end
+  end
+
   def test_yandex_result_new_york
     assert_nothing_raised do
       Geocoder.configure(:lookup => :yandex)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2015-01-24 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,
@@ -31,6 +31,7 @@ files:
 - examples/autoexpire_cache_dalli.rb
 - examples/autoexpire_cache_redis.rb
 - examples/cache_bypass.rb
+- examples/sidekiq_worker.rb
 - gemfiles/Gemfile.mongoid-2.4.x
 - lib/generators/geocoder/config/config_generator.rb
 - lib/generators/geocoder/config/templates/initializer.rb
@@ -218,6 +219,7 @@ files:
 - test/fixtures/yandex_invalid_key
 - test/fixtures/yandex_kremlin
 - test/fixtures/yandex_new_york
+- test/fixtures/yandex_no_administrative_area
 - test/fixtures/yandex_no_city_and_town
 - test/fixtures/yandex_no_results
 - test/integration/http_client_test.rb
@@ -265,7 +267,8 @@ files:
 - test/unit/result_test.rb
 - test/unit/test_mode_test.rb
 homepage: http://www.rubygeocoder.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -275,7 +278,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -283,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.