comprodls-sdk 2.64.1 → 2.67.0

package/lib/config/index.js

@@ -243,7 +243,11 @@ exports.AUTHEXTN_API_URLS = {
     userAssignedPaths: '/org/{orgid}/classes/{classid}/assigned-paths/{assignedpathid}/enroll-user/multi',
 
     // Class related APIs
-    particularClass: '/org/{orgId}/classes/{classId}'
+    particularClass: '/org/{orgId}/classes/{classId}',
+
+    // Org Entitlement related APIs
+    orgProductEntitlement: '/org/{orgid}/org-entitlements',
+    setupUser: '/accounts/{accountId}/user/setup'
 
 };
 

package/lib/services/authextn/index.js

@@ -41,8 +41,10 @@ var keepaliveAgent = new Agent({
 });
 
 //AuthExtn Adaptor Contsructor
-function authextn() {
+function authextn(accountId) {
+  this.accountId = accountId;
   return {
+    // Gradeformat related APIs
     createGradeformat: createGradeformat.bind(this),
     updateGradeformat: updateGradeformat.bind(this),
     deleteGradeformat: deleteGradeformat.bind(this),
@@ -54,9 +56,21 @@ function authextn() {
     getParticularGradeformatOfAClass: getParticularGradeformatOfAClass.bind(this),
     getAllGradeformatsOfAClass: getAllGradeformatsOfAClass.bind(this),
     getClassesOfAGradeformat: getClassesOfAGradeformat.bind(this),
+
+    // Assigned-path related APIs
     createUserAssignedPathEnrollments: createUserAssignedPathEnrollments.bind(this),
     deleteUserAssignedPathEnrollments: deleteUserAssignedPathEnrollments.bind(this),
-    getParticularClassV2: getParticularClassV2.bind(this)
+
+    // Class related APIs
+    getParticularClassV2: getParticularClassV2.bind(this),
+
+    // Org Entitlement related APIs
+    createOrgProductEntitlement: createOrgProductEntitlement.bind(this),
+    updateOrgProductEntitlement: updateOrgProductEntitlement.bind(this),
+    getParticularOrgProductEntitlement: getParticularOrgProductEntitlement.bind(this),
+    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this),
+    setupUser: setupUser.bind(this)
+
   };
 }
 
@@ -883,3 +897,244 @@ function getParticularClassV2(options) {
 
   return deferred.promise;
 }
+
+/**
+ * @param {
+ *  *productcode: "string",
+ *  status: "string"             // ['active', 'revoked'] - default: 'active'
+ *  expired: <boolean>,          // default: false
+ *  startdate: <epoch>,
+ *  enddate: <epoch>,
+ *  audit: <boolean>             // [true] - default: true
+ *  ext_data: {...},
+ * } options
+ */
+function createOrgProductEntitlement(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  if (options && options.productcode) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+      self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+    url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+    var requestAPI = request.post(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory param: productcode not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}
+
+/**
+ * @param {
+ *  *productcode: "string",
+ *  status: "string"             // ['active', 'revoked']
+ *  expired: <boolean>,
+ *  startdate: <epoch>,
+ *  enddate: <epoch>,
+ *  audit: <boolean>             // [true] - default: true
+ *  ext_data: {...},
+ * } options
+ */
+function updateOrgProductEntitlement(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  if (options && options.productcode) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+      self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+    url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+    var requestAPI = request.put(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory param: productcode not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}
+
+/**
+ * @param {
+ *  *productcode: "string"
+ * } options
+ */
+function getParticularOrgProductEntitlement(options) {
+  var self = this;
+  //Initializing promise
+  var deferred = q.defer();
+
+  //Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+    deferred.reject(error);
+  } else {
+    if (options && options.productcode) {
+      // Passed all validations, Contruct the API URL
+      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+        self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+      url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+      // Setup request with URL and Query Params
+      var params = { productcode: options.productcode };
+      var requestAPI = request.get(url).query(params);
+
+      // Setup 'traceid' in request header
+      if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      // Setup 'token' in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      requestAPI.agent(keepaliveAgent).end(function (error, response) {
+        if (error) {
+          error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          deferred.reject(error);
+        } else {
+          deferred.resolve(response.body);
+        }
+      });
+    } else {
+      error = {};
+      error.message = error.description = 'Mandatory field \'productcode\' not found '+
+        'in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/**
+ * @param {
+ *  status: "string"             // ['active', 'revoked']
+ *  expired: <boolean>,
+ *  cursor: <epoch>
+ * } options
+ */
+function getAllOrgProductEntitlements(options) {
+  var self = this;
+  //Initializing promise
+  var deferred = q.defer();
+
+  //Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+    deferred.reject(error);
+  } else {
+    // Passed all validations, Contruct the API URL
+    var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+      self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+    url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+    // Setup request with URL and Query Params
+    var params = { productcode: options.productcode };
+
+    if (options.status) { params.status = options.status; }
+    if (options.hasOwnProperty('expired')) { params.expired = options.expired; }
+    if (options.cursor) { params.cursor = options.cursor; }
+
+    var requestAPI = request.get(url).query(params);
+
+    // Setup 'traceid' in request header
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    // Setup 'token' in Authorization header
+    requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+    requestAPI.agent(keepaliveAgent).end(function (error, response) {
+      if (error) {
+        error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        deferred.reject(error);
+      } else {
+        deferred.resolve(response.body);
+      }
+    });
+  }
+
+  return deferred.promise;
+}
+
+/**
+ * @param {
+*  ext_user_id: "string",        // mandatory
+*  workflow_type: "string",      // mandatory 
+*  <workflow_type>: {}           // mandatory
+* } options
+*/
+function setupUser(options) {
+  var self = this;
+  //Initializing promise
+  var deferred = q.defer();
+
+  if(options && options.ext_user_id && options.workflow_type) {
+    //Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTHEXTN + self.config.AUTHEXTN_API_URLS.setupUser;
+    url = helpers.api.constructAPIUrl(url,  { accountId: self.accountId });
+
+    var requestAPI = request.post(url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .send(options);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(err, res) {
+      if(err) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+          deferred.reject(err);
+      } else {
+        deferred.resolve(res.body);
+      }
+    });
+  } else {
+    err = {};
+    err.message = err.description = 'Mandatory field \'ext_user_id\' or \'workflow_type\' not found '+
+      'in the request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    deferred.reject(err);
+  }
+return deferred.promise;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.64.1",
+  "version": "2.67.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -14,10 +14,10 @@
   "dependencies": {
     "agentkeepalive": "4.2.0",
     "extend": "3.0.2",
-    "pubnub": "7.3.0",
+    "pubnub": "7.5.0",
     "q": "~1.4.1",
     "string-template": "^1.0.0",
-    "superagent": "2.0.0",
+    "superagent": "3.8.3",
     "validate.js": "^0.9.0"
   },
   "devDependencies": {

package/test.js

@@ -0,0 +1,38 @@
+
+var orgId = 'dev1';
+
+var ComproDLS = require('../comprodls-sdk-js/lib/comprodls.js').init('DEVELOPMENT','GLOBAL');
+
+var accountId = 'compro';
+var tokenObj = {
+    // "access_token": "71a2d361-16b4-40b4-9a73-2499f808d7fe",
+    //"access_token" : "YWMtb2nasMuyEemJvL3ph9UnmAAAAW0KQNb1ziRGuAkJ_n6LweFX9KOhYaSQeKg~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e", //student //YWMtw4m3tmsMEem5x6kSLL2ajAAAAWqQ3dJz4CkidQEwcm1LDszgrThOUuDLCkA~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e
+    // "access_token" : "YWMtQAfQGHfCEemdBmGZgYqIcgAAAWrkJ96wsnysSc8M5ilW1ZI1jOeLo226vn8~~5d5cf9be-cb5d-11e6-a329-0e34ffe5d91e", //admin
+    // "expires_in": 604800,
+    // "refresh_token": "c002d2710236789e3f36d0b8670a07b684f44b4a43e9c4a322260c11390d37826a889053c876df0dc3ae49f4701cc27bdc42d77b62ec3735eaaf9ea35cc433f208aeb1d7003eddf38ec9ab418e40caa2fefb9fda6454a3b98daf9d911db4a4e8ca285a2dfbb395b7"
+};
+
+
+var self = this;
+var Adapter = ComproDLS.AuthExtn(accountId);
+
+var Options = {
+    "ext_user_id": "11jan_07",
+    "workflow_type": "org_entitlement",
+    "org_entitlement": {
+        "productcode": "evolve_l1",
+        "orgid": "dev1",
+        "dls_user_id": "71a2d361-16b4-40b4-9a73-2499f808d7fe",
+        "ext_role": "student"
+    }
+};
+
+Adapter.setupUser(Options)
+    .then(function (res) {
+        console.log("^^^^^^^^^^^^^", res);
+    })
+    .catch(function (err) {
+        console.log("ERR CATCG", err);
+})
+
+