comprodls-sdk 2.90.2 → 2.91.0-thor

package/lib/token/index.js

@@ -17,6 +17,7 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Token Manager Module
  * Provides Token managements functions for the SDK
@@ -28,87 +29,92 @@ var helpers = require('../helpers');
 var DLSError = helpers.errors.DLSError;
 var validations = require('./validations');
 
-/*************************************
- * Setting up Exports/Public functions
- *************************************/
 exports.authWithExtUser = authWithExtUser;
 exports.authWithToken = authWithToken;
 
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/02_Authentication-and-Tokens#authwithextuser
+ */
 function authWithExtUser(organizationId, options) {
-    var self = this;
-    var dfd = q.defer();
+  var self = this;
+  var dfd = q.defer();
 
-    //Validation
-    var err = validations.validateAuthWithExtUser(organizationId, options);
-    if (err) {
-        dfd.reject(err);
-    } else {
-        //Passed all Validations, Setup the GET TOKEN API URL.
-        var url = this.config.DEFAULT_HOSTS['AUTH'] + this.config.AUTH_API_URLS.getExtUserTokenAPI;
-        url = helpers.api.constructAPIUrl(url, {"orgId" : organizationId});
+  //Validation
+  var err = validations.validateAuthWithExtUser(organizationId, options);
+  if (err) {
+    dfd.reject(err);
+  } else {
+    //Passed all Validations, Setup the GET TOKEN API URL.
+    var url = this.config.DEFAULT_HOSTS['AUTH'] + this.config.AUTH_API_URLS.getExtUserTokenAPI;
+    url = helpers.api.constructAPIUrl(url, {'orgId' : organizationId});
 
-        //Setup Credentials
-        var params = {
-            "ext_user_id": options.ext_user_id
+    //Setup Credentials
+    var params = {
+      'ext_user_id': options.ext_user_id
+    };
+    //Call the comproDLS GET TOKEN API
+    request.post(url).send(params).end(function(err, response) {
+      if (err) {
+        //API Error, Construct Standard SDK error response
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        //Success, Extract the Token & Other useful information
+        var token = {
+          'access_token': response.body.access_token
+        };
+        var user = response.body.user;
+        var responseObj = {
+          'token': token,
+          'user': user,
+          'metrics': response.body.metrics
         };
-        //Call the comproDLS GET TOKEN API
-        request.post(url).send(params).end(function(err, response) {
-            if (err) {
-                //API Error, Construct Standard SDK error response
-                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            } else {
-
-                //Success, Extract the Token & Other useful information
-                var token = {
-                    'access_token': response.body.access_token
-                };
-                var user = response.body.user;
-                var responseObj = {
-                    'token': token,
-                    'user': user,
-                    'metrics': response.body.metrics
-                }
 
-                //Setting token and organisationid in comproDLS instance
-                self.token = token;
-                self.orgId = user.org.id;
+        //Setting token and organisationid in comproDLS instance
+        self.token = token;
+        self.orgId = user.org.id;
 
-                dfd.resolve(responseObj);
-            }
-        });
-    }
-    return dfd.promise;
+        dfd.resolve(responseObj);
+      }
+    });
+  }
+  return dfd.promise;
 };
 
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/02_Authentication-and-Tokens#authwithtoken
+ */
 function authWithToken(organizationId, token, options) {
-    var self = this;
-    var dfd = q.defer();
+  var self = this;
+  var dfd = q.defer();
 
-    //Validation
-    var err = validations.authWithToken(organizationId, token ,options);
-    if (err) {
-        dfd.reject(err);
-    } else {
+  //Validation
+  var err = validations.authWithToken(organizationId, token ,options);
+  if (err) {
+    dfd.reject(err);
+  } else {
 
-        //Setting token and organisationid in comproDLS instance
-        self.token = token;
-        self.orgId = organizationId;
+    //Setting token and organisationid in comproDLS instance
+    self.token = token;
+    self.orgId = organizationId;
 
-        if (options && options.getuserdetails) {
-            self.Auth().getUserProfile().then(function(response) {
-                var responseObj = {
-                    'token': self.token,
-                    'user': response
-                }
-                dfd.resolve(responseObj);
-            }, function(err) {
-                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            });
-        } else {
-            dfd.resolve(self.token);
-        }
+    if (options && options.getuserdetails) {
+      self.Auth().getUserProfile().then(function(response) {
+        var responseObj = {
+          'token': self.token,
+          'user': response
+        };
+        dfd.resolve(responseObj);
+      }, function(err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      });
+    } else {
+      dfd.resolve(self.token);
     }
-    return dfd.promise;
+  }
+  return dfd.promise;
 };

package/lib/token/validations.js

@@ -17,15 +17,13 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS Token Module Validations
  * This module contains validations for token manager module.
  ************************************************************/
 var validate = require('../helpers').validations.validate;
 
-/****************************************************
- * Setting up Exports/Public variables 
- *****************************************************/
 exports.authWithToken = validateAuthWithToken;
 exports.validateAuthWithExtUser = validateAuthWithExtUser;
 
@@ -33,56 +31,55 @@ exports.validateAuthWithExtUser = validateAuthWithExtUser;
  * Public Function definitions
  **********************************/
 function validateAuthWithToken(organizationId, token ,options) {
-    var validate_options = {
-        'organization': organizationId,
-        'token': token,
-        'options': options
-    };
+  var validate_options = {
+    'organization': organizationId,
+    'token': token,
+    'options': options
+  };
 
-    var validate_constraints = {
-        "organization": {
-            "isString": true,
-            "presence": true
-        },
-        "token": {
-            "isObject": true,
-            "presence": true,
-            "contains": ["access_token"]
-        },
-        "token.access_token": {
-            "isString": true,
-            "presence": true
-        },
-        "options": {
-            "isObject": true
-        }
-    };
+  var validate_constraints = {
+    'organization': {
+      'isString': true,
+      'presence': true
+    },
+    'token': {
+      'isObject': true,
+      'presence': true,
+      'contains': ['access_token']
+    },
+    'token.access_token': {
+      'isString': true,
+      'presence': true
+    },
+    'options': {
+      'isObject': true
+    }
+  };
 
-    return validate(validate_options, validate_constraints);
+  return validate(validate_options, validate_constraints);
 };
 
 function validateAuthWithExtUser(organizationId, options) {
-    var validate_options = {
-        'organization': organizationId,
-        'options': options
-    };
+  var validate_options = {
+    'organization': organizationId,
+    'options': options
+  };
 
-    var validate_constraints = {
-        "organization": {
-            "isString": true,
-            "presence": true
-        },
-        "options": {
-            "isObject": true,
-            "presence": true,
-            "contains": ["ext_user_id"]
-        },
-        "options.ext_user_id": {
-            "isString": true,
-            "presence": true
-        }
-    };
+  var validate_constraints = {
+    'organization': {
+      'isString': true,
+      'presence': true
+    },
+    'options': {
+      'isObject': true,
+      'presence': true,
+      'contains': ['ext_user_id']
+    },
+    'options.ext_user_id': {
+      'isString': true,
+      'presence': true
+    }
+  };
 
-    return validate(validate_options, validate_constraints);
+  return validate(validate_options, validate_constraints);
 };
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.90.2",
+  "version": "2.91.0-thor",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -13,7 +13,6 @@
   },
   "dependencies": {
     "agentkeepalive": "4.2.0",
-    "extend": "3.0.2",
     "pubnub": "7.5.0",
     "q": "~1.4.1",
     "string-template": "^1.0.0",
@@ -24,7 +23,7 @@
     "grunt": "^0.4.5",
     "grunt-browserify": "^4.0.1",
     "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-uglify": "^0.11.1",
+    "grunt-contrib-uglify": "4.0.1",
     "semver": "^5.1.0",
     "shelljs": "^0.6.0"
   }

package/lib/helpers/lib/api/validations.js

@@ -1,73 +0,0 @@
-/*************************************************************************
- *
- * COMPRO CONFIDENTIAL
- * __________________
- *
- *  [2015] - [2020] Compro Technologies Private Limited
- *  All Rights Reserved.
- *
- * NOTICE:  All information contained herein is, and remains
- * the property of Compro Technologies Private Limited. The
- * intellectual and technical concepts contained herein are
- * proprietary to Compro Technologies Private Limited and may
- * be covered by U.S. and Foreign Patents, patents in process,
- * and are protected by trade secret or copyright law.
- *
- * Dissemination of this information or reproduction of this material
- * is strictly forbidden unless prior written permission is obtained
- * from Compro Technologies Pvt. Ltd..
- ***************************************************************************/
-/***********************************************************
- * comproDLS APIS Module Validations
- * This module contains validations for APIS module.
- ************************************************************/
-var validate = require('../validator').validate;
-
-/****************************************************
- * Setting up Exports/Public variables 
- *****************************************************/
-exports.genericAPICaller = validateGenericAPICaller;
-
-/*********************************
- * Public Function definitions
- **********************************/
-function validateGenericAPICaller(apiName, method, url, params) {
-    var validate_options = {
-        'apiName': apiName,
-        'method': method,
-        'url': url,
-        'params':params
-    };
-
-    var validate_constraints = {
-        "apiName" : {
-            "isString" : true,
-            "presence" : true,
-            "inclusion": {
-                "within" : ["AUTH" , "PRODUCT" , "COLLAB" , "ANALYTICS" , "ACTIVITY" , "XAPI"],
-                "message": "^Enter a valid API Name"
-            }
-        },
-        "method" : {
-            "isString" : true,
-            "presence" : true,
-            "inclusion": {
-                "within" : ["GET" , "POST" , "PUT" , "DELETE"],
-                "message": "^Enter a valid HTTP method"
-            }
-        },
-        "url" : {
-            "isString" : true,
-            "presence" : true,
-            "format": {
-                "pattern": "^/.*$",
-                "message": "^Url should start with a /"
-            }
-        },
-        "params" : {
-            "isObject" : true
-        }
-    };
-
-    return validate(validate_options, validate_constraints);
-};

package/lib/helpers/lib/utils.js

@@ -1,24 +0,0 @@
-/*************************************************************************
- *
- * COMPRO CONFIDENTIAL
- * __________________
- *
- *  [2015] - [2020] Compro Technologies Private Limited
- *  All Rights Reserved.
- *
- * NOTICE:  All information contained herein is, and remains
- * the property of Compro Technologies Private Limited. The
- * intellectual and technical concepts contained herein are
- * proprietary to Compro Technologies Private Limited and may
- * be covered by U.S. and Foreign Patents, patents in process,
- * and are protected by trade secret or copyright law.
- *
- * Dissemination of this information or reproduction of this material
- * is strictly forbidden unless prior written permission is obtained
- * from Compro Technologies Pvt. Ltd..
- ***************************************************************************/
-/***********************************************************
- * comproDLS SDK Util Module
- * This module provides Utility functions for SDK
- ************************************************************/
-exports.isBrowser = typeof window !== "undefined";

package/lib/services/activity/activity.js

@@ -1,209 +0,0 @@
-/*************************************************************************
- *
- * COMPRO CONFIDENTIAL
- * __________________
- *
- *  [2015] - [2020] Compro Technologies Private Limited
- *  All Rights Reserved.
- *
- * NOTICE:  All information contained herein is, and remains
- * the property of Compro Technologies Private Limited. The
- * intellectual and technical concepts contained herein are
- * proprietary to Compro Technologies Private Limited and may
- * be covered by U.S. and Foreign Patents, patents in process,
- * and are protected by trade secret or copyright law.
- *
- * Dissemination of this information or reproduction of this material
- * is strictly forbidden unless prior written permission is obtained
- * from Compro Technologies Pvt. Ltd..
- ***************************************************************************/
-
-/***********************************************************
- * comproDLS SDK Activity API Adaptor
- * Functions for calling Activity API.
- ************************************************************/
-var request = require('superagent');
-var q = require('q');
-
-var helpers = require('../../helpers');
-var DLSError = helpers.errors.DLSError;
-var extend = require('extend');
-/*********************************
- * Public Function definitions
- **********************************/
-module.exports = Activity;
-
-var attempt = require('./attempt');
-
-function Activity(productId, activityId, classId) {
-    //When Activity constructor is called, check for instance type
-    //comproDLS.Activity() will give instance type as ComproDLS
-    //So the control goes to else
-    if (this instanceof Activity) {
-        this.productId = productId; //Here this is instance of Activity
-        this.activityId = activityId; //Here this is instance of Activity
-        this.classId = classId;
-        
-    } else { //New object of Activity is created and its instance type is Activity
-        var act = new Activity(productId, activityId, classId);
-        act.token = this.token; //Here this is instance of ComproDLS
-        act.orgId = this.orgId; //Here this is instance of ComproDLS
-        act.config = this.config;
-        return act;
-    }
-};
-
-Activity.prototype.getDetails = function () {
-    var self = this;
-
-    //Initializing promise
-    var dfd = q.defer();
-
-    //Validations
-        var err = helpers.validations.isAuthenticated(this.orgId, this.token);
-        if (err) {
-            dfd.reject(err);
-        } else {
-
-    //Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS['ACTIVITY'] + self.config.ACTIVITY_API_URLS.activityDetailsAPI;
-
-    url = helpers.api.constructAPIUrl(url, {
-            "orgId" : self.orgId,
-            "productId" : self.productId,
-            "activityId" : self.activityId
-        });
-    url = helpers.api.addClassIdQueryParam(url, self.classId);
-
-    //Setup request with URL and Params
-    var req = request.get(url);
-
-    //Setup token in Authorization header
-    req = helpers.api.setupAPIToken(req, self.token);
-
-    // setting up traceid
-    if(self.traceid) { req.set('X-Amzn-Trace-Id', self.traceid); }
-
-    //Call GET activity details Api
-    req.end(function (err, response) {
-        if (err) {
-            err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-            dfd.reject(err);
-        } else {
-            var responseBody = response.body;
-            var resObject = new Object();
-            resObject.activity = responseBody;
-            dfd.resolve(resObject);
-        }
-    });
-    }
-    return dfd.promise;
-}
-
-Activity.prototype.loadAttempt = function (attemptId) {
-    var oldAttempt = new attempt(this.productId, this.activityId, attemptId, null, this.classId, this.config);
-    oldAttempt.setAuthCredentials(this.orgId, this.token);
-    return oldAttempt.getAttemptInfo();
-}
-
-Activity.prototype.getAttempt = function (attemptId) {
-    var oldAttempt = new attempt(this.productId, this.activityId, attemptId, null, this.classId, this.config);
-    oldAttempt.setAuthCredentials(this.orgId, this.token);
-    return oldAttempt;
-}
-
-Activity.prototype.newAttempt = function (params) {
-    var newAttempt = new attempt(this.productId, this.activityId, null, null, this.classId, this.config);
-    newAttempt.setAuthCredentials(this.orgId, this.token);
-    return newAttempt.start(params);
-}
-
-Activity.prototype.getAllQuestions = function () {
-        var self = this;
-
-    //Initializing promise
-    var dfd = q.defer();
-
-    //Validations
-        var err = helpers.validations.isAuthenticated(this.orgId, this.token);
-        if (err) {
-            dfd.reject(err);
-        } else {
-
-    //Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS['PRODUCT'] + self.config.PRODUCT_API_URLS.activityAPI;
-    url = helpers.api.constructAPIUrl(url, {
-            "orgId" : self.orgId,
-            "productId" : self.productId,
-            "activityId" : self.activityId
-        });
-    url = helpers.api.addClassIdQueryParam(url, self.classId);
-    //Setup request with URL and Params
-    var req = request.get(url);
-
-    //Setup token in Authorization header
-    req = helpers.api.setupAPIToken(req, self.token);
-
-    // Setting trace id
-    if(self.traceid) { req.set('X-Amzn-Trace-Id', self.traceid); }
-
-    //Call GET activity details Api
-    req.end(function (err, response) {
-        if (err) {
-            err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-            dfd.reject(err);
-        } else {
-            var responseBody = response.body;
-            var resObject = new Object();
-            resObject.questions = responseBody.items;
-            dfd.resolve(resObject);
-        }
-    });
-    }
-    return dfd.promise;
-}
-
-Activity.prototype.getQuestionsCount = function () {
-        var self = this;
-
-    //Initializing promise
-    var dfd = q.defer();
-
-    //Validations
-        var err = helpers.validations.isAuthenticated(this.orgId, this.token);
-        if (err) {
-            dfd.reject(err);
-        } else {
-
-    //Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS['PRODUCT'] + self.config.PRODUCT_API_URLS.activityAPI;
-    url = helpers.api.constructAPIUrl(url, {
-            "orgId" : self.orgId,
-            "productId" : self.productId,
-            "activityId" : self.activityId
-        });
-    url = helpers.api.addClassIdQueryParam(url, self.classId);
-    //Setup request with URL and Params
-    var req = request.get(url);
-
-    //Setup token in Authorization header
-    req = helpers.api.setupAPIToken(req, self.token);
-
-    // Setting trace id
-    if(self.traceid) { req.set('X-Amzn-Trace-Id', self.traceid); }
-
-    //Call GET activity details Api
-    req.end(function (err, response) {
-        if (err) {
-            err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-            dfd.reject(err);
-        } else {
-            var responseBody = {"count": response.body.items.length};
-            var resObject = new Object();
-            resObject.count = responseBody;
-            dfd.resolve(resObject);
-        }
-    });
-    }
-    return dfd.promise;
-}