geocoder 1.4.7 → 1.5.0

data/lib/geocoder/results/baidu.rb

@@ -11,34 +11,34 @@ module Geocoder::Result
       @data['formatted_address']
     end
 
-    def state
-      province
-    end
-    
     def province
-      @data['addressComponent']['province']
+      @data['addressComponent'] and @data['addressComponent']['province'] or ""
     end
 
+    alias_method :state, :province
+
     def city
-      @data['addressComponent']['city']
+      @data['addressComponent'] and @data['addressComponent']['city'] or ""
     end
 
     def district
-      @data['addressComponent']['district']
+      @data['addressComponent'] and @data['addressComponent']['district'] or ""
     end
 
     def street
-      @data['addressComponent']['street']
+      @data['addressComponent'] and @data['addressComponent']['street'] or ""
     end
 
     def street_number
-      @data['addressComponent']['street_number']
+      @data['addressComponent'] and @data['addressComponent']['street_number']
     end
 
     def formatted_address
-      @data['formatted_address']
+      @data['formatted_address'] or ""
     end
 
+    alias_method :address, :formatted_address
+
     def address_components
       @data['addressComponent']
     end

data/lib/geocoder/results/base.rb

@@ -20,8 +20,20 @@ module Geocoder
       ##
       # A string in the given format.
       #
+      # This default implementation dumbly follows the United States address
+      # format and will return incorrect results for most countries. Some APIs
+      # return properly formatted addresses and those should be funneled
+      # through this method.
+      #
       def address(format = :full)
-        fail
+        if state_code.to_s != ""
+          s = ", #{state_code}"
+        elsif state.to_s != ""
+          s = ", #{state}"
+        else
+          s = ""
+        end
+        "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, '')
       end
 
       ##

data/lib/geocoder/results/bing.rb

@@ -24,7 +24,7 @@ module Geocoder::Result
     alias_method :country_code, :country
 
     def postal_code
-      @data['address']['postalCode']
+      @data['address']['postalCode'].to_s
     end
 
     def coordinates

data/lib/geocoder/results/db_ip_com.rb

@@ -7,11 +7,6 @@ module Geocoder::Result
       ['latitude', 'longitude'].map{ |coordinate_name| @data[coordinate_name] }
     end
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{zip_code}, #{country_name}".sub(/^[ ,]*/, "")
-    end
-
     def city
       @data['city']
     end

data/lib/geocoder/results/freegeoip.rb

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class Freegeoip < 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/geocoder_ca.rb

@@ -16,17 +16,17 @@ module Geocoder::Result
     end
 
     def city
-      @data['city']
+      @data['city'] or (@data['standard'] and @data['standard']['city']) or ""
     end
 
     def state
-      @data['prov']
+      @data['prov'] or (@data['standard'] and @data['standard']['prov']) or ""
     end
 
     alias_method :state_code, :state
 
     def postal_code
-      @data['postal']
+      @data['postal'] or (@data['standard'] and @data['standard']['postal']) or ""
     end
 
     def country

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|
@@ -62,12 +58,12 @@ module Geocoder
         @language ||= default_language
       end
 
-      private
-
       def data
         @data.to_hash
       end
 
+      private
+
       def default_language
         @default_language = Geocoder.config[:language].to_s
       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/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

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class IpdataCo < 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/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/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/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/stores/active_record.rb

@@ -166,8 +166,6 @@ module Geocoder::Store
         }
       end
 
-      private # ----------------------------------------------------------------
-
       ##
       # SQL for calculating distance based on the current database's
       # capabilities (trig functions?).

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

data/lib/geocoder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 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,
@@ -68,9 +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
@@ -80,13 +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
@@ -119,9 +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
@@ -131,13 +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
@@ -159,7 +161,11 @@ licenses:
 metadata:
   source_code_uri: https://github.com/alexreisner/geocoder
   changelog_uri: https://github.com/alexreisner/geocoder/blob/master/CHANGELOG.md
-post_install_message: 
+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
@@ -167,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:
   - - ">="

data/lib/geocoder/lookups/okf.rb

