@itentialopensource/adapter-opengear_lighthouse 0.1.1

package/entities/Templates/action.json

@@ -0,0 +1,106 @@
+{
+  "actions": [
+    {
+      "name": "getTemplates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/templates?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "postTemplates",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/templates?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getTemplatesId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/templates/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "putTemplatesId",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/templates/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteTemplatesId",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/templates/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Templates/schema.json

@@ -0,0 +1,23 @@
+{
+  "$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": "getTemplates",
+      "enum": [
+        "getTemplates",
+        "postTemplates",
+        "getTemplatesId",
+        "putTemplatesId",
+        "deleteTemplatesId"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Users/action.json

@@ -0,0 +1,187 @@
+{
+  "actions": [
+    {
+      "name": "getUsers",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/users?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "postUsers",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/users?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getGroupResponse",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/users/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getGroupResponse-default.json"
+        }
+      ]
+    },
+    {
+      "name": "putUsersId",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/users/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteUsersId",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/users/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getUsersPasswordPolicy",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/users/password_policy?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "putUsersPasswordPolicy",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/users/password_policy?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "putUsersPasswordReset",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/users/password_reset?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "putUsersPasswordValidation",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/users/password_validation?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Users/mockdatafiles/getGroupResponse-default.json

@@ -0,0 +1,17 @@
+{
+  "group": {
+    "smart_group_roles": "NodeUser",
+    "description": "",
+    "id": "groups-3",
+    "members": [],
+    "rights": {
+      "delete": true,
+      "modify": true
+    },
+    "smart_group": "smart_groups_nodes_groups-1",
+    "managed_device_filter": "smart_groups_ports_groups-1",
+    "mode": "smart_group",
+    "enabled": true,
+    "groupname": "my-new-group"
+  }
+}

package/entities/Users/schema.json

@@ -0,0 +1,27 @@
+{
+  "$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": "getUsers",
+      "enum": [
+        "getUsers",
+        "postUsers",
+        "getGroupResponse",
+        "putUsersId",
+        "deleteUsersId",
+        "getUsersPasswordPolicy",
+        "putUsersPasswordPolicy",
+        "putUsersPasswordReset",
+        "putUsersPasswordValidation"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/error.json

@@ -0,0 +1,190 @@
+{
+  "errors": [
+    {
+      "key": "Unable To Save To Database",
+      "icode": "AD.100",
+      "displayString": "Error on saving to Database $VARIABLE$",
+      "recommendation": "Verify the database connectivity and credentials"
+    },
+    {
+      "key": "Database Error",
+      "icode": "AD.101",
+      "displayString": "Database Error: $VARIABLE$",
+      "recommendation": "Verify the database connectivity, schema and permissions"
+    },
+    {
+      "key": "Database Credentials",
+      "icode": "AD.102",
+      "displayString": "Database Error: Invalid Credentials",
+      "recommendation": "Verify the database credentials"
+    },
+    {
+      "key": "No Queue Item",
+      "icode": "AD.110",
+      "displayString": "Queue Item $VARIABLE$ not found in queue",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Create Queue",
+      "icode": "AD.111",
+      "displayString": "Unable to create queue: $VARIABLE$",
+      "recommendation": "Verify access to the database, redis or system memory"
+    },
+    {
+      "key": "Queue Full",
+      "icode": "AD.112",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ rejected - queue full at $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Clear Queue",
+      "icode": "AD.113",
+      "displayString": "Unable to clear queue: $VARIABLE$",
+      "recommendation": "Make sure the queue exists"
+    },
+    {
+      "key": "Unable To Claim Turn",
+      "icode": "AD.114",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to claim license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Free Turn",
+      "icode": "AD.115",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to free license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Item In Wrong State",
+      "icode": "AD.116",
+      "displayString": "Queue item is in the wrong state: $VARIABLE$ ",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Missing Data",
+      "icode": "AD.300",
+      "displayString": "$VARIABLE$ is required",
+      "recommendation": "Please provide the required data"
+    },
+    {
+      "key": "Missing File",
+      "icode": "AD.301",
+      "displayString": "Can not open file $VARIABLE$",
+      "recommendation": "Verify the file exists and has proper permissions"
+    },
+    {
+      "key": "Invalid Action File",
+      "icode": "AD.302",
+      "displayString": "Invalid action file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Unsupported Protocol",
+      "icode": "AD.303",
+      "displayString": "Protocol $VARIABLE$ not currently supported",
+      "recommendation": "Verify the protocol on the action"
+    },
+    {
+      "key": "Invalid Schema File",
+      "icode": "AD.304",
+      "displayString": "Invalid schema file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Invalid Properties",
+      "icode": "AD.305",
+      "displayString": "Invalid properties: $VARIABLE$",
+      "recommendation": "Verify the properties for the adapter"
+    },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
+    {
+      "key": "Query Not Translated",
+      "icode": "AD.310",
+      "displayString": "Query Not Translated",
+      "recommendation": "Verify the information passed in the query object"
+    },
+    {
+      "key": "Payload Not Translated",
+      "icode": "AD.311",
+      "displayString": "Payload Not Translated",
+      "recommendation": "Verify the information passed in the payload object"
+    },
+    {
+      "key": "Schema Validation Failure",
+      "icode": "AD.312",
+      "displayString": "Schema validation failed on $VARIABLE$",
+      "recommendation": "Verify the information provided is in the correct format with everything required"
+    },
+    {
+      "key": "Entity Cache Not Loading",
+      "icode": "AD.320",
+      "displayString": "Could not load entity: $VARIABLE$, into cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Error Verifying Entity Cache",
+      "icode": "AD.321",
+      "displayString": "Could not verify entity in cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Unable To Authenticate",
+      "icode": "AD.400",
+      "displayString": "Unable to authenticate with $VARIABLE$, response $VARIABLE$",
+      "recommendation": "Verify the user credentials and check the response for more information"
+    },
+    {
+      "key": "Unable To Encode",
+      "icode": "AD.401",
+      "displayString": "Can not perform base64 encoding on $VARIABLE$",
+      "recommendation": "Check the authentication format"
+    },
+    {
+      "key": "Unable To Get Token",
+      "icode": "AD.402",
+      "displayString": "Unable to get token for user: $VARIABLE$",
+      "recommendation": "Verify the user credentials and the system information"
+    },
+    {
+      "key": "Error On Request",
+      "icode": "AD.500",
+      "displayString": "Error $VARIABLE$ received on request",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Request Timeout",
+      "icode": "AD.501",
+      "displayString": "The Adapter has run out of time for the request",
+      "recommendation": "Increase your adapter request.attempt_timeout property"
+    },
+    {
+      "key": "Invalid Response",
+      "icode": "AD.502",
+      "displayString": "Invalid response received for $VARIABLE$",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Failure Response",
+      "icode": "AD.503",
+      "displayString": "Failure response received for $VARIABLE$",
+      "recommendation": "Check the reason for failure in the stack trace"
+    },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
+    {
+      "key": "Caught Exception",
+      "icode": "AD.900",
+      "displayString": "Caught Exception $VARIABLE$",
+      "recommendation": "Evaluate why the exception took place"
+    }
+  ]
+}

package/metadata.json

@@ -0,0 +1,45 @@
+{
+  "name": "adapter-opengear_lighthouse",
+  "webName": "Opengear_lighthouse",
+  "vendor": "opengear",
+  "product": "lighthouse",
+  "osVersions": [],
+  "apiVersions": [
+    "v3.5"
+  ],
+  "iapVersions": [],
+  "method": "REST",
+  "type": "Adapter",
+  "domains": [],
+  "tags": [],
+  "useCases": [],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-opengear_lighthouse",
+    "repoLink": "https://gitlab.com/@itentialopensource/adapters/adapter-opengear_lighthouse",
+    "docLink": "https://docs.itential.com/opensource/docs/opengear_lighthouse",
+    "demoLinks": [
+      "https://docs.itential.com/opensource/docs/opengear_lighthouse/examples"
+    ],
+    "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/opengear-lighthouse",
+    "vendorLink": "",
+    "productLink": "",
+    "apiLinks": []
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@itentialopensource/adapter-opengear_lighthouse",
+  "version": "0.1.1",
+  "description": "This adapter integrates with system described as: lighthouseRestApi.",
+  "main": "adapter.js",
+  "systemName": "Opengear_lighthouse",
+  "wizardVersion": "3.0.3",
+  "engineVersion": "1.67.12",
+  "adapterType": "http",
+  "scripts": {
+    "artifactize": "npm i && node utils/packModificationScript.js",
+    "preinstall": "node utils/setup.js",
+    "deinstall": "node utils/removeHooks.js",
+    "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
+    "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
+    "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
+    "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
+    "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
+    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
+    "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
+    "adapter:install": "npm i && node utils/tbScript.js install",
+    "adapter:checkMigrate": "node utils/checkMigrate.js",
+    "adapter:findPath": "node utils/findPath.js",
+    "adapter:migrate": "node utils/modify.js -m",
+    "adapter:update": "node utils/modify.js -u",
+    "adapter:revert": "node utils/modify.js -r",
+    "troubleshoot": "node utils/tbScript.js troubleshoot",
+    "healthcheck": "node utils/tbScript.js healthcheck",
+    "basicget": "node utils/tbScript.js basicget",
+    "connectivity": "node utils/tbScript.js connectivity",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
+    "build": "npm run deploy"
+  },
+  "keywords": [
+    "Itential",
+    "IAP",
+    "Automation",
+    "Integration",
+    "App-Artifacts",
+    "Adapter",
+    "opengear_lighthouse",
+    "Pre-Release",
+    "Controller",
+    "Orchestraton"
+  ],
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 8.0.0",
+    "npm": ">= 6.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:itentialopensource/adapters/controller-orchestrato/adapter-opengear_lighthouse.git"
+  },
+  "author": "Itential",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrato/adapter-opengear_lighthouse#readme",
+  "dependencies": {
+    "@itentialopensource/adapter-utils": "^5.3.2",
+    "acorn": "^8.10.0",
+    "ajv": "^8.12.0",
+    "axios": "^1.6.2",
+    "commander": "^11.0.0",
+    "dns-lookup-promise": "^1.0.4",
+    "fs-extra": "^11.1.1",
+    "json-query": "^2.2.2",
+    "mocha": "^10.2.0",
+    "mocha-param": "^2.0.1",
+    "mongodb": "^4.16.0",
+    "nyc": "^15.1.0",
+    "ping": "^0.4.4",
+    "prompts": "^2.4.2",
+    "readline-sync": "^1.4.10",
+    "semver": "^7.5.3",
+    "winston": "^3.9.0"
+  },
+  "devDependencies": {
+    "chai": "^4.3.7",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-json": "^3.1.0",
+    "testdouble": "^3.18.0"
+  },
+  "private": false
+}