https://github.com/davidf1000/technical-assessment-covid-api
Technical assessment for Nodeflux SWE Internship
https://github.com/davidf1000/technical-assessment-covid-api
docker flask python
Last synced: 3 months ago
JSON representation
Technical assessment for Nodeflux SWE Internship
- Host: GitHub
- URL: https://github.com/davidf1000/technical-assessment-covid-api
- Owner: davidf1000
- Created: 2022-01-01T23:28:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-03T16:40:31.000Z (over 4 years ago)
- Last Synced: 2025-01-11T17:19:08.073Z (over 1 year ago)
- Topics: docker, flask, python
- Language: Python
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[]()
[](https://travis-ci.org/brennv/flask-app)
[](https://codecov.io/gh/brennv/flask-app)
[](https://codeclimate.com/github/brennv/flask-app)
[]()
# Introduction
Nodeflux Software Engineer Internship Batch 2 Technical Assessment
A docker containerized HTTP API server that could retrieve GET information about current status of covid cases and vaccination rates in Indonesia. Server is able to list the data by yearly, monthly, daily, and be able to provide information on general situations. Data is fetched from official Indonesian Goverment APIs.
HTTP API server is written in Python using Flask Framework. Flask Blueprint is used for code modularization. Error handling is defined for various scenario and will reports errors by returning appropriate HTTP status code. Postman is used during the development process and Python unittest module is used to do unit testing for each created API. Python coverage module is used to measure test coverage. Server is containerized using Docker. The Docker Image is pushed to Docker Hub.
## Getting started
Install [docker](https://docs.docker.com/engine/installation/) and pull application's docker image from :
Docker Image repository link :
pull docker image using : https://hub.docker.com/r/davidf1000/api-nodeflux-assessment
```shell
docker pull davidf1000/api-nodeflux-assessment
```
Run the image using :
```shell
docker run -it -d --network=host --rm -p 5000:5000 davidf1000/api-nodeflux-assessment
```
Otherwise, for the standalone web service:
```shell
pip install -r requirements.txt
python3 app.py
```
Visit [http://localhost:5000](http://localhost:5000)
To build Docker images using Dockerfile, run :
```shell
docker build -t .
```
## Implementation
Run inside docker image :
Run using standalone web service :
Documentation of API using Postman :
1. API used for Covid Cases Data : https://hub.docker.com/r/davidf1000/api-nodeflux-assessment
2. "http://\:\/"
3. http://\:\/yearly
4. http://\:\/yearly/\
5. http://\:\/monthly
6. http://\:\/monthly/\
7. http://\:\/monthly/\/\
8. http://\:\/daily
9. http://\:\/daily/\
10. http://\:\/daily/\/\
11. http://\:\/daily/\/\/\
## Unit Tests
Unit Test using unitest module. List of unit testing criteria implemented:
1. 200 OK response
2. Method allowed
3. Content return
4. Query string validity
5. Path param validity
6. Response body
7. 404 Not found response
Unit tests individual API with:
```shell
python3 tests/test_all.py
```
1. GeneralTest : http://\:\/
2. YearlyTest : http://\:\/yearly
3. YearlyProvidedYearTest : http://\:\/yearly/\
4. MonthlyTest : http://\:\/monthly
5. MonthlyProvidedYearTest : http://\:\/monthly/\
6. MonthlyProvidedYearMonthTest : http://\:\/monthly/\/\
7. DailyTest http://\:\/daily
8. DailyProvidedYearTest : http://\:\/daily/\
9. DailyProvidedYearMonthTest : http://\:\/daily/\/\
10. DailyProvidedYearMonthDateTest : http://\:\/daily/\/\/\
Or to run every testcase from every API :
```shell
python3 tests/test_all.py
```
### Unit Test Result
### Unit Test Coverage
To Check the coverage of unit test run:
```shell
cd tests
coverage run -m unittest test_all.py
```
To show report of the results :
```shell
coverage report
```
Based on test coverage report, unit test has a test coverage of 95%
## Additional Information
Based on Implementation of Covid Cases HTTP API, server is able to meet all the requirements needed and provide error handling for various scenarios. Unit testing of the API shows average test coverage of 95%.
### Current Limitations
System still doesnt fully handle internal system error, especially when caused by improper JSON response structure and querying data
### Future Ideation
- Use the API to create Covid Cases Plotter Website (Reference : https://github.com/davidf1000/Corona-Tracker-React , https://warm-mesa-01623.herokuapp.com/ )
- Further containerizing Flask Web Apps together with uWSGI and NGINX using docker compose so that it can be deployed securely with high performance and efficiency
- Create new string query to sort lists of data with ASC or DESC order
- Create new string query to limit the elements of data lists for the first X latest data