cloudkit 0.9.1 → 0.10.0

data/doc/index.html

@@ -24,7 +24,7 @@
   </div>
   <div class="meta">
     <p class="wrapper">
-      Version 0.9.1 released. Install with <em>gem install cloudkit</em>.
+      Version 0.10.0 <a href="http://blog.joncrosby.me">released</a>. Install with <em>gem install cloudkit</em>.
     </p>
   </div>
   <div class="wrapper intro-row">

data/doc/rest-api.html

@@ -107,6 +107,59 @@
   <span class="definition">uri-list:</span> an array of document URIs within the given collection. If less than the total available are supplied in the uris element, additional requests can be made, specifying the offset and limit query parameters. Future versions of CloudKit may page result sets to optimize performance.
 </p>
 
+<div class="uri-template">
+  GET /%collection%/_resolved
+</div>
+<p>
+  List the objects and metadata contained within a collection. This effectively provides the
+  same result as first listing the URIs using GET /%collection% followed by
+  performing a GET /%collection%/%uuid% for each URI.
+</p>
+
+<p>
+  <span class="spec-header">URI Variables:</span><br/>
+  <span class="definition">collection:</span> a named collection of JSON documents.
+</p>
+
+<p>
+  <span class="spec-header">Optional Query Parameters:</span><br/>
+  <span class="definition">offset:</span> 0-based starting index for the list of results. Default is 0.<br/>
+  <span class="definition">limit:</span>  maximum number of results to return. Default is undefined, meaning unlimited.
+</p>
+
+<p>
+  <span class="spec-header">Response:</span><br/>
+  {<br/>
+    "total":%total-results%,<br/>
+    "offset":%offset-value%,<br/>
+    "documents":[%document-list%]<br/>
+  }
+</p>
+
+<p>
+  <span class="spec-header">Response Variables:</span><br/>
+  <span class="definition">total-results:</span> the total number of available results in the complete set, calculated prior applying any provided limits.<br/>
+  <span class="definition">offset-value:</span> integer representing the offset.<br/>
+  <span class="definition">document-list:</span> an array of documents and their metadata within the given collection. If less than the total available are supplied in the documents element, additional requests can be made, specifying the offset and limit query parameters. Future versions of CloudKit may page result sets to optimize performance.
+</p>
+
+<p>
+  <span class="spec-header">Document:</span><br/>
+  {<br/>
+    "etag":%etag%,<br/>
+    "last_modified":%last-modified%,<br/>
+    "uri":%uri-value%,<br/>
+    "document":%json-document%<br/>
+  }
+</p>
+
+<p>
+  <span class="spec-header">Document Variables:</span><br/>
+  <span class="definition">etag:</span> the value of the ETag normally returned in a response header when requesting the individual document.<br/>
+  <span class="definition">last-modified:</span> the value of the Last-Modified timestamp normally returned in a response header when requesting the individual document.<br/>
+  <span class="definition">uri-value:</span> the URI for the individual document relative to the service root.<br/>
+  <span class="definition">json-document:</span> a valid JSON document.
+</p>
 
 <div class="uri-template">
   GET /%collection%/%uuid%
@@ -167,6 +220,62 @@
   <span class="definition">uri-list:</span> an array of document URIs within the given collection. If less than the total available are supplied in the uris element, additional requests can be made, specifying the offset and limit query parameters. Future versions of CloudKit may page result sets to optimize performance.
 </p>
 
