geocoder 0.1.1 → 0.9.8

data/lib/geocoder/result.rb

@@ -0,0 +1,42 @@
+module Geocoder
+  class Result
+    attr_accessor :data
+
+    ##
+    # Takes a hash of result data from a parsed Google result document.
+    #
+    def initialize(data)
+      @data = data
+    end
+
+    def types
+      @data['types']
+    end
+
+    def formatted_address
+      @data['formatted_address']
+    end
+
+    def address_components
+      @data['address_components']
+    end
+
+    ##
+    # Get address components of a given type. Valid types are defined in
+    # Google's Geocoding API documentation and include (among others):
+    #
+    #   :street_number
+    #   :locality
+    #   :neighborhood
+    #   :route
+    #   :postal_code
+    #
+    def address_components_of_type(type)
+      address_components.select{ |c| c['types'].include?(type.to_s) }
+    end
+
+    def geometry
+      @data['geometry']
+    end
+  end
+end

data/lib/tasks/geocoder.rake

@@ -0,0 +1,15 @@
+def klass
+  class_name = ENV['CLASS'] || ENV['class']
+  raise "Please specify a CLASS (model)" unless class_name
+  Object.const_get(class_name)
+end
+
+namespace :geocode do
+
+  desc "Geocode all objects without coordinates."
+  task :all => :environment do
+    klass.not_geocoded.each do |obj|
+      obj.fetch_coordinates!
+    end
+  end
+end

data/test/geocoder_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class GeocoderTest < Test::Unit::TestCase
+
+  def test_fetch_coordinates
+    v = Venue.new(*venue_params(:msg))
+    assert_equal [40.750354, -73.993371], v.fetch_coordinates
+    assert_equal [40.750354, -73.993371], [v.latitude, v.longitude]
+  end
+
+  # sanity check
+  def test_distance_between
+    assert_equal 69, Geocoder::Calculations.distance_between(0,0, 0,1).round
+  end
+
+  # sanity check
+  def test_geographic_center
+    assert_equal [0.0, 0.5],
+      Geocoder::Calculations.geographic_center([[0,0], [0,1]])
+    assert_equal [0.0, 1.0],
+      Geocoder::Calculations.geographic_center([[0,0], [0,1], [0,2]])
+  end
+
+  def test_exception_raised_for_unconfigured_geocoding
+    l = Landmark.new("Mount Rushmore", 43.88, -103.46)
+    assert_raises Geocoder::ConfigurationError do
+      l.fetch_coordinates
+    end
+  end
+
+  def test_result_address_components_of_type
+    results = Geocoder::Lookup.search("Madison Square Garden, New York, NY")
+    assert_equal "Manhattan",
+      results.first.address_components_of_type(:sublocality).first['long_name']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,97 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support/core_ext'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+##
+# Simulate enough of ActiveRecord::Base that objects can be used for testing.
+#
+module ActiveRecord
+  class Base
+
+    def initialize
+      @attributes = {}
+    end
+
+    def read_attribute(attr_name)
+      @attributes[attr_name.to_sym]
+    end
+
+    def write_attribute(attr_name, value)
+      @attributes[attr_name.to_sym] = value
+    end
+
+    def update_attribute(attr_name, value)
+      write_attribute(attr_name.to_sym, value)
+    end
+
+    def self.scope(*args); end
+  end
+end
+
+# Require Geocoder after ActiveRecord simulator.
+require 'geocoder'
+
+##
+# Mock HTTP request to geocoding service.
+#
+module Geocoder
+  module Lookup
+    extend self
+    private #-----------------------------------------------------------------
+    def fetch_data(query, reverse = false)
+      File.read(File.join("test", "fixtures", "madison_square_garden.json"))
+    end
+  end
+end
+
+##
+# Geocoded model.
+#
+class Venue < ActiveRecord::Base
+  geocoded_by :address
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+
+  ##
+  # If method not found, assume it's an ActiveRecord attribute reader.
+  #
+  def method_missing(name, *args, &block)
+    @attributes[name]
+  end
+end
+
+##
+# Reverse geocoded model.
+#
+class Landmark < ActiveRecord::Base
+  reverse_geocoded_by :latitude, :longitude
+
+  def initialize(name, latitude, longitude)
+    super()
+    write_attribute :name, name
+    write_attribute :latitude, latitude
+    write_attribute :longitude, longitude
+  end
+
+  ##
+  # If method not found, assume it's an ActiveRecord attribute reader.
+  #
+  def method_missing(name, *args, &block)
+    @attributes[name]
+  end
+end
+
+class Test::Unit::TestCase
+  def venue_params(abbrev)
+    {
+      :msg => ["Madison Square Garden", "4 Penn Plaza, New York, NY"]
+    }[abbrev]
+  end
+end

