Add slide api

server/app/apis/__init__.py

@@ -142,6 +142,7 @@ def init_api():
     from .competitions import blp as competitions_blp
     from .media import blp as media_blp
     from .misc import blp as misc_blp
+    from .slides import blp as slide_blp
     from .users import blp as user_blp
 
     flask_api.register_blueprint(user_blp)
@@ -149,3 +150,4 @@ def init_api():
     flask_api.register_blueprint(competitions_blp)
     flask_api.register_blueprint(misc_blp)
     flask_api.register_blueprint(media_blp)
+    flask_api.register_blueprint(slide_blp)

server/app/apis/slides.py

@@ -3,93 +3,96 @@ All API calls concerning question alternatives.
 Default route: /api/competitions/<competition_id>/slides
 """
 
-import app.core.http_codes as codes
 import app.database.controller as dbc
-from app.apis import item_response, list_response, protect_route
-from app.core.dto import SlideDTO
-from app.core.parsers import sentinel
+from app.apis import protect_route
+from app.core import ma
+from app.core.schemas import BaseSchema, SlideSchema
+from app.database import models
 from app.database.models import Competition, Slide
-from flask_restx import Resource, reqparse
-from flask_restx.errors import abort
+from flask.views import MethodView
+from flask_smorest import Blueprint, abort
 
-api = SlideDTO.api
-schema = SlideDTO.schema
-list_schema = SlideDTO.list_schema
+from . import http_codes
 
-slide_parser_edit = reqparse.RequestParser()
-slide_parser_edit.add_argument("order", type=int, default=sentinel, location="json")
-slide_parser_edit.add_argument("title", type=str, default=sentinel, location="json")
-slide_parser_edit.add_argument("timer", type=int, default=sentinel, location="json")
-slide_parser_edit.add_argument("order", type=int, default=sentinel, location="json")
-slide_parser_edit.add_argument("background_image_id", default=sentinel, type=int, location="json")
+blp = Blueprint(
+    "slide",
+    "slide",
+    url_prefix="/api/competitions/<competition_id>/slides",
+    description="Adding, updating, deleting and searching for slide",
+)
 
 
-@api.route("")
-@api.param("competition_id")
-class SlidesList(Resource):
+class SlideEditArgsSchema(BaseSchema):
+    class Meta(BaseSchema.Meta):
+        model = models.Slide
+
+    order = ma.auto_field(required=False)
+    title = ma.auto_field(required=False)
+    timer = ma.auto_field(required=False)
+    order = ma.auto_field(required=False)
+    background_image_id = ma.auto_field(required=False)
+
+
+@blp.route("")
+class Slides(MethodView):
     @protect_route(allowed_roles=["*"])
+    @blp.response(http_codes.OK, SlideSchema(many=True))
     def get(self, competition_id):
         """ Gets all slides from the specified competition. """
-
-        items = dbc.get.slide_list(competition_id)
-        return list_response(list_schema.dump(items))
+        return dbc.get.slide_list(competition_id)
 
     @protect_route(allowed_roles=["*"])
+    @blp.response(http_codes.OK, SlideSchema)
+    @blp.alt_response(http_codes.CONFLICT, None, description="Can't add slide")
     def post(self, competition_id):
         """ Posts a new slide to the specified competition. """
+        return dbc.add.slide(competition_id)
 
-        item_slide = dbc.add.slide(competition_id)
-        return item_response(schema.dump(item_slide))
 
-
-@api.route("/<slide_id>")
-@api.param("competition_id, slide_id")
-class Slides(Resource):
+@blp.route("/<slide_id>")
+class Slides(MethodView):
     @protect_route(allowed_roles=["*"])
+    @blp.response(http_codes.OK, SlideSchema)
+    @blp.alt_response(http_codes.NOT_FOUND, None)
     def get(self, competition_id, slide_id):
         """ Gets the specified slide. """
-
-        item_slide = dbc.get.slide(competition_id, slide_id)
-        return item_response(schema.dump(item_slide))
+        return dbc.get.slide(competition_id, slide_id)
 
     @protect_route(allowed_roles=["*"])
-    def put(self, competition_id, slide_id):
+    @blp.arguments(SlideEditArgsSchema)
+    @blp.response(http_codes.OK, SlideSchema)
+    @blp.alt_response(http_codes.CONFLICT, None, description="Can't edit slide")
+    @blp.alt_response(http_codes.BAD_REQUEST, None, description="Can't edit slide with the provided arguments")
+    def put(self, competition_id, slide_id, args):
         """ Edits the specified slide using the provided arguments. """
 
-        args = slide_parser_edit.parse_args(strict=True)
-
         item_slide = dbc.get.slide(competition_id, slide_id)
 
         new_order = args.pop("order")
-        if new_order is not sentinel and item_slide.order != new_order:
+        if new_order is not None and item_slide.order != new_order:
             if not (0 <= new_order < dbc.utils.count(Slide, {"competition_id": competition_id})):
-                abort(codes.BAD_REQUEST, f"Cant change to invalid slide order '{new_order}'")
+                abort(http_codes.BAD_REQUEST, f"Cant change to invalid slide order '{new_order}'")
 
             item_competition = dbc.get.one(Competition, competition_id)
             dbc.utils.move_order(item_competition.slides, "order", item_slide.order, new_order)
 
-        item_slide = dbc.edit.default(item_slide, **args)
-
-        return item_response(schema.dump(item_slide))
+        return dbc.edit.default(item_slide, **args)
 
     @protect_route(allowed_roles=["*"])
+    @blp.response(http_codes.NO_CONTENT, None)
+    @blp.alt_response(http_codes.NOT_FOUND, None, description="Slide not found")
+    @blp.alt_response(http_codes.CONFLICT, None, description="Can't delete slide")
     def delete(self, competition_id, slide_id):
         """ Deletes the specified slide. """
-
-        item_slide = dbc.get.slide(competition_id, slide_id)
-
-        dbc.delete.slide(item_slide)
-        return {}, codes.NO_CONTENT
+        dbc.delete.slide(dbc.get.slide(competition_id, slide_id))
+        return None
 
 
-@api.route("/<slide_id>/copy")
-@api.param("competition_id,slide_id")
-class SlideCopy(Resource):
+@blp.route("/<slide_id>/copy")
+class SlideCopy(MethodView):
     @protect_route(allowed_roles=["*"])
+    @blp.response(http_codes.OK, SlideSchema)
+    @blp.alt_response(http_codes.NOT_FOUND, None, description="Can't find slide")
     def post(self, competition_id, slide_id):
         """ Creates a deep copy of the specified slide. """
-
-        item_slide = dbc.get.slide(competition_id, slide_id)
-        item_slide_copy = dbc.copy.slide(item_slide)
-
-        return item_response(schema.dump(item_slide_copy))
+        return dbc.copy.slide(dbc.get.slide(competition_id, slide_id))