@itentialopensource/adapter-zscaler 0.10.7 → 0.10.9

package/CALLS.md

@@ -395,8 +395,8 @@ Specific adapter calls are built based on the API of the Adapter for Zscaler. Th
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getUrlCategories(customOnly, callback)</td>
-    <td style="padding:15px">Gets information about all or custom URL categories</td>
+    <td style="padding:15px">getUrlCategoriesWithOptions(queryData, callback)</td>
+    <td style="padding:15px">Gets information about all or custom URL categories with query data</td>
     <td style="padding:15px">{base_path}/{version}/urlCategories?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
@@ -1660,5 +1660,17 @@ Specific adapter calls are built based on the API of the Adapter for Zscaler. Th
     <td style="padding:15px">{base_path}/{version}/locations/groups?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">postUrlCategoriesReviewDomain(body, callback)</td>
+    <td style="padding:15px">URL Categories - Review Domain</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/review/domains?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putUrlCategoriesReviewDomainAddURLs(body, callback)</td>
+    <td style="padding:15px">URL Categories - Review Domain - Add URLs</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/review/domains?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.10.9 [10-15-2024]
+
+* Changes made at 2024.10.14_21:32PM
+
+See merge request itentialopensource/adapters/adapter-zscaler!38
+
+---
+
+## 0.10.8 [09-25-2024]
+
+* Add missing calls and add a task to take in query data
+
+See merge request itentialopensource/adapters/adapter-zscaler!35
+
+---
+
 ## 0.10.7 [09-20-2024]
 
 * add workshop and fix vulnerabilities

package/adapter.js

@@ -2716,7 +2716,20 @@ class Zscaler extends AdapterBaseCl {
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
   getUrlCategories(customOnly, callback) {
-    const meth = 'adapter-getUrlCategories';
+    const queryData = { customOnly };
+    this.getUrlCategoriesWithOptions(queryData, callback);
+  }
+
+  /**
+   * @summary Gets information about all or custom URL categories
+   *
+   * @function getUrlCategoriesWithOptions
+   * @param {object} queryData - object of query data - includeOnlyUrlKeywordCounts, customOnly
+   * @param {getCallback} callback - a callback function to return the result
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getUrlCategoriesWithOptions(queryData, callback) {
+    const meth = 'adapter-getUrlCategoriesWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -2729,7 +2742,10 @@ class Zscaler extends AdapterBaseCl {
     /* HERE IS WHERE YOU VALIDATE DATA */
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { customOnly };
+    let queryParamsAvailable = {};
+    if (queryData) {
+      queryParamsAvailable = queryData;
+    }
     const queryParams = {};
     const pathVars = [];
     const bodyVars = {};
@@ -19478,6 +19494,170 @@ class Zscaler extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @function postUrlCategoriesReviewDomain
+   * @pronghornType method
+   * @name postUrlCategoriesReviewDomain
+   * @summary URL Categories - Review Domain
+   *
+   * @param {array} body - body param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /postUrlCategoriesReviewDomain
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  postUrlCategoriesReviewDomain(body, callback) {
+    const meth = 'adapter-postUrlCategoriesReviewDomain';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('URLCategories', 'postUrlCategoriesReviewDomain', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['postUrlCategoriesReviewDomain'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function putUrlCategoriesReviewDomainAddURLs
+   * @pronghornType method
+   * @name putUrlCategoriesReviewDomainAddURLs
+   * @summary URL Categories - Review Domain - Add URLs
+   *
+   * @param {array} body - body param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /putUrlCategoriesReviewDomainAddURLs
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  putUrlCategoriesReviewDomainAddURLs(body, callback) {
+    const meth = 'adapter-putUrlCategoriesReviewDomainAddURLs';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('URLCategories', 'putUrlCategoriesReviewDomainAddURLs', reqObj, false, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['putUrlCategoriesReviewDomainAddURLs'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
 }
 
 module.exports = Zscaler;

package/entities/URLCategories/action.json

@@ -167,6 +167,46 @@
           "mockFile": "mockdatafiles/postUrlLookup-default.json"
         }
       ]
+    },
+    {
+      "name": "postUrlCategoriesReviewDomain",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/urlCategories/review/domains?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "putUrlCategoriesReviewDomainAddURLs",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/urlCategories/review/domains?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/URLCategories/schema.json

@@ -17,7 +17,9 @@
         "getUrlCategoriescategoryId",
         "putUrlCategoriescategoryId",
         "deleteUrlCategoriescategoryId",
-        "postUrlLookup"
+        "postUrlLookup",
+        "postUrlCategoriesReviewDomain",
+        "putUrlCategoriesReviewDomainAddURLs"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-zscaler",
-  "version": "0.10.7",
+  "version": "0.10.9",
   "description": "This adapter integrates with system Zscaler",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -52,7 +52,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-zscaler#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.8.0",
+    "@itentialopensource/adapter-utils": "^5.9.4",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
     "axios": "^1.7.4",

package/pronghorn.json

@@ -2016,6 +2016,40 @@
       },
       "task": true
     },
+    {
+      "name": "getUrlCategoriesWithOptions",
+      "summary": "Gets information about all or custom URL categories with query data",
+      "description": "Gets information about all or custom URL categories with query data",
+      "input": [
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "Query data: includeOnlyUrlKeywordCounts, customOnly",
+          "required": false,
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getUrlCategoriesWithOptions"
+      },
+      "task": true
+    },
     {
       "name": "postUrlCategories",
       "summary": "Adds a new custom URL category",
@@ -20232,6 +20266,74 @@
         "path": "/getLocationGroups"
       },
       "task": true
+    },
+    {
+      "name": "postUrlCategoriesReviewDomain",
+      "summary": "URL Categories - Review Domain",
+      "description": "URL Categories - Review Domain",
+      "input": [
+        {
+          "name": "body",
+          "type": "array",
+          "info": "The list of URLs that must be matched against the entries present in existing custom URL categories",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "array"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/postUrlCategoriesReviewDomain"
+      },
+      "task": true
+    },
+    {
+      "name": "putUrlCategoriesReviewDomainAddURLs",
+      "summary": "URL Categories - Review Domain - Add URLs",
+      "description": "URL Categories - Review Domain - Add URLs",
+      "input": [
+        {
+          "name": "body",
+          "type": "array",
+          "info": "Information about the URLs (of Subdomain type) and the respective custom categories to which they must be added.",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "array"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/putUrlCategoriesReviewDomainAddURLs"
+      },
+      "task": true
     }
   ]
 }

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.10.6",
-  "configLines": 22098,
+  "version": "0.10.7",
+  "configLines": 22200,
   "scriptLines": 1783,
-  "codeLines": 20937,
-  "testLines": 14642,
-  "testCases": 745,
-  "totalCodeLines": 37362,
-  "wfTasks": 268
+  "codeLines": 21117,
+  "testLines": 14797,
+  "testCases": 753,
+  "totalCodeLines": 37697,
+  "wfTasks": 271
 }

