where 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Venables
+
+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,33 @@
+= Where
+
+A basic geolocation library for Ruby.
+
+== Installation
+
+  gem install 'where'
+
+== Usage
+
+Search by Address:
+
+  result = Where.is '4 yawkey way boston ma'
+  if result.success?
+    puts "Address: #{result.address}"
+    puts "Street Number: #{result.street_number}"
+    puts "Street: #{result.street}"
+    puts "City: #{result.city}"
+    puts "State: #{result.state}"
+    puts "Zip: #{result.postal_code}"
+    puts "Country: #{result.country}"
+    puts "Lat: #{result.lat}"
+    puts "Lng: #{result.lng}"
+  end
+  
+Or, by IP-Address:
+
+  result = Where.is "173.194.33.104"
+  ...
+
+== Copyright
+
+Copyright (c) 2010 Matt Venables. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "where"
+    gem.summary = %Q{A simple geolocation library.}
+    gem.description = %Q{A very simple geolocation library for searching based on postal address or ip address.}
+    gem.email = "matt@veg.etabl.es"
+    gem.homepage = "http://github.com/vegetables/where"
+    gem.authors = ["Matt Venables"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "where #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/Where.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{where}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Venables"]
+  s.date = %q{2010-10-03}
+  s.description = %q{A very simple geolocation library for searching based on postal address or ip address.}
+  s.email = %q{matt@veg.etabl.es}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "Where.gemspec",
+     "lib/where.rb",
+     "lib/where/address.rb",
+     "lib/where/base.rb",
+     "lib/where/ip_address.rb",
+     "test/helper.rb",
+     "test/test_where.rb"
+  ]
+  s.homepage = %q{http://github.com/vegetables/where}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple geolocation library.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_where.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/where/address.rb

@@ -0,0 +1,58 @@
+module Where
+  class Address < Where::Base    
+    class << self
+      GEOCODER_URL = 'http://maps.googleapis.com/maps/api/geocode/json?sensor=false&address='
+      
+      def geocode(address, api_url=nil)
+        super(address, api_url || GEOCODER_URL)
+      end
+    end
+    
+    def results=(results_array = [])
+      results_array.each { |result| self.new_attributes = result }
+    end
+    
+    def types=(val = [])
+      @accuracy = determine_type(val)
+    end
+    
+    def formatted_address=(val)
+      @address = val
+    end
+    
+    def address_components=(components = [])
+      components.each do |component|
+        type = determine_type component['types']
+        next if type.empty?
+        if %w(region country).include? type
+          self.send "#{type}_code=", component['short_name']
+          self.send "#{type}_name=", component['long_name']
+        else
+          self.send "#{type}=", component['long_name']
+        end
+      end
+    end
+    
+    def geometry=(val = {})
+      self.new_attributes = val['location']
+    end
+     
+  private
+
+    def determine_type(val = [])
+      { 'street_address'              => 'street_address',
+        'street_number'               => 'street_number',
+        'route'                       => 'street',
+        'neighborhood'                => 'neighborhood',
+        'locality'                    => 'city',
+        'administrative_area_level_1' => 'region',
+        'postal_code'                 => 'postal_code',
+        'country'                     => 'country'
+      }.each do |k, v|
+        return v if val.include? k
+      end
+      ""
+    end
+      
+  end
+end

data/lib/where/base.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'net/http'
+require 'active_support'
+
+module Where
+  class Base
+    attr_accessor :street_number, :street, :city, :neighborhood, :postal_code, 
+                  :region_code, :region_name, :accuracy,
+                  :country_code, :country_name, :lat, :lng
+    
+    class << self
+      def geocode(address, api_url = '')
+        begin
+          url = api_url + URI.escape(address)
+          response = Net::HTTP.get_response(URI.parse(url))
+          self.new response.body
+        rescue
+          self.new
+        end
+      end
+    end
+    
+    def initialize(data = "")
+      opts = ActiveSupport::JSON.decode(data)
+      return if opts.empty?
+      self.new_attributes = opts
+      self
+    end
+    
+    def new_attributes=(opts = {})
+      opts.each do |k,v|
+        var_name = ActiveSupport::Inflector.underscore(k)
+        if self.respond_to?("#{var_name}=")
+          self.send "#{var_name}=", v
+        else
+          self.instance_variable_set("@#{var_name}", v) 
+        end
+      end
+    end
+
+    # Did the request return at least one result?
+    def success?
+      @status == 'OK' || !@region_code.nil?
+    end
+    
+    def street_address
+      arr = [street_number, street].compact
+      arr.empty? ? nil : arr.join(" ")
+    end
+
+    def address
+      arr = [street_address, city, region(true), postal_code, country(true)].compact
+      arr.empty? ? nil : arr.join(", ")
+    end
+    
+    def city(use_neighborhood = false)
+      @neighborhood && use_neighborhood ? @neighborhood : @city
+    end
+    
+    def country(short_version = false)
+      short_version ? @country_code : @country_name
+    end
+
+    def region(short_version = false)
+      short_version ? @region_code : @region_name
+    end
+
+  end
+
+end

data/lib/where/ip_address.rb

@@ -0,0 +1,33 @@
+module Where
+  class IpAddress < Where::Base
+    class << self
+      GEOCODER_URL = 'http://www.geoplugin.net/json.gp?ip='
+      
+      def geocode(address, api_url=nil)
+        super(address, api_url || GEOCODER_URL)
+      end
+    end
+    
+    def initialize(body="")
+      data = body[10..-2] || ""
+      super(data.empty? ? data : data.gsub('geoplugin_', ''))
+    end
+            
+    def latitude=(val)
+      @lat = val
+    end
+    
+    def longitude=(val)
+      @lng = val
+    end
+  
+    def accuracy
+      return 'street_address' unless street.nil?
+      return 'city' unless city.nil?
+      return 'region' unless region.nil?
+      return 'country' unless country.nil?
+      ""
+    end
+    
+  end
+end

data/lib/where.rb

@@ -0,0 +1,14 @@
+require 'where/base'
+require 'where/address'
+require 'where/ip_address'
+
+module Where  
+  def self.is(address = "")
+    address ||= ""
+    if address.match(/^(\d{1,3}\.){3}\d{1,3}$/)
+      Where::IpAddress.geocode address
+    else
+      Where::Address.geocode address
+    end    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'where'
+
+class Test::Unit::TestCase
+end

data/test/test_where.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+class TestWhere < Test::Unit::TestCase
+    
+  should "build an empty object when given a nil address" do
+    result = Where.is(nil)
+    assert result.accuracy.nil?
+    assert result.address.nil?
+    assert result.street_number.nil?
+    assert result.street.nil?
+    assert result.city.nil?
+    assert result.region.nil?
+    assert result.postal_code.nil?
+    assert result.country.nil?
+    assert result.lat.nil?
+    assert result.lng.nil?
+  end
+  
+  should "build an empty object when given an empty address" do
+    result = Where.is("")
+    assert result.accuracy.nil?
+    assert result.address.nil?
+    assert result.street_number.nil?
+    assert result.street.nil?
+    assert result.city.nil?
+    assert result.region.nil?
+    assert result.postal_code.nil?
+    assert result.country.nil?
+    assert result.lat.nil?
+    assert result.lng.nil?
+  end
+
+  should "build a valid geolocation object when given a street address" do
+    result = Where.is("4 yawkey way boston ma")
+    assert result.accuracy == 'street_address'
+    assert !result.address.nil?
+    assert result.street_number == '4'
+    assert result.street == 'Yawkey Way'
+    assert result.city == 'Boston'
+    assert result.city(true) == 'Boston'
+    assert result.region == 'Massachusetts'
+    assert result.region(true) == 'MA'
+    assert result.postal_code == '02215'
+    assert result.country == 'United States'
+    assert result.country(true) == 'US'
+    assert !result.lat.nil?
+    assert !result.lng.nil?
+  end
+  
+  should "build a valid geolocation object when given an address in a neighborhood" do
+    result = Where.is("brighton ma")
+    assert result.accuracy == 'neighborhood'
+    assert !result.address.nil?
+    assert result.street_number.nil?
+    assert result.street.nil?
+    assert result.city == 'Boston'
+    assert result.city(true) == 'Brighton'
+    assert result.region == 'Massachusetts'
+    assert result.region(true) == 'MA'
+    assert result.postal_code.nil?
+    assert result.country == 'United States'
+    assert result.country(true) == 'US'
+    assert !result.lat.nil?
+    assert !result.lng.nil?
+  end
+  
+  
+  should "build a valid geolocation object when given an ip address" do
+    result = Where.is("173.194.33.104")
+    assert result.accuracy == 'city'
+    assert !result.address.nil?
+    assert result.street_number.nil?
+    assert result.street.nil?
+    assert result.city == 'Mountain View'
+    assert result.city(true) == 'Mountain View'
+    assert result.region == 'California'
+    assert result.region(true) == 'CA'
+    assert result.postal_code.nil?
+    assert result.country == 'United States'
+    assert result.country(true) == 'US'
+    assert !result.lat.nil?
+    assert !result.lng.nil?
+  end
+  
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: where
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Venables
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A very simple geolocation library for searching based on postal address or ip address.
+email: matt@veg.etabl.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- Where.gemspec
+- lib/where.rb
+- lib/where/address.rb
+- lib/where/base.rb
+- lib/where/ip_address.rb
+- test/helper.rb
+- test/test_where.rb
+has_rdoc: true
+homepage: http://github.com/vegetables/where
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple geolocation library.
+test_files: 
+- test/helper.rb
+- test/test_where.rb