Adds, ping service

Author: onlinejudge95

app/__init__.py

@@ -0,0 +1,18 @@
+"""
+Module to register our Blueprints
+"""
+from .src.controller.ping import api as ping_ns
+from flask import Blueprint
+from flask_restplus import Api
+
+
+blueprint = Blueprint("api", __name__)
+
+api = Api(
+    blueprint,
+    title="Flask-RESTplus API server",
+    version="1.0.0",
+    description="REST server for py",
+)
+
+api.add_namespace(ping_ns, path="/ping")

app/src/__init__.py

@@ -0,0 +1,19 @@
+"""
+App factory for our server.
+"""
+from .config import config_map
+from dotenv import find_dotenv, load_dotenv
+from flask import Flask
+
+import os
+import pathlib
+
+
+load_dotenv(dotenv_path=str(pathlib.Path.cwd() / ".env"), verbose=True)
+
+
+def create_app(cfg):
+    app = Flask(__name__)
+    app.config.from_object(config_map[cfg])
+
+    return app

app/src/config.py

@@ -0,0 +1,34 @@
+"""
+Configuration module for the app.
+"""
+import os
+import pathlib
+import uuid
+
+
+class BaseConfig:
+    TESTING = False
+    BASE_DIR = pathlib.Path.cwd()
+    SECRET_KEY = uuid.uuid4().hex
+
+
+class DevelopmentConfig(BaseConfig):
+    pass
+
+
+class TestingConfig(BaseConfig):
+    TESTING = True
+    JSONIFY_PRETTYPRINT_REGULAR = True
+
+
+class ProductionConfig(BaseConfig):
+    JSONIFY_PRETTYPRINT_REGULAR = True
+
+
+config_map = {
+    "development": "app.src.config.DevelopmentConfig",
+    "testing": "app.src.config.TestingConfig",
+    "production": "app.src.config.ProductionConfig",
+}
+
+KEY = BaseConfig.SECRET_KEY

app/src/controller/ping.py

@@ -0,0 +1,18 @@
+"""
+Module to provide ping controller functionality
+"""
+from flask_restplus import Resource
+
+from ..service import ping as service
+from ..utils import decorators, dto
+
+api = dto.PingDto.api
+
+
+@api.route("/")
+class Ping(Resource):
+    @decorators.validate_headers
+    @api.doc("ping")
+    def get(self):
+        """Ping response to find if the server is up"""
+        return service.ping()

app/src/service/ping.py

@@ -0,0 +1,8 @@
+"""
+Module to provide ping service fundtionality
+"""
+
+
+def ping():
+    response_object = {"status": "success", "message": "PONG"}
+    return (response_object, 200, {"Connection": "close"})

app/src/util/__init__.py renamed to app/src/utils/__init__.py

@@ -0,0 +1,16 @@
+import functools
+from flask import request
+
+from .dto import PingDto
+
+api = PingDto.api
+
+
+def validate_headers(func):
+    @functools.wraps(func)
+    def check(*args, **kwargs):
+        if request.headers.get("Content-Type") != "application/json":
+            return api.abort(415)
+        return func(*args, **kwargs)
+
+    return check

app/src/utils/decorators.py

@@ -0,0 +1,6 @@
+"Module to implement ping data objects"
+from flask_restplus import Namespace, fields
+
+
+class PingDto:
+    api = Namespace("ping", description="ping related operations")

app/src/utils/dto.py

@@ -0,0 +1,55 @@
+"""
+Tests the app.main.config module.
+"""
+from flask import current_app
+from flask_testing import TestCase
+from manage import app
+
+import os
+import unittest
+
+
+class TestBaseConfig(TestCase):
+    def create_app(self):
+        app.config.from_object("app.src.config.BaseConfig")
+        return app
+
+    def test_app_is_base_config(self):
+        self.assertIsNotNone(app.config.get("BASE_DIR"))
+        self.assertIsNotNone(app.config.get("SECRET_KEY"))
+        self.assertIsNotNone(app.config.get("ENV"))
+        self.assertIsNotNone(app.config.get("DEBUG"))
+
+        self.assertFalse(app.config.get("TESTING"))
+
+
+class TestDevelopmentConfig(TestCase):
+    def create_app(self):
+        app.config.from_object("app.src.config.DevelopmentConfig")
+        return app
+
+    def test_app_is_development(self):
+        self.assertIsNotNone(current_app)
+
+
+class TestTestingConfig(TestCase):
+    def create_app(self):
+        app.config.from_object("app.src.config.TestingConfig")
+        return app
+
+    def test_app_is_testing(self):
+        self.assertTrue(app.config.get("TESTING"))
+        self.assertTrue(app.config.get("JSONIFY_PRETTYPRINT_REGULAR"))
+
+
+class TestProductionConfig(TestCase):
+    def create_app(self):
+        app.config.from_object("app.src.config.ProductionConfig")
+        return app
+
+    def test_app_is_production(self):
+        self.assertTrue(app.config.get("JSONIFY_PRETTYPRINT_REGULAR"))
+
+
+if __name__ == "__main__":
+    unittest.main()

app/test/test_config.py

@@ -0,0 +1,37 @@
+"""
+Application entry point
+"""
+from app import blueprint
+from app.src import create_app
+from flask_cors import CORS
+from flask_script import Manager
+
+import os
+import unittest
+
+
+app = create_app(os.getenv("FLASK_ENV") or "development")
+app.register_blueprint(blueprint)
+CORS(app, resources={"/ping/*": {"origins": "*"}})
+app.app_context().push()
+
+manager = Manager(app)
+
+
+@manager.command
+def run():
+    app.run()
+
+
+@manager.command
+def test():
+    """Runs the unit tests."""
+    tests = unittest.TestLoader().discover("app/test", pattern="test*.py")
+    result = unittest.TextTestRunner(verbosity=2).run(tests)
+    if result.wasSuccessful():
+        return 0
+    return 1
+
+
+if __name__ == "__main__":
+    manager.run()