metadata

@@ -1,64 +1,81 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
 name: geocoder
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-02-09 00:00:00 -06:00
-summary: Geocoding library and CLI.
-require_paths: 
-- lib
-email: paul@cnt.org
-homepage: http://geocoder.rubyforge.org
-rubyforge_project: geocoder
-description: 
-autorequire: geocoder
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  hash: 43
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 8
+  version: 0.9.8
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
-- Paul Smith
+- Alex Reisner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Geocoder adds object geocoding and distance calculations to ActiveRecord models. It does not rely on proprietary database functions so finding geocoded objects in a given area is easily done using out-of-the-box MySQL, PostgreSQL, or SQLite.
+email: 
+- alex@alexreisner.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/geocoder.rb
-- bin/geocode
-- CHANGELOG
-- LICENSE
+- lib/geocoder/lookup.rb
+- lib/geocoder/calculations.rb
+- lib/geocoder/railtie.rb
+- lib/geocoder/result.rb
+- lib/geocoder/configuration.rb
+- lib/geocoder/active_record.rb
+- lib/tasks/geocoder.rake
+- test/test_helper.rb
+- test/geocoder_test.rb
+- CHANGELOG.rdoc
 - Rakefile
-- README
-- TODO
-- test/mocks
-- test/sample.xml
-- test/tc_geocoderus.rb
-- test/tc_yahoo.rb
-- test/ts_geocoder.rb
-- test/mocks/csv?address=2038+damen+ave+chicago+il
-- test/mocks/csv?address=2125+w+north+ave+chicago+il
-- test/mocks/csv?address=donotleaveitisnotreal
-- test/mocks/geocode?appid=YahooDemo&location=
-- test/mocks/geocode?appid=YahooDemo&location=2038+damen+ave+chicago+il
-- test/mocks/geocode?appid=YahooDemo&location=2125+w+north+ave+chicago+il
-- test/mocks/geocode?appid=YahooDemo&location=donotleaveitisnotreal
-- test/mocks/http.rb
-test_files: []
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/alexreisner/geocoder
+licenses: []
 
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: 
-- geocode
-extensions: []
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
 
-requirements: 
-- none
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple, database-agnostic geocoding and distance calculations for Rails.
+test_files: []
 

data/CHANGELOG

@@ -1,10 +0,0 @@
-= 0.1.0a
-== February 9, 2006
-
-* Fixed gem: no redundant require statement needed
-
-
-= 0.1.0 
-== February 8, 2006
-
-* Initial release.

data/README

