google-geo 1.0 → 2.0

data/CHANGELOG

@@ -1 +1,6 @@
+= 2.0 Multiple Addresses (and tests you can actually run!)
+  - Not insignificant API change: *** Google::Geo#locate ALWAYS RETURNS AN ARRAY ***
+  - There are now some nice examples in the README.
+  - Updated to include the fixtures and vendor dependencies for tests, yeknow, so you can actually run them.
+  - No namby pamby point releases. This is serious, folks.
 = 1.0 Initial Release

data/README

@@ -5,23 +5,27 @@ A simple, elegant library for getting geocoding information from Google Maps. Ve
 == Examples
 
   geo = Google::Geo.new API_KEY
+
+  addresses = geo.locate '1600 Amphitheatre Parkway, Mountain View, CA'
   
-  address = geo.locate '1600 Amphitheatre Parkway, Mountain View, CA'
+  addresses.size # 1, :locate always returns an Array
   
+  address = addresses.first
+
   address.country      # 'US'
   address.city         # 'Mountain View'
   address.full_address # '1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA'
-  
+
   address.query        # '1600 Amphitheatre Parkway, Mountain View, CA'
   address.accuracy     # 8
-  
-In the case of sufficiently vague queries, +Google::Geo+ will return an +Array+:
-  
+
+In the case of sufficiently vague queries, Google::Geo will return more than one:
+
   addresses = geo.locate 'hell'
-  
+
   addresses.size                  # 2
-  addresses.map { |a| a.country } # ['US', 'NO']
+  addresses.map { |a| a.state } # ['PA', 'NC']
 
 == Contributors
-    
+
 Seth Thomas Rasmussen - http://sethrasmussen.com - sethrasmussen@gmail.com

data/lib/google/geo.rb

@@ -10,7 +10,11 @@ module Google
 # 
 #   geo = Google::Geo.new API_KEY
 # 
-#   address = geo.locate '1600 Amphitheatre Parkway, Mountain View, CA'
+#   addresses = geo.locate '1600 Amphitheatre Parkway, Mountain View, CA'
+#   
+#   addresses.size # 1, :locate always returns an Array
+#   
+#   address = addresses.first
 # 
 #   address.country      # 'US'
 #   address.city         # 'Mountain View'
@@ -19,12 +23,12 @@ module Google
 #   address.query        # '1600 Amphitheatre Parkway, Mountain View, CA'
 #   address.accuracy     # 8
 # 
-# In the case of sufficiently vague queries, +Google::Geo+ will return an +Array+:
+# In the case of sufficiently vague queries, Google will return more than one address:
 # 
-#   addresses = geo.locate 'hell'
+#   addresses = geo.locate 'heaven'
 # 
 #   addresses.size                  # 2
-#   addresses.map { |a| a.country } # ['US', 'NO']
+#   addresses.map { |a| a.state } # ['PA', 'NC']
 # 
 # == Contributors
 # 
@@ -37,8 +41,8 @@ class  Geo
     @key = key
   end
   
-  # Returns an +Address+ object with accessors for all the components of a location. 
-  # The +query+ argument should be a string.
+  # Returns an array of Address objects, each with accessors for all the components of a location. 
+  # The query argument should be a string.
   def locate(query)
     xml = open(uri(query)).read
     res = Response.new(xml, key)

