1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# coding=utf-8
import os
import random
import string
from functools import wraps
from flask import Blueprint, jsonify, render_template, request
from flask.views import MethodView
from pysite.constants import ErrorCodes
class BaseView(MethodView):
name = None # type: str
def render(self, *template_names, **context):
context["current_page"] = self.name
context["view"] = self
return render_template(template_names, **context)
class RouteView(BaseView):
path = None # type: str
@classmethod
def setup(cls: "RouteView", blueprint: Blueprint):
if not cls.path or not cls.name:
raise RuntimeError("Route views must have both `path` and `name` defined")
blueprint.add_url_rule(cls.path, view_func=cls.as_view(cls.name))
class APIView(RouteView):
def validate_key(self, api_key: str):
""" Placeholder! """
return api_key == os.environ.get("API_KEY")
def generate_api_key(self):
""" Generate a random string of n characters. """
pool = random.choices(string.ascii_letters + string.digits, k=32)
return "".join(pool)
def valid_api_key(f):
"""
Decorator to check if X-API-Key is valid.
"""
@wraps(f)
def has_valid_api_key(*args, **kwargs):
if not request.headers.get("X-API-Key") == os.environ.get("API_KEY"):
resp = jsonify({"error_code": 401, "error_message": "Invalid API-Key"})
resp.status_code = 401
return resp
return f(*args, **kwargs)
return has_valid_api_key
def error(self, error_code: ErrorCodes):
data = {
"error_code": error_code.value,
"error_message": "Unknown error"
}
http_code = 200
if error_code is ErrorCodes.unknown_route:
data["error_message"] = "Unknown API route"
http_code = 404
elif error_code is ErrorCodes.unauthorized:
data["error_message"] = "Unauthorized"
http_code = 401
elif error_code is ErrorCodes.invalid_api_key:
data["error_message"] = "Invalid API-key"
http_code = 401
elif error_code is ErrorCodes.missing_parameters:
data["error_message"] = "Not all required parameters were provided"
response = jsonify(data)
response.status_code = http_code
return response
class ErrorView(BaseView):
error_code = None # type: int
@classmethod
def setup(cls: "ErrorView", blueprint: Blueprint):
if not cls.name or not cls.error_code:
raise RuntimeError("Error views must have both `name` and `error_code` defined")
blueprint.errorhandler(cls.error_code)(cls.as_view(cls.name))
|
