simple_geocoder 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,17 +1,31 @@
 = simple_geocoder
 
-Simple interface to the Google Geocoding Service API V3 http://code.google.com/apis/maps/documentation/geocoding/
+Simple Ruby interface to the Google Geocoding Service API V3 http://code.google.com/apis/maps/documentation/geocoding/
 
-* API configuration in config/api.yml
 * returns results in parsed JSON format
+* API configuration in config/api.yml
 
 == Examples
+  require 'rubygems'
   require 'simple_geocoder'
   result = SimpleGeocoder::Geocoder.new.geocode('2000 28th St, Boulder, CO')
-  puts result['results'][0]['geometry']['location'] # => {"lat"=> 40.0185510,"lng"=> -105.2582644}
+  puts result['results'][0]['geometry']['location'].inspect # => {"lat"=> 40.0185510,"lng"=> -105.2582644}
+  
+Accepts optional parameters as a hash, keyed by parameter name symbols.
+Optional parameters include: bounds, region, language, sensor.
+Default *region* is 'us'.
+Default *sensor* value is 'false'
+  
+Example for region parameter:
+  result =  SimpleGeocoder::Geocoder.new.geocode("Toledo",{:region=>'es'})
+returns location for Toledo, Spain.
+  
+Example for bounds (viewport biasing):
+  result =  SimpleGeocoder::Geocoder.new.geocode("Winnetka", { :bounds => "34.172684,-118.604794|34.236144,-118.500938" } )
+Returns location for Winnetka in California instead of Illinois.
 
 == Requirements
 * JSON http://flori.github.com/json/doc/index.html
 
 == Copyright
-Copyright (c) 2010 Ying Tsen Hong. See LICENSE for details
+Copyright (c) 2010, 2011, 2012 Ying Tsen Hong. See LICENSE for details

data/lib/simple_geocoder/geocoder.rb

@@ -16,15 +16,15 @@ module SimpleGeocoder
     end
 
     # swallow exceptions and return nil on error
-    def geocode(address)
-      geocode!(address)
+    def geocode(address, options = {})
+      geocode!(address, options)
     rescue ResponseError
       nil
     end
     
     # raise ResponseError exception on error
-    def geocode!(address)
-      response = call_geocoder_service(address)
+    def geocode!(address, options = {})
+      response = call_geocoder_service(address, options)
       if response.is_a?(Net::HTTPOK)
         return JSON.parse response.body
       else
@@ -49,10 +49,15 @@ module SimpleGeocoder
     end
     
     private
-    def call_geocoder_service(address)
+    def call_geocoder_service(address, options)
       format = 'json'
       address = CGI.escape address
-      parameters = "address=#{address}&region=#{@@api_config['google_v3']['region']}&sensor=#{@@api_config['google_v3']['sensor']}"
+      parameters = "address=#{address}"
+      parameters += options[:region] ? "&region=#{options[:region]}" : "&region=#{@@api_config['google_v3']['region']}"
+      parameters += options[:sensor] ? "&sensor=#{options[:sensor]}" : "&sensor=#{@@api_config['google_v3']['sensor']}"
+      parameters += "&bounds=#{CGI.escape options[:bounds]}" if options[:bounds]
+      parameters += "&language=#{options[:language]}" if options[:language]
+      # parameters = "address=#{address}&region=#{@@api_config['google_v3']['region']}&sensor=#{@@api_config['google_v3']['sensor']}"
       url = "#{@@api_config['google_v3']['url_root']}/#{format}?#{parameters}"
 
       Net::HTTP.get_response(URI.parse(url))

data/lib/simple_geocoder/version.rb

@@ -1,3 +1,3 @@
 module SimpleGeocoder
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/geocoder_spec.rb

@@ -9,6 +9,41 @@ describe SimpleGeocoder::Geocoder do
     result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-105.2582644)
   end
   
+  it "works outside us region" do
+    result =  SimpleGeocoder::Geocoder.new.geocode("Moto'otua, Samoa")
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location']['lat'].should be_within(0.0001).of(-13.8460556)
+    result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-171.7629788)
+  end
+  
+  it "accepts region parameter" do
+    # returns Toledo, Ohio location
+    result =  SimpleGeocoder::Geocoder.new.geocode("Toledo")
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location']['lat'].should be_within(0.0001).of(41.6639383)
+    result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-83.555212)
+    
+    # returns Toledo, Spain location
+    result =  SimpleGeocoder::Geocoder.new.geocode("Toledo",{:region=>'es'})
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location']['lat'].should be_within(0.0001).of(39.8567775)
+    result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-4.0244759)
+  end
+  
+  it "accepts bounds parameter" do
+    # returns Winnetka, IL location
+    result =  SimpleGeocoder::Geocoder.new.geocode("Winnetka")
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location']['lat'].should be_within(0.0001).of(42.1080834)
+    result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-87.735895)
+    
+    # returns Winnetka, CA location
+    result =  SimpleGeocoder::Geocoder.new.geocode("Winnetka", { :bounds => "34.172684,-118.604794|34.236144,-118.500938" } )
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location']['lat'].should be_within(0.0001).of(34.20485860)
+    result['results'][0]['geometry']['location']['lng'].should be_within(0.0001).of(-118.57396210)
+  end
+  
   it "can find lat/lng in string" do
     address = "ÜT: 34.044817,-118.311893"
     result = SimpleGeocoder::Geocoder.new.find_location(address)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_geocoder
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ying Tsen Hong
@@ -50,7 +50,7 @@ files:
 - lib/simple_geocoder.rb
 - MIT-LICENSE
 - README.rdoc
-- simple_geocoder-0.0.2.gem
+- simple_geocoder-0.0.3.gem
 - simple_geocoder.gemspec
 - spec/geocoder_spec.rb
 - spec/spec_helper.rb