Merge pull request #44 from ECN/staging

Add HTTP response simulator to API

docs-src/api/Simulating Responses.md

@@ -0,0 +1,19 @@
+Returns the requested HTTP response with a JSON payload containing the response phrase. Valid response codes and phrases are pulled from the [Python `http` library index](https://docs.python.org/3/library/http.html#http.HTTPStatus).
+
+## Endpoint
+```
+GET /api/error/{response_code}
+```
+### Parameters
+Name | Value
+- | -
+`response_code` | The HTTP response code to be returned.
+
+## Example
+```bash
+curl {{production_url}}/api/error/301
+```
+```jsonc
+// Expected Output
+{"message": "Moved Permanently"}
+```

src/webqueue2api/api/app.py

@@ -2,7 +2,7 @@
 from flask_restful import Api
 from flask_jwt_extended import JWTManager
 from .config import config
-from .resources import Login, RefreshAccessToken, Item, Queue, QueueList
+from .resources import Login, RefreshAccessToken, Item, Queue, QueueList, HTTPResponse
 
 app = Flask(__name__)
 api = Api(app)
@@ -34,4 +34,5 @@
 api.add_resource(RefreshAccessToken, "/api/tokens/refresh")
 api.add_resource(Item, "/api/data/<string:queue>/<int:number>")
 api.add_resource(Queue, "/api/data/<string:queues>")
-api.add_resource(QueueList, "/api/data/get_queues")
+api.add_resource(QueueList, "/api/data/get_queues")
+api.add_resource(HTTPResponse, "/api/error/<int:response_code>")

src/webqueue2api/api/resources/__init__.py

@@ -2,4 +2,5 @@
 from .refresh_access_token import RefreshAccessToken
 from .item import Item
 from .queue import Queue
-from .queue_list import QueueList
+from .queue_list import QueueList
+from .http_response import HTTPResponse

src/webqueue2api/api/resources/http_response.py

@@ -0,0 +1,25 @@
+from flask_restful import Resource
+from http import HTTPStatus
+
+
+
+class HTTPResponse(Resource):
+    def get(self, response_code: int) -> tuple:
+        """Returns the passed HTTP response code and a JSON payload containing a description of the response.
+
+        Args:
+            error_code (int): The HTTP response to return.
+
+        Returns:
+            tuple: HTTP response descriptions as JSON and HTTP response code.
+        """
+        # Build list of HTTP responses from http library
+        responses = {}
+        for status in HTTPStatus:
+            responses[status.value] = status.phrase
+
+        # Check for requested response code in reponses
+        if response_code not in responses.keys():
+            return ({"message": f"No entry for response code {response_code} found."}, 404)
+
+        return ({"message": f"{responses[response_code]}"}, response_code)