simple_geocoder 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ying Tsen Hong
+
+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,17 @@
+= simple_geocoder
+
+Simple 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
+
+== Examples
+  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}
+
+== Requirements
+* JSON http://flori.github.com/json/doc/index.html
+
+== Copyright
+Copyright (c) 2010 Ying Tsen Hong. See LICENSE for details

data/config/api.yml

@@ -0,0 +1,6 @@
+google_v3:
+  # output: json # only JSON output format supported
+  sensor: false
+  region: us
+  url_root: "http://maps.google.com/maps/api/geocode"
+  

data/lib/simple_geocoder/exceptions.rb

@@ -0,0 +1,15 @@
+module SimpleGeocoder
+  # contains the Net::HTTP response object accessible via the {#response} method.
+  class ResponseError < StandardError
+    # response of the last request
+    # @return [Net::HTTPResponse] A subclass of Net::HTTPResponse, e.g.
+    # Net::HTTPOK
+    attr_reader :response
+
+    # Instantiate an instance of ResponseError with a Net::HTTPResponse object
+    # @param [Net::HTTPResponse]
+    def initialize(response)
+      @response = response
+    end
+  end
+end

data/lib/simple_geocoder/geocoder.rb

@@ -0,0 +1,60 @@
+require 'net/http'
+require 'cgi'
+require 'timeout'
+require 'json'
+
+# Geocoding is a time and resource intensive task. 
+# Whenever possible, pre-geocode known addresses 
+# (using the Geocoding API described here or another geocoding service), 
+# and store your results in a temporary cache of your own design. (from Google Geocoding API docs)
+module SimpleGeocoder
+  class Geocoder
+    @@api_config = YAML.load_file(File.join(File.dirname(__FILE__), '../../config/api.yml'))
+    def initialize
+      
+    end
+
+    # swallow exceptions and return nil on error
+    def geocode(address)
+      geocode!(address)
+    rescue ResponseError
+      nil
+    end
+    
+    # raise ResponseError exception on error
+    def geocode!(address)
+      response = call_geocoder_service(address)
+      if response.is_a?(Net::HTTPOK)
+        return JSON.parse response.body
+      else
+        raise ResponseError.new response
+      end
+    end
+    
+    # if geocoding fails, then look for lat,lng string in address
+    def find_location(address)
+      result = geocode(address)
+      if result['status'] == 'OK'
+        return result['results'][0]['geometry']['location']
+      else
+        latlon_regexp = /(-?([1-8]?[0-9]\.{1}\d{1,6}|90\.{1}0{1,6})),(-?((([1]?[0-7][0-9]|[1-9]?[0-9])\.{1}\d{1,6})|[1]?[1-8][0]\.{1}0{1,6}))/
+        if address =~ latlon_regexp
+          location = $&.split(',').map {|e| e.to_f}
+          return { "lat" => location[0], "lng" => location[1] }
+        else
+          return nil
+        end
+      end
+    end
+    
+    private
+    def call_geocoder_service(address)
+      format = 'json'
+      address = CGI.escape address
+      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))
+    end
+  end
+end

data/lib/simple_geocoder/version.rb

@@ -0,0 +1,3 @@
+module SimpleGeocoder
+  VERSION = '0.0.1'
+end

data/lib/simple_geocoder.rb

@@ -0,0 +1,3 @@
+require 'simple_geocoder/version'
+require 'simple_geocoder/geocoder'
+require 'simple_geocoder/exceptions'

data/simple_geocoder.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path("../lib/simple_geocoder/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name     = 'simple_geocoder'
+  spec.summary  = 'Simple interface to Google Geocoding API V3'
+  spec.version     = ::SimpleGeocoder::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.email    = 'tsenying gmail'
+  spec.authors  = ['Ying Tsen Hong']
+  spec.homepage = 'http://github.com/tsenying/simple_geocoder'
+
+  # silence a gem build warning.
+  spec.rubyforge_project = 'N/A'
+  
+  spec.extra_rdoc_files = ['MIT-LICENSE', 'README.rdoc']
+
+  # everything except the git files
+  spec.files = Dir['**/*'].reject{ |f| f.include?('.git') }
+  # spec.files += ['.gitignore']
+  spec.test_files = Dir['test/*.rb']
+
+  spec.description = %q{Simple Geocoder}
+  # spec.require_paths = ["lib"] # default
+  spec.has_rdoc = "true"
+
+  spec.add_dependency('json', '~>1.1.9')
+end

data/spec/geocoder_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe SimpleGeocoder::Geocoder do
+  it "can geocode" do
+    address = '2000 28th St, Boulder, CO'
+    result = SimpleGeocoder::Geocoder.new.geocode(address)
+    result['status'].should == "OK" # at least one geocode returned
+    result['results'][0]['geometry']['location'].should == {"lat"=> 40.0185510,"lng"=> -105.2582644}
+  end
+  
+  it "can find lat/lng in string" do
+    address = "ÜT: 34.044817,-118.311893"
+    result = SimpleGeocoder::Geocoder.new.find_location(address)
+    result.should_not be_nil
+    result.should == {"lat"=> 34.044817,"lng"=> -118.311893}
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: simple_geocoder
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ying Tsen Hong
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-25 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 1
+        - 9
+        version: 1.1.9
+  type: :runtime
+  version_requirements: *id001
+description: Simple Geocoder
+email: tsenying gmail
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- config/api.yml
+- lib/simple_geocoder/exceptions.rb
+- lib/simple_geocoder/geocoder.rb
+- lib/simple_geocoder/version.rb
+- lib/simple_geocoder.rb
+- MIT-LICENSE
+- README.rdoc
+- simple_geocoder-0.0.1.gem
+- simple_geocoder.gemspec
+- spec/geocoder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tsenying/simple_geocoder
+licenses: []
+
+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: N/A
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple interface to Google Geocoding API V3
+test_files: []
+