geocoder 1.4.3 → 1.5.0

data/lib/geocoder/results/geoip2.rb

@@ -3,10 +3,6 @@ require 'geocoder/results/base'
 module Geocoder
   module Result
     class Geoip2 < Base
-      def address(format = :full)
-        s = state.to_s == '' ? '' : ", #{state_code}"
-        "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, '')
-      end
 
       def coordinates
         %w[latitude longitude].map do |l|
@@ -15,11 +11,15 @@ module Geocoder
       end
 
       def city
-        data.fetch('city', {}).fetch('names', {}).fetch(locale, '')
+        fetch_name(
+          data.fetch('city', {}).fetch('names', {})
+        )
       end
 
       def state
-        data.fetch('subdivisions', []).fetch(0, {}).fetch('names', {}).fetch(locale, '')
+        fetch_name(
+          data.fetch('subdivisions', []).fetch(0, {}).fetch('names', {})
+        )
       end
 
       def state_code
@@ -27,7 +27,9 @@ module Geocoder
       end
 
       def country
-        data.fetch('country', {}).fetch('names', {}).fetch(locale, '')
+        fetch_name(
+          data.fetch('country', {}).fetch('names', {})
+        )
       end
 
       def country_code
@@ -48,14 +50,26 @@ module Geocoder
         end
       end
 
-      private
+      def language=(l)
+        @language = l.to_s
+      end
+
+      def language
+        @language ||= default_language
+      end
 
       def data
         @data.to_hash
       end
 
-      def locale
-        @locale ||= Geocoder.config[:language].to_s
+      private
+
+      def default_language
+        @default_language = Geocoder.config[:language].to_s
+      end
+
+      def fetch_name(names)
+        names[language] || names[default_language] || ''
       end
     end
   end

data/lib/geocoder/results/geoportail_lu.rb

@@ -59,11 +59,13 @@ module Geocoder::Result
     private
 
     def geolocalized?
-      try_to_extract('coordinates', geomlonlat).present?
+      !!try_to_extract('coordinates', geomlonlat)
     end
 
-    def try_to_extract(key, nullable_hash)
-      nullable_hash.try(:[], key)
+    def try_to_extract(key, hash)
+      if hash.is_a?(Hash) and hash.include?(key)
+        hash[key]
+      end
     end
   end
 end

data/lib/geocoder/results/google.rb

@@ -120,19 +120,30 @@ module Geocoder::Result
     def precision
       geometry['location_type'] if geometry
     end
-    
+
     def partial_match
       @data['partial_match']
     end
-    
+
     def place_id
       @data['place_id']
-    end  
+    end
 
     def viewport
       viewport = geometry['viewport'] || fail
-      south, west = %w(lat lng).map { |c| viewport['southwest'][c] }
-      north, east = %w(lat lng).map { |c| viewport['northeast'][c] }
+      bounding_box_from viewport
+    end
+
+    def bounds
+      bounding_box_from geometry['bounds']
+    end
+
+    private
+
+    def bounding_box_from(box)
+      return nil unless box
+      south, west = %w(lat lng).map { |c| box['southwest'][c] }
+      north, east = %w(lat lng).map { |c| box['northeast'][c] }
       [south, west, north, east]
     end
   end

data/lib/geocoder/results/here.rb

@@ -17,6 +17,14 @@ module Geocoder::Result
       fail unless d = @data['Location']['DisplayPosition']
       [d['Latitude'].to_f, d['Longitude'].to_f]
     end
+    
+    def route
+      address_data['Street']
+    end
+    
+    def street_number
+      address_data['HouseNumber']
+    end  
 
     def state
       address_data['County']

data/lib/geocoder/results/ip2location.rb

