cloudkit 0.9.0

data/lib/cloudkit/store/adapter.rb

@@ -0,0 +1,9 @@
+module CloudKit
+
+  # A common interface for pluggable storage adapters
+  class Adapter
+    include Util
+
+    # TODO extract from SQLAdapter
+  end
+end

data/lib/cloudkit/store/extraction_view.rb

@@ -0,0 +1,57 @@
+module CloudKit
+  
+  # An ExtractionView observes a resource collection and extracts specified
+  # elements for querying.
+  class ExtractionView
+    attr_accessor :name, :observe, :extract
+
+    # Initialize an ExtractionView.
+    #
+    # ==Examples
+    #
+    # Observe a "notes" collection and extract the titles and colors.
+    #   view = ExtractionView.new(
+    #     :name => :note_features,
+    #     :observe => :notes,
+    #     :extract => [:title, :color])
+    #
+    def initialize(name, options)
+      @name    = name
+      @observe = options[:observe]
+      @extract = options[:extract]
+    end
+
+    # Map the provided data into a collection for querying.
+    def map(db, collection, uri, data)
+      if @observe == collection
+        elements = @extract.inject({}) do |e, field|
+          e.merge(field.to_s => data[field.to_s])
+        end
+        elements.merge!('uri' => uri)
+        db.transaction do
+          db[@name].filter(:uri => uri).delete
+          db[@name].insert(elements)
+        end
+      end
+    end
+
+    # Remove the data with the specified URI from the view
+    def unmap(db, type, uri)
+      if @observe == type
+        db[@name].filter(:uri => uri).delete
+      end
+    end
+
+    # Initialize the storage for this view
+    def initialize_storage(db)
+      extractions = @extract
+      db.create_table @name do
+        extractions.each do |field|
+          text field
+        end
+        primary_key :id
+        varchar     :uri
+      end unless db.table_exists?(@name)
+    end
+  end
+end

data/lib/cloudkit/store/response.rb

@@ -0,0 +1,51 @@
+module CloudKit
+
+  # A response wrapper for CloudKit::Store
+  class Response
+    include Util
+
+    attr_reader :status, :meta, :content
+
+    # Create an instance of a Response.
+    def initialize(status, meta, content='')
+      @status = status; @meta = meta; @content = content
+    end
+
+    # Return the header value specified by key.
+    def [](key)
+      meta[key]
+    end
+
+    # Set the header specified by key to value.
+    def []=(key, value)
+      meta[key] = value
+    end
+
+    # Translate to the standard Rack representation: [status, headers, content]
+    def to_rack
+      [status, meta, [content]]
+    end
+
+    # Parse and return the JSON content
+    def parsed_content
+      JSON.parse(content)
+    end
+
+    # Clear only the content of the response. Useful for HEAD requests.
+    def clear_content
+      @content = ''
+    end
+
+    # Return a response suitable for HEAD requests.
+    def head
+      response = self.dup
+      response.clear_content
+      response
+    end
+
+    # Return the ETag for this response without the surrounding quotes.
+    def etag
+      unquote(meta['ETag'])
+    end
+  end
+end

data/lib/cloudkit/store/response_helpers.rb

