geocoder 0.9.13 → 1.0.0

data/lib/geocoder/configuration.rb

@@ -15,6 +15,12 @@ module Geocoder
         # use HTTPS for lookup requests? (if supported)
         [:use_https, false],
 
+        # HTTP proxy server (user:pass@host:port)
+        [:http_proxy, nil],
+
+        # HTTPS proxy server (user:pass@host:port)
+        [:https_proxy, nil],
+
         # API key for geocoding service
         [:api_key, nil],
 
@@ -32,13 +38,6 @@ module Geocoder
       eval("def self.#{o}=(obj); @@#{o} = obj; end")
     end
 
-    # legacy support
-    def self.yahoo_app_id=(value)
-      warn "DEPRECATION WARNING: Geocoder's 'yahoo_app_id' setting has been replaced by 'api_key'. " +
-        "This method will be removed in Geocoder v1.0."
-      @@api_key = value
-    end
-
     ##
     # Set all values to default.
     #

data/lib/geocoder/lookups/base.rb

@@ -1,4 +1,6 @@
 require 'net/http'
+require 'uri'
+
 unless defined?(ActiveSupport::JSON)
   begin
     require 'rubygems' # for Ruby 1.8
@@ -20,12 +22,7 @@ module Geocoder
       # "205.128.54.202") for geocoding, or coordinates (latitude, longitude)
       # for reverse geocoding. Returns an array of <tt>Geocoder::Result</tt>s.
       #
-      def search(query, *args)
-        # convert coordinates as separate arguments to an array
-        if query.is_a?(Numeric) and args.first.is_a?(Numeric)
-          warn "DEPRECATION WARNING: Instead of passing latitude/longitude as separate arguments to the search method, please pass an array: [#{query},#{args.first}]. The old argument format will not be supported in Geocoder v.1.0."
-          query = [query, args.first]
-        end
+      def search(query)
 
         # if coordinates given as string, turn into array
         query = query.split(/\s*,\s*/) if coordinates?(query)
@@ -39,9 +36,39 @@ module Geocoder
         results(query, reverse).map{ |r| result_class.new(r) }
       end
 
+      ##
+      # Return the URL for a map of the given coordinates.
+      #
+      # Not necessarily implemented by all subclasses as only some lookups
+      # also provide maps.
+      #
+      def map_link_url(coordinates)
+        nil
+      end
+
 
       private # -------------------------------------------------------------
 
+      ##
+      # Object used to make HTTP requests.
+      #
+      def http_client
+        protocol = "http#{'s' if Geocoder::Configuration.use_https}"
+        proxy_name = "#{protocol}_proxy"
+        if proxy = Geocoder::Configuration.send(proxy_name)
+          proxy_url = protocol + '://' + proxy
+          begin
+            uri = URI.parse(proxy_url)
+          rescue URI::InvalidURIError
+            raise ConfigurationError,
+              "Error parsing #{protocol.upcase} proxy URL: '#{proxy_url}'"
+          end
+          Net::HTTP::Proxy(uri.host, uri.port, uri.user, uri.password)
+        else
+          Net::HTTP
+        end
+      end
+
       ##
       # Geocoder::Result object or nil on timeout or other error.
       #
@@ -74,7 +101,7 @@ module Geocoder
         rescue TimeoutError
           warn "Geocoding API not responding fast enough " +
             "(see Geocoder::Configuration.timeout to set limit)."
-      end
+        end
       end
 
       ##
@@ -107,7 +134,7 @@ module Geocoder
         timeout(Geocoder::Configuration.timeout) do
           url = query_url(query, reverse)
           unless cache and response = cache[url]
-            response = Net::HTTP.get_response(URI.parse(url)).body
+            response = http_client.get_response(URI.parse(url)).body
             if cache
               cache[url] = response
             end
@@ -134,7 +161,7 @@ module Geocoder
       # Does the given string look like latitude/longitude coordinates?
       #
       def coordinates?(value)
-        !!value.to_s.match(/^[0-9\.\-]+, *[0-9\.\-]+$/)
+        value.is_a?(String) and !!value.to_s.match(/^-?[0-9\.]+, *-?[0-9\.]+$/)
       end
 
       ##

data/lib/geocoder/lookups/bing.rb