data/test/fixtures/invalid_map_key.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>1600 Amphitheater Pkwy, Mountain View, CA</name>
+    <Status>
+      <code>610</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/fixtures/missing_address.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>1600</name>
+    <Status>
+      <code>601</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/fixtures/server_error.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>1600 Amphitheater Pkwy, Mountain View, CA</name>
+    <Status>
+      <code>500</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/fixtures/success.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.1">
+  <Response>
+    <name>1600 Amphitheatre Parkway, Mountain View, CA</name>
+    <Status>
+      <code>200</code>
+      <request>geocode</request>
+    </Status>
+    <Placemark>
+      <address>1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA</address>
+      <AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0" Accuracy="8">
+        <Country>
+          <CountryNameCode>US</CountryNameCode>
+          <AdministrativeArea>
+            <AdministrativeAreaName>CA</AdministrativeAreaName>
+            <SubAdministrativeArea>
+              <SubAdministrativeAreaName>Santa Clara</SubAdministrativeAreaName>
+              <Locality>
+                <LocalityName>Mountain View</LocalityName>
+                <Thoroughfare>
+                  <ThoroughfareName>1600 Amphitheatre Pkwy</ThoroughfareName>
+                </Thoroughfare>
+                <PostalCode>
+                  <PostalCodeNumber>94043</PostalCodeNumber>
+                </PostalCode>
+              </Locality>
+            </SubAdministrativeArea>
+          </AdministrativeArea>
+        </Country>
+      </AddressDetails>
+      <Point>
+        <coordinates>-122.083739,37.423021,0</coordinates>
+      </Point>
+    </Placemark>
+  </Response>
+</kml>

data/test/fixtures/success_with_multiple_addresses.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>heaven</name>
+    <Status>
+      <code>200</code>
+      <request>geocode</request>
+    </Status>
+    <Placemark id="p1">
+      <address>Heaven, Pottsville, PA 17901, USA</address>
+      <AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0" Accuracy="6">
+        <Country>
+          <CountryNameCode>US</CountryNameCode>
+          <AdministrativeArea>
+            <AdministrativeAreaName>PA</AdministrativeAreaName>
+            <SubAdministrativeArea>
+              <SubAdministrativeAreaName>Schuylkill</SubAdministrativeAreaName>
+              <Locality>
+                <LocalityName>Pottsville</LocalityName>
+                <Thoroughfare>
+                  <ThoroughfareName>Heaven</ThoroughfareName>
+                </Thoroughfare>
+                <PostalCode>
+                  <PostalCodeNumber>17901</PostalCodeNumber>
+                </PostalCode>
+              </Locality>
+            </SubAdministrativeArea>
+          </AdministrativeArea>
+        </Country>
+      </AddressDetails>
+      <Point>
+        <coordinates>-76.169968,40.650970,0</coordinates>
+      </Point>
+    </Placemark>
+    <Placemark id="p2">
+      <address>Heaven, Oakboro, NC 28129, USA</address>
+      <AddressDetails xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0" Accuracy="6">
+        <Country>
+          <CountryNameCode>US</CountryNameCode>
+          <AdministrativeArea>
+            <AdministrativeAreaName>NC</AdministrativeAreaName>
+            <SubAdministrativeArea>
+              <SubAdministrativeAreaName>Stanly</SubAdministrativeAreaName>
+              <Locality>
+                <LocalityName>Oakboro</LocalityName>
+                <Thoroughfare>
+                  <ThoroughfareName>Heaven</ThoroughfareName>
+                </Thoroughfare>
+                <PostalCode>
+                  <PostalCodeNumber>28129</PostalCodeNumber>
+                </PostalCode>
+              </Locality>
+            </SubAdministrativeArea>
+          </AdministrativeArea>
+        </Country>
+      </AddressDetails>
+      <Point>
+        <coordinates>-80.330399,35.254227,0</coordinates>
+      </Point>
+    </Placemark>
+  </Response>
+</kml>

data/test/fixtures/too_many_queries.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>1600 Amphitheater Pkwy, Mountain View, CA</name>
+    <Status>
+      <code>620</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/fixtures/unavailable_address.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>42-44 Hanway Street, London</name>
+    <Status>
+      <code>603</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/fixtures/unknown_address.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+  <Response>
+    <name>1600</name>
+    <Status>
+      <code>602</code>
+      <request>geocode</request>
+    </Status>
+  </Response>
+</kml>

data/test/geo_test.rb

@@ -10,7 +10,8 @@ class Google::GeoTest < Test::Unit::TestCase
 
   def test_success
     @geo.expects(:open).
