avhvr / backend-assessment

Assignment Scaffolding

Code Navigation

This project consists of a main folder src which contains all the project files. The files outside the source folder consists of docker-compose.yml, Dockerfile and a local.env file which are used for running the docker containers. The src folder contains the entrypoint of the Flask project app.py, settings folder which contains your application settings and an apis folder that stores all your urls and views. The tasks folder contains the tasks.

Installation

Running the scaffolding app is very easy. First install docker for your operating system from the docs provided in the docker website. Also install docker-compose

Then run

sudo docker-compose build

and then

sudo docker-compose up

This will run the server at port http://localhost:8400/

The index view will be displayed in your browser.

Logs

A logs folder is created in the root of the project i.e outside the src folder, which is mounted using the docker-compose volume mount. It will contain a file flask-scaffolding.log and will contain the project logs.

Your Assignment

You have to achieve two major tasks:

Create a Login API (JSON) in flask in this structure.
Setup celery in this project and write a task that stores last login information in another collection of mongo

Go through the structure of the project and figure out how you would proceed.

Make sure that all the api only logic should go in api layer (i.e. views.py) and all the business logic should go in the service layer (i.e. user_service.py). Schema goes in the models/user.py file.

Refer docstrings in the above mentioned files.

Tasks

Celery is used for running the Asynchronous tasks. It is setup to use RabbitMQ as message broker and MongoDB as results backend. Tasks can be found in the tasks i.e inside the src folder.

Testing

Using cURL:

# First create a test user: johndoe
curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"johndoe","password":"iamjohndoe"}' http://localhost:8400/register

# Login with test user:johndoe
curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"johndoe","password":"iamjohndoe"}' http://localhost:8400/login

The Login and register routes accept json data and respond accordingly with respective http status codes.