sniff 0.0.3 → 0.0.4

data/lib/sniff/active_record_ext.rb

@@ -1,12 +0,0 @@
-require 'active_record'
-require 'common_name'
-require 'falls_back_on'
-
-ActiveRecord::Base.class_eval do
-  extend FallsBackOn
-
-  def self._common_name
-    name.underscore
-  end
-  include CommonName
-end

data/lib/sniff/conversions_ext.rb

@@ -1,45 +0,0 @@
-require 'conversions'
-Conversions.register(:miles, :nautical_miles, 0.868976242)
-Conversions.register(:kilometres, :nautical_miles, 0.539956803)
-Conversions.register(:pounds_per_gallon, :kilograms_per_litre, 0.119826427)
-Conversions.register(:inches, :meters, 0.0254)
-Conversions.register(:kilowatt_hours, :watt_hours, 1_000.0)
-Conversions.register(:kilowatt_hours, :btus, 3_412.14163) # obsolete?
-Conversions.register(:watt_hours, :btus, 3.4121414799) # obsolete?
-Conversions.register(:watt_hours, :joules, 3_600.0)
-Conversions.register(:kilowatt_hours, :joules, 3_600_000.0)
-
-# Conversions.register(:btus, :gallons_of_kerosene, 0.000007419521097)
-Conversions.register(:joules, :litres_of_kerosene, 1.0 / (135_000.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
-
-# Conversions.register(:btus, :gallons_of_propane, 0.000010471204188)
-Conversions.register(:joules, :litres_of_propane, 1.0 / (91_333.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
-
-# Conversions.register(:btus, :therms, 0.000010002388121)
-Conversions.register(:therms, :joules, 105_505_585.0) # should only be used for RECS 2005
-
-# Conversions.register(:btus, :gallons_of_fuel_oil, 0.0000072007637183)
-Conversions.register(:joules, :litres_of_fuel_oil, 1.0 / (138_690.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
-
-# Conversions.register(:tons_of_coal, :btus, 20_169_000.0)
-Conversions.register(:joules, :kilograms_of_coal, 1.0 / (22_342_000.0 * 0.00110231131 * 1_055.05585)) # should only be used for RECS 2005
-
-Conversions.register(:kilograms, :lbs, 2.20462262)
-Conversions.register(:kbtus, :btus, 1_000.0)
-Conversions.register(:square_feet, :square_metres, 0.09290304)
-Conversions.register(:pounds_per_square_foot, :kilograms_per_square_metre, 4.88242764)
-Conversions.register(:kilograms_per_kilowatt_hour, :kilograms_per_megawatt_hour, 1_000.0)
-Conversions.register(:btus, :joules, 1_055.05585)
-Conversions.register(:kbtus, :joules, 1_000.0 * 1_055.05585)
-Conversions.register(:cords, :joules, 2.11011171e10)
-
-Conversions.register(:gallons_per_mile, :litres_per_kilometre, 2.35214583)
-Conversions.register(:pounds_per_mile, :kilograms_per_kilometre, 0.281849232)
-Conversions.register(:dollars, :cents, 100)
-Conversions.register(:cubic_feet, :cubic_metres, 0.0283168466)
-# 1 (kilocalories per pound) = 9 224.14105 joules per kilogram
-Conversions.register :kilocalories_per_pound, :joules_per_kilogram, 9_224.14105
-# 1 (grams per kilocalories) = 2.39005736 × 10-7 kilograms per joules
-Conversions.register :grams_per_kilocalorie, :kilograms_per_joule, 2.39005736e-7
-# 1 joule = 0.000239005736 kilocalories
-Conversions.register :joules, :kilocalories, 0.000239005736

data/lib/test_support/data_models/census_division.rb

@@ -1,9 +0,0 @@
-class CensusDivision < ActiveRecord::Base
-  set_primary_key :number
-  
-  belongs_to :census_region, :foreign_key => 'census_region_number'
-  has_many :states, :foreign_key => 'census_division_number'
-  has_many :zip_codes, :through => :states
-  has_many :climate_divisions, :through => :states
-  has_many :residential_energy_consumption_survey_responses, :foreign_key => 'census_division_number'
-end

data/lib/test_support/data_models/census_region.rb

@@ -1,9 +0,0 @@
-class CensusRegion < ActiveRecord::Base
-  set_primary_key :number
-  
-  has_many :census_divisions, :foreign_key => 'census_region_number'
-  has_many :states, :through => :census_divisions
-  # has_many :climate_divisions, :through => :census_divisions
-  # has_many :zip_codes, :through => :census_divisions
-  has_many :residential_energy_consumption_survey_responses, :foreign_key => 'census_region_number'
-end

data/lib/test_support/data_models/climate_division.rb

@@ -1,8 +0,0 @@
-class ClimateDivision < ActiveRecord::Base
-  set_primary_key :name
-  
-  has_many :zip_codes, :foreign_key => 'climate_division_name'
-  belongs_to :state, :foreign_key => 'state_postal_abbreviation'
-  
-  RADIUS = 750
-end

data/lib/test_support/data_models/country.rb

@@ -1,9 +0,0 @@
-class Country < ActiveRecord::Base
-  set_primary_key :iso_3166_code
-  
-  class << self
-    def united_states
-      find_by_iso_3166_code('US')
-    end
-  end
-end

data/lib/test_support/data_models/egrid_region.rb

@@ -1,7 +0,0 @@
-class EgridRegion < ActiveRecord::Base
-  set_primary_key :name
-  
-  has_many :egrid_subregions, :foreign_key => 'egrid_region_name'
-  
-  falls_back_on :loss_factor => 0.061311 # Ian
-end

data/lib/test_support/data_models/egrid_subregion.rb

@@ -1,8 +0,0 @@
-class EgridSubregion < ActiveRecord::Base
-  set_primary_key :abbreviation
-  
-  has_many :zip_codes, :foreign_key => 'egrid_subregion_abbreviation'
-  belongs_to :egrid_region, :foreign_key => 'egrid_region_name'
-  
-  falls_back_on :electricity_emission_factor => 1.404.pounds.to(:kilograms) # kg CO2 / kWh https://brighterplanet.sifterapp.com/projects/30/issues/437?return_uri=%2Fprojects%2F30%2Fissues%3Fa%3D79%26s%3D1-2
-end

data/lib/test_support/data_models/gender.rb

@@ -1,6 +0,0 @@
-class Gender < ActiveRecord::Base
-  set_primary_key :name
-  
-  has_many :pets
-  has_many :breed_genders, :foreign_key => 'gender_name'
-end

data/lib/test_support/data_models/petroleum_administration_for_defense_district.rb

@@ -1,9 +0,0 @@
-class PetroleumAdministrationForDefenseDistrict < ActiveRecord::Base
-  set_primary_key :code
-  
-  def name
-    str = "PAD District #{district_code} (#{district_name})"
-    str << " Subdistrict #{district_code}#{subdistrict_code} (#{subdistrict_name})" if subdistrict_code
-    str
-  end
-end

data/lib/test_support/data_models/state.rb

@@ -1,13 +0,0 @@
-class State < ActiveRecord::Base
-  set_primary_key :postal_abbreviation
-  
-  has_many :climate_divisions, :foreign_key => 'state_postal_abbreviation'
-  has_many :zip_codes, :foreign_key => 'state_postal_abbreviation'
-  belongs_to :census_division, :foreign_key => 'census_division_number'
-  belongs_to :petroleum_administration_for_defense_district, :foreign_key => 'petroleum_administration_for_defense_district_code'
-  has_one :census_region, :through => :census_division
-  
-  def country
-    Country.united_states
-  end
-end

data/lib/test_support/data_models/urbanity.rb

@@ -1,6 +0,0 @@
-class Urbanity < ActiveRecord::Base
-  set_primary_key :name
-  
-  has_many :residences
-  has_many :residential_energy_consumption_survey_responses
-end

data/lib/test_support/data_models/zip_code.rb

@@ -1,14 +0,0 @@
-class ZipCode < ActiveRecord::Base
-  set_primary_key :name
-  
-  belongs_to :egrid_subregion, :foreign_key => 'egrid_subregion_abbreviation'
-  belongs_to :climate_division, :foreign_key => 'climate_division_name'
-  belongs_to :state, :foreign_key => 'state_postal_abbreviation'
-#  has_one :census_division, :through => :state
-#  has_one :census_region, :through => :state
-  has_many :residences
-
-  acts_as_mappable :default_units => :miles,  # FIXME imperial
-                   :lat_column_name => :latitude,
-                   :lng_column_name => :longitude
-end

data/lib/test_support/db/schema.rb

@@ -1,117 +0,0 @@
-require 'sniff/database'
-
-Sniff::Database.define_schema do
-  create_table "census_divisions", :primary_key => "number", :id => false, :force => true do |t|
-    t.string   "number"
-    t.string   "name"
-    t.string   "census_region_name"
-    t.integer  "census_region_number"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "census_regions", :primary_key => "number", :id => false, :force => true do |t|
-    t.string   "number"
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "climate_divisions", :primary_key => "name", :id => false, :force => true do |t|
-    t.string   "name"
-    t.float    "heating_degree_days"
-    t.float    "cooling_degree_days"
-    t.string   "state_postal_abbreviation"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "countries", :primary_key => "iso_3166_code", :id => false, :force => true do |t|
-    t.string   "iso_3166_code"
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "egrid_regions", :primary_key => "name", :id => false, :force => true do |t|
-    t.string   "name"
-    t.float    "loss_factor"
-    t.string   "loss_factor_units"
-    t.datetime "updated_at"
-    t.datetime "created_at"
-  end
-
-  create_table "egrid_subregions", :primary_key => "abbreviation", :id => false, :force => true do |t|
-    t.string   "abbreviation"
-    t.string   "name"
-    t.float    "electricity_emission_factor"
-    t.string   "electricity_emission_factor_units"
-    t.string   "nerc_abbreviation"
-    t.string   "egrid_region_name"
-    t.datetime "updated_at"
-    t.datetime "created_at"
-  end
-
-  create_table "fallbacks", :force => true do |t|
-    t.string   "name"
-    t.text     "values"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "genders", :primary_key => "name", :id => false, :force => true do |t|
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "petroleum_administration_for_defense_districts", :primary_key => "code", :id => false, :force => true do |t|
-    t.string   "code"
-    t.string   "district_code"
-    t.string   "district_name"
-    t.string   "subdistrict_code"
-    t.string   "subdistrict_name"
-    t.datetime "updated_at"
-    t.datetime "created_at"
-  end
-
-  create_table "states", :primary_key => "postal_abbreviation", :id => false, :force => true do |t|
-    t.string   "postal_abbreviation"
-    t.integer  "fips_code"
-    t.string   "name"
-    t.string   "census_division_number"
-    t.string   "petroleum_administration_for_defense_district_code"
-    t.datetime "updated_at"
-    t.datetime "created_at"
-  end
-
-  create_table "urbanities", :primary_key => "name", :id => false, :force => true do |t|
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table "yearly_anonymous_emissions", :force => true do |t|
-    t.string  "component"
-    t.integer "year"
-    t.float   "emission"
-  end
-
-  create_table "yearly_typical_emissions", :force => true do |t|
-    t.string  "component"
-    t.integer "year"
-    t.float   "emission"
-  end
-
-  create_table "zip_codes", :primary_key => "name", :id => false, :force => true do |t|
-    t.string   "name"
-    t.string   "state_postal_abbreviation"
-    t.string   "description"
-    t.string   "latitude"
-    t.string   "longitude"
-    t.string   "egrid_subregion_abbreviation"
-    t.string   "climate_division_name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-end

data/spec/spec.opts

@@ -1,2 +0,0 @@
---colour
---format progress

data/vendor/geokit-rails/CHANGELOG.rdoc

@@ -1,46 +0,0 @@
-== 2009-10-02 / Version 1.2.0
-* Overhaul the test suite to be independent of a Rails project
-* Added concept of database adapter. Ported mysql/postgresql conditional code to their own adapter.
-* Added SQL Server support. THANKS http://github.com/brennandunn for all the improvements in this release
-
-== 2009-09-26 / Version 1.1.3
-* documentation updates and updated to work with Geokit gem v1.5.0
-* IMPORTANT: in the Geokit gem, Geokit::Geocoders::timeout became Geokit::Geocoders::request_timeout for jruby compatibility.
-The plugin sets this in config/initializers/geokit_config.rb. So if you've upgraded the gem to 1.5.0, you need to
-make the change manually from Geokit::Geocoders::timeout to Geokit::Geocoders::request_timeout in config/initializers/geokit_config.rb
-
-== 2009-06-08 / Version 1.1.2
-* Added support for hashes in :through. So you can do: acts_as_mappable :through => { :state => :country } (Thanks José Valim).
-
-== 2009-05-22 / Version 1.1.1
-* Support for multiple ip geocoders (Thanks dreamcat4)
-* Now checks if either :origin OR :bounds is passed, and proceeds with geokit query if this is true (Thanks Glenn Powell)
-* Raises a helpful error if someone uses through but the association does not exists or was not defined yet (Thanks José Valim)
-
-== 2009-04-11 / Version 1.1.0
-* Fixed :through usages so that the through model is only included in the query if there 
-	is an :origin passed in (Only if it is a geokit search) (Thanks Glenn Powell)
-* Move library initialisation into lib/geokit-rails. init.rb uses lib/geokit-rails now (thanks Alban Peignier)
-* Handle the case where a user passes a hash to the :conditions Finder option (thanks Adam Greene)
-* Added ability to specify domain-specific API keys (Thanks Glenn Powell)
-
-== 2009-02-20
-* More powerful assosciations in the Rails Plugin:You can now specify a model as mappable "through" an associated model. 
-In other words, that associated model is the actual mappable model with "lat" and "lng" attributes, but this "through" model 
-can still utilize all Geokit's "find by distance" finders. Also Rails 2.3 compatibility (thanks github/glennpow)
-
-== 2008-12-18
-* Split Rails plugin from geocoder gem
-* updated for Rails 2.2.2
-
-== 2008-08-20
-* Further fix of distance calculation, this time in SQL. Now uses least() function, which is available in MySQL version 3.22.5+ and postgres versions 8.1+
-
-== 2008-01-16
-* fixed the "zero-distance" bug (calculating between two points that are the same)
-
-== 2007-11-12
-* fixed a small but with queries crossing meridian, and also fixed find(:closest)
-
-== 2007-10-11
-* Fixed Rails2/Edge compatability

data/vendor/geokit-rails/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2007 Bill Eisenhauer & Andre Lewis
-
-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.

data/vendor/geokit-rails/README.markdown

@@ -1,561 +0,0 @@
-## INSTALLATION
-  
-Geokit consists of a Gem ([geokit-gem](http://github.com/andre/geokit-gem/tree/master)) and a Rails plugin ([geokit-rails](http://github.com/andre/geokit-rails/tree/master)).
-
-#### 1. Install the Rails plugin:
-
-    cd [YOUR_RAILS_APP_ROOT]
-    script/plugin install git://github.com/andre/geokit-rails.git
-    
-#### 2. Add this line to your environment.rb 
-(inside the Rails::Initializer.run do |config| block)
-
-		config.gem "geokit"
-
-This informs Rails of the gem dependency.
-
-#### 3. Tell Rails to install the gem:
-
-		rake gems:install
-
-And you're good to go! If you're running an older verion of Rails, just install the gem manually: `sudo gem install rails`
-
-## FEATURE SUMMARY
-
-Geokit provides key functionality for location-oriented Rails applications:
-
-- Distance calculations, for both flat and spherical environments. For example, 
-  given the location of two points on the earth, you can calculate the miles/KM 
-  between them.
-- ActiveRecord distance-based finders. For example, you can find all the points 
-  in your database within a 50-mile radius.
-- IP-based location lookup utilizing hostip.info. Provide an IP address, and get
-  city name and latitude/longitude in return
-- A before_filter helper to geocoder the user's location based on IP address, 
-  and retain the location in a cookie.
-- Geocoding from multiple providers. It provides a fail-over mechanism, in case 
-  your input fails to geocode in one service. Geocoding is provided buy the Geokit
-  gem, which you must have installed
-  
-The goal of this plugin is to provide the common functionality for location-oriented 
-applications (geocoding, location lookup, distance calculation) in an easy-to-use 
-package.
-
-## A NOTE ON TERMINOLOGY
-
-Throughout the code and API, latitude and longitude are referred to as lat 
-and lng.  We've found over the long term the abbreviation saves lots of typing time.
-
-## LOCATION QUERIES
-
-To get started, just specify an ActiveRecord class as `acts_as_mappale`:
-
-    class Location < ActiveRecord::Base
-      acts_as_mappable
-    end
-
-There are some defaults you can override:
-
-    class Location < ActiveRecord::Base
-      acts_as_mappable :default_units => :miles, 
-                       :default_formula => :sphere, 
-                       :distance_field_name => :distance,
-                       :lat_column_name => :lat,
-                       :lng_column_name => :lng
-    end
-
-
-The optional parameters are :units, :formula, and distance_field_name.  
-Values for :units can be :miles, :kms (kilometers), or :nms (nautical miles),
-with :miles as the default.  Values for :formula can be :sphere or :flat with
-:sphere as the default.  :sphere gives you Haversine calculations, while :flat 
-gives the Pythagoreum Theory.  These defaults persist through out the plug-in.
-
-The plug-in creates a calculated `distance` field on AR instances that have
-been retrieved throw a Geokit location query. By default, these fields are 
-known as "distance" but this can be changed through the `:distance_field_name` key.  
-
-You can also define alternative column names for latitude and longitude using
-the `:lat_column_name` and `:lng_column_name` keys.  The defaults are 'lat' and
-'lng' respectively.
-
-Once you've specified acts_as_mappable, a set of distance-based 
-finder methods are available:
-
-Origin as a two-element array of latititude/longitude:
-
-		find(:all, :origin => [37.792,-122.393])
-
-Origin as a geocodeable string:
-
-		find(:all, :origin => '100 Spear st, San Francisco, CA')
-
-Origin as an object which responds to lat and lng methods, 
-or latitude and longitude methods, or whatever methods you have 
-specified for `lng_column_name` and `lat_column_name`:
-
-		find(:all, :origin=>my_store) # my_store.lat and my_store.lng methods exist
-
-Often you will need to find within a certain distance. The prefered syntax is:
-
-    find(:all, :origin => @somewhere, :within => 5)
-    
-. . . however these syntaxes will also work:
-
-    find_within(5, :origin => @somewhere)
-    find(:all, :origin => @somewhere, :conditions => "distance < 5")
-    
-Note however that the third form should be avoided. With either of the first two,
-Geokit automatically adds a bounding box to speed up the radial query in the database.
-With the third form, it does not.
-
-If you need to combine distance conditions with other conditions, you should do
-so like this:
-
-    find(:all, :origin => @somewhere, :within => 5, :conditions=>['state=?',state])
-
-If :origin is not provided in the finder call, the find method 
-works as normal.  Further, the key is removed
-from the :options hash prior to invoking the superclass behavior.
-
-Other convenience methods work intuitively and are as follows:
-
-    find_within(distance, :origin => @somewhere)
-    find_beyond(distance, :origin => @somewhere)
-    find_closest(:origin => @somewhere)
-    find_farthest(:origin => @somewhere)
-
-where the options respect the defaults, but can be overridden if 
-desired.  
-
-Lastly, if all that is desired is the raw SQL for distance 
-calculations, you can use the following:
-
-    distance_sql(origin, units=default_units, formula=default_formula)
-
-Thereafter, you are free to use it in find_by_sql as you wish.
-
-There are methods available to enable you to get the count based upon
-the find condition that you have provided.  These all work similarly to
-the finders.  So for instance:
-
-    count(:origin, :conditions => "distance < 5")
-    count_within(distance, :origin => @somewhere)
-    count_beyond(distance, :origin => @somewhere)
-
-## FINDING WITHIN A BOUNDING BOX
- 
-If you are displaying points on a map, you probably need to query for whatever falls within the rectangular bounds of the map:
-
-    Store.find :all, :bounds=>[sw_point,ne_point]
-
-The input to :bounds can be array with the two points or a Bounds object. However you provide them, the order should always be the southwest corner, northeast corner of the rectangle. Typically, you will be getting the sw_point and ne_point from a map that is displayed on a web page.
-
-If you need to calculate the bounding box from a point and radius, you can do that:
-
-    bounds=Bounds.from_point_and_radius(home,5)
-    Store.find :all, :bounds=>bounds
-
-## USING INCLUDES
-
-You can use includes along with your distance finders:
-
-    stores=Store.find :all, :origin=>home, :include=>[:reviews,:cities] :within=>5, :order=>'distance'
-
-*However*, ActiveRecord drops the calculated distance column when you use include. So, if you need to
-use the distance column, you'll have to re-calculate it post-query in Ruby:
-
-    stores.sort_by_distance_from(home)
-
-In this case, you may want to just use the bounding box
-condition alone in your SQL (there's no use calculating the distance twice):
-
-    bounds=Bounds.from_point_and_radius(home,5)
-    stores=Store.find :all, :include=>[:reviews,:cities] :bounds=>bounds
-    stores.sort_by_distance_from(home)
-    
-## USING :through
-
-You can also specify a model as mappable "through" another associated model.  
-In other words, that associated model is the actual mappable model with 
-"lat" and "lng" attributes, but this "through" model can still utilize
-all of the above find methods to search for records.
-
-    class Location < ActiveRecord::Base
-      belongs_to :locatable, :polymorphic => true
-      acts_as_mappable
-    end
-
-    class Company < ActiveRecord::Base
-      has_one :location, :as => :locatable  # also works for belongs_to associations
-      acts_as_mappable :through => :location
-    end
-    
-Then you can still call:
-    
-    Company.find_within(distance, :origin => @somewhere)
-
-You can also give :through a hash if you location is nested deep. For example, given:
-
-    class House
-      acts_as_mappable
-    end
-
-    class Family
-      belongs_to :house
-    end
-
-    class Person
-      belongs_to :family
-      acts_as_mappable :through => { :family => :house }
-    end
-
-Remember that the notes above about USING INCLUDES apply to the results from 
-this find, since an include is automatically used.
-
-## IP GEOCODING
-
-You can obtain the location for an IP at any time using the geocoder
-as in the following example:
-
-    location = IpGeocoder.geocode('12.215.42.19')
-
-where Location is a GeoLoc instance containing the latitude, 
-longitude, city, state, and country code.  Also, the success 
-value is true.
-
-If the IP cannot be geocoded, a GeoLoc instance is returned with a
-success value of false.  
-
-It should be noted that the IP address needs to be visible to the
-Rails application.  In other words, you need to ensure that the 
-requesting IP address is forwarded by any front-end servers that
-are out in front of the Rails app.  Otherwise, the IP will always
-be that of the front-end server.
-
-The Multi-Geocoder will also geocode IP addresses and provide
-failover among multiple IP geocoders. Just pass in an IP address for the 
-parameter instead of a street address. Eg:
-
-	location = Geocoders::MultiGeocoder.geocode('12.215.42.19')
-
-The MultiGeocoder class requires 2 configuration setting for the provider order. 
-Ordering is done through `Geokit::Geocoders::provider_order` and 
-`Geokit::Geocoders::ip_provider_order`, found in 
-`config/initializers/geokit_config.rb`. If you don't already have a 
-`geokit_config.rb` file, the plugin creates one when it is first installed.
-
-
-## IP GEOCODING HELPER
-
-A class method called geocode_ip_address has been mixed into the 
-ActionController::Base.  This enables before_filter style lookup of
-the IP address.  Since it is a filter, it can accept any of the 
-available filter options.
-
-Usage is as below:
-
-    class LocationAwareController < ActionController::Base
-      geocode_ip_address
-    end
-
-A first-time lookup will result in the GeoLoc class being stored
-in the session as `:geo_location` as well as in a cookie called
-`:geo_session`.  Subsequent lookups will use the session value if it
-exists or the cookie value if it doesn't exist.  The last resort is
-to make a call to the web service.  Clients are free to manage the
-cookie as they wish.
-
-The intent of this feature is to be able to provide a good guess as
-to a new visitor's location.
-
-## INTEGRATED FIND AND GEOCODING
-
-Geocoding has been integrated with the finders enabling you to pass
-a physical address or an IP address.  This would look the following:
-
-    Location.find_farthest(:origin => '217.15.10.9')
-    Location.find_farthest(:origin => 'Irving, TX')
-
-where the IP or physical address would be geocoded to a location and
-then the resulting latitude and longitude coordinates would be used 
-in the find.  This is not expected to be common usage, but it can be
-done nevertheless.
-
-## ADDRESS GEOCODING
-
-Geocoding is provided by the Geokit gem, which is required for this plugin.
-See the top of this file for instructions on installing the Geokit gem.
-
-Geokit can geocode addresses using multiple geocodeing web services.
-Geokit supports services like Google, Yahoo, and Geocoder.us, and more --
-see the Geokit gem API for a complete list.
-
-These geocoder services are made available through the following classes: 
-GoogleGeocoder, YahooGeocoder, UsGeocoder, CaGeocoder, and GeonamesGeocoder.
-Further, an additional geocoder class called MultiGeocoder incorporates an ordered failover
-sequence to increase the probability of successful geocoding.
-
-All classes are called using the following signature:
-
-    include Geokit::Geocoders
-    location = XxxGeocoder.geocode(address)
-
-where you replace Xxx Geocoder with the appropriate class.  A GeoLoc
-instance is the result of the call.  This class has a "success"
-attribute which will be true if a successful geocoding occurred.  
-If successful, the lat and lng properties will be populated.
-
-Geocoders are named with the convention NameGeocoder.  This
-naming convention enables Geocoder to auto-detect its sub-classes
-in order to create methods called `name_geocoder(address)` so that
-all geocoders can be called through the base class.  This is done 
-purely for convenience; the individual geocoder classes are expected
-to be used independently.
-
-The MultiGeocoder class requires the configuration of a provider
-order which dictates what order to use the various geocoders.  Ordering
-is done through `Geokit::Geocoders::provider_order`, found in 
-`config/initializers/geokit_config.rb`.
-
-If you don't already have a `geokit_config.rb` file, the plugin creates one
-when it is first installed.
-
-Make sure your failover configuration matches the usage characteristics 
-of your application -- for example, if you routinely get bogus input to 
-geocode, your code will be much slower if you have to failover among 
-multiple geocoders before determining that the input was in fact bogus. 
-
-The Geocoder.geocode method returns a GeoLoc object. Basic usage:
-
-    loc=Geocoder.geocode('100 Spear St, San Francisco, CA')
-    if loc.success
-      puts loc.lat
-      puts loc.lng
-      puts loc.full_address
-    end
-
-## REVERSE GEOCODING
-
-Currently, only the Google Geocoder supports reverse geocoding. 
-Pass the lat/lng as a string, array or LatLng instance:
-
-		res=Geokit::Geocoders::GoogleGeocoder.reverse_geocode "37.791821,-122.394679"
-		=> #<Geokit::GeoLoc:0x558ed0 ...
-		res.full_address
-		"101-115 Main St, San Francisco, CA 94105, USA"
-
-The address will usually appear as a range, as it does in the above example.
-
-
-## INTEGRATED FIND WITH ADDRESS GEOCODING
-
-Just has you can pass an IP address directly into an ActiveRecord finder
-as the origin, you can also pass a physical address as the origin:
-
-    Location.find_closest(:origin => '100 Spear st, San Francisco, CA')
-
-where the physical address would be geocoded to a location and then the 
-resulting latitude and longitude coordinates would be used in the 
-find. 
-
-Note that if the address fails to geocode, the find method will raise an 
-ActiveRecord::GeocodeError you must be prepared to catch. Alternatively,
-You can geocoder the address beforehand, and pass the resulting lat/lng
-into the finder if successful.
-
-## Auto Geocoding
-
-If your geocoding needs are simple, you can tell your model to automatically
-geocode itself on create:
-
-    class Store < ActiveRecord::Base
-      acts_as_mappable :auto_geocode=>true
-    end
-
-It takes two optional params:
-
-    class Store < ActiveRecord::Base
-      acts_as_mappable :auto_geocode=>{:field=>:address, :error_message=>'Could not geocode address'}
-    end
-
-. . . which is equivilent to:
-
-    class Store << ActiveRecord::Base
-      acts_as_mappable
-      before_validation_on_create :geocode_address
-
-      private
-      def geocode_address
-        geo=Geokit::Geocoders::MultiGeocoder.geocode (address)
-        errors.add(:address, "Could not Geocode address") if !geo.success
-        self.lat, self.lng = geo.lat,geo.lng if geo.success
-      end
-    end
-    
-If you need any more complicated geocoding behavior for your model, you should roll your own 
-`before_validate` callback.
-
-
-## Distances, headings, endpoints, and midpoints
-
-    distance=home.distance_from(work, :units=>:miles)
-    heading=home.heading_to(work) # result is in degrees, 0 is north
-    endpoint=home.endpoint(90,2)  # two miles due east
-    midpoing=home.midpoint_to(work)
-
-## Cool stuff you can do with bounds
-    
-    bounds=Bounds.new(sw_point,ne_point)
-    bounds.contains?(home)
-    puts bounds.center
-    
-
-HOW TO . . .
-=================================================================================
-
-A few quick examples to get you started ....
-
-## How to install the Geokit Rails plugin 
-(See the very top of this file)	
-
-## How to find all stores within a 10-mile radius of a given lat/lng
-1. ensure your stores table has lat and lng columns with numeric or float 
-   datatypes to store your latitude/longitude
-
-3. use `acts_as_mappable` on your store model:
-
-    class Store < ActiveRecord::Base
-       acts_as_mappable
-       ...
-    end
-
-3. finders now have extra capabilities:
-
-    Store.find(:all, :origin =>[32.951613,-96.958444], :within=>10)
-
-## How to geocode an address
-
-1. configure your geocoder key(s) in `config/initializers/geokit_config.rb`
-
-2. also in `geokit_config.rb`, make sure that `Geokit::Geocoders::provider_order` reflects the 
-   geocoder(s). If you only want to use one geocoder, there should
-   be only one symbol in the array. For example:
-   
-    Geokit::Geocoders::provider_order=[:google]
-   
-3. Test it out in script/console
-
-    include Geokit::Geocoders
-    res = MultiGeocoder.geocode('100 Spear St, San Francisco, CA')
-    puts res.lat
-    puts res.lng
-    puts res.full_address 
-    ... etc. The return type is GeoLoc, see the API for 
-    all the methods you can call on it.
-
-## How to find all stores within 10 miles of a given address
-
-1. as above, ensure your table has the lat/lng columns, and you've
-   applied `acts_as_mappable` to the Store model.
-
-2. configure and test out your geocoder, as above
-
-3. pass the address in under the :origin key
-
-		Store.find(:all, :origin=>'100 Spear st, San Francisco, CA', 
-		           :within=>10)
-
-4. you can also use a zipcode, or anything else that's geocodable:
-
-		Store.find(:all, :origin=>'94117', 
-		           :conditions=>'distance<10')
-
-## How to sort a query by distance from an origin
-
-You now have access to a 'distance' column, and you can use it
-as you would any other column. For example:
-		Store.find(:all, :origin=>'94117', :order=>'distance')
-
-## How to elements of an array according to distance from a common point
-
-Usually, you can do your sorting in the database as part of your find call.
-If you need to sort things post-query, you can do so:
-
-    stores=Store.find :all
-    stores.sort_by_distance_from(home)
-    puts stores.first.distance
-    
-Obviously, each of the items in the array must have a latitude/longitude so
-they can be sorted by distance.
-
-## Database indexes
-
-MySQL can't create indexes on a calculated field such as those Geokit uses to
-calculate distance based on latitude/longitude values for a record.  However,
-indexing the lat and lng columns does improve Geokit distance calculation
-performance since the lat and lng columns are used in a straight comparison
-for distance calculation.  Assuming a Page model that is incorporating the
-Geokit plugin the migration would be as follows.
-
-    class AddIndexOPageLatAndLng < ActiveRecord::Migration
-
-      def self.up
-        add_index  :pages, [:lat, :lng]
-      end
-
-      def self.down
-        remove_index  :pages, [:lat, :lng]
-      end
-    end
-
-## Database Compatability
-
-* Geokit works with MySQL (tested with version 5.0.41), PostgreSQL (tested with version 8.2.6) and Microsoft SQL Server (tested with 2000).
-* Geokit does *not* work with SQLite, as it lacks the necessary geometry functions. 
-* Geokit is known to *not* work with Postgres versions under 8.1 -- it uses the least() funciton.
-
-
-## HIGH-LEVEL NOTES ON WHAT'S WHERE
-
-`acts_as_mappable.rb`, as you'd expect, contains the ActsAsMappable
-module which gets mixed into your models to provide the 
-location-based finder goodness.
-
-`ip_geocode_lookup.rb` contains the before_filter helper method which
-enables auto lookup of the requesting IP address.
-
-### The Geokit gem provides the building blocks of distance-based operations:
-
-The Mappable module, which provides basic
-distance calculation methods, i.e., calculating the distance
-between two points. 
-
-The LatLng class  is a simple container for latitude and longitude, but 
-it's made more powerful by mixing in the above-mentioned Mappable
-module -- therefore, you can calculate easily the distance between two
-LatLng ojbects with `distance = first.distance_to(other)`
-
-GeoLoc represents an address or location which
-has been geocoded. You can get the city, zipcode, street address, etc.
-from a GeoLoc object. GeoLoc extends LatLng, so you also get lat/lng
-AND the Mappable modeule goodness for free.
-
-## GOOGLE GROUP
-
-Follow the Google Group for updates and discussion on Geokit: http://groups.google.com/group/geokit 
-
-## IMPORTANT POST-INSTALLATION NOTES: 
-
-*1. The configuration file*: Geokit for Rails uses a configuration file in config/initializers. 
-You *must* add your own keys for the various geocoding services if you want to use geocoding. 
-If you need to refer to the original template again, see the `assets/api_keys_template` file.
-
-*2. The gem dependency*: Geokit for Rails depends on the Geokit gem. Tell Rails about this 
-dependency in `config/environment.rb`, within the initializer block:
-config.gem "geokit"
-
-*If you're having trouble with dependencies ....*
-
-Try installing the gem manually (sudo gem install geokit), then adding a `require 'geokit'` to the top of 
-`vendor/plugins/geokit-rails/init.rb` and/or `config/geokit_config.rb`.