@@ -0,0 +1,72 @@
+# A set of mixins for building CloudKit::Response objects.
+module CloudKit::ResponseHelpers
+  def status_404
+    json_error_response(404, 'not found')
+  end
+
+  def status_405(methods)
+    response = json_error_response(405, 'method not allowed')
+    response['Allow'] = methods.join(', ')
+    response
+  end
+
+  def status_410
+    json_error_response(410, 'entity previously deleted')
+  end
+
+  def status_412
+    json_error_response(412, 'precondition failed')
+  end
+
+  def status_422
+    json_error_response(422, 'unprocessable entity')
+  end
+
+  def internal_server_error
+    json_error_response(500, 'unknown server error')
+  end
+
+  def data_required
+    json_error_response(400, 'data required')
+  end
+
+  def invalid_entity_type
+    json_error_response(400, 'valid entity type required')
+  end
+
+  def etag_required
+    json_error_response(400, 'etag required')
+  end
+
+  def allow(methods)
+    CloudKit::Response.new(200, {'Allow' => methods.join(', ')})
+  end
+
+  def response(status, content='', etag=nil, last_modified=nil, options={})
+    cache_control = options[:cache] == false ? 'no-cache' : 'proxy-revalidate'
+    headers = {
+      'Content-Type'  => 'application/json',
+      'Cache-Control' =>  cache_control}
+    headers.merge!('ETag' => "\"#{etag}\"") if etag
+    headers.merge!('Last-Modified' => last_modified) if last_modified
+    CloudKit::Response.new(status, headers, content)
+  end
+
+  def json_meta_response(status, uri, etag, last_modified)
+    json = JSON.generate(
+      :ok            => true,
+      :uri           => uri,
+      :etag          => etag,
+      :last_modified => last_modified)
+    response(status, json, nil, nil, :cache => false)
+  end
+
+  def json_error(message)
+    "{\"error\":\"#{message}\"}"
+  end
+
+  def json_error_response(status, message)
+    "trying to throw a json error message for #{status} #{message}"
+    response(status, json_error(message), nil, nil, :cache => false)
+  end
+end

data/lib/cloudkit/store/sql_adapter.rb

@@ -0,0 +1,36 @@
+module CloudKit
+
+  # Adapts a CloudKit::Store to a SQL backend.
+  class SQLAdapter < Adapter
+
+    # Initialize a new SQL backend. Defaults to in-memory SQLite.
+    def initialize(uri=nil, options={})
+      @db = uri ? Sequel.connect(uri, options) : Sequel.sqlite
+      # TODO accept views as part of a store, then initialize them here
+      initialize_storage
+    end
+
+    # method_missing is a placeholder for future interface extraction into
+    # CloudKit::Adapter.
+    def method_missing(method, *args, &block)
+      @db.send(method, *args, &block)
+    end
+
+    protected
+
+    # Initialize the HTTP-oriented storage if it does not exist.
+    def initialize_storage
+      @db.create_table store_key do
+        primary_key :id
+        varchar     :uri, :unique => true
+        varchar     :etag
+        varchar     :collection_reference
+        varchar     :resource_reference
+        varchar     :last_modified
+        varchar     :remote_user
+        text        :content
+        boolean     :deleted, :default => false
+      end unless @db.table_exists?(store_key)
+    end
+  end
+end

data/lib/cloudkit/templates/authorize_request_token.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<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>OAuth Request Token Authorized</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Your OAuth Request Token has been authorized. Please return to the application
+  that initiated this request to complete the setup.
+</p>
+</body>
+</html>

data/lib/cloudkit/templates/oauth_descriptor.erb

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRDS xmlns="xri://$xrds">
+  <XRD xml:id="oauth" xmlns:simple="http://xrds-simple.net/core/1.0" xmlns="xri://$XRD*($v*2.0)" version="2.0">
+    <Type>xri://$xrds*simple</Type>
+    <Expires><%= Time.at(Time.now.to_i + 2592000).utc.xmlschema %></Expires>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/request</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/PLAINTEXT</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/request_tokens</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/authorize</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/authorization</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/access</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/PLAINTEXT</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/access_tokens</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/resource</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/HMAC-SHA1</Type>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/discovery/1.0/consumer-identity/static</Type>
+      <LocalID>cloudkitconsumer</LocalID>
+    </Service>
+  </XRD>
+  <XRD xmlns="xri://$XRD*($v*2.0)" version="2.0">
+    <Type>xri://$xrds*simple</Type>
+    <Service priority="10">
+      <Type>http://oauth.net/discovery/1.0</Type>
+      <URI>#oauth</URI>
+    </Service>
+  </XRD>
+</XRDS>

data/lib/cloudkit/templates/oauth_meta.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRD>
+  <Type>http://oauth.net/discovery/1.0</Type>
+  <Service>
+    <Type>http://oauth.net/discovery/1.0/rel/provider</Type>
+    <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth</URI>
+  </Service>
+</XRD>

data/lib/cloudkit/templates/openid_login.erb