@@ -0,0 +1,33 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/bing"
+
+module Geocoder::Lookup
+  class Bing < Base
+
+    def map_link_url(coordinates)
+      "http://www.bing.com/maps/default.aspx?cp=#{coordinates.join('~')}"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query, reverse = false)
+      return [] unless doc = fetch_data(query, reverse)
+      
+      if doc['statusDescription'] == "OK"
+        return doc['resourceSets'].first['estimatedTotal'] > 0 ? doc['resourceSets'].first['resources'] : []
+      else
+        warn "Bing Geocoding API error: #{doc['statusCode']} (#{doc['statusDescription']})."
+        return []
+      end
+    end
+
+    def query_url(query, reverse = false)
+      params = {:key => Geocoder::Configuration.api_key}
+      params[:query] = query unless reverse
+
+      base_url = "http://dev.virtualearth.net/REST/v1/Locations"
+      url_tail = reverse ? "/#{query}?" : "?"
+      base_url + url_tail + hash_to_query(params)
+    end
+  end
+end

data/lib/geocoder/lookups/google.rb

@@ -4,6 +4,10 @@ require "geocoder/results/google"
 module Geocoder::Lookup
   class Google < Base
 
+    def map_link_url(coordinates)
+      "http://maps.google.com/maps?q=#{coordinates.join(',')}"
+    end
+
     private # ---------------------------------------------------------------
 
     def results(query, reverse = false)

data/lib/geocoder/lookups/yahoo.rb

@@ -4,6 +4,10 @@ require "geocoder/results/yahoo"
 module Geocoder::Lookup
   class Yahoo < Base
 
+    def map_link_url(coordinates)
+      "http://maps.yahoo.com/#lat=#{coordinates[0]}&lon=#{coordinates[1]}"
+    end
+
     private # ---------------------------------------------------------------
 
     def results(query, reverse = false)
@@ -18,7 +22,7 @@ module Geocoder::Lookup
 
     def query_url(query, reverse = false)
       params = {
-        :location =>  query,
+        :location => query,
         :flags => "JXTSR",
         :gflags => "AC#{'R' if reverse}",
         :locale => "#{Geocoder::Configuration.language}_US",
@@ -28,4 +32,3 @@ module Geocoder::Lookup
     end
   end
 end
-

data/lib/geocoder/lookups/yandex.rb

@@ -0,0 +1,39 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/yandex"
+
+module Geocoder::Lookup
+  class Yandex < Base
+
+    def map_link_url(coordinates)
+      "http://maps.yandex.ru/?ll=#{coordinates.reverse.join(',')}"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query, reverse = false)
+      return [] unless doc = fetch_data(query, reverse)
+      if err = doc['error']
+        warn "Yandex Geocoding API error: #{err['status']} (#{err['message']})."
+        return []
+      end
+      if doc = doc['response']['GeoObjectCollection']
+        meta = doc['metaDataProperty']['GeocoderResponseMetaData']
+        return meta['found'].to_i > 0 ? doc['featureMember'] : []
+      else
+        warn "Yandex Geocoding API error: unexpected response format."
+        return []
+      end
+    end
+
+    def query_url(query, reverse = false)
+      query = query.split(",").reverse.join(",") if reverse
+      params = {
+        :geocode => query,
+        :format => "json",
+        :plng => "#{Geocoder::Configuration.language}", # supports ru, uk, be
+        :key => Geocoder::Configuration.api_key
+      }
+      "http://geocode-maps.yandex.ru/1.x/?" + hash_to_query(params)
+    end
+  end
+end

data/lib/geocoder/models/base.rb

@@ -9,7 +9,11 @@ module Geocoder
     module Base
 
       def geocoder_options
-        @geocoder_options
+        if defined?(@geocoder_options)
+          @geocoder_options
+        elsif superclass.respond_to?(:geocoder_options)
+          superclass.geocoder_options
+        end
       end
 
       def geocoded_by

data/lib/geocoder/results/base.rb

@@ -32,6 +32,22 @@ module Geocoder
         coordinates[1]
       end
 
+      def state
+        fail
+      end
+
+      def province
+        state
+      end
+
+      def state_code
+        fail
+      end
+
+      def province_code
+        state_code
+      end
+
       def country
         fail
       end

data/lib/geocoder/results/bing.rb

