dannkkie / britetest

Brite Test

Run Locally

Clone the project

  git clone [https://github.com/dannkkie/britetest](https://github.com/dannkkie/britetest)

Go to the project directory

  cd britetest

Install dependencies

  python3 -m install -r requirements.txt

Set environment variables

    export FLASK_APP=brite

Initialise DB

  flask db init
  flask db migrate -m "Any message"
  flask db upgrade

Start the server

  gunicorn -w 1 -b :8000 run:app

  or 
  
  flask run

Code Changes

After making changes to code

You can run following commands to format and check style guides. I added pre-commit hooks

  isort .
  black .
  flake8 .

You can run all the test in the tests dir allat once with follwoing command

  python3 -m unittest discover -s brites/tests

Running Tests

To run tests, run the following command

You can run single test with the following code for each test

  python3 -m unittest brites/tests/test_movie_service.py
  ...
  ...

You can run all the test in the tests dir allat once with follwoing command

  python3 -m unittest discover -s brites/tests

Usage/Examples

Lets assume we are going to use Postman to test, Enter the endpoint url and its :params

1. GET http://localhost:8000/api/v1/movies This will list all movies in the databse.

2. GET http://localhost:8000/api/v1/movies?limit=10&page=3 This will also list all movies on page 3 and return 10 per page

3. GET http://localhost:8000/api/v1/movies/title/{title} This will retrieve a movie by title

4. GET http://localhost:8000/api/v1/movies/id/{id} This retreive a movie by id

5. POST http://localhost:8000/api/v1/movies This endpoint adds a movie to the database, it accepts a json object

6. DELETE http://localhost:8000/api/1/movies/{id} This endpoint accepts an id as argument to delete a movie if the authenticated user has role 'admin'.

7. POST http://localhost:8000/api/v1/login This endpoint accepts a json object as json and return a jwt token

   After getting a token it can be used to authorize a logged in user to be able to delete a record.