comprodls-sdk 2.89.0 → 2.90.0-qa

package/lib/services/pub/index.js

@@ -17,6 +17,7 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Pub Adaptor
  * Functions for calling Pub.
@@ -24,28 +25,31 @@
 
 var request = require('superagent');
 var q = require('q');
+var Agent = require('agentkeepalive');
 
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
+var keepaliveAgent = new Agent({
+  timeout: 60000,
+  freeSocketTimeout: 30000
+});
+
 module.exports = pub;
 
 function pub() {
   return {
-    "promoteProduct": promoteProduct.bind(this),
-    "registerProduct": registerProduct.bind(this),
-    "ingestProduct": ingestProduct.bind(this),
-    "createBundle": createBundle.bind(this),
-    "updateBundle": updateBundle.bind(this),
-    "getAllBundles": getAllBundles.bind(this),
-    "getSingleBundle": getSingleBundle.bind(this),
-    "createProductFamily": createProductFamily.bind(this),
-    "updateProductFamily": updateProductFamily.bind(this),
-    "getSingleProductFamily": getSingleProductFamily.bind(this),
-    "getAllProductFamilies": getAllProductFamilies.bind(this)
+    promoteProduct: promoteProduct.bind(this),
+    registerProduct: registerProduct.bind(this),
+    ingestProduct: ingestProduct.bind(this),
+    createBundle: createBundle.bind(this),
+    updateBundle: updateBundle.bind(this),
+    getAllBundles: getAllBundles.bind(this),
+    getSingleBundle: getSingleBundle.bind(this),
+    createProductFamily: createProductFamily.bind(this),
+    updateProductFamily: updateProductFamily.bind(this),
+    getSingleProductFamily: getSingleProductFamily.bind(this),
+    getAllProductFamilies: getAllProductFamilies.bind(this)
   };
 }
 
