npm - @itentialopensource/adapter-aruba_central - Versions diffs - 0.1.1 → 0.1.2 - Mend

@itentialopensource/adapter-aruba_central 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/adapter_modifications/updateFiles/components/adapter.js DELETED Viewed

@@ -1,164 +0,0 @@
-  /**
-   * @function apiInstallManagerExternalApiInviteInstaller
-   * @pronghornType method
-   * @name apiInstallManagerExternalApiInviteInstaller
-   * @summary Invite a new installer
-   *
-   * @param {object} body - Installer Object to be invited
-   * @param {getCallback} callback - a callback function to return the result
-   * @return {object} results - An object containing the response of the action
-   *
-   * @route {POST} /apiInstallManagerExternalApiInviteInstaller
-   * @roles admin
-   * @task true
-   */
-  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  apiInstallManagerExternalApiInviteInstaller(body, callback) {
-    const meth = 'adapter-apiInstallManagerExternalApiInviteInstaller';
-    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('Installers', 'apiInstallManagerExternalApiInviteInstaller', 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', ['apiInstallManagerExternalApiInviteInstaller'], 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 apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites
-   * @pronghornType method
-   * @name apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites
-   * @summary For a given set of site names, assign Group Names for each device type
-   *
-   * @param {object} body - The Device Types to Groups mapping for a set of Sites
-   * @param {getCallback} callback - a callback function to return the result
-   * @return {object} results - An object containing the response of the action
-   *
-   * @route {POST} /apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites
-   * @roles admin
-   * @task true
-   */
-  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites(body, callback) {
-    const meth = 'adapter-apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites';
-    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('Sites', 'apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites', 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', ['apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites'], 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);
-    }
-  }

package/adapter_modifications/updateFiles/components/entities/Installers/action.json DELETED Viewed

@@ -1,22 +0,0 @@
-[
-  {
-    "name": "apiInstallManagerExternalApiInviteInstaller",
-    "protocol": "REST",
-    "method": "POST",
-    "entitypath": "{base_path}/{version}/v1/invite_installer?{query}",
-    "requestSchema": "schema.json",
-    "responseSchema": "schema.json",
-    "timeout": 0,
-    "sendEmpty": false,
-    "requestDatatype": "JSON",
-    "responseDatatype": "JSON",
-    "headers": {},
-    "responseObjects": [
-      {
-        "type": "default",
-        "key": "",
-        "mockFile": ""
-      }
-    ]
-  }
-]

package/adapter_modifications/updateFiles/components/entities/Installers/mockdatafiles/mockdata.json DELETED Viewed

	@@ -1 +0,0 @@
1	- []

package/adapter_modifications/updateFiles/components/entities/Installers/schema.json DELETED Viewed

@@ -1,20 +0,0 @@
-{
-  "$id": "schema.json",
-  "type": "object",
-  "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
-  "dynamicfields": true,
-  "properties": {
-    "ph_request_type": {
-      "type": "string",
-      "description": "type of request (internal to adapter)",
-      "default": "apiInstallManagerExternalApiInviteInstaller",
-      "enum": [
-        "apiInstallManagerExternalApiInviteInstaller",
-        "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites"
-      ],
-      "external_name": "ph_request_type"
-    }
-  },
-  "definitions": {}
-}

package/adapter_modifications/updateFiles/components/entities/Sites/action.json DELETED Viewed

@@ -1,22 +0,0 @@
-[
-  {
-    "name": "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites",
-    "protocol": "REST",
-    "method": "POST",
-    "entitypath": "{base_path}/{version}/v1/assign_group_to_device_types_in_sites?{query}",
-    "requestSchema": "schema.json",
-    "responseSchema": "schema.json",
-    "timeout": 0,
-    "sendEmpty": false,
-    "requestDatatype": "JSON",
-    "responseDatatype": "JSON",
-    "headers": {},
-    "responseObjects": [
-      {
-        "type": "default",
-        "key": "",
-        "mockFile": ""
-      }
-    ]
-  }
-]

package/adapter_modifications/updateFiles/components/entities/Sites/mockdatafiles/mockdata.json DELETED Viewed

	@@ -1 +0,0 @@
1	- []

package/adapter_modifications/updateFiles/components/entities/Sites/schema.json DELETED Viewed

@@ -1,20 +0,0 @@
-{
-  "$id": "schema.json",
-  "type": "object",
-  "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
-  "dynamicfields": true,
-  "properties": {
-    "ph_request_type": {
-      "type": "string",
-      "description": "type of request (internal to adapter)",
-      "default": "apiInstallManagerExternalApiInviteInstaller",
-      "enum": [
-        "apiInstallManagerExternalApiInviteInstaller",
-        "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites"
-      ],
-      "external_name": "ph_request_type"
-    }
-  },
-  "definitions": {}
-}

package/adapter_modifications/updateFiles/components/methods.json DELETED Viewed

@@ -1,204 +0,0 @@
-{
-  "toDelByName": [],
-  "toAppByName": [
-    {
-      "name": "Installers",
-      "func": {
-        "truePath": "/v1/invite_installer",
-        "entityPath": "/v1/invite_installer",
-        "fnName": "apiInstallManagerExternalApiInviteInstaller",
-        "entityName": "Installers",
-        "basePath": "/install_manager/external",
-        "api_type": "POST",
-        "summary": "Invite a new installer",
-        "consumes": "JSON",
-        "produces": "JSON",
-        "description": "Invite a new installer using First Name, Last Name, Country Code, Mobile Number",
-        "mode": "append",
-        "parameters": [
-          {
-            "name": "body",
-            "required": true,
-            "in": "body",
-            "description": "Installer Object to be invited",
-            "trueName": "body",
-            "type": "object",
-            "schema": {
-              "type": "object",
-              "properties": {
-                "first_name": {
-                  "type": "string",
-                  "description": "First Name of Installer",
-                  "example": "John"
-                },
-                "last_name": {
-                  "type": "string",
-                  "description": "Last Name of Installer",
-                  "example": "Smith"
-                },
-                "country_code": {
-                  "type": "string",
-                  "description": "Country code of Installer mobile number",
-                  "example": "+1"
-                },
-                "mobile_number": {
-                  "type": "string",
-                  "description": "Installer mobile number without spaces or special characters",
-                  "example": "9600024979"
-                },
-                "expire_at": {
-                  "type": "number",
-                  "description": "Date upto which the installer should be given access. Value is in epoch seconds",
-                  "example": 1619784760
-                },
-                "allow_config": {
-                  "type": "boolean",
-                  "description": "Allow the installer to add a device name during installation",
-                  "example": true
-                },
-                "sites": {
-                  "type": "array",
-                  "description": "The list of sites assigned to the installer",
-                  "items": {
-                    "type": "object",
-                    "properties": {
-                      "site_name": {
-                        "type": "string",
-                        "description": "Name of the site that installer has to setup",
-                        "example": "Market Street"
-                      }
-                    }
-                  }
-                }
-              },
-              "definitions": {}
-            },
-            "hint": "{\\\"first_name\\\": \\\"string\\\", \\\"last_name\\\": \\\"string\\\", \\\"country_code\\\": \\\"string\\\", \\\"mobile_number\\\": \\\"string\\\", \\\"expire_at\\\": 123, \\\"allow_config\\\": \\\"boolean\\\", \\\"sites\\\": [{\\\"site_name\\\": \\\"string\\\"}]}",
-            "defaultVal": "",
-            "mockRequest": {
-              "first_name": "John",
-              "last_name": "Smith",
-              "country_code": "+1",
-              "mobile_number": "9600024979",
-              "expire_at": 1619784760,
-              "allow_config": true,
-              "sites": [
-                {
-                  "site_name": "Market Street"
-                }
-              ]
-            }
-          }
-        ],
-        "headerParameters": [],
-        "fnMetaData": {
-          "url": "/v1/invite_installer",
-          "query": [],
-          "body": [
-            {
-              "name": "body",
-              "type": "object"
-            }
-          ],
-          "path": []
-        },
-        "response": []
-      },
-      "fnName": "apiInstallManagerExternalApiInviteInstaller"
-    },
-    {
-      "name": "Sites",
-      "func": {
-        "truePath": "/v1/assign_group_to_device_types_in_sites",
-        "entityPath": "/v1/assign_group_to_device_types_in_sites",
-        "fnName": "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites",
-        "entityName": "Sites",
-        "basePath": "/install_manager/external",
-        "api_type": "POST",
-        "summary": "For a given set of site names, assign Group Names for each device type",
-        "consumes": "JSON",
-        "produces": "JSON",
-        "description": "Site Name, Device Type, Group Name mapping",
-        "mode": "append",
-        "parameters": [
-          {
-            "name": "body",
-            "required": true,
-            "in": "body",
-            "description": "The Device Types to Groups mapping for a set of Sites",
-            "trueName": "body",
-            "type": "object",
-            "schema": {
-              "type": "object",
-              "properties": {
-                "groups_association": {
-                  "type": "array",
-                  "items": {
-                    "type": "object",
-                    "properties": {
-                      "device_type": {
-                        "type": "string",
-                        "enum": [
-                          "IAP",
-                          "SWITCH",
-                          "GATEWAY"
-                        ]
-                      },
-                      "group_name": {
-                        "type": "string",
-                        "description": "Name of the Group that has to be assigned to this device-type"
-                      }
-                    }
-                  }
-                },
-                "sites_association": {
-                  "type": "array",
-                  "items": {
-                    "type": "object",
-                    "properties": {
-                      "site_name": {
-                        "type": "string",
-                        "description": "Name of the site that installer has to setup",
-                        "example": "Big Street"
-                      }
-                    }
-                  }
-                }
-              },
-              "definitions": {}
-            },
-            "hint": "{\\\"groups_association\\\": [{\\\"device_type\\\": \\\"Must be one of [IAP, SWITCH, GATEWAY]\\\", \\\"group_name\\\": \\\"string\\\"}], \\\"sites_association\\\": [{\\\"site_name\\\": \\\"string\\\"}]}",
-            "defaultVal": "",
-            "mockRequest": {
-              "groups_association": [
-                {
-                  "device_type": "GATEWAY",
-                  "group_name": "string"
-                }
-              ],
-              "sites_association": [
-                {
-                  "site_name": "Big Street"
-                }
-              ]
-            }
-          }
-        ],
-        "headerParameters": [],
-        "fnMetaData": {
-          "url": "/v1/assign_group_to_device_types_in_sites",
-          "query": [],
-          "body": [
-            {
-              "name": "body",
-              "type": "object"
-            }
-          ],
-          "path": []
-        },
-        "response": []
-      },
-      "fnName": "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites"
-    }
-  ]
-}

package/adapter_modifications/updateFiles/components/pronghorn.json DELETED Viewed

@@ -1,77 +0,0 @@
-[    {
-      "name": "apiInstallManagerExternalApiInviteInstaller",
-      "summary": "Invite a new installer",
-      "description": "Invite a new installer using First Name, Last Name, Country Code, Mobile Number",
-      "input": [
-        {
-          "name": "body",
-          "type": "object",
-          "info": "Installer Object to be invited: {\"first_name\": \"string\", \"last_name\": \"string\", \"country_code\": \"string\", \"mobile_number\": \"string\", \"expire_at\": 123, \"allow_config\": \"boolean\", \"sites\": [{\"site_name\": \"string\"}]}",
-          "required": true,
-          "schema":
-              {"type":"object","properties":{"first_name":{"type":"string","description":"First Name of Installer","example":"John"},"last_name":{"type":"string","description":"Last Name of Installer","example":"Smith"},"country_code":{"type":"string","description":"Country code of Installer mobile number","example":"+1"},"mobile_number":{"type":"string","description":"Installer mobile number without spaces or special characters","example":"9600024979"},"expire_at":{"type":"number","description":"Date upto which the installer should be given access. Value is in epoch seconds","example":1619784760},"allow_config":{"type":"boolean","description":"Allow the installer to add a device name during installation","example":true},"sites":{"type":"array","description":"The list of sites assigned to the installer","items":{"type":"object","properties":{"site_name":{"type":"string","description":"Name of the site that installer has to setup","example":"Market Street"}}}}},"definitions":{}}
-        }
-      ],
-      "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": "/apiInstallManagerExternalApiInviteInstaller"
-      },
-      "task": true
-    },
-    {
-      "name": "apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites",
-      "summary": "For a given set of site names, assign Group Names for each device type",
-      "description": "Site Name, Device Type, Group Name mapping",
-      "input": [
-        {
-          "name": "body",
-          "type": "object",
-          "info": "The Device Types to Groups mapping for a set of Sites: {\"groups_association\": [{\"device_type\": \"Must be one of [IAP, SWITCH, GATEWAY]\", \"group_name\": \"string\"}], \"sites_association\": [{\"site_name\": \"string\"}]}",
-          "required": true,
-          "schema":
-              {"type":"object","properties":{"groups_association":{"type":"array","items":{"type":"object","properties":{"device_type":{"type":"string","enum":["IAP","SWITCH","GATEWAY"]},"group_name":{"type":"string","description":"Name of the Group that has to be assigned to this device-type"}}}},"sites_association":{"type":"array","items":{"type":"object","properties":{"site_name":{"type":"string","description":"Name of the site that installer has to setup","example":"Big Street"}}}}},"definitions":{}}
-        }
-      ],
-      "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": "/apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites"
-      },
-      "task": true
-    }
-]

