cloudkit 0.9.1 → 0.10.0

data/lib/cloudkit/service.rb

@@ -20,12 +20,11 @@ module CloudKit
   #   use CloudKit::OAuthFilter
   #   use CloudKit::OpenIDFilter
   #   use CloudKit::Service, :collections => [:items, :things]
-  #   run lambda{|env| [200, {}, ['Hello']]}
+  #   run lambda{|env| [200, {'Content-Type' => 'text/html'}, ['Hello']]}
   #
   # For more examples, including the use of different storage implementations,
   # see the Table of Contents in the examples directory.
   class Service
-    include Util
     include ResponseHelpers
 
     @@lock = Mutex.new
@@ -38,7 +37,7 @@ module CloudKit
     def call(env)
       @@lock.synchronize do
         @store = Store.new(
-          :adapter     => SQLAdapter.new(env[storage_uri_key]),
+          :adapter     => SQLAdapter.new(env[CLOUDKIT_STORAGE_URI]),
           :collections => @collections)
       end unless @store
 
@@ -61,7 +60,7 @@ module CloudKit
           :remote_user => request.current_user,
           :offset      => request['offset'],
           :limit       => request['limit']))
-      response['Link'] = link_header(request) if @store.resource_uri?(request.path_info)
+      inject_link_headers(request, response)
       response.to_rack
     end
 
@@ -71,14 +70,14 @@ module CloudKit
       end
       @store.post(
         request.path_info,
-        {:json => request.body.string}.filter_merge!(
+        {:json => request.json}.filter_merge!(
           :remote_user => request.current_user)).to_rack
     end
 
     def put(request)
       @store.put(
         request.path_info,
-        {:json => request.body.string}.filter_merge!(
+        {:json => request.json}.filter_merge!(
           :remote_user => request.current_user,
           :etag        => request.if_match)).to_rack
     end
@@ -98,7 +97,7 @@ module CloudKit
           :remote_user => request.current_user,
           :offset      => request['offset'],
           :limit       => request['limit']))
-      response['Link'] = link_header(request) if @store.resource_uri?(request.path_info)
+      inject_link_headers(request, response)
       response.to_rack
     end
 
@@ -106,11 +105,30 @@ module CloudKit
       @store.options(request.path_info).to_rack
     end
 
-    def link_header(request)
+    def inject_link_headers(request, response)
+      response['Link'] = versions_link_header(request) if @store.resource_uri?(request.path_info)
+      response['Link'] = resolved_link_header(request) if @store.resource_collection_uri?(request.path_info)
+      response['Link'] = index_link_header(request)    if @store.resolved_resource_collection_uri?(request.path_info)
+      response['Link'] = resolved_link_header(request) if @store.version_collection_uri?(request.path_info)
+      response['Link'] = index_link_header(request)    if @store.resolved_version_collection_uri?(request.path_info)
+    end
+
+    def versions_link_header(request)
       base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{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}/_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}>; rel=\"index\""
+    end
+
     def auth_missing?(request)
       request.current_user == nil
     end

data/lib/cloudkit/store.rb

@@ -2,7 +2,6 @@ module CloudKit
 
   # A functional storage interface with HTTP semantics and pluggable adapters.
   class Store
-    include CloudKit::Util
     include ResponseHelpers
 
     # Initialize a new Store, creating its schema if needed. All resources in a
@@ -51,8 +50,10 @@ module CloudKit
     # ===URI Types
     #   /cloudkit-meta
     #   /{collection}
+    #   /{collection}/_resolved
     #   /{collection}/{uuid}
     #   /{collection}/{uuid}/versions
+    #   /{collection}/{uuid}/versions/_resolved
     #   /{collection}/{uuid}/versions/{etag}
     #   /{view}
     #
@@ -69,13 +70,15 @@ module CloudKit
     # See also: {REST API}[http://getcloudkit.com/rest-api.html]
     #
     def get(uri, options={})
-      return invalid_entity_type               if !valid_collection_type?(collection_type(uri))
-      return meta                              if meta_uri?(uri)
-      return resource_collection(uri, options) if resource_collection_uri?(uri)
-      return resource(uri, options)            if resource_uri?(uri)
-      return version_collection(uri, options)  if version_collection_uri?(uri)
-      return resource_version(uri, options)    if resource_version_uri?(uri)
-      return view(uri, options)                if view_uri?(uri)
+      return invalid_entity_type                        if !valid_collection_type?(collection_type(uri))
+      return meta                                       if meta_uri?(uri)
+      return resource_collection(uri, options)          if resource_collection_uri?(uri)
+      return resolved_resource_collection(uri, options) if resolved_resource_collection_uri?(uri)
+      return resource(uri, options)                     if resource_uri?(uri)
+      return version_collection(uri, options)           if version_collection_uri?(uri)
+      return resolved_version_collection(uri, options)  if resolved_version_collection_uri?(uri)
+      return resource_version(uri, options)             if resource_version_uri?(uri)
+      return view(uri, options)                         if view_uri?(uri)
       status_404
     end
 
