Merge pull request #25 from Moesif/replace-request-with-axios

Replace deprecated request with axios http client and added getGovernRules

Author: xinghengwang

lib/Controllers/ApiController.js

@@ -213,6 +213,36 @@ var ApiController = {
     );
   },
 
+  /**
+   * Get governance rules configuration
+   * @param {void}    parameter: Example:
+   * @param {function} callback    Required parameter: Callback function in the form of function(error, response)
+   *
+   * @return {void}
+   */
+  getRules : function(callback){
+
+    //prepare query string for API call;
+    var _baseUri = _configuration.BaseUri;
+
+    var _queryBuilder = _baseUri + "/v1/rules";
+
+    //validate and preprocess url
+    var _queryUrl = _APIHelper.cleanUrl(_queryBuilder);
+
+    //Construct the request
+    var _options = {
+      queryUrl: _queryUrl,
+      method: "GET",
+      headers: buildHeaders(),
+    };
+
+    _request(
+      _options,
+      buildCallback(callback)
+    );
+  },
+
   /**
    * Update a single company
    * @param {CompanyModel} body    Required parameter: Example:

lib/Http/Client/RequestClient.js

@@ -1,126 +1,99 @@
 var HttpContext = require("./HttpContext");
 var HttpResponse = require("../Response/HttpResponse");
-var https = require('https');
-var request = require("request");
-var zlib = require('zlib')
-var APIHelper = require('../../APIHelper');
-var _configuration = require('../../configuration');
+var https = require("https");
+var axios = require("axios");
+var axiosRetry = require("axios-retry");
+var zlib = require("zlib");
+var APIHelper = require("../../APIHelper");
+var _configuration = require("../../configuration");
 
 var keepAliveAgent = new https.Agent({
   keepAlive: true,
   maxSockets: 25
 });
 
-var convertHttpRequest = function (req, callback) {
-    //Convert to request's version of http request
-
-    var options = {
-        url: req.queryUrl,
-        method: req.method,
-        headers: req.headers,
-        timeout: 10000,
-        agent: keepAliveAgent
-    };
+var alreadySetReTry = false;
 
-    if (req.body) {
-      zlib.gzip(req.body, function (err, buffer) {
-        if (err) {
-          options.body = req.body;
-          callback(options);
-        } else {
-          options.headers["Content-Encoding"] = 'gzip';
-          options.body = buffer;
-          callback(options);
-        }
-      });
-    } else {
-      callback(options);
-    }
-}
+var convertHttpRequest = function (req, callback) {
+  //Convert to request's version of http request
+  var options = {
+    url: req.queryUrl,
+    method: req.method,
+    headers: req.headers,
+    timeout: 10000,
+    httpsAgent: keepAliveAgent,
+    params: req.params
+  };
 
-var appendFormdata = function (form, data) {
-    var dataArray = APIHelper.formDataEncodeObject(data);
-    for (var index in dataArray) {
-        var key = dataArray[index].key
-        var value = dataArray[index].value;
-        form.append(key, value);
-    }
-}
+  if (req.body) {
+    zlib.gzip(req.body, function (err, buffer) {
+      if (err) {
+        options.data = req.body;
+        callback(options);
+      } else {
+        options.headers["Content-Encoding"] = "gzip";
+        options.data = buffer;
+        callback(options);
+      }
+    });
+  } else {
+    callback(options);
+  }
+};
 
 var convertHttpResponse = function (resp) {
-    var response = new HttpResponse();
-    if(resp) {
-        response.body = resp.body;
-        response.headers = resp.headers;
-        response.statusCode = resp.statusCode;
-    }
-
-    return response;
-}
+  var response = new HttpResponse();
+  if (resp) {
+    // axios calls response data.
+    response.body = resp.data;
+    response.headers = resp.headers;
+    response.statusCode = resp.statusCode || resp.status;
+  }
 
+  return response;
+};
 
 /**
  * Execute a given HttpRequest to get string response back
  * @param	{HttpRequest | HttpBodyRequest} request    The query string builder to replace the template parameters
- * @param	{Array} parameters    The parameters to replace in the queryBuilder
  */
