comments

Author: Shahnawaz-Sk

lib/api_client.js

@@ -2,10 +2,17 @@ var request = require("request"),
     logger,
     packageVersion = require("../package.json").version;
 
+/**
+ * ApiClient is a function based Class.
+ * @param {!AutomationApiClient} settings An object that for lambda user credentials
+ */
 var ApiClient = function (settings) {
     settings = settings || {};
 
-    // Set default region if not provided and validate
+    /**
+    * Region validation
+    * @return {Error|null}
+    */
     const region = settings.region || "us";
     if (!["us", "eu"].includes(region)) {
         throw new Error("Region is invalid.");
@@ -14,12 +21,18 @@ var ApiClient = function (settings) {
     // Load region-specific config and attach it to ApiClient
     ApiClient.config = require(`./config.${region}`);
 
-    // Required check for username
+    /**
+     * Required check for username.
+     * @return {Error|null}
+     */
     if (!settings.username) {
         throw new Error("Username is required.");
     }
 
-    // Required check for accessKey
+    /**
+     * Required check for accessKey.
+     * @return {Error|null}
+     */
     if (!settings.accessKey) {
         throw new Error("Access Key is required.");
     }
@@ -39,7 +52,14 @@ var ApiClient = function (settings) {
     }
 };
 
+/**
+ * Extends ApiClient Class with static method for all Api Request.
+ * @param {!ApiClient} options An object that determine the Request payload
+ * @param {Function} fnCallback is callback function.
+ * @return {Function|Error} return response to Callable method or throw Error.
+ */
 ApiClient.request = function (options, fnCallback) {
+     /** Initialize Callback function is not there */
     fnCallback = fnCallback || function () {};
 
     // Access the configuration from ApiClient
@@ -50,6 +70,7 @@ ApiClient.request = function (options, fnCallback) {
         ApiClient.baseUrl = baseUrl + version.latestVersion;
         ApiClient.request(options, fnCallback);
     } else {
+        /** Update Options with User Credential If It is object */
         if (typeof options === "object") {
             options.headers = {
                 Authorization: ApiClient.authHeader,
@@ -61,14 +82,15 @@ ApiClient.request = function (options, fnCallback) {
             options.url = ApiClient.baseUrl + options.url;
         }
 
+         /** For Debbuging purpose log Request Payload */
         logger.info("Api request options", options);
         request(options, function (e, response, body) {
             if (e) {
                 logger.error("Error while Api call", e);
             } else if (response.statusCode === 200) {
                 try {
                     body = JSON.parse(body);
-                    logger.info("Api response json", body);
+                    logger.info("Api response json :", body);
                     return fnCallback(e, body);
                 } catch (e) {
                     logger.error("Error while parsing to json of output response", e);