CloudKit

+1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 +1 1

Jon Crosby http://joncrosby.me

Engine Yard Solo “The platform for on-demand management of your Ruby on Rails application in the cloud.”

We’re Hiring

CloudKit

Open Web JSON Appliance

RESTful Collections of JSON Documents

CouchDB Persevere

$ gem install cloudkit

WayOfThinking.new

WayOfThinking.web

if (developer.building_web_framework?) { MVCAbstraction.new }

Rails 3

Rails 3 => API

framework = { :orm => AR :dispatcher => AD}.merge( :orm => YourORM)

! MVC “in the back?”

RESTful Application Architectures

RADAR Dave Thomas http://pragdave.pragprog.com/pragdave/2007/03/the_radar_archi.html

Resource Composition in the Browser A.S. Focus

Cappuccino http://280slides.com

Sproutcore http://sproutcore.com

Desktop / Mobile Apps

ESI Caching Layer REST Fragment A Service Client REST Fragment B Service

jQueryUI Dojo MooTools

WayOfThinking.web

The Web

Intermediaries HTTP

Intermediaries App HTTP

Intermediaries Rack HTTP

Intermediaries HTTP

Middleware HTTP

Middleware App HTTP

Rack is the Web

Constraints

Constraints => Interface

Constraints => Interface => SPEC

CloudKit

Roy Fielding Architectural Styles and the Design of Network-based Software Architectures http://www.ics.uci.edu/~ﬁelding/pubs/dissertation/rest_arch_style.htm

Build An App

conﬁg.ru

require ‘cloudkit’ expose :todos, :proﬁles

$ rackup conﬁg.ru

$ curl -i http://localhost:9292/cloudkit-meta

$ curl -i http://localhost:9292/cloudkit-meta HTTP/1.1 200 OK ETag: quot;5b6f484abf2d95cec3ea8867d1754418quot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 33 {quot;urisquot;:[quot;/todosquot;,quot;/proﬁlesquot;]}

$ curl -i -XOPTIONS http://localhost:9292/todos

$ curl -i -XOPTIONS http://localhost:9292/todos HTTP/1.1 200 OK Content-Type: application/json Content-Length: 0 Allow: GET, HEAD, POST, OPTIONS

$ curl -i http://localhost:9292/todos

$ curl -i http://localhost:9292/todos HTTP/1.1 200 OK ETag: quot;df392c5664e6ecd64b83210fb925f6c8quot; Link: <http://localhost:9292/todos/_resolved>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/resolvedquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 32 {quot;urisquot;:[],quot;totalquot;:0,quot;offsetquot;:0}

Link Relations and HTTP Header Linking IETF Draft by Mark Nottingham http://tools.ietf.org/html/draft-nottingham-http-link-header-04

Hypermedia as the Engine of Application State -- Fielding

Connectedness -- Richardson, Ruby

$ curl -i -XPOST -d'{quot;titlequot;:quot;fooquot;}' http://localhost:9292/todos

$ curl -i -XPOST -d'{quot;titlequot;:quot;fooquot;}' http://localhost:9292/todos HTTP/1.1 201 Created Cache-Control: no-cache Content-Type: application/json Content-Length: 159 { quot;okquot;:true, quot;uriquot;:quot;/todos/9216df80-0c7b-012c-af2e-0023dfa0a208quot;, quot;etagquot;:quot;9216dde0-0c7b-012c-af2e-0023dfa0a208quot;, quot;last_modiﬁedquot;:quot;Thu, 16 Apr 2009 06:13:04 GMTquot; }

Read-optimized

HTTP-Oriented Storage

Metadata + Document

URI, ETag, Last-Modiﬁed, etc. + Document

Tokyo Cabinet

Tokyo Cabinet Tables