package/adapter_modifications/updateFiles/components/test/integration/adapterTestIntegration.js DELETED Viewed

@@ -1,76 +0,0 @@
-    const installersApiInstallManagerExternalApiInviteInstallerBodyParam = {
-      first_name: 'John',
-      last_name: 'Smith',
-      country_code: '+1',
-      mobile_number: '9600024979',
-      expire_at: 1619784760,
-      allow_config: true,
-      sites: [
-        {
-          site_name: 'Market Street'
-        }
-      ]
-    };
-    describe('#apiInstallManagerExternalApiInviteInstaller - errors', () => {
-      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        try {
-          a.apiInstallManagerExternalApiInviteInstaller(installersApiInstallManagerExternalApiInviteInstallerBodyParam, (data, error) => {
-            try {
-              if (stub) {
-                const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-append-connectorRest-handleEndResponse', displayE);
-              } else {
-                runCommonAsserts(data, error);
-              }
-              saveMockData('Installers', 'apiInstallManagerExternalApiInviteInstaller', 'default', data);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-    });
-    const sitesApiInstallManagerExternalApiAssignGroupToDeviceTypesInSitesBodyParam = {
-      groups_association: [
-        {
-          device_type: 'GATEWAY',
-          group_name: 'string'
-        }
-      ],
-      sites_association: [
-        {
-          site_name: 'Big Street'
-        }
-      ]
-    };
-    describe('#apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites - errors', () => {
-      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        try {
-          a.apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites(sitesApiInstallManagerExternalApiAssignGroupToDeviceTypesInSitesBodyParam, (data, error) => {
-            try {
-              if (stub) {
-                const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-append-connectorRest-handleEndResponse', displayE);
-              } else {
-                runCommonAsserts(data, error);
-              }
-              saveMockData('Sites', 'apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites', 'default', data);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-    });