geocoder 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f394e733415900303ed8be35b91692886c134ffb
-  data.tar.gz: 21211fb7e4b78a3f957923fabe959af3e9073c4f
+  metadata.gz: 7d93c7deeb30de425af22733c64e2a6297f610a4
+  data.tar.gz: 46c3d2b77ddb91bee2156bebebf102b73c1fd328
 SHA512:
-  metadata.gz: 628aa577898b95b9a5674f2b8f97452c04744eebbe80af4a90372f5461bde24a217408dc5c06b2e99213907ee91e4beead63e51cf69e0631a1b6b42a7085e7f7
-  data.tar.gz: fad11275dbbcc8a897b9d5b9231ceb543d0b81341745aaadd5033f93950af21cf04ea2bb93f0c8242d7c81a317b1eccf4be984d2b3bae9c3cb879b1fac02510a
+  metadata.gz: 327e8d5c40c31aa09be5b8e9d0b55ec18e74a8da166d0d65882fe31760182c4d96b36bfe3c0261cdeb2a5b91aefca204114d7bcc54dd46ea68e1cb7f0b7e3fd0
+  data.tar.gz: 5ad20ece66d7117b6e0928dd19daf8f602496a9b033fcf6833f58a0f6d9efd87388289681adf3a96a7c4ad71e159d7b06c956aca2e3646cdf8087bd4a570aec7

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.4.4 (2017 May 17)
+-------------------
+* Use HTTPS by default for :freegeoip (thanks github.com/mehanoid).
+* Add support for :amap lookup (thanks github.com/pzgz).
+
 1.4.3 (2017 Feb  7)
 -------------------
 * Add :google_places_search lookup (thanks github.com/waruboy).

data/README.md

@@ -176,11 +176,11 @@ Some utility methods are also available:
     # look up coordinates of some location (like searching Google Maps)
     Geocoder.coordinates("25 Main St, Cooperstown, NY")
      => [42.700149, -74.922767]
-
+    
     # distance between Eiffel Tower and Empire State Building
     Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
      => 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])
      => [35.14968, -90.048929]
@@ -333,26 +333,26 @@ Some common configuration options are:
 
     # config/initializers/geocoder.rb
     Geocoder.configure(
-
+    
       # geocoding service (see below for supported options):
       :lookup => :yandex,
-
+    
       # IP address geocoding service (see below for supported options):
       :ip_lookup => :maxmind,
-
+    
       # to use an API key:
       :api_key => "...",
-
+    
       # geocoding service request timeout, in seconds (default 3):
       :timeout => 5,
-
+    
       # set default units to kilometers:
       :units => :km,
-
+    
       # caching (see below for details):
       :cache => Redis.new,
       :cache_prefix => "..."
-
+    
     )
 
 Please see `lib/geocoder/configuration.rb` for a complete list of configuration options. Additionally, some lookups have their own configuration options, some of which are directly supported by Geocoder. For example, to specify a value for Google's `bounds` parameter:
@@ -375,21 +375,21 @@ You can also configure multiple geocoding services at once, like this:
 
       :timeout => 2,
       :cache => Redis.new,
-
+    
       :yandex => {
         :api_key => "...",
         :timeout => 5
       },
-
+    
       :baidu => {
         :api_key => "..."
       },
-
+    
       :maxmind => {
         :api_key => "...",
         :service => :omni
       }
-
+    
     )
 
 The above combines global and service-specific options and could be useful if you specify different geocoding services for different models or under different conditions. Lookup-specific settings override global settings. In the above example, the timeout for all lookups would be 2 seconds, except for Yandex which would be 5.
@@ -713,6 +713,18 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 * **Terms of Service**: https://adresse.data.gouv.fr/faq/ (in french)
 * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://openstreetmap.fr/ban)
 
+#### AMap (`:amap`)
+
+- **API key**: required
+- **Quota**: 2000/day and 2000/minute for personal developer, 4000000/day and 60000/minute for enterprise developer, for geocoding requests
+- **Region**: China
+- **SSL support**: yes
+- **Languages**: Chinese (Simplified)
+- **Documentation**: http://lbs.amap.com/api/webservice/guide/api/georegeo
+- **Terms of Service**: http://lbs.amap.com/home/terms/
+- **Limitations**: Only good for non-commercial use. For commercial usage please check http://lbs.amap.com/home/terms/
+- **Notes**: To use AMap set `Geocoder.configure(:lookup => :amap, :api_key => "your_api_key")`.
+
 ### IP Address Services
 
 #### FreeGeoIP (`:freegeoip`)
@@ -835,7 +847,7 @@ You can generate ActiveRecord migrations and download and import data via provid
 
     # generate migration to create tables
     rails generate geocoder:maxmind:geolite_city
