comprodls-sdk 2.42.3 → 2.43.0

package/lib/comprodls.js

@@ -24,6 +24,7 @@
 var token_manager = require('./token');
 var helpers = require('./helpers');
 var auth = require('./services/auth');
+var authextn = require('./services/authextn');
 var activity = require('./services/activity');
 var analytics = require('./services/analytics');
 var collab = require('./services/collab');
@@ -130,6 +131,7 @@ comproDLS.prototype.request = helpers.api.genericAPICaller;
 
 //Custom Service Adaptors
 comproDLS.prototype.Auth = auth;
+comproDLS.prototype.AuthExtn = authextn;
 comproDLS.prototype.Activity = activity;
 comproDLS.prototype.Analytics = analytics;
 comproDLS.prototype.Collab = collab;

package/lib/config/index.js

@@ -32,6 +32,7 @@ exports.REALM_HOSTS = {
     PROD1: {
       PUB: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -45,6 +46,7 @@ exports.REALM_HOSTS = {
     THOR: {
       PUB: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -58,6 +60,7 @@ exports.REALM_HOSTS = {
     ALPHA: {
       PUB: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://dls-cup-alpha-2093819659.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -69,6 +72,7 @@ exports.REALM_HOSTS = {
     PROD1: {
       PUB: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://internal-dls-cup-prod1-284466545.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -80,6 +84,7 @@ exports.REALM_HOSTS = {
     QA: {
       PUB: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://internal-dls-cup-qa-41690511.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -91,6 +96,7 @@ exports.REALM_HOSTS = {
     HFX: {
       PUB: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://internal-dls-cup-hfx-908523553.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -102,6 +108,7 @@ exports.REALM_HOSTS = {
     REL: {
       PUB: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-pub',
       AUTH: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-auth',
+      AUTHEXTN: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-authextn',
       PUSHX: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-pushx',
       XAPI: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-xapi',
       ATTEMPTS: 'http://internal-dls-cup-rel-1458752944.us-west-2.elb.amazonaws.com/lb-attempts',
@@ -220,6 +227,15 @@ exports.AUTH_API_URLS = {
     particularCustomComponent: '/org/{orgid}/custom-components/{custom_component_code}'
 };
 
+exports.AUTHEXTN_API_URLS = {
+    // Grade Formats related APIs
+    gradeFormat: '/org/{orgid}/gradeformats',
+    particularGradeFormat: '/org/{orgid}/gradeformats/{gradeformat_id}',
+    classGradeformatAssociation: '/org/{orgid}/classes/{classid}/associate-gradeformats/{gradeformat_id}',
+    classGradeformats: '/org/{orgid}/classes/{classid}/gradeformats',
+    gradeformatClasses: '/org/{orgid}/gradeformats/{gradeformat_id}/classes'
+};
+
 exports.ACTIVITY_API_URLS = {
     newAttemptAPI: '/{orgId}/products/{productId}/activities/{activityId}/start',
     activityDetailsAPI: '/{orgId}/products/{productId}/activities/{activityId}',

package/lib/services/auth/index.js

@@ -33,7 +33,7 @@ var converter = require('../../helpers/lib/api/converter');
 var DLSError = helpers.errors.DLSError;
 
 /*********************************
- * Setting Up Module Entry Point  
+ * Setting Up Module Entry Point
  **********************************/
 module.exports = auth;
 
@@ -762,7 +762,7 @@ function getClassUsers(options) {
 //    upFile: '' // path to csv file to be uploaded
 //}
 function pisImport(options) {
-	var self = this;
+  var self = this;
   // Initializing promise
   var dfd = q.defer();
   // Validations
@@ -772,7 +772,7 @@ function pisImport(options) {
     // Passed all validations, Construct API url
     var url = self.config.DEFAULT_HOSTS.AUTH +
               self.config.AUTH_API_URLS.pisImportAPI;
-    url = helpers.api.constructAPIUrl(url, {"orgId" : self.orgId});
+    url = helpers.api.constructAPIUrl(url, {'orgId' : self.orgId});
     // Contruct parameters
     var params = {};
     var upfile;
@@ -807,7 +807,7 @@ function pisImport(options) {
 //	field: '' // apps / lti / sis / pis / product[ANY ONE]
 //}
 function getOrgSettings(options) {
-	var self = this;
+  var self = this;
   // Initializing promise
   var dfd = q.defer();
   // Validations
@@ -852,7 +852,7 @@ function getOrgSettings(options) {
 //	body: {} // the top level settings field to be updated.
 //}
 function updateOrgSettings(options) {
-	var self = this;
+  var self = this;
   // Initializing promise
   var dfd = q.defer();
   // Validations
@@ -948,7 +948,7 @@ function getAllJobs(options) {
     // Passed all validations, Contruct API url
     var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getAllJobs;
     url = helpers.api.constructAPIUrl(url, { accountId : options.accountId, extUserId: options.extUserId });
-  
+
     var params = {};
     if(options.jobType) { params.jobType = options.jobType; }
     if(options.details) { params.details = options.details; }
@@ -1249,7 +1249,7 @@ function getParticularShadowClass(options) {
         if(err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);
-        } 
+        }
         else {
           dfd.resolve(response.body);
         }
@@ -1432,21 +1432,21 @@ function getClassAppdata(options) {
         orgId: self.orgId, classid: options.classid
       });
       //Setup request with URL
-		var requestAPI = request.get(url);
+    var requestAPI = request.get(url);
     if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-		//Setup token in Authorization header
-		requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-		//Call Class Appdata 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);
-			}
-		});
+    //Setup token in Authorization header
+    requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+    //Call Class Appdata 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);
+      }
+    });
     } else {
       err = {};
       err.message = err.description = 'classid  not found in request options.';
@@ -1555,26 +1555,26 @@ function deleteClassAppdata(options) {
 //};
 function enrollUsertoClass(options) {
     var self = this;
-	var err = {};
+  var err = {};
     //Initializing promise
     var dfd = q.defer();
-	if(options && options.classid && options.userid) {
-		//Validations
-		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.AUTH +
+  if(options && options.classid && options.userid) {
+    //Validations
+    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.AUTH +
                 self.config.AUTH_API_URLS.enrollUsertoClass;
-			url = helpers.api.constructAPIUrl(url, {
-				orgId: self.orgId,
-				classId: options.classid,
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId,
+        classId: options.classid,
                 userId: options.userid
-			});
+      });
 
-			//Contruct parameters
-			var params = {};
+      //Contruct parameters
+      var params = {};
 
       //Setup request with URL and Params
       var requestAPI = request.post(url)
@@ -1583,24 +1583,24 @@ function enrollUsertoClass(options) {
                               .query(params);
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-			//Setup token in Authorization header
-			requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-			//Call GET Product by it's code 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);
-				}
-			});
-		}
-	} else {
-		err.message = err.description = 'Mandatory parameter classid or userid not found in request options';
-		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-		dfd.reject(err);
-	}
+      //Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      //Call GET Product by it's code 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);
+        }
+      });
+    }
+  } else {
+    err.message = err.description = 'Mandatory parameter classid or userid not found in request options';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
     return dfd.promise;
 }
 
@@ -1776,49 +1776,49 @@ function unEnrollMultiUserstoClass(options) {
 //};
 function unEnrollUsertoClass(options) {
     var self = this;
-	var err = {};
+  var err = {};
     //Initializing promise
     var dfd = q.defer();
-	if(options && options.classid && options.userid) {
-		//Validations
-		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.AUTH +
+  if(options && options.classid && options.userid) {
+    //Validations
+    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.AUTH +
                 self.config.AUTH_API_URLS.enrollUsertoClass;
-			url = helpers.api.constructAPIUrl(url, {
-				orgId: self.orgId,
-				classId: options.classid,
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId,
+        classId: options.classid,
                 userId: options.userid
-			});
+      });
 
-			//Contruct parameters
-			var params = {};
+      //Contruct parameters
+      var params = {};
 
       //Setup request with URL and Params
       var requestAPI = request.delete(url).query(params);
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-			//Setup token in Authorization header
-			requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-			//Call GET Product by it's code 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);
-				}
-			});
-		}
-	} else {
-		err.message = err.description = 'Mandatory parameter classid or userid not found in request options';
-		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-		dfd.reject(err);
-	}
+      //Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      //Call GET Product by it's code 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);
+        }
+      });
+    }
+  } else {
+    err.message = err.description = 'Mandatory parameter classid or userid not found in request options';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
     return dfd.promise;
 }
 
