dormouse

Version:

Javascript API for Dormouse

84 lines (69 loc) • 12.4 kB

HTML

<!DOCTYPE html> <html> <head> <title>tasks.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="assembler.html"> assembler.coffee </a> <a class="source" href="connection.html"> connection.coffee </a> <a class="source" href="libutils.html"> libutils.coffee </a> <a class="source" href="mixin.html"> mixin.coffee </a> <a class="source" href="projects.html"> projects.coffee </a> <a class="source" href="query.html"> query.coffee </a> <a class="source" href="tasks.html"> tasks.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> tasks.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> Here you can see the methods on <code>dormouse</code> pertaining to tasks <h3>Task structure on API</h3> The starred properties are required to create a new task <pre><code>{ id: 1234, name: "ManReduce-Step-1", * project_id: 11, * template_id: 7, duplication: 1, replication: 1, created_at: "2011-10-14T14:02:47Z", updated_at: "2011-10-14T14:02:47Z", expires_at: "", eligibility: { communities: [], predicate: null }, * parameters: { question: "blah", type: "abc" } } </code></pre> <h3>Template formatting</h3> Templates follow {{ <a href="http://mustache.github.com/">mustache.js</a> }} style. Uses the <code>task.parameters</code> object as a context for the template, but copies over a few top level properties before doing so. A simple template example is <pre><code>Here is {{ name }} task It is of {{ type }} type </code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h3>And now for code</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Connection and Query needed. </td> <td class="code"> <div class="highlight"><pre>Connection = require('./connection').Connection Query = require('./query').Query</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Templating settings </td> <td class="code"> <div class="highlight"><pre>_ = require 'underscore' _.templateSettings = interpolate : /\{\{(.+?)\}\}/g</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Mixin for Dormouse with methods to manipulate tasks </td> <td class="code"> <div class="highlight"><pre>class Tasks extends Connection</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Fetch a task from Dormouse @param id of task </td> <td class="code"> <div class="highlight"><pre> @getTask: (id, callback) -> @get "tasks/#{id}.json", (err, r) -> if err then callback err, r else callback null, r.task</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Fetches all tasks from Dormouse. Look at query.coffee for the structure of the returned object </td> <td class="code"> <div class="highlight"><pre> @getTasks: (callback) -> q = new Query() if callback and typeof callback is 'function' q.run callback q</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> Render the <code>task</code> in HTML assumpting that <code>snippet</code> is a raw HTML template. Makes no allowances for escaped HTML, it will be returned as escaped too. You can safely use <code>document.body.innerHTML</code> here. </td> <td class="code"> <div class="highlight"><pre> @render: (snippet, task) -> template = _.template snippet context = {} _.extend context, task.parameters ['id', 'name', 'project_id', 'template_id'].forEach (prop) -> context[prop] = task[prop] template context</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> @param task_info object following the format outlined in the task structure section @callback <code>{ status: 'created', location: 1234 }</code> </td> <td class="code"> <div class="highlight"><pre> @createTask: (task_info, callback) -> required_fields = [ 'project_id', 'template_id', 'parameters' ] for field in required_fields throw new Error "Required field for task creation: #{field}" unless field of task_info task_info.eligibility ?= predicate: null, communities: [] task_info.replication ?= 1 task_info.duplication ?= 1 post_path = 'tasks.json' this.post post_path, {}, { 'task': task_info }, callback @answerTask: (task_id, answer_info, callback) -> put_path = "tasks/#{task_id}/answer.json" this.put put_path, {}, answer_info, callback @deleteTask: (task_id, callback) -> delete_path = "tasks/#{task_id}.json" this.delete delete_path, callback exports.Tasks = Tasks </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>