RubyGems - geocoder-sgonyea - Versions diffs - 1.1.6.1 - Mend

geocoder-sgonyea 1.1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (122) hide show

data/.gitignore +5 -0
data/.travis.yml +23 -0
data/CHANGELOG.md +298 -0
data/LICENSE +20 -0
data/README.md +656 -0
data/Rakefile +25 -0
data/bin/geocode +5 -0
data/examples/autoexpire_cache.rb +28 -0
data/gemfiles/Gemfile.mongoid-2.4.x +15 -0
data/lib/generators/geocoder/config/config_generator.rb +14 -0
data/lib/generators/geocoder/config/templates/initializer.rb +21 -0
data/lib/geocoder.rb +55 -0
data/lib/geocoder/cache.rb +85 -0
data/lib/geocoder/calculations.rb +319 -0
data/lib/geocoder/cli.rb +114 -0
data/lib/geocoder/configuration.rb +130 -0
data/lib/geocoder/configuration_hash.rb +11 -0
data/lib/geocoder/exceptions.rb +21 -0
data/lib/geocoder/lookup.rb +82 -0
data/lib/geocoder/lookups/base.rb +250 -0
data/lib/geocoder/lookups/bing.rb +47 -0
data/lib/geocoder/lookups/freegeoip.rb +47 -0
data/lib/geocoder/lookups/geocoder_ca.rb +54 -0
data/lib/geocoder/lookups/google.rb +62 -0
data/lib/geocoder/lookups/google_premier.rb +47 -0
data/lib/geocoder/lookups/mapquest.rb +43 -0
data/lib/geocoder/lookups/maxmind.rb +88 -0
data/lib/geocoder/lookups/nominatim.rb +45 -0
data/lib/geocoder/lookups/ovi.rb +52 -0
data/lib/geocoder/lookups/test.rb +38 -0
data/lib/geocoder/lookups/yahoo.rb +84 -0
data/lib/geocoder/lookups/yandex.rb +54 -0
data/lib/geocoder/models/active_record.rb +46 -0
data/lib/geocoder/models/base.rb +42 -0
data/lib/geocoder/models/mongo_base.rb +60 -0
data/lib/geocoder/models/mongo_mapper.rb +26 -0
data/lib/geocoder/models/mongoid.rb +32 -0
data/lib/geocoder/query.rb +103 -0
data/lib/geocoder/railtie.rb +26 -0
data/lib/geocoder/request.rb +23 -0
data/lib/geocoder/results/base.rb +67 -0
data/lib/geocoder/results/bing.rb +48 -0
data/lib/geocoder/results/freegeoip.rb +45 -0
data/lib/geocoder/results/geocoder_ca.rb +60 -0
data/lib/geocoder/results/google.rb +106 -0
data/lib/geocoder/results/google_premier.rb +6 -0
data/lib/geocoder/results/mapquest.rb +51 -0
data/lib/geocoder/results/maxmind.rb +136 -0
data/lib/geocoder/results/nominatim.rb +94 -0
data/lib/geocoder/results/ovi.rb +62 -0
data/lib/geocoder/results/test.rb +16 -0
data/lib/geocoder/results/yahoo.rb +55 -0
data/lib/geocoder/results/yandex.rb +80 -0
data/lib/geocoder/sql.rb +106 -0
data/lib/geocoder/stores/active_record.rb +259 -0
data/lib/geocoder/stores/base.rb +120 -0
data/lib/geocoder/stores/mongo_base.rb +85 -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/oauth_util.rb +112 -0
data/lib/tasks/geocoder.rake +25 -0
data/test/active_record_test.rb +15 -0
data/test/cache_test.rb +19 -0
data/test/calculations_test.rb +195 -0
data/test/configuration_test.rb +78 -0
data/test/custom_block_test.rb +32 -0
data/test/error_handling_test.rb +43 -0
data/test/fixtures/bing_invalid_key +1 -0
data/test/fixtures/bing_madison_square_garden +40 -0
data/test/fixtures/bing_no_results +16 -0
data/test/fixtures/bing_reverse +42 -0
data/test/fixtures/freegeoip_74_200_247_59 +12 -0
data/test/fixtures/freegeoip_no_results +1 -0
data/test/fixtures/geocoder_ca_madison_square_garden +1 -0
data/test/fixtures/geocoder_ca_no_results +1 -0
data/test/fixtures/geocoder_ca_reverse +34 -0
data/test/fixtures/google_garbage +456 -0
data/test/fixtures/google_madison_square_garden +57 -0
data/test/fixtures/google_no_city_data +44 -0
data/test/fixtures/google_no_locality +51 -0
data/test/fixtures/google_no_results +4 -0
data/test/fixtures/mapquest_madison_square_garden +52 -0
data/test/fixtures/mapquest_no_results +7 -0
data/test/fixtures/maxmind_24_24_24_21 +1 -0
data/test/fixtures/maxmind_24_24_24_22 +1 -0
data/test/fixtures/maxmind_24_24_24_23 +1 -0
data/test/fixtures/maxmind_24_24_24_24 +1 -0
data/test/fixtures/maxmind_74_200_247_59 +1 -0
data/test/fixtures/maxmind_invalid_key +1 -0
data/test/fixtures/maxmind_no_results +1 -0
data/test/fixtures/nominatim_madison_square_garden +150 -0
data/test/fixtures/nominatim_no_results +1 -0
data/test/fixtures/ovi_madison_square_garden +72 -0
data/test/fixtures/ovi_no_results +8 -0
data/test/fixtures/yahoo_error +1 -0
data/test/fixtures/yahoo_invalid_key +2 -0
data/test/fixtures/yahoo_madison_square_garden +52 -0
data/test/fixtures/yahoo_no_results +10 -0
data/test/fixtures/yahoo_over_limit +2 -0
data/test/fixtures/yandex_invalid_key +1 -0
data/test/fixtures/yandex_kremlin +48 -0
data/test/fixtures/yandex_no_city_and_town +112 -0
data/test/fixtures/yandex_no_results +16 -0
data/test/geocoder_test.rb +59 -0
data/test/https_test.rb +16 -0
data/test/integration/smoke_test.rb +26 -0
data/test/lookup_test.rb +116 -0
data/test/method_aliases_test.rb +25 -0
data/test/mongoid_test.rb +39 -0
data/test/mongoid_test_helper.rb +43 -0
data/test/near_test.rb +43 -0
data/test/oauth_util_test.rb +30 -0
data/test/proxy_test.rb +23 -0
data/test/query_test.rb +51 -0
data/test/request_test.rb +29 -0
data/test/result_test.rb +42 -0
data/test/services_test.rb +277 -0
data/test/test_helper.rb +279 -0
data/test/test_mode_test.rb +50 -0
metadata +170 -0