@@ -54,200 +58,156 @@ function pub() {
  **********************************/
 
 /**
- * {
-    "source": {
-      "stage": "1" //["1", "2"]
-    },
-    "target": {
-      "org": <target_org> //optional, mandatory for sourceStage-1 + targetStage-2
-      "stage": "2" //["2", "final"]
-    },
-    "externalrefid": <externalID>,
-    "productcode": "string"
-    }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#promoteproductparams
  */
 function promoteProduct(options) {
   var self = this;
-
   //Initializing promise
   var dfd = q.defer();
 
-  //Construct API url
-  var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.promoteAPI;
-  url = helpers.api.constructAPIUrl(url, {
-    "orgId": self.orgId, "productcode": options.productcode
-  });
   //Contruct parameters
-  var params = {
-    source: {},
-    target: {}
-  };
-  if (options) {
-    if (options.source && options.source.stage) {
-      params.source.stage = options.source.stage;
-    }
+  if (options && options.productcode) {
+    //Construct API url
+    var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.promoteAPI;
+    url = helpers.api.constructAPIUrl(url, {
+      'orgId': self.orgId, 'productcode': options.productcode
+    });
+
+    var params = { source: {}, target: {} };
+    if (options.ext_user_id) { params.ext_user_id = options.ext_user_id; }
+    if (options.source && options.source.stage) { params.source.stage = options.source.stage; }
     if (options.target) {
-      if(options.target.org) {
-        params.target.org = options.target.org;
-      }
-      if(options.target.stage) {
-        params.target.stage = options.target.stage;
-      }
-    }
-    if(options.externalrefid) {
-      params.externalrefid = options.externalrefid;
+      if(options.target.org) { params.target.org = options.target.org; }
+      if(options.target.stage) { params.target.stage = options.target.stage; }
     }
-  }
+    if(options.externalrefid) { params.externalrefid = options.externalrefid; }
 
-  //Setup request with URL and Post data
-  var requestAPI = request.post(url).send(params);
+    //Setup request with URL and Post data
+    var requestAPI = request.post(url).send(params);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function (err, response) {
+      if (err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        dfd.resolve(response);
+      }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory field \'options\' are not provided '+
+      'in the request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
 
-  if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-  requestAPI.end(function (err, response) {
-    if (err) {
-      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-      dfd.reject(err);
-    } else {
-      dfd.resolve(response);
-    }
-  });
   return dfd.promise;
 }
 
-//options = {
-//    targetorg: 'dev',
-//    repositorytype: 'github', //mandatory
-//    productcode: 'Product code', //mandatory
-//    title: 'Product title', //mandatory
-//    producttype: 'Product type',  //mandatory e.g., etextbook, imgbook, courseware.
-//    bundle-codes: ['bundle-code of the bundle']  //optional: Product register request, related to a Bundle, currently only one buldle-code in Array
-//    externalrefid: <externalID>
-//
-// /* Note: Register via github is no more supported from v2.5. */
-//    github: {
-//        repository: 'Github repository',
-//        token: 'Github Auth token'
-//    }
-//}
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#registerproductparams
+ */
 function registerProduct(options) {
   var self = this;
-
-  //Initializing promise
   var dfd = q.defer();
 
-  //Construct API url
-  var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.registerProductAPI;
-  url = helpers.api.constructAPIUrl(url, { "orgId" : self.orgId });
-  
-  //Contruct parameters
-  var params = {};
-  if(options) {
-    if(options.targetorg) {
-      params.targetorgid = options.targetorg;
-    }
-    if(options.repositorytype) {
-      params.repositorytype = options.repositorytype;
-    }
-    if(options.producttitle) {
-      params.producttitle = options.producttitle;
-    }
-    if(options.producttype) {
-      params.producttype = options.producttype;
-    }
-    if(options.productcode) {
-      params.productcode = options.productcode;
-    }
-    if(options.github) {
-      params.github = options.github;
-    }
-    if(options.s3) {
-      params.s3 = options.s3;
-    }
-    if(options.externalrefid) {
-      params.externalrefid = options.externalrefid;
-    }
-    if(options['bundle-codes']) {
-      params['bundle-codes'] = options['bundle-codes'];
-    }
-  }
+  if (options) {
+    //Construct API url
+    var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.registerProductAPI;
+    url = helpers.api.constructAPIUrl(url, { 'orgId' : self.orgId });
 
-  //Setup request with URL and Post data
-  var requestAPI = request.post(url).send(params);
+    var params = {};
+    if (options.targetorg) { params.targetorgid = options.targetorg; }
+    if (options.repositorytype) { params.repositorytype = options.repositorytype; }
+    if (options.producttitle) { params.producttitle = options.producttitle; }
+    if (options.producttype) { params.producttype = options.producttype; }
+    if (options.productcode) { params.productcode = options.productcode; }
+    if (options.s3) { params.s3 = options.s3; }
+    if (options.externalrefid) { params.externalrefid = options.externalrefid; }
+    if (options['bundle-codes']) { params['bundle-codes'] = options['bundle-codes']; }
+
+    // Setup request with URL and Post data
+    var requestAPI = request.post(url).send(params);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(err, response) {
+      if (err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        dfd.resolve(response);
+      }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory field \'options\' are not provided '+
+      'in the request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
 
-  if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-  requestAPI.end(function(err, response) {
-    if (err) {
-      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-      dfd.reject(err);
-    } else { 
-      dfd.resolve(response);
-    }
-  });
   return dfd.promise;
 }
 
-//options = {
-//    productcode: "string",
-//    branchref: 'Github branch name or s3 folder path', //mandatory, ingestion via Github no more supported from v2.5.
-//    "externalrefid": <externalID>,
-//    "bundle-codes": ['bundle-code of the bundle'] //optional: Product register request, related to a Bundle
-//}
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#ingestproductparams
+ */
 function ingestProduct(options) {
   var self = this;
-
   //Initializing promise
   var dfd = q.defer();
 
-  var productCode;
-  if(options && options.productcode) {
-    productCode = options.productcode;
-  }
+  if (options && options.productcode) {
+    //Construct API url
+    var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.ingestByCodeAPI;
+    url = helpers.api.constructAPIUrl(url, {
+      'orgId' : self.orgId, 'productcode' : options.productcode
+    });
 
-  //Construct API url
-  var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.ingestByCodeAPI;
-  url = helpers.api.constructAPIUrl(url, {
-    "orgId" : self.orgId,
-    "productcode" : productCode
-  });
-  //Contruct parameters
-  var params = {};
-  if(options) {
-    if(options.branchref) {
-      params.branchref = options.branchref;
-    }
-    if(options.externalrefid) {
-      params.externalrefid = options.externalrefid;
-    }
-    if(options['bundle-codes']) {
-      params['bundle-codes'] = options['bundle-codes'];
-    }
-  }
+    //Contruct parameters
+    var params = {};
+    if (options.ext_user_id) { params.ext_user_id = options.ext_user_id; }
+    if (options.branchref) { params.branchref = options.branchref; }
+    if (options.externalrefid) { params.externalrefid = options.externalrefid; }
+    if (options['bundle-codes']) { params['bundle-codes'] = options['bundle-codes']; }
 
-  //Setup request with URL and Post data
-  var requestAPI = request.post(url).send(params);
+    //Setup request with URL and Post data
+    var requestAPI = request.post(url).send(params);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(err, response) {
+      if (err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        dfd.resolve(response);
+      }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory field \'productcode\' is not provided '+
+      'in the request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
 
-  if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-  requestAPI.end(function(err, response) {
-    if (err) {
-      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-      dfd.reject(err);
-    } else {
-      dfd.resolve(response);
-    }
-  });
   return dfd.promise;
 }
 
-// options = {
-// 	stage: "",		      //stage number or version
-// 	"bundle-code": "",	//bundle identifier
-// 	body: {
-// 		title: "",		    //bundle title
-// 		products: []	    //products array of objects containing following keys:
-                        //mandatory fields:  ext-product, dls-product, meta, activation, analytics, classes,
-                        //optional fields: groups, segment, results-display, assignability, learning-path, activity
-// 	}
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#createbundleparams
+ */
 function createBundle(options) {
   var self = this;
   //Initializing promise
@@ -287,16 +247,10 @@ function createBundle(options) {
   return dfd.promise;
 }
 
-// options = {
-// 	stage: "",					//stage number or version
-// 	"bundle-code": "",	//bundle identifier
-// 	body: {
-// 		title: "",				//bundle title (optional)
-// 		products: []			//products array of objects containing following keys:
-                        //mandatory fields:  ext-product, dls-product, meta, activation, analytics, classes,
-                        //optional fields: groups, segment, results-display, assignability, learning-path, activity
-// 	}
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#updatebundleparams
+ */
 function updateBundle(options) {
   var self = this;
 
@@ -335,10 +289,10 @@ function updateBundle(options) {
   return dfd.promise;
 }
 
-/* options= {
-  stage: "string",          //optional, stage number or version
-  target_role: "string"     // optional
-} */
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#getallbundlesparams
+ */
 function getAllBundles(options) {
   var self = this;
   //Initializing promise
@@ -374,10 +328,10 @@ function getAllBundles(options) {
   return dfd.promise;
 }
 
-// options = {
-//   'bundle-code': "",   //bundle identifier
-//   stage: "",           //stage number/version
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#getsinglebundleparams
+ */
 function getSingleBundle(options) {
   var self = this;
   var dfd = q.defer();
@@ -417,23 +371,10 @@ function getSingleBundle(options) {
   return dfd.promise;
 }
 
-// options = {
-//   "stage": <>,                 // Mandatory
-//   "body": {
-//     "family-code": "string",   // Mandatory
-//     "ext_user_id": "string",   // Optional
-//     "assets": {                // Optional
-//       "branchref": "string",   // Optional
-//       "bucket": "string"       // Optional
-//       "source": {              // Optional
-//         "branchref": "string", // Mandatory
-//         "bucket": "string"     // Mandatory
-//       }
-//     },
-//     "externalrefid": "string", // Optional
-//     "data": {... }             // Optional
-//   }
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#createproductfamilyparams
+ */
 function createProductFamily(options) {
   var self = this;
   //Initializing promise
@@ -470,23 +411,10 @@ function createProductFamily(options) {
   return dfd.promise;
 }
 
-// options = {
-//   "stage": <>,                 // Mandatory
-//   "family-code": <>,           // Mandatory
-//   "body": {
-//     "ext_user_id": "string",   // Optional
-//     "assets": {                // Optional
-//       "branchref": "string",   // Optional
-//       "bucket": "string"       // Optional
-//       "source": {              // Optional
-//         "branchref": "string", // Mandatory
-//         "bucket": "string"     // Mandatory
-//       }
-//     },
-//     "externalrefid": "string", // Optional
-//     "data": {... }             // Optional
-//   }
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#updateproductfamilyparams
+ */
 function updateProductFamily(options) {
   var self = this;
 
@@ -495,7 +423,7 @@ function updateProductFamily(options) {
   var err;
 
   //Validations
-    if (options && options.stage && options['family-code']) {
+  if (options && options.stage && options['family-code']) {
     //Passed all validations, Construct API url
     var url = self.config.DEFAULT_HOSTS['PUB'] + self.config.PUB_API_URLS.updateProductFamily;
     url = helpers.api.constructAPIUrl(url, {
@@ -526,10 +454,8 @@ function updateProductFamily(options) {
 }
 
 /**
- * options = {
- *   "family-code": "",   //product family identifier, Mandatory
- *   "stage"      : "",   //stage number
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#getsingleproductfamilyparams
  */
 function getSingleProductFamily(options) {
   var self = this;
@@ -572,9 +498,8 @@ function getSingleProductFamily(options) {
 }
 
 /**
- * options = {
- *   "stage": <>,   // Optional
- *  }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/07_PUB-Adapter#getallproductfamiliesparams
  */
 function getAllProductFamilies(options) {
   var self = this;

package/lib/services/pushX/index.js

@@ -23,7 +23,6 @@
  * Functions for calling PUSHX.
  ************************************************************/
 
-
 var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
@@ -32,9 +31,6 @@ var helpers = require('../../helpers');
 var pubnubClientWrapper = require('./pubnubClientWrapper');
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = pushX;
 
 var keepaliveAgent = new Agent({
@@ -42,19 +38,16 @@ var keepaliveAgent = new Agent({
   freeSocketTimeout: 30000
 });
 
-/*********************************
- * Public Function definitions
- **********************************/
 function pushX() {
   var _pubnubClientWrapper = pubnubClientWrapper();
   return {
-    "connect": _connect.bind(this, _pubnubClientWrapper),
-    "cleanup": _cleanup.bind(this, _pubnubClientWrapper),
-    "grantByUserOrgId": grantByUserOrgId.bind(this),
-    "grantByAccountId": grantByAccountId.bind(this),
-    "grantByAccountIdOnExtUserId": grantByAccountIdOnExtUserId.bind(this),
-    "grantV2": grantV2.bind(this),
-    "getPushedEvents": getPushedEvents.bind(this)
+    connect: _connect.bind(this, _pubnubClientWrapper),
+    cleanup: _cleanup.bind(this, _pubnubClientWrapper),
+    grantByUserOrgId: grantByUserOrgId.bind(this),
+    grantByAccountId: grantByAccountId.bind(this),
+    grantByAccountIdOnExtUserId: grantByAccountIdOnExtUserId.bind(this),
+    grantV2: grantV2.bind(this),
+    getPushedEvents: getPushedEvents.bind(this)
   };
 }
 
@@ -88,9 +81,16 @@ function _connect(pubnubCW, options) {
   });
 }
 
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#cleanup
+ */
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }
 
-/*options = {}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#get-user--org-level-grants
+ */
 function grantByUserOrgId(options) {
   var dfd = q.defer();  // Initializing promise
   var allowedChannels = ['jobs', 'systemevents'];
@@ -112,12 +112,12 @@ function grantByUserOrgId(options) {
   return dfd.promise;
 }
 
-/*options = {
-    accountId: <accountid>,
-    refId: <extRefId>
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#get-account-level-grants
+ */
 function grantByAccountId(options) {
-	var err ={};
+  var err ={};
   var dfd = q.defer();  // Initializing promise
 
   if(options.accountId && options.refId) {
@@ -142,12 +142,12 @@ function grantByAccountId(options) {
   return dfd.promise;
 }
 
-/*options = {
-    accountId: <accountid>,
-    extUserId: <extUserId>, //mandatory
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#get-account-level-grants-on-extuserid
+ */
 function grantByAccountIdOnExtUserId(options) {
-	var err ={};
+  var err ={};
   var dfd = q.defer();  // Initializing promise
 
   if(options.accountId && options.extUserId) {
@@ -174,8 +174,8 @@ function grantByAccountIdOnExtUserId(options) {
 
 /**
  * This function provides grant token on given channels
- * @param { channels: { exactMatch: [], patterns: [] } } options 
- * @returns { token, publishKey, subscribeKey }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#get-grant-token-for-the-access-manager-v3
  */
 function grantV2(options) {
   var self = this, err = {};
@@ -208,12 +208,8 @@ function grantV2(options) {
 }
 
 /**
- * @param {
- *  *accountid: "string",
- *  *channelName: "string",
- *  *starttime: number,
- *  *endtime: number
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_PUSHX-Adapter#getpushedeventsparams
  */
 function getPushedEvents(options) {
   var self = this;