ADD - Heroku Deployment

Procfile

@@ -0,0 +1 @@
+web: gunicorn main:app

api.py

@@ -2,7 +2,8 @@
 from flask_restful import Api
 
 from endpoints import (
-    EPUserLogin, EPQuestPostList, EPQuestPostGet, EPQuestPostPublish, EPQuestPostEdit, EPQuestPostIDCheck
+    EPRootTest, EPUserLogin,
+    EPQuestPostList, EPQuestPostGet, EPQuestPostPublish, EPQuestPostEdit, EPQuestPostIDCheck
 )
 from responses import Error500Response
 
@@ -26,6 +27,7 @@ def attach_api(app):
 
 def attach_endpoints(api_app):
     """Attach API endpoints to Flask app."""
+    api_app.add_resource(EPRootTest, "/", endpoint="misc.root")
     api_app.add_resource(EPUserLogin, "/user/login", endpoint="user.login")
     api_app.add_resource(EPQuestPostList, "/posts/quest", endpoint="posts.quest.list")
     api_app.add_resource(EPQuestPostGet, "/posts/quest/get", endpoint="posts.quest.get")

endpoints/__init__.py

@@ -6,4 +6,5 @@
     EPQuestPostEdit,
     EPQuestPostIDCheck
 )
+from .root import EPRootTest
 from .user import EPUserLogin, EPUserLoginParam

endpoints/root.py

@@ -0,0 +1,13 @@
+"""Endpoints at the root. Serve as a status checking endpoint."""
+from responses import RootTestResponse, ResponseCodeCollection
+
+from .base import EndpointBase
+
+__all__ = ("EPRootTest",)
+
+
+class EPRootTest(EndpointBase):
+    """Endpoint at the root path of the app."""
+
+    def get(self):  # pylint: disable=no-self-use, missing-function-docstring
+        return RootTestResponse(ResponseCodeCollection.SUCCESS), 200

main.py

@@ -37,4 +37,4 @@ class AppConfig:
 # pylint: enable=fixme
 
 if __name__ == "__main__":
-    app.run(debug=True)
+    app.run(threaded=True)

requirements.txt

@@ -1,3 +1,6 @@
+# Web server
+gunicorn
+
 # Web framework
 flask
 flask-CORS

responses/body/__init__.py

@@ -8,4 +8,5 @@
     QuestPostEditSuccessResponse, QuestPostEditFailedResponse,
     QuestPostIDCheckResponse
 )
+from .root import RootTestResponse
 from .user import UserLoginResponse

responses/body/root.py

@@ -0,0 +1,8 @@
+"""Response body for the root endpoint."""
+from .basic import Response
+
+__all__ = ("RootTestResponse",)
+
+
+class RootTestResponse(Response):
+    """Response body for the root endpoint."""

runtime.txt

@@ -0,0 +1 @@
+python-3.9.0

tests/test_endpoints.py

@@ -4,6 +4,17 @@
 from responses import ResponseCodeCollection, QuestPostListResponseKey
 
 
+def test_root(client):
+    r = client.get(url_for("misc.root"))
+
+    assert r.status_code == 200
+
+    response = r.json
+
+    assert response[QuestPostListResponseKey.CODE] == ResponseCodeCollection.SUCCESS.code
+    assert response[QuestPostListResponseKey.SUCCESS]
+
+
 def test_user_login(client):
     r = client.post(
         url_for("user.login"),
@@ -17,7 +28,8 @@ def test_user_login(client):
 
     response = r.json
 
-    assert response[QuestPostListResponseKey.CODE] in (100, 101)
+    assert response[QuestPostListResponseKey.CODE] \
+           in (ResponseCodeCollection.SUCCESS.code, ResponseCodeCollection.SUCCESS_NEW.code)
     assert response[QuestPostListResponseKey.SUCCESS]