hacked0ff-reverse_geocode 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 YOUR NAME
+
+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/README

@@ -0,0 +1,3 @@
+ReverseGeocode
+
+A small wrapper gem for Reverse Geocoding coordinated using the Google Maps API

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "reverse_geocode"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Your Name"
+EMAIL = "Your Email"
+HOMEPAGE = "http://example.com"
+SUMMARY = "A gem that provides..."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README Rakefile TODO) + 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::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/lib/reverse_geocode.rb

@@ -0,0 +1,92 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+class ReverseGeocode
+  class GeocodeError < StandardError
+    ERRORS = {
+      400 => "Bad Request",
+      500 => "Server Error",
+      601 => "Missing Query or Address",
+      602 => "Unknown Address",
+      603 => "Unavailable Address",
+      604 => "Unknown Directions",
+      610 => "Bad Key",
+      620 => "Too Many Queries"
+    }
+
+    def initialize(error_code)
+      super("#{error_code}: #{ERRORS[error_code]}")
+    end
+  end
+
+  class << self; attr_accessor :api_key; end
+
+  attr_reader :lat, :long
+  def initialize(lat, long)
+    raise ArgumentError, "Latitude and longitude required" unless lat && long
+    @lat, @long = lat, long
+  end
+
+  def response
+    @response ||= handle_response
+  end
+
+  def address
+    @address ||= first_placemark/'address'
+  end
+
+  def street
+    @street ||= first_administrative_area/'Thoroughfare'/'ThoroughfareName'
+  end
+
+  def state
+    @state ||= first_administrative_area/'AdministrativeAreaName'
+  end
+
+  def zip
+    @zip ||= first_administrative_area/'PostalCode'/'PostalCodeNumber'
+  end
+
+  def city
+    @city ||= placemark[1]/'AddressDetails'/'Country'/'AdministrativeArea'/'Locality'/'LocalityName'
+  end
+
+  def county
+    @county ||= (placemark[3]/'AddressDetails'/'Country'/'AdministrativeArea'/'AddressLine').first
+  end
+
+  private
+
+  def first_placemark
+    placemark[0]
+  end
+
+  def first_administrative_area
+    first_placemark/'AddressDetails'/'Country'/'AdministrativeArea'
+  end
+
+  def placemark
+    (response/"Placemark")
+  end
+
+  def reverse_geocode_uri
+    URI.parse("http://maps.google.com/maps/geo?ll=#{URI.escape(lat.to_s)},#{URI.escape(long.to_s)}&output=json")
+  end
+
+  def parse_json
+    body = Net::HTTP.get_response(reverse_geocode_uri).body
+    JSON.parse(body)
+  end
+
+  def handle_response
+    hash = parse_json
+    status_code = (hash/'Status'/'code').to_i
+    raise GeocodeError, status_code if status_code >= 400
+    return hash
+  end
+end
+
+class Hash
+  alias_method :/, :[]
+end