@@ -88,7 +91,7 @@ module CloudKit
       if resource_uri?(uri) || resource_version_uri?(uri)
         # ETag and Last-Modified are already stored for single items, so a slight
         # optimization can be made for HEAD requests.
-        result = @db[store_key].
+        result = @db[CLOUDKIT_STORE].
           select(:etag, :last_modified, :deleted).
           filter(options.merge(:uri => uri))
         if result.any?
@@ -130,7 +133,7 @@ module CloudKit
       return status_405(methods) unless methods.include?('DELETE')
       return invalid_entity_type unless @collections.include?(collection_type(uri))
       return etag_required       unless options[:etag]
-      original = @db[store_key].
+      original = @db[CLOUDKIT_STORE].
         filter(options.excluding(:etag).merge(:uri => uri))
       if original.any?
         item = original.first
@@ -141,7 +144,7 @@ module CloudKit
         @db.transaction do
           version_uri = "#{item[:uri]}/versions/#{item[:etag]}"
           original.update(:uri => version_uri)
-          @db[store_key].insert(
+          @db[CLOUDKIT_STORE].insert(
             :uri                  => item[:uri],
             :collection_reference => item[:collection_reference],
             :resource_reference   => item[:resource_reference],
@@ -161,19 +164,15 @@ module CloudKit
       allow(methods)
     end
 
-    # Return a list of allowed methods for a given URI. 
+    # Return a list of allowed methods for a given URI.
     def methods_for_uri(uri)
-      if meta_uri?(uri)
-        meta_methods
-      elsif resource_collection_uri?(uri)
-        resource_collection_methods
-      elsif resource_uri?(uri)
-        resource_methods
-      elsif version_collection_uri?(uri)
-        version_collection_methods
-      elsif resource_version_uri?(uri)
-        resource_version_methods
-      end
+      return meta_methods                         if meta_uri?(uri)
+      return resource_collection_methods          if resource_collection_uri?(uri)
+      return resolved_resource_collection_methods if resolved_resource_collection_uri?(uri)
+      return resource_methods                     if resource_uri?(uri)
+      return version_collection_methods           if version_collection_uri?(uri)
+      return resolved_version_collection_methods  if resolved_version_collection_uri?(uri)
+      return resource_version_methods             if resource_version_uri?(uri)
     end
 
     # Return the list of methods allowed for the cloudkit-meta URI.
@@ -186,6 +185,11 @@ module CloudKit
       @resource_collection_methods ||= http_methods.excluding('PUT', 'DELETE')
     end
 
+    # Return the list of methods allowed on a resolved resource collection.
+    def resolved_resource_collection_methods
+      @resolved_resource_collection_methods ||= http_methods.excluding('POST', 'PUT', 'DELETE')
+    end
+
     # Return the list of methods allowed on an individual resource.
     def resource_methods
       @resource_methods ||= http_methods.excluding('POST')
@@ -196,6 +200,11 @@ module CloudKit
       @version_collection_methods ||= http_methods.excluding('POST', 'PUT', 'DELETE')
     end
 
+    # Return the list of methods allowed on a resolved version history collection.
+    def resolved_version_collection_methods
+      @resolved_version_collection_methods ||= http_methods.excluding('POST', 'PUT', 'DELETE')
+    end
+
     # Return the list of methods allowed on a resource version.
     def resource_version_methods
       @resource_version_methods ||= http_methods.excluding('POST', 'PUT', 'DELETE')
@@ -246,10 +255,16 @@ module CloudKit
       return c.size == 1 && @collections.include?(c[0].to_sym)
     end
 
+    # Returns true if URI matches /{collection}/_resolved
+    def resolved_resource_collection_uri?(uri)
+      c = uri_components(uri)
+      return c.size == 2 && @collections.include?(c[0].to_sym) && c[1] == '_resolved'
+    end
+
     # Returns true if URI matches /{collection}/{uuid}
     def resource_uri?(uri)
       c = uri_components(uri)
-      return c.size == 2 && @collections.include?(c[0].to_sym)
+      return c.size == 2 && @collections.include?(c[0].to_sym) && c[1] != '_resolved'
     end
 
     # Returns true if URI matches /{collection}/{uuid}/versions
@@ -258,10 +273,16 @@ module CloudKit
       return c.size == 3 && @collections.include?(c[0].to_sym) && c[2] == 'versions'
     end
 
+    # Returns true if URI matches /{collection}/{uuid}/versions/_resolved
+    def resolved_version_collection_uri?(uri)
+      c = uri_components(uri)
+      return c.size == 4 && @collections.include?(c[0].to_sym) && c[2] == 'versions' && c[3] == '_resolved'
+    end
+
     # Returns true if URI matches /{collection}/{uuid}/versions/{etag}
     def resource_version_uri?(uri)
       c = uri_components(uri)
-      return c.size == 4 && @collections.include?(c[0].to_sym) && c[2] == 'versions'
+      return c.size == 4 && @collections.include?(c[0].to_sym) && c[2] == 'versions' && c[3] != '_resolved'
     end
 
     # Returns true if URI matches /{view}
@@ -297,9 +318,10 @@ module CloudKit
       response(200, json, build_etag(json))
     end
 
-    # Return a list of resource URIs for the given collection URI.
+    # Return a list of resource URIs for the given collection URI. Sorted by
+    # Last-Modified date in descending order.
     def resource_collection(uri, options)
-      result = @db[store_key].
+      result = @db[CLOUDKIT_STORE].
         select(:uri, :last_modified).
         filter(options.excluding(:offset, :limit).merge(:deleted => false)).
         filter(:collection_reference => collection_uri_fragment(uri)).
@@ -308,10 +330,21 @@ module CloudKit
       bundle_collection_result(uri, options, result)
     end
 
+    # Return all documents and their associated metadata for the given
+    # collection URI.
+    def resolved_resource_collection(uri, options)
+      result = @db[CLOUDKIT_STORE].
+        filter(options.excluding(:offset, :limit).merge(:deleted => false)).
+        filter(:collection_reference => collection_uri_fragment(uri)).
+        filter('resource_reference = uri').
+        reverse_order(:id)
+      bundle_resolved_collection_result(uri, options, result)
+    end
+
     # Return the resource for the given URI. Return 404 if not found or if
     # protected and unauthorized, 410 if authorized but deleted.
     def resource(uri, options)
-      result = @db[store_key].
+      result = @db[CLOUDKIT_STORE].
         select(:content, :etag, :last_modified, :deleted).
         filter(options.merge!(:uri => uri))
       if result.any?
@@ -325,12 +358,12 @@ module CloudKit
     # Return a collection of URIs for all versions of a resource including the
     #current version. Sorted by Last-Modified date in descending order.
     def version_collection(uri, options)
-      found = @db[store_key].
+      found = @db[CLOUDKIT_STORE].
         select(:uri).
         filter(options.excluding(:offset, :limit).merge(
           :uri => current_resource_uri(uri)))
       return status_404 unless found.any?
-      result = @db[store_key].
+      result = @db[CLOUDKIT_STORE].
         select(:uri, :last_modified).
         filter(:resource_reference => current_resource_uri(uri)).
         filter(options.excluding(:offset, :limit).merge(:deleted => false)).
@@ -338,9 +371,25 @@ module CloudKit
       bundle_collection_result(uri, options, result)
     end
 
+    # Return all document versions and their associated metadata for a given
+    # resource including the current version. Sorted by Last-Modified date in
+    # descending order.
+    def resolved_version_collection(uri, options)
+      found = @db[CLOUDKIT_STORE].
+        select(:uri).
+        filter(options.excluding(:offset, :limit).merge(
+          :uri => current_resource_uri(uri)))
+      return status_404 unless found.any?
+      result = @db[CLOUDKIT_STORE].
+        filter(:resource_reference => current_resource_uri(uri)).
+        filter(options.excluding(:offset, :limit).merge(:deleted => false)).
+        reverse_order(:id)
+      bundle_resolved_collection_result(uri, options, result)
+    end
+
     # Return a specific version of a resource.
     def resource_version(uri, options)
-      result = @db[store_key].
+      result = @db[CLOUDKIT_STORE].
         select(:content, :etag, :last_modified).
         filter(options.merge(:uri => uri))
       return status_404 unless result.any?
@@ -362,7 +411,7 @@ module CloudKit
       data = JSON.parse(options[:json]) rescue (return status_422)
       etag = UUID.generate
       last_modified = timestamp
-      @db[store_key].insert(
+      @db[CLOUDKIT_STORE].insert(
         :uri                  => uri,
         :collection_reference => collection_uri_fragment(uri),
         :resource_reference   => uri,
@@ -377,7 +426,7 @@ module CloudKit
     # Update the resource at the specified URI. Requires the :etag option.
     def update_resource(uri, options)
       data = JSON.parse(options[:json]) rescue (return status_422)
-      original = @db[store_key].
+      original = @db[CLOUDKIT_STORE].
         filter(options.excluding(:json, :etag).merge(:uri => uri))
       if original.any?
         item = original.first
@@ -388,7 +437,7 @@ module CloudKit
         last_modified = timestamp
         @db.transaction do
           original.update(:uri => "#{uri}/versions/#{item[:etag]}")
-          @db[store_key].insert(
+          @db[CLOUDKIT_STORE].insert(
             :uri                  => uri,
             :collection_reference => item[:collection_reference],
             :resource_reference   => item[:resource_reference],
@@ -414,11 +463,37 @@ module CloudKit
       response(200, json, build_etag(json), last_modified)
     end
 
+    # Bundle a collection of results as a list of documents and the associated
+    # metadata (last_modified, uri, etag) that would have accompanied a response
+    # to their singular request.
+    def bundle_resolved_collection_result(uri, options, result)
+      total  = result.count
+      offset = options[:offset].try(:to_i) || 0
+      max    = options[:limit] ? offset + options[:limit].to_i : total
+      list   = result.all[offset...max]
+      json   = resource_list(list, total, offset)
+      last_modified = result.first[:last_modified] if result.any?
+      response(200, json, build_etag(json), last_modified)
+    end
+
     # Generate a JSON URI list.
     def uri_list(list, total, offset)
       JSON.generate(:total => total, :offset => offset, :uris => list)
     end
 
+    # Generate a JSON document list.
+    def resource_list(list, total, offset)
+      results = []
+      list.each do |resource|
+        results << {
+          :uri           => resource[:uri],
+          :etag          => resource[:etag],
+          :last_modified => resource[:last_modified],
+          :document      => resource[:content]}
+      end
+      JSON.generate(:total => total, :offset => offset, :documents => results)
+    end
+
     # Build an ETag for a collection. ETags are generated on write as an
     # optimization for GETs. This method is used for collections of resources
     # where the optimization is not practical.

data/lib/cloudkit/store/adapter.rb

@@ -2,7 +2,6 @@ module CloudKit
 
   # A common interface for pluggable storage adapters
   class Adapter
-    include Util
 
     # TODO extract from SQLAdapter
   end

data/lib/cloudkit/store/response.rb

@@ -23,6 +23,7 @@ module CloudKit
 
     # Translate to the standard Rack representation: [status, headers, content]
     def to_rack
+      meta['Content-Length'] = content.length.to_s
       [status, meta, [content]]
     end
 

data/lib/cloudkit/store/sql_adapter.rb

@@ -20,7 +20,7 @@ module CloudKit
 
     # Initialize the HTTP-oriented storage if it does not exist.
     def initialize_storage
-      @db.create_table store_key do
+      @db.create_table CLOUDKIT_STORE do
         primary_key :id
         varchar     :uri, :unique => true
         varchar     :etag
@@ -30,7 +30,7 @@ module CloudKit
         varchar     :remote_user
         text        :content
         boolean     :deleted, :default => false
-      end unless @db.table_exists?(store_key)
+      end unless @db.table_exists?(CLOUDKIT_STORE)
     end
   end
 end

data/lib/cloudkit/util.rb

@@ -8,7 +8,8 @@ module CloudKit
         'templates',
         "#{template.to_s}.erb"))
       template = ERB.new(template_file.read)
-      [status, headers, [template.result(binding)]]
+      result = template.result(binding)
+      Rack::Response.new(result, status, headers).finish
     end
 
     # Build a Rack::Router instance
@@ -20,41 +21,5 @@ module CloudKit
     def unquote(text)
       (text =~ /^\".*\"$/) ? text[1..-2] : text
     end
-
-    # Return the key used to store the authenticated user.
-    def auth_key; 'cloudkit.user'; end
-    
-    # Return the key used to indicate the presence of auth in a stack.
-    def auth_presence_key; 'cloudkit.auth'; end
-    
-    # Return the key used to store auth challenge headers shared between
-    # OpenID and OAuth middleware.
-    def challenge_key; 'cloudkit.challenge'; end
-    
-    # Return the 'via' key used to announce and track upstream middleware.
-    def via_key; 'cloudkit.via'; end
-    
-    # Return the key used to store the 'flash' in the session.
-    def flash_key; 'cloudkit.flash'; end
-    
-    # Return the 'via' key for the OAuth filter.
-    def oauth_filter_key; 'cloudkit.filter.oauth'; end
-    
-    # Return the 'via' key for the OpenID filter.
-    def openid_filter_key; 'cloudkit.filter.openid'; end
-    
-    # Return the key used to store the shared storage URI for the stack.
-    def storage_uri_key; 'cloudkit.storage.uri'; end
-    
-    # Return the key for the login URL used in OpenID and OAuth middleware
-    # components.
-    def login_url_key; 'cloudkit.filter.openid.url.login'; end
-    
-    # Return the key for the logout URL used in OpenID and OAuth middleware
-    # components.
-    def logout_url_key; 'cloudkit.filter.openid.url.logout'; end
-    
-    # Return the outer namespace key for the JSON store.
-    def store_key; :cloudkit_json_store; end
   end
 end