+<div class="uri-template">
+  GET /%collection%/%uuid%/versions/_resolved
+</div>
+<p>
+  List the objects and metadata contained within a collection of document versions.
+  This effectively provides the same result as first listing the URIs using
+  GET /%collection%/%uuid%/versions followed by performing a
+  GET /%collection%/%uuid%/versions/%etag% for each URI.
+</p>
+
+<p>
+  <span class="spec-header">URI Variables:</span><br/>
+  <span class="definition">collection:</span> a named collection of documents.<br/>
+  <span class="definition">uuid:</span> the unique key for a JSON document.
+</p>
+
+<p>
+  <span class="spec-header">Optional Query Parameters:</span><br/>
+  <span class="definition">offset:</span> 0-based starting index for the list of results. Default is 0.<br/>
+  <span class="definition">limit:</span> maximum number of results to return. Default is undefined, meaning unlimited.
+</p>
+
+<p>
+  <span class="spec-header">Response:</span><br/>
+  {<br/>
+    "total":%total-results%,<br/>
+    "offset":%offset-value%,<br/>
+    "documents":[%document-list%]<br/>
+  }
+</p>
+
+<p>
+  <span class="spec-header">Response Variables:</span><br/>
+  <span class="definition">total-results:</span> the total number of available results in the complete set, calculated prior applying any provided limits.<br/>
+  <span class="definition">offset-value:</span> integer representing the offset.<br/>
+  <span class="definition">document-list:</span> an array of documents and their metadata within the given collection. If less than the total available are supplied in the documents element, additional requests can be made, specifying the offset and limit query parameters. Future versions of CloudKit may page result sets to optimize performance.
+</p>
+
+<p>
+  <span class="spec-header">Document:</span><br/>
+  {<br/>
+    "etag":%etag%,<br/>
+    "last_modified":%last-modified%,<br/>
+    "uri":%uri-value%,<br/>
+    "document":%json-document%<br/>
+  }
+</p>
+
+<p>
+  <span class="spec-header">Document Variables:</span><br/>
+  <span class="definition">etag:</span> the value of the ETag normally returned in a response header when requesting the individual document.<br/>
+  <span class="definition">last-modified:</span> the value of the Last-Modified timestamp normally returned in a response header when requesting the individual document.<br/>
+  <span class="definition">uri-value:</span> the URI for the individual document relative to the service root.<br/>
+  <span class="definition">json-document:</span> a valid JSON document.
+</p>
+
 <div class="uri-template">
   GET /%collection%/%uuid%/versions/%etag%
 </div>

data/examples/3.ru

@@ -3,4 +3,4 @@ require 'cloudkit'
 use Rack::Session::Pool
 use CloudKit::OpenIDFilter
 use CloudKit::Service, :collections => [:notes]
-run lambda{|env| [200, {'Content-Type' => 'text/html'}, ['HELLO']]}
+run lambda{|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => '5'}, ['HELLO']]}

data/examples/4.ru

@@ -2,4 +2,4 @@ $:.unshift File.expand_path(File.dirname(__FILE__)) + '/../lib'
 require 'cloudkit'
 use CloudKit::OAuthFilter
 use CloudKit::Service, :collections => [:notes]
-run lambda{|env| [200, {'Content-Type' => 'text/html'}, ['HELLO']]}
+run lambda{|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => '5'}, ['HELLO']]}

data/examples/5.ru

@@ -1,10 +1,10 @@
 $:.unshift File.expand_path(File.dirname(__FILE__)) + '/../lib'
 require 'cloudkit'
 use Rack::Config do |env|
-  env['cloudkit.storage.uri'] = 'sqlite://example.db'
+  env[CLOUDKIT_STORAGE_URI] = 'sqlite://example.db'
 end
 use Rack::Session::Pool
 use CloudKit::OAuthFilter
 use CloudKit::OpenIDFilter
 use CloudKit::Service, :collections => [:notes]
-run lambda{|env| [200, {'Content-Type' => 'text/html'}, ['HELLO']]}
+run lambda{|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => '5'}, ['HELLO']]}

data/examples/6.ru

@@ -1,10 +1,10 @@
 $:.unshift File.expand_path(File.dirname(__FILE__)) + '/../lib'
 require 'cloudkit'
 use Rack::Config do |env|
-  env['cloudkit.storage.uri'] = 'mysql://user:pass@localhost/cloudkit_example'
+  env[CLOUDKIT_STORAGE_URI] = 'mysql://user:pass@localhost/cloudkit_example'
 end
 use Rack::Session::Pool
 use CloudKit::OAuthFilter
 use CloudKit::OpenIDFilter
 use CloudKit::Service, :collections => [:notes]
-run lambda{|env| [200, {'Content-Type' => 'text/html'}, ['HELLO']]}
+run lambda{|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => '5'}, ['HELLO']]}

