geocoder 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d790b89d4257ea08df5cc44f42b141e528ab807b
-  data.tar.gz: d9b4a0cbe6b3f4c709040e9b784cb8e605e5b9ce
+  metadata.gz: b7f44c3ea3ee0cecd7dfaa73c96393864f578c01
+  data.tar.gz: 39a47431d911edda32bd8182cb051c5af49dbad0
 SHA512:
-  metadata.gz: ecfc4e757b64650f23cb1cbba2aa7294395c5cb1deff2e30f52639951c7392104c4cca299655062558540147ffab088a4d66de5da37cde17e2c0de7cfc60ab61
-  data.tar.gz: 6e60f809ce62c62bbe05522ceb1adeb5f8e6fbbff9e6eea61d934d1362afdc8123525ca30674c000f92b440182a3e6b038b0389a37128dd5a9d5e5bfb715c33b
+  metadata.gz: d463d7fd2cfad2c24e5d2c7a37cb5e11285a07291f6dd0a758547727beb0651d06c2165455794e9ce26229ec067a3084dd25b4a28f11b1bc18ea9992b7164795
+  data.tar.gz: e17a5c5e8dff69d558f56a1c4510988c68df7c538fb42897b43f95b9b2a410a3e19c83b72eb44af176c09879c3fc5f6dcb49dc6d41a378c734b070a6d4af18af

data/CHANGELOG.md

@@ -3,10 +3,19 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.3.5 (2016 May 27)
+-------------------
+* Fix Rails 5 ActionDispatch include issue (thanks github.com/alepore).
+* Fix bug that caused :esri lookup to ignore certain configured parameters (thanks github.com/aaronpk).
+* Add reverse geocoding support to :pelias/:mapzen (thanks github.com/shinyaK14).
+* Add support for custom host with :telize (thanks github.com/jwaldrip).
+* Change the way :esri lookup generates cache keys for improved performance (thanks github.com/aaronpk).
+* Improve HTTPS connections with :google (thanks github.com/jlhonora).
+
 1.3.4 (2016 Apr 14)
 -------------------
 * Update :freegeoip host (old one is down).
-* Add ip-api.com IP address lookup (thanks github.com/piotrgorecki).
+* Add IP lookup :ipapi_com (thanks github.com/piotrgorecki).
 
 1.3.3 (2016 Apr 4)
 ------------------

data/README.md

@@ -11,7 +11,7 @@ Compatibility
 
 * 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).
