EasyEats

Group project for course COMP3122

To run the code

Run the project with docker compose
docker-compose up

Access the API from localhost at port 8000
curl localhost:8000

Authentication

The API is secured with Auth0 and Kong Gateway. To access the API, an access token is required when sending an request.

Example for getting an access token for the API:

We can execute a client credentials exchange to get an access token for easyeats.

curl --request POST \
  --url https://sky92i.jp.auth0.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"Nhh2ojJcgIHg0fh86dAuDJdWwEZ6aUit","client_secret":"A1kIo2nD9VTg45WBBHv5s_9eOPNSI-Vg1ZXVmj5cnz6i24LiWTIGYsuWjTOj-RqN","audience":"https://easyeats","grant_type":"client_credentials"}'

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImxGUmlMYi0ycHBUWFRzTC1QT3M2UCJ9.eyJpc3MiOiJodHRwczovL3NreTkyaS5qcC5hdXRoMC5jb20vIiwic3ViIjoiTmhoMm9qSmNnSUhnMGZoODZkQXVESmRXd0VaNmFVaXRAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vZWFzeWVhdHMiLCJpYXQiOjE2MzY1MzcxNzIsImV4cCI6MTYzNjYyMzU3MiwiYXpwIjoiTmhoMm9qSmNnSUhnMGZoODZkQXVESmRXd0VaNmFVaXQiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMifQ.J2I9vGYbQ58FGbwxMCAy6M-BbDhmo_4untC0uNp8q1z3dG_eYRLJ211lJlx4rjFhCwTCJi5-3G_cyb6Tdt8lvpYpTz9TV5H0PvIemUs2crmvx3qohNHOOjNWqqja0_A09RuKUc-LaEJ8WzY-bKBxg_demsrRtAp6TJpiv38HcaWy3QxdWWEiPUVoZfSwpeQzYrsrxOsZ5ygFbXVFPrsIM1ensBYpdaAsIQ0nS7PTBS1c-AMg2cPDWlIyRm1Qt6qADv5beP0OUqHYFVAFTwC-MosJHPVQ9Y6FSpsQ51xYo5MTLWwreftk6gZfSo_B8P1TPWIvSAsEiiZwVz3SYY-k8Q",
  "token_type": "Bearer"
}

We can use the bearer token with an Authorization Header in our request to obtain authorized access to our API.

curl --request GET \
  --url http://localhost:9990/order/1 \
  --header 'authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImxGUmlMYi0ycHBUWFRzTC1QT3M2UCJ9.eyJpc3MiOiJodHRwczovL3NreTkyaS5qcC5hdXRoMC5jb20vIiwic3ViIjoiTmhoMm9qSmNnSUhnMGZoODZkQXVESmRXd0VaNmFVaXRAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vZWFzeWVhdHMiLCJpYXQiOjE2MzY1MzU1MTMsImV4cCI6MTYzNjYyMTkxMywiYXpwIjoiTmhoMm9qSmNnSUhnMGZoODZkQXVESmRXd0VaNmFVaXQiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMifQ.eGv526lXjcNERyhxlh43PLhZBfNyP5zKpmYHKqcxqqwQlxYJT67MV4Ck13sUUFFDqwQazVoXbGG2gId88Jj-J2iBuvYqK3T3AT_OPlSj0cuvlLl2981muqa3njwFXf2fdfemrobJaMNc-o2ZqgeLlkJb4gSG1WIk7LVC_IJkAfYFYPB9eeVC9Oq1YYu1kPsjQxUvsAecWYeC7EmE7q6GPzFT8MrtwJ_Xj9x9mHzo2X3N8rNeHcIxEp0sQRpeScPvjwPcbfKN58b_0FIrtju5ZOHwaEFjpiwF6XWdDDo6r_VU71q3nDUl79YjhkhTkL7tbtBY2kk8QREpRMxOvS8yyw'

Order endpoint

[GET] localhost:8000/orders/<order_id>

• to see order details

[POST] localhost:8000/orders/<order_id>/accept_pos_order

• to accept order
• must include JSON object with reason value