package/test/integration/adapterTestIntegration.js

@@ -1437,6 +1437,35 @@ describe('[integration] Zscaler Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getUrlCategoriesWithOptions - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getUrlCategoriesWithOptions(null, (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal('object', typeof data.response[0]);
+                assert.equal('object', typeof data.response[1]);
+                assert.equal('object', typeof data.response[2]);
+                assert.equal('object', typeof data.response[3]);
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#postUrlCategories - errors', () => {
       it('should work if integrated or standalone with mockdata', (done) => {
         try {
@@ -7061,5 +7090,61 @@ describe('[integration] Zscaler Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    const uRLCategoriespostUrlCategoriesReviewDomainBodyParam = [
+      {}
+    ];
+    describe('#postUrlCategoriesReviewDomain - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.postUrlCategoriesReviewDomain(uRLCategoriespostUrlCategoriesReviewDomainBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-zscaler-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('URLCategories', 'postUrlCategoriesReviewDomain', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const uRLCategoriesputUrlCategoriesReviewDomainAddURLsBodyParam = [
+      {}
+    ];
+    describe('#putUrlCategoriesReviewDomainAddURLs - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.putUrlCategoriesReviewDomainAddURLs(uRLCategoriesputUrlCategoriesReviewDomainAddURLsBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-zscaler-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('URLCategories', 'putUrlCategoriesReviewDomainAddURLs', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });

package/test/unit/adapterTestUnit.js

@@ -2039,6 +2039,18 @@ describe('[unit] Zscaler Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getUrlCategoriesWithOptions - errors', () => {
+      it('should have a getUrlCategoriesWithOptions function', (done) => {
+        try {
+          assert.equal(true, typeof a.getUrlCategoriesWithOptions === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#postUrlCategories - errors', () => {
       it('should have a postUrlCategories function', (done) => {
         try {
@@ -6343,5 +6355,63 @@ describe('[unit] Zscaler Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#postUrlCategoriesReviewDomain - errors', () => {
+      it('should have a postUrlCategoriesReviewDomain function', (done) => {
+        try {
+          assert.equal(true, typeof a.postUrlCategoriesReviewDomain === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing body', (done) => {
+        try {
+          a.postUrlCategoriesReviewDomain(null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-zscaler-adapter-postUrlCategoriesReviewDomain', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#putUrlCategoriesReviewDomainAddURLs - errors', () => {
+      it('should have a putUrlCategoriesReviewDomainAddURLs function', (done) => {
+        try {
+          assert.equal(true, typeof a.putUrlCategoriesReviewDomainAddURLs === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing body', (done) => {
+        try {
+          a.putUrlCategoriesReviewDomainAddURLs(null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-zscaler-adapter-putUrlCategoriesReviewDomainAddURLs', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });