Moved all Plex stuff to its own module object

Tests back up and running

Author: OverloadUT

Gruntfile.js

@@ -52,6 +52,17 @@ module.exports = function(grunt) {
                 command: 'deploy.bat'
             }
         },
+        jsdoc : {
+            dist : {
+                src: ['*.js', 'lib/**/*.js', 'test/*.js'],
+                options: {
+                    destination: 'jsdoc',
+                    template : "node_modules/ink-docstrap/template",
+                    configure : "node_modules/ink-docstrap/template/jsdoc.conf.json",
+                    readme: "README.md"
+                }
+            }
+        }
     });
 
     // Coveralls support
@@ -68,6 +79,7 @@ module.exports = function(grunt) {
     grunt.loadNpmTasks('grunt-shell');
     grunt.loadNpmTasks('grunt-mocha-test');
     grunt.loadNpmTasks('grunt-mocha-istanbul');
+    grunt.loadNpmTasks('grunt-jsdoc');
 
     // Default task(s).
     grunt.registerTask('default', ['mocha_istanbul:coverage']);

index.js

@@ -1,19 +1,14 @@
+/**
+ * @module
+ */
+
 require('dotenv').load();
-var common = require('./lib/common.js');
-var db = require('./lib/db.js');
-var stateMachine = require('./lib/statemachine.js');
+var app = require('./lib/app');
+var db = require('./lib/db');
+var stateMachine = require('./lib/statemachine');
 var User = require('./lib/user');
 var Alexa = require('alexa-app');
-
-//console.error = function(err) {
-//        console.log(err);
-//        console.log(err.stack);
-//};
-
-// HACK this is pretty terrible, but it's the only way I could get it to work with proxyquire in the unit tests :(
-// There is a better way I'm sure. TODO fix it.
-common.PlexAPI = require('plex-api');
-common.PlexPinAuth = require('plex-api-pinauth');
+var Plex = require('./lib/plex');
 
 /**
  * The main AWS Lambda handler.
@@ -29,19 +24,22 @@ exports.handler = function(event, context) {
         }
     }
 
-    common.app = new Alexa.app('plex');
+    app.skill = new Alexa.app('plex');
+    app.plex = new Plex.Plex();
 
     db.initializeUserRecord(event.session.user.userId).then(function(dbuser) {
-        common.user = new User(dbuser);
+        app.user = new User(dbuser);
+        app.plex.pinAuth.token = app.user.authtoken;
 
-        if(!common.user.authtoken) {
+        if(!app.user.authtoken) {
             return stateMachine.initApp('not-authed');
         } else {
             return stateMachine.initApp('authed');
         }
     }).then(function() {
-        common.app.lambda()(event, context);
+        app.skill.lambda()(event, context);
     }).catch(function(err) {
         console.error(err);
+        console.error(err.stack);
     });
 };

lib/app.js

@@ -0,0 +1,28 @@
+/**
+ * @module app
+ */
+
+/**
+ * @name module:app
+ */
+app = module.exports = {
+    /** @type {module:Plex~Plex} */
+    plex: null,
+
+    // TODO figure out how to properly jsdoc this so that it is recognized as an alexa-app.app object
+    /** @type {Object} */
+    skill: null,
+
+    /**
+     * How confident we need to be when trying to figure out which show a user is talkijng about
+     * @const
+     */
+    CONFIDICE_CONFIRM_THRESHOLD: 0.4,
+
+    /**
+     * The invocation name used for this app. Used in many responses so put here in case it changes.
+     * @const
+     * @type {string}
+     */
+    INVOCATION_NAME: "the home theater"
+};

lib/common.js

@@ -171,7 +171,7 @@ function updateUserPlayer(user, player) {
         }
 
         if(typeof user === 'object') {
-            user.dbobject = data.Attributes; // TODO this is broken
+            user.dbobject = data.Attributes;
         }
 
         deferred.fulfill(data);

lib/db.js

@@ -0,0 +1,131 @@
+/**
+ * @module Plex
+ */
+
+"use strict";
+var PlexAPI = require('plex-api');
+var PlexPinAuth = require('plex-api-pinauth');
+var app = require('./app');
+
+require('dotenv').load('../');
+
+/**
+ * The app config used in all Plex API requests for the X-Plex headers describing this app
+ * @const
+ * @type {{product: {String}, version: {String}, device: {String}, deviceName: {String}, identifier: {String}}}
+ */
+var PLEX_APP_CONFIG = {
+    product: process.env.APP_PRODUCT,
+    version: process.env.APP_VERSION,
+    device: process.env.APP_DEVICE,
+    deviceName: process.env.APP_DEVICE_NAME,
+    identifier: process.env.APP_IDENTIFIER
+};
+
+/**
+ * Creates a new Plex object, which handles the stateful objects from the plex-api library
+ * @constructor Plex
+ * @classdesc A container for the multiple stateful plex-api objects needed for the app
+ */
+var Plex = function() {
+    var context = this;
+
+    /**
+     * The stateful PlexPinAuth object that provides handy PIN auth functions
+     * @member {PlexPinAuth}
+     */
+    this.pinAuth = new PlexPinAuth();
+
+    /**
+     * @private
+     * @member {?PlexAPI}
+     */
+    this._pms = null;
+    /**
+     * @private
+     * @member {?PlexAPI}
+     */
+    this._web = null;
+    this.initializeWebApi();
+
+    /**
+     * @type {PlexAPI}
+     * @name module:Plex~Plex#pms
+     * @memberof module:Plex~Plex
+     */
+    Object.defineProperty(this, 'pms', {
+        get: function() {
+            if(!context._pms) {
+                if(!context.initializeServerApi()) {
+                    throw new ReferenceError("Tried to access Plex.pms before it has been initialized");
+                }
+            }
+            return context._pms;
+        }
+    });
+
+    /**
+     * @type {PlexAPI}
+     * @name module:Plex~Plex#web
+     * @memberof module:Plex~Plex
+     */
+    Object.defineProperty(this, 'web', {
+        get: function() {
+            if(!context._pms) {
+                if(!context.initializeWebApi()) {
+                    throw new ReferenceError("Tried to access Plex.web before it has been initialized");
+                }
+            }
+            return context._web;
+        }
+    });
+};
+
+/**
+ * Initializes the "web" instance of the Plex API
+ * @returns {Boolean} true if creation of the API object was successful
+ */
+Plex.prototype.initializeWebApi = function() {
+    this._web = new PlexAPI({
+        hostname: 'plex.tv',
+        port: 443,
+        https: true,
+        authenticator: this.pinAuth,
+        options: PLEX_APP_CONFIG
+    });
+
+    return true;
+};
+
+/**
+ * Initializes the "server" instance of the Plex API
+ * The user must have a server configured or the creation will fail
+ * @returns {Boolean} true if creation of the API object was successful
+ */
+Plex.prototype.initializeServerApi = function() {
+    if(!app.user.server) {
+        return false;
+    }
+
+    this._pms = new PlexAPI({
+        hostname: app.user.hostname,
+        port: app.user.port,
+        https: app.user.https,
+        authenticator: this.pinAuth,
+        options: PLEX_APP_CONFIG
+    });
+
+    return true;
+};
+
+/**
+ * Sets the auth token to be used on all future API calls
+ * @param {String} authtoken - The auth token
+ */
+Plex.prototype.setAuthToken = function(authtoken) {
+    this.pinAuth.token = authtoken;
+};
+
+module.exports = {
+    Plex: Plex
+};