data/spec/reverse_geocode_spec.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "ReverseGeocode" do
+  before do
+    @attrs = {
+      :lat => 30.009897,
+      :long => -81.387655,
+      :address => "439-499 La Travesia Flora, FL 32095, USA",
+      :street => "439-499 La Travesia Flora",
+      :state => "FL",
+      :city => "St Augustine",
+      :zip => "32095",
+      :county => "St Johns"
+    }
+
+    @response = {"Status"=>{"code"=>200, "request"=>"geocode"},
+     "name"=>"30.009897,-81.387655",
+     "Placemark"=>
+      [{"AddressDetails"=>
+         {"Country"=>
+           {"AdministrativeArea"=>
+             {"Thoroughfare"=>{"ThoroughfareName"=>@attrs[:street]},
+              "PostalCode"=>{"PostalCodeNumber"=>@attrs[:zip]},
+              "AdministrativeAreaName"=>@attrs[:state]},
+            "CountryName"=>"USA",
+            "CountryNameCode"=>"US"},
+          "Accuracy"=>8},
+        "id"=>"p1",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-81.3845068,
+            "south"=>30.0067498,
+            "west"=>-81.390802,
+            "north"=>30.013045}},
+        "Point"=>{"coordinates"=>[-81.3876544, 30.0098974, 0]},
+        "address"=> @attrs[:address]},
+       {"AddressDetails"=>
+         {"Country"=>
+           {"AdministrativeArea"=>
+             {"Locality"=>
+               {"LocalityName"=>@attrs[:city],
+                "PostalCode"=>{"PostalCodeNumber"=>@attrs[:zip]}},
+              "AdministrativeAreaName"=>"FL"},
+            "CountryName"=>"USA",
+            "CountryNameCode"=>"US"},
+          "Accuracy"=>5},
+        "id"=>"p2",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-81.313069,
+            "south"=>29.929597,
+            "west"=>-81.498143,
+            "north"=>30.086469}},
+        "Point"=>{"coordinates"=>[-81.4059186, 29.9934528, 0]},
+        "address"=>"St Augustine, FL 32095, USA"},
+       {"AddressDetails"=>
+         {"Country"=>
+           {"AdministrativeArea"=>
+             {"AddressLine"=>["St Augustine"], "AdministrativeAreaName"=>"FL"},
+            "CountryName"=>"USA",
+            "CountryNameCode"=>"US"},
+          "Accuracy"=>4},
+        "id"=>"p3",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-81.194405,
+            "south"=>29.767845,
+            "west"=>-81.63343,
+            "north"=>30.18062}},
+        "Point"=>{"coordinates"=>[-81.3839326, 30.0149544, 0]},
+        "address"=>"St Augustine, Florida, USA"},
+       {"AddressDetails"=>
+         {"Country"=>
+           {"AdministrativeArea"=>
+             {"AddressLine"=>[@attrs[:county]], "AdministrativeAreaName"=>"FL"},
+            "CountryName"=>"USA",
+            "CountryNameCode"=>"US"},
+          "Accuracy"=>3},
+        "id"=>"p4",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-81.150818,
+            "south"=>29.622428,
+            "west"=>-81.69039,
+            "north"=>30.253036}},
+        "Point"=>{"coordinates"=>[-81.4278984, 29.9719419, 0]},
+        "address"=>"St Johns, Florida, USA"},
+       {"AddressDetails"=>
+         {"Country"=>
+           {"AdministrativeArea"=>{"AdministrativeAreaName"=>"FL"},
+            "CountryName"=>"USA",
+            "CountryNameCode"=>"US"},
+          "Accuracy"=>2},
+        "id"=>"p5",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-79.974307,
+            "south"=>24.396308,
+            "west"=>-87.634643,
+            "north"=>31.001056}},
+        "Point"=>{"coordinates"=>[-81.5157535, 27.6648274, 0]},
+        "address"=>"Florida, USA"},
+       {"AddressDetails"=>
+         {"Country"=>{"CountryName"=>"USA", "CountryNameCode"=>"US"},
+          "Accuracy"=>1},
+        "id"=>"p6",
+        "ExtendedData"=>
+         {"LatLonBox"=>
+           {"east"=>-65.168504,
+            "south"=>17.83151,
+            "west"=>172.347848,
+            "north"=>71.434357}},
+        "Point"=>{"coordinates"=>[-95.712891, 37.09024, 0]},
+        "address"=>"United States"}]}
+
+    Net::HTTP.stub!(:get_response)
+    @reverse_geocode = ReverseGeocode.new(@attrs[:lat], @attrs[:long])
+    @reverse_geocode.stub!(:parse_json).and_return(@response)
+  end
+
+  %w( lat long address street state city zip county ).each do |attr|
+    describe "##{attr}" do
+      it {@reverse_geocode.send(attr).should == @attrs[attr.to_sym]}
+    end
+  end
+
+  describe "without a latitude or longitude" do
+    it "should raise an ArgumentError" do
+      lambda { ReverseGeocode.new(nil, 1) }.should raise_error(ArgumentError)
+      lambda { ReverseGeocode.new(1, nil) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "when the response is a" do
+    def error_json(code)
+      {"Status"=>{"code"=>code, "request"=>"geocode"}, "name"=>""}
+    end
+
+    errors = {
+      400 => "Bad Request",
+      500 => "Server Error",
+      601 => "Missing Query or Address",
+      602 => "Unknown Address",
+      603 => "Unavailable Address",
+      604 => "Unknown Directions",
+      610 => "Bad Key",
+      620 => "Too Many Queries"
+    }
+
+    errors.each do |code, message|
+      describe code.to_s do
+        before do
+          @reverse_geocode.stub!(:parse_json).and_return(error_json(code))
+        end
+
+        it "should raise a GeocodeError" do
+          lambda {
+            @reverse_geocode.send(:handle_response)
+          }.should raise_error(ReverseGeocode::GeocodeError, "#{code}: #{message}")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'fake_web'
+
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'reverse_geocode'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: hacked0ff-reverse_geocode
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tommy Campbell & ReinH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: A gem that provides Reverse Geocoding using the Google Maps API
+email: tommycampbell@mindspring.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/reverse_geocode.rb
+- spec/reverse_geocode_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://example.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem that provides Reverse Geocoding using the Google Maps API
+test_files: []
+