This project is a coffee shop app that allows users to view drinks, baristas can view drinks and see ingredients and managers can create, edit, and update drinks. The objective is to demonstrate API Authentication and Authorization. Specifically, this API requires JWT tokens from Auth0.

Backend code follows PEP8 style guidelines.

Follow instructions to install the latest version of python for your platform in the python docs

It is generally recommended, but not required, to use a virtual environment.

python docs

Once you have your virtual environment setup and running, install dependencies by naviging to the /backend directory and running:

pip install -r requirements.txt

• Flask is a lightweight backend microservices framework. Flask is required to handle requests and responses.

• SQLAlchemy is the Python SQL toolkit and ORM used to handle the lightweight sqlite database.

• Flask-CORS is the extension used to handle cross origin requests from the frontend server.

From within the backend/src directory first ensure you are working using your created virtual environment.

To run the server, execute:

export FLASK_APP=api.py
export FLASK_ENV=development
flask run

To run the tests, create a sqlite database called test_drinks.py in the /src directory and add a single drink. Change self.manager_token and self.barista_token in test_drinks.py to valid tokens. Then, from the /src directory run

python test_drinks.py

This project depends on Nodejs and Node Package Manager (NPM). Before continuing, you must download and install Node (the download includes NPM) from https://nodejs.com/en/download.

The Ionic Command Line Interface is required to serve and build the frontend. Instructions for installing the CLI is in the Ionic Framework Docs.

This project uses NPM to manage software dependencies. NPM Relies on the package.json file located in the frontend directory of this repository. After cloning, open your terminal and run:

npm install

Ionic uses a configuration file to manage environment variables. These variables ship with the transpiled software and should not include secrets.

• Open ./src/environments/environments.ts and ensure each variable reflects the system you stood up for the backend.

Ionic ships with a useful development server which detects changes and transpiles as you work. The application is then accessible through the browser on a localhost port. To run the development server, cd into the frontend directory and run:

ionic serve

Checkout the Ionic docs to learn more

• Base URL: At present this app can only be run locally and is not hosted as a base URL. The backend app is hosted at the default, http://127.0.0.1:5000/, which is set as a proxy in the frontend configuration.

• Authentication: This version of the application does not require API keys but does require an Auth0 JWT token for all create, update, and delete requests. A token is also required for drink details.

Error are returned as JSON objects in the following format

{
'message':'Bad request',
'error': 400,
'success':False
}

The API will return four error types when requests fail:

• 400
• 401
• 403
• 404
• 422
• 500

• General:

  • Returns a list of drink objects and success value.

• Sample: curl -X GET http://localhost:5000/drinks

{
  "drinks": [
    {
      "id": 1,
      "recipe": [
        {
          "color": "green",
          "parts": 1
        }
      ],
      "title": "Super Green"
    }
  ],
  "success": true
}

• General:

  • Returns a list of drinks and success value. The drinks contain recipe information.
  • Requires barista or manager permissions role.

• Sample: curl -X GET \ http://localhost:5000/drinks-detail \ -H 'Accept: */*' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlJFSTJNVFF3UXpoR1JEQTRRMFJETVVGRE5VTkJRVVUwUmtVNU9FUXhNMEUzTmtOQ016RkRSQSJ9.eyJpc3MiOiJodHRwczovL2ZzbmQtYmlsbHkuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDVkODYyYmY1NWJiZTgyMGRmN2EwNDQ5NyIsImF1ZCI6ImRyaW5rcyIsImlhdCI6MTU2OTI3NDUwNCwiZXhwIjoxNTY5MzYwOTA0LCJhenAiOiJybFVOaURqalMwQlA2bzBYSHJiNGYyU0ZobEUwRnJEMCIsInNjb3BlIjoiIiwicGVybWlzc2lvbnMiOlsiZ2V0OmRyaW5rcy1kZXRhaWwiXX0.L1Lr2EbFY5TokQaWh2aAdPyOQRWUnPFj0LIxYXyreq4I6SWr5Bc4dXbFUgJr0tltBj7ufZ2oJEa4VymnIfHryVdUVqKKCm32cbFFqse5ugB_VHQgqHeZsPnLyGIOcncMtC6dXKD0BolweE1d8PL0XkgoJhZjsTN5EM3F-6O2ODmnm0sjeH31ddrwBcV6MkS5MuDTuvYXqO2aWeNT4qwD5hJHXmyGkGQNAxearR8hR8cS4LD4xaB2cnEVHny_DUGHei4an1xhawh9QYZ3Vzb8qCEVGuRYm3VwzDgKKMYVUN5nnqSoGCXSlt398zMCqYV_WGr9N6y7IGkKI_xFiGIk5Q' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Host: localhost:5000' \ -H 'Postman-Token: e743809d-1e4e-435a-832a-8a7cb62d63d1,ee6da28a-6c6a-4283-a33d-6fc2c8fad5ab' \ -H 'User-Agent: PostmanRuntime/7.17.1' \ -H 'cache-control: no-cache'

