Skip to content

Commit

Permalink
Update package pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredhanson committed Jun 19, 2024
1 parent 9d7884f commit 1dc5196
Show file tree
Hide file tree
Showing 532 changed files with 3,383 additions and 4,077 deletions.
22 changes: 9 additions & 13 deletions packages/bypass-passport-strategy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
<div id="content">
<div class="package hproduct" id="package">
<div class="description"><h1 id="bypass-passport-strategy">bypass-passport-strategy</h1>
<p><a href="https://circleci.com/gh/bypasslane/bypass-passport-strategy"><img src="https://circleci.com/gh/bypasslane/bypass-passport-strategy.svg?style=svg&amp;circle-token=def6ddf5670339f606d411b0d5095ca16fa8d57c" alt="CircleCI"></a></p>
<p><a href="https://circleci.com/gh/bypasslane/bypass-passport-strategy"><img src="https://circleci.com/gh/bypasslane/bypass-passport-strategy.svg?style=svg&circle-token=def6ddf5670339f606d411b0d5095ca16fa8d57c" alt="CircleCI"></a></p>
<p><a href="http://passportjs.org/">Passport</a> strategy for authenticating with Bypass session tokens</p>
<p>This module lets you authenticate using a the Bypass session token in Node.js
applications.</p>
Expand All @@ -105,17 +105,15 @@ <h2 id="install">Install</h2>
<span class="attr">&quot;bypass-passport-strategy&quot;</span><span class="punctuation">:</span> <span class="string">&quot;git@github.com:bypasslane/bypass-passport-strategy.git&quot;</span>
<span class="punctuation">}</span>
<span class="punctuation">}</span>
</code></pre>
<h2 id="usage">Usage</h2>
</code></pre><h2 id="usage">Usage</h2>
<h4 id="configure-strategy">Configure Strategy</h4>
<p>The local authentication strategy authenticates users using a username and
password. The strategy requires a <code>verify</code> callback, which accepts these
credentials and calls <code>done</code> providing a user.</p>
<pre><code class="js"><span class="keyword">var</span> <span class="title class_">BypassStrategy</span> = <span class="built_in">require</span>(<span class="string">&quot;bypass-passport-strategy&quot;</span>).<span class="property">Strategy</span>;