data/lib/cloudkit.rb

@@ -14,6 +14,7 @@ require 'oauth/consumer'
 require 'oauth/request_proxy/rack_request'
 require 'oauth/server'
 require 'oauth/signature'
+require 'cloudkit/constants'
 require 'cloudkit/util'
 require 'cloudkit/store/adapter'
 require 'cloudkit/store/extraction_view'
@@ -27,12 +28,17 @@ require 'cloudkit/oauth_store'
 require 'cloudkit/openid_filter'
 require 'cloudkit/openid_store'
 require 'cloudkit/rack/builder'
-require 'cloudkit/rack/lint'
 require 'cloudkit/rack/router'
 require 'cloudkit/request'
 require 'cloudkit/service'
 require 'cloudkit/user_store'
 
+include CloudKit::Constants
+
+module CloudKit
+  VERSION = '0.10.0'
+end
+
 class Object
 
   # Execute a method if it exists.

data/lib/cloudkit/constants.rb

@@ -0,0 +1,40 @@
+module CloudKit
+  module Constants
+
+    # The key used to store the authenticated user.
+    CLOUDKIT_AUTH_KEY = 'cloudkit.user'.freeze
+
+    # The key used to indicate the presence of auth in a stack.
+    CLOUDKIT_AUTH_PRESENCE = 'cloudkit.auth'.freeze
+
+    # The key used to store auth challenge headers shared between
+    # OpenID and OAuth middleware.
+    CLOUDKIT_AUTH_CHALLENGE = 'cloudkit.challenge'.freeze
+
+    # The 'via' key used to announce and track upstream middleware.
+    CLOUDKIT_VIA = 'cloudkit.via'.freeze
+
+    # The key used to store the 'flash' in the session.
+    CLOUDKIT_FLASH = 'cloudkit.flash'.freeze
+
+    # The 'via' key for the OAuth filter.
+    CLOUDKIT_OAUTH_FILTER_KEY = 'cloudkit.filter.oauth'.freeze
+
+    # 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
+
+    # 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/oauth_filter.rb

@@ -31,11 +31,11 @@ module CloudKit
 
     def call(env)
       @@lock.synchronize do
-        @@store = OAuthStore.new(env[storage_uri_key])
+        @@store = OAuthStore.new(env[CLOUDKIT_STORAGE_URI])
       end unless @@store
 
       request = Request.new(env)
-      request.announce_auth(oauth_filter_key)
+      request.announce_auth(CLOUDKIT_OAUTH_FILTER_KEY)
       return xrds_location(request) if oauth_disco_draft2_xrds?(request)
       return @app.call(env) if request.path_info == '/'
 
@@ -99,7 +99,7 @@ module CloudKit
       @@store.put(
         "/cloudkit_oauth_request_tokens/#{token_id}",
         :json => request_token)
-      [201, {'Content-Type' => 'text/html'}, ["oauth_token=#{token_id}&oauth_token_secret=#{secret}"]]
+      Rack::Response.new("oauth_token=#{token_id}&oauth_token_secret=#{secret}", 201).finish
     end
 
     def request_authorization(request)
@@ -186,7 +186,7 @@ module CloudKit
       @@store.delete(
         "/cloudkit_oauth_request_tokens/#{request[:oauth_token]}",
         :etag => request_token_response.etag)
-      [201, {'Content-Type' => 'text/html'}, ["oauth_token=#{token_id}&oauth_token_secret=#{secret}"]]
+      Rack::Response.new("oauth_token=#{token_id}&oauth_token_secret=#{secret}", 201).finish
     end
 
     def inject_user_or_challenge(request)
@@ -222,11 +222,11 @@ module CloudKit
     end
 
     def inject_challenge(request)
-      request.env[challenge_key] = challenge_headers(request)
+      request.env[CLOUDKIT_AUTH_CHALLENGE] = challenge_headers(request)
     end
 
-    def challenge(request, message)
-      [401, challenge_headers(request), [message || '']]
+    def challenge(request, message='')
+      Rack::Response.new(message, 401, challenge_headers(request)).finish
     end
 
     def challenge_headers(request)
