hacked0ff-reverse_geocode 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 YOUR NAME
+Copyright (c) 2009 PRIMEDIA
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -3,13 +3,13 @@ require 'rake/gempackagetask'
 require 'rubygems/specification'
 require 'date'
 require 'spec/rake/spectask'
+require 'rake/rdoctask'
 
 GEM = "reverse_geocode"
-GEM_VERSION = "0.0.1"
-AUTHOR = "Your Name"
-EMAIL = "Your Email"
-HOMEPAGE = "http://example.com"
-SUMMARY = "A gem that provides..."
+GEM_VERSION = "0.0.3"
+AUTHORS = ["Tommy Campbell", "Rein Henrichs"]
+EMAIL = "tommycampbell@mindspring.com"
+SUMMARY = "A gem that provides Reverse Geocoding using the Google Maps API"
 
 spec = Gem::Specification.new do |s|
   s.name = GEM
@@ -19,26 +19,27 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
   s.summary = SUMMARY
   s.description = s.summary
-  s.author = AUTHOR
+  s.authors = AUTHORS
   s.email = EMAIL
-  s.homepage = HOMEPAGE
-  
-  # Uncomment this to add a dependency
-  # s.add_dependency "foo"
-  
+
+  s.add_dependency('json', '>= 1.1.3')
+
   s.require_path = 'lib'
   s.autorequire = GEM
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
 
 task :default => :spec
 
-desc "Run specs"
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
   t.spec_opts = %w(-fs --color)
 end
 
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include('lib/*.rb')
+}
 
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
@@ -54,4 +55,4 @@ task :make_spec do
   File.open("#{GEM}.gemspec", "w") do |file|
     file.puts spec.to_ruby
   end
-end
+end

data/lib/reverse_geocode.rb

@@ -2,9 +2,15 @@ require 'net/http'
 require 'uri'
 require 'json'
 
+# ReverseGeocode provides an simple API for accessing reverse geocode data for
+# a given geocode using the google maps geocoding API.
+#
+# Examples:
+#   ReverseGeocode.new(30.0098974, -81.3876544).city # => "St Augustine"
 class ReverseGeocode
   GOOGLE_URI = "http://maps.google.com/maps/geo"
 
+  # Used to raise Google API errors
   class GeocodeError < StandardError
     ERRORS = {
       400 => "Bad Request",
@@ -24,12 +30,14 @@ class ReverseGeocode
 
   class << self; attr_accessor :api_key; end
 
-  attr_reader :lat, :long
+  # Creates a new reverse geocode object.
   def initialize(lat, long)
     raise ArgumentError, "Latitude and longitude required" unless lat && long
     @lat, @long = lat, long
   end
+  attr_reader :lat, :long
 
+  # The raw response hash from the reverse geocode request
   def response
     @response ||= handle_response
   end
@@ -93,11 +101,14 @@ class ReverseGeocode
   end
 end
 
+# Hash.[] is aliased to '/' to provide xpath-like access into the response
+# hash
 class Hash
   alias_method :/, :[]
 end
 
 class NilClass
+  # Raises a more useful error when nil#/ is called.
   def /(other)
     raise ArgumentError, "Unknown method '/' called on nil with #{other.inspect}. Maybe you were looking for a Hash?"
   end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: hacked0ff-reverse_geocode
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
-- Tommy Campbell & ReinH
-autorequire: 
+- Tommy Campbell
+- Rein Henrichs
+autorequire: reverse_geocode
 bindir: bin
 cert_chain: []
 
@@ -36,12 +37,12 @@ files:
 - LICENSE
 - README
 - Rakefile
-- TODO
 - lib/reverse_geocode.rb
 - spec/reverse_geocode_spec.rb
 - spec/spec_helper.rb
+- TODO
 has_rdoc: true
-homepage: http://example.com
+homepage: 
 post_install_message: 
 rdoc_options: []