/
users.html
29 lines (23 loc) · 7.5 KB
/
users.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<!DOCTYPE html> <html> <head> <title>users.js</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="..//jitsu/apps.html"> jitsu/apps.html </a> <a class="source" href="..//jitsu/client.html"> jitsu/client.html </a> <a class="source" href="..//jitsu/commands/apps.html"> jitsu/commands/apps.html </a> <a class="source" href="..//jitsu/commands/config.html"> jitsu/commands/config.html </a> <a class="source" href="..//jitsu/commands.html"> jitsu/commands.html </a> <a class="source" href="..//jitsu/config.html"> jitsu/config.html </a> <a class="source" href="..//jitsu/log.html"> jitsu/log.html </a> <a class="source" href="..//jitsu/prompt.html"> jitsu/prompt.html </a> <a class="source" href="..//jitsu/users.html"> jitsu/users.html </a> <a class="source" href="..//jitsu/utils/base64.html"> jitsu/utils/base64.html </a> <a class="source" href="..//jitsu/utils/index.html"> jitsu/utils/index.html </a> <a class="source" href="..//jitsu.html"> jitsu.html </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> users.js </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> </td> <td class="code"> <div class="highlight"><pre><span class="cm">/*</span>
<span class="cm"> * users.js: Client for the Nodejitsu users API.</span>
<span class="cm"> *</span>
<span class="cm"> * (C) 2010, Nodejitsu Inc.</span>
<span class="cm"> *</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'util'</span><span class="p">),</span>
<span class="nx">winston</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'winston'</span><span class="p">),</span>
<span class="nx">jitsu</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'jitsu'</span><span class="p">);</span>
</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h3>function Users (options)</h3>
<h4>@options {Object} Options for this instance</h4>
<p>Constructor function for the Users resource responsible
with Nodejitsu's Users API</p> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">Users</span> <span class="o">=</span> <span class="nx">exports</span><span class="p">.</span><span class="nx">Users</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">jitsu</span><span class="p">.</span><span class="nx">Client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span>
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Inherit from Client base object</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">Users</span><span class="p">,</span> <span class="nx">jitsu</span><span class="p">.</span><span class="nx">Client</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h3>function auth (callback)</h3>
<h4>@callback {function} Continuation to pass control to when complete</h4>
<p>Tests the authentication of the user identified in this process.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Users</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">auth</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">winston</span><span class="p">.</span><span class="nx">info</span><span class="p">(</span><span class="s1">'Attempting to authenticate as '</span> <span class="o">+</span> <span class="nx">jitsu</span><span class="p">.</span><span class="nx">config</span><span class="p">.</span><span class="nx">settings</span><span class="p">.</span><span class="nx">auth</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)[</span><span class="mi">0</span><span class="p">].</span><span class="nx">magenta</span><span class="p">);</span>
<span class="k">this</span><span class="p">.</span><span class="nx">_request</span><span class="p">(</span><span class="s1">'GET'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'auth'</span><span class="p">],</span> <span class="nx">callback</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">res</span><span class="p">,</span> <span class="nx">body</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">};</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>