RubyGems - broken-geocoder - Versions diffs - 1.3.4 - Mend

broken-geocoder 1.3.4

Files changed (119) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +467 -0
data/LICENSE +20 -0
data/README.md +1193 -0
data/bin/geocode +5 -0
data/examples/autoexpire_cache_dalli.rb +62 -0
data/examples/autoexpire_cache_redis.rb +28 -0
data/examples/cache_bypass.rb +48 -0
data/examples/reverse_geocode_job.rb +40 -0
data/lib/generators/geocoder/config/config_generator.rb +14 -0
data/lib/generators/geocoder/config/templates/initializer.rb +21 -0
data/lib/generators/geocoder/maxmind/geolite_city_generator.rb +28 -0
data/lib/generators/geocoder/maxmind/geolite_country_generator.rb +28 -0
data/lib/generators/geocoder/maxmind/templates/migration/geolite_city.rb +30 -0
data/lib/generators/geocoder/maxmind/templates/migration/geolite_country.rb +17 -0
data/lib/geocoder.rb +48 -0
data/lib/geocoder/cache.rb +90 -0
data/lib/geocoder/calculations.rb +431 -0
data/lib/geocoder/cli.rb +121 -0
data/lib/geocoder/configuration.rb +129 -0
data/lib/geocoder/configuration_hash.rb +11 -0
data/lib/geocoder/esri_token.rb +38 -0
data/lib/geocoder/exceptions.rb +37 -0
data/lib/geocoder/ip_address.rb +13 -0
data/lib/geocoder/kernel_logger.rb +25 -0
data/lib/geocoder/logger.rb +47 -0
data/lib/geocoder/lookup.rb +110 -0
data/lib/geocoder/lookups/baidu.rb +59 -0
data/lib/geocoder/lookups/baidu_ip.rb +59 -0
data/lib/geocoder/lookups/base.rb +325 -0
data/lib/geocoder/lookups/bing.rb +80 -0
data/lib/geocoder/lookups/dstk.rb +20 -0
data/lib/geocoder/lookups/esri.rb +64 -0
data/lib/geocoder/lookups/freegeoip.rb +51 -0
data/lib/geocoder/lookups/geocoder_ca.rb +53 -0
data/lib/geocoder/lookups/geocoder_us.rb +43 -0
data/lib/geocoder/lookups/geocodio.rb +42 -0
data/lib/geocoder/lookups/geoip2.rb +45 -0
data/lib/geocoder/lookups/geoportail_lu.rb +65 -0
data/lib/geocoder/lookups/google.rb +91 -0
data/lib/geocoder/lookups/google_places_details.rb +50 -0
data/lib/geocoder/lookups/google_premier.rb +47 -0
data/lib/geocoder/lookups/here.rb +62 -0
data/lib/geocoder/lookups/ipapi_com.rb +86 -0
data/lib/geocoder/lookups/ipinfo_io.rb +55 -0
data/lib/geocoder/lookups/latlon.rb +59 -0
data/lib/geocoder/lookups/mapbox.rb +53 -0
data/lib/geocoder/lookups/mapquest.rb +59 -0
data/lib/geocoder/lookups/mapzen.rb +15 -0
data/lib/geocoder/lookups/maxmind.rb +90 -0
data/lib/geocoder/lookups/maxmind_geoip2.rb +69 -0
data/lib/geocoder/lookups/maxmind_local.rb +65 -0
data/lib/geocoder/lookups/nominatim.rb +52 -0
data/lib/geocoder/lookups/okf.rb +44 -0
data/lib/geocoder/lookups/opencagedata.rb +58 -0
data/lib/geocoder/lookups/ovi.rb +62 -0
data/lib/geocoder/lookups/pelias.rb +64 -0
data/lib/geocoder/lookups/pointpin.rb +68 -0
data/lib/geocoder/lookups/postcode_anywhere_uk.rb +51 -0
data/lib/geocoder/lookups/smarty_streets.rb +50 -0
data/lib/geocoder/lookups/telize.rb +55 -0
data/lib/geocoder/lookups/test.rb +44 -0
data/lib/geocoder/lookups/yandex.rb +58 -0
data/lib/geocoder/models/active_record.rb +50 -0
data/lib/geocoder/models/base.rb +39 -0
data/lib/geocoder/models/mongo_base.rb +62 -0
data/lib/geocoder/models/mongo_mapper.rb +26 -0
data/lib/geocoder/models/mongoid.rb +32 -0
data/lib/geocoder/query.rb +111 -0
data/lib/geocoder/railtie.rb +26 -0
data/lib/geocoder/request.rb +83 -0
data/lib/geocoder/results/baidu.rb +79 -0
data/lib/geocoder/results/baidu_ip.rb +62 -0
data/lib/geocoder/results/base.rb +67 -0
data/lib/geocoder/results/bing.rb +52 -0
data/lib/geocoder/results/dstk.rb +6 -0
data/lib/geocoder/results/esri.rb +75 -0
data/lib/geocoder/results/freegeoip.rb +45 -0
data/lib/geocoder/results/geocoder_ca.rb +60 -0
data/lib/geocoder/results/geocoder_us.rb +39 -0
data/lib/geocoder/results/geocodio.rb +70 -0
data/lib/geocoder/results/geoip2.rb +62 -0
data/lib/geocoder/results/geoportail_lu.rb +69 -0
data/lib/geocoder/results/google.rb +139 -0
data/lib/geocoder/results/google_places_details.rb +35 -0
data/lib/geocoder/results/google_premier.rb +6 -0
data/lib/geocoder/results/here.rb +71 -0
data/lib/geocoder/results/ipapi_com.rb +45 -0
data/lib/geocoder/results/ipinfo_io.rb +48 -0
data/lib/geocoder/results/latlon.rb +71 -0
data/lib/geocoder/results/mapbox.rb +47 -0
data/lib/geocoder/results/mapquest.rb +48 -0
data/lib/geocoder/results/mapzen.rb +5 -0
data/lib/geocoder/results/maxmind.rb +135 -0
data/lib/geocoder/results/maxmind_geoip2.rb +9 -0
data/lib/geocoder/results/maxmind_local.rb +49 -0
data/lib/geocoder/results/nominatim.rb +99 -0
data/lib/geocoder/results/okf.rb +106 -0
data/lib/geocoder/results/opencagedata.rb +90 -0
data/lib/geocoder/results/ovi.rb +71 -0
data/lib/geocoder/results/pelias.rb +58 -0
data/lib/geocoder/results/pointpin.rb +40 -0
data/lib/geocoder/results/postcode_anywhere_uk.rb +42 -0
data/lib/geocoder/results/smarty_streets.rb +106 -0
data/lib/geocoder/results/telize.rb +45 -0
data/lib/geocoder/results/test.rb +33 -0
data/lib/geocoder/results/yandex.rb +92 -0
data/lib/geocoder/sql.rb +107 -0
data/lib/geocoder/stores/active_record.rb +305 -0
data/lib/geocoder/stores/base.rb +116 -0
data/lib/geocoder/stores/mongo_base.rb +58 -0
data/lib/geocoder/stores/mongo_mapper.rb +13 -0
data/lib/geocoder/stores/mongoid.rb +13 -0
data/lib/geocoder/version.rb +3 -0
data/lib/hash_recursive_merge.rb +74 -0
data/lib/maxmind_database.rb +109 -0
data/lib/tasks/geocoder.rake +38 -0
data/lib/tasks/maxmind.rake +73 -0
metadata +167 -0

