geocoder2 0.1.0

data/lib/geocoder2/lookups/google.rb

@@ -0,0 +1,69 @@
+require 'geocoder2/lookups/base'
+require "geocoder2/results/google"
+
+module Geocoder2::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)
+      "#{configuration.api_key ? 'https' : protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
+      "#{protocol}://maps.googleapis.com/maps/api/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']
+      when "OVER_QUERY_LIMIT"
+        raise_error(Geocoder2::OverQueryLimitError) ||
+          warn("Google Geocoding API error: over query limit.")
+      when "REQUEST_DENIED"
+        raise_error(Geocoder2::RequestDenied) ||
+          warn("Google Geocoding API error: request denied.")
+      when "INVALID_REQUEST"
+        raise_error(Geocoder2::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/geocoder2/lookups/google_premier.rb

@@ -0,0 +1,47 @@
+require 'openssl'
+require 'base64'
+require 'geocoder2/lookups/google'
+require 'geocoder2/results/google_premier'
+
+module Geocoder2::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/geocoder2/lookups/mapquest.rb

@@ -0,0 +1,59 @@
+require 'cgi'
+require 'geocoder2/lookups/base'
+require "geocoder2/results/mapquest"
+
+module Geocoder2::Lookup
+  class Mapquest < Base
+
+    def name
+      "Mapquest"
+    end
+
+    def required_api_key_parts
+      ["key"]
+    end
+
+    def query_url(query)
+      domain = configuration[:licensed] ? "www" : "open"
+      version = configuration[:version] || 1
+      url = "#{protocol}://#{domain}.mapquestapi.com/geocoding/v#{version}/#{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
+
+    # http://www.mapquestapi.com/geocoding/status_codes.html
+    # http://open.mapquestapi.com/geocoding/status_codes.html
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      return doc["results"][0]['locations'] if doc['info']['statuscode'] == 0 # A successful geocode call
+
+      messages = doc['info']['messages'].join
+
+      case doc['info']['statuscode']
+      when 400 # Error with input
+        raise_error(Geocoder2::InvalidRequest, messages) ||
+          warn("Mapquest Geocoding API error: #{messages}")
+      when 403 # Key related error
+        raise_error(Geocoder2::InvalidApiKey, messages) ||
+          warn("Mapquest Geocoding API error: #{messages}")
+      when 500 # Unknown error
+        raise_error(Geocoder2::Error, messages) ||
+          warn("Mapquest Geocoding API error: #{messages}")
+      end
+    end
+
+  end
+end

data/lib/geocoder2/lookups/maxmind.rb

@@ -0,0 +1,88 @@
+require 'geocoder2/lookups/base'
+require 'geocoder2/results/maxmind'
+require 'csv'
+
+module Geocoder2::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(
+          Geocoder2::ConfigurationError,
+          "When using MaxMind you MUST specify a service name: " +
+          "Geocoder2.configure(:maxmind => {:service => ...}), " +
+          "where '...' is one of: #{services.keys.inspect}"
+        )
+      end
+    end
+
+    def service_code
+      services[configured_service!]
+    end
+
+    def service_response_fields_count
+      Geocoder2::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(Geocoder2::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,,,".split(",")
+    end
+
+    def query_url_params(query)
+      {
+        :l => configuration.api_key,
+        :i => query.sanitized_text
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder2/lookups/nominatim.rb

@@ -0,0 +1,44 @@
+require 'geocoder2/lookups/base'
+require "geocoder2/results/nominatim"
+
+module Geocoder2::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",
+        :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/geocoder2/lookups/ovi.rb

@@ -0,0 +1,62 @@
+require 'geocoder2/lookups/base'
+require 'geocoder2/results/ovi'
+
+module Geocoder2::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/geocoder2/lookups/test.rb

@@ -0,0 +1,44 @@
+require 'geocoder2/lookups/base'
+require 'geocoder2/results/test'
+
+module Geocoder2
+  module Lookup
+    class Test < Base
+
+      def name
+        "Test"
+      end
+
+      def self.add_stub(query_text, results)
+        stubs[query_text] = results
+      end
+
+      def self.set_default_stub(results)
+        @default_stub = results
+      end
+
+      def self.read_stub(query_text)
+        stubs.fetch(query_text) {
+          return @default_stub unless @default_stub.nil?
+          raise ArgumentError, "unknown stub request #{query_text}"
+        }
+      end
+
+      def self.stubs
+        @stubs ||= {}
+      end
+
+      def self.reset
+        @stubs = {}
+        @default_stub = nil
+      end
+
+      private
+
+      def results(query)
+        Geocoder2::Lookup::Test.read_stub(query.text)
+      end
+
+    end
+  end
+end

data/lib/geocoder2/lookups/yahoo.rb

@@ -0,0 +1,86 @@
+require 'geocoder2/lookups/base'
+require "geocoder2/results/yahoo"
+require 'oauth_util'
+
+module Geocoder2::Lookup
+  class Yahoo < Base
+
+    def name
+      "Yahoo BOSS"
+    end
+
+    def map_link_url(coordinates)
+      "http://maps.yahoo.com/#lat=#{coordinates[0]}&lon=#{coordinates[1]}"
+    end
+
+    def required_api_key_parts
+      ["consumer key", "consumer secret"]
+    end
+
+    def query_url(query)
+      parsed_url = URI.parse(raw_url(query))
+      o = OauthUtil.new
+      o.consumer_key = configuration.api_key[0]
+      o.consumer_secret = configuration.api_key[1]
+      base_url + o.sign(parsed_url).query_string
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      doc = doc['bossresponse']
+      if doc['responsecode'].to_i == 200
+        if doc['placefinder']['count'].to_i > 0
+          return doc['placefinder']['results']
+        else
+          return []
+        end
+      else
+        warn "Yahoo Geocoding API error: #{doc['responsecode']} (#{doc['reason']})."
+        return []
+      end
+    end
+
+    ##
+    # Yahoo returns errors as XML even when JSON format is specified.
+    # Handle that here, without parsing the XML
+    # (which would add unnecessary complexity).
+    # Yahoo auth errors can also be cryptic, so add raw error desc
+    # to warning message.
+    #
+    def parse_raw_data(raw_data)
+      if raw_data.match /^<\?xml/
+        if raw_data.include?("Rate Limit Exceeded")
+          raise_error(Geocoder2::OverQueryLimitError) || warn("Over API query limit.")
+        elsif raw_data =~ /<yahoo:description>(Please provide valid credentials.*)<\/yahoo:description>/i
+          raise_error(Geocoder2::InvalidApiKey) || warn("Invalid API key. Error response: #{$1}")
+        end
+      else
+        super(raw_data)
+      end
+    end
+
+    def query_url_params(query)
+      {
+        :location => query.sanitized_text,
+        :flags => "JXTSR",
+        :gflags => "AC#{'R' if query.reverse_geocode?}",
+        :locale => "#{configuration.language}_US",
+        :appid => configuration.api_key
+      }.merge(super)
+    end
+
+    def cache_key(query)
+      raw_url(query)
+    end
+
+    def base_url
+      "#{protocol}://yboss.yahooapis.com/geo/placefinder?"
+    end
+
+    def raw_url(query)
+      base_url + url_query_string(query)
+    end
+  end
+end

data/lib/geocoder2/lookups/yandex.rb

@@ -0,0 +1,54 @@
+require 'geocoder2/lookups/base'
+require "geocoder2/results/yandex"
+
+module Geocoder2::Lookup
+  class Yandex < Base
+
+    def name
+      "Yandex"
+    end
+
+    def map_link_url(coordinates)
+      "http://maps.yandex.ru/?ll=#{coordinates.reverse.join(',')}"
+    end
+
+    def query_url(query)
+      "#{protocol}://geocode-maps.yandex.ru/1.x/?" + url_query_string(query)
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if err = doc['error']
+        if err["status"] == 401 and err["message"] == "invalid key"
+          raise_error(Geocoder2::InvalidApiKey) || warn("Invalid API key.")
+        else
+          warn "Yandex Geocoding API error: #{err['status']} (#{err['message']})."
+        end
+        return []
+      end
+      if doc = doc['response']['GeoObjectCollection']
+        meta = doc['metaDataProperty']['Geocoder2ResponseMetaData']
+        return meta['found'].to_i > 0 ? doc['featureMember'] : []
+      else
+        warn "Yandex Geocoding API error: unexpected response format."
+        return []
+      end
+    end
+
+    def query_url_params(query)
+      if query.reverse_geocode?
+        q = query.coordinates.reverse.join(",")
+      else
+        q = query.sanitized_text
+      end
+      {
+        :geocode => q,
+        :format => "json",
+        :plng => "#{configuration.language}", # supports ru, uk, be
+        :key => configuration.api_key
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder2/models/active_record.rb

@@ -0,0 +1,46 @@
+require 'geocoder2/models/base'
+
+module Geocoder2
+  module Model
+    module ActiveRecord
+      include Base
+
+      ##
+      # Set attribute names and include the Geocoder2 module.
+      #
+      def geocoded_by(address_attr, options = {}, &block)
+        geocoder2_init(
+          :geocode       => true,
+          :user_address  => address_attr,
+          :latitude      => options[:latitude]  || :latitude,
+          :longitude     => options[:longitude] || :longitude,
+          :geocode_block => block,
+          :units         => options[:units],
+          :method        => options[:method]
+        )
+      end
+
+      ##
+      # Set attribute names and include the Geocoder2 module.
+      #
+      def reverse_geocoded_by(latitude_attr, longitude_attr, options = {}, &block)
+        geocoder2_init(
+          :reverse_geocode => true,
+          :fetched_address => options[:address] || :address,
+          :latitude        => latitude_attr,
+          :longitude       => longitude_attr,
+          :reverse_block   => block,
+          :units         => options[:units],
+          :method        => options[:method]
+        )
+      end
+
+
+      private # --------------------------------------------------------------
+
+      def geocoder2_file_name;   "active_record"; end
+      def geocoder2_module_name; "ActiveRecord"; end
+    end
+  end
+end
+

data/lib/geocoder2/models/base.rb

@@ -0,0 +1,42 @@
+require 'geocoder2'
+
+module Geocoder2
+
+  ##
+  # Methods for invoking Geocoder2 in a model.
+  #
+  module Model
+    module Base
+
+      def geocoder2_options
+        if defined?(@geocoder2_options)
+          @geocoder2_options
+        elsif superclass.respond_to?(:geocoder2_options)
+          superclass.geocoder2_options || { }
+        else
+          { }
+        end
+      end
+
+      def geocoded_by
+        fail
+      end
+
+      def reverse_geocoded_by
+        fail
+      end
+
+      private # ----------------------------------------------------------------
+
+      def geocoder2_init(options)
+        unless @geocoder2_options
+          @geocoder2_options = {}
+          require "geocoder2/stores/#{geocoder2_file_name}"
+          include Geocoder2::Store.const_get(geocoder2_module_name)
+        end
+        @geocoder2_options.merge! options
+      end
+    end
+  end
+end
+