fable 3.0.35 → 3.0.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fable",
-  "version": "3.0.35",
+  "version": "3.0.37",
   "description": "An entity behavior management and API bundling library.",
   "main": "source/Fable.js",
   "scripts": {
@@ -10,7 +10,7 @@
     "build": "./node_modules/.bin/gulp build",
     "build-compatible": "GULP_CUSTOM_BUILD_TARGET=compatible ./node_modules/.bin/gulp build",
     "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/fable:local",
-    "docker-dev-run": "docker run -it -d --name retold-fable-dev -p 30001:8080 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/fable\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/fable:local"
+    "docker-dev-run": "docker run -it -d --name retold-fable-dev -p 30001:8080 -p 8086:8086 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/fable\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/fable:local"
   },
   "mocha": {
     "diff": true,
@@ -30,6 +30,9 @@
       "lib/vendor"
     ]
   },
+  "browser": {
+    "./source/service/Fable-Service-EnvironmentData.js": "./source/service/Fable-Service-EnvironmentData-Web.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/stevenvelozo/fable.git"

package/retold-harness/Bookstore-Import-Books.sh

@@ -0,0 +1,4 @@
+#/bin/bash
+
+# Eventually this will delete the database too!
+node ./bookstore-import-books-run.js

package/retold-harness/bookstore-import-books-run.js

@@ -0,0 +1,9 @@
+let tmpRun = require('./bookstore-import-books.js')(
+    (pError)=>
+    {
+        if (pError)
+        {
+            console.log(`ERROR: ${pError}`, pError);
+        }
+        process.exit();
+    });

package/retold-harness/bookstore-serve-meadow-endpoint-apis-run.js

@@ -0,0 +1,6 @@
+const libServer = require('./bookstore-serve-meadow-endpoint-apis.js'); 
+let _Orator = libServer(
+	()=>
+	{
+		console.log('API service is started!');
+	});

package/{.config/retold-harness → retold-harness}/bookstore-serve-meadow-endpoint-apis.js

@@ -74,13 +74,16 @@ let fStartServiceServer = (fInitializeCallback) =>
 				_MeadowEndpoints[tmpDALEntityName].connectRoutes(_Orator.webServer);
 			}
 
+			let tmpNames = Object.keys(_MeadowEndpoints.Book);
+			console.log(JSON.stringify(tmpNames));
+
 			// 100. Add a post processing hook to the Book DAL on single reads
 			/*
 				This post processing step will look for all book author joins then 
 				load all appropriate authors and stuff them in the book record before 
 				returning it.
 			*/
-			_MeadowEndpoints.Book.controller.BehaviorInjection.setBehavior('Read-PostOperation',
+			_MeadowEndpoints.Book.behaviorModifications.setBehavior('Read-PostOperation',
 				(pRequest, pRequestState, fComplete) =>
 				{
 					// Get the join records

package/{.config/retold-harness → retold-harness}/package.json

@@ -4,16 +4,19 @@
   "description": "Harness data import and server.",
   "main": "bookstore-serve-meadow-endpoints-apis.js",
   "scripts": {
+    "start": "node bookstore-serve-meadow-endpoint-apis-run.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
   "license": "MIT",
   "dependencies": {
     "async": "^3.2.4",
-    "fable": "^3.0.33",
+    "fable": "^3.0.35",
     "meadow": "^2.0.4",
     "meadow-endpoints": "^3.0.7",
     "mysql2": "^3.3.0",
-    "orator": "^3.0.11"
+    "orator": "^3.0.11",
+    "orator-serviceserver-restify": "^1.0.4",
+    "papaparse": "^5.4.1"
   }
 }

package/source/Fable.js

@@ -10,6 +10,7 @@ const libFableLog = require('fable-log');
 const libFableServiceManager = require('./Fable-ServiceManager.js');
 
 // Default Services
+const libFableServiceEnvironmentData = require('./services/Fable-Service-EnvironmentData.js');
 const libFableServiceDataFormat = require('./services/Fable-Service-DataFormat.js');
 const libFableServiceMetaTemplate = require('./services/Fable-Service-MetaTemplate.js');
 const libFableServiceOperation = require('./services/Fable-Service-Operation.js');
@@ -50,6 +51,7 @@ class Fable
 		this.serviceManager.connectPreinitServiceProviderInstance(this._coreServices.SettingsManager);
 
 		// Initialize and instantiate the default baked-in Data Arithmatic service
+		this.serviceManager.addAndInstantiateServiceType('EnvironmentData', libFableServiceEnvironmentData);
 		this.serviceManager.addServiceType('Template', libFableServiceTemplate);
 		this.serviceManager.addServiceType('MetaTemplate', libFableServiceMetaTemplate);
 		this.serviceManager.addAndInstantiateServiceType('DataFormat', libFableServiceDataFormat);

package/source/services/Fable-Service-EnvironmentData-Web.js

@@ -0,0 +1,15 @@
+const libFableServiceBase = require('../Fable-ServiceManager.js').ServiceProviderBase;
+
+class FableServiceEnvironmentData extends libFableServiceBase
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+        super(pFable, pOptions, pServiceHash);
+
+        this.serviceType = 'EnvironmentData';
+
+		this.Environment = `web`;
+	}
+}
+
+module.exports = FableServiceEnvironmentData;

package/source/services/Fable-Service-EnvironmentData.js

@@ -0,0 +1,15 @@
+const libFableServiceBase = require('../Fable-ServiceManager.js').ServiceProviderBase;
+
+class FableServiceEnvironmentData extends libFableServiceBase
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+        super(pFable, pOptions, pServiceHash);
+
+        this.serviceType = 'EnvironmentData';
+
+		this.Environment = `node.js`;
+	}
+}
+
+module.exports = FableServiceEnvironmentData;

package/source/services/Fable-Service-RestClient.js

@@ -19,64 +19,88 @@ class FableServiceRestClient extends libFableServiceBase
 		this.serviceType = 'RestClient';
 	}
 
