comprodls-sdk 2.42.2 → 2.42.3

package/lib/services/auth/index.js

@@ -2009,8 +2009,28 @@ function updateClass(options) {
         "analytics_score_aggregation_type": true,
         "ext_data": true,
         "advanced": {
-          "students": [ { "ext_user_id": "string" } ],
-          "teachers": [ { "ext_user_id": "string" } ],
+          "students": [
+            {
+              "ext_user_id": "string",
+              "invite-students": <boolean>,
+              "first_name": "string",
+              "last_name": "string",
+              "email": "string",
+              "dls_org_status": "string",
+              "ext_account_status": "string"
+            }
+          ],
+          "teachers": [
+            {
+              "ext_user_id": "string",
+              "invite-teachers": <boolean>,
+              "first_name": "string",
+              "last_name": "string",
+              "email": "string",
+              "dls_org_status": "string",
+              "ext_account_status": "string"
+            }
+          ]
           "groups": [ { "groupid": "string" } ],
           "assigned_paths": [
             {
@@ -3256,7 +3276,15 @@ function getParticularGradebookMetaOfAClass(options) {
             error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
             deferred.reject(error);
           } else {
-            deferred.resolve(response.body.entities[0]);
+            if (response.body.entities) {
+              deferred.resolve(response.body.entities[0]);
+            } else {
+              /**
+               * An empty response is sent when the requested gradebook doesn't exist in the class.
+               * In this case, the API sends an 204 (No-Content) response.
+               */
+              deferred.resolve();
+            }
           }
       });
     } else {

package/package.json

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

package/apiResponseTime.js

@@ -1,198 +0,0 @@
-let comprodls = require('./lib/comprodls');
-let bunyan = require('bunyan');
-let bformat = require('bunyan-format');
-let Q = require('q');
-const { async } = require('q');
-// let comproDLS = require('comprodls-sdk').init();
-let options = require('./input');
-
-var formatOut = bformat({ outputMode: 'short' });
-var loggerOpptions = {
-	name: 'script', stream: formatOut, level: 'debug'
-};
-
-// let authOptions = {
-//   'access_token': '3a63697f-1817-11eb-9368-0242ac110003'
-// };
-
-function apiTimeResponse(){
-	var logger = bunyan.createLogger(loggerOpptions);
-	console.log(JSON.stringify(options));
-	// let options = {//import from diff file
-	// 	configuration: {
-	// 		NTimes: 2,
-	// 		orgid: 'dev1',
-	// 		account: 'compro',
-	// 		intraBatchDelay: 500,
-	// 		interBatchDelay: 1000
-	// 	},
-	// 	token: authOptions,
-	// 	// getClassUsers:{
-	// 	// 	classid: 'd982518b-86e0-4e14-b0fa-00e0afe63434'
-	// 	// 	// cursor
-	// 	// },
-	// 	getAGroup: {
-	// 		groupId: '84339a32-8950-4121-9ec0-8ac6d11409ea'
-	// 	},
-	// 	getUserSpaces: {
-	// 		extuserid: 'SuperAdmin-20-July-2021-1',
-	// 		details: true
-	// 		// spaceRole,
-	// 		// spaceType,
-	// 		// spaceOrgContext,
-	// 		// cursor
-	// 	}
-	// };
-	let authToken = {
-		token: options.token
-	};
-	authToken.orgid = options.configuration.orgid;
-
-	// comproDLS.authWithToken('dev1', saved_token , {})
-	// .then(function success(response) {
-	// 		var token = response["token"];
-	// 	}, 
-	// 	function error(errorObject) {
-	// 		//Do error handling here
-	// 		console.log(errorObject);
-	// 	}
-	// );
-	// var auth = comproDLS.Auth();
-	// auth.getAGroup(options.getAGroup)
-	// .then(function(response) {
-	// 	console.log(response);
-	// })
-	// .catch(function(err) {
-	// 	console.log(err);
-	// });
-	let SDKCaller = comprodls.init('DEVELOPMENT', 'GLOBAL',  authToken);
-
-	
-
-	// recursiveFunc(SDKCaller, options, logger);
-	getResponseTime(SDKCaller, options, logger);
-}
-
-async function getResponseTime(SDKCaller, options, logger){
-	let { configuration, getAGroup, getUserSpaces } = options;
-	let delayOptions;
-	for(let i=0; i<configuration.NTimes; i++) {
-		try{
-			delayOptions = {
-				params: getAGroup,
-				account: configuration.account,
-				waitTime: configuration.interBatchDelay
-			};
-			await delay(getAGroupFunc, SDKCaller, delayOptions, logger);
-			delayOptions = {
-				params: getUserSpaces,
-				account: configuration.account,
-				waitTime: configuration.intraBatchDelay
-			};
-			await delay(getUserSpacesFunc, SDKCaller, delayOptions, logger);
-		}
-		catch(err) {
-			logger.info(`apiResponse#error = ${err}`);
-		}
-	}
-}
-
-// function recursiveFunc(SDKCaller, options, logger) {
-// 	let { configuration, getAGroup, getUserSpaces } = options;
-// 	let startTime, delayOptions;
-
-// 	if (configuration.NTimes<=0) {
-// 		return;
-// 	}
-
-// 	delayOptions = {
-// 		params: getAGroup,
-// 		account: configuration.account,
-// 		waitTime: configuration.interBatchDelay
-// 	};
-// 	delay(getAGroupFunc, SDKCaller, delayOptions, logger)
-// 	// .then(function () {
-// 	// 	delayOptions = {
-// 	// 		params: getAGroup,
-// 	// 		account: configuration.account,
-// 	// 		waitTime: configuration.intraBatchDelay
-// 	// 	};
-// 	// 	return delay(getAGroupFunc, SDKCaller, delayOptions, logger);
-// 	// })
-// 	.then(function () {
-// 		delayOptions = {
-// 			params: getUserSpaces,
-// 			account: configuration.account,
-// 			waitTime: configuration.intraBatchDelay
-// 		};
-// 		return delay(getUserSpacesFunc, SDKCaller, delayOptions, logger);
-// 	})
-// 	.then(function () {
-// 		configuration.NTimes--;
-// 		return recursiveFunc(SDKCaller, options, logger);
-// 	})
-// 	.catch(function (err) {
-// 		logger.info(`apiResponse#error = ${err}`);
-// 	});
-// }
-
-
-function delay(waitFunc, SDKCaller, options, logger) {
-  let deferred = Q.defer();
-
-	setTimeout(waitFunc, options.waitTime, SDKCaller, options, logger, deferred);
-
-  return deferred.promise;
-}
-
-function getClassUsersFunc(SDKCaller, options, logger, deferred) {
-	let { params, account } = options;
-	let startTime = Date.now();
-
-	SDKCaller.Auth(account).getClassUsers(params)
-	.then(function () {
-		logger.info(`apiResponse#getClassUsers#success#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	})
-	.catch(function (err) {
-		logger.info(`apiResponse#getClassUsers#error: ${err}`);
-		logger.info(`apiResponse#getClassUsers#error#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	});
-	return deferred.promise;
-}
-
-function getAGroupFunc(SDKCaller, options, logger, deferred) {
-	let { params, account } = options;
-	let startTime = Date.now();
-
-	SDKCaller.Auth(account).getAGroup(params)
-	.then(function () {
-		logger.info(`apiResponse#getAGroup#success#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	})
-	.catch(function (err) {
-		logger.info(`apiResponse#getAGroup#error: ${JSON.stringify(err)}`);
-		logger.info(`apiResponse#getAGroup#error#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	});
-	return deferred.promise;
-}
-
-function getUserSpacesFunc(SDKCaller, options, logger, deferred) {
-	let { params, account } = options;
-	let startTime = Date.now();
-	SDKCaller.Spaces(account).getUserSpaces(params)
-	.then(function () {
-		logger.info(`apiResponse#getUserSpaces#success#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	})
-	.catch(function (err) {
-		logger.info(`apiResponse#getUserSpaces#error: ${JSON.stringify(err)}`);
-		logger.info(`apiResponse#getUserSpaces#error#time=${(Date.now()-startTime)}ms.`);
-		deferred.resolve();
-	});
-	return deferred.promise;
-}
-
-apiTimeResponse();

package/input.js

@@ -1,28 +0,0 @@
-let input = {//import from diff file
-    configuration: {
-        NTimes: 20,
-        orgid: 'aberystwyth-thor',
-        account: 'cup1',
-        intraBatchDelay: 500,
-        interBatchDelay: 1000
-    },
-    token: {
-        'access_token': '3a63697f-1817-11eb-9368-0242ac110003'
-      },
-    // getClassUsers:{
-    // 	classid: 'd982518b-86e0-4e14-b0fa-00e0afe63434'
-    // 	// cursor
-    // },
-    getAGroup: {
-        groupId: 'e842f79d-44b8-4f0b-88d6-3346ffa92a53'
-    },
-    getUserSpaces: {
-        extuserid: 'api_team_admin',
-        details: true
-        // spaceRole,
-        // spaceType,
-        // spaceOrgContext,
-        // cursor
-    }
-};
-module.exports = input;

package/input.json

@@ -1,27 +0,0 @@
-let input = {//import from diff file
-configuration: {
-    NTimes: 20,
-    orgid: 'aberystwyth-thor',
-    account: 'cup1',
-    intraBatchDelay: 500,
-    interBatchDelay: 1000
-},
-token: {
-    'access_token': '3a63697f-1817-11eb-9368-0242ac110003'
-  },
-// getClassUsers:{
-// 	classid: 'd982518b-86e0-4e14-b0fa-00e0afe63434'
-// 	// cursor
-// },
-getAGroup: {
-    groupId: 'e842f79d-44b8-4f0b-88d6-3346ffa92a53'
-},
-getUserSpaces: {
-    extuserid: 'api_team_admin',
-    details: true
-    // spaceRole,
-    // spaceType,
-    // spaceOrgContext,
-    // cursor
-}
-};

package/test.js

@@ -1,30 +0,0 @@
-var comprodls = require('./lib/comprodls');
-
-var authOptions = {
-  'access_token': '97fe7f89-6883-4294-9c3e-5da969e8795e',
-  'expires_in': 604800,
-  'refresh_token': 'c002d2710236789e3f36d0b8670a07b684f44b4a43e9c4a322260c11390d37826a889053c876df0dc3ae49f4702fd014c36cd83654ec3729fa95a0be72ec36f16bf297d7003ed2d3b7ceab74dd70cadbcf9794db1e50b0b3bff0daa0078590e7e271532f9b8faab3',
-};
-var options = {
-  token: authOptions
-};
-options.orgid = 'dev1';
-
-var params = {
-  classid: 'd982518b-86e0-4e14-b0fa-00e0afe63434'
-
-};
-
-var temp = comprodls.init('DEVELOPMENT','GLOBAL',  options);
-temp.Auth('compro').getClassUsers(params)
-.then((result)=>{
-    console.log(JSON.stringify(result, 0, 2));
-})
-.catch((err)=>{
-    console.log(err);
-});
-
-// ,
-// DEVELOPMENT: {
-//     AUTH: 'http://localhost:5000'
-//   }