passport.<span class="title function_">use</span>(<span class="keyword">new</span> <span class="title class_">BypassStrategy</span>({<span class="attr">server</span>: <span class="string">&#x27;http://where-my-auth-is&#x27;</span>}));
</code></pre>
<h4 id="authenticate-requests">Authenticate Requests</h4>
</code></pre><h4 id="authenticate-requests">Authenticate Requests</h4>
<p>Use <code>passport.authenticate()</code>, specifying the <code>&#39;bypasstoken&#39;</code> strategy, to
authenticate requests.</p>
<p>For example, as route middleware in an <a href="http://expressjs.com/">Express</a>
Expand All @@ -125,23 +123,21 @@ <h4 id="authenticate-requests">Authenticate Requests</h4>
<span class="keyword">function</span>(<span class="params">req, res</span>) {
res.<span class="title function_">redirect</span>(<span class="string">&#x27;/&#x27;</span>);
});
</code></pre>
<h2 id="tests">Tests</h2>
</code></pre><h2 id="tests">Tests</h2>
<pre><code class="bash">$ npm install
$ npm <span class="built_in">test</span>
</code></pre>
</div>
</code></pre></div>
<div class="metadata">
<div class="install"><code>npm install <span class="fn">bypass-passport-strategy</span></code></div>
<ul>
<li><span class="version">1.0.2</span> published <abbr class="updated" title="2022-04-12T04:51:23Z">a year ago</abbr></li>
<li><span class="version">1.0.2</span> published <abbr class="updated" title="2022-04-12T04:51:23Z">2 years ago</abbr></li>
<li><a class="url" href="https://github.com/bypasslane/bypass-passport-strategy">https://github.com/bypasslane/bypass-passport-strategy#readme</a></li>
<li><a rel="licence" href="http://www.isc.org/software/license">ISC License</a></li>
</ul>
<ul>
<li><b>0</b> downloads in the last day</li>
<li><b>2</b> downloads in the last week</li>
<li><b>16</b> downloads in the last month</li>
<li><b>1</b> downloads in the last day</li>
<li><b>5</b> downloads in the last week</li>
<li><b>23</b> downloads in the last month</li>
</ul>
</div>
</div>
Expand Down
14 changes: 6 additions & 8 deletions packages/clever-passport/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,7 @@ <h4 id="configuration">Configuration</h4>
<span class="title class_">User</span>.<span class="title function_">findOrCreate</span>({ <span class="attr">cleverId</span>: profile.<span class="property">data</span>.<span class="property">id</span> }, <span class="keyword">function</span>(<span class="params">err, user</span>) {
<span class="keyword">return</span> <span class="title function_">done</span>(err, user);
}}));
</code></pre>
<h4 id="authenticate-requests">Authenticate Requests</h4>
</code></pre><h4 id="authenticate-requests">Authenticate Requests</h4>
<p>Use <code>passport.authenticate()</code> to authunicate the requests.</p>
<p>For example, you could implement it with <a href="http://expressjs.com/">Express</a> like this:</p>
<pre><code class="js">app.<span class="title function_">get</span>(<span class="string">&quot;/login&quot;</span>, passport.<span class="title function_">authenticate</span>(<span class="string">&quot;clever&quot;</span>));
Expand All @@ -123,21 +122,20 @@ <h4 id="authenticate-requests">Authenticate Requests</h4>
<span class="keyword">function</span>(<span class="params">req, res</span>) {
res.<span class="title function_">redirect</span>(<span class="string">&quot;/&quot;</span>); <span class="comment">//redirect on successful authentication</span>
});
</code></pre>
<h2 id="disclaimer">Disclaimer</h2>
</code></pre><h2 id="disclaimer">Disclaimer</h2>
<p>This repository is NOT developed or endorsed by Clever. This library is here to help users easily integrate Clever&#39;s Instant Login API to their Node.js projects. All questions about the API should be taken to <a href="https://support.clever.com/hc/s/?language=en_US">Clever Support</a> and all questions about this library should be taken to <a href="mailto:milanmdev@gmail.com">Milan Mehra</a>.</p>
</div>
<div class="metadata">
<div class="install"><code>npm install <span class="fn">clever-passport</span></code></div>
<ul>
<li><span class="version">1.0.3</span> published <abbr class="updated" title="2022-04-04T22:06:08Z">a year ago</abbr></li>
<li><span class="version">1.0.3</span> published <abbr class="updated" title="2022-04-04T22:06:08Z">2 years ago</abbr></li>
<li><a class="url" href="https://github.com/milanmdev/clever-passport">https://github.com/milanmdev/clever-passport#readme</a></li>
<li><a rel="licence" href="http://www.opensource.org/licenses/MIT">MIT License</a></li>
</ul>
<ul>
<li><b>20</b> downloads in the last day</li>
<li><b>80</b> downloads in the last week</li>
<li><b>250</b> downloads in the last month</li>
<li><b>6</b> downloads in the last day</li>
<li><b>107</b> downloads in the last week</li>
<li><b>301</b> downloads in the last month</li>
</ul>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions packages/heroku-passport/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,14 @@
<div class="metadata">
<div class="install"><code>npm install <span class="fn">heroku-passport</span></code></div>
<ul>
<li><span class="version">0.0.1</span> published <abbr class="updated" title="2022-06-18T20:16:03Z">a year ago</abbr></li>
<li><span class="version">0.0.1</span> published <abbr class="updated" title="2022-06-18T20:16:03Z">2 years ago</abbr></li>
<li><a class="url" href="https://github.com/jeffandersen/heroku-passport.git">https://github.com/jeffandersen/heroku-passport</a></li>
<li><a rel="licence" href="http://www.opensource.org/licenses/MIT">MIT License</a></li>
</ul>
<ul>
<li><b>1</b> downloads in the last day</li>
<li><b>1</b> downloads in the last week</li>
<li><b>6</b> downloads in the last month</li>
<li><b>2</b> downloads in the last week</li>
<li><b>5</b> downloads in the last month</li>
</ul>
</div>
</div>
Expand Down
30 changes: 12 additions & 18 deletions packages/node-freeagent2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,44 +93,38 @@
</nav>
<div id="content">
<div class="package hproduct" id="package">
<div class="description"><h1 id="node-freeagent2-build-status">Node-FreeAgent2 <a href="https://travis-ci.org/JoeStanton/Node-FreeAgent2"><img src="https://travis-ci.org/JoeStanton/Node-FreeAgent2.png" alt="Build Status"></a></h1>
<div class="description"><h1 id="node-freeagent2-build-statushttpstravis-ciorgjoestantonnode-freeagent2png">Node-FreeAgent2 <a href="https://travis-ci.org/JoeStanton/Node-FreeAgent2"><img src="https://travis-ci.org/JoeStanton/Node-FreeAgent2.png" alt="Build Status"></a></h1>
<p>Node.js OAuth2 REST Library for use with the FreeAgent v2 API. It provides a very thin wrapper around the API to deal with all of the boring stuff without sacrificing on flexibility. </p>
<p>Includes a passport strategy for plugging into the node-passport authentication library. </p>
<p><strong>Note: This library provides a foundation for interacting with the REST API but is not complete.</strong></p>
<p>##Install</p>
<pre><code class="bash">npm install node-freeagent2
</code></pre>
<p>##Usage </p>
</code></pre><p>##Usage </p>
<p>The two components of this library - the API and the Authentication Strategy, can be used independently. First require the module.</p>
<pre><code class="coffeescript">FreeAgent = <span class="built_in">require</span> <span class="string">&#x27;node-freeagent2&#x27;</span>
</code></pre>
<p>###API</p>
</code></pre><p>###API</p>
<pre><code class="coffeescript">freeAgent = <span class="keyword">new</span> FreeAgent.Api <span class="string">&#x27;auth_token&#x27;</span>

