Refactor test (move to mocha, add login/logout coverage), add nyc, travis

Author: dmitrizagidulin

.gitignore

@@ -37,3 +37,4 @@ lib
 dist
 demo/solid-client.min.js*
 
+.nyc_output

.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: node_js
+node_js:
+  - ">=7.0"
+
+cache:
+  directories:
+    - node_modules

README.md

@@ -12,22 +12,84 @@ It is meant to be used in browser-side applications, as part of `solid-client`.
 
 ### Usage
 
+##### currentUser
+
+`Promise<string|null> currentUser()`
+
+Resolves to the WebID URI of the currently authenticated user, or `null` if none
+found.
+
+This SHOULD be checked either on page load or on whatever "Application is
+ready" event that your framework provides. For example:
+
 ```js
   // Using a standard "document loaded" event listener
   //  (equivalent to jQuery's $(document).ready())
-  // Trigger a login() check on page load, in case user is logged in already
   document.addEventListener('DOMContentLoaded', function () {
-    SolidClient.auth.login()
+    solidClient.currentUser()
       .then(function (webId) {
-        // User is logged in, you can display their webId, load their profile, etc
-        // Solid.auth.webId is set to the current user's webId URI
-        // Also, SolidClient.auth.accessToken is set to the current user's access token
+        if (webId) {
+          // User is logged in, you can display their webId, load their profile, etc
+        } else {
+          // Not logged in, display appropriate Login button / UI
+        }
       })
       .catch(function (error) {
-        // An error has occurred while logging in, display it to user
+        // An error has occurred, display it to user
       })
   })
 ```
 
-Called by itself, `login()` will perform Provider Discovery and kick off the
-OAuth2/OpenID Connect `/authorize` process.
+##### login
+
+`Promise<string|null> login([string providerUri])`
+
+This is the main "authenticate to your favorite server/identity provider"
+action, which can be hooked up to whatever 'Login' button or link that your
+UI provides.
+
+App developers will use it in one of two ways:
+
+a) (typical) Your app does not provide its own Select Provider UI, so you can
+  just call `.login()` by itself with no parameter, which uses the built-in
+  provider selection UI.
+b) Your app *does* provide its own Select Provider UI. In this case, you can
+  perform provider selection and pass in the `providerUri` to `.login()`
+  directly.
+
+Called by itself (without a `providerUri`), `login()` does the following:
+
+1. If the user has already logged in, it resolves with their WebID URI
+2. Otherwise, opens a 'Select Provider' popup window, asking the user to select
+   their identity provider (Solid server, pod, etc) to login to.
+3. The user makes their selection, and the popup closes and the current page
+   is redirected to that provider's `/authorize` endpoint
+4. When the user has gone through the local login process etc, they are
+   redirected back to the current page (from which `login()` was invoked)
+
+If `login()` is called *with* a `providerUri` argument, the Select Provider
+popup window step is skipped, and the user proceeds directly to the auth
+workflow.
+
+```js
+  // You can bind any sort of Login button or link to do the following:
+  solidClient.login()
+    .then(function (webId) {
+      // User is logged in, you can display their webId, load their profile, etc
+    })
+    .catch(function (error) {
+      // An error has occurred while logging in, display it to user
+    })
+```
+
+After `login()` is successful, the following variables are set:
+
+- `solidClient.auth.webId` is set to the current user's webId URI
+- `solidClient.auth.accessToken` is set to the current user's access token
+
+##### selectProvider
+
+`Promise<string> selectProvider ([string providerUri])`
+
+##### logout
+

karma.conf.js

@@ -2,7 +2,7 @@
   "name": "solid-auth-oidc",
   "version": "0.0.4",
   "engines": {
-    "node": "^6.0"
+    "node": ">= 7.0"
   },
   "description": "Authentication library for Solid client based on OAuth2/OpenID Connect",
   "main": "./lib/index.js",
@@ -15,13 +15,19 @@
     "build-dist": "webpack --progress --colors --optimize-occurrence-order --optimize-dedupe --optimize-minimize",
     "build-lib": "babel src -d lib",
     "dist": "npm run build && npm run build-dist",
-    "karma": "./node_modules/.bin/karma start",
+    "mocha": "nyc mocha test/*.js",
     "postversion": "git push --follow-tags",
     "prepublish": "npm run build && npm run test",
     "preversion": "npm test",
     "standard": "standard src/*",
-    "tape": "tape test/unit/*.js",
-    "test": "npm run standard && npm run dist && npm run karma"
+    "test": "npm run standard && npm run mocha"
+  },
+  "nyc": {
+    "reporter": [
+      "html",
+      "text-summary"
+    ],
+    "cache": true
   },
   "repository": {
     "type": "git",
@@ -57,15 +63,13 @@
     "babel-core": "^6.21.0",
     "babel-loader": "^6.2.5",
     "babel-preset-es2015": "^6.18.0",
-    "karma": "^1.3.0",
-    "karma-babel-preprocessor": "^6.0.1",
-    "karma-chrome-launcher": "^2.0.0",
-    "karma-mocha": "^1.3.0",
-    "karma-sinon-chai": "^1.2.4",
-    "karma-webpack": "^2.0.3",
+    "chai": "^3.5.0",
+    "chai-as-promised": "^6.0.0",
+    "localstorage-polyfill": "^1.0.1",
     "mocha": "^3.2.0",
-    "sinon": "^1.17.7",
-    "sinon-chai": "^2.8.0",
+    "nyc": "^10.2.0",
+    "sinon": "^2.1.0",
+    "sinon-chai": "^2.9.0",
     "standard": "^9.0.2",
     "webpack": "^1.14.0"
   },