todos[“random_id”] = { “uri” => “/todos/abc”, “etag” => “9216dde0-0c7b-012c”, “last_modiﬁed” => “Thu, 16 Apr 2009 06:13:04 GMT”, “remote_user” => “http://joncrosby.me”, “json” => “{”title”:”foo”}”, ... }

Rufus::Tokyo record = store.query { |q| q.add_condition(“uri”, :eql, “/todos/abc”) }

Schema-free

* Schema-free

HTTP and JSON are the Schema

$ curl -i -XPUT -d'{quot;titlequot;:quot;barquot;}' http://localhost:9292/todos/abc

$ curl -i -XPUT -d'{quot;titlequot;:quot;barquot;}' http://localhost:9292/todos/abc HTTP/1.1 201 Created Cache-Control: no-cache Content-Type: application/json Content-Length: 126 { quot;okquot;:true, quot;uriquot;:quot;/todos/abcquot;, quot;etagquot;:quot;f4538ca0-0c7b-012c-af2e-0023dfa0a208quot;, quot;last_modiﬁedquot;:quot;Thu, 16 Apr 2009 06:15:49 GMTquot; }

$ curl -i -XOPTIONS http://localhost:9292/todos/abc

$ curl -i -XOPTIONS http://localhost:9292/todos/abc HTTP/1.1 200 OK Content-Type: application/json Content-Length: 0 Allow: GET, HEAD, PUT, DELETE, OPTIONS

$ curl -i http://localhost:9292/todos/abc

$ curl -i http://localhost:9292/todos/abc HTTP/1.1 200 OK Last-Modiﬁed: Thu, 16 Apr 2009 06:15:49 GMT ETag: quot;f4538ca0-0c7b-012c-af2e-0023dfa0a208quot; Link: <http://localhost:9292/todos/abc/versions>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/versionsquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 15 {quot;titlequot;:quot;barquot;}

Auto-versioning

/:collection /:collection/:uuid /:collection/:uuid/versions /:collection/:uuid/versions/:etag

$ curl -i http://localhost:9292/todos

$ curl -i http://localhost:9292/todos HTTP/1.1 200 OK Last-Modiﬁed: Thu, 16 Apr 2009 06:15:49 GMT ETag: quot;0aca58964aa2e15a9365d72dd4c43472quot; Link: <http://localhost:9292/todos/_resolved>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/resolvedquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 94 { quot;urisquot;:[ quot;/todos/abcquot;, quot;/todos/9216df80-0c7b-012c-af2e-0023dfa0a208quot; ], quot;totalquot;:2, quot;offsetquot;:0 }

Lost Update Problem:

Lost Update Problem: Solved

2 Users

2 Users 2 Browsers

2 Users 2 Browsers 1 Document

2 Users 2 Browsers 1 Document Fight!

2 Users 2 Browsers 1 Document Hand Wave!

$ curl -i -XPUT -d'{quot;titlequot;:quot;bazquot;}' http://localhost:9292/todos/abc

$ curl -i -XPUT -d'{quot;titlequot;:quot;bazquot;}' http://localhost:9292/todos/abc HTTP/1.1 400 Bad Request Cache-Control: no-cache Content-Type: application/json Content-Length: 25 {quot;errorquot;:quot;etag requiredquot;}

$ curl -i -XPUT -H'If-Match:f4538ca0-0c7b-012c-af2e-0023dfa0a208' -d'{quot;titlequot;:quot;bazquot;}' http://localhost:9292/todos/abc

$ curl -i -XPUT -H'If-Match:f4538ca0-0c7b-012c-af2e-0023dfa0a208' -d'{quot;titlequot;:quot;bazquot;}' http://localhost:9292/todos/abc HTTP/1.1 200 OK Cache-Control: no-cache Content-Type: application/json Content-Length: 126 { quot;okquot;:true, quot;uriquot;:quot;/todos/abcquot;, quot;etagquot;:quot;55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;last_modiﬁedquot;:quot;Thu, 16 Apr 2009 06:25:41 GMTquot; }

$ curl -i -XPUT -H'If-Match:f4538ca0-0c7b-012c-af2e-0023dfa0a208' -d'{quot;titlequot;:quot;boxquot;}' http://localhost:9292/todos/abc

$ curl -i -XPUT -H'If-Match:f4538ca0-0c7b-012c-af2e-0023dfa0a208' -d'{quot;titlequot;:quot;boxquot;}' http://localhost:9292/todos/abc HTTP/1.1 412 Precondition Failed Cache-Control: no-cache Content-Type: application/json Content-Length: 31 {quot;errorquot;:quot;precondition failedquot;}

$ curl -i http://localhost:9292/todos/abc/versions

$ curl -i http://localhost:9292/todos/abc/versions HTTP/1.1 200 OK Last-Modiﬁed: Thu, 16 Apr 2009 06:25:41 GMT ETag: quot;f7aae4894429a39c7c3fe0c8ea9aa00equot; Link: <http://localhost:9292/todos/abc/versions/_resolved>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/resolvedquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 109 { quot;urisquot;:[ quot;/todos/abcquot;, quot;/todos/abc/versions/f4538ca0-0c7b-012caf2e-0023dfa0a208quot; ], quot;totalquot;:2, quot;offsetquot;:0 }

Why _resolved?

1000 documents = 1001 GETs

Time to rewrite in Scala?

$ curl -i http://localhost:9292/todos/abc/versions/_resolved

$ curl -i http://localhost:9292/todos/abc/versions/_resolved HTTP/1.1 200 OK Last-Modified: Thu, 16 Apr 2009 06:25:41 GMT ETag: quot;ea2238f8f2da37b70f3d2f09464f166equot; Link: <http://localhost:9292/todos/abc/versions>; rel=quot;indexquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 384 { quot;documentsquot;:[ { quot;etagquot;:quot;55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;uriquot;:quot;/todos/abcquot;, quot;last_modifiedquot;:quot;Thu, 16 Apr 2009 06:25:41 GMTquot;, quot;documentquot;:quot;{quot;titlequot;:quot;bazquot;}quot; }, { quot;etagquot;:quot;f4538ca0-0c7b-012c-af2e-0023dfa0a208quot;, quot;uriquot;:quot;/todos/abc/versions/f4538ca0-0c7b-012c-af2e-0023dfa0a208quot;, quot;last_modifiedquot;:quot;Thu, 16 Apr 2009 06:15:49 GMTquot;, quot;documentquot;:quot;{quot;titlequot;:quot;barquot;}quot; } ], quot;totalquot;:2, quot;offsetquot;:0 }

$ curl -i http://localhost:9292/todos/_resolved

$ curl -i http://localhost:9292/todos/_resolved HTTP/1.1 200 OK Last-Modified: Thu, 16 Apr 2009 06:25:41 GMT ETag: quot;59edaebe03b5fe90fa59ef6de633afcequot; Link: <http://localhost:9292/todos>; rel=quot;indexquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 369 { quot;documentsquot;:[ { quot;etagquot;:quot;55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;uriquot;:quot;/todos/abcquot;, quot;last_modifiedquot;:quot;Thu, 16 Apr 2009 06:25:41 GMTquot;, quot;documentquot;:quot;{quot;titlequot;:quot;bazquot;}quot; }, { quot;etagquot;:quot;9216dde0-0c7b-012c-af2e-0023dfa0a208quot;, quot;uriquot;:quot;/todos/9216df80-0c7b-012c-af2e-0023dfa0a208quot;, quot;last_modifiedquot;:quot;Thu, 16 Apr 2009 06:13:04 GMTquot;, quot;documentquot;:quot;{quot;titlequot;:quot;fooquot;}quot; } ], quot;totalquot;:2, quot;offsetquot;:0 }

$ curl -i -XDELETE -H'If-Match:55286040-0c7d-012c-af2e-0023dfa0a208' http://localhost:9292/todos/abc

$ curl -i -XDELETE -H'If-Match:55286040-0c7d-012c-af2e-0023dfa0a208' http://localhost:9292/todos/abc HTTP/1.1 200 OK Cache-Control: no-cache Content-Type: application/json Content-Length: 92 { quot;okquot;:true, quot;uriquot;:quot;/todos/abc/versions/55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;etagquot;: quot;55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;last_modiﬁedquot;:quot;Thu, 16 Apr 2009 06:33:50 GMTquot; }

$ curl -i http://localhost:9292/todos/abc

$ curl -i http://localhost:9292/todos/abc HTTP/1.1 410 Gone Link: <http://localhost:9292/todos/abc/versions>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/versionsquot; Cache-Control: no-cache Content-Type: application/json Content-Length: 37 {quot;errorquot;:quot;entity previously deletedquot;}

$ curl -i http://localhost:9292/todos/abc/versions

$ curl -i http://localhost:9292/todos/abc/versions HTTP/1.1 200 OK Last-Modiﬁed: Thu, 16 Apr 2009 06:25:41 GMT ETag: quot;22116ccbc80e6356aec956be63c9c440quot; Link: <http://localhost:9292/todos/abc/versions/_resolved>; rel=quot;http://joncrosby.me/cloudkit/1.0/rel/resolvedquot; Cache-Control: proxy-revalidate Content-Type: application/json Content-Length: 157 { quot;urisquot;:[ quot;/todos/abc/versions/55286040-0c7d-012c-af2e-0023dfa0a208quot;, quot;/todos/abc/versions/f4538ca0-0c7b-012c-af2e-0023dfa0a208quot; ], quot;totalquot;:2, quot;offsetquot;:0 }

Uniform Interface

RESTful Collections

Addressable Nouns

Manipulate with HTTP Methods

Expose Relationships with Links

Fully Discoverable API

What’s Missing?

Ability to Ask Questions

Pagination /todos?page=2&limit=50

Querying /todos?user=http://joncrosby.me /todos?only=title

Uniform Interface

Uniform Interface ... for querying?

JSONQuery Kris Zyp http://www.sitepen.com/blog/2008/07/16/jsonquery-data-querying-beyond-jsonpath/

XPath=> JSONPath http://goessner.net/articles/JsonPath/

Array Slice Operators /todos[10:20]

Array Slice Operators /todos[10:20:2]

Comparisons /todos[?priority>=3]

Chained Expressions /todos[?priority>=3][0:5]

Extractions /todos[=name]

Sorting /todos[/priority][name]

Recursive Finders /todos[objectid..ﬁrstName]

Unions /todos[?foo=‘bar’,rating=4]

JSONQuery.js http://github.com/jcrosby/jsonquery

jquery.cloudkit.js http://github.com/jcrosby/jquery-cloudkit

var store = $.cloudkit; store.boot({ success: function() { // do something }, error: function(status) { // fail gracefully } });

store.boot 1) Local collection per remote collection 2) Loads remote data

var store = $.cloudkit; store.boot({ success: function() { // do something }, error: function(status) { // fail gracefully } });

// insert a 'todo' store.collection('todos').create({name:quot;fooquot;}, { success: function(todo) { // do something with the todo alert(todo.json().name); } });

// update the 'todo' todo.update({name:quot;barquot;} { success: function() { // updated remotely, ready for use alert(todo.json().name); // now “bar” }, error: function(status) { // fail gracefully or recover } });

Recovery 410 => Remove Locally? Create New?

Recovery 410 => Remove Locally? Create New? 412 => Progressive Diff/Merge

Recovery 410 => Remove Locally? Create New? 412 => Progressive Diff/Merge (Sync)

// delete the 'todo' todo.destroy({ success: function() { // the 'todo' has now been deleted } });

store.collection('todos').query(quot;?name='foo'quot;);

Johnson Ruby/JavaScript Bridge http://github.com/jbarnette/johnson

1.0 Roadmap

JSONSchema /:collection/_schema http://www.json.com/json-schema-proposal/

{ quot;descriptionquot;:quot;A personquot;, quot;typequot;:quot;objectquot;, quot;propertiesquot;: { quot;namequot;: { quot;typequot;:quot;stringquot; }, quot;agequot;: { quot;typequot;:quot;integerquot;, quot;maximumquot;:125 } } }

Open Web JSON Appliance

require ‘cloudkit’ expose :todos, :proﬁles

require ‘cloudkit’ contain :todos, :proﬁles

OpenID + OAuth + OAuth/Discovery

Browser OAuth OpenID Service

Browser {...} OAuth OpenID Service

Browser OAuth OpenID Service {...} Login

Service or Desktop App OAuth OpenID Service

Service or Desktop App {...} OAuth OpenID Service

Service or Desktop App OAuth OpenID Service {...} Login

curl -i http://localhost:9292/todos HTTP/1.1 401 Unauthorized Connection: close Date: Thu, 15 Jan 2009 22:24:23 GMT WWW-Authenticate: OAuth realm=quot;http://localhost:9292quot; Link: <http://localhost:9292/oauth/meta>; rel=quot;http://oauth.net/discovery/1.0/rel/providerquot; Content-Type: text/html Set-Cookie: rack.session=d6b1c6aa6d463a478eb9af0e921eb997; path=/; HttpOnly Content-Length: 1280 <!DOCTYPE html PUBLIC quot;-//W3C//DTD XHTML 1.0 Transitional//ENquot; quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtdquot;> <html xmlns=quot;http://www.w3.org/1999/xhtmlquot; xml:lang=quot;enquot; lang=quot;enquot;> ... etc ...

$ curl -i http://localhost:9292/oauth/meta

$ curl -i http://localhost:9292/oauth/meta <?xml version=quot;1.0quot; encoding=quot;UTF-8quot;?> <XRD> <Type>http://oauth.net/discovery/1.0</Type> <Service> <Type>http://oauth.net/discovery/1.0/rel/provider</Type> <URI>http://localhost:9292/oauth</URI> </Service> </XRD>

$ curl -i http://localhost:9292/oauth

(squint)

<?xml version=quot;1.0quot; encoding=quot;UTF-8quot;?> <XRDS xmlns=quot;xri://$xrdsquot;> <XRD xml:id=quot;oauthquot; xmlns:simple=quot;http://xrds-simple.net/core/1.0quot; xmlns=quot;xri://$XRD*($v*2.0)quot; version=quot;2.0quot;> <Type>xri://$xrds*simple</Type> <Expires>2009-02-14T22:27:50Z</Expires> <Service priority=quot;10quot;> <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>http://localhost:9292/oauth/request_tokens</URI> </Service> <Service priority=quot;10quot;> <Type>http://oauth.net/core/1.0/endpoint/authorize</Type> <Type>http://oauth.net/core/1.0/parameters/uri-query</Type> <URI>http://localhost:9292/oauth/authorization</URI> </Service> <Service priority=quot;10quot;> <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>http://localhost:9292/oauth/access_tokens</URI> </Service> <Service priority=quot;10quot;> <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=quot;10quot;> <Type>http://oauth.net/discovery/1.0/consumer-identity/static</Type> <LocalID>cloudkitconsumer</LocalID> </Service> </XRD> <XRD xmlns=quot;xri://$XRD*($v*2.0)quot; version=quot;2.0quot;> <Type>xri://$xrds*simple</Type> <Service priority=quot;10quot;> <Type>http://oauth.net/discovery/1.0</Type> <URI>#oauth</URI> </Service> </XRD> </XRDS>

JSONQuery Release

JSONSchema Release

Templating

CloudKit http://getcloudkit.com http://joncrosby.me

http://www.slideshare.net	6
http://blog.samdevore.com	4
http://www.techgig.com	2
http://static.slidesharecdn.com	1

CloudKit

by Jon Crosby on Apr 21, 2009

Accessibility

Categories

Tags

Upload Details

Usage Rights

4 Embeds 13

Statistics

CloudKit — Presentation Transcript