Reset function for further requests

Author: James Haley

README.md

@@ -135,13 +135,26 @@ Batchelor.add({
 ```
 This could be required, for example, when making multiple requests with different Auth data and then needing to make further requests with the same Auth data.
 
+###### Resetting and Re-using
+Once Batchelor has been run, there are certain use-cases for running futher batch requests on response. This requires the variables in the module to be reset. This can be done using the `.reset()` call:
+``` node
+Batchelor.run(function(response){
+
+	//	Reset Batchelor for further use
+	Batchelor.reset();
+	...
+
+});
+```
+
 ## To Do List-ish
 These might get done if we end up needing them/have time:
 * Limit requests per batch request
-* Handle Media in API calls (no need for it here, feel free)
+* Handle Media in API calls (no need for it here, feel free to write it)
 
 ## Release History
 
+* 0.0.7 Reset function for when you are using batchelor more than once in a script (ability for nested requests too)
 * 0.0.6 Bug fixes introduced in the last update and clean up was happening too soon. Moved it.
 * 0.0.5 Added the ability to passthrough specific information from the `.add()` options to the response object
 * 0.0.4 Authorization can now be set on each request (currently Bearer [...] only)

lib/batchelor.js

@@ -31,10 +31,6 @@ var request = require('request'),
 
 (function (Batchelor) {
 
-  var _requests = [],
-    _requestSpecificCallbacks = [],
-    _requestExtensionData = [];
-
   /**
    * Initialise Batchelor
    *
@@ -55,6 +51,11 @@ var request = require('request'),
     //  Globalise the options
     this._globalOptions = options;
 
+    //  Ready internal variables
+    this._requests = [];
+    this._requestSpecificCallbacks = [];
+    this._requestExtensionData = [];
+
     //  Chaining baby
     return this;
 
@@ -88,12 +89,12 @@ var request = require('request'),
 
     //  Save out request specific callback
     if (!!options.callback) {
-      _requestSpecificCallbacks[requestId] = options.callback;
+      this._requestSpecificCallbacks[requestId] = options.callback;
     }
 
     //  Any data thay needs to be passed through to the callback
     if (!!options.extend) {
-      _requestExtensionData[requestId] = options.extend;
+      this._requestExtensionData[requestId] = options.extend;
     }
 
     //  Set Defaults
@@ -115,7 +116,7 @@ var request = require('request'),
     }
 
     //  Push to _requests Array
-    _requests.push(options);
+    this._requests.push(options);
 
     //  Chaining baby
     return this;
@@ -130,10 +131,11 @@ var request = require('request'),
    */
   Batchelor.run = function (callback) {
 
-    var _multiparts = [];
+    var _multiparts = [],
+      _self = this;
 
     //  Build multipart request
-    _requests.forEach(function (requestPart) {
+    this._requests.forEach(function (requestPart) {
 
       var requestSettings = {
         'Content-Type': 'application/http',
@@ -213,8 +215,8 @@ var request = require('request'),
 
           //  Get the response id if exists
           var returnedContentId = part.header['content-id'],
-            currentRequestCallback = null,
-            currentRequestExtendData = null;
+            currentRequestCallback,
+            currentRequestExtendData;
 
           if (!!returnedContentId) {
 
@@ -226,10 +228,10 @@ var request = require('request'),
             part.data.headers['Content-ID'] = returnedContentId;
 
             //  As we have a content id, we can link to individual callback (if exists)
-            currentRequestCallback = _requestSpecificCallbacks[returnedContentId];
+            currentRequestCallback = _self._requestSpecificCallbacks[returnedContentId];
 
             //  If this request has extend data, retrieve it for callback
-            currentRequestExtendData = _requestExtensionData[returnedContentId];
+            currentRequestExtendData = _self._requestExtensionData[returnedContentId];
           }
 
           //  If this individual request has a callback, run it
@@ -247,13 +249,7 @@ var request = require('request'),
 
         //  All remaining responses get output
         //  Extend data sent through as is for parse in callback
-        callback(responseBody, _requestExtensionData);
-
-        //  Clean up
-        _requests = [];
-        _requestExtensionData = [];
-        _requestSpecificCallbacks = [];
-        _multiparts = [];
+        callback(responseBody, _self._requestExtensionData);
 
       });
 
@@ -262,4 +258,20 @@ var request = require('request'),
     });
   };
 
+  /**
+   * Reset all internal options if a re-run is required
+   *
+   * @return  {object} Batchelor object
+   */
+  Batchelor.reset = function () {
+
+    this._requests = [];
+    this._requestSpecificCallbacks = [];
+    this._requestExtensionData = [];
+    this._globalOptions.multipart = [];
+
+    return this;
+
+  };
+
 }(exports));