google_geocoding 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rodrigo Kochenburger
+
+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.rdoc

@@ -0,0 +1,13 @@
+= GoogleGeocoding
+
+GoogleGeocoding is a small library for performing geocoding using the Google's HTTP geocoding API.
+
+== Usage Example
+
+  geo = GoogleGeocoding::Geocoder.new(:app_key => YOUR_API_KEY, :user_agent => YOUR_USER_AGENT)
+  res = geo.query("Union Square, San Francisco, CA")
+  res.placemarks # => [#<GoogleGeocoding::Placemark:0x100629598 @country_code="US", @country_name=["USA", "US"], @city="San Francisco", @accurracy=4, @coordinates=[-122.4074374, 37.7879938], @region="CA">]
+
+== Copyright
+
+Copyright (c) 2010 Rodrigo Kochenburger. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "google_geocoding"
+    gem.summary     = %Q{Google's geocoding library}
+    gem.description = %Q{GoogleGeocoding is a small library for performing geocoding using the Google's HTTP geocoding API}
+    gem.email       = "divoxx@gmail.com"
+    gem.homepage    = "http://github.com/divoxx/google_geocoding"
+    gem.authors     = ["Rodrigo Kochenburger"]
+    gem.add_dependency "json", ">= 1.2.0"
+    gem.add_dependency "patron", ">= 0.4.5"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard",  ">= 0.5.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/google_geocoding.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{google_geocoding}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rodrigo Kochenburger"]
+  s.date = %q{2010-02-24}
+  s.description = %q{GoogleGeocoding is a small library for performing geocoding using the Google's HTTP geocoding API}
+  s.email = %q{divoxx@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "google_geocoding.gemspec",
+     "lib/google_geocoding.rb",
+     "lib/google_geocoding/errors.rb",
+     "lib/google_geocoding/geocoder.rb",
+     "lib/google_geocoding/placemark.rb",
+     "lib/google_geocoding/response.rb",
+     "spec/google_geocoding_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/divoxx/google_geocoding}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Google's geocoding library}
+  s.test_files = [
+    "spec/google_geocoding_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<patron>, [">= 0.4.5"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<json>, [">= 1.2.0"])
+      s.add_dependency(%q<patron>, [">= 0.4.5"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.2.0"])
+    s.add_dependency(%q<patron>, [">= 0.4.5"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0.5.3"])
+  end
+end
+

data/lib/google_geocoding/errors.rb

@@ -0,0 +1,76 @@
+module GoogleGeocoding
+  module Errors
+    # Base error for the geocoding service, all error should inherit from this one.
+    class BaseError < StandardError; end
+    
+    # Http error, will be raised when the server returns with a status code outside the 200...300 range.
+    class HttpError < BaseError
+      def initialize(address, response)
+        @address  = address
+        @response = response
+        super "Could not geocode '#{@address}'. Server responded with #{@response.status}"
+      end
+    end
+          
+    # Services error means the service was reached but returned a unsuccessful response.
+    class ServiceError < BaseError; end
+    
+    # 500 G_GEO_SERVER_ERROR
+    class ServerError < ServiceError
+      def initialize
+        super("A geocoding or directions request could not be successfully processed, yet the exact reason for the failure is unknown.")
+      end
+    end
+    
+    # 601 G_GEO_MISSING_QUERY
+    class MissingQueryError < ServiceError
+      def initialize
+        super("An empty address was specified")
+      end
+    end
+
+    # 602 G_GEO_UNKNOWN_ADDRESS
+    class UnknownAddressError < ServiceError
+      def initialize
+        super("No corresponding geographic location could be found for the specified address, possibly because the address is relatively new, or because it may be incorrect.")
+      end
+    end
+    
+    # 603 G_GEO_UNAVAILABLE_ADDRESS
+    class UnavailableAddressError < ServiceError
+      def initialize
+        super("The geocode for the given address or the route for the given directions query cannot be returned due to legal or contractual reasons.")
+      end
+    end
+    
+    # 610 G_GEO_BAD_KEY
+    class BadKeyError < ServiceError
+      def initialize
+        super("The given key is either invalid or does not match the domain for which it was given.")
+      end
+    end
+    
+    # 620 G_GEO_TOO_MANY_QUERIES
+    class TooManyQueriesError < ServiceError
+      def initialize
+        super("The given key has gone over the requests limit in the 24 hour period or has submitted too many requests in too short a period of time. If you're sending multiple requests in parallel or in a tight loop, use a timer or pause in your code to make sure you don't send the requests too quickly.")
+      end
+    end
+    
+    # Extend ServiceError to include factory method based on status codes.
+    class ServiceError
+      ERRORS_MAPPING = {
+        500 => ServerError,
+        601 => MissingQueryError,
+        602 => UnknownAddressError,
+        603 => UnknownAddressError,
+        610 => BadKeyError,
+        620 => TooManyQueriesError
+      }
+      
+      def self.build(status)
+        ERRORS_MAPPING[status].new
+      end
+    end
+  end
+end

data/lib/google_geocoding/geocoder.rb

@@ -0,0 +1,29 @@
+module GoogleGeocoding    
+  class Geocoder
+    # Creates a new geocoder instance.
+    # @see Geocoder#geocode
+    def initialize(options = {})
+      @options = options
+      @sess = Patron::Session.new
+      @sess.timeout = 5
+      @sess.base_url = "http://maps.google.com/maps/geo"
+      @sess.headers['User-Agent'] = options[:user_agent]
+    end
+
+    # Performs a geocoding request against google for the given address.
+    #
+    # @param [String, #to_s]
+    # @return [Response]
+    def query(address)
+      params = "?q=#{URI.encode(address.to_s)}"
+      params << "&key=#{@options[:api_key]}" if @options[:api_key]
+      resp = @sess.get(params)
+  
+      if (200...300).include?(resp.status)
+        Response.new(resp.body)
+      else
+        raise GeocodeError.new(address, resp)
+      end
+    end
+  end
+end

data/lib/google_geocoding/placemark.rb

@@ -0,0 +1,30 @@
+module GoogleGeocoding
+  # Model that represents a placemark returned by the geocoding service.
+  class Placemark
+    # The level of accurracy for the placemark
+    # @see http://code.google.com/apis/maps/documentation/geocoding/index.html#GeocodingAccuracy
+    attr_accessor :accurracy
+    
+    # The country name
+    attr_accessor :country_name
+    
+    # The country ISO code
+    # @see http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm
+    attr_accessor :country_code
+    
+    # The region/province/state
+    attr_accessor :region
+    
+    # The city name
+    attr_accessor :city
+    
+    # The postal/zip code
+    attr_accessor :postal_code
+    
+    # The street address, including the number
+    attr_accessor :street
+    
+    # An array with two positions: latitude and longitude
+    attr_accessor :coordinates
+  end
+end

data/lib/google_geocoding/response.rb

@@ -0,0 +1,76 @@
+module GoogleGeocoding
+  class Response
+    # Creates a new response object from the given response body, expects to be a JSON string.
+    #
+    # @param [String]
+    def initialize(resp_body)
+      @data = JSON.parse(resp_body)
+    end
+    
+    # Return the status code included in the server response.
+    #
+    # @return [Integer] 
+    # @see http://code.google.com/apis/maps/documentation/geocoding/index.html#StatusCodes
+    def status_code
+      Integer(@data["Status"]["code"])
+    end
+    
+    # Return whether response successfully resolved the geolocation
+    def success?
+      status_code == 200
+    end
+    
+    # Return whether response failed to resolved the geolocation
+    def failure?
+      !success?
+    end
+    
+    # Return the placemarks included in the response.
+    #
+    # @return [Array<Placemark>]
+    def placemarks
+      if failure?
+        raise Errors::ServiceError.build(status_code)
+      else
+        @data["Placemark"].map do |placemark_data|
+          details               = placemark_data["AddressDetails"]
+          coordinates           = placemark_data["Point"]["coordinates"][0,2]
+          accurracy             = Integer(details["Accuracy"])
+          placemark             = Placemark.new
+          placemark.accurracy   = accurracy
+          placemark.coordinates = coordinates
+
+          if accurracy >= 1
+            country = details["Country"]
+            placemark.country_name = country["CountryName"],
+            placemark.country_code = country["CountryNameCode"]
+            
+            if accurracy >= 2
+              admarea = country["AdministrativeArea"]
+              placemark.region = admarea["AdministrativeAreaName"]
+              
+              if accurracy >= 3
+                subadmarea = admarea["SubAdministrativeArea"]
+                
+                if accurracy >= 4
+                  locality = subadmarea ? subadmarea["Locality"] : admarea["Locality"]
+                  placemark.city = locality["LocalityName"]
+                  
+                  if accurracy >= 5
+                    placemark.postal_code = locality["PostalCode"]["PostalCodeNumber"]
+                  end
+                  
+                  if accurracy >= 6
+                    placemark.street = locality["Thoroughfare"]["ThoroughfareName"]
+                  end
+                end
+              end
+            end
+          end
+          
+          placemark
+        end
+      end
+    end
+  end
+end

data/lib/google_geocoding.rb

@@ -0,0 +1,6 @@
+require 'json'
+require 'patron'
+require 'google_geocoding/errors'
+require 'google_geocoding/placemark'
+require 'google_geocoding/response'
+require 'google_geocoding/geocoder'

data/spec/google_geocoding_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "GoogleGeocoding" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'google_geocoding'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: google_geocoding
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rodrigo Kochenburger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 -08: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.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: patron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+description: GoogleGeocoding is a small library for performing geocoding using the Google's HTTP geocoding API
+email: divoxx@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- google_geocoding.gemspec
+- lib/google_geocoding.rb
+- lib/google_geocoding/errors.rb
+- lib/google_geocoding/geocoder.rb
+- lib/google_geocoding/placemark.rb
+- lib/google_geocoding/response.rb
+- spec/google_geocoding_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/divoxx/google_geocoding
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Google's geocoding library
+test_files: 
+- spec/google_geocoding_spec.rb
+- spec/spec_helper.rb