update crud mixin to just be router factory

Author: zachspar

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FireFrame"
-version = "0.0.0-alpha.5"
+version = "0.0.0-alpha.6"
 authors = [
   { name="Zachary Spar", email="[email protected]" },
 ]

sample_app.py

@@ -1,6 +1,6 @@
 """A sample FireFrame API."""
 from fireframe.core.api import FireFrameAPI
-from fireframe.core.mixins import CrudMixin
+from fireframe.core.mixins import crud_router
 from fireframe.core.models import Model
 from fireframe.core.serializers import ModelSerializer
 
@@ -32,11 +32,36 @@ class Meta:
         fields = ["name", "email", "age"]
 
 
-class UserCrudAPI(CrudMixin):
-    serializer_class = UserSerializer
+class Item(Model):
+    """
+    Item model.
+
+    Inherits from FireFrame's Model.
+    """
+
+    class Meta:
+        collection_name = "items_sample_collection"
+
+    name: str
+    price: float
+    is_offer: bool
+    stock: int
+
+
+class ItemSerializer(ModelSerializer):
+    """
+    Item serializer.
+
+    Inherits from FireFrame's ModelSerializer.
+    """
+
+    class Meta:
+        model = Item
+        fields = ["name", "price", "is_offer", "stock"]
 
 
 app = FireFrameAPI(title="Sample FireFrame App", version="0.0.0")
 
 # routes from mixin
-app.include_router(UserCrudAPI.as_router(), tags=["Users"])
+app.include_router(crud_router(UserSerializer), tags=["Users"], prefix="/users")
+app.include_router(crud_router(ItemSerializer), tags=["Items"], prefix="/items")

src/fireframe/core/mixins.py

@@ -6,7 +6,7 @@
 
 
 __all__ = [
-    "CrudMixin",
+    "crud_router",
 ]
 
 
@@ -16,33 +16,23 @@ class BaseAPIViewSet(BaseAPIView):
     """
 
 
-class CrudMixin(BaseAPIViewSet):
-    """
-    Mixin for CRUD operations.
-    """
-
-    @classmethod
-    def as_router(cls):
-        """
-        Instantiate a new router with CRUD views and return the router.
-        """
-        router = APIRouter()
-
-        class CreateView(BaseCreateAPIView):
-            serializer_class = cls.serializer_class
+def crud_router(input_serializer_class):
+    router = APIRouter()
 
-        class RetrieveView(BaseRetrieveAPIView):
-            serializer_class = cls.serializer_class
+    class CreateView(BaseCreateAPIView):
+        serializer_class = input_serializer_class
 
-        class UpdateView(BaseUpdateAPIView):
-            serializer_class = cls.serializer_class
+    class RetrieveView(BaseRetrieveAPIView):
+        serializer_class = input_serializer_class
 
-        class DestroyView(BaseDestroyAPIView):
-            serializer_class = cls.serializer_class
+    class UpdateView(BaseUpdateAPIView):
+        serializer_class = input_serializer_class
 
-        router.include_router(CreateView.as_router())
-        router.include_router(RetrieveView.as_router())
-        router.include_router(UpdateView.as_router())
-        router.include_router(DestroyView.as_router())
+    class DestroyView(BaseDestroyAPIView):
+        serializer_class = input_serializer_class
 
-        return router
+    router.include_router(CreateView.as_router())
+    router.include_router(RetrieveView.as_router())
+    router.include_router(UpdateView.as_router())
+    router.include_router(DestroyView.as_router())
+    return router

src/fireframe/core/views.py

@@ -46,6 +46,7 @@ def _generate_routes(self):
             name=f"List {self.serializer_class.Meta.model.__name__} View",
             response_model=List[self.serializer_class],
             methods=["GET"],
+            status_code=200,
         )
 
     async def list(self):
@@ -69,6 +70,7 @@ def _generate_routes(self):
             name=f"Retrieve {self.serializer_class.Meta.model.__name__} View",
             response_model=self.serializer_class,
             methods=["GET"],
+            status_code=200,
         )
 
     async def retrieve(self, id: str):
@@ -99,6 +101,7 @@ def _generate_routes(self):
             name=f"Create {self.serializer_class.Meta.model.__name__} View",
             response_model=self.serializer_class,
             methods=["POST"],
+            status_code=201,
         )
 
     async def create(self, serializer_data):
@@ -127,6 +130,7 @@ def _generate_routes(self):
             name=f"Update {self.serializer_class.Meta.model.__name__} View",
             response_model=self.serializer_class,
             methods=["PUT"],
+            status_code=200,
         )
 
     async def update(self, id: str, serializer_data):  # TODO FIXME serializer_data: self.serializer_class
@@ -157,7 +161,11 @@ async def update(self, id: str, serializer_data):  # TODO FIXME serializer_data:
 class BaseDestroyAPIView(BaseAPIView):
     def _generate_routes(self):
         self.add_api_route(
-            "/{id}", self.destroy, name=f"Destroy {self.serializer_class.Meta.model.__name__} View", methods=["DELETE"]
+            "/{id}",
+            self.destroy,
+            name=f"Destroy {self.serializer_class.Meta.model.__name__} View",
+            methods=["DELETE"],
+            status_code=204,
         )
 
     async def destroy(self, id: str) -> None: