geocoder 1.2.12 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ac038477cf014a8e62f7fec0e684f851cb55bbb
-  data.tar.gz: 3abbf824220bd221ecd033e75c7c14a8ece6057a
+  metadata.gz: 2184f181fb0c642d0cc02774bcd2208e325b8dc8
+  data.tar.gz: 7b0da04b5c05f0b9afe9182e00ee6099a83adc45
 SHA512:
-  metadata.gz: 42d47442e4839e84bcb0d98c28591ddeb1df2c63d19b1400736c1f90523f32e84b80990efb714551592a8614704a234c24533398c81c48052654aaf2f83d3d7f
-  data.tar.gz: b51c9a638a256db67d025e8ab67001fcb7a482dcae9206931b957952aa215e27c635044c829eecd20043dd901b5a683248155a403baa5f1057954c1711439c3d
+  metadata.gz: fd8d36a0c7fb2cabda97f03baa19c68d4106bca4e5c8eb1e987ac0156393fa1c05f67d235020ca332cd3557c77411cbfd8d601add3b8820dcfffd0359a30a19a
+  data.tar.gz: 05a0eb39a8f575083f3ff20fbe93c209afcb533313c531bee25462b1e6f25bed6da7f2d47ffcb296923d933786249309d8f07e66cb23d0e271da9cf7962c53c8

data/CHANGELOG.md

@@ -3,6 +3,18 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.2.13 (2015 Dec 15)
+--------------------
+* Update :telize IP lookup to reflect new URL (thanks github.com/jfredrickson).
+* Add reverse geocode rake task (thanks github.com/FanaHOVA).
+* Fix reversed coordinates array with Mapbox (thanks github.com/marcusat).
+* Fix missing city name in some cases with ESRI (thanks github.com/roybotnik).
+* Prevent re-opening of DB file on every read with :geoip2 (thanks github.com/oogali).
+
+1.2.12 (2015 Oct 29)
+--------------------
+* Fix Ruby 1.9.3 incompatibility (remove non-existent timeout classes) (thanks github.com/roychri).
+
 1.2.11 (2015 Sep 10)
 --------------------
 * Fix load issue on Ruby 1.9.3.

data/README.md

@@ -9,7 +9,7 @@ _Please note that this README is for the current `HEAD` and may document feature
 Compatibility
 -------------
 
-* Supports multiple Ruby versions: Ruby 1.9.3, 2.0.x, 2.1.x, JRuby, and Rubinius.
+* Supports multiple Ruby versions: Ruby 1.9.3, 2.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.
@@ -106,6 +106,10 @@ If you have just added geocoding to an existing application with a lot of object
 
     rake geocode:all CLASS=YourModel
 
+If you need reverse geocoding instead, call the task with REVERSE=true:
+
+    rake geocode:all CLASS=YourModel REVERSE=true
+
 Geocoder will print warnings if you exceed the rate limit for your geocoding service. Some services — Google notably — enforce a per-second limit in addition to a per-day limit. To avoid exceeding the per-second limit, you can add a `SLEEP` option to pause between requests for a given amount of time. You can also load objects in batches to save memory, for example:
 
     rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100
@@ -140,6 +144,12 @@ See _Advanced Geocoding_ below for more information about `Geocoder::Result` obj
 Location-Aware Database Queries
 -------------------------------
 
+### For Mongo-backed models:
+
+Please use MongoDB's [geospatial query language](https://docs.mongodb.org/manual/reference/command/geoNear/). Mongoid also provides [a DSL](http://mongoid.github.io/en/mongoid/docs/querying.html#geo_near) for doing near queries.
+
+### For ActiveRecord models:
+
 To find objects by location, use the following scopes:
 
     Venue.near('Omaha, NE, US', 20)    # venues within 20 miles of Omaha
@@ -149,6 +159,10 @@ To find objects by location, use the following scopes:
     Venue.geocoded                     # venues with coordinates
     Venue.not_geocoded                 # venues without coordinates
 
+by default, objects are ordered by distance. To remove the ORDER BY clause use the following:
+
+    Venue.near('Omaha', 20, :order => false)
+
 With geocoded objects you can do things like this:
 
     if obj.geocoded?
@@ -500,6 +514,20 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 * **Terms of Service**: http://geocoder.us/terms.shtml
 * **Limitations**: ?
 