-         with("http://maps.google.com/maps/geo?q=1600%20Amphitheatre%20Parkway,%20Mountain%20View,%20CA&key=API_KEY&output=xml"). # show that query is escaped
+         # show that query is escaped
+         with("http://maps.google.com/maps/geo?q=1600%20Amphitheatre%20Parkway,%20Mountain%20View,%20CA&key=API_KEY&output=xml").
          returns(response(:success))
     
     query = '1600 Amphitheatre Parkway, Mountain View, CA'
@@ -50,6 +51,19 @@ class Google::GeoTest < Test::Unit::TestCase
     assert_equal '1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA', address.full_address
     assert_equal query, address.query
   end
+  
+  def test_success_with_multiple_addresses
+    @geo.expects(:open).returns(response(:success_with_multiple_addresses))
+    
+    heavens = @geo.locate('heaven')
+    
+    assert_equal 2, heavens.size
+    
+    assert_equal 'Heaven, Pottsville, PA 17901, USA', heavens[0].full_address
+    assert_equal 'Heaven, Oakboro, NC 28129, USA', heavens[1].full_address
+    
+    heavens.each { |h| assert_kind_of Google::Geo::Address, h }
+  end
 
   def test_invalid_map_key
     @geo.expects(:open).returns(response(:invalid_map_key))
@@ -81,8 +95,8 @@ class Google::GeoTest < Test::Unit::TestCase
     assert_raises(Google::Geo::UnknownAddressError) { @geo.locate 'foo' }
   end
   
-  private
-    def response(filename)
-      File.new "#{File.dirname __FILE__}/fixtures/#{filename}.xml"
-    end
+private
+  def response(filename)
+    File.new "#{File.dirname __FILE__}/fixtures/#{filename}.xml"
+  end
 end

data/vendor/mocha-0.4.0/COPYING