@@ -0,0 +1,48 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Bing < Base
+
+    def address(format = :full)
+      @data['address']['formattedAddress']
+    end
+
+    def city
+      @data['address']['locality']
+    end
+
+    def state_code
+      @data['address']['adminDistrict']
+    end
+
+    alias_method :state, :state_code
+
+    def country
+      @data['address']['countryRegion']
+    end
+
+    alias_method :country_code, :country
+
+    def postal_code
+      @data['address']['postalCode']
+    end
+
+    def coordinates
+      @data['point']['coordinates']
+    end
+
+    def address_data
+      @data['address']
+    end
+
+    def self.response_attributes
+      %w[bbox name confidence entityType]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/results/freegeoip.rb

@@ -4,13 +4,21 @@ module Geocoder::Result
   class Freegeoip < Base
 
     def address(format = :full)
-      "#{city}#{', ' + region_code unless region_code == ''} #{postal_code}, #{country}"
+      "#{city}#{', ' + state_code unless state_code == ''} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
     def city
       @data['city']
     end
 
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
     def country
       @data['country_name']
     end
@@ -24,8 +32,7 @@ module Geocoder::Result
     end
 
     def self.response_attributes
-      %w[city region_code region_name metrocode
-        zipcode country_name country_code ip]
+      %w[metrocode ip]
     end
 
     response_attributes.each do |a|

data/lib/geocoder/results/geocoder_ca.rb

@@ -8,7 +8,7 @@ module Geocoder::Result
     end
 
     def address(format = :full)
-      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}"
+      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
     def street_address
@@ -23,7 +23,7 @@ module Geocoder::Result
       @data['prov']
     end
 
-    alias_method :province, :state
+    alias_method :state_code, :state
 
     def postal_code
       @data['postal']
@@ -34,19 +34,14 @@ module Geocoder::Result
     end
 
     def country_code
-      prov = @data['prov']
-      return nil if prov.nil? || prov == ""
-      canadian_province_abbreviations.include?(@data['prov']) ? "CA" : "US"
-    end
-
-    def canadian_province_abbreviations
-      %w[ON QC NS NB MB BC PE SK AB NL]
+      return nil if state.nil? || state == ""
+      canadian_province_abbreviations.include?(state) ? "CA" : "US"
     end
 
     def self.response_attributes
-      %w[latt longt inlatt inlongt betweenRoad1 betweenRoad2 distance
-        stnumber staddress city prov postal
-        NearRoad NearRoadDistance intersection major_intersection]
+      %w[latt longt inlatt inlongt distance stnumber staddress prov
+        NearRoad NearRoadDistance betweenRoad1 betweenRoad2
+        intersection major_intersection]
     end
 
     response_attributes.each do |a|
@@ -54,5 +49,12 @@ module Geocoder::Result
         @data[a]
       end
     end
+
+
+    private # ---------------------------------------------------------------- 
+
+    def canadian_province_abbreviations
+      %w[ON QC NS NB MB BC PE SK AB NL]
+    end
   end
 end

data/lib/geocoder/results/google.rb

@@ -12,8 +12,9 @@ module Geocoder::Result
     end
 
     def city
-      fields = [:locality, :sublocality, :administrative_area_level_3,
-        :administrative_area_level_2, :administrative_area_level_1]
+      fields = [:locality, :sublocality,
+        :administrative_area_level_3,
+        :administrative_area_level_2]
       fields.each do |f|
         if entity = address_components_of_type(f).first
           return entity['long_name']
@@ -21,6 +22,18 @@ module Geocoder::Result
       end
     end
 
+    def state
+      if state = address_components_of_type(:administrative_area_level_1).first
+        state['long_name']
+      end
+    end
+
+    def state_code
+      if state = address_components_of_type(:administrative_area_level_1).first
+        state['short_name']
+      end
+    end
+
     def country
       if country = address_components_of_type(:country).first
         country['long_name']

data/lib/geocoder/results/yahoo.rb

@@ -11,6 +11,14 @@ module Geocoder::Result
       @data['city']
     end
 
+    def state
+      @data['state']
+    end
+
+    def state_code
+      @data['statecode']
+    end
+
     def country
       @data['country']
     end
@@ -25,8 +33,8 @@ module Geocoder::Result
 
     def self.response_attributes
       %w[quality offsetlat offsetlon radius boundingbox name
-        line1 line2 line3 line4 cross house street xstreet unittype unit postal
-        neighborhood city county state country countrycode statecode countycode
+        line1 line2 line3 line4 cross house street xstreet unittype unit
+        neighborhood county countycode
         level0 level1 level2 level3 level4 level0code level1code level2code
         timezone areacode uzip hash woeid woetype]
     end