cloudkit 0.11.1 → 0.11.2

data/CHANGES

@@ -1,3 +1,11 @@
+0.11.2
+- Added Location header for 201s
+- Fixed JSON response for DELETE operations
+- Updated MD5 dependency for Ruby 1.9 (Andreas Haller)
+- Updated spec setup for RSpec 1.2 (Andreas Haller)
+- Updated gem dependencies for Rack, OpenID, and JSON
+- Other minor fixes
+
 0.11.1
 - Added a block option for configuring OpenID bypassed routes (Devlin Daley)
 - Added write locks for Tokyo Tyrant Tables

data/README

@@ -17,7 +17,7 @@ In a rackup file called config.ru:
   require 'cloudkit'
   expose :notes, :todos
 
-The above creates a versioned HTTP service using JSON to represent two types of resource collections -- Notes and ToDos.
+The above creates a versioned HTTP/REST service using JSON to represent two types of resource collections -- Notes and ToDos.
 
 In a different rackup file:
 

data/TODO

@@ -2,18 +2,16 @@
 - openid sreg
 - oauth token management
 - oauth consumer registration
-- acls i.e. allowed methods per user per uri
-- jsonpath
 - jsonquery
 - jsonschema
 - user lookup via a block for integration with existing stores
 - custom templates for openid / oauth
 
 Backlog
+- acls i.e. allowed methods per user per uri
 - 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

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.11.1"
-  s.date              = "2008-03-24"
+  s.version           = "0.11.2"
+  s.date              = "2008-05-03"
   s.summary           = "An Open Web JSON Appliance."
   s.description       = "An Open Web JSON Appliance."
   s.authors           = ["Jon Crosby"]
@@ -77,9 +77,9 @@ Gem::Specification.new do |s|
   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', '>= 1.0'
   s.add_dependency 'uuid', '= 2.0.1'
   s.add_dependency 'oauth', '~> 0.3'
-  s.add_dependency 'ruby-openid', '= 2.1.2'
-  s.add_dependency 'json', '= 1.1.3'
+  s.add_dependency 'ruby-openid', '~> 2.1'
+  s.add_dependency 'json', '~> 1.1'
 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.11.1):
+If you already have the gem, make sure you're running the latest version (0.11.2):
   <div class="code">
     $ gem list cloudkit<br/>
     cloudkit (0.10.0) &lt;-- need to upgrade<br/>
     $ gem update cloudkit<br/>
     $ gem list cloudkit<br/>
-    cloudkit (0.11.1, 0.10.0) &lt;-- 0.11.1 is now in the list
+    cloudkit (0.11.2, 0.10.0) &lt;-- 0.11.2 is now in the list
   </div>
 </p>
 
@@ -120,6 +120,7 @@ Let's move on, creating a note using <a href="http://tools.ietf.org/html/rfc2616
     $ curl -i -XPOST -d'{"title":"projects"}' http://localhost:9292/notes<br/>
     HTTP/1.1 201 Created<br/>
     Cache-Control: no-cache<br/>
+    Location: http://localhost:9292/notes/0dda06f0-b134-012b-a2d8-0017f2c62348<br/>
     Content-Type: application/json<br/>
     Content-Length: 159<br/><br/>
 
@@ -139,6 +140,7 @@ so that we can specify its location:
     $ curl -i -XPUT -d'{"title":"reminders"}' http://localhost:9292/notes/abc<br/>
     HTTP/1.1 201 Created<br/>
     Cache-Control: no-cache<br/>
+    Location: http://localhost:9292/notes/abc<br/>
     Content-Type: application/json<br/>
     Content-Length: 126<br/><br/>
 

data/doc/index.html

@@ -24,7 +24,7 @@
   </div>
   <div class="meta">
     <p class="wrapper">
-      Version 0.11.1 released with Tokyo Cabinet support. Install with <em>gem install cloudkit</em>.
+      Version 0.11.2 released with Tokyo Cabinet support. Install with <em>gem install cloudkit</em>.
     </p>
   </div>
   <div class="wrapper intro-row">

data/lib/cloudkit.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'erb'
 require 'json'
-require 'md5'
+require 'digest/md5'
 require 'openid'
 require 'time'
 require 'uuid'
@@ -34,7 +34,7 @@ require 'cloudkit/user_store'
 include CloudKit::Constants
 
 module CloudKit
-  VERSION = '0.11.1'
+  VERSION = '0.11.2'
 
   # Sets up the storage adapter. Defaults to development-time
   # CloudKit::MemoryTable. Also supports Rufus Tokyo Table instances. See the

data/lib/cloudkit/oauth_filter.rb

