refactor: CrudAPI _crud_add_obj _crud_patch_obj

Author: freemindcore

easy/controller/meta.py

@@ -149,7 +149,11 @@ async def add_obj(  # type: ignore
                 PUT /
                 Create a single Object
                 """
-                return await self.service.add_obj(**data.dict())
+                obj_id = await self.service.add_obj(**data.dict())
+                if obj_id:
+                    return BaseApiResponse({"id": obj_id}, errno=201)
+                else:
+                    return BaseApiResponse("Update failed", errno=204)
 
             async def patch_obj(  # type: ignore
                 self, request: HttpRequest, id: int, data: DataSchema
@@ -158,7 +162,10 @@ async def patch_obj(  # type: ignore
                 PATCH /{id}
                 Update a single field for a Object
                 """
-                return await self.service.patch_obj(id=id, payload=data.dict())
+                if await self.service.patch_obj(id=id, payload=data.dict()):
+                    return BaseApiResponse("Updated.")
+                else:
+                    return BaseApiResponse("Update Failed", errno=400)
 
             DataSchema.__name__ = (
                 f"{opts_model.__name__}__AutoSchema({str(uuid.uuid4())[:4]})"

easy/domain/orm.py

@@ -1,10 +1,11 @@
 import logging
 from typing import Any, Dict, List, Tuple, Type
 
-from django.db import models
+from django.db import models, transaction
 from django.db.models.query import QuerySet
 from ninja_extra.shortcuts import get_object_or_none
 
+from easy.exception import BaseAPIException
 from easy.response import BaseApiResponse
 
 logger = logging.getLogger(__name__)
@@ -19,7 +20,7 @@ def __init__(self, model: Type[models.Model]):
             if isinstance(_field, models.ManyToManyField)
         )
 
-    def __separate_payload(self, payload: Dict) -> Tuple[Dict, Dict]:
+    def _separate_payload(self, payload: Dict) -> Tuple[Dict, Dict]:
         m2m_fields = {}
         local_fields = {}
         for _field in payload.keys():
@@ -35,22 +36,30 @@ def __separate_payload(self, payload: Dict) -> Tuple[Dict, Dict]:
                     local_fields.update({_field: payload[_field]})
         return local_fields, m2m_fields
 
+    @staticmethod
+    def _crud_set_m2m_obj(obj: models.Model, m2m_fields: Dict) -> bool:
+        if obj and m2m_fields:
+            for _field, _value in m2m_fields.items():
+                if _value and isinstance(_value, List):
+                    m2m_f = getattr(obj, _field)
+                    m2m_f.set(_value)
+        return True
+
     # Define BASE CRUD
+    @transaction.atomic()
     def _crud_add_obj(self, **payload: Dict) -> Any:
-        local_f_payload, m2m_f_payload = self.__separate_payload(payload)
+        local_f_payload, m2m_f_payload = self._separate_payload(payload)
+
         # Create obj with local_fields payload
-        try:
-            obj = self.model.objects.create(**local_f_payload)
-        except Exception as e:  # pragma: no cover
-            logger.error(f"Crud_add Error - {e}", exc_info=True)
-            return BaseApiResponse(str(e), message="Add failed", errno=500)
+        obj = self.model.objects.create(**local_f_payload)
+
         # Save obj with m2m_fields payload
-        if m2m_f_payload:
-            for _field, _value in m2m_f_payload.items():
-                if _value and isinstance(_value, List):
-                    m2m_f = getattr(obj, _field)
-                    m2m_f.set(_value)
-        return BaseApiResponse({"id": obj.pk}, errno=201)
+        set_m2m_status = self._crud_set_m2m_obj(obj, m2m_f_payload)
+
+        if obj and set_m2m_status:
+            return obj.id
+        else:
+            return None
 
     def _crud_del_obj(self, pk: int) -> "BaseApiResponse":
         obj = get_object_or_none(self.model, pk=pk)
@@ -60,27 +69,18 @@ def _crud_del_obj(self, pk: int) -> "BaseApiResponse":
         else:
             return BaseApiResponse("Not Found.", errno=404)
 
-    def _crud_update_obj(self, pk: int, payload: Dict) -> "BaseApiResponse":
-        local_fields, m2m_fields = self.__separate_payload(payload)
+    @transaction.atomic()
+    def _crud_update_obj(self, pk: int, payload: Dict) -> bool:
+        local_fields, m2m_fields = self._separate_payload(payload)
         if not self.model.objects.filter(pk=pk).exists():
-            return BaseApiResponse("Not Found.", errno=404)
+            return False
         try:
             obj, _ = self.model.objects.update_or_create(pk=pk, defaults=local_fields)
         except Exception as e:  # pragma: no cover
-            logger.error(f"Crud_update Error - {e}", exc_info=True)
-            return BaseApiResponse(str(e), message="Update Failed", errno=500)
-        if obj and m2m_fields:
-            for _field, _value in m2m_fields.items():
-                if _value:
-                    m2m_f = getattr(obj, _field)
-                    try:
-                        m2m_f.set(_value)
-                    except Exception as e:  # pragma: no cover
-                        logger.error(f"Crud_update Error - {e}", exc_info=True)
-                        return BaseApiResponse(
-                            str(e), message="Update Failed", errno=500
-                        )
-        return BaseApiResponse({"pk": pk}, message="Updated.")
+            raise BaseAPIException(f"Update Error - {e}")
+
+        set_m2m_status = self._crud_set_m2m_obj(obj, m2m_fields)
+        return bool(set_m2m_status and obj)
 
     def _crud_get_obj(self, pk: int) -> Any:
         if self.m2m_fields_list:

tests/demo_app/controllers.py

@@ -110,8 +110,7 @@ async def must_be_super_user(self, word: str):
 
     @http_get("/test_perm_only_super/", permissions=[BaseApiPermission])
     async def test_perm_only_super(self, request):
-        response = await self.service.add_obj(title="test_event_title")
-        event_id = response.json_data.get("data")["id"]
+        event_id = await self.service.add_obj(title="test_event_title")
         # return await self.service.get_obj(id=note.id)
         return await sync_to_async(self.get_object_or_none)(Event, id=event_id)
 

tests/demo_app/test_async_api_permissions.py

@@ -23,7 +23,6 @@ async def test_demo(self, easy_api_client):
             "/must_be_authenticated/?word=authenticated",
             content_type="application/json",
         )
-        print(f"{response.__dict__.items()}")
         assert response.status_code == 200
         assert response.json().get("data")["says"] == "authenticated"
 
@@ -187,7 +186,7 @@ async def test_perm_auto_apis_patch(self, transactional_db, easy_api_client):
         response = await client.patch(
             f"/{event.id}", json=new_data, content_type="application/json"
         )
-        assert response.json().get("data")["pk"] == event.id
+        assert response.json().get("data")
 
         response = await client.get(
             f"/{event.id}",

tests/demo_app/test_async_auto_crud_apis.py

@@ -192,14 +192,14 @@ async def test_crud_default_patch(self, transactional_db, easy_api_client):
         )
 
         assert response.status_code == 200
-        assert response.json()["code"] == 404
+        assert response.json()["code"] == 400
 
         response = await client.patch(
             f"/{event.pk}", json=new_data, content_type="application/json"
         )
 
         assert response.status_code == 200
-        assert response.json().get("data")["pk"] == event.pk
+        assert response.json().get("data")
 
         response = await client.get(
             f"/{event.pk}",