data/lib/geocoder/lookups/bing.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/bing"
+module Geocoder::Lookup
+  class Bing < Base
+    def name
+      "Bing"
+    end
+    def map_link_url(coordinates)
+      "http://www.bing.com/maps/default.aspx?cp=#{coordinates.join('~')}"
+    end
+    def required_api_key_parts
+      ["key"]
+    end
+    def query_url(query)
+      "#{protocol}://dev.virtualearth.net/REST/v1/Locations" +
+        (query.reverse_geocode? ? "/#{query.sanitized_text}?" : "?") +
+        url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if doc['statusCode'] == 200
+        return doc['resourceSets'].first['estimatedTotal'] > 0 ? doc['resourceSets'].first['resources'] : []
+      elsif doc['statusCode'] == 401 and doc["authenticationResultCode"] == "InvalidCredentials"
+        raise_error(Geocoder::InvalidApiKey) || warn("Invalid Bing API key.")
+      else
+        warn "Bing Geocoding API error: #{doc['statusCode']} (#{doc['statusDescription']})."
+      end
+      return []
+    end
+    def query_url_params(query)
+      {
+        :key => configuration.api_key,
+        :query => query.reverse_geocode? ? nil : query.sanitized_text
+      }.merge(super)
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/freegeoip'
+module Geocoder::Lookup
+  class Freegeoip < Base
+    def name
+      "FreeGeoIP"
+    end
+    def query_url(query)
+      "#{protocol}://freegeoip.net/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?
+      begin
+        return (doc = fetch_data(query)) ? [doc] : []
+      rescue StandardError => err # Freegeoip.net returns HTML on bad request
+        raise_error(err)
+        return []
+      end
+    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
+  end
+end

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

@@ -0,0 +1,54 @@
+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
+        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/google.rb ADDED Viewed

@@ -0,0 +1,62 @@
+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 query_url(query)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    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) ||
+          warn("Google Geocoding API error: over query limit.")
+      when "REQUEST_DENIED"
+        raise_error(Geocoder::RequestDenied) ||
+          warn("Google Geocoding API error: request denied.")
+      when "INVALID_REQUEST"
+        raise_error(Geocoder::InvalidRequest) ||
+          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 => 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
+      params
+    end
+    def query_url_params(query)
+      query_url_google_params(query).merge(
+        :key => configuration.api_key
+      ).merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/google_premier.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'openssl'
+require 'base64'
+require 'geocoder/lookups/google'
+require 'geocoder/results/google_premier'
+module Geocoder::Lookup
+  class GooglePremier < Google
+    def name
+      "Google Premier"
+    end
+    def required_api_key_parts
+      ["private key", "client", "channel"]
+    end
+    def query_url(query)
+      path = "/maps/api/geocode/json?" + url_query_string(query)
+      "#{protocol}://maps.googleapis.com#{path}&signature=#{sign(path)}"
+    end
+    private # ---------------------------------------------------------------
+    def query_url_params(query)
+      query_url_google_params(query).merge(super).merge(
+        :key => nil, # don't use param inherited from Google lookup
+        :client => configuration.api_key[1],
+        :channel => configuration.api_key[2]
+      )
+    end
+    def sign(string)
+      raw_private_key = url_safe_base64_decode(configuration.api_key[0])
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      raw_signature = OpenSSL::HMAC.digest(digest, raw_private_key, string)
+      url_safe_base64_encode(raw_signature)
+    end
+    def url_safe_base64_decode(base64_string)
+      Base64.decode64(base64_string.tr('-_', '+/'))
+    end
+    def url_safe_base64_encode(raw)
+      Base64.encode64(raw).tr('+/', '-_').strip
+    end
+  end
+end

