kwbmm / scraped-tvtime-api Goto Github PK

After performing a request, the response from TVTime always returns a new cookie. This cookie should be updated in the Flask session automatically when doing a request.
Right now, we have to manually call Utils.update_tvtime_cookies() after each request. This should be avoided as it can lead to issues.

The API should reject all requests not using HTTPS.
This is because we are dealing with sensitive information, so no data should be passed over the network in clear text.

This API should be packaged for easy distribution.

• Look into how to create packages
• Upload to pip?
• Automate releases on github

API should handle errors through JSON and HTTP codes rather than crashing.

• When login fails
• When no show is found
• When episode watch trigger fails

To perform tests, a test user is needed.

Requirements

• The user should have a list of known series for test purposes.
• It should be possible to create a random user on-the-fly
• The user should be deleted once tests are over
• The API should not offer a way to create a new user.

A better way to document the API should be put in place.
Relying on a table written in markdown is not the best option.
Ideally, it would be great if API documentation can be generated automatically from the code, so that it is always kept up to date.

Having to start your own Flask server is not ideal.
What if the project could be dockerized and one could just launch the container and have the API exposed and ready to handle requests?

Remarks

• Server session secret key should be passed in some way down to the flask app
• Maybe should deal with SSL certificates?

The API should offer a way to add shows to follow to your profile.

This is a requirement for #3

A pipeline should be set up to verify the integrity of the code:

• When a new commit is pushed, tests should be run

Bonus

• Tests should be run daily
• Code coverage

To provide information to the end user about errors, especially when testing, a logging system should be implemented.

Should write tests for endpoints

• Login
• Shows
• Show
• Episode