@@ -0,0 +1,20 @@
+# More information about the Data Science Toolkit can be found at:
+# http://www.datasciencetoolkit.org/. The provided APIs mimic the
+# Google geocoding api.
+require 'geocoder/lookups/google'
+require 'geocoder/results/dstk'
+module Geocoder::Lookup
+  class Dstk < Google
+    def name
+      "Data Science Toolkit"
+    end
+    def query_url(query)
+      host = configuration[:host] || "www.datasciencetoolkit.org"
+      "#{protocol}://#{host}/maps/api/geocode/json?" + url_query_string(query)
+    end
+  end
+end

data/lib/geocoder/lookups/esri.rb ADDED

@@ -0,0 +1,64 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/esri"
+require 'geocoder/esri_token'
+module Geocoder::Lookup
+  class Esri < Base
+    def name
+      "Esri"
+    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)
+    end
+    private # ---------------------------------------------------------------
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if (!query.reverse_geocode?)
+        return [] if !doc['locations'] || doc['locations'].empty?
+      end
+      if (doc['error'].nil?)
+        return [ doc ]
+      else
+        return []
+      end
+    end
+    def query_url_params(query)
+      params = {
+        :f => "pjson",
+        :outFields => "*"
+      }
+      if query.reverse_geocode?
+        params[:location] = query.coordinates.reverse.join(',')
+      else
+        params[:text] = query.sanitized_text
+      end
+      params[:token] = token
+      params[:forStorage] = configuration[:for_storage] if configuration[:for_storage]
+      params.merge(super)
+    end
+    def token
+      fetch_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 fetch_and_save_token!
+      token_instance = Geocoder::EsriToken.generate_token(*configuration.api_key)
+      Geocoder.configure(:esri => Geocoder.config[:esri].merge({:token => token_instance}))
+    end
+  end
+end