@@ -243,7 +243,7 @@ module CloudKit
 
     def login_redirect(request)
       request.session['return_to'] = request.url if request.session
-      [302, {'Location' => request.login_url, 'Content-Type' => 'text/html'}, []]
+      Rack::Response.new([], 302, {'Location' => request.login_url}).finish
     end
 
     def load_user_from_session(request)
@@ -264,7 +264,7 @@ module CloudKit
 
     def xrds_location(request)
       # Current OAuth Discovery Draft 2 / XRDS-Simple 1.0, Section 5.1.2
-      [200, {'X-XRDS-Location' => "#{request.scheme}://#{request.env['HTTP_HOST']}/oauth"}, []]
+      Rack::Response.new([], 200, {'X-XRDS-Location' => "#{request.scheme}://#{request.env['HTTP_HOST']}/oauth"}).finish
     end
 
     def get_descriptor(request)

data/lib/cloudkit/oauth_store.rb

@@ -1,5 +1,5 @@
 module CloudKit
-  
+
   # An OAuthStore is a thin abstraction around CloudKit::Store, providing
   # consistent collection names, and allowing automatic migrations in later
   # releases if needed.
@@ -35,10 +35,6 @@ module CloudKit
       @@store.delete(uri, options)
     end
 
-    def resolve_uris(uris) #:nodoc:
-      @@store.resolve_uris(uris)
-    end
-    
     def reset! #:nodoc:
       @@store.reset!
     end

data/lib/cloudkit/openid_filter.rb

@@ -20,13 +20,13 @@ module CloudKit
 
     def call(env)
       @@lock.synchronize do
-        @@store = OpenIDStore.new(env[storage_uri_key])
-        @users  = UserStore.new(env[storage_uri_key])
+        @@store = OpenIDStore.new(env[CLOUDKIT_STORAGE_URI])
+        @users  = UserStore.new(env[CLOUDKIT_STORAGE_URI])
         @@store.get_association('x') rescue nil # refresh sqlite3
       end unless @@store
 
       request = Request.new(env)
-      request.announce_auth(openid_filter_key)
+      request.announce_auth(CLOUDKIT_OPENID_FILTER_KEY)
 
       case request
       when r(:get, request.login_url); request_login(request)
@@ -37,18 +37,18 @@ module CloudKit
         if (root_request?(request) || valid_auth_key?(request) || logged_in?(request))
           @app.call(env)
         else
-          if request.env[challenge_key]
+          if request.env[CLOUDKIT_AUTH_CHALLENGE]
             store_location(request)
             erb(
               request,
               :openid_login,
-              request.env[challenge_key].merge('Content-Type' => 'text/html'),
+              request.env[CLOUDKIT_AUTH_CHALLENGE].merge('Content-Type' => 'text/html'),
               401)
-          elsif !request.via.include?(oauth_filter_key)
+          elsif !request.via.include?(CLOUDKIT_OAUTH_FILTER_KEY)
             store_location(request)
             login_redirect(request)
           else
-            [500, {}, ['server misconfigured']]
+            Rack::Response.new('server misconfigured', 500).finish
           end
         end
       end
@@ -63,7 +63,7 @@ module CloudKit
       json = JSON.generate(user)
       @users.put(user_uri, :etag => result.etag, :json => json)
 
