comprodls-sdk 2.39.0 → 2.41.0

package/lib/config/index.js

@@ -213,11 +213,11 @@ exports.AUTH_API_URLS = {
     updateOrDeleteGradebookMeta: '/org/{orgId}/classes/{classId}/gradebooks/{gradebook_id}',
     gradebookColumns: '/org/{orgId}/classes/{classId}/gradebooks/{gradebook_id}/columns',
     getAllClassesOfAComponent: '/org/{orgId}/components/{component_code}/classes',
-    removeAllGradebookColumnsOfAComponent: '/org/{orgId}/gradebook/columns/custom-components/{component_code}',
+    removeAllGradebookColumnsOfCustomComponent: '/org/{orgId}/gradebook/columns/custom-components/{component_code}',
 
     // Custom Components related APIs
     customComponents: '/org/{orgid}/custom-components',
-    particularCustomComponent: '/org/{orgid}/custom-components/{custom_component_code}',
+    particularCustomComponent: '/org/{orgid}/custom-components/{custom_component_code}'
 };
 
 exports.ACTIVITY_API_URLS = {
@@ -260,7 +260,11 @@ exports.ANALYTICS_API_URLS = {
     getMyAssignedPathsOfClass: '/{orgId}/user/class/assigned-paths',
     getAssignedPathAnalytics: '/{orgId}/class/assigned-paths/aggregations',
 
-    timeseriesAnalytics: '/progress/timeseries'
+    timeseriesAnalytics: '/progress/timeseries',
+
+    //ClassCustomComponentRecord Related APIs
+    getClassCustomComponentRecord: '/{orgId}/class/custom-component/class-record',
+    getClassCustomComponentUserSubmission: '/{orgId}/class/custom-component/class-record/evaluations'
 };
 
 exports.SISEVENTS_API_URLS = {

package/lib/services/analytics/index.js

@@ -86,7 +86,11 @@ function analytics() {
     getMyParticularAssignedPathOfClass: getMyParticularAssignedPathOfClass.bind(this),
     
     getTimeseriesAnalytics: getTimeseriesAnalytics.bind(this),
-    postProgressTimeseries: postProgressTimeseries.bind(this)
+    postProgressTimeseries: postProgressTimeseries.bind(this),
+
+    //ClassCustomComponentRecord Related APIs
+    getClassCustomComponentRecord: getClassCustomComponentRecord.bind(this),
+    getClassCustomComponentUserSubmission: getClassCustomComponentUserSubmission.bind(this)
   };
 }
 
@@ -1769,3 +1773,120 @@ function postProgressTimeseries(options) {
   }
   return dfd.promise;
 }