-	getJSON(pOptionsOrURL, fCallback)
+	executeChunkedRequest(pOptions, fCallback)
 	{
-		return this.getRaw(pOptionsOrURL, 
-			(pError, pResponse, pResult) =>
+		pOptions.RequestStartTime = this.fable.log.getTimeStamp();
+
+		if (this.TraceLog)
+		{
+			this.fable.log.debug(`Beginning ${pOptions.method} request to ${pOptions.url} at ${pOptions.RequestStartTime}`);
+		}
+
+		return libSimpleGet(pOptions,
+			(pError, pResponse)=>
 			{
 				if (pError)
 				{
-					return fCallback(pError, pResponse, pResult);
+					return fCallback(pError, pResponse);
 				}
 
-				if (pResponse.statusCode != 200)
+				if (this.TraceLog)
 				{
-					return fCallback(new Error(`Invalid status code ${pResponse.statusCode}`), pResponse, pResult);
+					let tmpConnectTime = this.fable.log.getTimeStamp();
+					this.fable.log.debug(`--> ${pOptions.method} connected in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
 				}
 
-				return fCallback(pError, pResponse, JSON.parse(pResult));
+				let tmpData = '';
+
+				pResponse.on('data', (pChunk) =>
+					{
+						// For JSON, the chunk is the serialized object.
+						if (this.TraceLog)
+						{
+							let tmpChunkTime = this.fable.log.getTimeStamp();
+							this.fable.log.debug(`--> ${pOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpChunkTime)}ms`);
+						}
+						tmpData += pChunk;
+					});
+
+				pResponse.on('end', ()=>
+					{
+						if (this.TraceLog)
+						{
+							let tmpCompletionTime = this.fable.log.getTimeStamp();
+							this.fable.log.debug(`==> ${pOptions.method} completed data size ${tmpData.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpCompletionTime)}ms`);
+						}
+						return fCallback(pError, pResponse, tmpData);
+					});
 			});
 	}
 
-	getRaw(pOptionsOrURL, fCallback)
+	executeJSONRequest(pOptions, fCallback)
 	{
-		let tmpRequestOptions = (typeof(pOptions) == 'object') ? pOptions : {};
-		if (typeof(pOptionsOrURL) == 'string')
-		{
-			tmpRequestOptions.url = pOptionsOrURL;
-		}
+		pOptions.json = true;
+
+		pOptions.RequestStartTime = this.fable.log.getTimeStamp();
 
-		let tmpRequestStartTime = this.fable.log.getTimeStamp();
 		if (this.TraceLog)
 		{
-			let tmpConnectTime = this.fable.log.getTimeStamp();
-			this.fable.log.debug(`Beginning GET request to ${tmpRequestOptions.url} at ${tmpRequestStartTime}`);
+			this.fable.log.debug(`Beginning ${pOptions.method} JSON request to ${pOptions.url} at ${pOptions.RequestStartTime}`);
 		}
 
-		libSimpleGet.get(tmpRequestOptions,
+		return libSimpleGet(pOptions,
 			(pError, pResponse)=>
 			{
 				if (pError)
 				{
-					return fCallback(pError, pResponse, tmpRequestOptions);
+					return fCallback(pError, pResponse);
 				}
 
 				if (this.TraceLog)
 				{
 					let tmpConnectTime = this.fable.log.getTimeStamp();
-					this.fable.log.debug(`--> GET connected in ${this.dataFormat.formatTimeDelta(tmpRequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
+					this.fable.log.debug(`--> JSON ${pOptions.method} connected in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
 				}
 
-				let tmpData = '';
-
-				pResponse.on('data', (pChunk)=>
+				pResponse.on('data', (pChunk) =>
 					{
 						if (this.TraceLog)
 						{
 							let tmpChunkTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`--> GET data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(tmpRequestStartTime, tmpChunkTime)}ms`);
+							this.fable.log.debug(`--> JSON ${pOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpChunkTime)}ms`);
 						}
-						tmpData += pChunk;
+						// In a JSON request, the chunk is the serialized method.
+						return fCallback(pError, pResponse, JSON.parse(pChunk));
 					});
 
 				pResponse.on('end', ()=>
@@ -84,12 +108,92 @@ class FableServiceRestClient extends libFableServiceBase
 						if (this.TraceLog)
 						{
 							let tmpCompletionTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`==> GET completed data size ${tmpData.length}b received in ${this.dataFormat.formatTimeDelta(tmpRequestStartTime, tmpCompletionTime)}ms`);
+							this.fable.log.debug(`==> JSON ${pOptions.method} completed - received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpCompletionTime)}ms`);
 						}
-						return fCallback(pError, pResponse, tmpData);
 					});
 			});
 	}
+
+	getJSON(pOptionsOrURL, fCallback)
+	{
+		let tmpRequestOptions = (typeof(pOptions) == 'object') ? pOptions : {};
+		if (typeof(pOptionsOrURL) == 'string')
+		{
+			tmpRequestOptions.url = pOptionsOrURL;
+		}
+
+		tmpRequestOptions.method = 'GET';
+
+		return this.executeJSONRequest(tmpRequestOptions, fCallback);
+	}
+
+	putJSON(pOptions, fCallback)
+	{
+		if (typeof(pOptions.body) != 'object')
+		{
+			return fCallback(new Error(`PUT JSON Error Invalid options object`));
+		}
+
+		pOptions.method = 'PUT';
+
+		return this.executeJSONRequest(pOptions, fCallback);
+	}
+
+	postJSON(pOptions, fCallback)
+	{
+		if (typeof(pOptions.body) != 'object')
+		{
+			return fCallback(new Error(`POST JSON Error Invalid options object`));
+		}
+
+		pOptions.method = 'POST';
+
+		return this.executeJSONRequest(pOptions, fCallback);
+	}
+
+	patchJSON(pOptions, fCallback)
+	{
+		if (typeof(pOptions.body) != 'object')
+		{
+			return fCallback(new Error(`PATCH JSON Error Invalid options object`));
+		}
+
+		pOptions.method = 'PATCH';
+
+		return this.executeJSONRequest(pOptions, fCallback);
+	}
+
+	headJSON(pOptions, fCallback)
+	{
+		if (typeof(pOptions.body) != 'object')
+		{
+			return fCallback(new Error(`HEAD JSON Error Invalid options object`));
+		}
+
+		pOptions.method = 'HEAD';
+
+		return this.executeJSONRequest(pOptions, fCallback);
+	}
+	
+	delJSON(pOptions, fCallback)
+	{
+		pOptions.method = 'DELETE';
+
+		return this.executeJSONRequest(pOptions, fCallback);
+	}
+
+	getRawText(pOptionsOrURL, fCallback)
+	{
+		let tmpRequestOptions = (typeof(pOptions) == 'object') ? pOptions : {};
+		if (typeof(pOptionsOrURL) == 'string')
+		{
+			tmpRequestOptions.url = pOptionsOrURL;
+		}
+
+		tmpRequestOptions.method = 'GET';
+
+		return this.executeChunkedRequest(tmpRequestOptions, fCallback);
+	}
 }
 
 module.exports = FableServiceRestClient;

package/test/Fable_tests.js

@@ -62,6 +62,8 @@ suite
 						.that.is.a('object');
 						Expect(testFable.settings.Product)
 							.to.equal('LegacyApplicationNameHere')
+						Expect(testFable.EnvironmentData.Environment)
+							.to.equal('node.js');
 					}
 				);
 				test

package/test/RestClient_test.js

@@ -38,16 +38,82 @@ suite
                         let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
 
 						// Download the wiktionary entry for dog!
-						tmpRestClient.getJSON('https://en.wiktionary.org/w/api.php?action=parse&prop=wikitext&format=json&page=dog',
+						tmpRestClient.getJSON('http://localhost:8086/1.0/Author/1',
 							(pError, pResponse, pBody)=>
 							{
 								Expect(pBody).to.be.an('object');
-								Expect(pBody.hasOwnProperty('parse')).to.equal(true);
-								Expect(pBody.parse.title).to.equal('dog');
+								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
+								Expect(pBody.Name).to.equal('J.K. Rowling');
 								fTestComplete();
 							});
 					}
 				);
+				test
+				(
+					'Perform a POST request.',
+					function(fTestComplete)
+					{
+						let testFable = new libFable();
+						// Instantiate the RestClient Service Provider
+                        let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
+
+						// Download the wiktionary entry for dog!
+						tmpRestClient.postJSON({url: 'http://localhost:8086/1.0/Author', body:{Name:'Test Author'}},
+							(pError, pResponse, pBody)=>
+							{
+								Expect(pBody).to.be.an('object');
+								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
+								Expect(pBody.Name).to.equal('Test Author');
+								fTestComplete();
+							});
+					}
+				);
+				test
+				(
+					'Perform a PUT request.',
+					function(fTestComplete)
+					{
+						let testFable = new libFable();
+						// Instantiate the RestClient Service Provider
+                        let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
+
+						// Download the wiktionary entry for dog!
+						tmpRestClient.putJSON({url: 'http://localhost:8086/1.0/Author/Upsert', body:{GUIDAuthor:'TestAuthor', Name:'Test Author 2'}},
+							(pError, pResponse, pBody)=>
+							{
+								Expect(pBody).to.be.an('object');
+								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
+								Expect(pBody.Name).to.equal('Test Author 2');
+								fTestComplete();
+							});
+					}
+				);
+				test
+				(
+					'Perform an UPSERT request then a DELETE.',
+					function(fTestComplete)
+					{
+						let testFable = new libFable();
+						// Instantiate the RestClient Service Provider
+                        let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
+
+						// Download the wiktionary entry for dog!
+						tmpRestClient.putJSON({url: 'http://localhost:8086/1.0/Author/Upsert', body:{Name:'Test Author 2 DELETE'}},
+							(pError, pResponse, pBody)=>
+							{
+								Expect(pBody).to.be.an('object');
+								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
+								Expect(pBody.Name).to.equal('Test Author 2 DELETE');
+								tmpRestClient.delJSON({url: `http://localhost:8086/1.0/Author/${pBody.IDAuthor}`},
+								(pDeleteError, pDeleteResponse, pDeleteBody) =>
+								{
+									Expect(pDeleteBody.Count)
+										.to.equal(1);
+									fTestComplete();
+								});
+							});
+					}
+				);
 			}
 		);
 	}

package/.config/retold-harness/bookstore-import-books-run.js

@@ -1 +0,0 @@
-let tmpRun = require('./bookstore-import-books.js')();