rails-geocoder 0.8.0 → 0.8.1

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+= Changelog
+
+Per-release changes to Geocoder.
+
+== 0.8.1 (2009 Oct 8)
+
+* Extract XML-fetching code from Geocoder.search and place in Geocoder._fetch_xml (for ease of mocking).
+* Add tests for coordinate-fetching instance methods.
+
+== 0.8.0 (2009 Oct 1)
+
+First release.

data/README.rdoc

@@ -1,14 +1,14 @@
 = Geocoder
 
-Geocoder adds database-agnostic object geocoding to Rails (via Google). It does not rely on proprietary database functions so reasonably accurate distances can be calculated in MySQL or even SQLite.
+Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. 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 or even SQLite.
 
-== Setup
+== Install
 
-Install either *as a plugin*:
+Install either as a plugin:
 
   script/plugin install git://github.com/alexreisner/geocoder.git
 
-or *as a gem*:
+or as a gem:
 
   # add to config/environment.rb:
   config.gem "rails-geocoder", :lib => "geocoder", :source => "http://gemcutter.org/"
@@ -16,6 +16,8 @@ or *as a gem*:
   # at command prompt:
   sudo rake gems:install
 
+== Configure
+
 To add geocoding features to a class:
 
   geocoded_by :location
@@ -36,8 +38,7 @@ If your model has +address+, +city+, +state+, and +country+ attributes your +loc
     [address, city, state, country].compact.join(', ')
   end
 
-
-== Features
+== Use
 
 Assuming +Venue+ is a geocoded model:
 

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name        = "rails-geocoder"
     gem.summary     = %Q{Add geocoding functionality to Rails models.}
-    gem.description = %Q{Add geocoding functionality to Rails models.}
+    gem.description = %Q{Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. 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 or even SQLite.}
     gem.email       = "alex@alexreisner.com"
     gem.homepage    = "http://github.com/alexreisner/geocoder"
     gem.authors     = ["Alex Reisner"]

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/lib/geocoder.rb

@@ -210,7 +210,21 @@ module Geocoder
   # Returns the XML response as a hash. This method is not intended for
   # general use (prefer Geocoder.search).
   #
+  # Google's XML document has incorrect encoding (says UTF-8 but is actually
+  # ISO 8859-1). We have to fix this or REXML won't parse it 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
+  #
   def self.search(query)
+    if doc = _fetch_xml(query)
+      REXML::Document.new(doc.sub('UTF-8', 'ISO-8859-1'))
+    end
+  end
+  
+  ##
+  # Request an XML geo search result from Google.
+  #
+  def self._fetch_xml(query)
     params = { :q => query, :output => "xml" }
     url    = "http://maps.google.com/maps/geo?" + params.to_query
     
@@ -218,19 +232,11 @@ module Geocoder
     begin
       resp = nil
       timeout(3) do
-        resp = Net::HTTP.get_response(URI.parse(url))
+        Net::HTTP.get_response(URI.parse(url)).body
       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')
-
-    REXML::Document.new(doc)
   end
 end
 

data/rails-geocoder.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails-geocoder}
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Reisner"]
-  s.date = %q{2009-10-01}
-  s.description = %q{Add geocoding functionality to Rails models.}
+  s.date = %q{2009-10-08}
+  s.description = %q{Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. 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 or even SQLite.}
   s.email = %q{alex@alexreisner.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -26,6 +27,7 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/geocoder.rb",
      "rails-geocoder.gemspec",
+     "test/fixtures/madison_square_garden.xml",
      "test/geocoder_test.rb",
      "test/test_helper.rb"
   ]

data/test/fixtures/madison_square_garden.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<kml xmlns="http://earth.google.com/kml/2.0"><Response>
+  <name>4 Penn Plaza, New York, NY</name>
+  <Status>
+    <code>200</code>
+    <request>geocode</request>
+  </Status>
+  <Placemark id="p1">
+    <address>4 Penn Plaza, New York, NY 10001, USA</address>
+    <AddressDetails Accuracy="8" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><CountryName>USA</CountryName><AdministrativeArea><AdministrativeAreaName>NY</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>New York</SubAdministrativeAreaName><Locality><LocalityName>New York</LocalityName><Thoroughfare><ThoroughfareName>4 Penn Plaza</ThoroughfareName></Thoroughfare><PostalCode><PostalCodeNumber>10001</PostalCodeNumber></PostalCode></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails>
+    <ExtendedData>
+      <LatLonBox north="40.7527158" south="40.7464206" east="-73.9885076" west="-73.9948028" />
+    </ExtendedData>
+    <Point><coordinates>-73.9916733,40.7495760,0</coordinates></Point>
+  </Placemark>
+</Response></kml>

data/test/geocoder_test.rb

@@ -1,8 +1,15 @@
 require 'test_helper'
 
 class GeocoderTest < Test::Unit::TestCase
-  # Replace this with your real tests.
-  def test_this_plugin
-    flunk
+
+  def test_fetch_coordinates
+    v = Venue.new(*venue_params(:msg))
+    assert_equal [40.7495760, -73.9916733], v.fetch_coordinates
+  end
+
+  def test_fetch_coordinates!
+    v = Venue.new(*venue_params(:msg))
+    v.fetch_coordinates!
+    assert_equal [40.7495760, -73.9916733], [v.latitude, v.longitude]
   end
 end

data/test/test_helper.rb

@@ -1,9 +1,68 @@
 require 'rubygems'
 require 'test/unit'
+require 'activesupport'
 
 $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_s]
+    end
+    
+    def write_attribute(attr_name, value)
+      attr_name = attr_name.to_s
+      @attributes[attr_name] = value
+    end
+    
+    def self.named_scope(*args); end
+  end
+end
+
+# Require Geocoder after ActiveRecord simulator.
 require 'geocoder'
 
+##
+# Mock HTTP request to Google.
+#
+module Geocoder
+  def self._fetch_xml(query)
+    filename = File.join("test", "fixtures", "madison_square_garden.xml")
+    File.read(filename)
+  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
+  
+  # could implement these with method_missing
+  # to simulate custom lat/lon methods
+  def latitude; read_attribute(:latitude); end
+  def longitude; read_attribute(:longitude); 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails-geocoder
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - Alex Reisner
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-01 00:00:00 -04:00
+date: 2009-10-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Add geocoding functionality to Rails models.
+description: Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. 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 or even SQLite.
 email: alex@alexreisner.com
 executables: []
 
@@ -25,6 +25,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -32,6 +33,7 @@ files:
 - init.rb
 - lib/geocoder.rb
 - rails-geocoder.gemspec
+- test/fixtures/madison_square_garden.xml
 - test/geocoder_test.rb
 - test/test_helper.rb
 has_rdoc: true