+#### Mapbox (`:mapbox`)
+
+* **API key**: required
+* **Dataset**: Uses `mapbox.places` dataset by default.  Specific the `mapbox.places-permanent` dataset by setting: `Geocoder.configure(:mapbox => {:dataset => "mapbox.places-permanent"})`
+* **Key signup**: https://www.mapbox.com/pricing/
+* **Quota**: depends on plan
+* **Region**: complete coverage of US and Canada, partial coverage elsewhere (see for details: https://www.mapbox.com/developers/api/geocoding/#coverage)
+* **SSL support**: yes
+* **Languages**: English
+* **Documentation**: https://www.mapbox.com/developers/api/geocoding/
+* **Terms of Service**: https://www.mapbox.com/tos/
+* **Limitations**: For `mapbox.places` dataset, must be displayed on a Mapbox map; Cache results for up to 30 days. For `mapbox.places-permanent` dataset, depends on plan.
+* **Notes**: Currently in public beta.
+
 #### Mapquest (`:mapquest`)
 
 * **API key**: required
@@ -653,14 +681,15 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 
 #### Telize (`:telize`)
 
-* **API key**: none
-* **Quota**: none
+* **API key**: required
+* **Quota**: 1,000/day for $7/mo through 100,000/day for $100/mo
 * **Region**: world
-* **SSL support**: no
+* **SSL support**: yes
 * **Languages**: English
-* **Documentation**: http://www.telize.com/
+* **Documentation**: https://market.mashape.com/fcambus/telize
 * **Terms of Service**: ?
 * **Limitations**: ?
+* **Notes**: To use Telize set `Geocoder.configure(:ip_lookup => :telize, :api_key => "your_api_key")`.
 
 #### MaxMind Legacy Web Services (`:maxmind`)
 

data/lib/geocoder/configuration.rb

@@ -125,6 +125,5 @@ module Geocoder
       end
       EOS
     end.join("\n\n"))
-
   end
 end

data/lib/geocoder/lookup.rb

@@ -32,6 +32,7 @@ module Geocoder
         :geocoder_us,
         :yandex,
         :nominatim,
+        :mapbox,
         :mapquest,
         :opencagedata,
         :ovi,

data/lib/geocoder/lookups/geoip2.rb

@@ -4,6 +4,8 @@ require 'geocoder/results/geoip2'
 module Geocoder
   module Lookup
     class Geoip2 < Base
+      attr_reader :gem_name
+
       def initialize
         unless configuration[:file].nil?
           begin
@@ -12,6 +14,8 @@ module Geocoder
           rescue LoadError
             raise "Could not load Maxmind DB dependency. To use the GeoIP2 lookup you must add the #{@gem_name} gem to your Gemfile or have it installed in your system."
           end
+
+          @mmdb = db_class.new(configuration[:file].to_s)
         end
         super
       end
@@ -26,14 +30,14 @@ module Geocoder
 
       private
 
+      def db_class
+        gem_name == 'hive_geoip2' ? Hive::GeoIP2 : MaxMindDB
+      end
+
       def results(query)
         return [] unless configuration[:file]
-        if @gem_name == 'hive_geoip2'
-          result = Hive::GeoIP2.lookup(query.to_s, configuration[:file].to_s)
-        else
-          result = MaxMindDB.new(configuration[:file].to_s).lookup(query.to_s)
-        end
-        result.nil? ? [] : [result]
+
+        Array(@mmdb.lookup(query.to_s))
       end
     end
   end

data/lib/geocoder/lookups/mapbox.rb

@@ -0,0 +1,53 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/mapbox"
+
+module Geocoder::Lookup
+  class Mapbox < Base
+
+    def name
+      "Mapbox"
+    end
+
+    def query_url(query)
+      "#{protocol}://api.mapbox.com/geocoding/v5/#{dataset}/#{url_query_string(query)}.json?access_token=#{configuration.api_key}"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      return [] unless data = fetch_data(query)
+      if data['features']
+        sort_relevant_feature(data['features'])
+      elsif data['message'] =~ /Invalid\sToken/
+        raise_error(Geocoder::InvalidApiKey, data['message'])
+      else
+        []
+      end
+    end
+
+    def url_query_string(query)
+      require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        "#{CGI.escape lon},#{CGI.escape lat}"
+      else
+        CGI.escape query.text.to_s
+      end
+    end
+
+    def dataset
+      configuration[:dataset] || "mapbox.places"
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    def sort_relevant_feature(features)
+      # Sort by descending relevance; Favor original order for equal relevance (eg occurs for reverse geocoding)
+      features.sort_by do |feature|
+        [feature["relevance"],-features.index(feature)]
+      end.reverse
+    end
+  end
+end

data/lib/geocoder/lookups/telize.rb

@@ -8,13 +8,16 @@ module Geocoder::Lookup
       "Telize"
     end
 
+    def required_api_key_parts
+      ["key"]
+    end
+
     def query_url(query)
-      "#{protocol}://www.telize.com/geoip/#{query.sanitized_text}"
+      "#{protocol}://telize-v1.p.mashape.com/geoip/#{query.sanitized_text}?mashape-key=#{api_key}"
     end
 
-    # currently doesn't support HTTPS
     def supported_protocols
-      [:http]
+      [:https]
     end
 
     private # ---------------------------------------------------------------
@@ -36,5 +39,9 @@ module Geocoder::Lookup
     def reserved_result(ip)
       {"message" => "Input string is not a valid IP address", "code" => 401}
     end
+
+    def api_key
+      configuration.api_key
+    end
   end
 end

data/lib/geocoder/results/esri.rb

@@ -9,7 +9,11 @@ module Geocoder::Result
     end
 
     def city
