google_maps_geocoder 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'activesupport'
+  gem 'jeweler'
+  gem 'rack'
+  gem 'rcov'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Roderick Monje
+
+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,47 @@
+= google_maps_geocoder
+
+A simple PORO wrapper for geocoding with Google Maps.
+
+chez_barack = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+
+chez_barack.formatted_address
+ => "1600 Pennsylvania Ave NW, Washington D.C., DC 20500, USA"
+
+chez_barack.city
+ => "Washington D.C."
+
+chez_barack.state_long_name
+ => "District of Columbia"
+
+chez_barack.state_short_name
+ => "DC"
+
+The complete, hopefully self-explanatory, API is:
+
+city
+country_long_name
+country_short_name
+county
+exact_match?
+formatted_address
+formatted_street_address
+lat
+lng
+partial_match?
+postal_code
+state_long_name
+state_short_name
+
+== Contributing to google_maps_geocoder
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Roderick Monje. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "google_maps_geocoder"
+  gem.homepage = "http://github.com/ivanoblomov/google_maps_geocoder"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple PORO wrapper for geocoding with Google Maps.}
+  gem.description = %Q{Geocode a location without worrying about parsing Google Maps' response. GoogleMapsGeocoder wraps it in a plain-old Ruby object.}
+  gem.email = "rod@seologic.com"
+  gem.authors = ["Roderick Monje"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google_maps_geocoder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/google_maps_geocoder.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{google_maps_geocoder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roderick Monje"]
+  s.date = %q{2011-04-13}
+  s.description = %q{Geocode with Google Maps without worrying about JSON.}
+  s.email = %q{rod@seologic.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "google_maps_geocoder.gemspec",
+    "lib/google_maps_geocoder.rb",
+    "spec/lib/google_maps_geocoder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ivanoblomov/google_maps_geocoder}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Simple PORO wrapper for a Google-Maps geocoding call.}
+  s.test_files = [
+    "spec/lib/google_maps_geocoder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/google_maps_geocoder.rb

@@ -0,0 +1,112 @@
+require 'active_support'
+require 'logger'
+require 'net/http'
+require 'rack'
+
+class GoogleMapsGeocoder
+  # Returns the complete formatted address with standardized abbreviations.
+  attr_reader :formatted_address
+  # Returns the formatted street address with standardized abbreviations.
+  attr_reader :formatted_street_address
+  # Self-explanatory
+  attr_reader :city, :country_long_name, :country_short_name, :county, :lat, :lng, :postal_code, :state_long_name, :state_short_name
+
+  # Instance Methods: Overrides ====================================================================
+
+  # Geocodes the specified address and wraps the results in a geocoder object.
+  #
+  # ==== Attributes
+  #
+  # * +address+ - a geocodable address
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+  #    white_house.formatted_address
+  #     => "1600 Pennsylvania Ave NW, Washington D.C., DC 20500, USA"
+  def initialize(address)
+    response = Net::HTTP.get_response(URI.parse("http://maps.googleapis.com/maps/api/geocode/json?address=#{Rack::Utils.escape(address)}&sensor=false"))
+    @json = ActiveSupport::JSON.decode(response.body)
+    raise "Geocoding \"#{address}\" exceeded query limit! Google returned...\n#{@json.inspect}" if @json.blank? || @json['status'] != 'OK'
+
+    logger = Logger.new(STDERR)
+    logger.info('GoogleMapsGeocoder') { "Geocoded \"#{address}\" and Google returned...\n#{@json.inspect}" }
+
+    @city, @country_short_name, @country_long_name, @county, @formatted_address, @formatted_street_address, @lat, @lng, @postal_code, @state_long_name, @state_short_name = parse_city, parse_country_short_name, parse_country_long_name, parse_county, parse_formatted_address, parse_formatted_street_address, parse_lat, parse_lng, parse_postal_code, parse_state_long_name, parse_state_short_name
+  end
+
+  # Instance Methods ===============================================================================
+
+  # Returns true if the address Google returns is an exact match.
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Ave')
+  #    white_house.exact_match?
+  #     => true
+  def exact_match?
+    ! self.partial_match?
+  end
+
+  # Returns true if the address Google returns isn't an exact match.
+  #
+  # ==== Examples
+  #
+  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+  #    white_house.exact_match?
+  #     => false
+  def partial_match?
+    @json['results'][0]['partial_match'] == true
+  end
+
+  private
+
+  def parse_address_component_type(type, name='long_name')
+    _address_component = @json['results'][0]['address_components'].detect{ |ac| ac['types'] && ac['types'].include?(type) }
+    _address_component && _address_component[name]
+  end
+
+  def parse_city
+    parse_address_component_type('sublocality') || parse_address_component_type('locality')
+  end
+
+  def parse_country_long_name
+    parse_address_component_type('country')
+  end
+
+  def parse_country_short_name
+    parse_address_component_type('country', 'short_name')
+  end
+
+  def parse_county
+    parse_address_component_type('administrative_area_level_2')
+  end
+
+  def parse_formatted_address
+    @json['results'][0]['formatted_address']
+  end
+
+  def parse_formatted_street_address
+    "#{parse_address_component_type('street_number')} #{parse_address_component_type('route')}"
+  end
+
+  def parse_lat
+    @json['results'][0]['geometry']['location']['lat']
+  end
+
+  def parse_lng
+    @json['results'][0]['geometry']['location']['lng']
+ end
+
+  def parse_postal_code
+    parse_address_component_type('postal_code')
+  end
+
+  def parse_state_long_name
+    parse_address_component_type('administrative_area_level_1')
+  end
+
+  def parse_state_short_name
+    parse_address_component_type('administrative_area_level_1', 'short_name')
+  end
+end

data/spec/lib/google_maps_geocoder_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe GoogleMapsGeocoder do
+  before(:all) do
+    begin
+      @exact_match = GoogleMapsGeocoder.new('837 Union St Brooklyn NY')
+      @partial_match = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
+    rescue SocketError
+      @no_network = true
+    rescue RuntimeError
+      @query_limit = true
+    end
+  end
+
+  before(:each) do
+    pending 'waiting for a network connection', :if => @no_network
+    pending 'waiting for query limit to pass', :if => @query_limit
+  end
+
+  context 'with "837 Union St Brooklyn NY"' do
+    subject { @exact_match }
+    specify { should be_exact_match }
+
+    context 'address' do
+      specify { subject.formatted_street_address.should == '837 Union St' }
+      specify { subject.city.should == 'Brooklyn' }
+      specify { subject.county.should == 'Kings' }
+      specify { subject.state_long_name.should == 'New York' }
+      specify { subject.state_short_name.should == 'NY' }
+      specify { subject.postal_code.should == '11215' }
+      specify { subject.country_short_name.should == 'US' }
+      specify { subject.country_long_name.should == 'United States' }
+      specify { subject.formatted_address.should == '837 Union St, Brooklyn, NY 11215, USA' }
+    end
+
+    context 'coordinates' do
+      specify { subject.lat.should be_within(0.005).of(40.6748151) }
+      specify { subject.lng.should be_within(0.005).of(-73.9760302) }
+    end
+  end
+
+  context 'with "1600 Pennsylvania Washington"' do
+    subject { @partial_match }
+    specify { should be_partial_match }
+
+    context 'address' do
+      specify { subject.formatted_street_address.should == '1600 Pennsylvania Ave NW' }
+      specify { subject.city.should == 'Washington D.C.' }
+      specify { subject.state_long_name.should == 'District of Columbia' }
+      specify { subject.state_short_name.should == 'DC' }
+      specify { subject.postal_code.should == '20500' }
+      specify { subject.country_short_name.should == 'US' }
+      specify { subject.country_long_name.should == 'United States' }
+      specify { subject.formatted_address.should == '1600 Pennsylvania Ave NW, Washington D.C., DC 20500, USA' }
+   end
+
+   context 'coordinates' do
+      specify { subject.lat.should be_within(0.005).of(38.8976964) }
+      specify { subject.lng.should be_within(0.005).of(-77.0365191) }
+   end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'google_maps_geocoder'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: google_maps_geocoder
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Roderick Monje
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Geocode with Google Maps without worrying about JSON.
+email: rod@seologic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- google_maps_geocoder.gemspec
+- lib/google_maps_geocoder.rb
+- spec/lib/google_maps_geocoder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ivanoblomov/google_maps_geocoder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Simple PORO wrapper for a Google-Maps geocoding call.
+test_files: 
+- spec/lib/google_maps_geocoder_spec.rb
+- spec/spec_helper.rb