@@ -0,0 +1,31 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<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>Sign Up or Sign In</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+    #openid_url {
+      background: url(data:image/gif;base64,R0lGODlhEAAQANUAAPr6+t/f37Gxsby8vJycnKWlpaampq+vr/zUpfz8/Lm5ufLy8r6+vp2dncvLy/muVsjIyLW1tcTExKGhof7+/sDAwMHBwbS0tNnZ2erq6qioqPn5+bi4uLu7u+np6e3t7evr66mpqeXl5b29vaqqqtfX18zMzO7u7u/v756enveTHv///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAAAAAAALAAAAAAQABAAAAZlwJVwKEQQj0eECslcqZbN4zMqhTY/EoFzKbCAVoDNKjFIERTbFaeRcpwWCU3qgBJOVxVDhOEpH4hTFBkBIyQiKSkBgFZEiBiLTBApBgBDd0gXKROKaU0mZiEFl0wAJR0FD1SqQ0EAOw%3D%3D) no-repeat #FFF 5px;
+      padding-left: 25px;
+      width: 300px;
+    }
+    #submit {
+      display: block;
+      margin-top: 10px;
+    }
+  </style>
+</head>
+<body>
+<%= request.flash[:error] %>
+<%= request.flash[:info] %>
+<p>Sign Up or Sign In with OpenID</p>
+<form action="/login" method="POST">
+<input type="text" id="openid_url" name="openid_url"/>
+<input id="submit" type="submit" value="Sign In"/>
+</form>
+</body>
+</html>

data/lib/cloudkit/templates/request_authorization.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<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>OAuth Authorization Requested</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Another application or website has requested access to your data.
+</p>
+<form action="/oauth/authorized_request_tokens/<%= request['oauth_token'] %>" method="POST">
+  <input type="hidden" name="_method" value="PUT"/>
+  <input type="submit" value="Approve"/>
+  <input type="submit" value="Deny"/>
+</form>
+</body>
+</html>

data/lib/cloudkit/templates/request_token_denied.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<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>OAuth Request Token Authorization Denied</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Your OAuth Request Token was not denied and has been removed.
+</p>
+</body>
+</html>

data/lib/cloudkit/user_store.rb

@@ -0,0 +1,44 @@
+module CloudKit
+
+  # A thin layer on top of CloudKit::Store providing consistent URIs and
+  # automatic schema upgrades if required for future releases.
+  class UserStore
+    @@store = nil
+
+    def initialize(uri=nil)
+      unless @@store
+        login_view = ExtractionView.new(
+          :cloudkit_login_view,
+          :observe => :cloudkit_users,
+          :extract => [:identity_url, :remember_me_token, :remember_me_expiration])
+        @@store = Store.new(
+          :collections => [:cloudkit_users],
+          :views       => [login_view],
+          :adapter     => SQLAdapter.new(uri))
+      end
+    end
+
+    def get(uri, options={}) #:nodoc:
+      @@store.get(uri, options)
+    end
+
+    def post(uri, options={}) #:nodoc:
+      @@store.post(uri, options)
+    end
+
+    def put(uri, options={}) #:nodoc:
+      @@store.put(uri, options)
+    end
+
+    def delete(uri, options={}) #:nodoc:
+      @@store.delete(uri, options)
+    end
+
+    def resolve_uris(uris) #:nodoc:
+      @@store.resolve_uris(uris)
+    end
+
+    # Return the version for this UserStore
+    def version; 1; end
+  end
+end

data/lib/cloudkit/util.rb

@@ -0,0 +1,60 @@
+module CloudKit
+  module Util
+
+    # Render ERB content
+    def erb(request, template, headers={'Content-Type' => 'text/html'}, status=200)
+      template_file = open(
+        File.join(File.dirname(__FILE__),
+        'templates',
+        "#{template.to_s}.erb"))
+      template = ERB.new(template_file.read)
+      [status, headers, [template.result(binding)]]
+    end
+
+    # Build a Rack::Router instance
+    def r(method, path, params=[])
+      Rack::Router.new(method, path, params)
+    end
+
+    # Remove the outer double quotes from a given string.
+    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