-      request.env[auth_key] = nil
+      request.env[CLOUDKIT_AUTH_KEY] = nil
       request.flash['info'] = 'You have been logged out.'
       response = Rack::Response.new(
         [],
@@ -86,7 +86,7 @@ module CloudKit
       end
 
       redirect_url = response.redirect_url(base_url(request), full_url(request))
-      [302, {'Location' => redirect_url, 'Content-Type' => 'text/html'}, []]
+      Rack::Response.new([], 302, {'Location' => redirect_url}).finish
     end
 
     def complete_openid_login(request)
@@ -142,7 +142,7 @@ module CloudKit
     end
 
     def login_redirect(request)
-      [302, {'Location' => request.login_url, 'Content-Type' => 'text/html'}, []]
+      Rack::Response.new([], 302, {'Location' => request.login_url}).finish
     end
 
     def base_url(request)
@@ -172,7 +172,7 @@ module CloudKit
     end
 
     def valid_auth_key?(request)
-      request.env[auth_key] && request.env[auth_key] != ''
+      request.env[CLOUDKIT_AUTH_KEY] && request.env[CLOUDKIT_AUTH_KEY] != ''
     end
 
     def openid_consumer(request)

data/lib/cloudkit/rack/builder.rb

@@ -8,9 +8,9 @@ module Rack #:nodoc:
     def to_app
       default_app = lambda do |env|
         if (env['PATH_INFO'] == '/')
-          [200, {'Content-Type' => 'text/html'}, [welcome]]
+          Rack::Response.new(welcome).finish
         else
-          [404, {'Content-Type' => 'text/html'}, []]
+          Rack::Response.new('not found', 404).finish
         end
       end
       @ins << default_app if @last_cloudkit_id == @ins.last.object_id
@@ -51,7 +51,7 @@ doc = <<HTML
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-  <title>CloudKit via cURL</title>
+  <title>CloudKit</title>
   <style type="text/css">
     body {
       font-family: 'Helvetica', 'Arial', san-serif;

data/lib/cloudkit/request.rb

@@ -14,6 +14,12 @@ module CloudKit
       @cloudkit_params ||= cloudkit_params.merge(oauth_header_params)
     end
 
+    # Return the JSON content from the request body
+    def json
+      self.body.rewind
+      self.body.read
+    end
+
     # Return true if method, path, and required_params match.
     def match?(method, path, required_params=[])
       (request_method == method) &&
@@ -78,7 +84,7 @@ module CloudKit
     # not use the header because the transition from one piece of middleware to
     # the next does not use HTTP.
     def via
-      @env[via_key].split(', ') rescue []
+      @env[CLOUDKIT_VIA].split(', ') rescue []
     end
 
     # Return parsed contents of an If-Match header.
@@ -99,29 +105,29 @@ module CloudKit
     # Add a via entry to the Rack environment.
     def inject_via(key)
       items = via << key
-      @env[via_key] = items.join(', ')
+      @env[CLOUDKIT_VIA] = items.join(', ')
     end
 
     # Return the current user URI.
     def current_user
-      return nil unless @env[auth_key] && @env[auth_key] != ''
-      @env[auth_key]
+      return nil unless @env[CLOUDKIT_AUTH_KEY] && @env[CLOUDKIT_AUTH_KEY] != ''
+      @env[CLOUDKIT_AUTH_KEY]
     end
 
     # Set the current user URI.
     def current_user=(user)
-      @env[auth_key] = user
+      @env[CLOUDKIT_AUTH_KEY] = user
     end
 
     # Return true if authentication is being used.
     def using_auth?
-      @env[auth_presence_key] != nil
+      @env[CLOUDKIT_AUTH_PRESENCE] != nil
     end
 
     # Report to downstream middleware that authentication is in use.
     def announce_auth(via)
       inject_via(via)
-      @env[auth_presence_key] = 1
+      @env[CLOUDKIT_AUTH_PRESENCE] = 1
     end
 
     # Return the session associated with this request.
@@ -133,27 +139,27 @@ module CloudKit
     # environment so the OpenID and OAuth middleware can cooperate during the
     # token authorization step in the OAuth flow.
     def login_url
-      @env[login_url_key] || '/login'
+      @env[CLOUDKIT_LOGIN_URL] || '/login'
     end
 
     # Set the login url for this request.
     def login_url=(url)
-      @env[login_url_key] = url
+      @env[CLOUDKIT_LOGIN_URL] = url
     end
 
     # Return the logout URL for this request.
     def logout_url
-      @env[logout_url_key] || '/logout'
+      @env[CLOUDKIT_LOGOUT_URL] || '/logout'
     end
 
     # Set the logout URL for this request.
     def logout_url=(url)
-      @env[logout_url_key] = url
+      @env[CLOUDKIT_LOGOUT_URL] = url
     end
 
     # Return the flash session for this request.
     def flash
-      session[flash_key] ||= CloudKit::FlashSession.new
+      session[CLOUDKIT_FLASH] ||= CloudKit::FlashSession.new
     end
   end
 end