data/lib/geocoder/lookups/freegeoip.rb ADDED

@@ -0,0 +1,51 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/freegeoip'
+module Geocoder::Lookup
+  class Freegeoip < Base
+    def name
+      "FreeGeoIP"
+    end
+    def supported_protocols
+      [:http]
+    end
+    def query_url(query)
+      "#{protocol}://#{host}/json/#{query.sanitized_text}"
+    end
+    private # ---------------------------------------------------------------
+    def parse_raw_data(raw_data)
+      raw_data.match(/^<html><title>404/) ? nil : super(raw_data)
+    end
+    def results(query)
+      # don't look up a loopback address, just return the stored result
+      return [reserved_result(query.text)] if query.loopback_ip_address?
+      # note: Freegeoip.net returns plain text "Not Found" on bad request
+      (doc = fetch_data(query)) ? [doc] : []
+    end
+    def reserved_result(ip)
+      {
+        "ip"           => ip,
+        "city"         => "",
+        "region_code"  => "",
+        "region_name"  => "",
+        "metrocode"    => "",
+        "zipcode"      => "",
+        "latitude"     => "0",
+        "longitude"    => "0",
+        "country_name" => "Reserved",
+        "country_code" => "RD"
+      }
+    end
+    def host
+      configuration[:host] || "freegeoip.io"
+    end
+  end
+end

data/lib/geocoder/lookups/geocoder_ca.rb ADDED

@@ -0,0 +1,53 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/geocoder_ca"
+module Geocoder::Lookup
+  class GeocoderCa < Base
+    def name
+      "Geocoder.ca"
+    end
+    def query_url(query)
+      "#{protocol}://geocoder.ca/?" + url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if doc['error'].nil?
+        return [doc]
+      elsif doc['error']['code'] == "005"
+        # "Postal Code is not in the proper Format" => no results, just shut up
+      else
+        Geocoder.log(:warn, "Geocoder.ca service error: #{doc['error']['code']} (#{doc['error']['description']}).")
+      end
+      return []
+    end
+    def query_url_params(query)
+      params = {
+        :geoit    => "xml",
+        :jsonp    => 1,
+        :callback => "test",
+        :auth     => configuration.api_key
+      }.merge(super)
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        params[:latt] = lat
+        params[:longt] = lon
+        params[:corner] = 1
+        params[:reverse] = 1
+      else
+        params[:locate] = query.sanitized_text
+        params[:showpostal] = 1
+      end
+      params
+    end
+    def parse_raw_data(raw_data)
+      super raw_data[/^test\((.*)\)\;\s*$/, 1]
+    end
+  end
+end

data/lib/geocoder/lookups/geocoder_us.rb ADDED

@@ -0,0 +1,43 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/geocoder_us"
+module Geocoder::Lookup
+  class GeocoderUs < Base
+    def name
+      "Geocoder.us"
+    end
+      def supported_protocols
+        [:http]
+      end
+    def query_url(query)
+      if configuration.api_key
+        "#{protocol}://#{configuration.api_key}@geocoder.us/member/service/csv/geocode?" + url_query_string(query)
+      else
+        "#{protocol}://geocoder.us/service/csv/geocode?" + url_query_string(query)
+      end
+    end
+    private
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if doc[0].to_s =~ /^(\d+)\:/
+        return []
+      else
+        return [doc.size == 5 ? ((doc[0..1] << nil) + doc[2..4]) : doc]
+      end
+    end
+    def query_url_params(query)
+      (query.text =~ /^\d{5}(?:-\d{4})?$/ ? {:zip => query} : {:address => query.sanitized_text}).merge(super)
+    end
+    def parse_raw_data(raw_data)
+      raw_data.chomp.split(',')
+    end
+  end
+end

data/lib/geocoder/lookups/geocodio.rb ADDED

