add woqlclientTools

Author: Francesca-Bit

lib/connectionConfig.js

@@ -330,13 +330,15 @@ ConnectionConfig.prototype.userURL = function(user) {
 
 /**
  * Generate URL for the user's organization api endpoint
- * @param {string} [organization] - the organization id
+ * @param {string} orgId - the organization id
+ * @param {string} [action] - the organization id
  * @returns {string}
  */
 
-ConnectionConfig.prototype.organizationURL = function(organization) {
+ConnectionConfig.prototype.organizationURL = function(orgId, action) {
     let url = `${this.apiURL()}organization`
-    if (organization) url += `/${encodeURIComponent(organization)}`
+    if (orgId) url += `/${encodeURIComponent(orgId)}`
+    if (action) url += `/${encodeURIComponent(action)}`
     return url
 }
 
@@ -345,7 +347,7 @@ ConnectionConfig.prototype.organizationURL = function(organization) {
  * @returns {string}
  */
 ConnectionConfig.prototype.rolesURL = function() {
-    return `${this.apiURL()}role`
+    return `${this.apiURL()}roles`
 }
 
 /**

lib/dispatchRequest.js

@@ -19,12 +19,13 @@ function btoaImplementation(str) {
  * @file Dispatch Request
  * @license Apache Version 2
  * @description Functions for dispatching API requests via the axios library.
- * @param {String} url  API endpoint URL
- * @param {String} action API action
- * @param {Object} payload data to be transmitted to endpoint
- * @param {String} key optional basic auth string to be passed
+ * @param {string} url  API endpoint URL
+ * @param {string} action API action
+ * @param {object} payload data to be transmitted to endpoint
+ * @param {string} key optional basic auth string to be passed
+ * @param {string} reqUID the unique reqID
  */
-function DispatchRequest(url, action, payload, local_auth, remote_auth = null) {
+function DispatchRequest(url, action, payload, local_auth, remote_auth = null, reqUID = null) {
     /*
      *CORS is only required when trying to fetch data from a browser,
      *as browsers by default will block requests to different origins
@@ -68,6 +69,10 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null) {
         if (!options.headers) options.headers = {}
         options.headers['Authorization-Remote'] = `Basic ${rencoded}`
     }
+
+    if (reqUID) {
+        options.headers['ReqUID'] = reqUID
+    }
     switch (action) {
         case CONST.DELETE_DATABASE:
         case CONST.DELETE_CSV:
@@ -96,6 +101,7 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null) {
         case CONST.GET_CSV:
         case CONST.MESSAGE:
         case CONST.INFO:
+        case CONST.GET_ROLES:
             if (payload) {
                 const ext = UTILS.URIEncodePayload(payload)
                 if (ext) url += `?${ext}`

lib/woqlClient.js

@@ -24,7 +24,7 @@ const WOQLQuery = require('./query/woqlBuilder')
  * client.db("test")
  * client.checkout("dev")
  * const turtle = await client.getTriples("schema", "main")
- * //The client has an internal state which defines what 
+ * //The client has an internal state which defines what
  * //organization / database / repository / branch / ref it is currently attached to
  */
 
@@ -35,6 +35,10 @@ function WOQLClient(serverUrl, params) {
     this.connection = new ConnectionCapabilities()
 }
 
+WOQLClient.prototype.reqUID = function(reqUID) {
+    if (reqUID) this._reqUID = reqUID
+    else return this._reqUID
+}
 
 WOQLClient.CONST = CONST
 
@@ -870,7 +874,14 @@ WOQLClient.prototype.dispatch = function(action, apiUrl, payload) {
             ),
         )
     }
-    return DispatchRequest(apiUrl, action, payload, this.localAuth(), this.remoteAuth())
+    return DispatchRequest(
+        apiUrl,
+        action,
+        payload,
+        this.localAuth(),
+        this.remoteAuth(),
+        this.reqUID(),
+    )
 }
 
 /**
@@ -985,7 +996,6 @@ WOQLClient.prototype.getClassFrame = function(docType) {
  */
 
 WOQLClient.prototype.getDatabase = function() {
-    //console.log('___DB__URL__', this.connectionConfig.dbURL())
     return this.dispatch(CONST.READ_DATABASE, this.connectionConfig.dbURL())
 }
 
@@ -1122,13 +1132,17 @@ WOQLClient.prototype.createOrganization = function(orgId, orgDoc) {
 }
 
 /**
- *  Gets all the information about the given organization
+ * Gets all the information about the given organization
  * @param {string} orgId - the organization id
+ * @param {string} [action] - set an action like recommendations | invitations | collaborators
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  */
 
-WOQLClient.prototype.getOrganization = function(orgId) {
-    return this.dispatch(CONST.READ_ORGANIZATION, this.connectionConfig.organizationURL(orgId))
+WOQLClient.prototype.getOrganization = function(orgId, action) {
+    return this.dispatch(
+        CONST.READ_ORGANIZATION,
+        this.connectionConfig.organizationURL(orgId, action),
+    )
 }
 
 /**
@@ -1176,23 +1190,20 @@ WOQLClient.prototype.deleteOrganization = function(orgId) {
 }
 
 /**
- * @param {string} userId - the user id
+ * get all the user roles (for the current logged user)
+ * or the user roles for a specific database and user
+ * (the logged used need to have the permission to see the roles info for another user)
+ * @param {string} [userId] - the user id
  * @param {string} [orgId] - the organization id
  * @param {string} [dbId] - the dbId
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  */
 WOQLClient.prototype.getRoles = function(userId, orgId, dbId) {
-    let payload = {}
-    if (userId) {
-        payload['agent_name'] = userId
-    }
-    if (dbId) {
-        payload['database_name'] = dbId
-    }
-    if (orgId) {
-        payload['organization_name'] = orgId
+    let roleURL = this.connectionConfig.rolesURL()
+    if (userId && orgId && dbId) {
+        roleURL = `${roleURL}/${userId}/${orgId}/${dbId}`
     }
-    return this.dispatch(CONST.GET_ROLES, this.connectionConfig.rolesURL(), payload)
+    return this.dispatch(CONST.GET_ROLES, roleURL)
 }
 
 /**

lib/woqlClientTools.js

@@ -1,7 +1,7 @@
 const WOQLLibrary = require('./query/woqlLibrary')
 
 function WOQLClientTools(client) {
-    this.client = client
+    this.client = client.copy()
     this.woqlLibrary = new WOQLLibrary()
 }