+
+/* This function will get all the customcomponent analytics of each user for each item in a class.
+ * options = {
+ *  classid: 'string',                // class uuid(mandatory)
+ *  custom-component-code: 'string',  // class custom component code(optional)
+ *}
+ */
+ function getClassCustomComponentRecord(options) {
+  var self = this;
+
+  //Initializing DFD
+  var dfd = q.defer(), err = {};
+
+  // Validations
+  if(options && options.classid) {
+    err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err){ dfd.reject(err); }
+    else {
+      // Passed all validations, Constructing URL
+      var url = self.config.DEFAULT_HOSTS['ANALYTICS'] +  self.config.ANALYTICS_API_URLS.getClassCustomComponentRecord;
+      url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+      // Setup Query Params
+      var queryParams = {
+        classid: options.classid
+      };
+
+      if(options['custom-component-code']) {  
+        queryParams['custom-component-code'] = options['custom-component-code'];
+      }
+
+      // Setup Request with url and params
+      var requestAPI = request.get(url).query(queryParams);
+      // Setup token in Authorization Header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      // setting up traceid
+      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      // Call GET CLASS CUSTOM COMPONENT RECORD ITEM
+      requestAPI.end(function(error, response) {
+        if(error) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          err.message = error.response.res.text;
+          dfd.reject(err);
+        } else {
+          dfd.resolve(response.body);
+        }
+      });
+    }
+  } else {
+    err.message = err.description = 'Required parameter classid not found in request options.';
+		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+		dfd.reject(err);
+  }
+  return dfd.promise;
+}
+
+/* This function will get submissions of user on an item of custom component.
+ * options = {
+ *  classid: 'string',                // class uuid(mandatory)
+ *  custom-component-code: 'string',  // class custom component code(mandatory)
+ *  userid: 'string',                 // user uuid(mandatory)
+ *  item-code: 'string'               // item-code of an item(mandatory)
+ *}
+ */
+ function getClassCustomComponentUserSubmission(options) {
+  var self = this;
+
+  //Initializing DFD
+  var dfd = q.defer(), err = {};
+
+  // Validations
+  if(options && options.classid && options['custom-component-code'] &&
+    options.userid && options['item-code']) {
+    err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err){ dfd.reject(err); }
+    else {
+      // Passed all validations, Constructing URL
+      var url = self.config.DEFAULT_HOSTS['ANALYTICS'] +  self.config.ANALYTICS_API_URLS.getClassCustomComponentUserSubmission;
+      url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+      // Setup Query Params
+      var queryParams = {
+        classid: options.classid,
+        userid: options.userid,
+        'custom-component-code': options['custom-component-code'],
+        'item-code': options['item-code']
+      };
+
+      // Setup Request with url and params
+      var requestAPI = request.get(url).query(queryParams);
+      // Setup token in Authorization Header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      // setting up traceid
+      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      // Call GET CLASS CUSTOM COMPONENT SUBMISSION OF A USER ON AN ITEM
+      requestAPI.end(function(error, response) {
+        if(error) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          err.message = error.response.res.text;
+          dfd.reject(err);
+        } else {
+          dfd.resolve(response.body);
+        }
+      });
+    }
+  } else {
+    err.message = err.description = 'Required parameter classid or ' +
+    'custom-component-code or ' + 'userid or ' + 'item-code not found in request options.';
+		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+		dfd.reject(err);
+  }
+  return dfd.promise;
+}

package/lib/services/auth/index.js

@@ -117,7 +117,7 @@ function auth() {
     getParticularColumnOfAGradebook: getParticularColumnOfAGradebook.bind(this),
     getAllColumnsOfAGradebook: getAllColumnsOfAGradebook.bind(this),
     getAllClassesOfAComponent: getAllClassesOfAComponent.bind(this),
-    removeAllGradebookColumnsOfAComponent: removeAllGradebookColumnsOfAComponent.bind(this),
+    removeAllGradebookColumnsOfCustomComponent: removeAllGradebookColumnsOfCustomComponent.bind(this),
 
     // Custom Components related APIs
     createCustomComponent: createCustomComponent.bind(this),
@@ -3342,6 +3342,7 @@ function getAllGradebooksMetaOfAClass (options) {
           "bundle-codes": [],
           "productcode": "string",
           "custom_component_code": "string",
+          "scoring_type": "string",
           "items": [
             {
               "item-code": "string"
@@ -3714,7 +3715,7 @@ function getAllClassesOfAComponent (options) {
     component_code: "string" //mandatory
   }
 */
-function removeAllGradebookColumnsOfAComponent (options) {
+function removeAllGradebookColumnsOfCustomComponent (options) {
     // Initializing promise
     var deferred = q.defer();
     var self = this;
@@ -3728,7 +3729,7 @@ function removeAllGradebookColumnsOfAComponent (options) {
       if (options && options.component_code) {
         // Passed all validations, Contruct API url
         var url = self.config.DEFAULT_HOSTS.AUTH +
-          self.config.AUTH_API_URLS.removeAllGradebookColumnsOfAComponent;
+          self.config.AUTH_API_URLS.removeAllGradebookColumnsOfCustomComponent;
 
         url = helpers.api.constructAPIUrl(url, {
           orgId: self.orgId,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.39.0",
+  "version": "2.41.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -12,16 +12,16 @@
     "node": ">= 0.8.0"
   },
   "dependencies": {
+    "agentkeepalive": "4.2.0",
     "extend": "^2.0.0",
+    "pubnub": "7.0.1",
     "q": "~1.4.1",
     "socket.io-client": "1.4.5",
     "string-template": "^1.0.0",
     "superagent": "~1.7.2",
     "tincanjs": "^0.50.0",
     "underscore": "1.8.3",
-    "validate.js": "^0.9.0",
-    "pubnub": "7.0.1",
-    "agentkeepalive": "4.2.0"
+    "validate.js": "^0.9.0"
   },
   "devDependencies": {
     "grunt": "^0.4.5",