{
  "drinks": [
    {
      "id": 1,
      "recipe": [
        {
          "color": "green",
          "name": "Green Beast",
          "parts": 1
        }
      ],
      "title": "Super Green"
    }
  ],
  "success": true
}

• General:
  • Deletes a drink with the provided ID. Returns the success value and the deleted drink's ID.
  • Requires manager permissions role.
• Sample: curl -X DELETE \ http://localhost:5000/drinks/2 \ -H 'Accept: */*' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlJFSTJNVFF3UXpoR1JEQTRRMFJETVVGRE5VTkJRVVUwUmtVNU9FUXhNMEUzTmtOQ016RkRSQSJ9.eyJpc3MiOiJodHRwczovL2ZzbmQtYmlsbHkuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDVkODYyYzMwNGVmMDMyMGRmNGU0YWU5NiIsImF1ZCI6ImRyaW5rcyIsImlhdCI6MTU2OTI3NjY2OSwiZXhwIjoxNTY5MzYzMDY5LCJhenAiOiJybFVOaURqalMwQlA2bzBYSHJiNGYyU0ZobEUwRnJEMCIsInNjb3BlIjoiIiwicGVybWlzc2lvbnMiOlsiZGVsZXRlOmRyaW5rcyIsImdldDpkcmlua3MtZGV0YWlsIiwicGF0Y2g6ZHJpbmtzIiwicG9zdDpkcmlua3MiXX0.cqm-TZaSALiLlm9zeSOHCiasJltDet4-76yDUOIrkM4bH0VZG2-whg5b0fxV-dxyOjKwHtd2fBt-V-hFgzonO6CfpL2G0CsWmfrSTmex5sMJL24YA5ZotX1HsLENntsjza2OCMvBxMiE0HFD8qdekMndweWYxeE5YON-L_0SIYg0RVpZ1WInaEuArh40n-bD84E3fDleczuxslGUSc873rQ6k_2kfI-IxUj-57iezSDmoGEXgUdexi_1sO2eyZ6F3En4Jj0Aka5p5rfps09Bro9uGYIitCFsTh_k7nuHi-KQE80ReZjIONtUNT-G-68tQ2yMyNqtM5Dmorvtb1f5Yw' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Content-Length: 0' \ -H 'Host: localhost:5000' \ -H 'Postman-Token: 672de643-2ebe-410a-9777-4b84ee0bdd4d,674e3740-df0c-4b6d-a79c-f579b37ca0ca' \ -H 'User-Agent: PostmanRuntime/7.17.1' \ -H 'cache-control: no-cache'

{
  "delete": 2,
  "success": true
}

• General:

  • Creates a new drink using the title and recipe. Returns the success value and the created drink JSON.
  • Requires manager permissions role

