cloudkit 0.10.1 → 0.11.0

data/CHANGES

@@ -1,3 +1,14 @@
+0.11.0
+- Added Tokyo Cabinet storage
+- Added MemoryTable development-time storage
+- Improved router performance
+- Added CloudKit::Resource model
+- Added custom URIs for OpenID bypass
+- Removed internal undocumented ExtractionViews
+- Removed SQL backends
+- Removed Sequel and Rack::Config dependencies
+- Switched test framework to RSpec
+
 0.10.1
 - Updated oauth and sequel gem dependencies
 - Fixed 410 responses for stale PUT operations

data/README

@@ -2,9 +2,9 @@
 
 CloudKit is an Open Web JSON Appliance.
 
-More specifically, CloudKit provides RESTful JSON storage with optional OpenID and OAuth support, including OAuth Discovery. Stored entities are versioned. Services manage their own storage and do not require schema updates when models change.
+CloudKit provides schema-free, auto-versioned, RESTful JSON storage with optional OpenID and OAuth support, including OAuth Discovery.
 
-CloudKit is Rack middleware and as such can be used on its own or alongside other Rack-based applications or middleware components like Rails, Merb or Sinatra.
+CloudKit is Rack middleware. It can be used on its own or alongside other Rack-based applications or middleware components like Rails, Merb or Sinatra.
 
 ===Install
 
@@ -35,12 +35,11 @@ An explicit version of example 2, minus the default developer landing page:
   use CloudKit::Service, :collections => [:notes, :todos]
   run lambda {|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => '5'}, ['HELLO']]}
 
-The same as above, using MySQL:
+The same as above, using Tokyo Cabinet:
 
   require 'cloudkit'
-  use Rack::Config do |env|
-    env[CLOUDKIT_STORAGE_URI] = 'mysql://user:pass@localhost/cloudkit_example'
-  end
+  require 'rufus/tokyo' # gem install rufus-tokyo
+  CloudKit.setup_storage_adapter(Rufus::Tokyo::Table.new('cloudkit.tdb'))
   use Rack::Pool::Session
   use CloudKit::OAuthFilter
   use CloudKit::OpenIDFilter
@@ -59,6 +58,8 @@ Google Group: http://groups.google.com/group/cloudkit
 
 Source: http://github.com/jcrosby/cloudkit
 
+IRC: #cloudkit on freenode
+
 ===License
 
 Copyright (c) 2008, 2009 Jon Crosby http://joncrosby.me

data/Rakefile

@@ -1,13 +1,20 @@
 require 'rake/clean'
+require 'spec/rake/spectask'
 
 CLEAN.include 'doc/api'
 
-task :default => :test
+task :default => :spec
 
-desc 'Run specs'
-task :test => FileList['test/*_test.rb'] do |t|
-  suite = t.prerequisites.map{|f| "-r#{f.chomp('.rb')}"}.join(' ')
-  sh "ruby -Ilib:test #{suite} -e ''", :verbose => false
+desc "Run all examples (or a specific spec with TASK=xxxx)"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts  = ["-c"]
+  t.spec_files = begin
+    if ENV["TASK"] 
+      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
+    else
+      FileList['spec/**/*_spec.rb']
+    end
+  end
 end
 
 desc 'Generate rdoc'