-
+    
     # download, unpack, and import data
     rake geocoder:maxmind:geolite:load PACKAGE=city
 
@@ -884,6 +896,7 @@ This example uses Redis, but the cache store can be any object that supports the
 * `store#[](key)` or `#get` or `#read` - retrieves a value
 * `store#[]=(key, value)` or `#set` or `#write` - stores a value
 * `store#del(url)` - deletes a value
+* `store#keys` - (Optional) Returns array of keys. Used if you wish to expire the entire cache (see below).
 
 Even a plain Ruby hash will work, though it's not a great choice (cleared out when app is restarted, not shared between app instances, etc).
 
@@ -923,7 +936,7 @@ For example:
 
       # build an address from street, city, and state attributes
       geocoded_by :address_from_components
-
+    
       # store the fetched address in the full_address attribute
       reverse_geocoded_by :latitude, :longitude, :address => :full_address
     end
@@ -935,7 +948,7 @@ However, there can be only one set of latitude/longitude attributes, and whichev
       geocoded_by :address,
         :latitude  => :fetched_latitude,  # this will be overridden by the below
         :longitude => :fetched_longitude  # same here
-
+    
       reverse_geocoded_by :latitude, :longitude
     end
 
@@ -963,7 +976,7 @@ For example:
 
       after_validation :reverse_geocode, :if => :has_coordinates
       after_validation :geocode, :if => :has_location, :unless => :has_coordinates
-
+    
     end
 
 Use Outside of Rails
@@ -1193,7 +1206,7 @@ Instead of using `includes` to reduce the number of database queries, try using
     # Pass a :select option to the near scope to get the columns you want.
     # Instead of City.near(...).includes(:venues), try:
     City.near("Omaha, NE", 20, :select => "cities.*, venues.*").joins(:venues)
-
+    
     # This preload call will normally trigger two queries regardless of the
     # number of results; one query on hotels, and one query on administrators.
     # Instead of Hotel.near(...).includes(:administrator), try:

data/lib/generators/geocoder/config/templates/initializer.rb

@@ -2,12 +2,13 @@ Geocoder.configure(
   # Geocoding options
   # timeout: 3,                 # geocoding service timeout (secs)
   # lookup: :google,            # name of geocoding service (symbol)
+  # ip_lookup: :freegeoip,      # name of IP address geocoding service (symbol)
   # language: :en,              # ISO-639 language code
   # use_https: false,           # use HTTPS for lookup requests? (if supported)
   # http_proxy: nil,            # HTTP proxy server (user:pass@host:port)
   # https_proxy: nil,           # HTTPS proxy server (user:pass@host:port)
   # api_key: nil,               # API key for geocoding service
-  # cache: nil,                 # cache object (must respond to #[], #[]=, and #keys)
+  # cache: nil,                 # cache object (must respond to #[], #[]=, and #del)
   # cache_prefix: 'geocoder:',  # prefix (string) to use for all cache keys
 
   # Exceptions that should not be rescued by default

data/lib/geocoder/cache.rb

@@ -40,7 +40,11 @@ module Geocoder
     #
     def expire(url)
       if url == :all
-        urls.each{ |u| expire(u) }
+        if store.respond_to?(:keys)
+          urls.each{ |u| expire(u) }
+        else
+          raise(NoMethodError, "The Geocoder cache store must implement `#keys` for `expire(:all)` to work")
+        end
       else
         expire_single_url(url)
       end

data/lib/geocoder/lookup.rb

@@ -50,7 +50,8 @@ module Geocoder
         :geoportail_lu,
         :ban_data_gouv_fr,
         :test,
-        :latlon
+        :latlon,
+        :amap
       ]
     end
 

data/lib/geocoder/lookups/amap.rb

@@ -0,0 +1,59 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/amap"
+
+module Geocoder::Lookup
+  class Amap < Base
+
+    def name
+      "AMap"
+    end
+
+    def required_api_key_parts
+      ["key"]
+    end
+
+    def query_url(query)
+      path = query.reverse_geocode? ? 'regeo' : 'geo'
+      "http://restapi.amap.com/v3/geocode/#{path}?" + url_query_string(query)
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query, reverse = false)
+      return [] unless doc = fetch_data(query)
+      case [doc['status'], doc['info']]
+      when ['1', 'OK']
+        return doc['regeocodes'] unless doc['regeocodes'].blank?
+        return [doc['regeocode']] unless doc['regeocode'].blank?
+        return doc['geocodes'] unless doc['geocodes'].blank?
+      when ['0', 'INVALID_USER_KEY']
+        raise_error(Geocoder::InvalidApiKey, "invalid api key") ||
+          warn("#{self.name} Geocoding API error: invalid api key.")
+      else
+        raise_error(Geocoder::Error, "server error.") ||
+          warn("#{self.name} Geocoding API error: server error - [#{doc['info']}]")
+      end
+      return []
+    end
+
+    def query_url_params(query)
+      params = {
+        :key => configuration.api_key,
+        :output => "json"
+      }
+      if query.reverse_geocode?
+        params[:location] = revert_coordinates(query.text)
+        params[:extensions] = "all"
+        params[:coordsys] = "gps"
+      else
+        params[:address] = query.sanitized_text
+      end
+      params.merge(super)
+    end
+
+    def revert_coordinates(text)
+      [text[1],text[0]].join(",")
+    end
+
+  end
+end

