comprodls-sdk 2.86.2-valky → 2.90.2

package/lib/services/pushX/index.js

@@ -26,7 +26,6 @@
 
 var q = require('q');
 var request = require('superagent');
-var Agent = require('agentkeepalive');
 
 var helpers = require('../../helpers');
 var pubnubClientWrapper = require('./pubnubClientWrapper');
@@ -37,25 +36,18 @@ var DLSError = helpers.errors.DLSError;
  **********************************/
 module.exports = pushX;
 
-var keepaliveAgent = new Agent({
-  timeout: 60000,
-  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)
-  };
+    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)
+    };
 }
 
 /*********************************
@@ -63,190 +55,144 @@ function pushX() {
  **********************************/
 
 function _connect(pubnubCW, options) {
-  var bpubnubV7 = true; // If pubnub v7 or higher in package.json, set it true
-  if (bpubnubV7 && !options.userid) {
-    var err = {};
-    err.message = err.description = 'Mandatory parameter userid not found in request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.PUSHX_ERROR, err);
-    throw err;
-  }
-
-  // Adding SSL flag
-  return pubnubCW.setup({
-    'userid': options.userid,
-    'accountid': options.accountid,
-    'token': options.token,
-    'pubnub': {
-      'publishKey': options.publishKey,
-      'subscribeKey': options.subscribeKey,
-      'ssl': true,
-      'suppressLeaveEvents': true
+    var bpubnubV7 = true; // If pubnub v7 or higher in package.json, set it true
+    if (bpubnubV7 && !options.userid) {
+        var err = {};
+        err.message = err.description = 'Mandatory parameter userid not found in request options.';
+        err = new DLSError(helpers.errors.ERROR_TYPES.PUSHX_ERROR, err);
+        throw err;
     }
-  });
+
+    // Adding SSL flag
+    return pubnubCW.setup({
+      'userid': options.userid,
+      'pubnub': {
+        'publishKey': options.publishKey,
+        'subscribeKey': options.subscribeKey,
+        'authKey': options.authKey,
+        'ssl': true
+      }
+    });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }
 
-/*options = {}*/
+/*options = {
+  authKey: <authKey>
+}*/
 function grantByUserOrgId(options) {
-  var dfd = q.defer();  // Initializing promise
-  var allowedChannels = ['jobs', 'systemevents'];
-  var baseChannelName = "o-" + this.orgId + "\\$u-" + this.token.access_token + "\\$";
-  var patterns = [];
-  for(var i in allowedChannels) {
-    var channelName = baseChannelName + allowedChannels[i] + "\\..*";
-    patterns.push(channelName);
-  }
-  options.channels = {};
-  options.channels.patterns = patterns;
-  grantV2.call(this, options)
-  .then(function (res) {
-    dfd.resolve(res);
-  })
-  .catch(function(err) {
-    dfd.reject(err);
-  });
-  return dfd.promise;
+    var self = this;
+    var dfd = q.defer();  // Initializing promise
+    // Validations
+    var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) { dfd.reject(err); }
+    else {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByUserOrgId;
+        url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+
+        var body = {};
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+
+        //Setup token in Authorization header
+        requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        // Call Change Password Api
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
+    }
+    return dfd.promise;
 }
 
 /*options = {
     accountId: <accountid>,
-    refId: <extRefId>
+    refId: <extRefId>,
+    authKey: <authKey>
 }*/
 function grantByAccountId(options) {
-	var err ={};
-  var dfd = q.defer();  // Initializing promise
-
-  if(options.accountId && options.refId) {
-    var channel = "a-" + options.accountId + "$refid." + options.refId;
-    var exactMatch = [channel];
-    options.channels = {};
-    options.channels.exactMatch = exactMatch;
-    grantV2.call(this, options)
-    .then(function (res) {
-      dfd.resolve(res);
-    })
-    .catch(function(err) {
-      dfd.reject(err);
-    });
-  }
-  else {
-    err.message = err.description = "Required parameter ['accountId', 'refId'] " +
-                                    "not found in request options";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
+	var self = this, err ={};
+    var dfd = q.defer();  // Initializing promise
+
+    if(options.accountId && options.refId) {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByAccountId;
+        url = helpers.api.constructAPIUrl(url, { accountId: options.accountId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        var body = { refId: options.refId };
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
+    }
+    else {
+        err.message = err.description = "Required parameter ['accountId', 'refId'] " +
+                                        "not found in request options";
+        err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+        dfd.reject(err);
+    }
+    return dfd.promise;
 }
 
 /*options = {
     accountId: <accountid>,
     extUserId: <extUserId>, //mandatory
+    authKey: <authKey>
 }*/
 function grantByAccountIdOnExtUserId(options) {
-	var err ={};
-  var dfd = q.defer();  // Initializing promise
-
-  if(options.accountId && options.extUserId) {
-    var channel = "a-" + options.accountId + "$u-" + options.extUserId;
-    var exactMatch = [channel];
-    options.channels = {};
-    options.channels.exactMatch = exactMatch;
-    grantV2.call(this, options)
-    .then(function (res) {
-      dfd.resolve(res);
-    })
-    .catch(function(err) {
-      dfd.reject(err);
-    });
-  }
-  else {
-    err.message = err.description = "Required parameter ['accountId', 'extUserId'] " +
-                                    "not found in request options";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
-}
-
-/**
- * This function provides grant token on given channels
- * @param { channels: { exactMatch: [], patterns: [] } } options 
- * @returns { token, publishKey, subscribeKey }
- */
-function grantV2(options) {
-  var self = this, err = {};
-  var dfd = q.defer();
-  var body = { channels: {} };
-  if(!options.channels) {
-    err.message = err.description = "channels not given in input body.";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-    return dfd.promise;
-  }
-  body.channels = options.channels;
-  // Passed all validations, Construct API url
-  var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantV2;
-  // Setup request with URL and Params
-  var requestAPI = request.post(url)
-                    .set('Content-Type', 'application/json')
-                    .set('Accept', 'application/json');
-  if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-  requestAPI.send(body);
-  requestAPI.end(function(err, response) {
-    if(err) {
-      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-      dfd.reject(err);
+	var self = this, err ={};
+    var dfd = q.defer();  // Initializing promise
+
+    if(options.accountId && options.extUserId) {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByAccountId;
+        url = helpers.api.constructAPIUrl(url, { accountId: options.accountId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        var body = { extUserId: options.extUserId };
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
     }
-    else { dfd.resolve(response.body); }
-  });
-  return dfd.promise;
+    else {
+        err.message = err.description = "Required parameter ['accountId', 'extUserId'] " +
+                                        "not found in request options";
+        err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+        dfd.reject(err);
+    }
+    return dfd.promise;
 }
 
-/**
- * @param {
- *  *accountid: "string",
- *  *channelName: "string",
- *  *starttime: number,
- *  *endtime: number
- * } options
- */
-function getPushedEvents(options) {
-  var self = this;
-  var dfd = q.defer();  // Initializing promise
-  var accountid = options.accountid,
-    channelname = options.channelname,
-    starttime = options.starttime,
-    endtime = options.endtime;
-
-  if (accountid && channelname && starttime && endtime) {
-    // Passed all validations, Construct API url
-    var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.getPushedEvents;
-    url = helpers.api.constructAPIUrl(url, { accountId: accountid });
-
-    // Setup request with URL and Params
-    var params = {channelname: channelname, starttime: starttime, endtime: endtime};
-    var requestAPI = request.get(url).query(params);
-    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-    requestAPI
-      .agent(keepaliveAgent)
-      .end(function(error, response) {
-        if (error) {
-          error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-          dfd.reject(error);
-        } else {
-          dfd.resolve(response.body);
-        }
-    });
-  }
-  else {
-    var err = {};
-    err.message = err.description = 'Mandatory parameters [accountId, channelname,' +
-      ' starttime, endtime] not found in request options';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
-}

package/lib/services/pushX/pubnubClientWrapper.js

@@ -75,7 +75,7 @@ module.exports = function () {
         _eventEmitter.emit(subscribedChannel, message);
     };
 
-    var _translatePubnubStatus = function(status, options) {
+    var _translatePubnubStatus = function(status) {
         var channels = [], error, successObj;
         switch (status.category) {
             case "PNConnectedCategory":
@@ -104,10 +104,8 @@ module.exports = function () {
                 break;
             case "PNAccessDeniedCategory":
                 if(status.operation === "PNSubscribeOperation") {
-                    var errorText = status.errorData.response && status.errorData.response.text;
-                    var errorJSON = errorText ? JSON.parse(errorText) : undefined;
                     var errorData = {
-                        payload: errorJSON && errorJSON.payload || status.errorData.payload,
+                        payload: JSON.parse(status.errorData.response.text).payload,
                         message: 'Forbidden: Subscription failed.',
                         errorDetails: {
                             operation: status.operation,
@@ -136,46 +134,6 @@ module.exports = function () {
                 error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
                 _eventEmitter.emit('pushx_status', error);
                 break;
-            case "PNNetworkIssuesCategory":
-                if(status.operation === 'PNSubscribeOperation') {
-                    if(!options.accountId) {
-                        error = {
-                            message: "Missing mandatory parameters to initiate polling operation - accountId",
-                            status: status.statusCode,
-                            type: helpers.errors.ERROR_TYPES.POLLING_INITIATION,
-                        };
-                        error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                        _eventEmitter.emit('pushx_status', error);
-                        break;
-                    }
-                    else {
-                        /**
-                         * Handle network issue category status for 'subscription' opreration
-                         * Start the events polling here.
-                         *
-                         * The wrapper supports multiple channels, but the APP currently uses a single channel only.
-                         * Polling will also limited to a single channel.
-                         */
-                    }
-                }
-                else {
-                    // Handle network issue category status for other operations like 'unsubscription'
-                }
-                break;
-            case "PNReconnectedCategory":
-                // Handle reconnected category status.
-                break;
-            default:
-                // Emit error for other status-category received from pubnub
-                error = {
-                    message: "PushX Error",
-                    status: status.statusCode,
-                    type: helpers.errors.ERROR_TYPES.UNEXPECTED_ERROR,
-                    pushXError: status
-                };
-                error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                _eventEmitter.emit('pushx_status', error);
-                break;
         }
     };
 
@@ -209,12 +167,9 @@ module.exports = function () {
     var __setup = function (userOptions) {
         var pubnubConfig = userOptions.pubnub;
         pubnubConfig.uuid = userOptions.userid;
-        var accountId = userOptions.accountid;
-        var token = userOptions.token;
 
         if (!_pubnubClient && pubnubConfig) {
             _pubnubClient = new pubNub(pubnubConfig); //Connect with PubNub SDK
-            _pubnubClient.setToken(token);
             processSetup();
         } else {
             return new Error('Already Initialized');
@@ -230,8 +185,7 @@ module.exports = function () {
                     _translatePubnubMessage(data);
                 },
                 "status": function (status) {
-                    var statusOptions = { accountId: accountId };
-                    _translatePubnubStatus(status, statusOptions);
+                    _translatePubnubStatus(status);
                 }
             });
         }

package/lib/services/spaces/index.js

@@ -524,7 +524,6 @@ function provisionBulkSpaces(options) {
  *     *startdate: <epoch>,
  *     *enddate: <epoch>,
  *     description: 'string',
- *     ext_class_title : 'string',
  *     ext_data: {},
  *     limits: {
  *       *los: 0,
@@ -538,7 +537,6 @@ function provisionBulkSpaces(options) {
  *   clone_settings: {
  *     *src_ext_classid: 'string',
  *     products: boolean,
- *     bundles: boolean,
  *     assigned_paths: boolean,
  *     ext_assigned_path_id_rule: 'string'  //enum: ['SRC_ID']
  *     advanced: {
@@ -552,9 +550,6 @@ function provisionBulkSpaces(options) {
  *       ],
  *       products: [
  *         { *productcode: 'string' },
- *       ],
- *       bundles: [
- *         { *bundlecode: 'string' },
  *       ]
  *     }
  *   }

package/lib/services/spacesextn/index.js

@@ -44,8 +44,7 @@ var keepaliveAgent = new Agent({
 function spacesextn(accountId) {
   this.accountId = accountId;
   return {
-    entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this),
-    setupUser: setupUser.bind(this)
+    entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this)
   };
 }
 
@@ -106,46 +105,3 @@ function entitleBulkUsersToProducts(options) {
   return dfd.promise;
 }
 
-/**
- * @param {
- *  *ext_user_id: "string",
- *  *workflow_type: "string",
- *  *<workflow_type>: {}
- * } options
- */
-function setupUser(options) {
-  var self = this;
-  //Initializing promise
-  var deferred = q.defer();
-
-  if (options && options.ext_user_id && options.workflow_type) {
-    //Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS.AUTHEXTN + self.config.AUTHEXTN_API_URLS.setupUser;
-    url = helpers.api.constructAPIUrl(url, { accountId: self.accountId });
-
-    var requestAPI = request.post(url)
-    .set('Content-Type', 'application/json')
-    .set('Accept', 'application/json')
-    .send(options);
-
-    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-    requestAPI
-    .agent(keepaliveAgent)
-    .end(function(err, res) {
-      if (err) {
-        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-        deferred.reject(err);
-      } else {
-        deferred.resolve(res.body);
-      }
-    });
-  } else {
-    var err = {};
-    err.message = err.description = 'Mandatory field \'ext_user_id\' or \'workflow_type\' not found '+
-      'in the request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    deferred.reject(err);
-  }
-  return deferred.promise;
-}

package/lib/services/workflows/index.js

@@ -59,7 +59,6 @@ function workflows(accountId) {
       "address": {
         "city": "string",
         "country": "string",
-        "line1": "string",
         "street1": "string",
         "street2": "string",
         "street3": "string",
@@ -415,7 +414,6 @@ function completeAWorkflow(options) {
         "address": {
           "city": "string",
           "country": "string",
-          "line1": "string",
           "street1": "string",
           "street2": "string",
           "street3": "string",
@@ -425,7 +423,7 @@ function completeAWorkflow(options) {
         "display_name": "string",
         "school_key": "string"
       }
-    }
+    } 
   }
  */
 function updateWorkflowRequest(options) {
@@ -464,4 +462,4 @@ function updateWorkflowRequest(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-}
+}

package/lib/services/xapi/index.js

@@ -42,7 +42,8 @@ function xapi(accountId) {
   this.accountId = accountId;
   return {
     postStatement: postStatements.bind(this),
-    postExternalStatements: postExternalStatements.bind(this)
+    postExternalStatements: postExternalStatements.bind(this),
+    resetUserProductProgress: resetUserProductProgress.bind(this)
   };
 }
 
@@ -231,3 +232,44 @@ function postExternalStatements(options) {
   });
   return dfd.promise;
 }
+
+/*options = {
+    userid: 'string',
+    productcode: 'string',
+    actorid: 'string'
+}*/
+function resetUserProductProgress(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  var err = {};
+  if(options && options.userid && options.productcode && options.actorid) {
+
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.XAPI + self.config.XAPI_API_URLS.resetUserProductProgress;
+    url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
+
+    // Setup request with URL and Params
+    var requestAPI = request.delete(url)
+                    .set('Content-Type', 'application/json')
+                    .set('Accept', 'application/json')
+                    .send(options);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI.end(function(error, response) {
+      if(error) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        dfd.reject(err);
+      }
+      else { dfd.resolve(response.body); }
+    });
+  }
+  else {
+    err.message = err.description = 'userid, productcode or actorid not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.86.2-valky",
+  "version": "2.90.2",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -24,7 +24,7 @@
     "grunt": "^0.4.5",
     "grunt-browserify": "^4.0.1",
     "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-uglify": "4.0.1",
+    "grunt-contrib-uglify": "^0.11.1",
     "semver": "^5.1.0",
     "shelljs": "^0.6.0"
   }

package/test.js

@@ -0,0 +1,38 @@
+
+var orgId = 'dev1';
+
+var ComproDLS = require('../comprodls-sdk-js/lib/comprodls.js').init('DEVELOPMENT','GLOBAL');
+
+var accountId = 'compro';
+var tokenObj = {
+    // "access_token": "71a2d361-16b4-40b4-9a73-2499f808d7fe",
+    //"access_token" : "YWMtb2nasMuyEemJvL3ph9UnmAAAAW0KQNb1ziRGuAkJ_n6LweFX9KOhYaSQeKg~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e", //student //YWMtw4m3tmsMEem5x6kSLL2ajAAAAWqQ3dJz4CkidQEwcm1LDszgrThOUuDLCkA~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e
+    // "access_token" : "YWMtQAfQGHfCEemdBmGZgYqIcgAAAWrkJ96wsnysSc8M5ilW1ZI1jOeLo226vn8~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e", //admin
+    // "expires_in": 604800,
+    // "refresh_token": "c002d2710236789e3f36d0b8670a07b684f44b4a43e9c4a322260c11390d37826a889053c876df0dc3ae49f4701cc27bdc42d77b62ec3735eaaf9ea35cc433f208aeb1d7003eddf38ec9ab418e40caa2fefb9fda6454a3b98daf9d911db4a4e8ca285a2dfbb395b7"
+};
+
+
+var self = this;
+var Adapter = ComproDLS.AuthExtn(accountId);
+
+var Options = {
+    "ext_user_id": "11jan_07",
+    "workflow_type": "org_entitlement",
+    "org_entitlement": {
+        "productcode": "evolve_l1",
+        "orgid": "dev1",
+        "dls_user_id": "71a2d361-16b4-40b4-9a73-2499f808d7fe",
+        "ext_role": "student"
+    }
+};
+
+Adapter.setupUser(Options)
+    .then(function (res) {
+        console.log("^^^^^^^^^^^^^", res);
+    })
+    .catch(function (err) {
+        console.log("ERR CATCG", err);
+})
+
+