Initial commit

Author: romuaa

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.log
+.idea
+venv
+tmp
+__pycache__

.pylintrc

@@ -0,0 +1,58 @@
+[MASTER]
+# Specify a score threshold to be exceeded before program exits with error.
+fail-under=10.0
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+# disable=too-few-public-methods
+
+# Files or directories to be skipped. They should be base names, not paths.
+# ignore=schema_common.graphql, schema_api.graphql, schema_admin.graphql
+
+# List of plugins (as comma separated values of python module names) to load,
+# usually to register additional checkers.
+# load-plugins=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=0
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+[MESSAGES CONTROL]
+disable=missing-docstring
+
+[FORMAT]
+max-line-length=120
+
+[tool.pylint.SIMILARITIES]
+min-similarity-lines=5
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=e,i,j,k,p,t,v,fn,db,tz
+
+# [TYPECHECK]
+# ignored-classes=scoped_session
+
+[SIMILARITIES]
+# Signatures are removed from the similarity computation
+ignore-signatures=yes
+
+[LOGGING]
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+[REPORTS]
+output-format=colorized

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.9
+
+# Install the function's dependencies using file requirements.txt
+# from your project folder.
+WORKDIR /api
+COPY requirements.txt .
+RUN  pip3 install --upgrade pip
+RUN  pip3 install -r requirements.txt
+
+# Copy function code
+COPY tasks.py .
+COPY prod_tasks.py .
+COPY app/ ./app
+
+# Clean up the Python compilation cache
+RUN find ./ -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
+
+CMD invoke -c prod_tasks prodserver -p $PORT

README.md

@@ -0,0 +1 @@
+# Simple Hello World REST API

app/__init__.py

@@ -0,0 +1,16 @@
+import logging as log
+import sys
+
+from flask import Flask
+
+from app.controller import restx
+
+app = Flask(__name__)
+
+root = log.getLogger()
+root.setLevel(log.DEBUG)
+log_handler = log.StreamHandler(sys.stdout)
+log_handler.setLevel(log.DEBUG)
+formatter = log.Formatter('%(asctime)s %(levelname)s (%(filename)s:%(lineno)d) - %(message)s')
+log_handler.setFormatter(formatter)
+root.addHandler(log_handler)

app/controller/hello_controller.py

@@ -0,0 +1,43 @@
+import logging as log
+
+from flask import request
+from flask_restx import Namespace, Resource, fields
+
+from app.service import hello_world_service
+from app.util.flask_decorators import require_auth
+
+ns = Namespace('hello', description='Hello api')
+
+resource_fields = ns.model('Resource', {
+    'name': fields.String(example="John")
+})
+
+
+@ns.route('/')
+class HelloController(Resource):
+
+    @ns.response(200, 'OK')
+    def get(self):  # pylint: disable=no-self-use
+        try:
+            return hello_world_service.say_hello(), 200
+        except Exception:  # pylint: disable=broad-except
+            log.exception("Error calling service")
+            return "Bad Request", 400
+
+
+@ns.route('/<string:api_key>')
+class ProtectedHelloController(Resource):
+
+    @ns.response(200, 'OK')
+    @ns.doc(body=resource_fields)
+    @require_auth()
+    def post(self, api_key: str):  # pylint: disable=no-self-use
+        try:
+            payload = request.get_json()
+            name = payload.get('name', None)
+            if name is None:
+                return "No name defined in request body", 400
+            return f"Hello {name}!", 200
+        except Exception:  # pylint: disable=broad-except
+            log.exception("Error echoing name")
+            return "Bad Request", 400

app/controller/restx.py