@@ -0,0 +1,22 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ip2location < Base
+
+    def address(format = :full)
+      "#{city_name} #{zip_code}, #{country_name}".sub(/^[ ,]*/, '')
+    end
+
+    def self.response_attributes
+      %w[country_code country_name region_name city_name latitude longitude
+        zip_code time_zone isp domain net_speed idd_code area_code usage_type
+        weather_station_code weather_station_name mcc mnc mobile_brand elevation]
+    end
+
+    response_attributes.each do |attr|
+      define_method attr do
+        @data[attr] || ""
+      end
+    end
+  end
+end

data/lib/geocoder/results/ipdata_co.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class IpdataCo < Base
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['region']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def postal_code
+      @data['postal']
+    end
+
+    def self.response_attributes
+      %w[ip asn organisation currency currency_symbol calling_code flag time_zone is_eu]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/results/ipstack.rb

@@ -0,0 +1,60 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipstack < Base
+
+    def address(format = :full)
+      s = region_code.empty? ? "" : ", #{region_code}"
+      "#{city}#{s} #{zip}, #{country_name}".sub(/^[ ,]*/, "")
+    end
+
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def postal_code
+      @data['zip'] || @data['zipcode'] || @data['zip_code']
+    end
+
+    def self.response_attributes
+      [
+        ['ip', ''],
+        ['hostname', ''],
+        ['continent_code', ''],
+        ['continent_name', ''],
+        ['country_code', ''],
+        ['country_name', ''],
+        ['region_code', ''],
+        ['region_name', ''],
+        ['city', ''],
+        ['zip', ''],
+        ['latitude', 0],
+        ['longitude', 0],
+        ['location', {}],
+        ['time_zone', {}],
+        ['currency', {}],
+        ['connection', {}],
+        ['security', {}],
+      ]
+    end
+
+    response_attributes.each do |attr, default|
+      define_method attr do
+        @data[attr] || default
+      end
+    end
+
+    def metro_code
+      Geocoder.log(:warn, "Ipstack does not implement `metro_code` in api results.  Please discontinue use.")
+      0 # no longer implemented by ipstack
+    end
+  end
+end

data/lib/geocoder/results/maxmind.rb

@@ -87,11 +87,6 @@ module Geocoder::Result
       [data_hash[:latitude].to_f, data_hash[:longitude].to_f]
     end
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{postal_code}, #{country_code}".sub(/^[ ,]*/, "")
-    end
-
     def city
       data_hash[:city_name]
     end

data/lib/geocoder/results/maxmind_local.rb

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class MaxmindLocal < Base
 
-    def address(format = :full)
-      s = state.to_s == "" ? "" : ", #{state}"
-      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
-    end
-
     def coordinates
       [@data[:latitude], @data[:longitude]]
     end

data/lib/geocoder/results/nominatim.rb

@@ -64,6 +64,18 @@ module Geocoder::Result
       @data['address']['suburb']
     end
 
+    def city_district
+      @data['address']['city_district']
+    end
+
+    def state_district
+      @data['address']['state_district']
+    end
+
+    def neighbourhood
+      @data['address']['neighbourhood']
+    end
+
     def coordinates
       [@data['lat'].to_f, @data['lon'].to_f]
     end

data/lib/geocoder/results/opencagedata.rb

@@ -36,12 +36,13 @@ module Geocoder::Result
       @data['components']['village']
     end
 
-
     def state
       @data['components']['state']
     end
 
-    alias_method :state_code, :state
+    def state_code
+      @data['components']['state_code']
+    end
 
     def postal_code
       @data['components']['postcode'].to_s
@@ -74,6 +75,15 @@ module Geocoder::Result
       [south, west, north, east]
     end
 
+    def time_zone
+      # The OpenCage API documentation states that `annotations` is available
+      # "when possible" https://geocoder.opencagedata.com/api#annotations
+      @data
+        .fetch('annotations', {})
+        .fetch('timezone', {})
+        .fetch('name', nil)
+    end
+
     def self.response_attributes
       %w[boundingbox license 
         formatted stadium]

data/lib/geocoder/results/pickpoint.rb

