simplegeo 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.swp
+*.swo
+*.swn
+.tmp_*
+.project
+._*
+.DS_Store
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Scott Windsor
+
+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,21 @@
+= simplegeo-ruby
+
+This is a Ruby client for the Simplegeo API (Version 0.1)
+
+For the specific documentation on APIs (and the full list of parameters) see:
+
+http://help.simplegeo.com/faqs/api-documentation/endpoints
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Scott Windsor. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simplegeo"
+    gem.summary = %Q{a simplegeo client written in ruby}
+    gem.description = %Q{a simplegeo client written in ruby.  see http://help.simplegeo.com/faqs/api-documentation/endpoints for more info.}
+    gem.email = "swindsor@gmail.com"
+    gem.homepage = "http://github.com/sentientmonkey/simplegeo-ruby"
+    gem.authors = ["Scott Windsor"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_dependency('oauth', '>= 0.3.6')
+    gem.add_dependency('crack', '>= 0.1.7')
+    gem.add_dependency('json', '>= 1.2.2')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simplegeo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/simplegeo.rb

@@ -0,0 +1,179 @@
+require 'rubygems'
+
+gem 'crack', '~> 0.1.7'
+require 'crack'
+
+gem 'oauth', '~> 0.3.6'
+require 'oauth'
+
+gem 'json', '~> 1.2.2'
+require 'json'
+
+require 'forwardable'
+require 'uri'
+
+# This is a client for accessing Simplegeo's REST APIs
+# for full documentation see:
+# http://help.simplegeo.com/faqs/api-documentation/endpoints
+
+class Simplegeo
+  BASE_URI = 'http://api.simplegeo.com'
+  VER = '0.1'
+  attr_accessor :layer
+  attr_reader :access_token
+
+  extend Forwardable
+  def_delegators :access_token, :get, :post, :put, :delete
+
+  class NotAuthorized < StandardError; end
+  class NotFound < StandardError; end
+  class InternalError < StandardError; end
+
+  # initialize a new client with a acess key, secret key, and a default layer
+  def initialize(key, secret, layer = nil)
+    @access_token = self.class.get_access_token(key, secret)
+    @layer = layer
+  end
+ 
+  # find nearby objects given a lat & lng
+  # by default, only searches the the current layer
+  def nearby(lat, lng, options = {})
+    options = {}
+    options[:layers] ||= [self.layer]
+    perform_get("/nearby/#{lat},#{lng}.json", :query => options)
+  end
+
+  # reverse geocodes a lat & lng
+  def nearby_address(lat, lng, options = {})
+    options = {}
+    perform_get("/nearby/address/#{lat},#{lng}.json", :query => options)
+  end
+
+  def user_stats
+    perform_get("/stats.json")
+  end
+
+  def layer_stats
+    perform_get("/stats/#{layer}.json")
+  end
+
+  class Records
+    def initialize(simplegeo) #:nodoc:
+      @simplegeo = simplegeo
+    end
+
+    # get a record by id
+    def get(id)
+      @simplegeo.records_dispatch(:get, id)
+    end
+
+    # put a record by id
+    # data should be a hash with at least lat & lon keys, as well as extra data
+    def put(id, data)
+      @simplegeo.records_dispatch(:put, id, data)
+    end
+
+    # delete a record by id
+    def delete(id)
+      @simplegeo.records_dispatch(:delete, id)
+    end
+
+    # get the history of a record by id
+    def history(id)
+      @simplegeo.records_dispatch(:get_history, id)
+    end
+  end
+
+  # used to access record APIs
+  # i.e. client.records.get(1)
+  def records
+    Records.new(self)
+  end
+
+  def records_dispatch(operation, id, body = nil) #:nodoc:
+    case operation
+    when :get_history
+      perform(:get, "/records/#{layer}/#{id}/history.json")
+    when :put
+      perform(:put, "/records/#{layer}/#{id}.json", :body => build_feature(id, body))
+    else
+      perform(operation, "/records/#{layer}/#{id}.json")
+    end
+  end
+
+  protected
+
+  def self.get_access_token(key, secret)
+    consumer = OAuth::Consumer.new(key,secret, :site => BASE_URI)
+    OAuth::AccessToken.new(consumer)
+  end
+
+  def perform(operation, path, options = {})
+    case operation
+    when :put, :post
+      handle_response(self.send(operation, build_uri(path, options), options[:body].to_json))
+    else
+      handle_response(self.send(operation, build_uri(path, options)))
+    end
+  end
+
+  def perform_get(path, options = {})
+    perform(:get, path, options)
+  end
+
+  def perform_delete(path, options = {})
+    perform(:delete, path, options)
+  end
+
+  def perform_put(path, options = {})
+    perform(:put, path, options)
+  end
+
+  def perform_post(path, options = {})
+    perform(:post, path, options)
+  end
+
+  def build_uri(path, options = {})
+    uri = URI.parse("/#{VER}#{path}")
+    uri.query = build_query(options[:query])
+    uri.to_s 
+  end
+
+  def build_query(query)
+    if query && query != {}
+      query.map do |k,v|
+        [k.to_s,v.to_s].join('=')
+      end.join('&')
+    end
+  end
+
+  def build_feature(id, body)
+    {:type => 'Feature', 
+     :id => id,
+     :created => body[:created],
+     :geometry => { :type => 'Point',
+                    :coordinates => [body[:lon], body[:lat]]},
+     :properties => body.reject{|k,v| [:created, :lat, :lon].include?(k) }}
+  end
+
+  def handle_response(response)
+    raise_errors(response)
+    parse(response)
+  end
+
+  def raise_errors(response)
+    case response.code.to_i
+      when 401
+        raise NotAuthorized.new "(#{response.code}): #{response.message}"
+      when 404
+        raise NotFound.new "(#{response.code}): #{response.message}"
+      when 500
+        raise InternalError.new "(#{response.code}): #{response.message}"
+    end
+  end
+ 
+  def parse(response)
+    Crack::JSON.parse(response.body)
+  end
+
+end

data/simplegeo.gemspec

@@ -0,0 +1,64 @@
+# 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{simplegeo}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Windsor"]
+  s.date = %q{2010-03-08}
+  s.description = %q{a simplegeo client written in ruby.  see http://help.simplegeo.com/faqs/api-documentation/endpoints for more info.}
+  s.email = %q{swindsor@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/simplegeo.rb",
+     "simplegeo.gemspec",
+     "spec/simplegeo_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/test_keys.yml"
+  ]
+  s.homepage = %q{http://github.com/sentientmonkey/simplegeo-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{a simplegeo client written in ruby}
+  s.test_files = [
+    "spec/simplegeo_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0.3.6"])
+      s.add_runtime_dependency(%q<crack>, [">= 0.1.7"])
+      s.add_runtime_dependency(%q<json>, [">= 1.2.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<oauth>, [">= 0.3.6"])
+      s.add_dependency(%q<crack>, [">= 0.1.7"])
+      s.add_dependency(%q<json>, [">= 1.2.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<oauth>, [">= 0.3.6"])
+    s.add_dependency(%q<crack>, [">= 0.1.7"])
+    s.add_dependency(%q<json>, [">= 1.2.2"])
+  end
+end
+

data/spec/simplegeo_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Simplegeo" do
+  it "should be able to get an access token" do
+    access_token = Simplegeo.get_access_token(@test_keys['key'], @test_keys['secret'])
+    result = access_token.get("/0.1/records/com.simplegeo.us.zip/98122.json")
+    result.should be_a_kind_of(Net::HTTPOK)
+  end
+
+  it "should be able to find a record" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.simplegeo.us.zip')
+    result = simple.records.get(98122)
+    result.should be_a_kind_of(Hash)
+    result['id'].should eql('98122')
+  end
+
+  it "should be able to find history for a record" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.simplegeo.us.zip')
+    result = simple.records.history(98122)
+    result.should be_a_kind_of(Hash)
+  end
+
+  it "should be able to find nearby" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.simplegeo.us.zip')
+    result = simple.nearby(47.607089,-122.332034)
+    result.should be_a_kind_of(Hash)
+  end
+
+  it "should be able to find nearby address" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'])
+    result = simple.nearby_address(47.607089,-122.332034)
+    result.should be_a_kind_of(Hash)
+    result['properties'].should_not be_nil
+    result['properties']['place_name'].should eql('Seattle')
+    result['properties']['state_name'].should eql('Washington')
+    result['properties']['street'].should eql('5th Ave')
+    result['properties']['postal_code'].should eql('98104')
+    result['properties']['county_name'].should eql('King')
+    result['properties']['country'].should eql('US')
+  end
+
+  it "should be able to find user stats" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.simplegeo.us.zip')
+    result = simple.user_stats
+    result.should be_a_kind_of(Hash)
+    result['requests'].should_not be_nil
+    result['requests']['nearby'].should_not be_nil
+  end
+
+  it "should be able to put record" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.sentientmonkey.test')
+    result = simple.records.put(1, {:lat => 47.607089, :lon => -122.332034, :test => 'one'})
+    result = simple.records.get(1)
+    #TODO assertions
+  end
+
+  it "should be able to delete record" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.sentientmonkey.test')
+    result = simple.records.put(2, {:lat => 47.607089, :lon => -122.332034, :test => 'two'})
+    result = simple.records.delete(2)
+    result = simple.records.get(2)
+    #TODO assertions
+  end
+
+  it "should be able to find layer stats" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.sentientmonkey.test')
+    result = simple.layer_stats
+    result.should be_a_kind_of(Hash)
+    result['requests'].should_not be_nil
+  end
+
+  it "should raise NotFound exception on invalid record" do
+    simple = Simplegeo.new(@test_keys['key'], @test_keys['secret'], 'com.simplegeo.us.zip')
+    lambda{ simple.records.get(1) }.should raise_exception(Simplegeo::NotFound)
+  end
+
+  it "should raise NotAuthorized exception on invalid keys" do
+    simple = Simplegeo.new('bad key', 'bad secret', 'com.simplegeo.us.zip')
+    lambda{ simple.records.get(98122) }.should raise_exception(Simplegeo::NotAuthorized)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'simplegeo'
+require 'spec'
+require 'spec/autorun'
+require 'yaml'
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    @test_keys = YAML::load_file(File.join(File.dirname(__FILE__), "test_keys.yml"))
+    if @test_keys['key'] == 'key' || @test_keys['secret'] == 'secret'
+      raise 'test keys not set!  add your keys to test_keys.yml'
+    end
+  end
+end

data/spec/test_keys.yml

@@ -0,0 +1,2 @@
+key: 'Bg3Ys84hRtnUUzrtazaWCbbsxGfKuuNj'
+secret: 'Vme9ZtxkexyZXeFNQhjTyJQqmaVS7cAN'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: simplegeo
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+description: a simplegeo client written in ruby.  see http://help.simplegeo.com/faqs/api-documentation/endpoints for more info.
+email: swindsor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simplegeo.rb
+- simplegeo.gemspec
+- spec/simplegeo_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/test_keys.yml
+has_rdoc: true
+homepage: http://github.com/sentientmonkey/simplegeo-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: a simplegeo client written in ruby
+test_files: 
+- spec/simplegeo_spec.rb
+- spec/spec_helper.rb