@@ -0,0 +1,3 @@
+Copyright Revieworld Ltd. 2006
+ 	
+You may use, copy and redistribute this library under the same terms as Ruby itself (see http://www.ruby-lang.org/en/LICENSE.txt) or under the MIT license (see MIT-LICENSE file).

data/vendor/mocha-0.4.0/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2006 Revieworld Ltd.
+
+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/mocha-0.4.0/README

@@ -0,0 +1,35 @@
+= Mocha
+
+Mocha is a library for mocking and stubbing using a syntax like that of JMock[http://www.jmock.org], and SchMock[http://rubyforge.org/projects/schmock]. Most commonly Mocha is used in conjunction with Test::Unit[http://www.ruby-doc.org/core/classes/Test/Unit.html], but it can be used in other contexts.
+
+One of its main advantages is that it allows you to mock and stub methods on _real_ (non-mock) classes and instances. You can for example stub ActiveRecord[http://api.rubyonrails.com/classes/ActiveRecord/Base.html] instance methods like +create+, +save+, +destroy+ and even class methods like +find+ to avoid hitting the database in unit tests.
+
+Mocha provides a unified, simple and readable syntax for both traditional mocking and for mocking with _real_ objects.
+
+Mocha has been harvested from projects at Reevoo[http://www.reevoo.com] by me (James[http://blog.floehopper.org]) and my colleagues Ben[http://www.reevoo.com/blogs/bengriffiths], Chris[http://blog.seagul.co.uk] and Paul[http://po-ru.com]. Mocha is in use on real-world Rails[http://www.rubyonrails.org] projects.
+
+== Download and Installation
+
+Install the gem with the following command...
+
+  $ gem install mocha
+ 
+Or install the Rails[http://www.rubyonrails.org] plugin...
+
+  $ script/plugin install svn://rubyforge.org/var/svn/mocha/trunk
+
+Or download Mocha from here - http://rubyforge.org/projects/mocha
+
+== Examples
+
+* Quick Start - {Usage Examples}[link:examples/misc.html]
+* Traditional mocking - {Star Trek Example}[link:examples/mocha.html]
+* Setting expectations on real classes - {Order Example}[link:examples/stubba.html]
+* More examples on {Floehopper's Blog}[http://blog.floehopper.org]
+* {Mailing List Archives}[http://rubyforge.org/pipermail/mocha-developer/]
+
+== License
+
+Copyright Revieworld Ltd. 2006
+ 	
+You may use, copy and redistribute this library under the same terms as {Ruby itself}[http://www.ruby-lang.org/en/LICENSE.txt] or under the {MIT license}[http://mocha.rubyforge.org/files/MIT-LICENSE.html].

data/vendor/mocha-0.4.0/RELEASE

@@ -0,0 +1,98 @@
+= 0.4.0
+
+- Allow naming of mocks (patch from Chris Roos).
+- Specify multiple return values for consecutive calls.
+- Improved consistency of expectation error messages.
+- Allow mocking of Object instance methods e.g. kind_of?, type.
+- Provide aliased versions of #expects and #stubs to allow mocking of these methods.
+- Added at_least, at_most, at_most_once methods to expectation.
+- Allow expects and stubs to take a hash of method and return values.
+- Eliminate warning: "instance variable @yield not initialized" (patch from Xavier Shay).
+- Restore instance methods on partial mocks (patch from Chris Roos).
+- Allow stubbing of a method with non-word characters in its name (patch from Paul Battley).
+- Removed coupling to Test::Unit.
+- Allow specified exception instance to be raised (patch from Chris Roos).
+- Make mock object_id appear in hex like normal Ruby inspect (patch from Paul Battley).
+- Fix path to object.rb in rdoc rake task (patch from Tomas Pospisek).
+- Reverse order in which expectations are matched, so that last expectation is matched first. This allows e.g. a call to #stubs to be effectively overridden by a call to #expects (patch from Tobias Lutke).
+- Stubba & SmartTestCase modules incorporated into Mocha module so only need to require 'mocha' - no longer need to require 'stubba'.
+- AutoMocha removed.
+
+= 0.3.3
+
+- Quick bug fix to restore instance methods on partial mocks (for Kevin Clark).
+
+= 0.3.2
+
+- Examples added.
+
+= 0.3.1
+
+- Dual licensing with MIT license added.
+
+= 0.3.0
+
+* Rails plugin.
+* Auto-verify for expectations on concrete classes.
+* Include each expectation verification in the test result assertion count.
+* Filter out noise from assertion backtraces.
+* Point assertion backtrace to line where failing expectation was created.
+* New yields method for expectations.
+* Create stubs which stub all method calls.
+* Mocks now respond_to? expected methods.
+
+= 0.2.1
+
+* Rename MochaAcceptanceTest::Rover#move method to avoid conflict with Rake (in Ruby 1.8.4 only?)
+
+= 0.2.0
+
+* Small change to SetupAndTeardown#teardown_stubs suggested by Luke Redpath (http://www.lukeredpath.co.uk) to allow use of Stubba with RSpec (http://rspec.rubyforge.org).
+* Reorganized directory structure and extracted addition of setup and teardown methods into SmartTestCase mini-library.
+* Addition of auto-verify for Mocha (but not Stubba). This means there is more significance in the choice of expects or stubs in that any expects on a mock will automatically get verified.
+
+So instead of...
+
+  wotsit = Mocha.new
+  wotsit.expects(:thingummy).with(5).returns(10)
+  doobrey = Doobrey.new(wotsit)
+  doobrey.hoojamaflip
+  wotsit.verify
+
+you need to do...
+
+  wotsit = mock()
+  wotsit.expects(:thingummy).with(5).returns(10)
+  doobrey = Doobrey.new(wotsit)
+  doobrey.hoojamaflip
+  # no need to verify
+
+There are also shortcuts as follows...
+
+instead of...
+
+  wotsit = Mocha.new
+  wotsit.expects(:thingummy).returns(10)
+  wotsit.expects(:summat).returns(25)
+
+you can have...
+
+  wotsit = mock(:thingummy => 5, :summat => 25)
+
+and instead of...
+
+  wotsit = Mocha.new
+  wotsit.stubs(:thingummy).returns(10)
+  wotsit.stubs(:summat).returns(25)
+
+you can have...
+
+  wotsit = stub(:thingummy => 5, :summat => 25)
+
+= 0.1.2
+
+* Minor tweaks
+
+= 0.1.1
+
+* Initial release.