• Sample: curl -X POST \ http://localhost:5000/drinks \ -H 'Accept: */*' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlJFSTJNVFF3UXpoR1JEQTRRMFJETVVGRE5VTkJRVVUwUmtVNU9FUXhNMEUzTmtOQ016RkRSQSJ9.eyJpc3MiOiJodHRwczovL2ZzbmQtYmlsbHkuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDVkODYyYzMwNGVmMDMyMGRmNGU0YWU5NiIsImF1ZCI6ImRyaW5rcyIsImlhdCI6MTU2OTI3NjY2OSwiZXhwIjoxNTY5MzYzMDY5LCJhenAiOiJybFVOaURqalMwQlA2bzBYSHJiNGYyU0ZobEUwRnJEMCIsInNjb3BlIjoiIiwicGVybWlzc2lvbnMiOlsiZGVsZXRlOmRyaW5rcyIsImdldDpkcmlua3MtZGV0YWlsIiwicGF0Y2g6ZHJpbmtzIiwicG9zdDpkcmlua3MiXX0.cqm-TZaSALiLlm9zeSOHCiasJltDet4-76yDUOIrkM4bH0VZG2-whg5b0fxV-dxyOjKwHtd2fBt-V-hFgzonO6CfpL2G0CsWmfrSTmex5sMJL24YA5ZotX1HsLENntsjza2OCMvBxMiE0HFD8qdekMndweWYxeE5YON-L_0SIYg0RVpZ1WInaEuArh40n-bD84E3fDleczuxslGUSc873rQ6k_2kfI-IxUj-57iezSDmoGEXgUdexi_1sO2eyZ6F3En4Jj0Aka5p5rfps09Bro9uGYIitCFsTh_k7nuHi-KQE80ReZjIONtUNT-G-68tQ2yMyNqtM5Dmorvtb1f5Yw' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Content-Length: 101' \ -H 'Content-Type: application/json' \ -H 'Host: localhost:5000' \ -H 'Postman-Token: 883faf85-ac59-47cb-905d-f87711a3845e,b4b0f04e-f005-4519-8854-ad9e658d9a03' \ -H 'User-Agent: PostmanRuntime/7.17.1' \ -H 'cache-control: no-cache' \ -d '{ "title": "Watera2", "recipe": [{ "color":"green", "name":"Green Beast", "parts": 1 }] }'

{
  "drinks": [
    {
      "id": 2,
      "recipe": [
        {
          "color": "green",
          "name": "Green Beast",
          "parts": 1
        }
      ],
      "title": "Green Machine"
    }
  ],
  "success": true
}

• General:

  • Updates the drink with the provided ID. Returns the success value and the JSON for the updated drink.
  • Requires manager permissions role

• Sample: curl -X PATCH \ http://localhost:5000/drinks/1 \ -H 'Accept: */*' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlJFSTJNVFF3UXpoR1JEQTRRMFJETVVGRE5VTkJRVVUwUmtVNU9FUXhNMEUzTmtOQ016RkRSQSJ9.eyJpc3MiOiJodHRwczovL2ZzbmQtYmlsbHkuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDVkODYyYzMwNGVmMDMyMGRmNGU0YWU5NiIsImF1ZCI6ImRyaW5rcyIsImlhdCI6MTU2OTI3NjY2OSwiZXhwIjoxNTY5MzYzMDY5LCJhenAiOiJybFVOaURqalMwQlA2bzBYSHJiNGYyU0ZobEUwRnJEMCIsInNjb3BlIjoiIiwicGVybWlzc2lvbnMiOlsiZGVsZXRlOmRyaW5rcyIsImdldDpkcmlua3MtZGV0YWlsIiwicGF0Y2g6ZHJpbmtzIiwicG9zdDpkcmlua3MiXX0.cqm-TZaSALiLlm9zeSOHCiasJltDet4-76yDUOIrkM4bH0VZG2-whg5b0fxV-dxyOjKwHtd2fBt-V-hFgzonO6CfpL2G0CsWmfrSTmex5sMJL24YA5ZotX1HsLENntsjza2OCMvBxMiE0HFD8qdekMndweWYxeE5YON-L_0SIYg0RVpZ1WInaEuArh40n-bD84E3fDleczuxslGUSc873rQ6k_2kfI-IxUj-57iezSDmoGEXgUdexi_1sO2eyZ6F3En4Jj0Aka5p5rfps09Bro9uGYIitCFsTh_k7nuHi-KQE80ReZjIONtUNT-G-68tQ2yMyNqtM5Dmorvtb1f5Yw' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Content-Length: 101' \ -H 'Content-Type: application/json' \ -H 'Host: localhost:5000' \ -H 'Postman-Token: 138ab962-cac0-4745-a14a-76f4af900798,47554999-97de-464d-8efe-3cc3fa03ba5a' \ -H 'User-Agent: PostmanRuntime/7.17.1' \ -H 'cache-control: no-cache' \ -d '{ "title":"Super Green", "recipe": [{ "color":"green", "name":"Green Beast", "parts": 1 }] }'

{
  "drinks": [
    {
      "id": 1,
      "recipe": [
        {
          "color": "green",
          "name": "Green Beast",
          "parts": 1
        }
      ],
      "title": "Super Green"
    }
  ],
  "success": true
}