Pomalo Node js Test.

How to Run

This Project is build on HapiJS framework. There are two ways to run this project. They are below :- 1. Using container 2. Without container

Run the project using Docker container

1. You should have docker and docker-compose installed
2. Clone the project using git cmd ```git clone https://github.com/sainipradeep/pomelo-nodejs.git```
3. Run the project with docker-comspose using the cmd ```docker-compose up```
4. Run the test case using npm run test.

Run the project using node/npm cli

1. Clone the project using git cmd ```git clone https://github.com/sainipradeep/pomelo-nodejs.git```
2. Run the project using npm cmd ```npm run dev```
3. Run the test case using npm run test.

The changes I have made to fulfill the requirements as described below.

Part 1. Created a new API endpoint which takes input (Appendix1) and re-organized nodes (Appendix 2) and return it as response.

POST http://localhost:8080/api/nodes/parser

curl --location --request POST 'http://localhost:8080/api/nodes/parser' \
--header 'Content-Type: application/json' \
--data-raw '{
    "0": [
        {
            "id": 10,
            "title": "House",
            "level": 0,
            "children": [],
            "parent_id": null
        }
    ],
    "1": [
        {
            "id": 12,
            "title": "Red Roof",
            "level": 1,
            "children": [],
            "parent_id": 10
        },
        {
            "id": 18,
            "title": "Blue Roof",
            "level": 1,
            "children": [],
            "parent_id": 10
        },
        {
            "id": 13,
            "title": "Wall",
            "level": 1,
            "children": [],
            "parent_id": 10
        }
    ],
    "2": [
        {
            "id": 17,
            "title": "Blue Window",
            "level": 2,
            "children": [],
            "parent_id": 12
        },
        {
            "id": 16,
            "title": "Door",
            "level": 2,
            "children": [],
            "parent_id": 13
        },
        {
            "id": 15,
            "title": "Red Window",
            "level": 2,
            "children": [],
            "parent_id": 12
        }
    ]
}'

Part 2. Github Search api called internally from our application and render to the view.

This endpoint returns Github open repositories with desired query nodejs. And returns the html page

GET http://localhost:8080/?page=1

curl --location --request GET 'http://localhost:8080/?page=3' \
--header 'Content-Type: application/json' \

Made frontend application for rendering data in the View along with Pagination widget.
That should be rendered onto the screen with fully functionality.
Rendered the Github public repositories on to the view with 10 (per page) by 10 (pages) max on to the screen.
The pagination widgets works according the page query params and shows the same as page number.

Swagger

Implemented the Swagger tools for the API documentation. Which can be easily accessed via below URL link.

http://localhost:8080/documendation

TEST CASES

Tried to implement some unit test cases to make the application bullet proof. Below test cases are performed on the application.

POST route for formatting child nodes

responds with 200
responds having properties [meta, data, error]
Match output for given input

Mock Github Api (Dependancy Injection for HttpClient and mocking, to prevent third party api calling in unit testing)

Check returned data to be an object
Check page number is equal to requested page number

GET template

responds with 200

Author

Created in 2022 by Pradeep Saini.

sainipradeep / pomelo-nodejs