@itentialopensource/adapter-att_mobility 0.1.2 → 0.2.2

package/README.md

@@ -1,4 +1,4 @@
-# Adapter for Attmobility 
+# Adapter for AttMobility 
 
 ## Table of Contents
 
@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -29,7 +30,7 @@ Some of the page links in this document and links to other GitLab files do not w
 
 Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
 
-Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Attmobility works appropriately.
+Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to AttMobility works appropriately.
 
 Release notes can be viewed in CHANGELOG.md.
 
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.
@@ -86,7 +90,7 @@ The following list of packages are required for Itential opensource adapters or
   </tr>
   <tr>
     <td style="padding:15px">ajv</td>
-    <td style="padding:15px">Required for validation of adapter properties to integrate with Attmobility.</td>
+    <td style="padding:15px">Required for validation of adapter properties to integrate with AttMobility.</td>
   </tr>
   <tr>
     <td style="padding:15px">axios</td>
@@ -96,6 +100,10 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">commander</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">dns-lookup-promise</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
   <tr>
     <td style="padding:15px">fs-extra</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
@@ -112,14 +120,14 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">mongodb</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
   </tr>
-  <tr>
-    <td style="padding:15px">network-diagnostics</td>
-    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
-  </tr>
   <tr>
     <td style="padding:15px">nyc</td>
     <td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">ping</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
   <tr>
     <td style="padding:15px">readline-sync</td>
     <td style="padding:15px">Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality.</td>
@@ -143,7 +151,6 @@ eslint
 eslint-config-airbnb-base
 eslint-plugin-import
 eslint-plugin-json
-package-json-validator
 testdouble
 ```
 
@@ -161,18 +168,20 @@ if the @itentialopensource directory does not exist, create it:
 
 ```bash
 cd \@itentialopensource
-git clone git@gitlab.com:\@itentialopensource/adapters/adapter-attmobility
+git clone git@gitlab.com:\@itentialopensource/adapters/adapter-att_mobility
 or
-unzip adapter-attmobility.zip
+unzip adapter-att_mobility.zip
 or
-tar -xvf adapter-attmobility.tar
+tar -xvf adapter-att_mobility.tar
 ```
 
 3. Run the adapter install script.
 
 ```bash
-cd adapter-attmobility
-npm run adapter:install
+cd adapter-att_mobility
+npm install
+npm run lint:errors
+npm run test
 ```
 
 4. Restart IAP
@@ -181,17 +190,20 @@ npm run adapter:install
 systemctl restart pronghorn
 ```
 
-5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
+5. Create an adapter service instance configuration in IAP Admin Essentials GUI
+
+6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+
+7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-npm run adapter:install can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If this happens you can replace step 3-5 above with these:
+
+For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
 
 3. Install adapter dependencies and check the adapter.
 
 ```bash
-cd adapter-attmobility
-npm run install
-npm run lint:errors
-npm run test
+cd adapter-att_mobility
+npm run adapter:install
 ```
 
 4. Restart IAP
@@ -200,11 +212,8 @@ npm run test
 systemctl restart pronghorn
 ```
 
-5. Create an adapter service instance configuration in IAP Admin Essentials GUI
-
-6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
 ### Testing
 
@@ -225,7 +234,7 @@ To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests t
 
 #### Integration Testing - Standalone
 
-Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Attmobility. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
+Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from AttMobility. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
 
 Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
 
@@ -240,9 +249,9 @@ To add new integration tests, edit the `test/integration/adapterTestIntegration.
 
 #### Integration Testing
 
-Integration Testing requires connectivity to Attmobility. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
+Integration Testing requires connectivity to AttMobility. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
 
-> **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with Attmobility. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Attmobility which change order dependencies or required data.
+> **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with AttMobility. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within AttMobility which change order dependencies or required data.
 
 ```bash
 node utils/testRunner
@@ -268,7 +277,7 @@ Test should also be written to clean up after themselves. However, it is importa
 
 ### Helpful Links
 
-<a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a>
+<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
 ### Node Scripts
 
@@ -309,15 +318,15 @@ There are several node scripts that now accompany the adapter. These scripts are
   </tr>
   <tr>
     <td style="padding:15px">npm run connectivity</td>
-    <td style="padding:15px">Provides a connectivity check to the Attmobility system.</td>
+    <td style="padding:15px">Provides a connectivity check to the AttMobility system.</td>
   </tr>
   <tr>
     <td style="padding:15px">npm run healthcheck</td>
-    <td style="padding:15px">Checks whether the configured healthcheck call works to Attmobility.</td>
+    <td style="padding:15px">Checks whether the configured healthcheck call works to AttMobility.</td>
   </tr>
   <tr>
     <td style="padding:15px">npm run basicget</td>
-    <td style="padding:15px">Checks whether the basic get calls works to Attmobility.</td>
+    <td style="padding:15px">Checks whether the basic get calls works to AttMobility.</td>
   </tr>
 </table>
 <br>

package/SUMMARY.md

@@ -1,8 +1,8 @@
 ## Overview
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Attmobility System. The API that was used to build the adapter for Attmobility is usually available in the report directory of this adapter. The adapter utilizes the Attmobility API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+This adapter is used to integrate the Itential Automation Platform (IAP) with the AttMobility System. The API that was used to build the adapter for AttMobility is usually available in the report directory of this adapter. The adapter utilizes the AttMobility API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
->**Note**: It is possible that some integrations will be supported through the Attmobility adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
+>**Note**: It is possible that some integrations will be supported through the AttMobility adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
 
 Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 

package/SYSTEMINFO.md

@@ -1,11 +1,16 @@
-# Attmobility
+# AT&T Mobility
 
-Vendor: Att_Mobility
+Vendor: AT&T
 Homepage: https://www.att.com/
 
-Product: Attmobility
+Product: AT&T Mobility
 Product Page: https://www.att.com/
 
 ## Introduction
+We classify AT&T Mobility into the Inventory domain as AT&T Mobility manages and provides information about mobile devices, and services within mobile network.
+
+## Why Integrate
+The AT&T Mobility adapter from Itential is used to integrate the Itential Automation Platform (IAP) with AT&T Mobility. 
+
+## Additional Product Documentation
 
-## Additional Product Documentation

package/TROUBLESHOOT.md

@@ -22,21 +22,21 @@ npm run troubleshoot
 Go into the Itential Platform GUI and verify/update the properties
 ```
 
-3. Verify there is connectivity between the Itential Platform Server and Attmobility Server.
+3. Verify there is connectivity between the Itential Platform Server and AttMobility Server.
 
 ```text
-ping the ip address of Attmobility server
-try telnet to the ip address port of Attmobility
+ping the ip address of AttMobility server
+try telnet to the ip address port of AttMobility
 execute a curl command to the other system
 ```
 
-4. Verify the credentials provided for Attmobility.
+4. Verify the credentials provided for AttMobility.
 
 ```text
-login to Attmobility using the provided credentials
+login to AttMobility using the provided credentials
 ```
 
-5. Verify the API of the call utilized for Attmobility Healthcheck.
+5. Verify the API of the call utilized for AttMobility Healthcheck.
 
 ```text
 Go into the Itential Platform GUI and verify/update the properties