geocoder-us 1.0.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2006 Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/geocoder_us.rb
+test/test_geocoder_us.rb
+test/uri_stub.rb

data/README

@@ -0,0 +1,42 @@
+= geocoder-us
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/geocoder-us
+
+== About
+
+geocoder-us allows you to look up coordinates for addresses using geocoder.us.
+
+== Installing geocoder-us
+
+Just install the gem:
+
+  $ sudo gem install geocoder-us
+
+== Using geocoder-us
+
+The easy way:
+
+  require 'rubygems'
+  require 'geocoder-us'
+  
+  p GeocoderUs.new.locate('1924 E Denny Way, Seattle, WA')
+
+If you like you can use a geocoder.us account.  You can sign up for an account
+here:
+
+http://geocoder.us/user/signup
+
+And here's how you use your account:
+
+  require 'rubygems'
+  require 'geocoder-us'
+  
+  gu = GeocoderUs.new 'username', 'password'
+  p gu.locate('1924 E Denny Way, Seattle, WA')
+

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'geocoder-us'
+  s.version = '1.0.0'
+  s.summary = 'Geocoder.us API Library'
+  s.description = 'Map addresses to latitude and longitude using geocoder.us'
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Geocoder.us'
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/geocoder-us'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Geocoder.us'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby
+

data/lib/geocoder_us.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+
+##
+# A library for lookup up coordinates with geocoder.us' API.
+#
+# http://geocoder.us/help/
+
+class GeocoderUs
+
+  ##
+  # Base error class
+
+  class Error < RuntimeError; end
+
+  ##
+  # Raised if you give an unlocatable address.
+
+  class AddressError < Error; end
+
+  ##
+  # Raised if you give a bad username/password pair.
+
+  class LoginError < Error; end
+
+  ##
+  # Creates a new GeocoderUs object optionally using +username+ and
+  # +password+.
+  #
+  # You can sign up for a geocoder.us account here:
+  #
+  # http://geocoder.us/user/signup
+
+  def initialize(user = nil, password = nil)
+    if user and password then
+      @url = URI.parse 'http://geocoder.us/member/service/csv'
+      @url.user = user
+      @url.password = password
+    else
+      @url = URI.parse 'http://rpc.geocoder.us/service/csv'
+    end
+  end
+
+  ##
+  # Locates +address+ and returns the address' latitude and longitude or
+  # raises an AddressError.
+
+  def locate(address)
+    url = @url.dup
+    url.query = "address=#{URI.escape address}"
+
+    url.open do |f|
+      response = f.read
+      raise AddressError, $' if response =~ /^2: /
+      lat, lon, = response.split ',', 3
+      lat = lat.to_f
+      lon = lon.to_f
+      return lat, lon
+    end
+  rescue OpenURI::HTTPError => e
+    raise LoginError if e.message =~ /^401 /
+  end
+
+end
+

data/test/test_geocoder_us.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require 'test/uri_stub'
+require 'geocoder_us'
+
+class TestGeocoderUs < Test::Unit::TestCase
+
+  def setup
+    URI::HTTP.responses = []
+    URI::HTTP.uris = []
+
+    @gu = GeocoderUs.new
+  end
+
+  def test_locate
+    URI::HTTP.responses << <<-EOF
+47.618620,-122.306942,1924 E Denny Way,Seattle,WA,98122
+    EOF
+
+    assert_equal [47.618620, -122.306942],
+                 @gu.locate('1924 E Denny Way, Seattle, WA')
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://rpc.geocoder.us/service/csv?address=1924%20E%20Denny%20Way,%20Seattle,%20WA',
+                 URI::HTTP.uris.first
+  end
+
+  def test_locate_with_account
+    URI::HTTP.responses << <<-EOF
+47.618620,-122.306942,1924 E Denny Way,Seattle,WA,98122
+    EOF
+
+    gu = GeocoderUs.new 'username', 'password'
+    assert_equal [47.618620, -122.306942],
+                 gu.locate('1924 E Denny Way, Seattle, WA')
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://username:password@geocoder.us/member/service/csv?address=1924%20E%20Denny%20Way,%20Seattle,%20WA',
+                 URI::HTTP.uris.first
+  end
+
+  def test_locate_bad_address
+    URI::HTTP.responses << '2: couldn\'t find this address! sorry'
+
+    @gu.locate('yuck')
+  rescue GeocoderUs::AddressError => e
+    assert_equal 'couldn\'t find this address! sorry', e.message
+
+    assert_equal true, URI::HTTP.responses.empty?
+    assert_equal 1, URI::HTTP.uris.length
+    assert_equal 'http://rpc.geocoder.us/service/csv?address=yuck',
+                 URI::HTTP.uris.first
+  else
+    flunk 'Expected GeocoderUs::AddressError'
+  end
+
+end
+

data/test/uri_stub.rb

@@ -0,0 +1,17 @@
+require 'open-uri'
+
+class URI::HTTP
+
+  class << self
+    attr_accessor :responses, :uris
+  end
+
+  alias original_open open
+
+  def open
+    self.class.uris << self.to_s
+    yield StringIO.new(self.class.responses.shift)
+  end
+
+end
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.15
+specification_version: 1
+name: geocoder-us
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-06-13 00:00:00 -07:00
+summary: Geocoder.us API Library
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: Map addresses to latitude and longitude using geocoder.us
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/geocoder_us.rb
+- test/test_geocoder_us.rb
+- test/uri_stub.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+