Add full CRUD example for BaseUser

Author: RadoRado

styleguide_example/users/apis.py

@@ -1,15 +1,35 @@
+from django.shortcuts import Http404
 from rest_framework import serializers
+from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from styleguide_example.api.pagination import (
     LimitOffsetPagination,
     get_paginated_response,
 )
 from styleguide_example.users.models import BaseUser
-from styleguide_example.users.selectors import user_list
-
+from styleguide_example.users.selectors import user_get, user_list
+from styleguide_example.users.services import user_create, user_update
 
 # TODO: When JWT is resolved, add authenticated version
+
+
+class UserDetailApi(APIView):
+    class OutputSerializer(serializers.Serializer):
+        id = serializers.IntegerField()
+        email = serializers.CharField()
+
+    def get(self, request, user_id):
+        user = user_get(user_id)
+
+        if user is None:
+            raise Http404
+
+        data = self.OutputSerializer(user).data
+
+        return Response(data)
+
+
 class UserListApi(APIView):
     class Pagination(LimitOffsetPagination):
         default_limit = 1
@@ -38,3 +58,51 @@ def get(self, request):
             request=request,
             view=self,
         )
+
+
+class UserCreateApi(APIView):
+    class InputSerializer(serializers.Serializer):
+        email = serializers.EmailField()
+        password = serializers.CharField()
+
+    def post(self, request):
+        serializer = self.InputSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        user = user_create(
+            **serializer.validated_data
+        )
+
+        # Note: This shows a possible reusability for serializers between APIs
+        # Usually, this is how we approach things, when building APIs at first
+        # But at the very moment when we need to make a change to the output,
+        # that's specific to this API, we'll introduce a separate OutputSerializer just for this API
+        data = UserDetailApi.OutputSerializer(user).data
+
+        return Response(data)
+
+
+class UserUpdateApi(APIView):
+    class InputSerializer(serializers.Serializer):
+        # Note: Currently, those are not actual user fields, but rather an example
+        first_name = serializers.CharField(required=True)
+        last_name = serializers.CharField(required=True)
+
+    def post(self, request, user_id):
+        serializer = self.InputSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        user = user_get(user_id)
+
+        if user is None:
+            raise Http404
+
+        user = user_update(user=user, data=serializer.validated_data)
+
+        # Note: This shows a possible reusability for serializers between APIs
+        # Usually, this is how we approach things, when building APIs at first
+        # But at the very moment when we need to make a change to the output,
+        # that's specific to this API, we'll introduce a separate OutputSerializer just for this API
+        data = UserDetailApi.OutputSerializer(user).data
+
+        return Response(data)

styleguide_example/users/selectors.py

@@ -1,5 +1,8 @@
+from typing import Optional
+
 from django.db.models.query import QuerySet
 
+from styleguide_example.common.utils import get_object
 from styleguide_example.users.filters import BaseUserFilter
 from styleguide_example.users.models import BaseUser
 
@@ -20,3 +23,9 @@ def user_list(*, filters=None) -> QuerySet[BaseUser]:
     qs = BaseUser.objects.all()
 
     return BaseUserFilter(filters, qs).qs
+
+
+def user_get(user_id) -> Optional[BaseUser]:
+    user = get_object(BaseUser, id=user_id)
+
+    return user

styleguide_example/users/services.py

@@ -6,6 +6,7 @@
 from styleguide_example.users.models import BaseUser
 
 
+@transaction.atomic
 def user_create(
     *, email: str, is_active: bool = True, is_admin: bool = False, password: Optional[str] = None
 ) -> BaseUser:
@@ -16,7 +17,10 @@ def user_create(
 
 @transaction.atomic
 def user_update(*, user: BaseUser, data) -> BaseUser:
-    non_side_effect_fields = ["first_name", "last_name"]
+    non_side_effect_fields = [
+        # "first_name",
+        # "last_name"
+    ]
 
     user, has_updated = model_update(instance=user, fields=non_side_effect_fields, data=data)
 

styleguide_example/users/urls.py

@@ -1,5 +1,10 @@
 from django.urls import path
 
-from .apis import UserListApi
+from .apis import UserCreateApi, UserDetailApi, UserListApi, UserUpdateApi
 
-urlpatterns = [path("", UserListApi.as_view(), name="list")]
+urlpatterns = [
+    path("", UserListApi.as_view(), name="list"),
+    path("create/", UserCreateApi.as_view(), name="create"),
+    path("<int:user_id>/", UserDetailApi.as_view(), name="detail"),
+    path("<int:user_id>/update/", UserUpdateApi.as_view(), name="update"),
+]