@@ -9,7 +9,7 @@ module CloudKit
   #   /oauth/authorized_request_tokens/{id}
   #   /oauth/access_tokens
   #
-  # Responds to the following URIs are part of OAuth Discovery:
+  # Responds to the following URIs as part of OAuth Discovery:
   #   /oauth
   #   /oauth/meta
   #

data/lib/cloudkit/openid_filter.rb

@@ -6,8 +6,17 @@ module CloudKit
   # The root URI, "/", is always bypassed. More URIs can also be bypassed using
   # the :allow option:
   #
+  #   use Rack::Session::Pool
   #   use OpenIDFilter, :allow => ['/foo', '/bar']
   #
+  # In addition to the :allow option, a block can also be used for more complex
+  # decisions:
+  #
+  #   use Rack::Session::Pool
+  #   use OpenIDFilter, :allow => ['/foo'] do |url|
+  #     bar(url) # some method returning true or false
+  #   end
+  #
   # Responds to the following URIs:
   #   /login
   #   /logout

data/lib/cloudkit/rack/builder.rb

@@ -4,7 +4,7 @@ module Rack #:nodoc:
 
     # Extends Rack::Builder's to_app method to detect if the last piece of
     # middleware in the stack is a CloudKit shortcut (contain or expose), adding
-    # adding a default developer page at the root and a 404 everywhere else.
+    # a default developer page at the root and a 404 everywhere else.
     def to_app
       default_app = lambda do |env|
         if (env['PATH_INFO'] == '/')

data/lib/cloudkit/request.rb

@@ -168,5 +168,10 @@ module CloudKit
     def flash
       session[CLOUDKIT_FLASH] ||= CloudKit::FlashSession.new
     end
+
+    # Return the host and scheme
+    def domain_root
+      "#{scheme}://#{@env['HTTP_HOST']}"
+    end
   end
 end

data/lib/cloudkit/service.rb

@@ -1,7 +1,7 @@
 module CloudKit
 
   # A CloudKit Service is Rack middleware providing a REST/HTTP 1.1 interface to
-  # a Store. Its primary purpose is initialize and adapt a Store for use in a
+  # a Store. Its primary purpose is to initialize and adapt a Store for use in a
   # Rack middleware stack.
   #
   # ==Examples
@@ -68,18 +68,22 @@ module CloudKit
       if tunnel_methods.include?(request['_method'].try(:upcase))
         return send(request['_method'].downcase, request)
       end
-      @store.post(
+      response = @store.post(
         request.uri,
         {:json => request.json}.filter_merge!(
-          :remote_user => request.current_user)).to_rack
+          :remote_user => request.current_user))
+      update_location_header(request, response)
+      response.to_rack
     end
 
     def put(request)
-      @store.put(
+      response = @store.put(
         request.uri,
         {:json => request.json}.filter_merge!(
           :remote_user => request.current_user,
-          :etag        => request.if_match)).to_rack
+          :etag        => request.if_match))
+      update_location_header(request, response)
+      response.to_rack
     end
 
     def delete(request)
@@ -114,21 +118,26 @@ module CloudKit
     end
 
     def versions_link_header(request)
-      base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{request.path_info}"
+      base_url = "#{request.domain_root}#{request.path_info}"
       "<#{base_url}/versions>; rel=\"http://joncrosby.me/cloudkit/1.0/rel/versions\""
     end
 
     def resolved_link_header(request)
-      base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{request.path_info}"
+      base_url = "#{request.domain_root}#{request.path_info}"
       "<#{base_url}/_resolved>; rel=\"http://joncrosby.me/cloudkit/1.0/rel/resolved\""
     end
 
     def index_link_header(request)
       index_path = request.path_info.sub(/\/_resolved(\/)*$/, '')
-      base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{index_path}"
+      base_url = "#{request.domain_root}#{index_path}"
       "<#{base_url}>; rel=\"index\""
     end
 
+    def update_location_header(request, response)
+      return unless response['Location']
+      response['Location'] = "#{request.domain_root}#{response['Location']}"
+    end
+
     def auth_missing?(request)
       request.current_user == nil
     end

data/lib/cloudkit/store.rb

@@ -117,7 +117,8 @@ module CloudKit
       return status_412 if resource.etag != options[:etag]
 
       resource.delete
-      return json_meta_response(200, resource.uri.string, resource.etag, resource.last_modified)
+      archived_resource = resource.previous_version
+      return json_meta_response(archived_resource.uri.string, archived_resource.etag, resource.last_modified)
     end
 
     # Build a response containing the allowed methods for a given URI.
@@ -276,7 +277,7 @@ module CloudKit
     def create_resource(uri, options)
       JSON.parse(options[:json]) rescue (return status_422)
       resource = CloudKit::Resource.create(uri, options[:json], options[:remote_user])
-      json_meta_response(201, resource.uri.string, resource.etag, resource.last_modified)
+      json_create_response(resource.uri.string, resource.etag, resource.last_modified)
     end
 
     # Update the resource at the specified URI. Requires the :etag option.
@@ -288,7 +289,7 @@ module CloudKit
       return etag_required unless options[:etag]
       return status_412    unless options[:etag] == resource.etag
       resource.update(options[:json])
-      return json_meta_response(200, uri.string, resource.etag, resource.last_modified)
+      return json_meta_response(uri.string, resource.etag, resource.last_modified)
     end
 
     # Bundle a collection of results as a list of URIs for the response.
@@ -337,7 +338,7 @@ module CloudKit
     # optimization for GETs. This method is used for collections of resources
     # where the optimization is not practical.
     def build_etag(data)
-      MD5::md5(data.to_s).hexdigest
+      Digest::MD5.hexdigest(data.to_s)
     end
 
     # Returns true if the collection type is valid for this Store.

data/lib/cloudkit/store/resource.rb

@@ -1,8 +1,8 @@
 module CloudKit
 
   # A CloudKit::Resource represents a "resource" in the REST/HTTP sense of the
-  # word. It encapsulates a JSON document and its metadata such as it URI, ETag,
-  # Last-Modified date, remote user, and its historical versions.
+  # word. It encapsulates a JSON document and its metadata such as its URI, ETag,
+  # Last-Modified date, remote user, and historical versions.
   class Resource
 
     attr_reader :uri, :etag, :last_modified, :json, :remote_user
@@ -60,7 +60,7 @@ module CloudKit
     end
 
     # Delete the given resource. This is a soft delete, archiving the previous
-    # resource and inserted a deleted resource placeholder at the old URI.
+    # resource and inserting a deleted resource placeholder at the old URI.
     # Raises HistoricalIntegrityViolation for attempts to delete resources that
     # are not current.
     def delete

data/lib/cloudkit/store/response_helpers.rb

@@ -46,21 +46,32 @@ module CloudKit::ResponseHelpers
 
   def response(status, content='', etag=nil, last_modified=nil, options={})
     cache_control = options[:cache] == false ? 'no-cache' : 'proxy-revalidate'
-    headers = {
+    etag = "\"#{etag}\"" if etag
+    headers = {}.filter_merge!(
       'Content-Type'  => 'application/json',
-      'Cache-Control' =>  cache_control}
-    headers.merge!('ETag' => "\"#{etag}\"") if etag
-    headers.merge!('Last-Modified' => last_modified) if last_modified
+      'Cache-Control' =>  cache_control,
+      'Last-Modified' => last_modified,
+      'Location'      => options[:location],
+      'ETag'          => etag)
     CloudKit::Response.new(status, headers, content)
   end
 
-  def json_meta_response(status, uri, etag, last_modified)
-    json = JSON.generate(
+  def json_meta_response(uri, etag, last_modified)
+    json = json_metadata(uri, etag, last_modified)
+    response(200, json, nil, nil, :cache => false)
+  end
+
+  def json_create_response(uri, etag, last_modified)
+    json = json_metadata(uri, etag, last_modified)
+    response(201, json, nil, nil, {:cache => false, :location => uri})
+  end
+
+  def json_metadata(uri, etag, last_modified)
+    JSON.generate(
       :ok            => true,
       :uri           => uri,
       :etag          => etag,
       :last_modified => last_modified)
-    response(status, json, nil, nil, :cache => false)
   end
 
   def json_error(message)

data/lib/cloudkit/uri.rb

@@ -1,6 +1,6 @@
 module CloudKit
 
-  # A CloudKit::URI wraps a URI string, added methods useful for routing
+  # A CloudKit::URI wraps a URI string, adding methods useful for routing
   # in CloudKit as well as caching URI components for future comparisons.
   class URI
 
@@ -42,7 +42,7 @@ module CloudKit
 
     # Returns true if URI matches /{collection}
     def resource_collection_uri?
-      return components.size == 1
+      return components.size == 1 && components[0] != 'cloudkit-meta'
     end
 
     # Returns true if URI matches /{collection}/_resolved

data/spec/flash_session_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe "A FlashSession" do
 
-  setup do
+  before do
     @flash = CloudKit::FlashSession.new
   end
 

data/spec/openid_filter_spec.rb

@@ -34,6 +34,8 @@ describe "An OpenIDFilter" do
     request = Rack::MockRequest.new(openid_app)
     response = request.get('/bar')
     response.status.should == 200
+    response = request.get('/foo')
+    response.status.should == 200
   end
 
   it "should redirect to the login page if authorization is required" do

data/spec/request_spec.rb

@@ -182,4 +182,10 @@ describe "A Request" do
     request.last_path_element.should == 'def'
   end
 
+  it "should know its domain root" do
+    request = CloudKit::Request.new(Rack::MockRequest.env_for(
+      '/', 'HTTP_HOST' => 'example.com'))
+    request.domain_root.should == "http://example.com"
+  end
+
 end

data/spec/service_spec.rb

@@ -570,7 +570,7 @@ describe "A CloudKit::Service" do
       before(:each) do
         json = JSON.generate(:this => 'that')
         @response = @request.post(
-          '/items', {:input => json}.merge(VALID_TEST_AUTH))
+          '/items', {:input => json, 'HTTP_HOST' => 'example.org'}.merge(VALID_TEST_AUTH))
         @body = JSON.parse(@response.body)
       end
 
