app/controllers/geocoder_controller.rb

   1 class GeocoderController < ApplicationController
   2   require 'uri'
   3   require 'net/http'
   4   require 'rexml/document'
   5
   6   def search
   7     query = params[:query]
   8     results = Array.new
   9
  10     if query.match(/^\d{5}(-\d{4})?$/)
  11       results.push search_us_postcode(query)
  12     elsif query.match(/(GIR 0AA|[A-PR-UWYZ]([0-9]{1,2}|([A-HK-Y][0-9]|[A-HK-Y][0-9]([0-9]|[ABEHMNPRV-Y]))|[0-9][A-HJKS-UW])\s*[0-9][ABD-HJLNP-UW-Z]{2})/i)
  13       results.push search_uk_postcode(query)
  14     elsif query.match(/[A-Z]\d[A-Z]\s*\d[A-Z]\d/i)
  15       results.push search_ca_postcode(query)
  16     else
  17       results.push search_osm_namefinder(query)
  18       results.push search_geonames(query)
  19     end
  20
  21     results_count = count_results(results)
  22
  23     render :update do |page|
  24       page.replace_html :search_results_content, :partial => 'results', :object => results
  25
  26       if results_count == 1
  27         position = results.collect { |s| s[:results] }.compact.flatten[0]
  28         page.call "setPosition", position[:lat], position[:lon], position[:zoom]
  29       else
  30         page.call "openSearchResults"
  31       end
  32     end
  33   end
  34
  35   def description
  36     results = Array.new
  37
  38     lat = params[:lat]
  39     lon = params[:lon]
  40
  41     results.push description_osm_namefinder("cities", lat, lon, 2)
  42     results.push description_osm_namefinder("towns", lat, lon, 4)
  43     results.push description_osm_namefinder("places", lat, lon, 10)
  44     results.push description_geonames(lat, lon)
  45
  46     render :update do |page|
  47       page.replace_html :search_results_content, :partial => 'results', :object => results
  48       page.call "openSearchResults"
  49     end
  50   end
  51
  52 private
  53
  54   def search_us_postcode(query)
  55     results = Array.new
  56
  57     # ask geocoder.us (they have a non-commercial use api)
  58     response = fetch_text("http://rpc.geocoder.us/service/csv?zip=#{URI.escape(query)}")
  59
  60     # parse the response
  61     unless response.match(/couldn't find this zip/)
  62       data = response.split(/\s*,\s+/) # lat,long,town,state,zip
  63       results.push({:lat => data[0], :lon => data[1], :zoom => 12,
  64                     :prefix => "#{data[2]}, #{data[3]}, ",
  65                     :name => data[4]})
  66     end
  67
  68     return { :source => "Geocoder.us", :url => "http://geocoder.us/", :results => results }
  69   rescue Exception => ex
  70     return { :source => "Geocoder.us", :url => "http://geocoder.us/", :error => "Error contacting rpc.geocoder.us: #{ex.to_s}" }
  71   end
  72
  73   def search_uk_postcode(query)
  74     results = Array.new
  75
  76     # ask npemap.org.uk to do a combined npemap + freethepostcode search
  77     response = fetch_text("http://www.npemap.org.uk/cgi/geocoder.fcgi?format=text&postcode=#{URI.escape(query)}")
  78
  79     # parse the response
  80     unless response.match(/Error/)
  81       dataline = response.split(/\n/)[1]
  82       data = dataline.split(/,/) # easting,northing,postcode,lat,long
  83       results.push({:lat => data[3], :lon => data[4], :zoom => 12,
  84                     :name => data[2].gsub(/'/, "")})
  85     end
  86
  87     return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :results => results }
  88   rescue Exception => ex
  89     return { :source => "NPEMap / FreeThePostcode", :url => "http://www.npemap.org.uk/", :error => "Error contacting www.npemap.org.uk: #{ex.to_s}" }
  90   end
  91
  92   def search_ca_postcode(query)
  93     results = Array.new
  94
  95     # ask geocoder.ca (note - they have a per-day limit)
  96     response = fetch_xml("http://geocoder.ca/?geoit=XML&postal=#{URI.escape(query)}")
  97
  98     # parse the response
  99     unless response.get_elements("geodata/error")
 100       results.push({:lat => response.get_text("geodata/latt").to_s,
 101                     :lon => response.get_text("geodata/longt").to_s,
 102                     :zoom => 12,
 103                     :name => query.upcase})
 104     end
 105
 106     return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :results => results }
 107   rescue Exception => ex
 108     return { :source => "Geocoder.CA", :url => "http://geocoder.ca/", :error => "Error contacting geocoder.ca: #{ex.to_s}" }
 109   end
 110
 111   def search_osm_namefinder(query)
 112     results = Array.new
 113
 114     # ask OSM namefinder
 115     response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{URI.escape(query)}")
 116
 117     # parse the response
 118     response.elements.each("searchresults/named") do |named|
 119       lat = named.attributes["lat"].to_s
 120       lon = named.attributes["lon"].to_s
 121       zoom = named.attributes["zoom"].to_s
 122       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
 123       type = named.attributes["info"].to_s.capitalize
 124       name = named.attributes["name"].to_s
 125       description = named.elements["description"].to_s
 126       if name.empty?
 127         prefix = ""
 128         name = type
 129       else
 130         prefix = "#{type} "
 131       end
 132       if place
 133         distance = format_distance(place.attributes["approxdistance"].to_i)
 134         direction = format_direction(place.attributes["direction"].to_i)
 135         placename = place.attributes["name"].to_s
 136         suffix = ", #{distance} #{direction} of #{placename}"
 137       else
 138         suffix = ""
 139       end
 140       results.push({:lat => lat, :lon => lon, :zoom => zoom,
 141                     :prefix => prefix, :name => name, :suffix => suffix,
 142                     :description => description})
 143     end
 144
 145     return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
 146   rescue Exception => ex
 147     return { :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
 148   end
 149
 150   def search_geonames(query)
 151     results = Array.new
 152
 153     # ask geonames.org
 154     response = fetch_xml("http://ws.geonames.org/search?q=#{URI.escape(query)}&maxRows=20")
 155
 156     # parse the response
 157     response.elements.each("geonames/geoname") do |geoname|
 158       lat = geoname.get_text("lat").to_s
 159       lon = geoname.get_text("lng").to_s
 160       name = geoname.get_text("name").to_s
 161       country = geoname.get_text("countryName").to_s
 162       results.push({:lat => lat, :lon => lon, :zoom => 12,
 163                     :name => name,
 164                     :suffix => ", #{country}"})
 165     end
 166
 167     return { :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
 168   rescue Exception => ex
 169     return { :source => "GeoNames", :url => "http://www.geonames.org/", :error => "Error contacting ws.geonames.org: #{ex.to_s}" }
 170   end
 171
 172   def description_osm_namefinder(types, lat, lon, max)
 173     results = Array.new
 174
 175     # ask OSM namefinder
 176     response = fetch_xml("http://www.frankieandshadow.com/osm/search.xml?find=#{types}+near+#{lat},#{lon}&max=#{max}")
 177
 178     # parse the response
 179     response.elements.each("searchresults/named") do |named|
 180       lat = named.attributes["lat"].to_s
 181       lon = named.attributes["lon"].to_s
 182       zoom = named.attributes["zoom"].to_s
 183       place = named.elements["place/named"] || named.elements["nearestplaces/named"]
 184       type = named.attributes["info"].to_s
 185       name = named.attributes["name"].to_s
 186       description = named.elements["description"].to_s
 187       distance = format_distance(place.attributes["approxdistance"].to_i)
 188       direction = format_direction((place.attributes["direction"].to_i - 180) % 360)
 189       prefix = "#{distance} #{direction} of #{type} "
 190       results.push({:lat => lat, :lon => lon, :zoom => zoom,
 191                     :prefix => prefix.capitalize, :name => name,
 192                     :description => description})
 193     end
 194
 195     return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :results => results }
 196   rescue Exception => ex
 197     return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
 198   end
 199
 200   def description_geonames(lat, lon)
 201     results = Array.new
 202
 203     # ask geonames.org
 204     response = fetch_xml("http://ws.geonames.org/countrySubdivision?lat=#{lat}&lng=#{lon}")
 205
 206     # parse the response
 207     response.elements.each("geonames/countrySubdivision") do |geoname|
 208       name = geoname.get_text("adminName1").to_s
 209       country = geoname.get_text("countryName").to_s
 210       results.push({:prefix => "#{name}, #{country}"})
 211     end
 212
 213     return { :type => "Location", :source => "GeoNames", :url => "http://www.geonames.org/", :results => results }
 214   rescue Exception => ex
 215     return { :type => types.capitalize, :source => "OpenStreetMap Namefinder", :url => "http://www.frankieandshadow.com/osm/", :error => "Error contacting www.frankieandshadow.com: #{ex.to_s}" }
 216   end
 217
 218   def fetch_text(url)
 219     return Net::HTTP.get(URI.parse(url))
 220   end
 221
 222   def fetch_xml(url)
 223     return REXML::Document.new(fetch_text(url))
 224   end
 225
 226   def format_distance(distance)
 227     return "less than 1km" if distance == 0
 228     return "about #{distance}km"
 229   end
 230
 231   def format_direction(bearing)
 232     return "south-west" if bearing >= 22.5 and bearing < 67.5
 233     return "south" if bearing >= 67.5 and bearing < 112.5
 234     return "south-east" if bearing >= 112.5 and bearing < 157.5
 235     return "east" if bearing >= 157.5 and bearing < 202.5
 236     return "north-east" if bearing >= 202.5 and bearing < 247.5
 237     return "north" if bearing >= 247.5 and bearing < 292.5
 238     return "north-west" if bearing >= 292.5 and bearing < 337.5
 239     return "west"
 240   end
 241
 242   def count_results(results)
 243     count = 0
 244
 245     results.each do |source|
 246       count += source[:results].length if source[:results]
 247     end
 248
 249     return count
 250   end
 251 end