@@ -0,0 +1,42 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/geocodio"
+module Geocoder::Lookup
+  class Geocodio < Base
+    def name
+      "Geocodio"
+    end
+    def query_url(query)
+      path = query.reverse_geocode? ? "reverse" : "geocode"
+      "#{protocol}://api.geocod.io/v1/#{path}?#{url_query_string(query)}"
+    end
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      return doc["results"] if doc['error'].nil?
+      if doc['error'] == 'Invalid API key'
+        raise_error(Geocoder::InvalidApiKey) ||
+          Geocoder.log(:warn, "Geocodio service error: invalid API key.")
+      elsif doc['error'].match(/You have reached your daily maximum/)
+        raise_error(Geocoder::OverQueryLimitError, doc['error']) ||
+          Geocoder.log(:warn, "Geocodio service error: #{doc['error']}.")
+      else
+        raise_error(Geocoder::InvalidRequest, doc['error']) ||
+          Geocoder.log(:warn, "Geocodio service error: #{doc['error']}.")
+      end
+      []
+    end
+    private # ---------------------------------------------------------------
+    def query_url_params(query)
+      {
+        :api_key => configuration.api_key,
+        :q => query.sanitized_text
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/geoip2.rb ADDED

@@ -0,0 +1,45 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/geoip2'
+module Geocoder
+  module Lookup
+    class Geoip2 < Base
+      attr_reader :gem_name
+      def initialize
+        unless configuration[:file].nil?
+          begin
+            @gem_name = configuration[:lib] || 'maxminddb'
+            require @gem_name
+          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
+      def name
+        'GeoIP2'
+      end
+      def required_api_key_parts
+        []
+      end
+      private
+      def db_class
+        gem_name == 'hive_geoip2' ? Hive::GeoIP2 : MaxMindDB
+      end
+      def results(query)
+        return [] unless configuration[:file]
+        result = @mmdb.lookup(query.to_s)
+        result.nil? ? [] : [result]
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/geoportail_lu.rb ADDED

@@ -0,0 +1,65 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/geoportail_lu"
+module Geocoder
+  module Lookup
+    class GeoportailLu < Base
+      def name
+        "Geoportail.lu"
+      end
+      def query_url(query)
+        url_base_path(query) + url_query_string(query)
+      end
+      private
+      def url_base_path(query)
+        query.reverse_geocode? ? reverse_geocode_url_base_path : search_url_base_path
+      end
+      def search_url_base_path
+        "#{protocol}://api.geoportail.lu/geocoder/search?"
+      end
+      def reverse_geocode_url_base_path
+        "#{protocol}://api.geoportail.lu/geocoder/reverseGeocode?"
+      end
+      def query_url_geoportail_lu_params(query)
+        query.reverse_geocode? ? reverse_geocode_params(query) : search_params(query)
+      end
+      def search_params(query)
+        {
+            queryString: query.sanitized_text
+        }
+      end
+      def reverse_geocode_params(query)
+        lat_lon = query.coordinates
+        {
+            lat: lat_lon.first,
+            lon: lat_lon.last
+        }
+      end
+      def query_url_params(query)
+        query_url_geoportail_lu_params(query).merge(super)
+      end
+      def results(query)
+        return [] unless doc = fetch_data(query)
+        if doc['success'] == true
+          result = doc['results']
+        else
+          result = []
+          raise_error(Geocoder::Error) ||
+              warn("Geportail.lu Geocoding API error")
+        end
+        result
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/google.rb ADDED

@@ -0,0 +1,91 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/google"
+module Geocoder::Lookup
+  class Google < Base
+    def name
+      "Google"
+    end
+    def map_link_url(coordinates)
+      "http://maps.google.com/maps?q=#{coordinates.join(',')}"
+    end
+    def supported_protocols
+      # Google requires HTTPS if an API key is used.
+      if configuration.api_key
+        [:https]
+      else
+        [:http, :https]
+      end
+    end
+    def query_url(query)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
+    end
+    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
+      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']
+      when "OVER_QUERY_LIMIT"
+        raise_error(Geocoder::OverQueryLimitError) ||
+          Geocoder.log(:warn, "Google Geocoding API error: over query limit.")
+      when "REQUEST_DENIED"
+        raise_error(Geocoder::RequestDenied) ||
+          Geocoder.log(:warn, "Google Geocoding API error: request denied.")
+      when "INVALID_REQUEST"
+        raise_error(Geocoder::InvalidRequest) ||
+          Geocoder.log(:warn, "Google Geocoding API error: invalid request.")
+      end
+      return []
+    end
+    def query_url_google_params(query)
+      params = {
+        (query.reverse_geocode? ? :latlng : :address) => query.sanitized_text,
+        :sensor => "false",
+        :language => (query.language || configuration.language)
+      }
+      unless (bounds = query.options[:bounds]).nil?
+        params[:bounds] = bounds.map{ |point| "%f,%f" % point }.join('|')
+      end
+      unless (region = query.options[:region]).nil?
+        params[:region] = region
+      end
+      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
+    def query_url_params(query)
+      query_url_google_params(query).merge(
+        :key => configuration.api_key
+      ).merge(super)
+    end
+  end
+end