@@ -0,0 +1,41 @@
+import logging as log
+
+from flask_restx import Api
+from flask_swagger_ui import get_swaggerui_blueprint
+
+api = Api(version='1.0', title='Python REST API',
+          description='Template for building Python REST APIs')
+
+
+@api.errorhandler
+def default_error_handler(_):
+    message = 'An unhandled exception occurred.'
+    log.exception(message)
+    return {'message': message}, 500
+
+
+def init(app):
+    # app.config['SERVER_NAME'] = server_name + ':' + str(cfg.get('port', 5000))
+    app.config['SWAGGER_UI_DOC_EXPANSION'] = 'list'
+    app.config['RESTPLUS_VALIDATE'] = True
+    app.config['RESTPLUS_MASK_SWAGGER'] = False
+    app.config['ERROR_404_HELP'] = False
+
+    api_root = ''
+    swagger_url = f"{api_root}/api/docs"  # URL for exposing Swagger UI (without trailing '/')
+    log.debug("Registering swagger ui: {}".format(swagger_url))
+    api_url = f"{api_root}/swagger.json"  # Our API url (can of course be a local resource)
+    log.debug("Registering swagger api: %s", api_url)
+
+    # Call factory function to create our blueprint
+    swaggerui_blueprint = get_swaggerui_blueprint(
+        swagger_url,  # Swagger UI static files will be mapped to '{SWAGGER_URL}/dist/'
+        api_url,
+        config={  # Swagger UI config overrides
+            'app_name': "Python REST API"
+        }
+    )
+
+    # Register blueprint at URL
+    # (URL must match the one given to factory function above)
+    app.register_blueprint(swaggerui_blueprint, url_prefix=swagger_url)

app/controller/status_controller.py

@@ -0,0 +1,11 @@
+from flask_restx import Namespace, Resource
+
+ns = Namespace('', description='Status reporting')
+
+
+@ns.route('/')
+class StatusController(Resource):
+
+    @ns.response(200, 'OK')
+    def get(self):  # pylint: disable=no-self-use
+        return "OK", 200

app/server.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+import sys
+
+from flask import Blueprint
+
+from app import app
+from app.controller import restx, hello_controller, status_controller
+from app.controller.restx import api
+
+restx.init(app=app)
+blueprint = Blueprint('api', __name__, url_prefix=None)
+api.init_app(blueprint)
+api.add_namespace(status_controller.ns)
+api.add_namespace(hello_controller.ns)
+app.register_blueprint(blueprint)
+
+
+def start_dev_server():
+    app.run("0.0.0.0", port=8080, debug=True)
+
+
+if __name__ == "__main__":
+    if len(sys.argv) <= 1:
+        print("Usage: server.py [command]")
+        print("Commands:")
+        print("\tdevserver")
+        print("\t\t run Flask server in debug mode")
+        sys.exit(1)
+
+    cmd = sys.argv[1]
+    if cmd == "devserver":
+        start_dev_server()
+    else:
+        raise Exception(f"Unknown command '{sys.argv[1]}'")

app/service/hello_world_service.py

@@ -0,0 +1,2 @@
+def say_hello():
+    return "Hello World!"

app/util/flask_decorators.py

@@ -0,0 +1,20 @@
+import os
+from functools import wraps
+
+
+def check_api_key(**kwargs):
+    api_key = os.environ.get('API_KEY', None)
+    if api_key is None or ('api_key' in kwargs and kwargs['api_key'] == api_key):
+        return True
+    return False
+
+
+def require_auth():
+    def decorator(fn):
+        @wraps(fn)
+        def wrapper(*args, **kwargs):
+            if not check_api_key(**kwargs):
+                return 'Forbidden', 403
+            return fn(*args, **kwargs)
+        return wrapper
+    return decorator

docker-compose-dev.yml

@@ -0,0 +1,12 @@
+version: '3.9'
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - 8080:8080
+    environment:
+      API_KEY: foo
+      PORT: 8080

prod_tasks.py

@@ -0,0 +1,10 @@
+from invoke import run as invoke_run, task
+
+
+@task
+def prodserver(context, daemon=False, unbuffered=True, host='0.0.0.0', port=8080, workers=2, timeout=3600):
+    daemon = ' --daemon' if daemon is True else ''
+    unbuffered = 'TRUE' if unbuffered is True else 'FALSE'
+    app = 'server:app'
+    cmd = f"gunicorn --bind {host}:{port}{daemon} --workers {workers} --timeout {timeout} {app}"
+    invoke_run(cmd, env={'PYTHONPATH': './app', 'PYTHONUNBUFFERED': unbuffered})

requirements.txt

@@ -0,0 +1,6 @@
+invoke
+requests
+flask
+flask-restx
+flask-swagger-ui
+gunicorn

requirements_dev.txt

@@ -0,0 +1 @@
+pylint

tasks.py

@@ -0,0 +1,10 @@
+from os import path
+
+from invoke import run as invoke_run, task
+
+
+@task
+def devserver(context):
+    CURRENT_DIR = path.abspath(path.dirname(__file__))
+    print(CURRENT_DIR)
+    invoke_run('app/server.py devserver', env={'PYTHONPATH': './', 'PYTHONUNBUFFERED': 'TRUE'})