comprodls-sdk 2.12.0 → 2.12.1

package/grunt/publish.js

@@ -1,149 +1,149 @@
-/*************************************************************************
- *
- * 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 Publish Task
- * This task publishes/release new version of SDK to npm and bower.
- * Releasing new version invloves following tasks:  
- * 1. Update package.json and bower.json with new tag/release number.
- * 2. Commit above changes (master branch). 
- * 3. Create a new GIT release tag.
- * 4. Push the new tag and master branch to origin.
- * 5. Publish to NPM.
- ************************************************************/
-
-var shell = require('shelljs');
-var semver = require('semver');
-
-module.exports = function(grunt) {
-
-    /* Grunt Task to publish/release new version of SDK to npm and bower.
-     * Params:
-     *    tagnumber : new tag/release number
-     */
-    grunt.registerTask('publish', 'Task to publish/release new version of SDK to npm and bower', function(tagnumber) {
-
-        //Get the options object 
-        var options = this.options();
-
-        //Get the GIT access token from the environment variable. 
-        var token = process.env[options.github_access_token];
-
-        //Construct URL of the repository.
-        var url = "https://" + token + "@github.com/comprodls/comprodls-sdk-js.git"
-
-        //Check whether the tagnumber is semantically valid
-        if (!tagnumber || !semver.valid(tagnumber)) {
-            //If tagnumber is not valid, throw error
-            grunt.fatal("Please enter a valid semver tagnumber");
-        }
-
-        var checkTags = shell.exec('git ls-remote --tags', {silent: true}).stdout;
-        if(checkTags.indexOf('tags/v' + tagnumber) != -1) {
-            //If tagnumber is already present, throw error
-            grunt.fatal( tagnumber + " is already present");
-        }
-            
-
-        //Function to update the version in package.json and bower.json
-        function updateVersion() {
-            //Read package.json and bower.json file
-            var pkg = grunt.file.readJSON('package.json');
-            var bower = grunt.file.readJSON('bower.json');
-
-            //Update version to specified tagnumber
-            pkg.version = tagnumber;
-            bower.version = tagnumber;
-
-            //Save package.json file
-            grunt.file.write('package.json', JSON.stringify(pkg, null, "  "));
-            grunt.log.ok('Updated version of package.json to ' + tagnumber);
-
-            //Save bower.json file
-            grunt.file.write('bower.json', JSON.stringify(bower, null, "  "));
-            grunt.log.ok('Updated version of bower.json to ' + tagnumber);            
-        };
-
-        //Function to stage the changes.
-        function add() {
-            var cmd = 'git add --all';
-            return run(cmd, 'Staged all files');
-        };
-
-        //Function to commit the changes.
-        function commit() {
-            add();
-            var commitMessage = "Release " + tagnumber + " , Creating JS Bundle files and updating SDK version.";
-            var options = '-m "' + commitMessage + '"';
-            var cmd = 'git commit ' + options;
-            return run(cmd, 'Committed all files');
-        };
-
-        //Function to create a new tag with the updates
-        function tag() {
-            var tagName = "v" + tagnumber;
-            var tagMessage = tagnumber;
-            var cmd = 'git tag ' + tagName + ' -m "' + tagMessage + '"';
-            return run(cmd, 'Created new tag v' + tagnumber);
-        };
-
-        //Function to push the changes in master branch to remote
-        function pushMaster() {
-            var cmd = "git push " + url + " master";
-            return run(cmd, 'Pushed branch master to remote');
-        };
-
-        //Function to push the latest tag to remote
-        function pushTag() {
-            var tagName = "v" + tagnumber;
-            var cmd = "git push " + url + " " + tagName;
-            var msg = "Pushed new Tag " + tagName + " to remote";
-            return run(cmd, msg);
-        };
-
-        //Publish the latest tag to NPM.
-        function publishToNPM() {
-            var cmd = "npm publish";
-            var msg = "Published version " + tagnumber + " to npm";
-            return run(cmd, msg);
-        }
-
-        //Function to run shell commands.
-        function run(cmd, msg) {
-            var command = shell.exec(cmd, {silent: true});
-          console.log(command.code)
-            if (!command.code) {
-                grunt.log.ok(msg);
-            } else {
-                grunt.fatal('Execution failed for command=' + cmd + ', Message=' + command.stderr);                
-            }
-        };
-
-        //Excecuting all functions
-        (function() {
-            updateVersion();
-            commit();
-            tag();
-            pushMaster();
-            pushTag();
-            publishToNPM();
-        })();
-    });
+/*************************************************************************
+ *
+ * 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 Publish Task
+ * This task publishes/release new version of SDK to npm and bower.
+ * Releasing new version invloves following tasks:  
+ * 1. Update package.json and bower.json with new tag/release number.
+ * 2. Commit above changes (master branch). 
+ * 3. Create a new GIT release tag.
+ * 4. Push the new tag and master branch to origin.
+ * 5. Publish to NPM.
+ ************************************************************/
+
+var shell = require('shelljs');
+var semver = require('semver');
+
+module.exports = function(grunt) {
+
+    /* Grunt Task to publish/release new version of SDK to npm and bower.
+     * Params:
+     *    tagnumber : new tag/release number
+     */
+    grunt.registerTask('publish', 'Task to publish/release new version of SDK to npm and bower', function(tagnumber) {
+
+        //Get the options object 
+        var options = this.options();
+
+        //Get the GIT access token from the environment variable. 
+        var token = process.env[options.github_access_token];
+
+        //Construct URL of the repository.
+        var url = "https://" + token + "@github.com/comprodls/comprodls-sdk-js.git"
+
+        //Check whether the tagnumber is semantically valid
+        if (!tagnumber || !semver.valid(tagnumber)) {
+            //If tagnumber is not valid, throw error
+            grunt.fatal("Please enter a valid semver tagnumber");
+        }
+
+        var checkTags = shell.exec('git ls-remote --tags', {silent: true}).stdout;
+        if(checkTags.indexOf('tags/v' + tagnumber) != -1) {
+            //If tagnumber is already present, throw error
+            grunt.fatal( tagnumber + " is already present");
+        }
+            
+
+        //Function to update the version in package.json and bower.json
+        function updateVersion() {
+            //Read package.json and bower.json file
+            var pkg = grunt.file.readJSON('package.json');
+            var bower = grunt.file.readJSON('bower.json');
+
+            //Update version to specified tagnumber
+            pkg.version = tagnumber;
+            bower.version = tagnumber;
+
+            //Save package.json file
+            grunt.file.write('package.json', JSON.stringify(pkg, null, "  "));
+            grunt.log.ok('Updated version of package.json to ' + tagnumber);
+
+            //Save bower.json file
+            grunt.file.write('bower.json', JSON.stringify(bower, null, "  "));
+            grunt.log.ok('Updated version of bower.json to ' + tagnumber);            
+        };
+
+        //Function to stage the changes.
+        function add() {
+            var cmd = 'git add --all';
+            return run(cmd, 'Staged all files');
+        };
+
+        //Function to commit the changes.
+        function commit() {
+            add();
+            var commitMessage = "Release " + tagnumber + " , Creating JS Bundle files and updating SDK version.";
+            var options = '-m "' + commitMessage + '"';
+            var cmd = 'git commit ' + options;
+            return run(cmd, 'Committed all files');
+        };
+
+        //Function to create a new tag with the updates
+        function tag() {
+            var tagName = "v" + tagnumber;
+            var tagMessage = tagnumber;
+            var cmd = 'git tag ' + tagName + ' -m "' + tagMessage + '"';
+            return run(cmd, 'Created new tag v' + tagnumber);
+        };
+
+        //Function to push the changes in master branch to remote
+        function pushMaster() {
+            var cmd = "git push " + url + " master";
+            return run(cmd, 'Pushed branch master to remote');
+        };
+
+        //Function to push the latest tag to remote
+        function pushTag() {
+            var tagName = "v" + tagnumber;
+            var cmd = "git push " + url + " " + tagName;
+            var msg = "Pushed new Tag " + tagName + " to remote";
+            return run(cmd, msg);
+        };
+
+        //Publish the latest tag to NPM.
+        function publishToNPM() {
+            var cmd = "npm publish";
+            var msg = "Published version " + tagnumber + " to npm";
+            return run(cmd, msg);
+        }
+
+        //Function to run shell commands.
+        function run(cmd, msg) {
+            var command = shell.exec(cmd, {silent: true});
+          console.log(command.code)
+            if (!command.code) {
+                grunt.log.ok(msg);
+            } else {
+                grunt.fatal('Execution failed for command=' + cmd + ', Message=' + command.stderr);                
+            }
+        };
+
+        //Excecuting all functions
+        (function() {
+            updateVersion();
+            commit();
+            tag();
+            pushMaster();
+            pushTag();
+            publishToNPM();
+        })();
+    });
 };

package/lib/comprodls.js

@@ -1,146 +1,146 @@
-/*************************************************************************
- *
- * 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 Main Module
- * This module provides definition of SDK for Javascript
- ************************************************************/
-var token_manager = require('./token');
-var helpers = require('./helpers');
-var auth = require('./services/auth');
-var activity = require('./services/activity');
-var analytics = require('./services/analytics');
-var collab = require('./services/collab');
-var product = require('./services/product');
-var xapi = require('./services/xapi');
-var attempts = require('./services/attempts');
-var push = require('./services/push');
-var pushX = require('./services/pushX');
-var pub = require('./services/pub');
-var sisevents = require('./services/sisevents');
-var lrs = require('./services/lrs');
-var spaces = require('./services/spaces');
-var config = require('./config');
-var open_access = require('./open_access');
-var superuser = require('./services/superuser');
-var invitations = require('./services/invitations');
-var workflows = require('./services/workflows');
-var integrations = require('./services/integrations');
-var validations = require('./token/validations');
-var drive = require('./services/drive');
-
-
-/*********************************
- * Setting Up Module Entry Point  
- **********************************/
-exports.init = init;
-
-//Factory function to create and return a new SDK object/instance
-function init(environment, realm, options) {
-    return new comproDLS(environment, realm, options);
-};
-
-// Constructor for the SDK object
-function comproDLS(environment, realm, options) {
-    options = options || {};
-    environment = environment || 'production';
-    realm = realm || 'global';
-    /* 
-     * Instance level parameters, used across all API calls. These are set to null.
-     * Either authWithToken or authWithCredentials must be called to set these
-     * with valid values. 
-     */
-
-    /* API Token is a JSON Object with following structure
-     *  {
-	 *     "access_token" : [String]
-     *  }
-     */
-    this.token = null;
-
-    //Organization Id  
-    this.orgId = null;
-    this.traceid = options.traceid;
-
-    try {
-      config.DEFAULT_HOSTS = config.REALM_HOSTS[realm.toUpperCase()][environment.toUpperCase()];
-      if(!config.DEFAULT_HOSTS){ throw 'Invalid Environment'; }
-    }
-    catch (e){
-      var realmObj = config.REALM_HOSTS[realm.toUpperCase()];
-      var err;
-
-      if(!realmObj) { err = new Error('Invalid Realm: ' + realm); }
-      else if(!realmObj[environment.toUpperCase()]) {
-        err = new Error('Invalid Environment: ' + environment);
-      }
-      throw err;
-    }
-
-    this.config = config;
-    this.environment = environment;
-
-    if(options.orgid && options.token) {
-      var err = validations.authWithToken(options.orgid, options.token, {});
-      if (err) { throw err; }
-      else {
-        this.token = options.token;
-        this.orgId = options.orgid;
-      }
-    }
-  // This is the case when api requires orgid but not token
-    else if(options.orgid) {
-      this.orgId = options.orgid;
-    }
-}
-
-/****************************************
- * Setting Up SDK Public Functions/Objects  
- *****************************************/
-//Token Management
-comproDLS.prototype.authWithCredentials = token_manager.authWithCredentials;
-comproDLS.prototype.authWithToken = token_manager.authWithToken;
-comproDLS.prototype.authWithExtUser = token_manager.authWithExtUser;
-
-//Open Access SDK Functions
-comproDLS.prototype.getClassEnrolmentsStat = open_access.getClassEnrolmentsStat;
-comproDLS.prototype.getSingleInvitation = open_access.getSingleInvitation;
-
-//Generic API Caller / Adaptor
-comproDLS.prototype.request = helpers.api.genericAPICaller;
-
-//Custom Service Adaptors
-comproDLS.prototype.Auth = auth;
-comproDLS.prototype.Activity = activity;
-comproDLS.prototype.Analytics = analytics;
-comproDLS.prototype.Collab = collab;
-comproDLS.prototype.Product = product;
-comproDLS.prototype.Xapi = xapi;
-comproDLS.prototype.Attempts = attempts;
-comproDLS.prototype.Push = push;
-comproDLS.prototype.Pub = pub;
-comproDLS.prototype.SISEvents = sisevents;
-comproDLS.prototype.LRS = lrs;
-comproDLS.prototype.PushX = pushX;
-comproDLS.prototype.Spaces = spaces;
-comproDLS.prototype.Superuser = superuser;
-comproDLS.prototype.Invitations = invitations;
-comproDLS.prototype.Workflows = workflows;
-comproDLS.prototype.Integrations = integrations;
-comproDLS.prototype.Drive = drive;
+/*************************************************************************
+ *
+ * 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 Main Module
+ * This module provides definition of SDK for Javascript
+ ************************************************************/
+var token_manager = require('./token');
+var helpers = require('./helpers');
+var auth = require('./services/auth');
+var activity = require('./services/activity');
+var analytics = require('./services/analytics');
+var collab = require('./services/collab');
+var product = require('./services/product');
+var xapi = require('./services/xapi');
+var attempts = require('./services/attempts');
+var push = require('./services/push');
+var pushX = require('./services/pushX');
+var pub = require('./services/pub');
+var sisevents = require('./services/sisevents');
+var lrs = require('./services/lrs');
+var spaces = require('./services/spaces');
+var config = require('./config');
+var open_access = require('./open_access');
+var superuser = require('./services/superuser');
+var invitations = require('./services/invitations');
+var workflows = require('./services/workflows');
+var integrations = require('./services/integrations');
+var validations = require('./token/validations');
+var drive = require('./services/drive');
+
+
+/*********************************
+ * Setting Up Module Entry Point  
+ **********************************/
+exports.init = init;
+
+//Factory function to create and return a new SDK object/instance
+function init(environment, realm, options) {
+    return new comproDLS(environment, realm, options);
+};
+
+// Constructor for the SDK object
+function comproDLS(environment, realm, options) {
+    options = options || {};
+    environment = environment || 'production';
+    realm = realm || 'global';
+    /* 
+     * Instance level parameters, used across all API calls. These are set to null.
+     * Either authWithToken or authWithCredentials must be called to set these
+     * with valid values. 
+     */
+
+    /* API Token is a JSON Object with following structure
+     *  {
+	 *     "access_token" : [String]
+     *  }
+     */
+    this.token = null;
+
+    //Organization Id  
+    this.orgId = null;
+    this.traceid = options.traceid;
+
+    try {
+      config.DEFAULT_HOSTS = config.REALM_HOSTS[realm.toUpperCase()][environment.toUpperCase()];
+      if(!config.DEFAULT_HOSTS){ throw 'Invalid Environment'; }
+    }
+    catch (e){
+      var realmObj = config.REALM_HOSTS[realm.toUpperCase()];
+      var err;
+
+      if(!realmObj) { err = new Error('Invalid Realm: ' + realm); }
+      else if(!realmObj[environment.toUpperCase()]) {
+        err = new Error('Invalid Environment: ' + environment);
+      }
+      throw err;
+    }
+
+    this.config = config;
+    this.environment = environment;
+
+    if(options.orgid && options.token) {
+      var err = validations.authWithToken(options.orgid, options.token, {});
+      if (err) { throw err; }
+      else {
+        this.token = options.token;
+        this.orgId = options.orgid;
+      }
+    }
+  // This is the case when api requires orgid but not token
+    else if(options.orgid) {
+      this.orgId = options.orgid;
+    }
+}
+
+/****************************************
+ * Setting Up SDK Public Functions/Objects  
+ *****************************************/
+//Token Management
+comproDLS.prototype.authWithCredentials = token_manager.authWithCredentials;
+comproDLS.prototype.authWithToken = token_manager.authWithToken;
+comproDLS.prototype.authWithExtUser = token_manager.authWithExtUser;
+
+//Open Access SDK Functions
+comproDLS.prototype.getClassEnrolmentsStat = open_access.getClassEnrolmentsStat;
+comproDLS.prototype.getSingleInvitation = open_access.getSingleInvitation;
+
+//Generic API Caller / Adaptor
+comproDLS.prototype.request = helpers.api.genericAPICaller;
+
+//Custom Service Adaptors
+comproDLS.prototype.Auth = auth;
+comproDLS.prototype.Activity = activity;
+comproDLS.prototype.Analytics = analytics;
+comproDLS.prototype.Collab = collab;
+comproDLS.prototype.Product = product;
+comproDLS.prototype.Xapi = xapi;
+comproDLS.prototype.Attempts = attempts;
+comproDLS.prototype.Push = push;
+comproDLS.prototype.Pub = pub;
+comproDLS.prototype.SISEvents = sisevents;
+comproDLS.prototype.LRS = lrs;
+comproDLS.prototype.PushX = pushX;
+comproDLS.prototype.Spaces = spaces;
+comproDLS.prototype.Superuser = superuser;
+comproDLS.prototype.Invitations = invitations;
+comproDLS.prototype.Workflows = workflows;
+comproDLS.prototype.Integrations = integrations;
+comproDLS.prototype.Drive = drive;