+* Supports Rails 3, 4, and 5. 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.
 
 
@@ -555,15 +555,15 @@ The [Google Places Details API](https://developers.google.com/places/documentati
 
 #### ESRI (`:esri`)
 
-* **API key**: none
+* **API key**: optional (set `Geocoder.configure(:esri => {:api_key => ["client_id", "client_secret"]})`)
 * **Quota**: Required for some scenarios (see Terms of Service)
 * **Region**: world
 * **SSL support**: yes
 * **Languages**: English
-* **Documentation**: http://resources.arcgis.com/en/help/arcgis-online-geocoding-rest-api/
+* **Documentation**: https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm
 * **Terms of Service**: http://www.esri.com/legal/software-license
-* **Limitations**: ?
-* **Notes**: You can specify which projection you want to use by setting, for example: `Geocoder.configure(:esri => {:outSR => 102100})`.
+* **Limitations**: Requires API key if results will be stored. Using API key will also remove rate limit.
+* **Notes**: You can specify which projection you want to use by setting, for example: `Geocoder.configure(:esri => {:outSR => 102100})`. If you will store results, set the flag and provide API key: `Geocoder.configure(:esri => {:api_key => ["client_id", "client_secret"], :for_storage => true})`. If you want to, you can also supply an ESRI token directly: `Geocoder.configure(:esri => {:token => Geocoder::EsriToken.new('TOKEN', Time.now + 1.day})`
 
 #### Mapzen (`:mapzen`)
 

data/lib/geocoder/configuration.rb

@@ -38,6 +38,14 @@ module Geocoder
     data
   end
 
+  ##
+  # Merge the given hash into a lookup's existing configuration.
+  #
+  def self.merge_into_lookup_config(lookup_name, options)
+    base = Geocoder.config[lookup_name]
+    Geocoder.configure(lookup_name => base.merge(options))
+  end
+
   class Configuration
     include Singleton
 

data/lib/geocoder/esri_token.rb

@@ -0,0 +1,38 @@
+module Geocoder
+  class EsriToken
+    attr_accessor :value, :expires_at
+
+    def initialize(value, expires_at)
+      @value = value
+      @expires_at = expires_at
+    end
+
+    def to_s
+        @value
+    end
+
+    def active?
+      @expires_at > Time.now
+    end
+
+    def self.generate_token(client_id, client_secret, expires=1440)
+      # creates a new token that will expire in 1 day by default
+      getToken = Net::HTTP.post_form URI('https://www.arcgis.com/sharing/rest/oauth2/token'),
+        f: 'json',
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: 'client_credentials',
+        expiration: expires # (minutes) max: 20160, default: 1 day
+
+      response = JSON.parse(getToken.body)
+
+      if response['error']
+        Geocoder.log(:warn, response['error'])
+      else
+        token_value = response['access_token']
+        expires_at = Time.now + (expires * 60)
+        new(token_value, expires_at)
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/base.rb

@@ -274,6 +274,7 @@ module Geocoder
         uri = URI.parse(query_url(query))
         Geocoder.log(:debug, "Geocoder: HTTP request being made for #{uri.to_s}")
         http_client.start(uri.host, uri.port, use_ssl: use_ssl?, open_timeout: configuration.timeout, read_timeout: configuration.timeout) do |client|
+          configure_ssl!(client) if use_ssl?
           req = Net::HTTP::Get.new(uri.request_uri, configuration.http_headers)
           if configuration.basic_auth[:user] and configuration.basic_auth[:password]
             req.basic_auth(
@@ -297,6 +298,8 @@ module Geocoder
         end
       end
 
+      def configure_ssl!(client); end
+
       def check_api_key_configuration!(query)
         key_parts = query.lookup.required_api_key_parts
         if key_parts.size > Array(configuration.api_key).size

data/lib/geocoder/lookups/esri.rb

@@ -1,5 +1,6 @@
 require 'geocoder/lookups/base'
 require "geocoder/results/esri"
+require 'geocoder/esri_token'
 
 module Geocoder::Lookup
   class Esri < Base
@@ -9,14 +10,16 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      search_keyword = query.reverse_geocode? ? "reverseGeocode" : "find"
-
-      "#{protocol}://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/#{search_keyword}?" +
-        url_query_string(query)
+      base_query_url(query) + url_query_string(query)
     end
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      action = query.reverse_geocode? ? "reverseGeocode" : "find"
+      "#{protocol}://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/#{action}?"
+    end
+
     def results(query)
       return [] unless doc = fetch_data(query)
 
@@ -31,6 +34,17 @@ module Geocoder::Lookup
       end
     end
 
+    def cache_key(query)
+      base_query_url(query) + hash_to_query(cache_key_params(query))
+    end
+
+    def cache_key_params(query)
+      # omit api_key and token because they may vary among requests
+      query_url_params(query).reject do |key,value|
+        [:api_key, :token].include?(key)
+      end
+    end
+
     def query_url_params(query)
       params = {
         :f => "pjson",
@@ -41,8 +55,31 @@ module Geocoder::Lookup
       else
         params[:text] = query.sanitized_text
       end
+      params[:token] = token
+      params[:forStorage] = configuration[:for_storage] if configuration[:for_storage]
+      params[:sourceCountry] = configuration[:source_country] if configuration[:source_country]
       params.merge(super)
     end
 
+    def token
+      create_and_save_token! if !valid_token_configured? and configuration.api_key
+      configuration[:token].to_s unless configuration[:token].nil?
+    end
+
+    def valid_token_configured?
+      !configuration[:token].nil? and configuration[:token].active?
+    end
+
+    def create_and_save_token!
+      save_token!(create_token)
+    end
+
+    def create_token
+      Geocoder::EsriToken.generate_token(*configuration.api_key)
+    end
+
+    def save_token!(token_instance)
+      Geocoder.merge_into_lookup_config(:esri, token: token_instance)
+    end
   end
 end

data/lib/geocoder/lookups/google.rb

@@ -27,6 +27,17 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def configure_ssl!(client)
+      client.instance_eval {
+        @ssl_context = OpenSSL::SSL::SSLContext.new
+        options = OpenSSL::SSL::OP_NO_SSLv2 | OpenSSL::SSL::OP_NO_SSLv3
+        if OpenSSL::SSL.const_defined?('OP_NO_COMPRESSION')
+          options |= OpenSSL::SSL::OP_NO_COMPRESSION
+        end
+        @ssl_context.set_params({options: options})
+      }
+    end
+
     def valid_response?(response)
       json = parse_json(response.body)
       status = json["status"] if json
@@ -65,6 +76,9 @@ module Geocoder::Lookup
       unless (components = query.options[:components]).nil?
         params[:components] = components.is_a?(Array) ? components.join("|") : components
       end
+      unless (result_type = query.options[:result_type]).nil?
+        params[:result_type] = result_type.is_a?(Array) ? result_type.join("|") : result_type
+      end
       params
     end
 

data/lib/geocoder/lookups/ipapi_com.rb

@@ -9,7 +9,8 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      url_ = "#{protocol}://ip-api.com/json/#{query.sanitized_text}"
+      domain = configuration.api_key ? "pro.ip-api.com" : "ip-api.com"
+      url_ = "#{protocol}://#{domain}/json/#{query.sanitized_text}"
 
       if (params = url_query_string(query)) && !params.empty?
         url_ + "?" + params
@@ -29,17 +30,32 @@ module Geocoder::Lookup
 
     private
 
+    def parse_raw_data(raw_data)
+      if raw_data.chomp == "invalid key"
+        invalid_key_result
+      else
+        super(raw_data)
+      end
+    end
+
     def results(query)
       return [reserved_result(query.text)] if query.loopback_ip_address?
 
-      (doc = fetch_data(query)) ? [doc] : []
+      return [] unless doc = fetch_data(query)
+
+      if doc["message"] == "invalid key"
+        raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "Invalid API key.")
+        return []
+      else
+        return [doc]
+      end
     end
 
     def reserved_result(query)
       {
         "message"      => "reserved range",
         "query"        => query,
-        "status"       => fail,
+        "status"       => "fail",
         "ip"           => query,
         "city"         => "",
         "region_code"  => "",
@@ -53,6 +69,12 @@ module Geocoder::Lookup
       }
     end
 
+    def invalid_key_result
+      {
+        "message"      => "invalid key"
+      }
+    end
+
     def query_url_params(query)
       params = {}
       params.merge!(fields: configuration[:fields]) if configuration.has_key?(:fields)

data/lib/geocoder/lookups/pelias.rb

@@ -23,11 +23,19 @@ module Geocoder::Lookup
     private
 
     def query_url_params(query)
-      {
+      params = {
         api_key: configuration.api_key,
-        text: query.text,
         size: 1
-      }.merge(super(query))
+      }.merge(super)
+
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        params[:'point.lat'] = lat
+        params[:'point.lon'] = lon
+      else
+        params[:text] = query.text
+      end
+      params
     end
 
     def results(query)

data/lib/geocoder/lookups/telize.rb

@@ -9,15 +9,22 @@ module Geocoder::Lookup
     end
 
     def required_api_key_parts
-      ["key"]
+      configuration[:host] ? [] : ["key"]
     end
 
     def query_url(query)
-      "#{protocol}://telize-v1.p.mashape.com/geoip/#{query.sanitized_text}?mashape-key=#{api_key}"
+      if configuration[:host]
+        "#{protocol}://#{configuration[:host]}/geoip/#{query.sanitized_text}"
+      else
+        "#{protocol}://telize-v1.p.mashape.com/geoip/#{query.sanitized_text}?mashape-key=#{api_key}"
+      end
     end
 
     def supported_protocols
-      [:https]
+      [].tap do |array|
+        array << :https
+        array << :http if configuration[:host]
+      end
     end
 
     private # ---------------------------------------------------------------
@@ -43,5 +50,6 @@ module Geocoder::Lookup
     def api_key
       configuration.api_key
     end
+    
   end
 end

data/lib/geocoder/request.rb

@@ -78,6 +78,6 @@ module Geocoder
   end
 end
 
-if defined?(Rack) and defined?(Rack::Request)
-  Rack::Request.send :include, Geocoder::Request
+if defined?(ActionDispatch::Request)
+  ActionDispatch::Request.include Geocoder::Request
 end

data/lib/geocoder/results/geoip2.rb

@@ -9,15 +9,9 @@ module Geocoder
       end
 
       def coordinates
-        [latitude, longitude]
-      end
-
-      def latitude
-        data.fetch('location', {}).fetch('latitude', 0.0)
-      end
-
-      def longitude
-        data.fetch('location', {}).fetch('longitude', 0.0)
+        %w[latitude longitude].map do |l|
+          data.fetch('location', {}).fetch(l, 0.0)
+        end
       end
 
       def city

data/lib/geocoder/results/ipapi_com.rb

@@ -3,14 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class IpapiCom < Base
 
-    def latitude
-      lat
-    end
-
-    def longitude
-      lon
-    end
-
     def coordinates
       [lat, lon]
     end

data/lib/geocoder/results/ipinfo_io.rb

@@ -7,16 +7,8 @@ module Geocoder::Result
       "#{city} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
-    def latitude
-      @data['loc'].split(',')[0].to_f
-    end
-
-    def longitude
-      @data['loc'].split(',')[1].to_f
-    end
-
     def coordinates
-        [latitude, longitude]
+      @data['loc'].split(",").map(&:to_f)
     end
 
     def city

data/lib/geocoder/results/mapbox.rb

@@ -3,16 +3,8 @@ 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]
+      @data["geometry"]["coordinates"].reverse.map(&:to_f)
     end
 
     def place_name

data/lib/geocoder/results/mapquest.rb

@@ -2,16 +2,9 @@ require 'geocoder/results/base'
 
 module Geocoder::Result
   class Mapquest < Base
-    def latitude
-      @data["latLng"]["lat"]
-    end
-
-    def longitude
-      @data["latLng"]["lng"]
-    end
 
     def coordinates
-      [latitude, longitude]
+      %w[lat lng].map{ |l| @data["latLng"][l] }
     end
 
     def city

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.3.4"
+  VERSION = "1.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-05-27 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,
@@ -41,6 +41,7 @@ files:
 - lib/geocoder/cli.rb
 - lib/geocoder/configuration.rb
 - lib/geocoder/configuration_hash.rb
+- lib/geocoder/esri_token.rb
 - lib/geocoder/exceptions.rb
 - lib/geocoder/ip_address.rb
 - lib/geocoder/kernel_logger.rb
@@ -157,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.