data/lib/geocoder/lookups/mapquest.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'cgi'
+require 'geocoder/lookups/base'
+require "geocoder/results/mapquest"
+module Geocoder::Lookup
+  class Mapquest < Base
+    def name
+      "Mapquest"
+    end
+    def required_api_key_parts
+      []
+    end
+    def query_url(query)
+      key = configuration.api_key
+      domain = key ? "www" : "open"
+      url = "#{protocol}://#{domain}.mapquestapi.com/geocoding/v1/#{search_type(query)}?"
+      url + url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    def search_type(query)
+      query.reverse_geocode? ? "reverse" : "address"
+    end
+    def query_url_params(query)
+      params = { :location => query.sanitized_text }
+      if key = configuration.api_key
+        params[:key] = CGI.unescape(key)
+      end
+      params.merge(super)
+    end
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      doc["results"][0]['locations']
+    end
+  end
+end

data/lib/geocoder/lookups/maxmind.rb ADDED Viewed

@@ -0,0 +1,88 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/maxmind'
+require 'csv'
+module Geocoder::Lookup
+  class Maxmind < Base
+    def name
+      "MaxMind"
+    end
+    def query_url(query)
+      "#{protocol}://geoip.maxmind.com/#{service_code}?" + url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    ##
+    # Return the name of the configured service, or raise an exception.
+    #
+    def configured_service!
+      if s = configuration[:service] and services.keys.include?(s)
+        return s
+      else
+        raise(
+          Geocoder::ConfigurationError,
+          "When using MaxMind you MUST specify a service name: " +
+          "Geocoder.configure(:maxmind => {:service => ...}), " +
+          "where '...' is one of: #{services.keys.inspect}"
+        )
+      end
+    end
+    def service_code
+      services[configured_service!]
+    end
+    def service_response_fields_count
+      Geocoder::Result::Maxmind.field_names[configured_service!].size
+    end
+    def data_contains_error?(parsed_data)
+      # if all fields given then there is an error
+      parsed_data.size == service_response_fields_count and !parsed_data.last.nil?
+    end
+    ##
+    # Service names mapped to code used in URL.
+    #
+    def services
+      {
+        :country => "a",
+        :city => "b",
+        :city_isp_org => "f",
+        :omni => "e"
+      }
+    end
+    def results(query)
+      # don't look up a loopback address, just return the stored result
+      return [reserved_result] if query.loopback_ip_address?
+      doc = fetch_data(query)
+      if doc and doc.is_a?(Array)
+        if !data_contains_error?(doc)
+          return [doc]
+        elsif doc.last == "INVALID_LICENSE_KEY"
+          raise_error(Geocoder::InvalidApiKey) || warn("Invalid MaxMind API key.")
+        end
+      end
+      return []
+    end
+    def parse_raw_data(raw_data)
+      CSV.parse_line raw_data
+    end
+    def reserved_result
+      ",,,,0,0,0,0,,,"
+    end
+    def query_url_params(query)
+      {
+        :l => configuration.api_key,
+        :i => query.sanitized_text
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/nominatim.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/nominatim"
+module Geocoder::Lookup
+  class Nominatim < Base
+    def name
+      "Nominatim"
+    end
+    def map_link_url(coordinates)
+      "http://www.openstreetmap.org/?lat=#{coordinates[0]}&lon=#{coordinates[1]}&zoom=15&layers=M"
+    end
+    def query_url(query)
+      method = query.reverse_geocode? ? "reverse" : "search"
+      host = configuration[:host] || "nominatim.openstreetmap.org"
+      "#{protocol}://#{host}/#{method}?" + url_query_string(query)
+    end
+    private # ---------------------------------------------------------------
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      doc.is_a?(Array) ? doc : [doc]
+    end
+    def query_url_params(query)
+      params = {
+        :format => "json",
+        :polygon => "1",
+        :addressdetails => "1",
+        :"accept-language" => configuration.language
+      }.merge(super)
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        params[:lat] = lat
+        params[:lon] = lon
+      else
+        params[:q] = query.sanitized_text
+      end
+      params
+    end
+  end
+end

data/lib/geocoder/lookups/ovi.rb ADDED Viewed

@@ -0,0 +1,52 @@
+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/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)
+      super.merge(
+        :searchtext=>query.sanitized_text,
+        :gen=>1,
+        :app_id=>api_key,
+        :app_code=>api_code
+      )
+    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