token-manager-web-app

Overview

The web service facilitates the API token generation and validation for the API tokens. An API token is a 6 to 12 digit alphanumeric string that token admins can share with customers.

Installations and Pre-requisites:

Install MongoDB, Angular CLI, Node

Before you proceed clone the github repo.

$ git clone https://github.com/sg83/token-manager-web-app.git

Run Application

1. Start MongoDB

$cd token-manager-web-app/server
Create data directory for MongoDB database.
$mkdir data
$mongod --dbpath ./data

1. Start server

$cd token-manager-web-app/server
$npm install
$npm run start

The server runs on port 3200

2. Start client

$cd token-manager-web-app/client
$ng serve

The client runs on port 4200

Instructions for using the web service

Open your local browser and verify the newly deployed web service is working by accessing http://localhost:4200

1. Create admin user

Create admin user using any REST client like Postman. For Example:

Email: admin123@test.com
Password:admin12345
Name: Administrator

On successful completion a user will be created and the same user can be used to login to the web service.

2. Login into the web service

Login in using following registered admin credentials:

Email: admin123@test.com
Password:admin12345

3. Go to Dashboard for managing tokens.

List of tokens will be displayed on dashboard page with details such as validity, status, name. New token can be generated using 'Create' button.

4. Revoke/Enable selected token from the list

Admin can select a token by clicking 'Select' button and enable, revoke or delete it.

5. Logout

Admin can logout using 'Logout' button.

6. Token Validation

Any user or customer can use 'Token Validation' option to check the validity of specific token.

REST API documentation

• The swagger docs for the rest api can be accessed by the link http://localhost:3200/docs

• List of token endpoints

Request	Endpoint	Description
POST	​/api​/token​/generate	Generates a new API Token
GET	/api​/token​/	Get a list of API Tokens
GET	/api​/token​/:tokenId	Get details of the API Token
DELETE	/api​/token​/:tokenId	Delete the API Token
PATCH	/api​/token​/:tokenId	Update status of a API Token
POST	/api​/token​/validate/:tokenId	Validates an API Token (Public API)

• List of user endpoints

Request	Endpoint	Description
POST	/api​/user​/register	Creates a new user (Public API)
POST	/api​/user​/login	Validates user & returns a JWT token(Public API)

Testing instructions

Run the Chai base tests using the following commmand

npm run test

The test output will look like this

Integration test
    Test token generation and list
      ✔ Creating a new admin user using POST /api/user/register works. (131ms)
      ✔ Login using the admin user using POST /api/user/login works. (81ms)
      ✔ Creating a new token using POST /api/token/generate works.
      ✔ Creating a new token using POST /api/token/generate does not work without JWT Token. Expected to return 403 status code (Forbidden)
      ✔ Fetching token details using GET /api/token/:tokenId works.
      ✔ Fetching token details using GET /api/token/:tokenId does not work without JWT Token. Expected to return 403 status code (Forbidden)
      ✔ Validating token using GET /api/token/validate/:tokenId return 200 (Validation Passed).
      ✔ Validating token using GET /api/token/validate/:tokenId works without having to specific JWT token..
      ✔ Update token status using PATCH /api/token/:tokenId works.
      ✔ Updating token status using PATCH /api/token/:tokenId does not work without JWT Token. Expected to return 403 status code (Forbidden)
      ✔ Validating token using GET /api/token/validate/:tokenId returns 404 (Validation Failed - Inactive token).
      ✔ Getting the token list using GET /api/token works
      ✔ Getting the token list using GET /api/token does not work without JWT Token. Expected to return 403 status code (Forbidden)
      ✔ Deleting the token using DELETE /api/token/:tokenId does not work without JWT Token. Expected to return 403 status code (Forbidden)
      ✔ Deleting the token using DELETE /api/token/:tokenId works
      ✔ Fetching token details using GET /api/token/:tokenId works.
      ✔ Deleting an admin user works

TODO

• Search functionality
• Pagination
• Responsiveness