@@ -1,122 +0,0 @@
-= Geocoder: Geocoding library for Ruby and command-line utility
-
-Author:: Paul Smith <paul@cnt.org>
-License:: MIT
-
-Geocoder helps in converting street addresses to coordinate pairs,
-specifically latitude and longitude (in degrees decimal). It also
-provides address normalization.
-
-It comes with a library so that Ruby developers can include geocoding
-in their applications. It also comes with a command-line application,
-<tt>geocode</tt>, that is useful for one-offs, shell scripts, and non-Ruby
-applications.
-
-== How it works
-
-The Geocoder is basically a wrapper for geocoding web services.
-Currently, two services are utilized: {Yahoo! Maps Geocoding
-API}[http://developer.yahoo.net/maps/rest/V1/geocode.html], which
-is an interface to their proprietary geocoding system; and
-Geocoder.us[http://www.geocoder.us], which is basically a Perl
-frontend to the TIGER/Line file from the US Census Bureau.
-
-Unless the user or developer indicates otherwise, the Yahoo! Maps
-API is used by default.
-
-== Example: library
-
-If you are going to use this library with the Yahoo! Maps Geocoding
-service, you need to get yourself an {Application
-ID}[http://developer.yahoo.net/faq/index.html#appid].
-
-The very simplest use of the library would just instantiate a
-Geocoder object and call the <tt>#geocode</tt> method, grab the
-result, and get the values directly:
-
-  require 'geocoder'
-  geocoder = Geocoder::Yahoo.new "my_app_id" # => #<Geocoder::Yahoo:0x36b77c @appid="my_app_id">
-  result = geocoder.geocode "1600 pennsylvania ave nw washington dc"
-  result.lat # => "38.8987"
-  result.lng # => "-77.037223"
-  result.address # => "1600 PENNSYLVANIA AVE NW"
-  result.city # => "WASHINGTON"
-  result.state # => "DC"
-  result.zip # => "20502-0001"
-
-The result that the <tt>geocode</tt> method returns is a subclass
-of Array; each element contains the "closest match" for ambiguous
-addresses, as determined by the remote geocoding service.
-
-Any sort of production-level code would want to check for success
-and watch for exceptions. Geocoding is an inexact science, so you
-would want to check for success, and iterate over the refinements
-or closest matches that the service returns:
-
-  require 'geocoder'
-  geocoder = Geocoder::Yahoo.new "my_app_id" # => #<Geocoder::Yahoo:0x36ae44 @appid="my_app_id">
-  result = geocoder.geocode "2038 damen ave chicago il"
-  result.success? # => false
-  result.each do |r|
-    r.lat # => "41.854524", "41.918759"
-    r.lng # => "-87.676083", "-87.67763"
-    r.address # => "2038 S DAMEN AVE", "2038 N DAMEN AVE"
-    r.city # => "CHICAGO", "CHICAGO"
-    r.state # => "IL", "IL"
-    r.zip # => "60608-2625", "60647-4564"
-  end
-
-<tt>#success?</tt> is defined by a single result returned from the
-geocoding service (and in the case of the Y! API, with no warning)
-
-  require 'geocoder'
-  geocoder = Geocoder::Yahoo.new "my_app_id"
-  begin
-    result = geocoder.geocode "thisisnotreal"
-  rescue Geocoder::GeocodingError
-    # do something appropriate to your application here
-  end
-
-The Geocoder module defines 2 exception classes:
-
-1. BlankLocationString, thrown if a nil or a empty String is given to the geocode method;
-2. GeocodingError, thrown if the remote service indicates an error, for instance, on an ungeocodeable location
-
-== Example: command-line utility
-
-  % geocode 2125 W North Ave, Chicago IL
-  Found 1 result(s).
-  ------------------
-  Latitude: 41.910263
-  Longitude: -87.680696
-  Address: 2125 W NORTH AVE
-  City: CHICAGO
-  State: IL
-  ZIP Code: 60647-5415
-
-Notice that the geocoder normalizes the address, including city,
-state, and ZIP Code.
-
-You can also throw some switches on it. Try <tt>-q</tt> for quieter, CSV output:
-
-  % geocode -q 1600 pennsylvania ave nw washington dc
-  38.8987,-77.037223,1600 PENNSYLVANIA AVE NW,WASHINGTON,DC,20502-0001
-
-The order of the fields in the CSV output is:
-
-1. latitude (degrees decimal)
-2. longitude (degrees decimal)
-3. street address
-4. city
-5. state
-6. ZIP Code
-
-== Usage: command-line utility
-
-  % geocode -h
-  Options:
-      -a, --appid appid                Yahoo! Application ID
-      -s, --service service            `yahoo' or `geocoderus'
-      -t, --timeout secs               Timeout in seconds
-      -q, --quiet                      Quiet output
-      -h, --help                       Show this message