orator 3.0.6 → 3.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orator",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "Unopinionated restful web API server container",
   "main": "source/Orator.js",
   "scripts": {
@@ -50,6 +50,7 @@
   "devDependencies": {
     "browserify": "^17.0.0",
     "chai": "4.3.7",
+    "fable": "^3.0.7",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-sourcemaps": "^3.0.0",
@@ -63,8 +64,6 @@
   },
   "dependencies": {
     "async": "^3.2.4",
-    "fable": "^3.0.7",
-    "find-my-way": "^7.5.0",
-    "orator-serviceserver": "^1.0.2"
+    "find-my-way": "^7.5.0"
   }
 }

package/source/Orator-ServiceServer-Base.js

@@ -0,0 +1,160 @@
+class OratorServiceServerBase
+{
+	constructor(pOrator)
+	{
+		this.orator = pOrator;
+
+		this.log = pOrator.log;
+
+		this.Name = this.orator.settings.Product;
+		this.URL = 'BASE_SERVICE_SERVER';
+		this.Port = this.orator.settings.ServicePort;
+
+		this.Active = false;
+	}
+
+	/*
+	 * Service Lifecycle Functions
+	 *************************************************************************/
+	listen(pPort, fCallback)
+	{
+		// Sometimes, listen does not listen on network calls.
+		this.Active = true;
+
+		return fCallback();
+	}
+
+	close(fCallback)
+	{
+		this.Active = false;
+
+		return fCallback();
+	}
+	/*************************************************************************
+	 * End of Service Lifecycle Functions
+	 */
+
+	use(fHandlerFunction)
+	{
+		if (typeof(fHandlerFunction) != 'function')
+		{
+			this.log.error(`Orator USE global handler mapping failed -- parameter was expected to be a function with prototype function(Request, Response, Next) but type was ${typeof(fHandlerFunction)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+
+	/*
+	 * Service Route Creation Functions
+	 *
+	 * These base functions provide basic validation for the routes, but don't actually 
+	 * do anything with them.  The design intent here is to allow derived classes to call
+	 * these functions to validate that they conform to expected standards.
+	 *
+	 * Something like:
+
+		get (pRoute, ...fRouteProcessingFunctions)
+		{
+			if (!super.get(pRoute, ...fRouteProcessingFunctions))
+			{
+				this.log.error(`Restify provider failed to map route [${pRoute}]!`);
+				return false;
+			}
+
+			//...now we can do our actual get mapping function!....
+		}
+
+	 * This pattern and calling super is totally optional, obviously.
+	 *************************************************************************/
+	get(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator GET Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	put(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator PUT Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	post(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator POST Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	del(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator DEL Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	patch(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator PATCH Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	opts(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator OPTS Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+
+	head(pRoute, ...fRouteProcessingFunctions)
+	{
+		if (typeof(pRoute) != 'string')
+		{
+			this.log.error(`Orator HEAD Route mapping failed -- route parameter was ${typeof(pRoute)} instead of a string.`)
+			return false;
+		}
+
+		return true;
+	}
+	/*************************************************************************
+	 * End of Service Route Creation Functions
+	 */
+
+	// Programmatically invoke a route
+	invoke(pMethod, pRoute, pData, fCallback)
+	{
+		// The base class version of this does nothing
+		this.log.debug(`Orator invoke called for route [${pRoute}] and landed on the base class; the service provider likely does not implement programmatic invoke capabilities.`, pData);
+		return false;
+	}
+}
+
+module.exports = OratorServiceServerBase;

package/source/Orator-ServiceServer-IPC.js

@@ -1,4 +1,4 @@
-const libOratorServiceServerBase = require('orator-serviceserver');
+const libOratorServiceServerBase = require('./Orator-ServiceServer-Base.js');
 
 // A synthesized response object, for simple IPC.
 const libOratorServiceServerIPCSynthesizedResponse = require('./Orator-ServiceServer-IPC-SynthesizedResponse.js');

package/source/Orator.js

@@ -7,8 +7,6 @@
 * @module Orator Service
 */
 
-const libFable = require('fable');
-
 const defaultOratorConfiguration = require('./Orator-Default-Configuration.js');
 const defaultOratorServiceServers = require('./Orator-Default-ServiceServers-Node.js');
 
@@ -16,20 +14,8 @@ class Orator
 {
 	constructor(pFable, pServiceProvider)
 	{
-		// Need to figure out if pFable is a Fable object or a Settings object or neither
-		if ((typeof(pFable) === 'object') && (pFable instanceof libFable))
-		{
-			// We were passed a fully operational fable -- use this
-			this.fable = pFable;
-		}
-		else if (typeof(pFable) == 'object')
-		{
-			this.fable = new libFable(pFable);
-		}
-		else
-		{
-			this.fable = new libFable(defaultOratorConfiguration);
-		}
+		// We were passed a fully operational fable -- use this
+		this.fable = pFable;
 
 		// Carry core application requirements into the orator object for simplicity
 		this.settings = this.fable.settings;
@@ -176,3 +162,4 @@ class Orator
 }
 
 module.exports = Orator;
+module.exports.ServiceServerBase = require('./Orator-ServiceServer-Base.js');

package/test/Orator_basic_tests.js

@@ -14,14 +14,12 @@ const Assert = Chai.assert;
 
 //const libSuperTest = require('supertest');
 const libFable = require('fable');
-const _Fable = new libFable({Product:'Orator-BasicTests-Backplane'});
-
-const _MockSettings = (
-{
-	Product: 'MockOratorAlternate',
-	ProductVersion: '0.0.0',
-	APIServerPort: 8099
-});
+const _Fable = new libFable(
+	{
+		Product:'Orator-BasicTests-Backplane',
+		ProductVersion: '0.0.0',
+		APIServerPort: 8099
+	});
 
 suite
 (
@@ -38,7 +36,7 @@ suite
 					'initialize should build a happy little object',
 					(fDone) =>
 					{
-						let tmpOrator = new libOrator();
+						let tmpOrator = new libOrator(_Fable);
 						Expect(tmpOrator).to.be.an('object', 'Orator should initialize as an object directly from the require statement.');
 						Expect(tmpOrator.startService).to.be.an('function');
 						Expect(tmpOrator.settings).to.be.an('object');
@@ -51,13 +49,17 @@ suite
 					'orator should be able to initialize and start a service with no effort',
 					(fDone) =>
 					{
-						let tmpOrator = new libOrator();
+						let tmpOrator = new libOrator(_Fable);
 						// Start the service server
 						tmpOrator.initializeServiceServer();
 						// Start the service
 						Expect(tmpOrator.serviceServer.Active).to.equal(false);
-						tmpOrator.startService(fDone);
-						Expect(tmpOrator.serviceServer.Active).to.equal(true);
+						tmpOrator.startService(
+							()=>
+							{
+								Expect(tmpOrator.serviceServer.Active).to.equal(true);
+								fDone();
+							});
 					}
 				);
 
@@ -66,7 +68,7 @@ suite
 					'ipc should be able to provide basic endpoint functionality',
 					(fDone) =>
 					{
-						let tmpOrator = new libOrator();
+						let tmpOrator = new libOrator(_Fable);
 						// Initialize the service server
 						tmpOrator.initializeServiceServer();
 						// Start the service
@@ -102,7 +104,7 @@ suite
 					'ipc should be able to process any number of handler additions with the use function',
 					(fDone) =>
 					{
-						let tmpOrator = new libOrator();
+						let tmpOrator = new libOrator(_Fable);
 						// Initialize the service server
 						tmpOrator.initializeServiceServer();
 						// Start the service