Request example:

{"reason": "accepted"}

[POST] localhost:8000/orders/<order_id>/deny_pos_order

• to deny order
• must include JSON object with reason value and reason code

Request example:

{
	"reason": {
		"explanation":"failed to submit order",
		"code":"store_closed"
	}
}

[POST] localhost:8000/orders/<order_id>/cancel

• to cancel order
• must include JSON object with cancel code and cancelling party

Request example:

{
	"reason":"cannot_complete_customer_note",
    "cancelling_party": "merchant"
}

[POST] localhost:8000/orders/<order_id>/restaurantdelivery/status

• to set delivery status
• must include JSON object with status

Request example:

{"status": "delivered"}

Store endpoint

[GET] localhost:8000/stores/<store_id>

• to see store information

[GET] localhost:8000/stores

• to list all stores

[GET] localhost:8000/stores/<store_id>/status

• to see the online status of a restaurant

[POST] localhost:8000/stores/<store_id>/status

• to update the online status of a restaurant
• must include JSON object with valid online status value and reason code value. Reason code needs to be valid if status is OFFLINE

Request example:

{
    "status": "OFFLINE", 
    "reason": "INVISIBLE"
}

[GET] localhost:8000/stores/<store_id>/holiday-hours

• to see the holiday hours of a restaurant

[POST] localhost:8000/stores/<store_id>/holiday-hours

• to set the holiday hours of a restaurant
• must include JSON object with store id that exists in the store collection and holiday dates with opening hours
• if a store is closed the entire day, set start_time and end_time to 00:00
• each call to this endpoint will overwrite any existing holiday hours

Request example:

{
    "holiday_hours": 
        {"2021-12-24": {
            "open_time_periods": [
                {
                    "start_time": "08:00", 
                    "end_time": "16:00"
                }
            ]
        }, 
        "2021-12-25": {
            "open_time_periods": [
                {
                "start_time": "00:00", 
                "end_time": "00:00"
                }
            ]
        }
    }
}

Menu endpoint

[GET] localhost:8000/stores/<store_id>/menus

• to see the menu of a specific store

[PUT] localhost:8000/stores/<store_id>/menus

• to create or override the entire menu of a specific store
• every item on the menu needs to have an id, a price and an availability

Request example:

{
    "items": [
        {
            "available": "yes",
            "item_id": "Cracker",
            "price": "100"
        }, 
        {
            "available": "yes",
            "item_id": "Biscuit",
            "price": "200"
        }, 
        {
            "item_id": "Noodles", 
            "price": "80", 
            "available": "no"
        }
    ]
}

[POST] localhost:8000/stores/<store_id>/menus/items/<item_id>

• to update information about an existing item on a store's menu
• will only update a field if it is specified in the request

Request example 1:

{ 
    "price": "120",
    "available": "no"
}

Request example 2:

{
    "price": "75"
}

Webhook Notifications

A webhook will be sent to a webhook listener when an order has been created or canceled. In this case, a webhook listener is created for testing. The webhook is set to send to the webhook_listner container. Also, 2 endpoints created for creating or cancelling a dummy order for testing the webhook function.

Visit localhost:5001 at browser will start to listen the webhook and the received webhook will be parsed and displayed on the webpage. Then, we can visit the following endpoints to send webhook and check the results on localhost:5001. The results should be displayed immediately without refreshing the webpage manually.

localhost:9990/testwebhook/addorder

• will create a dummy order with order id 888

localhost:9990/testwebhook/cancelorder

• cancel the dummay order with order id 888

API gateway

Kong gateway is used for our API gateway. The config file is kong.yaml. The web GUI can be visited at http://localhost:8002/default/dashboard

Logging services

The project uses Prometheus and Grafana for logging.

Access prometheus at: localhost:9090

Access grafana at: localhost:3000 with username: admin and password: admin

Interactive Katacoda Scenarios

Visit https://www.katacoda.com/easyeats to view the profile and interactive scenarios

Katacoda Scenarios -- EasyEats

To view the katacoda scenario https://www.katacoda.com/easyeats/scenarios/easyeats