@@ -0,0 +1,6 @@
+require 'geocoder/results/nominatim'
+
+module Geocoder::Result
+  class Pickpoint < Nominatim
+  end
+end

data/lib/geocoder/results/postcodes_io.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class PostcodesIo < Base
+
+    def coordinates
+      [@data['latitude'].to_f, @data['longitude'].to_f]
+    end
+
+    def quality
+      @data['quality']
+    end
+
+    def postal_code
+      @data['postcode']
+    end
+    alias address postal_code
+
+    def city
+      @data['admin_ward']
+    end
+
+    def county
+      @data['admin_county']
+    end
+    alias state county
+
+    def state_code
+      @data['codes']['admin_county']
+    end
+
+    def country
+      'United Kingdom'
+    end
+
+    def country_code
+      'UK'
+    end
+  end
+end

data/lib/geocoder/results/smarty_streets.rb

@@ -3,9 +3,15 @@ require 'geocoder/lookups/base'
 module Geocoder::Result
   class SmartyStreets < Base
     def coordinates
-      %w(latitude longitude).map do |i|
+      result = %w(latitude longitude).map do |i|
         zipcode_endpoint? ? zipcodes.first[i] : metadata[i]
       end
+
+      if result.compact.empty?
+        nil
+      else
+        result
+      end
     end
 
     def address

data/lib/geocoder/results/telize.rb

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class Telize < Base
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
-    end
-
     def city
       @data['city']
     end

data/lib/geocoder/results/test.rb

@@ -15,7 +15,7 @@ module Geocoder
         end
       end
 
