comprodls-sdk 2.76.0 → 2.77.0

package/lib/config/index.js

@@ -351,6 +351,7 @@ exports.PUB_API_URLS = {
 exports.PUSHX_API_URLS = {
     grantByUserOrgId: '/orgs/{orgId}/grants',
     grantByAccountId: '/accounts/{accountId}/grants',
+    grantV2: '/ver/v2/grants',
     getPushedEvents: '/accounts/{accountId}/pushed-events/channels'
 };
 

package/lib/services/pushX/index.js

@@ -46,15 +46,16 @@ var keepaliveAgent = new Agent({
  * 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),
-        "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),
+    "grantV2": grantV2.bind(this),
+    "getPushedEvents": getPushedEvents.bind(this)
+  };
 }
 
 /*********************************
@@ -62,146 +63,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;
-    }
+  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,
-      'pubnub': {
-        'publishKey': options.publishKey,
-        'subscribeKey': options.subscribeKey,
-        'authKey': options.authKey,
-        'ssl': true
-      }
-    });
+  // Adding SSL flag
+  return pubnubCW.setup({
+    'userid': options.userid,
+    'accountid': options.accountid,
+    'token': options.token,
+    'pubnub': {
+      'publishKey': options.publishKey,
+      'subscribeKey': options.subscribeKey,
+      'ssl': true
+    }
+  });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }
 
-/*options = {
-  authKey: <authKey>
-}*/
+/*options = {}*/
 function grantByUserOrgId(options) {
-    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;
+  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;
 }
 
 /*options = {
     accountId: <accountid>,
-    refId: <extRefId>,
-    authKey: <authKey>
+    refId: <extRefId>
 }*/
 function grantByAccountId(options) {
-	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;
+	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;
 }
 
 /*options = {
     accountId: <accountid>,
     extUserId: <extUserId>, //mandatory
-    authKey: <authKey>
 }*/
 function grantByAccountIdOnExtUserId(options) {
-	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 {
-        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);
-    }
+	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);
+    }
+    else { dfd.resolve(response.body); }
+  });
+  return dfd.promise;
 }
 
 /**

package/lib/services/pushX/pubnubClientWrapper.js

@@ -55,8 +55,7 @@ module.exports = function () {
                   if(!_globalSubscription.includes(pubNubChannel)) {
                     _globalSubscription.push(pubNubChannel);
                     _globalSubscriptionStatus[pubNubChannel] = {
-                        status: 'pending',
-                        pushedEventIdentifier: pubNubChannel.split('.*')[0]
+                        status: 'pending'
                     };
                     _eventEmitter.on(pubNubChannel, handler);
                     _subscribeToPubNubChannels(pubNubChannel);
@@ -79,6 +78,10 @@ module.exports = function () {
 
     var _translatePubnubStatus = function(status, options) {
         var channels = [], error, successObj;
+
+        // If polling has been initiated, ignore all punnub status
+        if (bPollingInitiated) return;
+
         switch (status.category) {
             case "PNConnectedCategory":
                 if(status.operation === "PNSubscribeOperation") {
@@ -105,10 +108,11 @@ module.exports = function () {
                 }
                 break;
             case "PNAccessDeniedCategory":
-                if(bPollingInitiated) break;
                 if(status.operation === "PNSubscribeOperation") {
+                    var errorText = status.errorData.response && status.errorData.response.text;
+                    var errorJSON = errorText ? JSON.parse(errorText) : undefined;
                     var errorData = {
-                        payload: JSON.parse(status.errorData.response.text).payload,
+                        payload: errorJSON && errorJSON.payload || status.errorData.payload,
                         message: 'Forbidden: Subscription failed.',
                         errorDetails: {
                             operation: status.operation,
@@ -130,7 +134,6 @@ module.exports = function () {
             case "PNBadRequestCategory":
             case "PNNetworkDownCategory":
             case "PNNetworkUpCategory":
-                if(bPollingInitiated) break;
                 error = {
                     message: "PushX Error", status: status.statusCode,
                     pushXError: status
@@ -169,7 +172,6 @@ module.exports = function () {
                 // Handle reconnected category status.
                 break;
             default:
-                if(bPollingInitiated) break;
                 // Emit error for other status-category received from pubnub
                 error = {
                     message: "PushX Error",
@@ -214,9 +216,11 @@ module.exports = function () {
         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');
@@ -247,6 +251,7 @@ module.exports = function () {
             _globalSubscription = [];
             bStatusSubscribed = false;
             _globalSubscriptionStatus = {};
+            bPollingInitiated = false;
         }
         _pubnubClient = undefined;
     };

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,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.76.0",
+  "version": "2.77.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"