google-v3-geocoder 1.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem "geokit", ">=1.5.0"
+gem "json"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end
+
+group :test do
+  gem "mocha", ">=0.9.9", :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    geokit (1.5.0)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mocha (0.9.10)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  geokit (>= 1.5.0)
+  jeweler (~> 1.5.2)
+  json
+  mocha (>= 0.9.9)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew La Motte-Mitchell
+
+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 @@
+update

data/README.rdoc

@@ -0,0 +1,19 @@
+= google-v3-geocoder
+
+Description goes here.
+
+== Contributing to google-v3-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 Andrew La Motte-Mitchell. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+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-v3-geocoder"
+  gem.homepage = "http://github.com/startupseven/google-v3-geocoder"
+  gem.license = "MIT"
+  gem.summary = %Q{Geokit::Geocoder subclass for interacting with Google's v3 API}
+  gem.description = %Q{Geokit::Geocoder subclass for interacting with Google's v3 API <http://code.google.com/apis/maps/documentation/geocoding/>}
+  gem.email = "developers@tello.com"
+  gem.authors = ["Andrew La Motte-Mitchell", "Tyler Wolf"]
+  gem.add_runtime_dependency "geokit", ">=1.5.0"
+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
+
+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-v3-geocoder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/google-v3-geocoder.rb

@@ -0,0 +1 @@
+require 'google_v3_geocoder'

data/lib/google_v3_geocoder.rb

@@ -0,0 +1 @@
+require 'google_v3_geocoder/geocoders'

data/lib/google_v3_geocoder/geocoders.rb

@@ -0,0 +1,125 @@
+require 'geokit'
+require 'geokit/geocoders.rb'
+require 'json'
+
+module Geokit
+  module Geocoders
+    class GoogleV3Geocoder < Geocoder
+      private
+
+      def self.do_geocode(address, options = {})
+        geo_url = self.get_url(address, options)
+        logger.debug "Making Geocode request to:  #{geo_url}"
+        res = self.call_geocoder_service(geo_url)
+
+        return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
+        json = res.body
+        logger.debug "Google V3 geocoding. Address: #{address}. Result: #{json}"
+        return self.convert_json_to_geoloc(json)
+      end
+
+      def self.get_url(address, options={})
+        bias = options[:bias] || ''
+        address_str = address.is_a?(GeoLoc) ? address.to_geocodeable_s : address
+        return "http://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=#{Geokit::Inflector::url_escape(address_str)}&region=#{bias.to_s.downcase}"
+      end
+
+      def self.convert_json_to_geoloc(json)
+        begin
+          data = JSON.parse(json)
+        rescue
+          logger.error "Could not parse JSON from Google: #{json}"
+          return GeoLoc.new
+        end
+    
+        if data['status'] != "OK"
+          if data['status' ] == 'OVER_QUERY_LIMIT'
+            raise Geokit::TooManyQueriesError "Google returned OVER_QUERY_LIMIT: #{json}"
+          elsif data['status'] == 'ZERO_RESULTS'
+            logger.info "Found no results from google v3"
+            return GeoLoc.new
+          end
+          logger.error "Got an error from google, response: #{json}"
+          # Otherwise, we don't know what to do
+          return GeoLoc.new
+        end
+
+        begin
+          results = data['results']
+          geoloc = nil
+          results.each do |result|
+            extracted_geoloc = self.extract_location(result)
+            if geoloc.nil?
+              geoloc = extracted_geoloc
+            else
+              geoloc.all.push(extracted_geoloc)
+            end
+          end
+        rescue Exception => e
+          logger.error "Encountered unexpected exception during google geocoding: #{e.inspect}"
+          return GeoLoc.new
+        end
+
+        return geoloc
+      end
+  
+      def self.extract_location(result)
+        res = GeoLoc.new
+        res.provider = 'google_v3'
+    
+        res.lat = result['geometry']['location']['lat']
+        res.lng = result['geometry']['location']['lng']
+
+        res.full_address = result['formatted_address']
+
+        street_number = nil
+        street_name = nil
+
+        result['address_components'].each do |component|
+          types = component['types']
+
+          if types.include?('street_number')
+            street_number = component['long_name']
+          end
+
+          if types.include?('route')
+            street_name = component['long_name']
+          end
+
+          if types.include?('country')
+            res.country = component['short_name']
+            res.country_code = component['short_name']
+          end
+
+          if types.include?('administrative_area_level_1')
+            res.state = component['short_name']
+          end
+
+          if types.include?('postal_code')
+            res.zip = component['long_name']
+          end
+
+          if types.include?('locality')
+            res.city = component['long_name']
+          end
+
+          if types.include?('locality')
+            res.zip = component['long_name']
+          end
+      
+        end
+        res.street_address = [street_number, street_name].reject{|x| x.nil?}.join(" ")
+
+        # Set the bounds from the viewport
+        bounds = result['geometry']['viewport']
+        res.suggested_bounds = Bounds.normalize(
+          [bounds['southwest']['lat'], bounds['southwest']['lng']],
+          [bounds['northeast']['lat'], bounds['northeast']['lng']]
+        )
+
+        res.success = true
+        return res
+      end
+    end
+  end
+end

data/test/google_v3_geocoder_test.rb

@@ -0,0 +1,278 @@
+require 'test_helper'
+
+class GoogleV3GeocoderTest < Test::Unit::TestCase
+  include Geokit
+  
+  GOOD_JSON = <<-JSON
+{
+  "status": "OK",
+  "results": [ {
+    "types": [ "street_address" ],
+    "formatted_address": "1288 E Hillsdale Blvd, Foster City, CA 94404, USA",
+    "address_components": [ {
+      "long_name": "1288",
+      "short_name": "1288",
+      "types": [ "street_number" ]
+    }, {
+      "long_name": "E Hillsdale Blvd",
+      "short_name": "E Hillsdale Blvd",
+      "types": [ "route" ]
+    }, {
+      "long_name": "Foster City",
+      "short_name": "Foster City",
+      "types": [ "locality", "political" ]
+    }, {
+      "long_name": "San Mateo",
+      "short_name": "San Mateo",
+      "types": [ "administrative_area_level_3", "political" ]
+    }, {
+      "long_name": "San Mateo",
+      "short_name": "San Mateo",
+      "types": [ "administrative_area_level_2", "political" ]
+    }, {
+      "long_name": "California",
+      "short_name": "CA",
+      "types": [ "administrative_area_level_1", "political" ]
+    }, {
+      "long_name": "United States",
+      "short_name": "US",
+      "types": [ "country", "political" ]
+    }, {
+      "long_name": "94404",
+      "short_name": "94404",
+      "types": [ "postal_code" ]
+    } ],
+    "geometry": {
+      "location": {
+        "lat": 37.5684570,
+        "lng": -122.2660670
+      },
+      "location_type": "ROOFTOP",
+      "viewport": {
+        "southwest": {
+          "lat": 37.5653094,
+          "lng": -122.2692146
+        },
+        "northeast": {
+          "lat": 37.5716046,
+          "lng": -122.2629194
+        }
+      }
+    }
+  } ]
+}
+  JSON
+
+  def test_get_url_adds_bias_if_set
+    bias = 'thefreakingus'
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :get_url, 'address', :bias => bias
+    assert_match /&region=#{bias}/, result
+  end
+
+  def test_get_url_escapes_address
+    address = '123 hotel street'
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :get_url, address
+    assert_match /&address=#{Regexp.escape(Geokit::Inflector::url_escape(address))}/, result
+  end
+  
+  def test_convert_json_to_geoloc_extracts_result_from_json
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :convert_json_to_geoloc, GOOD_JSON
+    assert result.success
+    assert_equal 1, result.all.size
+    assert_equal '1288 E Hillsdale Blvd, Foster City, CA 94404, USA', result.full_address
+  end
+
+  def test_convert_json_to_geoloc_handles_empty_result_set
+    empty_json = '{"status": "ZERO_RESULTS","results": [ ]}'
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :convert_json_to_geoloc, empty_json
+    assert !result.success
+    assert_equal 1, result.all.size
+    assert_nil result.lat
+    assert_nil result.lng
+  end
+
+  def test_convert_json_to_geoloc_calls_extract_location
+    expected_geoloc = GeoLoc.new
+    expected_geoloc.city = "SOME City"
+    Geokit::Geocoders::GoogleV3Geocoder.expects(:extract_location).returns expected_geoloc
+
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :convert_json_to_geoloc, GOOD_JSON
+    assert_equal result, expected_geoloc
+  end
+
+  def test_convert_json_to_handles_multiple_results
+    address1 = 'add1'
+    address2 = 'add2'
+    
+    input_data = {
+      "status" => "OK",
+      "results" =>
+        [
+        {
+          "types" => [ "street_address" ],
+          "formatted_address" => address1,
+          "address_components" => [],
+          "geometry" => {
+            "location"=> {
+              "lat"=>  35.58032,
+              "lng"=> -122.2660670
+            },
+            "location_type"=> "ROOFTOP",
+            "viewport"=> {
+              "southwest"=> {
+                "lat"=> 37.5653094,
+                "lng"=> -122.2692146,
+              },
+              "northeast"=> {
+                "lat"=> 37.5716046,
+                "lng"=> -122.2629194
+              }
+            },
+          },
+        },
+        {
+          "types" => [ "street_address" ],
+          "formatted_address" => address2,
+          "address_components" => [],
+          "geometry" => {
+            "location"=> {
+              "lat"=>  35.58032,
+              "lng"=> -122.2660670
+            },
+            "location_type"=> "ROOFTOP",
+            "viewport"=> {
+              "southwest"=> {
+                "lat"=> 37.5653094,
+                "lng"=> -122.2692146,
+              },
+              "northeast"=> {
+                "lat"=> 37.5716046,
+                "lng"=> -122.2629194
+              }
+            },
+          },
+        }
+      ]
+    }
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :convert_json_to_geoloc, input_data.to_json
+    assert result.success
+    assert_equal 2, result.all.size
+    assert_equal address1, result.all[0].full_address
+    assert_equal address2, result.all[1].full_address
+  end
+
+  def test_extract_location_extracts_result_from_json
+    data = JSON.parse(GOOD_JSON)['results'][0]
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :extract_location, data
+    assert_equal 'Foster City', result.city
+    assert_equal 'CA', result.state
+    assert_equal '94404', result.zip
+    assert_equal 'US', result.country
+    assert_equal 'US', result.country_code
+    assert_equal '1288 E Hillsdale Blvd', result.street_address
+    assert_equal '1288 E Hillsdale Blvd, Foster City, CA 94404, USA', result.full_address
+    assert_equal 37.5653094, result.suggested_bounds.sw.lat
+    assert_equal -122.2692146, result.suggested_bounds.sw.lng
+    assert_equal 37.5716046, result.suggested_bounds.ne.lat
+    assert_equal -122.2629194, result.suggested_bounds.ne.lng
+  end
+
+  def test_extract_joins_street_address_with_no_number
+    route_name = 'Foo'
+    data =
+      {
+      "types" => [ "street_address" ],
+      "formatted_address" => 'address1',
+      "address_components" => [
+        {'types' => ['route'], 'long_name' => route_name, 'short_name' => route_name}
+      ],
+      "geometry" => {
+        "location"=> {
+          "lat"=>  35.58032,
+          "lng"=> -122.2660670
+        },
+        "location_type"=> "ROOFTOP",
+        "viewport"=> {
+          "southwest"=> {
+            "lat"=> 37.5653094,
+            "lng"=> -122.2692146,
+          },
+          "northeast"=> {
+            "lat"=> 37.5716046,
+            "lng"=> -122.2629194
+          }
+        },
+      },
+    }
+    
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :extract_location, data
+    assert_equal route_name, result.street_address
+  end
+
+  def test_extract_joins_street_address_with_no_route
+    number = '358'
+    data =
+      {
+      "types" => [ "street_address" ],
+      "formatted_address" => 'address1',
+      "address_components" => [
+        {'types' => ['street_number'], 'long_name' => number, 'short_name' => number},
+      ],
+      "geometry" => {
+        "location"=> {
+          "lat"=>  35.58032,
+          "lng"=> -122.2660670
+        },
+        "location_type"=> "ROOFTOP",
+        "viewport"=> {
+          "southwest"=> {
+            "lat"=> 37.5653094,
+            "lng"=> -122.2692146,
+          },
+          "northeast"=> {
+            "lat"=> 37.5716046,
+            "lng"=> -122.2629194
+          }
+        },
+      },
+    }
+
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :extract_location, data
+    assert_equal number, result.street_address
+  end
+
+  def test_extract_joins_street_address_with_number_and_route
+    route_name = 'Foo'
+    number = '3854'
+    data =
+      {
+      "types" => [ "street_address" ],
+      "formatted_address" => 'address1',
+      "address_components" => [
+        {'types' => ['route'], 'long_name' => route_name, 'short_name' => route_name},
+        {'types' => ['street_number'], 'long_name' => number, 'short_name' => number}
+      ],
+      "geometry" => {
+        "location"=> {
+          "lat"=>  35.58032,
+          "lng"=> -122.2660670
+        },
+        "location_type"=> "ROOFTOP",
+        "viewport"=> {
+          "southwest"=> {
+            "lat"=> 37.5653094,
+            "lng"=> -122.2692146,
+          },
+          "northeast"=> {
+            "lat"=> 37.5716046,
+            "lng"=> -122.2629194
+          }
+        },
+      },
+    }
+
+    result = Geokit::Geocoders::GoogleV3Geocoder.send :extract_location, data
+    assert_equal number + ' ' + route_name, result.street_address
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'google-v3-geocoder'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: google-v3-geocoder
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew La Motte-Mitchell
+- Tyler Wolf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: geokit
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: geokit
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  requirement: *id005
+description: Geokit::Geocoder subclass for interacting with Google's v3 API <http://code.google.com/apis/maps/documentation/geocoding/>
+email: developers@tello.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/google-v3-geocoder.rb
+- lib/google_v3_geocoder.rb
+- lib/google_v3_geocoder/geocoders.rb
+- test/.google_v3_geocoder_test.rb.swp
+- test/.helper.rb.swp
+- test/google_v3_geocoder_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/startupseven/google-v3-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.3.7
+signing_key: 
+specification_version: 3
+summary: Geokit::Geocoder subclass for interacting with Google's v3 API
+test_files: 
+- test/google_v3_geocoder_test.rb
+- test/test_helper.rb