-function executeRequestWithRetry(req, retryMax, callback) {
-    //Convert abstracted request to request's http request
-    convertHttpRequest(req, function(options) {
-      var context = new HttpContext();
-      context.request = req;
+function executeRequest(req, callback) {
+  convertHttpRequest(req, function (options) {
+    var context = new HttpContext();
+    context.request = req;
 
-      var retryCount = 0;
-      //Make a temp callback
-      var internalCallback = function cb(error, res, body) {
-        if (error && retryCount < retryMax) {
-          retryCount = retryCount + 1;
-          console.log('error sending, retrying count: ' + retryCount);
-          options.headers["X-Moesif-Retry"] = retryCount;
-          // set next retry to 250ms later.
-          setTimeout(function () {
-            request(options, internalCallback);
-          }, 250);
+    axios(options)
+      .then(function (res) {
+        context.response = res;
+        context.response.statusCode =
+          context.response.statusCode || context.response.status;
+        const convertedResponse = convertHttpResponse(res);
+        callback(null, convertedResponse, context);
+      })
+      .catch(function (err) {
+        if (err.response) {
+          err.response.statusCode =
+            err.response.statusCode || err.response.status;
+          context.response = err.response;
+
+          callback(err, convertHttpResponse(err.response), context);
         } else {
-          var response = convertHttpResponse(res);
-          context.response = response;
-          callback(error, response, context);
+          callback(err, null, context);
         }
-      };
-      //Make the request;
-      request(options, internalCallback);
-    });
+      });
+  });
 }
 
-/**
- * Execute a given HttpRequest to get string response back
- * @param	{HttpRequest | HttpBodyRequest} request    The query string builder to replace the template parameters
- * @param	{Array} parameters    The parameters to replace in the queryBuilder
- */
-function executeRequest(req, callback) {
-    //Convert abstracted request to request's http request
-    convertHttpRequest(req, function(options) {
-      var context = new HttpContext();
-      context.request = req;
-
-      //Make a temp callback
-      var internalCallback = function cb(error, res, body) {
-          var response = convertHttpResponse(res);
-          context.response = response;
-          callback(error, response, context);
-      };
-
-      //Make the request;
-      request(options, internalCallback);
+function executeRequestCombined(req, callback) {
+  if (_configuration.retry && !alreadySetReTry) {
+    axiosRetry(axios, {
+      retries: _configuration.retry,
+      retryDelay: axiosRetry.exponentialDelay
     });
-}
 
-function executeRequestCombined(req, callback) {
-  if (_configuration.retry) {
-    executeRequestWithRetry(req, _configuration.retry, callback);
-  } else {
-    executeRequest(req, callback);
+    alreadySetReTry = true;
   }
+  executeRequest(req, callback);
 }
 
 module.exports = executeRequestCombined;

lib/Models/EventModel.js

@@ -23,10 +23,12 @@ var EventModel = function (obj) {
         this.metadata = null;
         this.direction = null;
         this.weight = null;
+        this.blockedBy = null;
         //Append to variable dictionary
         this._variableDict['sessionToken'] = 'session_token';
         this._variableDict['userId'] = 'user_id';
         this._variableDict['companyId'] = 'company_id';
+        this._variableDict['blockedBy'] = 'blocked_by';
     } else {
         this.request = new EventRequestModel(obj.request);
         this.response = new EventResponseModel(obj.response);
@@ -37,10 +39,12 @@ var EventModel = function (obj) {
         this.metadata = obj.metadata;
         this.direction = obj.direction;
         this.weight = obj.weight;
+        this.blockedBy = obj.blockedBy;
         //Append to variable dictionary
         this._variableDict['sessionToken'] = 'session_token';
         this._variableDict['userId'] = 'user_id';
         this._variableDict['companyId'] = 'company_id';
+        this._variableDict['blockedBy'] = 'blocked_by';
     }
 };
 
@@ -210,4 +214,23 @@ EventModel.prototype.setWeight = function(value) {
     this.weight = value;
 };
 
-module.exports = EventModel;
+/**
+ * Blocked by rule id for an event
+ *
+ * @return {number|null}
+ */
+EventModel.prototype.getBlockedBy = function() {
+  return this.blockedBy;
+};
+
+
+/**
+ * Setter for blockedBy
+ *
+ * @param {string|null} value
+ */
+EventModel.prototype.setBlockedBy = function(value) {
+  this.blockedBy = value;
+}
+
+module.exports = EventModel;