MethodView mandates naming of methods

We don't like that and prefer to retain flexibility.

Author: MrMatAP

mrmat_python_api_flask/apis/resource/v1/api.py

@@ -27,7 +27,7 @@
 
 from werkzeug.local import LocalProxy
 from flask import request, g, current_app
-from flask.views import MethodView
+#from flask import g, request
 from flask_smorest import Blueprint
 from marshmallow import ValidationError
 
@@ -40,97 +40,104 @@
 logger = LocalProxy(lambda: current_app.logger)
 
 
-class ResourceV1(MethodView):
-
-    def _extract_identity(self) -> Tuple:
-        return g.oidc_token_info['client_id'], \
-               g.oidc_token_info['preferred_username']
-
-    @bp.route('/', methods=['GET'])
-    @oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
-    def get_all(self):
-        identity = self._extract_identity()
-        logger.info(f'Called by {identity[1]} ({identity[0]}')
-        a = Resource.query.all()
-        return {'resources': resources_schema.dump(a)}, 200
-
-    @bp.route('/<i>', methods=['GET'])
-    @oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
-    def get_one(self, i: int):
-        identity = self._extract_identity()
-        logger.info(f'Called by {identity[1]} ({identity[0]}')
-        resource = Resource.query.filter(Resource.id == i).first_or_404()
-        if resource is None:
-            return {'status': 404, 'message': f'Unable to find entry with identifier {i} in database'}, 404
-        return resource_schema.dump(resource), 200
-
-
-    @bp.route('/', methods=['POST'])
-    @oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
-    def create(self):
-        (client_id, name) = self._extract_identity()
-        logger.info(f'Called by {name} ({client_id}')
-        try:
-            json_body = request.get_json()
-            if not json_body:
-                return {'message': 'No input data provided'}, 400
-            body = resource_schema.load(request.get_json())
-        except ValidationError as ve:
-            return ve.messages, 422
-
-        #
-        # Check if we have a resource with the same name and owner already
-
-        resource = Resource.query\
-            .filter(Resource.name == body['name'] and Resource.owner.client_id == client_id)\
-            .one_or_none()
-        if resource is not None:
-            return {'status': 409,
-                    'message': f'A resource with the same name and owner already exists with id {resource.id}'}, 409
-
-        #
-        # Look up the owner and create one if necessary
-
-        owner = Owner.query.filter(Owner.client_id == client_id).one_or_none()
-        if owner is None:
-            owner = Owner(client_id=client_id, name=name)
-            db.session.add(owner)
-
-        resource = Resource(owner=owner, name=body['name'])
-        db.session.add(resource)
-        db.session.commit()
-        return resource_schema.dump(resource), 201
-
-    @bp.route('/<i>', methods=['PUT'])
-    @oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
-    def modify(self, i: int):
-        (client_id, name) = self._extract_identity()
-        logger.info(f'Called by {name} ({client_id}')
+def _extract_identity() -> Tuple:
+    return g.oidc_token_info['client_id'], \
+           g.oidc_token_info['preferred_username']
+
+
+@bp.get('/')
+@bp.doc(security=[{'mrmat_keycloak': ['mrmat-python-api-flask-resource-read']}])
+@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
+def get_all():
+    identity = _extract_identity()
+    logger.info(f'Called by {identity[1]} ({identity[0]}')
+    a = Resource.query.all()
+    return {'resources': resources_schema.dump(a)}, 200
+
+
+@bp.get('/<i>')
+@bp.doc(security=[{'mrmat_keycloak': ['mrmat-python-api-flask-resource-read']}])
+@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-read'])
+def get_one(i: int):
+    identity = _extract_identity()
+    #logger.info(f'Called by {identity[1]} ({identity[0]}')
+    resource = Resource.query.filter(Resource.id == i).first_or_404()
+    if resource is None:
+        return {'status': 404, 'message': f'Unable to find entry with identifier {i} in database'}, 404
+    return resource_schema.dump(resource), 200
+
+
+@bp.post('/')
+@bp.doc(security=[{'mrmat_keycloak': ['mrmat-python-api-flask-resource-write']}])
+@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+def create():
+    (client_id, name) = _extract_identity()
+    #logger.info(f'Called by {name} ({client_id}')
+    try:
+        json_body = request.get_json()
+        if not json_body:
+            return {'message': 'No input data provided'}, 400
         body = resource_schema.load(request.get_json())
