Refined sample project

Author: eadwinCode

sample/ellar-and-django-orm/ellar_and_django_orm/apps/event/controllers.py

@@ -14,7 +14,7 @@ def index(self):
 from ellar.common import Controller, ControllerBase, get, post
 
 from ...interfaces.events_repository import IEventRepository
-from .schemas import EventSchema, EventSchemaOut
+from .schemas import EventSchemaIn, EventSchemaOut
 
 
 @Controller("/event")
@@ -23,10 +23,14 @@ def __init__(self, event_repo: IEventRepository):
         self.event_repo = event_repo
 
     @post("/", response={201: EventSchemaOut})
-    def create_event(self, event: EventSchema):
+    def create_event(self, event: EventSchemaIn):
         event = self.event_repo.create_event(**event.dict())
         return 201, event
 
-    @get("/", response=t.List[EventSchema], name="event-list")
+    @get("/", response=t.List[EventSchemaOut], name="event-list")
     def list_events(self):
         return list(self.event_repo.list_events())
+
+    @get("/{event_id:int}", response=EventSchemaOut, name="event-detail")
+    def get_event_by_id(self, event_id: int):
+        return self.event_repo.get_by_id(event_id)

sample/ellar-and-django-orm/ellar_and_django_orm/apps/event/schemas.py

@@ -19,7 +19,7 @@ class ASampleDTO(DataclassSerializer):
 from ellar.common import Serializer
 
 
-class EventSchema(Serializer):
+class EventSchemaIn(Serializer):
     title: str
     start_date: date
     end_date: date
@@ -30,3 +30,6 @@ class Config:
 
 class EventSchemaOut(Serializer):
     id: int
+    title: str
+    start_date: date
+    end_date: date

sample/ellar-and-django-orm/ellar_and_django_orm/interfaces/dto.py

@@ -0,0 +1,16 @@
+import typing as t
+from datetime import datetime
+
+import ellar.common as ec
+
+class EventCategoryDTO(ec.Serializer):
+    id: int
+    name: str
+
+
+class EventDTO(ec.Serializer):
+    id: int
+    title: str
+    category: t.Optional[EventCategoryDTO]
+    start_date: datetime
+    end_date: datetime

sample/ellar-and-django-orm/ellar_and_django_orm/interfaces/events_repository.py

@@ -1,15 +1,17 @@
 import typing as t
 from abc import abstractmethod
-
-if t.TYPE_CHECKING:
-    from ..wsgi_django.db_models.models import Event
+from .dto import EventDTO
 
 
 class IEventRepository:
     @abstractmethod
-    def create_event(self, **kwargs: t.Dict) -> "Event":
+    def create_event(self, **kwargs: t.Dict) -> EventDTO:
+        pass
+
+    @abstractmethod
+    def list_events(self) -> t.List[EventDTO]:
         pass
 
     @abstractmethod
-    def list_events(self) -> t.List["Event"]:
+    def get_by_id(self, event_id: t.Any) -> EventDTO:
         pass

sample/ellar-and-django-orm/ellar_and_django_orm/services/event_repository.py

@@ -1,30 +1,43 @@
 import typing as t
+
+from asgiref.sync import sync_to_async
+
+import ellar.common as ec
 from datetime import datetime, timedelta
 
 from ellar.di import injectable
 
 from ..interfaces.events_repository import IEventRepository
 from ..wsgi_django.db_models.models import Event
+from ..interfaces.dto import EventDTO
 
 
 @injectable
 class EventRepository(IEventRepository):
+
     _dummy_data = {
         "title": "TestEvent1Title",
         "start_date": str(datetime.now().date()),
         "end_date": str((datetime.now() + timedelta(days=5)).date()),
     }
 
-    def create_dummy_events(self):
-        for i in range(3):
-            object_data = self._dummy_data.copy()
-            object_data.update(title=f"{object_data['title']}_{i + 1}")
-            Event.objects.create(**object_data)
-        print("Done")
+    def _seed(self) -> None:
+        if not Event.objects.exists():
+            for i in range(10):
+                object_data = self._dummy_data.copy()
+                object_data.update(title=f"{object_data['title']}_{i + 1}")
+                Event.objects.create(**object_data)
+
+    def create_event(self, **kwargs: t.Dict) -> EventDTO:
+        event = Event.objects.create(**kwargs)
+        return EventDTO.from_orm(event)
 
-    def create_event(self, **kwargs: t.Dict) -> "Event":
-        return Event.objects.create(**kwargs)
+    def list_events(self) -> t.List[EventDTO]:
+        self._seed()
+        return [EventDTO.from_orm(event) for event in Event.objects.all()]
 
-    def list_events(self) -> t.List["Event"]:
-        self.create_dummy_events()
-        return Event.objects.all()
+    def get_by_id(self, event_id: t.Any) -> EventDTO:
+        event = Event.objects.filter(id=event_id).first()
+        if not event:
+            raise ec.NotFound()
+        return EventDTO.from_orm(event)

sample/ellar-and-django-orm/ellar_and_django_orm/wsgi_django/db_models/models/event.py

@@ -10,5 +10,5 @@ class Event(models.Model):
     category = models.OneToOneField(
         Category, null=True, blank=True, on_delete=models.SET_NULL
     )
-    start_date = models.DateField(auto_now=True)
-    end_date = models.DateField(auto_now_add=True)
+    start_date = models.DateField()
+    end_date = models.DateField()