-      %w[latitude longitude neighborhood city state state_code sub_state
+      %w[coordinates neighborhood city state state_code sub_state
       sub_state_code province province_code postal_code country
       country_code address street_address street_number route geometry].each do |attr|
         add_result_attribute(attr)

data/lib/geocoder/sql.rb

@@ -47,8 +47,8 @@ module Geocoder
       spans = "#{lat_attr} BETWEEN #{sw_lat} AND #{ne_lat} AND "
       # handle box that spans 180 longitude
       if sw_lng.to_f > ne_lng.to_f
-        spans + "#{lon_attr} BETWEEN #{sw_lng} AND 180 OR " +
-        "#{lon_attr} BETWEEN -180 AND #{ne_lng}"
+        spans + "(#{lon_attr} BETWEEN #{sw_lng} AND 180 OR " +
+        "#{lon_attr} BETWEEN -180 AND #{ne_lng})"
       else
         spans + "#{lon_attr} BETWEEN #{sw_lng} AND #{ne_lng}"
       end

data/lib/geocoder/stores/active_record.rb

@@ -87,8 +87,6 @@ module Geocoder::Store
         end
       end
 
-      private # ----------------------------------------------------------------
-
       ##
       # Get options hash suitable for passing to ActiveRecord.find to get
       # records within a radius (in kilometers) of the given point.
@@ -131,7 +129,11 @@ module Geocoder::Store
         distance_column = options.fetch(:distance_column) { 'distance' }
         bearing_column = options.fetch(:bearing_column)  { 'bearing' }
 
-        b = Geocoder::Calculations.bounding_box([latitude, longitude], radius, options)
+        # If radius is a DB column name, bounding box should include
+        # all rows within the maximum radius appearing in that column.
+        # Note: performance is dependent on variability of radii.
+        bb_radius = radius.is_a?(Symbol) ? maximum(radius) : radius
+        b = Geocoder::Calculations.bounding_box([latitude, longitude], bb_radius, options)
         args = b + [
           full_column_name(latitude_attribute),
           full_column_name(longitude_attribute)
@@ -142,7 +144,16 @@ module Geocoder::Store
           conditions = bounding_box_conditions
         else
           min_radius = options.fetch(:min_radius, 0).to_f
-          conditions = [bounding_box_conditions + " AND (#{distance}) BETWEEN ? AND ?", min_radius, radius]
+          # if radius is a DB column name,
+          # find rows between min_radius and value in column
+          if radius.is_a?(Symbol)
+            c = "BETWEEN ? AND #{radius}"
+            a = [min_radius]
+          else
+            c = "BETWEEN ? AND ?"
+            a = [min_radius, radius]
+          end
+          conditions = [bounding_box_conditions + " AND (#{distance}) " + c] + a
         end
         {
           :select => select_clause(options[:select],

data/lib/geocoder/stores/base.rb

@@ -90,7 +90,7 @@ module Geocoder
           return
         end
 
-        query_options = [:lookup, :ip_lookup, :language].inject({}) do |hash, key|
+        query_options = [:lookup, :ip_lookup, :language, :params].inject({}) do |hash, key|
           if options.has_key?(key)
             val = options[key]
             hash[key] = val.respond_to?(:call) ? val.call(self) : val
@@ -113,4 +113,3 @@ module Geocoder
     end
   end
 end
-

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.4.3"
+  VERSION = "1.5.0"
 end

data/lib/tasks/geocoder.rake

@@ -1,4 +1,4 @@
-require "geocoder/models/mongoid" 
+require "geocoder/models/mongoid"
 
 namespace :geocode do
   desc "Geocode all objects without coordinates."
@@ -7,6 +7,7 @@ namespace :geocode do
     sleep_timer = ENV['SLEEP'] || ENV['sleep']
     batch = ENV['BATCH'] || ENV['batch']
     reverse = ENV['REVERSE'] || ENV['reverse']
+    limit = ENV['LIMIT'] || ENV['limit']
     raise "Please specify a CLASS (model)" unless class_name
     klass = class_from_string(class_name)
     batch = (batch.to_i unless batch.nil?) || 1000
@@ -20,13 +21,20 @@ namespace :geocode do
     }
 
     scope = reverse ? klass.not_reverse_geocoded : klass.not_geocoded
+    scope = scope.limit(limit) if limit
     if orm == 'mongoid'
       scope.each do |obj|
         geocode_record.call(obj)
       end
     elsif orm == 'active_record'
-      scope.find_each(batch_size: batch) do |obj|
-        geocode_record.call(obj)
+      if limit
+        scope.each do |obj|
+          geocode_record.call(obj)
+        end
+      else
+        scope.find_each(batch_size: batch) do |obj|
+          geocode_record.call(obj)
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2018-07-31 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,
@@ -35,6 +35,7 @@ files:
 - lib/generators/geocoder/maxmind/geolite_country_generator.rb
 - lib/generators/geocoder/maxmind/templates/migration/geolite_city.rb
 - lib/generators/geocoder/maxmind/templates/migration/geolite_country.rb
+- lib/generators/geocoder/migration_version.rb
 - lib/geocoder.rb
 - lib/geocoder/cache.rb
 - lib/geocoder/calculations.rb
@@ -47,11 +48,13 @@ files:
 - lib/geocoder/kernel_logger.rb
 - lib/geocoder/logger.rb
 - lib/geocoder/lookup.rb
+- lib/geocoder/lookups/amap.rb
 - lib/geocoder/lookups/baidu.rb
 - lib/geocoder/lookups/baidu_ip.rb
 - lib/geocoder/lookups/ban_data_gouv_fr.rb
 - lib/geocoder/lookups/base.rb
 - lib/geocoder/lookups/bing.rb
+- lib/geocoder/lookups/db_ip_com.rb
 - lib/geocoder/lookups/dstk.rb
 - lib/geocoder/lookups/esri.rb
 - lib/geocoder/lookups/freegeoip.rb
@@ -65,8 +68,11 @@ files:
 - lib/geocoder/lookups/google_places_search.rb
 - lib/geocoder/lookups/google_premier.rb
 - lib/geocoder/lookups/here.rb
+- lib/geocoder/lookups/ip2location.rb
 - lib/geocoder/lookups/ipapi_com.rb
+- lib/geocoder/lookups/ipdata_co.rb
 - lib/geocoder/lookups/ipinfo_io.rb
+- lib/geocoder/lookups/ipstack.rb
 - lib/geocoder/lookups/latlon.rb
 - lib/geocoder/lookups/location_iq.rb
 - lib/geocoder/lookups/mapbox.rb
@@ -76,12 +82,12 @@ files:
 - lib/geocoder/lookups/maxmind_geoip2.rb
 - lib/geocoder/lookups/maxmind_local.rb
 - lib/geocoder/lookups/nominatim.rb
-- lib/geocoder/lookups/okf.rb
 - lib/geocoder/lookups/opencagedata.rb
-- lib/geocoder/lookups/ovi.rb
 - lib/geocoder/lookups/pelias.rb
+- lib/geocoder/lookups/pickpoint.rb
 - lib/geocoder/lookups/pointpin.rb
 - lib/geocoder/lookups/postcode_anywhere_uk.rb
+- lib/geocoder/lookups/postcodes_io.rb
 - lib/geocoder/lookups/smarty_streets.rb
 - lib/geocoder/lookups/telize.rb
 - lib/geocoder/lookups/test.rb
@@ -94,11 +100,13 @@ files:
 - lib/geocoder/query.rb
 - lib/geocoder/railtie.rb
 - lib/geocoder/request.rb
+- lib/geocoder/results/amap.rb
 - lib/geocoder/results/baidu.rb
 - lib/geocoder/results/baidu_ip.rb
 - lib/geocoder/results/ban_data_gouv_fr.rb
 - lib/geocoder/results/base.rb
 - lib/geocoder/results/bing.rb
+- lib/geocoder/results/db_ip_com.rb
 - lib/geocoder/results/dstk.rb
 - lib/geocoder/results/esri.rb
 - lib/geocoder/results/freegeoip.rb
@@ -112,8 +120,11 @@ files:
 - lib/geocoder/results/google_places_search.rb
 - lib/geocoder/results/google_premier.rb
 - lib/geocoder/results/here.rb
+- lib/geocoder/results/ip2location.rb
 - lib/geocoder/results/ipapi_com.rb
+- lib/geocoder/results/ipdata_co.rb
 - lib/geocoder/results/ipinfo_io.rb
+- lib/geocoder/results/ipstack.rb
 - lib/geocoder/results/latlon.rb
 - lib/geocoder/results/location_iq.rb
 - lib/geocoder/results/mapbox.rb
@@ -123,12 +134,12 @@ files:
 - lib/geocoder/results/maxmind_geoip2.rb
 - lib/geocoder/results/maxmind_local.rb
 - lib/geocoder/results/nominatim.rb
-- lib/geocoder/results/okf.rb
 - lib/geocoder/results/opencagedata.rb
-- lib/geocoder/results/ovi.rb
 - lib/geocoder/results/pelias.rb
+- lib/geocoder/results/pickpoint.rb
 - lib/geocoder/results/pointpin.rb
 - lib/geocoder/results/postcode_anywhere_uk.rb
+- lib/geocoder/results/postcodes_io.rb
 - lib/geocoder/results/smarty_streets.rb
 - lib/geocoder/results/telize.rb
 - lib/geocoder/results/test.rb
@@ -147,8 +158,14 @@ files:
 homepage: http://www.rubygeocoder.com
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/alexreisner/geocoder
+  changelog_uri: https://github.com/alexreisner/geocoder/blob/master/CHANGELOG.md
+post_install_message: |2+
+
+
+  NOTE: Geocoder's default IP address lookup has changed from FreeGeoIP.net to IPInfo.io. If you explicitly specify :freegeoip in your configuration you must choose a different IP lookup before FreeGeoIP is discontinued on July 1, 2018. If you do not explicitly specify :freegeoip you do not need to change anything.
+
 rdoc_options: []
 require_paths:
 - lib
@@ -156,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -164,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.