@@ -1,44 +0,0 @@
-require 'geocoder/lookups/base'
-require "geocoder/results/okf"
-
-module Geocoder::Lookup
-  class Okf < Base
-
-    def name
-      "Okf"
-    end
-
-    def query_url(query)
-      "#{protocol}://data.okf.fi/gis/1/geocode/json?" + url_query_string(query)
-    end
-
-    private # ---------------------------------------------------------------
-
-    def valid_response?(response)
-      json = parse_json(response.body)
-      status = json["status"] if json
-      super(response) and ['OK', 'ZERO_RESULTS'].include?(status)
-    end
-
-    def results(query)
-      return [] unless doc = fetch_data(query)
-      case doc['status']; when "OK" # OK status implies >0 results
-        return doc['results']
-      end
-      return []
-    end
-
-    def query_url_okf_params(query)
-      params = {
-        (query.reverse_geocode? ? :latlng : :address) => query.sanitized_text,
-        :sensor => "false",
-        :language => (query.language || configuration.language)
-      }
-      params
-    end
-
-    def query_url_params(query)
-      query_url_okf_params(query).merge(super)
-    end
-  end
-end

data/lib/geocoder/lookups/ovi.rb

@@ -1,62 +0,0 @@
-require 'geocoder/lookups/base'
-require 'geocoder/results/ovi'
-
-module Geocoder::Lookup
-  class Ovi < Base
-
-    def name
-      "Ovi"
-    end
-
-    def required_api_key_parts
-      []
-    end
-
-    def query_url(query)
-      "#{protocol}://lbs.ovi.com/search/6.2/#{if query.reverse_geocode? then 'reverse' end}geocode.json?" + url_query_string(query)
-    end
-
-    private # ---------------------------------------------------------------
-
-    def results(query)
-      return [] unless doc = fetch_data(query)
-      return [] unless doc['Response'] && doc['Response']['View']
-      if r=doc['Response']['View']
-        return [] if r.nil? || !r.is_a?(Array) || r.empty?
-        return r.first['Result']
-      end
-      []
-    end
-
-    def query_url_params(query)
-      options = {
-        :gen=>1,
-        :app_id=>api_key,
-        :app_code=>api_code
-      }
-
-      if query.reverse_geocode?
-        super.merge(options).merge(
-          :prox=>query.sanitized_text,
-          :mode=>:retrieveAddresses
-        )
-      else
-        super.merge(options).merge(
-          :searchtext=>query.sanitized_text
-        )
-      end
-    end
-
-    def api_key
-      if a=configuration.api_key
-        return a.first if a.is_a?(Array)
-      end
-    end
-
-    def api_code
-      if a=configuration.api_key
-        return a.last if a.is_a?(Array)
-      end
-    end
-  end
-end

data/lib/geocoder/results/okf.rb

@@ -1,106 +0,0 @@
-require 'geocoder/results/base'
-
-module Geocoder::Result
-  class Okf < Base
-
-    def coordinates
-      ['lat', 'lng'].map{ |i| geometry['location'][i] }
-    end
-
-    def address(format = :full)
-      formatted_address
-    end
-
-    def city
-      fields = [:locality, :sublocality,
-        :administrative_area_level_3,
-        :administrative_area_level_2]
-      fields.each do |f|
-        if entity = address_components_of_type(f).first
-          return entity['long_name']
-        end
-      end
-      return nil # no appropriate components found
-    end
-
-  def state
-    ""
-  end
-
-  def sub_state
-    ""
-  end
-
-  def state_code
-    ""
-  end
-
-    def country
-      if country = address_components_of_type(:country).first
-        country['long_name']
-      end
-    end
-
-    def country_code
-      if country = address_components_of_type(:country).first
-        country['short_name']
-      end
-    end
-
-    def postal_code
-      if postal = address_components_of_type(:postal_code).first
-        postal['long_name']
-      end
-    end
-
-    def route
-      if route = address_components_of_type(:route).first
-        route['long_name']
-      end
-    end
-
-    def street_number
-      if street_number = address_components_of_type(:street_number).first
-        street_number['long_name']
-      end
-    end
-
-    def street_address
-      [route, street_number].compact.join(' ')
-    end
-
-    def types
-      @data['types']
-    end
-
-    def formatted_address
-      @data['formatted_address']
-    end
-
-    def address_components
-      @data['address_components']
-    end
-
-    ##
-    # Get address components of a given type. Valid types are defined in
-    # Google's Geocoding API documentation and include (among others):
-    #
-    #   :street_number
-    #   :locality
-    #   :neighborhood
-    #   :route
-    #   :postal_code
-    #
-    def address_components_of_type(type)
-      address_components.select{ |c| c['types'].include?(type.to_s) }
-    end
-
-    def geometry
-      @data['geometry']
-    end
-
-    def precision
-      geometry['location_type'] if geometry
-    end
-  end
-end