garrettkmoody / wwu-wash-and-dry-backend Goto Github PK

Python Flask Application to serve as the backend for WWU Wash and Dry

Python 100.00%

wwu-wash-and-dry-backend's Introduction

WWU-Wash-And-Dry-Backend

A Python Flask Application based on simple REST principles, the WWU Wash and Dry API endpoints return JSON metadata about WWU washing and drying machines.

This Web API also provides access to user related data, like user name, email, and floor and dorm preferences.

The API provides a set of endpoints, each with its own unique path. To access private data through the Web API, such as user information and washing/drying machine data.

Endpoints

Refer to the endpoints documentation in the docs folder for more information on specific endpoint parameters and returns.

Setup and Installation

In order to setup the WWU Wash and Dry API you must have Python 3.11.0 installed as well as GIT.

Clone in the WWU Wash and Dry Web API into your repository using:

git clone https://github.com/garrettkmoody/WWU-Wash-And-Dry-Backend.git

In your local repository, open a terminal and install the needed requirements using:

pip install -r requirements.txt

Hosting the API Locally

To run the API from your local machine, open the repository in a terminal and use the command:

python init.py

Testing the Web API

To test the API, open the repository in a terminal and use the command:

pytest

To ensure that any changes in a file meets the required style guides, use the command:

pylint "/path/to/file"

Developer Notes

SSO through Azure AD will expire 4/20/2023 and need to be renewed through by the WWU IT Department
There is an .env file which contains SSO and App configuration that should NOT be pushed to version control
The SSO Authorization URL (TESTING/DEVELOPMENT) - https://login.microsoftonline.com/d958f048-e431-4277-9c8d-ebfb75e7aa64/oauth2/v2.0/authorize?client_id=b011ad62-bda8-449f-99d3-519a3d973218&response_type=code&response_mode=query&scope=https://graph.microsoft.com/User.Read&redirect_uri=http://localhost:5000/login/callback
The SSO Authorization URL (PRODUCTION) - https://login.microsoftonline.com/d958f048-e431-4277-9c8d-ebfb75e7aa64/oauth2/v2.0/authorize?client_id=b011ad62-bda8-449f-99d3-519a3d973218&response_type=code&response_mode=query&scope=https://graph.microsoft.com/User.Read&redirect_uri=https://wwuwashanddryapi.cs.wallawalla.edu/login/callback

wwu-wash-and-dry-backend's People

Contributors

Watchers

wwu-wash-and-dry-backend's Issues

Make necessary deployment changes/SSL certificate

Unimplemented tests and TODO code

There are currently two unimplemented tests in test_api.py that should be implemented on line 525 as well as line 605.

Remove line 17 from routes/machine.py

Replace line 189 with the implementation from line 119

Separate file for error handling

Unit Testing

We currently have a lot of functional tests but we don't really have any low-level unit tests. However, at the same time, I do not know what that would look like for our application. Here are some examples of what they look like:

https://gitlab.com/patkennedy79/flask_user_management_example/-/blob/main/tests/unit/test_models.py

send_email

send_email is not properly passing a successful send_email test. This should be fixed to have the notification feature working.

Finish Notification System Implementation

Implement threading, and tests for the notification system

refactor: Ensure that all endpoints return JSON objects

Currently some endpoints return strings, arrays, and other data types. For the sake of consistency, it would be easiest to always give a JSON object in the response.

More Tests

Many endpoint routes are lacking sufficient testing (both successful and failure cases as well as edge cases). These should be implemented.

Add Machine Status Codes to Readme

Include in the readme the possible values of machine.status.

Add @token_required decorator to necessary endpoints, and fix tests to make authenticated calls

Get requests returns

I noticed that what we are returning for get requests aren't consistent across the endpoints. To make it easier for the front end we should try to be consistent with what we are returning. Currently we are returning either a list of objects or a dict. I think that it would be best to return dicts because we can control the information being sent. In the case where we want to send information on multiple objects like machines, we could return a list of dicts.