freeAgent.getProjects (error, projects) -&gt;
<span class="keyword">unless</span> error
console.log projects
<span class="keyword">else</span>
console.log error
</code></pre>
<p>Each REST resource has a corresponding method for GET. Requests using other HTTP verbs have not yet been implemented.
</code></pre><p>Each REST resource has a corresponding method for GET. Requests using other HTTP verbs have not yet been implemented.
Each method of the type <code>GET</code> has a consistent signature of:</p>
<pre><code class="coffeescript">getProjects : <span class="function"><span class="params">(optionsOrCallback, callback)</span> -&gt;</span>
</code></pre>
<p>Except where the method is a convenience function for getById or something similar, in which case it takes the form:</p>
</code></pre><p>Except where the method is a convenience function for getById or something similar, in which case it takes the form:</p>
<pre><code class="coffeescript">getProjectById : <span class="function"><span class="params">(id, optionsOrCallback, callback)</span> -&gt;</span>
</code></pre>
<p>###Passport Strategy</p>
</code></pre><p>###Passport Strategy</p>
<pre><code class="coffeescript">FreeAgentStrategy = FreeAgent.AuthenticationStragegy
passport.use <span class="string">&#x27;freeagent&#x27;</span>, <span class="keyword">new</span> FreeagentStrategy(options, ...)
</code></pre>
<p>##Contributing </p>
</code></pre><p>##Contributing </p>
<p>Please help make this a better library, Pull requests and Issues are very welcome. </p>
<p>The project is written in CoffeeScript and built into JS, both sources are currently committed but I may change this.<br>The CoffeeScript and JS should be kept in sync at all times. </p>
<ul>
<li>Use <code>cake watch</code> during development. </li>
<li>Place tests in <code>/tests</code>, execute with mocha using <code>cake test</code> </li>
<li>Try to conform to coffeelint, check by regularly running <code>cake lint</code> </li>
<li>Try to conform to coffeelint, check by regularly running <code>cake lint</code></li>
</ul>
<h2 id="license">License</h2>
<p>(The MIT License)</p>
Expand All @@ -155,14 +149,14 @@ <h2 id="license">License</h2>
<div class="metadata">
<div class="install"><code>npm install <span class="fn">node-freeagent2</span></code></div>
<ul>
<li><span class="version">0.0.11</span> published <abbr class="updated" title="2022-06-21T14:51:43Z">a year ago</abbr></li>
<li><span class="version">0.0.11</span> published <abbr class="updated" title="2022-06-21T14:51:43Z">2 years ago</abbr></li>
<li><a class="url" href="https://github.com/JoeStanton/node-freeagent2">https://github.com/JoeStanton/node-freeagent2</a></li>
<li><a rel="licence"></a></li>
</ul>
<ul>
<li><b>1</b> downloads in the last day</li>
<li><b>7</b> downloads in the last week</li>
<li><b>20</b> downloads in the last month</li>
<li><b>0</b> downloads in the last day</li>
<li><b>2</b> downloads in the last week</li>
<li><b>14</b> downloads in the last month</li>
</ul>
</div>
</div>
Expand Down
Loading

0 comments on commit 1dc5196

Please sign in to comment.