Add health checks to the application

Author: zfi

app/Health/__init__.py

@@ -0,0 +1,95 @@
+# ------------------------------------------------------------------------------
+#  Copyright (c) 2019 Parallax Inc.                                            -
+#                                                                              -
+#  Permission is hereby granted, free of charge, to any person obtaining       -
+#  a copy of this software and associated documentation files (the             -
+#  “Software”), to deal in the Software without restriction, including         -
+#  without limitation the rights to use, copy,  modify, merge, publish,        -
+#  distribute, sublicense, and/or sell copies of the Software, and to          -
+#  permit persons to whom the Software is furnished to do so, subject          -
+#  to the following conditions:                                                -
+#                                                                              -
+#     The above copyright notice and this permission notice shall be           -
+#     included in all copies or substantial portions of the Software.          -
+#                                                                              -
+#  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,             -
+#  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF          -
+#  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT.       -
+#  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY        -
+#  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,        -
+#  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE           -
+#  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                      -
+#                                                                              -
+#                                                                              -
+# ------------------------------------------------------------------------------
+
+import logging
+from flask_restful import Api, Resource
+from flask import request, Blueprint
+from app import __version__
+
+
+# Set the base URL for this module and register it
+health_app = Blueprint('health', __name__, url_prefix='/health')
+api = Api(health_app)
+
+
+class Ping(Resource):
+    # noinspection PyUnresolvedReferences
+    """
+        Provide a simple response to verify that the Rest API is functioning.
+
+        Args:
+            None
+
+        Returns:
+            A JSON document with the key 'success' set to True, 'message' set to
+            the constant 'pong', and a 200 response code.
+
+        Raises:
+            None
+        """
+    def get(self):
+        # Ping the REST server for signs of life
+        server = request.headers.get('server')
+        logging.info("Requesting ping from server %s", server)
+
+        return {
+            'Success': True,
+            'message': 'pong',
+            'code': 200
+        }
+
+
+class Version(Resource):
+    # noinspection PyUnresolvedReferences
+    """
+        Provide the application version string.
+
+        Args:
+            None
+
+        Returns:
+            A JSON document with the key 'success' set to True, 'message' contains a
+            version element holding a string representation of the application version
+            number, and a 200 response code.
+
+        Raises:
+            None
+        """
+    def get(self):
+        # Ping the REST server for signs of life
+        server = request.headers.get('server')
+        logging.info("Requesting version info from server %s", server)
+
+        return {
+            'Success': True,
+            'message': {
+                'version': __version__.__version__,
+            },
+            'code': 200
+        }
+
+
+api.add_resource(Ping, '/ping')
+api.add_resource(Version, '/version')

app/Health/controllers.py

@@ -225,14 +225,15 @@
 if db is not None:
     from app.Authenticate.controllers import authenticate_app
     from app.AuthToken.controllers import auth_token_app
+    from app.Health.controllers import health_app
     from app.User.controllers import user_app
     from app.LocalUser.controllers import local_user_app
     from app.RateLimiting.controllers import rate_limiting_app
     from app.OAuth.controllers import oauth_app
 
-
 app.register_blueprint(auth_token_app)
 app.register_blueprint(authenticate_app)
+app.register_blueprint(health_app)
 app.register_blueprint(user_app)
 app.register_blueprint(local_user_app)
 app.register_blueprint(rate_limiting_app)

app/__init__.py

@@ -27,6 +27,10 @@
 """
 Change Log
 
+1.3.2       Update supervisor package to accommodate the removal of the cgi
+            library in python 3.8.
+            Add API keys for version and ping.
+
 1.3.1       Add error handling to password authentication to trap the possibility
             of an unencoded password submission.
             Update password hash methods to accommodate a change in default string
@@ -51,4 +55,4 @@
 
 """
 
-__version__ = "1.3.1"
+__version__ = "1.3.2"