@@ -600,6 +600,10 @@ describe "A CloudKit::Service" do
         @response['Last-Modified'].should be_nil
       end
 
+      it "should return a Location header" do
+        @response['Location'].should match(/http:\/\/example.org#{@body['uri']}/)
+      end
+
       it "should return a 422 if parsing fails" do
         response = @request.post('/items', {:input => 'fail'}.merge(VALID_TEST_AUTH))
         response.status.should == 422
@@ -607,7 +611,7 @@ describe "A CloudKit::Service" do
 
     end
 
-    describe "on PUT /:collection/:id" do 
+    describe "on PUT /:collection/:id" do
 
       before(:each) do
         json = JSON.generate(:this => 'that')
@@ -626,11 +630,15 @@ describe "A CloudKit::Service" do
       it "should create a document if it does not already exist" do
         json = JSON.generate(:this => 'thing')
         response = @request.put(
-          '/items/xyz', {:input => json}.merge(VALID_TEST_AUTH))
+          '/items/xyz', {
+            :input      => json,
+            'HTTP_HOST' => 'example.org'}.merge(VALID_TEST_AUTH))
         response.status.should == 201
         result = @request.get('/items/xyz', VALID_TEST_AUTH)
         result.status.should == 200
-        JSON.parse(result.body)['this'].should == 'thing'
+        parsed_json = JSON.parse(result.body)['this']
+        parsed_json.should == 'thing'
+        response['Location'].should match(/http:\/\/example.org#{parsed_json['uri']}/)
       end
 
       it "should not create new resources using deleted resource URIs" do
@@ -782,6 +790,24 @@ describe "A CloudKit::Service" do
         json.keys.sort.should == ['etag', 'last_modified', 'ok', 'uri']
       end
 
+      it "should use the archived URI in the JSON result" do
+        response = @request.delete(
+          '/items/abc',
+          'HTTP_IF_MATCH' => @etag,
+          CLOUDKIT_AUTH_KEY => TEST_REMOTE_USER)
+        json = JSON.parse(response.body)
+        json['uri'].should match(/\/items\/abc\/versions\/.+/)
+      end
+
+      it "should not change the ETag for the archived version" do
+        response = @request.delete(
+          '/items/abc',
+          'HTTP_IF_MATCH' => @etag,
+          CLOUDKIT_AUTH_KEY => TEST_REMOTE_USER)
+        json = JSON.parse(response.body)
+        json['etag'].should == @etag
+      end
+
       it "should set the Content-Type header" do
         response = @request.delete(
           '/items/abc',

data/spec/uri_spec.rb

@@ -36,7 +36,7 @@ describe "A URI" do
   end
 
   it "should know if it is a resource collection URI" do
-    ['/items/123', '/items/123/versions', '/items/123/versions/abc'].each { |uri|
+    ['/cloudkit-meta', '/items/123', '/items/123/versions', '/items/123/versions/abc'].each { |uri|
       CloudKit::URI.new(uri).should_not be_resource_collection_uri
     }
     CloudKit::URI.new('/items').should be_resource_collection_uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cloudkit
 version: !ruby/object:Gem::Version 
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors: 
 - Jon Crosby
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-24 00:00:00 -07:00
+date: 2008-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.9"
+        version: "1.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: uuid
@@ -48,9 +48,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.1.2
+        version: "2.1"
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -58,9 +58,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.1.3
+        version: "1.1"
     version: 
 description: An Open Web JSON Appliance.
 email: jon@joncrosby.me