@@ -2250,8 +2250,8 @@ function deleteAssignedPath(options) {
   options = {
     classid: 'string' //mandatory
     assignedpathid: 'string' //mandatory
-    data: 
-      { 
+    data:
+      {
         title: 'string' //optional
         startdate: 'string' //optional
         duedate: 'string' //optional
@@ -2273,7 +2273,7 @@ function updateAssignedPath(options) {
       // Setup request with URL and Params
       var requestAPI = request.put(url);
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-		  if(options.data) { requestAPI.send(options.data); }
+      if(options.data) { requestAPI.send(options.data); }
 
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
@@ -2551,10 +2551,10 @@ function getAllMembersOfAGroup(options) {
         orgId: self.orgId,
         groupId: options.groupId
       });
-  
+
       // Setup request with URL and Param
-      if(options.cursor){ params.cursor = options.cursor };
-  
+      if(options.cursor){ params.cursor = options.cursor; };
+
       var requestAPI = request.get(url)
       .set('Content-Type', 'application/json')
       .set('Accept', 'application/json')
@@ -2563,7 +2563,7 @@ function getAllMembersOfAGroup(options) {
 
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-  
+
       requestAPI.end(function(error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -2602,11 +2602,11 @@ function getAllGroupMembersByPath(options) {
       url = helpers.api.constructAPIUrl(url, {
         orgId: self.orgId
       });
-  
+
       // Setup request with URL and Params
       params.path = options.path;
-      if(options.cursor){ params.cursor = options.cursor };
-  
+      if(options.cursor){ params.cursor = options.cursor; };
+
       var requestAPI = request.get(url)
       .set('Content-Type', 'application/json')
       .set('Accept', 'application/json')
@@ -2615,7 +2615,7 @@ function getAllGroupMembersByPath(options) {
 
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-  
+
       requestAPI.end(function(error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -2666,10 +2666,10 @@ function createMultiUserGroupMembership(options) {
       var url = self.config.DEFAULT_HOSTS.AUTH +
                 self.config.AUTH_API_URLS.userGroupMembership;
       url = helpers.api.constructAPIUrl(url, { orgId: self.orgId, groupId: options.groupId });
-  
+
       // Setup request with URL and Params
       params = options.body;
-  
+
       var requestAPI = request.post(url)
       .set('Content-Type', 'application/json')
       .set('Accept', 'application/json')
@@ -2677,7 +2677,7 @@ function createMultiUserGroupMembership(options) {
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-  
+
       requestAPI.end(function(error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -2688,7 +2688,7 @@ function createMultiUserGroupMembership(options) {
     } else {
       err = {};
       err.message = err.description = 'Mandatory param - groupId or body or body.users(min. 1 user) ' +
-                                      'not found in request options.'
+                                      'not found in request options.';
       err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
       dfd.reject(err);
     }
@@ -2723,7 +2723,7 @@ function deleteMultiUserGroupMembership(options) {
         orgId: self.orgId,
         groupId: options.groupId
       });
-  
+
       // Setup request with URL and Params
       params = options.body;
       var requestAPI = request.delete(url)
@@ -2744,7 +2744,7 @@ function deleteMultiUserGroupMembership(options) {
     } else {
       err = {};
       err.message = err.description = 'Mandatory param - groupId or body or body.users(min. 1 user) ' +
-                                      'not found in request options.'
+                                      'not found in request options.';
       err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
       dfd.reject(err);
     }
@@ -2871,11 +2871,11 @@ function getMyAllMemberships(options) {
         orgId: self.orgId,
         userId: options.userId
       });
-  
+
       // Setup request with URL and Params
       params.path = options.path;
-      if(options.cursor){ params.cursor = options.cursor };
-  
+      if(options.cursor){ params.cursor = options.cursor; };
+
       var requestAPI = request.get(url)
       .set('Content-Type', 'application/json')
       .set('Accept', 'application/json')
@@ -2884,7 +2884,7 @@ function getMyAllMemberships(options) {
 
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-  
+
       requestAPI.end(function(error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -4048,7 +4048,7 @@ function getAllCustomComponents(options) {
 
     // Setup request with URL and Params
     var params = {};
-    if (options.cursor) { params.cursor = options.cursor; }
+    if (options && options.cursor) { params.cursor = options.cursor; }
 
     var requestAPI = request.get(url).query(params);
     if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }