Initial commit.

MIT-LICENSE

+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README

+Geocoder
+========
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

Rakefile

+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the geocoder plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the geocoder plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Geocoder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

init.rb

+# Include hook code here

install.rb

+# Install hook code here

lib/geocoder.rb

+##
+# Add geocoding functionality (via Google) to any object that implements
+# a +location+ method that returns a string suitable for a Google Maps search.
+#
+module Geocoder
+  
+  ##
+  # Query Google for the coordinates of the given phrase.
+  # Returns array [lat,lon] if found.
+  #
+  def self.fetch_coordinates(query)
+    data = self.search(query)
+    
+    # Make sure search found a result.
+    return nil unless data['kml']['response']['status']['code'] == "200"
+    place = data['kml']['response']['placemark']
+
+    # If there are multiple results, blindly use the first.
+    place = place.first if place.is_a?(Array)
+    coords = place['point']['coordinates']
+    coords.split(',')[0...2].reverse.map{ |i| i.to_f }
+  end
+  
+  ##
+  # Search Google based on the object's +location+ attribute.
+  #
+  def fetch_coordinates
+    Geocoder.fetch_coordinates(location)
+  end
+  
+  ##
+  # Fetch and assign +latitude+ and +longitude+ if +location+ has changed.
+  #
+  def assign_coordinates
+    if location_changed? and c = fetch_coordinates
+      self.latitude = c[0]
+      self.longitude = c[1]
+    end
+  end
+
+  ##
+  # Find all records within a radius (in miles) of the given point.
+  # Taken from excellent tutorial at:
+  # http://www.scribd.com/doc/2569355/Geo-Distance-Search-with-MySQL
+  #
+  def self.nearby_mysql_query(table, latitude, longitude, radius = 20, options = {})
+    
+    # Alternate column names.
+    options[:latitude]  ||= 'latitude'
+    options[:longitude] ||= 'longitude'
+    
+    # Constrain search to a (radius x radius) square.
+    factor = (Math::cos(latitude * Math::PI / 180.0) * 69.0).abs
+    lon_lo = longitude - (radius / factor);
+    lon_hi = longitude + (radius / factor);
+    lat_lo = latitude  - (radius / 69.0);
+    lat_hi = latitude  + (radius / 69.0);
+    where  = "#{options[:latitude]} BETWEEN #{lat_lo} AND #{lat_hi} AND " +
+      "#{options[:longitude]} BETWEEN #{lon_lo} AND #{lon_hi}"
+
+    # Generate query.
+    "SELECT *, 3956 * 2 * ASIN(SQRT(" +
+      "POWER(SIN((#{latitude} - #{options[:latitude]}) * " +
+      "PI() / 180 / 2), 2) + COS(#{latitude} * PI()/180) * " +
+      "COS(#{options[:latitude]} * PI() / 180) * " +
+      "POWER(SIN((#{longitude} - #{options[:longitude]}) * " +
+      "PI() / 180 / 2), 2) )) as distance " +
+      "FROM #{table} WHERE #{where} HAVING distance <= #{radius}"
+  end
+
+  ##
+  # Query Google for geographic information about the given phrase.
+  # Returns the XML response as a hash. This method is not intended for
+  # general use (prefer Geocoder.search).
+  #
+  def self.search(query)
+    params = { :q => query, :output => "xml" }
+    url    = "http://maps.google.com/maps/geo?" + params.to_query
+    
+    # Query geocoder and make sure it responds quickly.
+    begin
+      resp = nil
+      timeout(3) do
+        resp = Net::HTTP.get_response(URI.parse(url))
+      end
+    rescue SocketError, TimeoutError
+      return nil
+    end
+
+    # Google's XML document has incorrect encoding (says UTF-8 but is actually
+    # ISO 8859-1). Have to fix this or REXML won't parse correctly.
+    # This may be fixed in the future; see the bug report at:
+    # http://code.google.com/p/gmaps-api-issues/issues/detail?id=233
+    doc = resp.body.sub('UTF-8', 'ISO-8859-1')
+
+    Hash.from_xml(doc)
+  end
+end

tasks/geocoder_tasks.rake

+# desc "Explaining what the task does"
+# task :geocoder do
+#   # Task goes here
+# end

test/geocoder_test.rb

+require 'test/unit'
+
+class GeocoderTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

uninstall.rb

+# Uninstall hook code here