package.json

@@ -45,6 +45,7 @@ class ClientAuthOIDC {
   constructor (options = {}) {
     this.window = options.window || global.window
     this.localStorage = options.localStorage || global.localStorage
+
     this.currentClient = null
     this.providerUri = null
     this.webId = null
@@ -73,8 +74,10 @@ class ClientAuthOIDC {
     if (this.webId) {
       return Promise.resolve(this.webId)
     }
+
     // Attempt to find a provider based on the 'state' param of the current URI
     let providerUri = this.providerFromCurrentUri()
+
     if (providerUri) {
       return this.login(providerUri)
     } else {
@@ -92,18 +95,21 @@ class ClientAuthOIDC {
     if (!uri) { return null }
     let uriObj = new URL(uri)
     let state
+
     if (uriType === HASH) {
       let hash = uriObj.hash || '#'
       let params = new URLSearchParams(hash.substr(1))
       state = params.get('state')
     }
+
     if (uriType === QUERY) {
       state = uriObj.searchParams.get('state')
     }
+
     return state
   }
 
-  keyByProvider (providerUri = this.providerUri) {
+  keyByProvider (providerUri) {
     return `oidc.rp.by-provider.${providerUri}`
   }
 
@@ -120,6 +126,7 @@ class ClientAuthOIDC {
    */
   loadOrRegisterClient (providerUri) {
     this.currentClient = null
+
     return this.loadClient(providerUri)
       .then(loadedClient => {
         if (loadedClient) {
@@ -149,6 +156,7 @@ class ClientAuthOIDC {
     // Check for client config stored locally
     let key = this.keyByProvider(providerUri)
     let clientConfig = localStorage.getItem(key)
+
     if (clientConfig) {
       clientConfig = JSON.parse(clientConfig)
       return RelyingParty.from(clientConfig)
@@ -169,10 +177,9 @@ class ClientAuthOIDC {
   }
 
   /**
-   * Resolves to the WebID URI of the current user. Intended to be called
-   * on page load (in case the user is already authenticated), as well as
-   * triggered when the user initiates login explicitly (such as by pressing
-   * a Login button, etc).
+   * Resolves to the WebID URI of the current user. Intended to be triggered
+   * when the user initiates login explicitly (such as by pressing a Login
+   * button, etc).
    *
    * @param [providerUri] {string} Provider URI, result of a Provider Selection
    *   operation (that the app developer has provided). If `null`, the
@@ -182,10 +189,9 @@ class ClientAuthOIDC {
    */
   login (providerUri) {
     this.clearCurrentUser()
-    let selectProvider = this.selectProvider.bind(this)
 
     return Promise.resolve(providerUri)
-      .then(selectProvider)
+      .then(providerUri => this.selectProvider(providerUri))
       .then(selectedProviderUri => {
         if (selectedProviderUri) {
           return this.loadOrRegisterClient(selectedProviderUri)
@@ -206,9 +212,9 @@ class ClientAuthOIDC {
 
   logout () {
     this.clearCurrentUser()
-    if (!this.currentClient) {
-      return Promise.resolve(null)
-    }
+
+    if (!this.currentClient) { return Promise.resolve(null) }
+
     return this.currentClient.logout()
   }
 
@@ -232,11 +238,13 @@ class ClientAuthOIDC {
     if (providerUri) {
       return Promise.resolve(providerUri)
     }
+
     // Attempt to find a provider based on the 'state' param of the current URI
     providerUri = this.providerFromCurrentUri()
     if (providerUri) {
       return Promise.resolve(providerUri)
     }
+
     // Lastly, kick off a Select Provider popup window workflow
     return this.providerFromUI()
   }
@@ -251,6 +259,7 @@ class ClientAuthOIDC {
   providerFromCurrentUri () {
     let currentUri = this.currentLocation()
     let stateParam = this.extractState(currentUri, HASH)
+
     if (stateParam) {
       return this.loadProvider(stateParam)
     } else {
@@ -285,6 +294,7 @@ class ClientAuthOIDC {
   currentUriHasAuthResponse () {
     let currentUri = this.currentLocation()
     let stateParam = this.extractState(currentUri, HASH)
+
     return !!stateParam
   }
 
@@ -294,6 +304,7 @@ class ClientAuthOIDC {
    */
   redirectTo (uri) {
     this.window.location.href = uri
+
     return false
   }
 
@@ -306,6 +317,7 @@ class ClientAuthOIDC {
   sendAuthRequest (client) {
     let options = {}
     let providerUri = client.provider.url
+
     return client.createRequest(options, this.localStorage)
       .then(authUri => {
         let state = this.extractState(authUri, QUERY)