dormouse
Version:
Javascript API for Dormouse
39 lines (31 loc) • 7.67 kB
HTML
<html> <head> <title>projects.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> projects.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> <h3>Project manipulation methods</h3>
<p>Want to get project information or create a new one?</p>
<p>Look no further.</p> </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>Project structure on API</h3>
<pre><code>{
id: '1234',
template: '2561'
}
</code></pre> </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> <h3>And now for code</h3> </td> <td class="code"> <div class="highlight"><pre><span class="nv">path = </span><span class="nx">require</span> <span class="s1">'path'</span>
<span class="nv">Connection = </span><span class="nx">require</span><span class="p">(</span><span class="s1">'./connection'</span><span class="p">).</span><span class="nx">Connection</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <ul>
<li>Projects mixin for Dormouse</li>
<li>basic API operations</li>
</ul> </td> <td class="code"> <div class="highlight"><pre><span class="k">class</span> <span class="nx">Projects</span> <span class="k">extends</span> <span class="nx">Connection</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>Get all projects from Dormouse
@param id of project to fetch</p> </td> <td class="code"> <div class="highlight"><pre> <span class="vi">@getProject: </span><span class="nf">(id, callback) -></span>
<span class="nx">@get</span> <span class="s2">"projects/#{id}.json"</span><span class="p">,</span> <span class="nf">(err, r) -></span>
<span class="k">if</span> <span class="nx">err</span> <span class="k">then</span> <span class="nx">callback</span> <span class="nx">err</span><span class="p">,</span> <span class="nx">r</span>
<span class="k">else</span> <span class="nx">callback</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">r</span><span class="p">.</span><span class="nx">project</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>Get all projects from Dormouse</p> </td> <td class="code"> <div class="highlight"><pre> <span class="vi">@getProjects: </span><span class="nf">(callback) -></span>
<span class="nx">@get</span> <span class="s1">'projects.json'</span><span class="p">,</span> <span class="nf">(err, r) -></span>
<span class="k">if</span> <span class="nx">err</span> <span class="k">then</span> <span class="nx">callback</span> <span class="nx">err</span><span class="p">,</span> <span class="nx">r</span>
<span class="k">else</span> <span class="nx">callback</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">r</span><span class="p">.</span><span class="nx">map</span> <span class="nf">(p) -></span>
<span class="nx">p</span><span class="p">.</span><span class="nx">project</span>
<span class="vi">@createProject: </span><span class="nf">(project_info, callback) -></span>
<span class="nv">post_path = </span><span class="s1">'projects.json'</span>
<span class="k">this</span><span class="p">.</span><span class="nx">post</span> <span class="nx">post_path</span><span class="p">,</span> <span class="p">{},</span> <span class="nx">project_info</span><span class="p">,</span> <span class="nx">callback</span>
<span class="vi">@editProject: </span><span class="nf">(project, callback) -></span>
<span class="nv">put_path = </span><span class="nx">path</span><span class="p">.</span><span class="nx">join</span> <span class="s1">'projects'</span><span class="p">,</span> <span class="s2">"#{project.id}.json"</span>
<span class="k">this</span><span class="p">.</span><span class="nx">put</span> <span class="nx">put_path</span><span class="p">,</span> <span class="p">{},</span> <span class="nx">project</span><span class="p">,</span> <span class="nx">callback</span>
<span class="vi">@deleteProject: </span><span class="nf">(project, callback) -></span>
<span class="nv">delete_path = </span><span class="nx">path</span><span class="p">.</span><span class="nx">join</span> <span class="s1">'projects'</span><span class="p">,</span> <span class="s2">"#{project.id}.json"</span>
<span class="k">this</span><span class="p">.</span><span class="k">delete</span> <span class="nx">delete_path</span><span class="p">,</span> <span class="nx">callback</span>
<span class="nv">exports.Projects = </span><span class="nx">Projects</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>