-
-        resource = Resource.query.filter(Resource.id == i).one_or_none()
-        if resource is None:
-            return {'status': 404, 'message': 'Unable to find requested resource'}, 404
-        if resource.owner.client_id != client_id:
-            return {'status': 401, 'message': 'You do not own this resource'}, 401
-        resource.name = body['name']
-
-        db.session.add(resource)
-        db.session.commit()
-        return resource_schema.dump(resource), 200
-
-    @bp.route('/<i>', methods=['DELETE'])
-    @oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
-    def remove(self, i: int):
-        (client_id, name) = self._extract_identity()
-        logger.info(f'Called by {name} ({client_id}')
-
-        resource = Resource.query.filter(Resource.id == i).one_or_none()
-        if resource is None:
-            return {'status': 410, 'message': 'Unable to find requested resource'}, 410
-        if resource.owner.client_id != client_id:
-            return {'status': 401, 'message': 'You do not own this resource'}, 401
-
-        db.session.delete(resource)
-        db.session.commit()
-        return {}, 204
+    except ValidationError as ve:
+        return ve.messages, 422
+
+    #
+    # Check if we have a resource with the same name and owner already
+
+    resource = Resource.query\
+        .filter(Resource.name == body['name'] and Resource.owner.client_id == client_id)\
+        .one_or_none()
+    if resource is not None:
+        return {'status': 409,
+                'message': f'A resource with the same name and owner already exists with id {resource.id}'}, 409
+
+    #
+    # Look up the owner and create one if necessary
+
+    owner = Owner.query.filter(Owner.client_id == client_id).one_or_none()
+    if owner is None:
+        owner = Owner(client_id=client_id, name=name)
+        db.session.add(owner)
+
+    resource = Resource(owner=owner, name=body['name'])
+    db.session.add(resource)
+    db.session.commit()
+    return resource_schema.dump(resource), 201
+
+
+@bp.put('/<i>')
+@bp.doc(security=[{'mrmat_keycloak': ['mrmat-python-api-flask-resource-write']}])
+@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+def modify(i: int):
+    (client_id, name) = _extract_identity()
+    #logger.info(f'Called by {name} ({client_id}')
+    body = resource_schema.load(request.get_json())
+
+    resource = Resource.query.filter(Resource.id == i).one_or_none()
+    if resource is None:
+        return {'status': 404, 'message': 'Unable to find requested resource'}, 404
+    if resource.owner.client_id != client_id:
+        return {'status': 401, 'message': 'You do not own this resource'}, 401
+    resource.name = body['name']
+
+    db.session.add(resource)
+    db.session.commit()
+    return resource_schema.dump(resource), 200
+
+
+@bp.delete('/<i>')
+@bp.doc(security=[{'mrmat_keycloak': ['mrmat-python-api-flask-resource-write']}])
+@oidc.accept_token(require_token=True, scopes_required=['mrmat-python-api-flask-resource-write'])
+def remove(self, i: int):
+    (client_id, name) = _extract_identity()
+    #logger.info(f'Called by {name} ({client_id}')
+
+    resource = Resource.query.filter(Resource.id == i).one_or_none()
+    if resource is None:
+        return {'status': 410, 'message': 'Unable to find requested resource'}, 410
+    if resource.owner.client_id != client_id:
+        return {'status': 401, 'message': 'You do not own this resource'}, 401
+
+    db.session.delete(resource)
+    db.session.commit()
+    return {}, 204