data/lib/geocoder/lookups/freegeoip.rb

@@ -9,7 +9,12 @@ module Geocoder::Lookup
     end
     
     def supported_protocols
-      [:http]
+      if configuration[:host]
+        [:http, :https]
+      else
+        # use https for default host
+        [:https]
+      end
     end
 
     def query_url(query)

data/lib/geocoder/request.rb

@@ -1,3 +1,5 @@
+require 'ipaddr'
+
 module Geocoder
   module Request
 
@@ -54,6 +56,8 @@ module Geocoder
       GEOCODER_CANDIDATE_HEADERS.each do |header|
         if @env.has_key? header
           addrs = geocoder_split_ip_addresses(@env[header])
+          addrs = geocoder_remove_port_from_addresses(addrs)
+          addrs = geocoder_reject_non_ipv4_addresses(addrs)
           addrs = geocoder_reject_trusted_ip_addresses(addrs)
           return addrs.first if addrs.any?
         end
@@ -75,6 +79,23 @@ module Geocoder
     def geocoder_reject_trusted_ip_addresses(ip_addresses)
       ip_addresses.reject { |ip| trusted_proxy?(ip) }
     end
+
+    def geocoder_remove_port_from_addresses(ip_addresses)
+      ip_addresses.map { |ip| ip.split(':').first }
+    end
+
+    def geocoder_reject_non_ipv4_addresses(ip_addresses)
+      ips = []
+      for ip in ip_addresses
+        begin
+          valid_ip = IPAddr.new(ip)
+        rescue
+          valid_ip = false
+        end
+        ips << valid_ip.to_s if valid_ip
+      end
+      return ips.any? ? ips : ip_addresses
+    end
   end
 end
 

data/lib/geocoder/results/amap.rb

@@ -0,0 +1,87 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Amap < Base
+
+    def coordinates
+      location = @data['location'] || @data['roadinters'].try(:first).try(:[], 'location') \
+        || address_components.try(:[], 'streetNumber').try(:[], 'location')
+      location.to_s.split(",").reverse.map(&:to_f)
+    end
+
+    def address
+      formatted_address
+    end
+
+    def state
+      province
+    end
+
+    def province
+      address_components['province']
+    end
+
+    def city
+      address_components['city'] == [] ? province : address_components["city"]
+    end
+
+    def district
+      address_components['district']
+    end
+
+    def street
+      if address_components["neighborhood"]["name"] != []
+        return address_components["neighborhood"]["name"]
+      elsif address_components['township'] != []
+        return address_components["township"]
+      else
+        return @data['street'] || address_components['streetNumber'].try(:[], 'street')
+      end
+    end
+
+    def street_number
+      @data['number'] || address_components['streetNumber'].try(:[], 'number')
+    end
+
+    def formatted_address
+      @data['formatted_address']
+    end
+
+    def address_components
+      @data['addressComponent'] || @data
+    end
+
+    def state_code
+      ""
+    end
+
+    def postal_code
+      ""
+    end
+
+    def country
+      "China"
+    end
+
+    def country_code
+      "CN"
+    end
+
+    ##
+    # Get address components of a given type. Valid types are defined in
+    # Baidu's Geocoding API documentation and include (among others):
+    #
+    #   :business
+    #   :cityCode
+    #
+    def self.response_attributes
+      %w[roads pois roadinters]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/results/geoip2.rb

@@ -15,11 +15,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 +31,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 +54,26 @@ module Geocoder
         end
       end
 
+      def language=(l)
+        @language = l.to_s
+      end
+
+      def language
+        @language ||= default_language
+      end
+
       private
 
       def data
         @data.to_hash
       end
 
-      def locale
-        @locale ||= Geocoder.config[:language].to_s
+      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/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/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

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-05-17 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,
@@ -47,6 +47,7 @@ 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
@@ -94,6 +95,7 @@ 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
@@ -164,7 +166,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.