geocode 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2009 David Brady github@shinybit.com
+ 
+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,62 @@
+= geocode
+
+Yet another geoding library. Initial version geocodes using Google
+only but I plan to extend it to use Yahoo and possibly Tiger/Line.
+
+= Examples
+
+== Command-Line
+
+Geocode an address using google:
+
+  geocode -s google -g abcd1234_SAMPLE_GOOGLE_API_KEY_etc 1600 Amphitheatre Parkway, Mountain View, CA
+  # => 37.421759,-122.08437
+
+Reverse geocode a lat/lng (with google api key set in configuration file):
+
+  geocode -r 37.421759,-122.08437
+  # => 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA
+
+== Ruby
+
+  g = Geocode.new_geocoder :google, {:google_api_key => "abcd1234_SAMPLE_GOOGLE_API_KEY_etc"}
+  result1 = g.geocode "1600 Amphitheatre Parkway, Mountain View, CA"
+  result2 = g.reverse_geocode "37.421759,-122.08437"
+
+result1 and result2 are hashes with the following extension functions added in:
+
+  result.success? # true if the geocode/reverse_geocode succeeded.
+  result.error? # opposite of success.
+  result.latlng # array of 2 floats, [latitude, longitude], returned by geocode.
+  result.address # string containing the address returned by reverse_geocode.
+
+= Installation
+
+  gem install geocode
+
+= Configuration (Command-Line)
+
+You can create a configuration file in ~/.geocode called geocode.yml.
+It's a handy place to put your Google API key, for example. You can
+also place geocode.yml in the current directory if you don't want to
+place it in your home folder. A sample file would look like:
+
+  ---
+  service: google
+  google_api_key: abcd1234_SAMPLE_GOOGLE_API_KEY_etc
+
+
+= TOS WARNING
+
+The Google geocoding service uses the Google Map API and thus you are
+bound by their Terms of Service. Most notably, this says that you MAY
+NOT "use or display the Content without a corresponding Google map".
+There are specific exceptions to this rule but be aware.
+
+= Authors
+
+* David Brady <github@shinybit.com>
+
+= License
+
+MIT.

data/bin/geocode

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'geocode'))
+
+config_file = ["./geocode.yml", "~/.geocode/geocode.yml"].map {|p| File.expand_path(p)}.find {|p| File.exists? p}
+
+config = config_file ? YAML::load_file(config_file) : {}
+config.each { |k,v| config[k.to_sym] = v}
+
+opts = Trollop.options do
+  opt :google_api_key, "API KEY to use", :default => nil
+  opt :service, "Geocoding Service to use", :default => nil
+  opt :reverse, "Reverse geocode", :type => :boolean, :default => false
+  opt :latlng, "Geocode to lat,lng (default)", :type => :boolean, :default => true
+end
+
+opts[:google_api_key] ||= config[:google_api_key] || ""
+opts[:service] ||= config[:service] || "google"
+opts[:service] = opts[:service].to_sym
+
+# reverse geocoding is not compatible with latlng
+if opts[:reverse] && opts[:latlng]
+  opts[:latlng] = false
+end
+
+# geocode the address or lat/lng given
+g = Geocode.new_geocoder(opts[:service], opts)
+if opts[:latlng]
+  puts g.geocode(ARGV * ' ').latlng * ','
+else opts[:reverse]
+  puts g.reverse_geocode(ARGV * ' ').address
+end

data/lib/geocode.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'google_geocode'))
+
+class Geocode
+  def self.new_geocoder(service, options)
+    case service
+    when :google
+      GoogleGeocode.new options[:google_api_key]
+    else
+      raise "Unsupported geocode service: #{service}"
+    end
+  end
+  
+  def geocode()
+    raise "geocode(): Unimplemented method! Child class must override!"
+  end
+
+  def reverse_geocode()
+    raise "reverse_geocode(): Unimplemented method! Child class must override!"
+  end
+end

data/lib/google_geocode.rb

@@ -0,0 +1,50 @@
+require 'net/http'
+require 'json'
+
+class GoogleGeocode
+  attr_reader :api_key
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def do_geocode(location)
+    url = "http://maps.google.com/maps/geo?sensor=false&key=#{@api_key}&output=json&q=#{location}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = resp.body
+    
+    result = JSON.parse(data)
+    class << result
+      def success?
+        self["Status"]["code"] == 200
+      end
+      
+      def error?
+        !success?
+      end
+      
+      def dump
+        inspect
+      end
+      
+      def latlng
+        self["Placemark"][0]["Point"]["coordinates"][0..1].reverse
+      end
+
+      def address
+        self["Placemark"][0]["address"]
+      end
+    end
+    result
+  end
+
+  def geocode(location)
+    # change whitespace to %20 for the URL
+    result = do_geocode location.gsub(/\s+/, '%20')
+  end
+  
+  
+  def reverse_geocode(location)
+    # reverse geocodes should not have any spaces in them
+    result = do_geocode location.gsub(/\s+/, '')
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: geocode
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: geocode, a ruby library and command-line tool for geocoding addresses and reverse geocoding coordinates.
+email: github@shinybit.com
+executables: 
+- geocode
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- bin/geocode
+- lib/geocode.rb
+- lib/google_geocode.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/dbrady/geocode/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- geocode
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Geocoding library and CLI tool
+test_files: []
+