From 853792a9e0f8c99060fd30bf30b8ed90b474f0c2 Mon Sep 17 00:00:00 2001
From: Byron Buckley <byronbuckley@live.com>
Date: Thu, 15 Dec 2016 13:18:03 -0500
Subject: [PATCH] linting + documentation

---
 .eslintignore                   |   3 -
 .eslintrc.js                    |   4 +-
 app/.app.eslintrc.js            |  30 +++++++++
 app/electron.js                 |  96 +++++++++++++---------------
 app/package.json                |   4 +-
 app/src/App.vue                 |  12 ++--
 app/src/components/Login.vue    |  28 ++++----
 app/src/components/Note.vue     |  51 +++++++--------
 app/src/components/Settings.vue |  23 ++++---
 app/src/main.js                 |   6 ++
 app/src/main/auth.js            | 109 +++++++++++++++++---------------
 app/src/main/is.js              |   8 ++-
 app/src/main/onenote.js         |  73 +++++++++++----------
 app/src/main/persist.js         |   1 +
 app/src/main/store.js           |   7 ++
 builds/.gitkeep                 |   0
 16 files changed, 256 insertions(+), 199 deletions(-)
 create mode 100644 app/.app.eslintrc.js
 delete mode 100644 builds/.gitkeep

diff --git a/.eslintignore b/.eslintignore
index a1582d7..3127706 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -1,9 +1,6 @@
 app/node_modules/**
 app/src/static/**
-app/src/main/**
-app/src/components/**
 app/dist/**
-app/electron.js
 test/unit/coverage/**
 test/unit/*.js
 test/e2e/*.js
diff --git a/.eslintrc.js b/.eslintrc.js
index 10745d6..009c03c 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -23,6 +23,8 @@ module.exports = {
     'no-unused-vars': 1,
     'spaced-comment': 1,
     'no-mixed-spaces-and-tabs': 1,
-    'indent': 1
+    'indent': 1,
+    'brace-style': 1,
+    'no-trailing-spaces': 1
   }
 }
diff --git a/app/.app.eslintrc.js b/app/.app.eslintrc.js
new file mode 100644
index 0000000..ec38ebb
--- /dev/null
+++ b/app/.app.eslintrc.js
@@ -0,0 +1,30 @@
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    sourceType: 'module'
+  },
+  env: {
+    browser: true,
+    node: true
+  },
+  extends: 'standard',
+  plugins: [
+    'html'
+  ],
+  'rules': {
+    // allow paren-less arrow functions
+    'arrow-parens': 0,
+    // allow async-await
+    'generator-star-spacing': 0,
+    // allow debugger during development
+    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
+    'camelcase': 0,
+    'no-unused-vars': 1,
+    'spaced-comment': 1,
+    'no-mixed-spaces-and-tabs': 1,
+    'indent': 1,
+    'brace-style': 0,
+    'curly': 0
+  }
+}
diff --git a/app/electron.js b/app/electron.js
index ed7a371..ed7df3d 100644
--- a/app/electron.js
+++ b/app/electron.js
@@ -6,7 +6,6 @@ const path = require('path')
 const schedule = require('node-schedule')
 const is = require('./src/main/is')
 const {URLS, WINDOW, DEFAULT_SETTINGS} = require('./app.config')
-const {ONENOTE} = require('./onenote.config')
 
 const storeSettings = require('node-persist')
 storeSettings.initSync({
@@ -16,7 +15,7 @@ storeSettings.initSync({
 
 let mainWindow
 let config = {}
-let scheduleInstance;
+let scheduleInstance
 
 if (is.dev()) {
   config = require('../config')
@@ -27,10 +26,8 @@ if (is.dev()) {
 }
 
 function createWindow () {
-  /**
-   * Initial window options
-   */
-  const demo = {
+  // window config for pre build demos
+  const demoWindow = {
     height: WINDOW.height,
     width: WINDOW.width,
     resizable: true,
@@ -44,6 +41,7 @@ function createWindow () {
     maximizable: false
   }
 
+  // default window config
   const defaultWindow = {
     height: WINDOW.height,
     width: WINDOW.width,
@@ -58,8 +56,7 @@ function createWindow () {
     maximizable: false
   }
 
-  mainWindow = new BrowserWindow(defaultWindow)
-
+  mainWindow = new BrowserWindow(defaultWindow) // put demoWindow here
   mainWindow.loadURL(config.url)
 
   if (is.dev()) {
@@ -73,8 +70,7 @@ function createWindow () {
     installExtension.default(installExtension.VUEJS_DEVTOOLS)
       .then((name) => mainWindow.webContents.openDevTools())
       .catch((err) => console.log('An error occurred: ', err))
-  }
-  else {
+  } else {
     // allow dev tools in prod
     mainWindow.webContents.on('devtools-opened', (event, deviceList, callback) => {
       mainWindow.setSize(1200, 600)
@@ -82,7 +78,7 @@ function createWindow () {
     })
 
     mainWindow.webContents.on('devtools-closed', (event, deviceList, callback) => {
-      mainWindow.setSize(WINDOW.width,WINDOW.height)
+      mainWindow.setSize(WINDOW.width, WINDOW.height)
       mainWindow.setResizable(false)
     })
 
@@ -98,11 +94,10 @@ function createWindow () {
 }
 
 app.on('ready', () => {
-  settings()
-  scheduleInstance = scheduleRandomNote();
+  loadSettings()
   createWindow()
-  setGlobalShortcuts();
-  // console.log('path', app.getPath('userData'))
+  scheduleInstance = scheduleRandomNote()
+  setGlobalShortcuts()
 })
 
 app.on('window-all-closed', () => {
@@ -125,35 +120,35 @@ ipc.on('set-global-shortcuts', () => {
   setGlobalShortcuts()
 })
 
-function setGlobalShortcuts() {
-  globalShortcut.unregisterAll();
+function setGlobalShortcuts () {
+  globalShortcut.unregisterAll()
 
   globalShortcut.register(storeSettings.getItemSync('shortcutKey'), () => {
-    mainWindow.webContents.send('trigger-random-note');
+    mainWindow.webContents.send('trigger-random-note')
   })
 }
 
 function initMenu () {
-    var template = [{
-      label: 'Edit',
-      submenu: [
-        {
-          label: 'Copy',
-          accelerator: 'Command+C',
-          selector: 'copy:'
-        },
-        {
-          label: 'Paste',
-          accelerator: 'Command+V',
-          selector: 'paste:'
-        },
-        {
-          label: 'Select All',
-          accelerator: 'Command+A',
-          selector: 'selectAll:'
-        }
-      ]
-    },
+  var template = [{
+    label: 'Edit',
+    submenu: [
+      {
+        label: 'Copy',
+        accelerator: 'Command+C',
+        selector: 'copy:'
+      },
+      {
+        label: 'Paste',
+        accelerator: 'Command+V',
+        selector: 'paste:'
+      },
+      {
+        label: 'Select All',
+        accelerator: 'Command+A',
+        selector: 'selectAll:'
+      }
+    ]
+  },
     {
       label: 'Developer',
       submenu: [
@@ -169,18 +164,16 @@ function initMenu () {
       ]
     }]
 
-    var menu = Menu.buildFromTemplate(template);
-    Menu.setApplicationMenu(menu);
-  }
+  var menu = Menu.buildFromTemplate(template)
+  Menu.setApplicationMenu(menu)
+}
 
 /**
- * settings - Description
- *
- * @returns {type} Description
+ * loadSettings - persist default settings
  */
-function settings() {
+function loadSettings () {
   for (const [key, value] of DEFAULT_SETTINGS) {
-    if(storeSettings.getItemSync(key) === undefined || null || '') {
+    if (storeSettings.getItemSync(key) === undefined || null || '') {
       storeSettings.setItemSync(key, value)
     }
   }
@@ -189,22 +182,21 @@ function settings() {
 /**
  * If we did not explicitly set minute to 0,
  * the message would have instead been logged at 5:00pm, 5:01pm, ..., 5:59pm.
- *
- * @returns {type} Description
  */
 function scheduleRandomNote () {
-  let rule;
+  let rule
 
-  if(storeSettings.getItemSync('schedule') === '*/5 * * * *') {
+  if (storeSettings.getItemSync('schedule') === '*/5 * * * *') {
     rule = '*/5 * * * *' // every 5 minutes
-  }
-  else {
+  } else {
     rule = new schedule.RecurrenceRule()
     rule.dayOfWeek = [0, new schedule.Range(0, 7)]
     rule.hour = storeSettings.getItemSync('schedule')
     rule.minute = 0
   }
 
+  // return job instance so we can cancel it when schedule is updated
+  // via settings
   return schedule.scheduleJob(rule, function () {
     mainWindow.webContents.send('trigger-random-note')
   })
diff --git a/app/package.json b/app/package.json
index 0e55920..4ac9d0b 100644
--- a/app/package.json
+++ b/app/package.json
@@ -14,6 +14,8 @@
     "vue-electron": "^1.0.0",
     "vue-resource": "^1.0.3"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "standard": "^8.6.0"
+  },
   "author": "Byron Buckley <byronbuckley@live.com>"
 }
diff --git a/app/src/App.vue b/app/src/App.vue
index dcf4d82..2af3440 100644
--- a/app/src/App.vue
+++ b/app/src/App.vue
@@ -45,12 +45,13 @@ import Login from './components/Login.vue'
 import Note from './components/Note.vue'
 import Settings from './components/Settings.vue'
 import is from './main/is'
-const { shell } = require('electron')
 
-const auth = require('./main/auth')
-const {setNoteSection} = require('./main/onenote')
+const {shell} = require('electron')
 const {app} = require('electron').remote
 const path = require('path')
+
+const auth = require('./main/auth')
+const {setNoteSection} = require('./main/onenote')
 const {URLS, WINDOW} = require('../app.config')
 const storeSettings = require('node-persist')
 storeSettings.initSync({dir: path.join(app.getPath('userData'), URLS.SETTINGS)})
@@ -59,7 +60,6 @@ window.onload = function () {
   console.log('loaded')
 }
 
-// export default $rootVm
 export default {
   data: function () {
     return {
@@ -90,10 +90,6 @@ export default {
     }
   },
 
-  watch: {
-
-  },
-
   components: {
     Login,
     Note,
diff --git a/app/src/components/Login.vue b/app/src/components/Login.vue
index 99ea6b2..f3e6d5e 100644
--- a/app/src/components/Login.vue
+++ b/app/src/components/Login.vue
@@ -24,12 +24,13 @@
 </template>
 
 <script>
-  const {app, BrowserWindow, ipcMain, ipcRenderer} = require('electron').remote
+  /* global $ */
+  const {app, BrowserWindow} = require('electron').remote
   const path = require('path')
   const {URLS} = require('../../app.config')
   const {ONENOTE} = require('../../onenote.config')
-  const {requestOneNoteToken, refreshOneNoteToken, hasAccessToken} = require('../main/auth')
-  const {setNoteSection, getRandomNote} = require('../main/onenote')
+  const {requestOneNoteToken, hasAccessToken} = require('../main/auth')
+  const {setNoteSection} = require('../main/onenote')
   const storeSettings = require('node-persist')
   storeSettings.initSync({dir: path.join(app.getPath('userData'), URLS.SETTINGS)})
 
@@ -47,7 +48,7 @@
       },
 
       handleLogin: function () {
-        if(hasAccessToken()) {
+        if (hasAccessToken()) {
           this.onAuth()
           this.$emit('toggleLogon')
         }
@@ -76,13 +77,13 @@
         })
 
         let handleCallback = (url) => {
-          var raw_code = /code=([^&]*)/.exec(url) || null
-          var code = (raw_code && raw_code.length > 1) ? raw_code[1] : null
-          var error = /\?error=(.+)$/.exec(url)
+          let raw_code = /code=([^&]*)/.exec(url) || null
+          let code = (raw_code && raw_code.length > 1) ? raw_code[1] : null
+          let error = /\?error=(.+)$/.exec(url)
 
+          // Close the browser if code found or error
           if (code || error) {
-              // Close the browser if code found or error
-            this.$emit('toggleLogon')
+            this.$emit('toggleLogon') // based on login state
             authWindow.destroy()
           }
 
@@ -95,7 +96,7 @@
               client_secret: ONENOTE.client_secret,
               redirect_uri: ONENOTE.redirect_uri
             })
-      			.then(() => {
+            .then(() => {
               this.onAuth()
               this.$emit('toggleLogon') // hide login, show main window
             })
@@ -106,16 +107,15 @@
           else if (error) {
             console.log('authOneNote', decodeURIComponent(error.toString()))
             /** TODO: update error state and display on login **/
-      //		('Oops! Something went wrong and we couldn\'t ' +'log you in using OneNote. Please try again.')
           }
         }
 
-      	// If "Done" button is pressed, hide "Loading"
+        // If "Done" button is pressed
         authWindow.on('close', () => {
           authWindow.destroy()
         })
 
-      	// handle the response from OneNote
+        // handle the response from OneNote
         authWindow.webContents.on('will-navigate', (event, url) => {
           handleCallback(url)
         })
@@ -124,7 +124,7 @@
           handleCallback(newUrl)
         })
 
-      	// reset the authWindow on close
+        // reset the authWindow on close
         authWindow.on('close', () => {
           authWindow = null
         }, false)
diff --git a/app/src/components/Note.vue b/app/src/components/Note.vue
index 3b3ed11..4d47b5d 100644
--- a/app/src/components/Note.vue
+++ b/app/src/components/Note.vue
@@ -35,13 +35,13 @@
 </template>
 
 <script>
+  /* global Notification */
   import $ from 'jquery'
   const { ipcRenderer: ipc, shell } = require('electron')
+  const path = require('path')
   const { getRandomNote } = require('../main/onenote')
-  const { refreshOneNoteToken } = require('../main/auth')
-  const { URLS, WINDOW } = require('../../app.config')
+  const { URLS } = require('../../app.config')
   const {app} = require('electron').remote
-  const path = require('path')
   const storeSettings = require('node-persist')
   storeSettings.initSync({dir: path.join(app.getPath('userData'), URLS.SETTINGS)})
 
@@ -68,39 +68,40 @@
       showAbout: function () {
         $('#about').modal('show')
       },
+      // get a random note update the UI, conditionally push a notification
       handleRandomNote: function (withNotification = true) {
-        this.loading = true
+        this.loading = true // show loading overlay
         getRandomNote()
         .then((note) => {
           const { title, noteLinks, preview: {previewText, links} } = note
-    			this.title = title
-    			this.body = previewText
-    			this.imgUrl = (links.previewImageUrl.href === null) ? URLS.THUMBNAIL : links.previewImageUrl.href
+          this.title = title
+          this.body = previewText
+          this.imgUrl = (links.previewImageUrl.href === null) ? URLS.THUMBNAIL : links.previewImageUrl.href
           this.noteLinks = noteLinks
+          this.loading = false // hide loading overlay
 
-          this.loading = false
-
-          if(withNotification)
+          if (withNotification) {
             this.renderNotification(note)
-    		})
-    		.catch((err) => {
+          }
+        })
+        .catch((err) => {
           this.loading = false
-    			console.log(err)
-    		})
+          console.log(err)
+        })
       },
       renderNotification: function (note) {
-        const vm = this
-      	const { title, noteLinks, preview: {previewText, links} } = note
-      	let myNotification = new Notification(title, {
-      		body: previewText,
-      		icon: (links.previewImageUrl.href !== null) ? links.previewImageUrl.href : ''
-      	})
-
-      	myNotification.addEventListener('click', () => {
-      		const { oneNoteClientUrl, oneNoteWebUrl } = noteLinks
-          ipc.send('show-app-window')
-      	})
+        const { title, preview: {previewText, links} } = note
+        let myNotification = new Notification(title, {
+          body: previewText,
+          icon: (links.previewImageUrl.href !== null) ? links.previewImageUrl.href : ''
+        })
+
+        myNotification.addEventListener('click', () => {
+          ipc.send('show-app-window') // clicking the notification shows the app window
+        })
       },
+      // clicking the note title in the app window opens the note in the client
+      // defined in settings
       openOneNoteClient: function () {
         const { oneNoteClientUrl, oneNoteWebUrl } = this.noteLinks
         shell.openExternal((storeSettings.getItemSync('openWith') === 'OneNote') ? oneNoteClientUrl.href : oneNoteWebUrl.href)
diff --git a/app/src/components/Settings.vue b/app/src/components/Settings.vue
index a0e7b3e..6282601 100644
--- a/app/src/components/Settings.vue
+++ b/app/src/components/Settings.vue
@@ -34,7 +34,7 @@
             Every?
           </label>
           <select v-model='settings.schedule' id='setSchedule' class="ui simple dropdown"
-          @change='handleChangedSettings'
+          @change='logChangedSettings'
           >
             <option v-for="{time, label} in schedules"
               :value='time'>
@@ -44,14 +44,14 @@
         </div>
         <div class="field">
           <label for='toggleOpeningMethod'>Open with?</label>
-          <select @change='handleChangedSettings' v-model='settings.openWith' id='toggleOpeningMethod' class="ui simple dropdown">
+          <select @change='logChangedSettings' v-model='settings.openWith' id='toggleOpeningMethod' class="ui simple dropdown">
             <option value="Browser">Browser</option>
             <option value="OneNote" >OneNote</option>
           </select>
         </div>
         <div id='setShortCut' class="field">
           <label for='setShortCut'>
-            Shortcut Key ({{settings.shortcutKey.join('+')}})
+            Shortcut Key ({{cleanShortcutKey(settings.shortcutKey.join('+'))}})
           </label>
           <div class="ui toggle checkbox">
             <input disabled id="global-shortcut-ctrl" v-model='settings.shortcutKey' value="CmdOrCtrl" type="checkbox">
@@ -84,14 +84,13 @@
   import is from '../main/is'
   const { ipcRenderer: ipc } = require('electron')
 
-  const {URLS, WINDOW} = require('../../app.config')
-  const {logout} = require('../main/auth')
+  const {URLS} = require('../../app.config')
+  const auth = require('../main/auth')
   const {app} = require('electron').remote
   const path = require('path')
   const storeSettings = require('node-persist')
   storeSettings.initSync({dir: path.join(app.getPath('userData'), URLS.SETTINGS)})
 
-
   let Settings = {
     template: '#settings',
     data: function () {
@@ -109,18 +108,19 @@
           schedule: storeSettings.getItemSync('schedule'),
           openWith: storeSettings.getItemSync('openWith'),
           shortcutKey: storeSettings.getItemSync('shortcutKey').split('+')
-        },
+        }
       }
     },
 
     methods: {
       handleLogout () {
         $('#settings').modal('hide')
-        logout()
+        auth.logout()
         this.$emit('toggleLogon')
       },
+      // persist settings, send related events to main process
       handleSave () {
-        this.handleChangedSettings()
+        this.logChangedSettings()
         storeSettings.setItemSync('schedule', this.settings.schedule)
         storeSettings.setItemSync('openWith', this.settings.openWith)
         storeSettings.setItemSync('shortcutKey', this.settings.shortcutKey.join('+'))
@@ -128,12 +128,15 @@
         ipc.send('reset-schedule')
         $('#settings').modal('hide')
       },
-      handleChangedSettings () {
+      logChangedSettings () {
         console.log(this.settings.sectionName)
         console.log(this.settings.schedule)
         console.log(this.settings.openWith)
         console.log(this.settings.shortcutKey)
         console.log(storeSettings.getItemSync('shortcutKey'))
+      },
+      cleanShortcutKey (shortcutKey) {
+        return shortcutKey.replace('CmdOrCtrl', this.CmdOrCtrl)
       }
     }
   }
diff --git a/app/src/main.js b/app/src/main.js
index 0f1b32c..86a5ec9 100644
--- a/app/src/main.js
+++ b/app/src/main.js
@@ -14,6 +14,12 @@ import App from './App'
 /* eslint-disable no-new */
 let vm = new Vue({...App}).$mount('#app')
 
+/**
+ * Triggers a random note based on the schedule rule defined in the main process
+ * Achieved using a child component ref: https://vuejs.org/v2/guide/components.html#Child-Component-Refs
+ * Efforts to do this from within the Note component only triggered the Notification
+ * but didn't update the Note component UI
+ */
 ipc.on('trigger-random-note', function () {
   let cmpNote = vm.$children.filter(child => child.$el.id === 'note')
   cmpNote[0].$refs.btnRandomNote.click()
diff --git a/app/src/main/auth.js b/app/src/main/auth.js
index fd251fe..886ff51 100644
--- a/app/src/main/auth.js
+++ b/app/src/main/auth.js
@@ -1,57 +1,55 @@
 const apiRequests = require('superagent')
-const {URLS,TIMEOUTS} = require('../../app.config')
+const {URLS, TIMEOUTS} = require('../../app.config')
 const {ONENOTE} = require('../../onenote.config')
 const storage = require('./store')
 
-function requestOneNoteToken (options) {
+/**
+ * Exchange the authorization code for an access token [and refresh token]. 
+ * Send the following HTTP request with a properly encoded URL string in the message body.
+ * https://msdn.microsoft.com/en-us/office/office365/howto/onenote-auth#code-flow
+ * 
+ * @returns {Promise} Ensures the caller acts after response is received
+ */
+function requestOneNoteToken (postParams) {
   return new Promise((resolve, reject) => {
     apiRequests
-			.post(URLS.OAUTH_TOKEN, options)
-            .timeout(TIMEOUTS)
-			.set('Content-Type', 'application/x-www-form-urlencoded')
-			.then(function (response) {
-        if (response && response.ok) {
-					// Success - Received Token.
-					// TODO: use spread in update
-          const {body} = response
-          const onenote = {
-            token_type: body.token_type,
-            expires_in: body.expires_in,
-            scope: body.scope,
-            access_token: body.access_token,
-            refresh_token: body.refresh_token,
-            user_id: body.user_id,
-            datestamp: Date.now()
-          }
-          // debugger
-          storage.setItem('onenote', onenote)
-          resolve()
-        }
-        else {
-          console.log(options.grant_type, response)
-          reject(response)
-        }
-      })
-			.catch(function (err) {
-        console.log(options.grant_type, err)
-        reject(err)
-      })
+    .post(URLS.OAUTH_TOKEN, postParams)
+    .timeout(TIMEOUTS)
+    .set('Content-Type', 'application/x-www-form-urlencoded')
+    .then(function (response) {
+      if (response && response.ok) {
+        // Success - Received Token.
+        storage.setItem('onenote', { datestamp: Date.now(), ...response.body })
+        resolve()
+      } else {
+        console.log(postParams.grant_type, response)
+        reject(response)
+      }
+    })
+    .catch(function (err) {
+      console.log(postParams.grant_type, err)
+      reject(err)
     })
+  })
 }
 
 /**
- *
+ * Get a new access token after it expires (consumer apps)
+ * Request a new access token by using the refresh token or 
+ * by repeating the auth process from the beginning.
+ * When an access token expires, requests to the API return a 401 Unauthorized response.
+ * https://msdn.microsoft.com/en-us/office/office365/howto/onenote-auth#code-flow
+ * 
+ * @returns {Promise} Ensures the caller acts after response is received
  */
 function refreshOneNoteToken () {
   return new Promise((resolve, reject) => {
     if (isTokenExpired() === true) {
-      const {datestamp, expires_in, refresh_token} = storage.getItem('onenote')
+      const {refresh_token} = storage.getItem('onenote')
       requestOneNoteToken({
         grant_type: 'refresh_token',
-        client_id: ONENOTE.client_id,
-        client_secret: ONENOTE.client_secret,
-        redirect_uri: ONENOTE.redirect_uri,
-        refresh_token: refresh_token
+        refresh_token: refresh_token,
+        ...ONENOTE
       })
       .then(() => {
         resolve()
@@ -59,20 +57,19 @@ function refreshOneNoteToken () {
       .catch(() => {
         reject()
       })
-    }
-    else {
+    } else {
       resolve()
     }
   })
 }
 
-
 /**
  * - Delete any cached access tokens or refresh tokens you've received or stored.
- * - Perform any sign out actions in your application (for example, cleaning up local state, removing any cached items, etc.).
- * - Make a call to the authorization service using this URL:
- *
- * @returns {type} Description
+ * - Perform any sign out actions in your application 
+ * (for example, cleaning up local state, removing any cached items, etc.).
+ * - Make a call to the authorization service
+ * 
+ * https://msdn.microsoft.com/en-us/office/office365/howto/onenote-auth#code-flow
  */
 function logout () {
   storage.removeItem('onenote')
@@ -87,8 +84,7 @@ function logout () {
     .then(function (response) {
       if (response && response.ok) {
         console.log('Logged out?', response.ok)
-      }
-      else {
+      } else {
         console.log(response)
       }
     })
@@ -97,11 +93,14 @@ function logout () {
     })
 }
 
+/**
+ * Primarily used by refreshOneNoteToken() to determine if a token is required
+ * @returns {Boolean} 
+ */
 function isTokenExpired () {
   if (storage.getItem('onenote') === null) {
     return true
-  }
-  else {
+  } else {
     const {datestamp, expires_in} = storage.getItem('onenote')
     if (Date.now() - parseInt(datestamp) > expires_in) {
       return true
@@ -110,11 +109,19 @@ function isTokenExpired () {
   return false
 }
 
+/**
+ * The app initiates the sign-in process by contacting the authorization service. 
+ * If authentication and authorization are successful, 
+ * you'll receive an access token that you include in your requests to the OneNote API.
+ * Therefore the presence of a token generally indicates login state
+ * https://msdn.microsoft.com/en-us/office/office365/howto/onenote-auth#code-flow
+ * 
+ * @returns {boolean}
+ */
 function hasAccessToken () {
   if (storage.getItem('onenote') === null) {
     return false
-  }
-  else {
+  } else {
     const {access_token} = storage.getItem('onenote')
 
     if (access_token === undefined || null || '') {
diff --git a/app/src/main/is.js b/app/src/main/is.js
index b1ef949..e5fb8df 100644
--- a/app/src/main/is.js
+++ b/app/src/main/is.js
@@ -1,10 +1,14 @@
+/**
+ * Webpack & electron-is (https://www.npmjs.com/package/electron-is) couldnt agree
+ * so just do this
+ */
 const os = require('os')
 
-function dev() {
+function dev () {
   return process.env.NODE_ENV === 'development'
 }
 
-function osx() {
+function osx () {
   return os.type() === 'Darwin'
 }
 
diff --git a/app/src/main/onenote.js b/app/src/main/onenote.js
index 9f92495..a7ce9be 100644
--- a/app/src/main/onenote.js
+++ b/app/src/main/onenote.js
@@ -1,22 +1,29 @@
 const {app} = require('electron').remote
 const path = require('path')
 const apiRequests = require('superagent')
-const Chance = require('chance'), chance = new Chance()
 const {URLS, TIMEOUTS} = require('../../app.config')
-const {ONENOTE} = require('../../onenote.config')
 const {refreshOneNoteToken} = require('./auth')
 const storage = require('./store')
+
 const storeSettings = require('node-persist')
 storeSettings.initSync({
   dir: path.join(app.getPath('userData'), URLS.SETTINGS)
 })
-
+const Chance = require('chance')
+const chance = new Chance()
 
 /**
- *
+ * This is where the magic happens but the magic can't happen without:
+ * - a fresh token (conditional HTTP request)
+ * - a note section id (conditional HTTP request)
+ * - Best case only one HTTP request is required, 
+ * on avg it will be two, since most schedules are daily
+ * 
+ * Ref Mistake #4: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html
+ * 
+ * @returns {Promise}
  */
 function getRandomNote () {
-  // debugger
   return refreshOneNoteToken()
     .then(hasNoteSection)
     .then(p)
@@ -27,7 +34,7 @@ function getRandomNote () {
   function hasNoteSection () {
     return Promise.resolve()
       .then(() => {
-        if(storage.getItem('onenote_section_id') === null) {
+        if (storage.getItem('onenote_section_id') === null) {
           return setNoteSection(storeSettings.getItemSync('sectionName'))
         }
       })
@@ -44,20 +51,19 @@ function getRandomNote () {
         .timeout(TIMEOUTS)
         .set('Authorization', `Bearer ${access_token}`)
         .then(function (response) {
-            if (response && response.ok) {
-              const notes = response.body.value
-              console.log('notes', notes.length)
-              const note = notes[chance.natural({min: 0, max: (notes.length - 1)})]
-              resolve(getNotePreview(note))
-            }
-            else {
-              console.log(response)
-              reject(response)
-            }
+          if (response && response.ok) {
+            const notes = response.body.value
+            console.log('notes', notes.length)
+            const note = notes[chance.natural({min: 0, max: (notes.length - 1)})]
+            resolve(getNotePreview(note))
+          } else {
+            console.log(response)
+            reject(response)
+          }
         })
         .catch(function (err) {
-            console.log(err)
-            reject(err)
+          console.log(err)
+          reject(err)
         })
     })
   }
@@ -67,8 +73,7 @@ function getRandomNote () {
  * setNoteSection - Description
  *
  * @param {string} [section=Quotes] Description
- *
- * @returns {type} Description
+ * @returns {Promise} Description
  */
 function setNoteSection (sectionName) {
   return refreshOneNoteToken()
@@ -88,16 +93,14 @@ function setNoteSection (sectionName) {
         .set('Authorization', `Bearer ${access_token}`)
         .then(function (response) {
           if (response && response.ok) {
-            if(response.body.value.length === 0) {
+            if (response.body.value.length === 0) {
               alert(`Please create a section with the name '${sectionName}' and restart the app.`)
               reject()
-            }
-            else {
+            } else {
               storage.setItem('onenote_section_id', response.body.value[0].id)
               resolve(response.body.value[0].id)
             }
-          }
-          else {
+          } else {
             console.log(response)
             reject(response)
           }
@@ -106,19 +109,25 @@ function setNoteSection (sectionName) {
           console.log(err)
           reject(err)
         })
-      })
+    })
   }
 }
 
 /**
- * getNotePreview - Description
+ * getNotePreview - getRandomNote() uses this
+ * to provide a note object to the UI 
+ * What's neat is when I tried this in Rails (2015)
+ * There was no page preview endpoint, so I had to strip the HTML from the page.
+ * The preview enpoint provides a previewText snippet as plain text
+ * and an optional previewImageUrl which I use to embelish the display
+ * of notes and notifications.
+ * https://dev.onenote.com/docs#/reference/get-pages/v10menotespagesidpreview/get
  *
- * @param {type} note Description
- *
- * @returns {type} Description
+ * @param {Object} note
+ * @returns {Promise} Description
  */
 function getNotePreview (note) {
-  const { id, links, self: url, title } = note
+  const { links, self: url, title } = note
 
   return new Promise((resolve, reject) => {
     const {access_token} = storage.getItem('onenote')
@@ -139,7 +148,7 @@ function getNotePreview (note) {
         console.log(err)
         reject(err)
       })
-    })
+  })
 }
 
 module.exports = {
diff --git a/app/src/main/persist.js b/app/src/main/persist.js
index a145963..3192608 100644
--- a/app/src/main/persist.js
+++ b/app/src/main/persist.js
@@ -1,3 +1,4 @@
+/** placeholder **/
 const storage = require('node-persist')
 
 module.exports = {
diff --git a/app/src/main/store.js b/app/src/main/store.js
index 3298d06..b193dea 100644
--- a/app/src/main/store.js
+++ b/app/src/main/store.js
@@ -1,3 +1,10 @@
+/* global localStorage */
+
+/**
+ * Wrapper for localStorage
+ * May consider localForage in the future:
+ * https://www.npmjs.com/package/localforage
+ */
 const storage = localStorage
 
 let getItem = function (key) {
diff --git a/builds/.gitkeep b/builds/.gitkeep
deleted file mode 100644
index e69de29..0000000