@@ -25,7 +32,7 @@ task :rdoc do
     --exclude=cloudkit.gemspec
     --exclude=templates/*
     --exclude=examples/*
-    --exclude=test/*
+    --exclude=spec/*
     --exclude=doc/index.html
     --exclude=doc/curl.html
     --exclude=doc/rest-api.html

data/TODO

@@ -3,19 +3,21 @@
 - oauth token management
 - oauth consumer registration
 - acls i.e. allowed methods per user per uri
-- complete user data export
-- method filtering on collections
-- js functions as observers (validation, mapping, etc.)
+- jsonpath
+- jsonquery
+- jsonschema
+- user lookup via a block for integration with existing stores
 - custom templates for openid / oauth
 
 Backlog
+- method filtering on collections
+- js functions as observers (validation, mapping, etc.)
+- complete user data export
 - batch updates (post, put, delete)
 - expect header/100-continue
 - deployable gem + admin app
 - cappuccino adapter
 - sproutcore adapter
-- tokyocabinet
-- ldap adapter for UserStore
 - titanium middleware
     version/upgrade middleware
     rake automation

data/cloudkit.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.name              = "cloudkit"
-  s.version           = "0.10.1"
-  s.date              = "2008-01-27"
+  s.version           = "0.11.0"
+  s.date              = "2008-03-09"
   s.summary           = "An Open Web JSON Appliance."
   s.description       = "An Open Web JSON Appliance."
   s.authors           = ["Jon Crosby"]
@@ -29,10 +29,10 @@ Gem::Specification.new do |s|
     examples/3.ru
     examples/4.ru
     examples/5.ru
-    examples/6.ru
     examples/TOC
     lib/cloudkit.rb
     lib/cloudkit/constants.rb
+    lib/cloudkit/exceptions.rb
     lib/cloudkit/flash_session.rb
     lib/cloudkit/oauth_filter.rb
     lib/cloudkit/oauth_store.rb
@@ -43,42 +43,42 @@ Gem::Specification.new do |s|
     lib/cloudkit/request.rb
     lib/cloudkit/service.rb
     lib/cloudkit/store.rb
-    lib/cloudkit/store/adapter.rb
-    lib/cloudkit/store/extraction_view.rb
+    lib/cloudkit/store/memory_table.rb
+    lib/cloudkit/store/resource.rb
     lib/cloudkit/store/response.rb
     lib/cloudkit/store/response_helpers.rb
-    lib/cloudkit/store/sql_adapter.rb
     lib/cloudkit/templates/authorize_request_token.erb
     lib/cloudkit/templates/oauth_descriptor.erb
     lib/cloudkit/templates/oauth_meta.erb
     lib/cloudkit/templates/openid_login.erb
     lib/cloudkit/templates/request_authorization.erb
     lib/cloudkit/templates/request_token_denied.erb
+    lib/cloudkit/uri.rb
     lib/cloudkit/user_store.rb
     lib/cloudkit/util.rb
-    test/ext_test.rb
-    test/flash_session_test.rb
-    test/helper.rb
-    test/oauth_filter_test.rb
-    test/oauth_store_test.rb
-    test/openid_filter_test.rb
-    test/openid_store_test.rb
-    test/rack_builder_test.rb
-    test/request_test.rb
-    test/service_test.rb
-    test/store_test.rb
-    test/user_store_test.rb
-    test/util_test.rb
+    spec/ext_spec.rb
+    spec/flash_session_spec.rb
+    spec/memory_table_spec.rb
+    spec/oauth_filter_spec.rb
+    spec/oauth_store_spec.rb
+    spec/openid_filter_spec.rb
+    spec/openid_store_spec.rb
+    spec/rack_builder_spec.rb
+    spec/request_spec.rb
+    spec/resource_spec.rb
+    spec/service_spec.rb
+    spec/spec_helper.rb
+    spec/store_spec.rb
+    spec/uri_spec.rb
+    spec/user_store_spec.rb
+    spec/util_spec.rb
   ]
-  s.test_files        = s.files.select {|path| path =~ /^test\/.*_test.rb/}
+  s.test_files        = s.files.select {|path| path =~ /^spec\/.*_spec.rb/}
   s.rubyforge_project = "cloudkit"
   s.rubygems_version  = "1.1.1"
   s.add_dependency 'rack', '~> 0.9'
-  s.add_dependency 'rack-config', '>= 0.9'
   s.add_dependency 'uuid', '= 2.0.1'
-  s.add_dependency 'sequel', '~> 2.9'
   s.add_dependency 'oauth', '~> 0.3'
   s.add_dependency 'ruby-openid', '= 2.1.2'
   s.add_dependency 'json', '= 1.1.3'
-  s.add_dependency 'sqlite3-ruby', '= 1.2.4'
 end

data/doc/curl.html

@@ -38,13 +38,13 @@ If you haven't already installed the gem:
 </p>
 
 <p>
-If you already have the gem, make sure you're running the latest version (0.10.0):
+If you already have the gem, make sure you're running the latest version (0.11.0):
   <div class="code">
     $ gem list cloudkit<br/>
     cloudkit (0.9.1) &lt;-- need to upgrade<br/>
     $ gem update cloudkit<br/>
     $ gem list cloudkit<br/>
-    cloudkit (0.10.0, 0.9.1) &lt;-- 0.10.0 is now in the list
+    cloudkit (0.11.0, 0.9.1) &lt;-- 0.11.0 is now in the list
   </div>
 </p>
 

data/doc/index.html

@@ -24,7 +24,7 @@
   </div>
   <div class="meta">
     <p class="wrapper">
-      Version 0.10.1 released. Install with <em>gem install cloudkit</em>.
+      Version 0.11 released with Tokyo Cabinet support. Install with <em>gem install cloudkit</em>.
     </p>
   </div>
   <div class="wrapper intro-row">
@@ -36,13 +36,11 @@
     </div>
     <div class="column-two">
       <p>
-        CloudKit provides RESTful JSON storage with optional OpenID and OAuth
-        support, including OAuth Discovery. Stored entities are versioned.
-        Services manage their own storage and do not require schema updates
-        when models change.
+        CloudKit provides schema-free, auto-versioned, RESTful JSON storage with optional OpenID and OAuth
+        support, including OAuth Discovery.
       </p>
       <p>
-        CloudKit is Rack middleware and as such can be used on its own or
+        CloudKit is Rack middleware. It can be used on its own or
         alongside other Rack-based applications or middleware components such
         as Rails, Merb or Sinatra.
       </p>

data/examples/5.ru

@@ -1,8 +1,7 @@
 $:.unshift File.expand_path(File.dirname(__FILE__)) + '/../lib'
 require 'cloudkit'
-use Rack::Config do |env|
-  env[CLOUDKIT_STORAGE_URI] = 'sqlite://example.db'
-end
+require 'rufus/tokyo' # gem install rufus-tokyo
+CloudKit.setup_storage_adapter(Rufus::Tokyo::Table.new('cloudkit.tdb'))
 use Rack::Session::Pool
 use CloudKit::OAuthFilter
 use CloudKit::OpenIDFilter

data/examples/TOC

@@ -12,6 +12,4 @@ removed.
 
 4. Notes with OAuth  - Same as #1 using only OAuth.
 
-5. SQLite Notes      - Same as #2 with a SQLite file store.
-
-6. MySQL Notes       - Same as #2 with MySQL store.
+5. Tokyo Notes       - Same as #2 with a Tokyo Cabinet Table store.

data/lib/cloudkit.rb

@@ -3,23 +3,22 @@ require 'erb'
 require 'json'
 require 'md5'
 require 'openid'
-require 'sequel'
 require 'time'
 require 'uuid'
 require 'rack'
-require 'rack/config'
 require 'oauth'
 require 'oauth/consumer'
 require 'oauth/request_proxy/rack_request'
 require 'oauth/server'
 require 'oauth/signature'
 require 'cloudkit/constants'
+require 'cloudkit/exceptions'
 require 'cloudkit/util'
-require 'cloudkit/store/adapter'
-require 'cloudkit/store/extraction_view'
+require 'cloudkit/uri'
+require 'cloudkit/store/memory_table'
+require 'cloudkit/store/resource'
 require 'cloudkit/store/response'
 require 'cloudkit/store/response_helpers'
-require 'cloudkit/store/sql_adapter'
 require 'cloudkit/store'
 require 'cloudkit/flash_session'
 require 'cloudkit/oauth_filter'
@@ -35,7 +34,19 @@ require 'cloudkit/user_store'
 include CloudKit::Constants
 
 module CloudKit
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
+
+  # Sets up the storage adapter. Defaults to development-time
+  # CloudKit::MemoryTable. Also supports Rufus Tokyo Table instances. See the
+  # examples directory for a demonstration.
+  def self.setup_storage_adapter(adapter_instance=nil)
+    @storage_adapter = adapter_instance || CloudKit::MemoryTable.new
+  end
+
+  # Return the shared storage adapter.
+  def self.storage_adapter
+    @storage_adapter
+  end
 end
 
 class Object
@@ -52,7 +63,6 @@ class Hash
   # Hash.
   def filter_merge!(other={})
     other.each_pair{|k,v| self.merge!(k => v) unless v.nil?}
-
     self
   end
 
@@ -61,7 +71,6 @@ class Hash
     if self.has_key? oldkey
       self[newkey] = self.delete(oldkey)
     end
-    
     nil
   end
 
@@ -69,7 +78,6 @@ class Hash
   def excluding(*keys)
     trimmed = self.dup
     keys.each{|k| trimmed.delete(k)}
-    
     trimmed
   end
 end
@@ -79,7 +87,6 @@ class Array
   # Return a new Array, excluding the specified list of values.
   def excluding(*keys)
     trimmed = self.dup
-    
     trimmed - keys
   end
 end

data/lib/cloudkit/constants.rb

@@ -23,9 +23,6 @@ module CloudKit
     # The 'via' key for the OpenID filter.
     CLOUDKIT_OPENID_FILTER_KEY = 'cloudkit.filter.openid'.freeze
 
-    # The key used to store the shared storage URI for the stack.
-    CLOUDKIT_STORAGE_URI = 'cloudkit.storage.uri'.freeze
-
     # The key for the login URL used in OpenID and OAuth middleware
     # components.
     CLOUDKIT_LOGIN_URL = 'cloudkit.filter.openid.url.login'.freeze
@@ -33,8 +30,5 @@ module CloudKit
     # The key for the logout URL used in OpenID and OAuth middleware
     # components.
     CLOUDKIT_LOGOUT_URL = 'cloudkit.filter.openid.url.logout'.freeze
-
-    # The outer namespace key for the JSON store.
-    CLOUDKIT_STORE = :cloudkit_json_store.freeze
   end
 end

data/lib/cloudkit/exceptions.rb

@@ -0,0 +1,10 @@
+module CloudKit
+
+  # HistoricalIntegrityViolation exceptions are raised when an attempt is made
+  # to modify an archived or deleted version of a resource.
+  class HistoricalIntegrityViolation < Exception; end
+
+  # InvalidURIFormat exceptions are raised during attempts to get or generate
+  # cannonical URIs from non-collection or non-resource URIs.
+  class InvalidURIFormat < Exception; end
+end

data/lib/cloudkit/flash_session.rb

@@ -14,9 +14,7 @@ module CloudKit
 
     # Access a value, then forget it.
     def [](k)
-      v = @values[k]
-      @values[k] = nil
-      v
+      @values.delete(k)
     end
   end
 end

data/lib/cloudkit/oauth_filter.rb

@@ -31,7 +31,7 @@ module CloudKit
 
     def call(env)
       @@lock.synchronize do
-        @@store = OAuthStore.new(env[CLOUDKIT_STORAGE_URI])
+        @@store = OAuthStore.new
       end unless @@store
 
       request = Request.new(env)
@@ -82,8 +82,7 @@ module CloudKit
     def create_request_token(request)
       return challenge(request, 'invalid nonce') unless valid_nonce?(request)
 
-      consumer_result = @@store.get(
-        "/cloudkit_oauth_consumers/#{request[:oauth_consumer_key]}")
+      consumer_result = @@store.get("/cloudkit_oauth_consumers/#{request[:oauth_consumer_key]}")
       unless consumer_result.status == 200
         return challenge(request, 'invalid consumer')
       end
@@ -105,8 +104,7 @@ module CloudKit
     def request_authorization(request)
       return login_redirect(request) unless request.current_user
 
-      request_token_result = @@store.get(
-        "/cloudkit_oauth_request_tokens/#{request[:oauth_token]}")
+      request_token_result = @@store.get("/cloudkit_oauth_request_tokens/#{request[:oauth_token]}")
       unless request_token_result.status == 200
         return challenge(request, 'invalid request token')
       end
@@ -118,8 +116,7 @@ module CloudKit
     def authorize_request_token(request)
       return login_redirect(request) unless request.current_user
 
-      request_token_response = @@store.get(
-        "/cloudkit_oauth_request_tokens/#{request.last_path_element}")
+      request_token_response = @@store.get("/cloudkit_oauth_request_tokens/#{request.last_path_element}")
       request_token = request_token_response.parsed_content
       if request_token['authorized_at']
         return challenge(request, 'invalid request token')
@@ -138,8 +135,7 @@ module CloudKit
     def deny_request_token(request)
       return login_redirect(request) unless request.current_user
 
-      request_token_response = @@store.get(
-        "/cloudkit_oauth_request_tokens/#{request.last_path_element}")
+      request_token_response = @@store.get("/cloudkit_oauth_request_tokens/#{request.last_path_element}")
       @@store.delete(
         "/cloudkit_oauth_request_tokens/#{request.last_path_element}",
         :etag => request_token_response.etag)
@@ -149,15 +145,13 @@ module CloudKit
     def create_access_token(request)
       return challenge(request, 'invalid nonce') unless valid_nonce?(request)
 
-      consumer_response = @@store.get(
-        "/cloudkit_oauth_consumers/#{request[:oauth_consumer_key]}")
+      consumer_response = @@store.get("/cloudkit_oauth_consumers/#{request[:oauth_consumer_key]}")
       unless consumer_response.status == 200
         return challenge(request, 'invalid consumer')
       end
 
       consumer = consumer_response.parsed_content
-      request_token_response = @@store.get(
-        "/cloudkit_oauth_request_tokens/#{request[:oauth_token]}")
+      request_token_response = @@store.get("/cloudkit_oauth_request_tokens/#{request[:oauth_token]}")
       unless request_token_response.status == 200
         return challenge(request, 'invalid request token')
       end
@@ -180,9 +174,7 @@ module CloudKit
         :consumer_key    => request[:oauth_consumer_key],
         :consumer_secret => consumer['secret'],
         :user_id         => request_token['user_id'])
-      @@store.put(
-        "/cloudkit_oauth_tokens/#{token_id}",
-        :json => token_data)
+      @@store.put("/cloudkit_oauth_tokens/#{token_id}", :json => token_data)
       @@store.delete(
         "/cloudkit_oauth_request_tokens/#{request[:oauth_token]}",
         :etag => request_token_response.etag)