-      attributes['City']
+      if !reverse_geocode? && is_city?
+        attributes['PlaceName']
+      else
+        attributes['City']
+      end
     end
 
     def state_code
@@ -47,5 +51,8 @@ module Geocoder::Result
       @data['locations'].nil?
     end
 
+    def is_city?
+      ['City', 'State Capital', 'National Capital'].include?(attributes['Type'])
+    end
   end
-end
+end

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(locale, '')
       end
 
       def state
-        data.fetch('subdivisions',[]).fetch(0,{}).fetch('names',{}).fetch('en','')
+        data.fetch('subdivisions', []).fetch(0, {}).fetch('names', {}).fetch(locale, '')
       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(locale, '')
       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
@@ -59,6 +59,10 @@ module Geocoder
       def data
         @data.to_hash
       end
+
+      def locale
+        @locale ||= Geocoder.config[:language].to_s
+      end
     end
   end
 end

data/lib/geocoder/results/mapbox.rb

@@ -0,0 +1,55 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Mapbox < Base
+
+    def latitude
+      @latitude ||= @data["geometry"]["coordinates"].last.to_f
+    end
+
+    def longitude
+      @longitude ||= @data["geometry"]["coordinates"].first.to_f
+    end
+
+    def coordinates
+      [latitude, longitude]
+    end
+
+    def place_name
+      @data['text']
+    end
+
+    def street
+      @data['properties']['address']
+    end
+
+    def city
+      @data['context'].map { |c| c['text'] if c['id'] =~ /place/ }.compact.first
+    end
+
+    def state
+      @data['context'].map { |c| c['text'] if c['id'] =~ /region/ }.compact.first
+    end
+
+    alias_method :state_code, :state
+
+    def postal_code
+      @data['context'].map { |c| c['text'] if c['id'] =~ /postcode/ }.compact.first
+    end
+
+    def country
+      @data['context'].map { |c| c['text'] if c['id'] =~ /country/ }.compact.first
+    end
+
+    alias_method :country_code, :country
+
+    def neighborhood
+      @data['context'].map { |c| c['text'] if c['id'] =~ /neighborhood/ }.compact.first
+    end
+
+    def address
+      [place_name, street, city, state, postal_code, country].compact.join(", ")
+    end
+  end
+end
+

data/lib/geocoder/stores/active_record.rb

@@ -28,6 +28,11 @@ module Geocoder::Store
             "OR #{table_name}.#{geocoder_options[:longitude]} IS NULL")
         }
 
+        # scope: not-reverse geocoded objects
+        scope :not_reverse_geocoded, lambda {
+          where("#{table_name}.#{geocoder_options[:fetched_address]} IS NULL")
+        }
+
         ##
         # Find all objects within a radius of the given location.
         # Location may be either a string to geocode or an array of

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.2.12"
+  VERSION = "1.2.13"
 end

data/lib/tasks/geocoder.rake

@@ -4,13 +4,22 @@ namespace :geocode do
     class_name = ENV['CLASS'] || ENV['class']
     sleep_timer = ENV['SLEEP'] || ENV['sleep']
     batch = ENV['BATCH'] || ENV['batch']
+    reverse = ENV['REVERSE'] || ENV['reverse']
     raise "Please specify a CLASS (model)" unless class_name
     klass = class_from_string(class_name)
     batch = batch.to_i unless batch.nil?
+    reverse = false unless reverse.to_s.downcase == 'true'
 
-    klass.not_geocoded.find_each(batch_size: batch) do |obj|
-      obj.geocode; obj.save
-      sleep(sleep_timer.to_f) unless sleep_timer.nil?
+    if reverse
+      klass.not_reverse_geocoded.find_each(batch_size: batch) do |obj|
+        obj.reverse_geocode; obj.save
+        sleep(sleep_timer.to_f) unless sleep_timer.nil?
+      end
+    else
+      klass.not_geocoded.find_each(batch_size: batch) do |obj|
+        obj.geocode; obj.save
+        sleep(sleep_timer.to_f) unless sleep_timer.nil?
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.2.12
+  version: 1.2.13
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-12-15 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,
@@ -61,6 +61,7 @@ files:
 - lib/geocoder/lookups/google_places_details.rb
 - lib/geocoder/lookups/google_premier.rb
 - lib/geocoder/lookups/here.rb
+- lib/geocoder/lookups/mapbox.rb
 - lib/geocoder/lookups/mapquest.rb
 - lib/geocoder/lookups/maxmind.rb
 - lib/geocoder/lookups/maxmind_geoip2.rb
@@ -99,6 +100,7 @@ files:
 - lib/geocoder/results/google_places_details.rb
 - lib/geocoder/results/google_premier.rb
 - lib/geocoder/results/here.rb
+- lib/geocoder/results/mapbox.rb
 - lib/geocoder/results/mapquest.rb
 - lib/geocoder/results/maxmind.rb
 - lib/geocoder/results/maxmind_geoip2.rb