fable 3.0.73 → 3.0.74

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.0.73",
+    "version": "3.0.74",
     "description": "An entity behavior management and API bundling library.",
     "main": "source/Fable.js",
     "scripts": {
@@ -49,7 +49,7 @@
     },
     "homepage": "https://github.com/stevenvelozo/fable",
     "devDependencies": {
-        "quackage": "^1.0.14"
+        "quackage": "^1.0.19"
     },
     "dependencies": {
         "async.eachlimit": "^0.5.2",

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

@@ -158,8 +158,7 @@ class FableServiceFilePersistence extends libFableServiceBase
 		// Check if the path is fully complete
 		if (tmpParameters.CurrentPathIndex >= tmpParameters.ActualPathParts.length)
 		{
-			fCallback(null);
-			return true;
+			return fCallback(null);
 		}
 
 		// Check if the path exists (and is a folder)
@@ -190,8 +189,7 @@ class FableServiceFilePersistence extends libFableServiceBase
 							else
 							{
 								console.log(pCreateError.code);
-								fCallback(pCreateError);
-								return false;
+								return fCallback(pCreateError);
 							}
 						});
 				}

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

@@ -26,6 +26,11 @@ class FableServiceRestClient extends libFableServiceBase
 		this.prepareRequestOptions = (pOptions) => { return pOptions; };
 	}
 
+	get simpleGet()
+	{
+		return libSimpleGet;
+	}
+
 	prepareCookies(pRequestOptions)
 	{
 		if (this.cookie)
@@ -102,6 +107,67 @@ class FableServiceRestClient extends libFableServiceBase
 			});
 	}
 
+	executeChunkedRequestBinary(pOptions, fCallback)
+	{
+		let tmpOptions = this.preRequest(pOptions);
+
+		tmpOptions.RequestStartTime = this.fable.log.getTimeStamp();
+
+		if (this.TraceLog)
+		{
+			this.fable.log.debug(`Beginning ${tmpOptions.method} request to ${tmpOptions.url} at ${tmpOptions.RequestStartTime}`);
+		}
+
+		tmpOptions.json = false;
+		tmpOptions.encoding = null;
+
+		return libSimpleGet(tmpOptions,
+			(pError, pResponse)=>
+			{
+				if (pError)
+				{
+					return fCallback(pError, pResponse);
+				}
+
+				if (this.TraceLog)
+				{
+					let tmpConnectTime = this.fable.log.getTimeStamp();
+					this.fable.log.debug(`--> ${tmpOptions.method} connected in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
+				}
+
+				let tmpDataBuffer = false;
+
+				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(`--> ${tmpOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpChunkTime)}ms`);
+						}
+						// TODO: Potentially create a third option that streams this to a file?  So it doesn't have to hold it all in memory.
+						if (!tmpDataBuffer)
+						{
+							tmpDataBuffer = Buffer.from(pChunk);
+						}
+						else
+						{
+							tmpDataBuffer = Buffer.concat([tmpDataBuffer, pChunk]);
+						}
+					});
+
+				pResponse.on('end', ()=>
+					{
+						if (this.TraceLog)
+						{
+							let tmpCompletionTime = this.fable.log.getTimeStamp();
+							this.fable.log.debug(`==> ${tmpOptions.method} completed data size ${tmpDataBuffer.length}b received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpCompletionTime)}ms`);
+						}
+						return fCallback(pError, pResponse, tmpDataBuffer);
+					});
+			});
+	}
+
 	executeJSONRequest(pOptions, fCallback)
 	{
 		pOptions.json = true;

package/test/RestClient_test.js

@@ -14,113 +14,134 @@ var Expect = Chai.expect;
 // https://en.wiktionary.org/w/api.php?action=parse&prop=wikitext&format=json&page=dog
 
 suite
-(
-	'Fable RestClient',
-	function()
-	{
-		setup
-		(
-			function() { }
-		);
-
-		suite
-		(
-			'Basic Requests',
-			function()
-			{
-				test
+	(
+		'Fable RestClient',
+		function ()
+		{
+			setup
 				(
-					'Perform a GET 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.getJSON('http://localhost:8086/1.0/Author/1',
-							(pError, pResponse, pBody)=>
-							{
-								Expect(pBody).to.be.an('object');
-								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
-								Expect(pBody.Name).to.equal('John Green');
-								fTestComplete();
-							});
-					}
+					function () { }
 				);
-				test
+
+			suite
 				(
-					'Perform a POST request.',
-					function(fTestComplete)
+					'Basic Requests',
+					function ()
 					{
-						let testFable = new libFable();
-						// Instantiate the RestClient Service Provider
-                        let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
+						test
+							(
+								'Perform a GET request.',
+								function (fTestComplete)
+								{
+									let testFable = new libFable();
+									// Instantiate the RestClient Service Provider
+									let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', { TraceLog: true }, 'RestClient-99');
 
-						tmpRestClient.prepareRequestOptions = (pOptions) =>
-						{
-							pOptions.headers = {'Content-Type':'application/json'};
-							return pOptions;
-						};
+									// Download the wiktionary entry for dog!
+									tmpRestClient.getJSON('http://localhost:8086/1.0/Author/1',
+										(pError, pResponse, pBody) =>
+										{
+											Expect(pBody).to.be.an('object');
+											Expect(pBody.hasOwnProperty('Name')).to.equal(true);
+											Expect(pBody.Name).to.equal('John Green');
+											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');
+									tmpRestClient.prepareRequestOptions = (pOptions) =>
+									{
+										pOptions.headers = { 'Content-Type': 'application/json' };
+										return pOptions;
+									};
 
-						// 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.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
+							(
+								'Get a binary file.',
+								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.executeChunkedRequestBinary({ url: 'http://localhost:8086/1.0/Author/1', method: 'GET' },
+										(pError, pResponse, pBuffer) =>
+										{
+											Expect(pBuffer).to.be.instanceof(Buffer);
+											testFable.serviceManager.instantiateServiceProvider('FilePersistence');
+											// TODO: How to test this on all operating systems safely?
+											//testFable.FilePersistence.writeFileSync(`/tmp/RestClient_binary_test.jpg`, pBuffer);
+											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:{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) =>
+									// 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)
 								{
-									Expect(pDeleteBody.Count)
-										.to.equal(1);
-									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();
+												});
+										});
+								}
+							);
 					}
 				);
-			}
-		);
-	}
-);
+		}
+	);