Merge pull request #33 from koopjs/auth-update

Update auth-plugin spec due to auth function signature changes.

Author: rgwozdz

docs/specs/authorization.md

@@ -24,12 +24,11 @@ An example of `authenticationSpecification` is available [here](https://github.c
 
 Authorization plugins are required to return a function called `authenticate`.  Its purpose is to validate credentials and, if successful, issue a token for authorizing subsequent resource requests.  The `authenticate` function should have the following signature:
 
-##### authenticate(username, password) ⇒ Promise
+##### authenticate(req) ⇒ Promise
 
 | Param | Type | Description |
 | --- | --- | --- |
-| username | <code>string</code> | requester's username |
-| password | <code>string</code> | requester's password |
+| req | <code>object</code> | Express request object. Credentials for authentication should be found in the `query` object. |
 
 
 As noted above, the `authenticate` function should return a promise. If the authentication is unsuccessful the promise should reject with an error object.  The error should have a `code` property with value `401`. If the authentication is successful, the promise should resolve an object with the following properties:
@@ -46,7 +45,7 @@ Authorization plugins are required to implement a function called `authorize`.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| input | <code>*</code> |input that can be used to prove previously successful authentication |
+| input | <code>object</code> | Express request object. Query parameter or header should include input (e.g., token) that can be used to prove previously successful authentication |
 
 As noted above, the `authorize` function should return a promise. If the authorization is unsuccessful, the promise should reject with an error object.  Successful authorization should allow the promise to resolve. An example of an `authorize` function can be viewed [here](https://github.com/koopjs/koop-auth-direct-file/blob/master/src/index.js#L90-L108).
 

docs/specs/authorization/index.html

@@ -54,7 +54,7 @@ <h5>authenticationSpecification() &#x21D2; object</h5>
 <p>An example of <code>authenticationSpecification</code> is available <a href="https://github.com/koopjs/koop-auth-direct-file/blob/master/src/index.js#L44-L56">here</a>.</p>
 <h3>Function: authenticate</h3>
 <p>Authorization plugins are required to return a function called <code>authenticate</code>.  Its purpose is to validate credentials and, if successful, issue a token for authorizing subsequent resource requests.  The <code>authenticate</code> function should have the following signature:</p>
-<h5>authenticate(username, password) &#x21D2; Promise</h5>
+<h5>authenticate(req) &#x21D2; Promise</h5>
 <table>
 <thead>
 <tr>
@@ -65,14 +65,9 @@ <h5>authenticate(username, password) &#x21D2; Promise</h5>
 </thead>
 <tbody>
 <tr>
-<td>username</td>
-<td><code>string</code></td>
-<td>requester&#x2019;s username</td>
-</tr>
-<tr>
-<td>password</td>
-<td><code>string</code></td>
-<td>requester&#x2019;s password</td>
+<td>req</td>
+<td><code>object</code></td>
+<td>Express request object. Credentials for authentication should be found in the <code>query</code> object.</td>
 </tr>
 </tbody>
 </table>
@@ -93,8 +88,8 @@ <h5>authorize(input) &#x21D2; Promise</h5>
 <tbody>
 <tr>
 <td>input</td>
-<td><code>*</code></td>
-<td>input that can be used to prove previously successful authentication</td>
+<td><code>object</code></td>
+<td>Express request object. Query parameter or header should include input (e.g., token) that can be used to prove previously successful authentication</td>
 </tr>
 </tbody>
 </table>