Merge pull request #1 from ozgurkara/refactoring-data-layer

Refactoring data layer

Author: ozgurkara

app/data/__init__.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel, Field
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
+from app.db.fake_db import fake_todo_db
+
+
+class AddTodoDataRequest(BaseModel, BaseRequest):
+    title: str = Field("", title="The title of the item", max_length=300, min_length=1)
+
+
+class AddTodoDataResponse(BaseModel, BaseResponse):
+    success: bool = Field(...)
+
+
+class AddTodoDataHandler(BaseHandler):
+
+    async def handle(self, req: AddTodoDataRequest) -> AddTodoDataResponse:
+        fake_todo_db.append({
+            "id": len(fake_todo_db) + 1,
+            "title": req.title
+        })
+
+        return AddTodoDataResponse(success=True)

app/data/todo/__init__.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel, Field
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
+from app.db.fake_db import fake_todo_db
+
+
+class DeleteTodoByIdDataRequest(BaseModel, BaseRequest):
+    id: int = Field(0, gt=0, title="item id")
+
+
+class DeleteTodoByIdDataResponse(BaseModel, BaseResponse):
+    success: bool = Field(...)
+
+
+class DeleteTodoByIdDataHandler(BaseHandler):
+
+    async def handle(self, req: DeleteTodoByIdDataRequest) -> DeleteTodoByIdDataResponse:
+        for it in fake_todo_db:
+            if it["id"] == req.id:
+                fake_todo_db.remove(it)
+                return DeleteTodoByIdDataResponse(success=True)
+
+        return DeleteTodoByIdDataResponse(success=False)

app/data/todo/handlers/__init__.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel, Field
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
+from app.db.fake_db import fake_todo_db
+from typing import List
+
+
+class GetTodoAllDataRequest(BaseModel, BaseRequest):
+    def __init__(self):
+        pass
+
+
+class GetTodoAllDataResponse(BaseModel, BaseResponse):
+    id: int = Field(...)
+    title: str = Field(...)
+
+
+class GetTodoAllDataHandler(BaseHandler):
+
+    async def handle(self, req: GetTodoAllDataRequest) -> List[GetTodoAllDataResponse]:
+        response = []
+        for it in fake_todo_db:
+            response.append(GetTodoAllDataResponse(id=it["id"], title=it["title"]))
+
+        return response

app/data/todo/handlers/add_todo_data_handler.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel, Field
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler, BaseCacheable, CacheType
+from app.db.fake_db import fake_todo_db
+
+
+class GetTodoByIdDataRequest(BaseModel, BaseRequest):
+    id: int = Field(0, gt=0, description="The item id be greater than zero")
+
+
+class GetTodoByIdDataResponse(BaseModel, BaseResponse):
+    id: int = Field(...)
+    title: str = Field(...)
+
+
+class GetTodoByIdDataHandler(BaseHandler):
+
+    async def handle(self, req: GetTodoByIdDataRequest) -> GetTodoByIdDataResponse:
+        for it in fake_todo_db:
+            if it["id"] == req.id:
+                return GetTodoByIdDataResponse(id=it["id"], title=it["title"])
+
+        return None

app/data/todo/handlers/delete_todo_by_id_data_handler.py

@@ -0,0 +1,23 @@
+from pydantic import BaseModel, Field, Extra
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
+from app.db.fake_db import fake_todo_db
+
+
+class UpdateTodoDataRequest(BaseModel, BaseRequest):
+    title: str = Field("", title="The title of the item", max_length=300, min_length=1)
+    id: int = Field(0, title="", gt=0)
+
+
+class UpdateTodoDataResponse(BaseModel, BaseResponse):
+    success: bool = Field(...)
+
+
+class UpdateTodoDataHandler(BaseHandler):
+
+    async def handle(self, req: UpdateTodoDataRequest) -> UpdateTodoDataResponse:
+        for it in fake_todo_db:
+            if it["id"] == req.id:
+                it["title"] = req.title
+                return UpdateTodoDataResponse(success=True)
+
+        return UpdateTodoDataResponse(success=False)

app/data/todo/handlers/get_todo_all_data_handler.py

@@ -7,7 +7,7 @@
     request_validation_exception_handler
 )
 
-from app.resources.pydiator_config import set_up_pydiator
+from app.pydiator_config import set_up_pydiator
 from starlette.exceptions import HTTPException as StarletteHTTPException
 
 app = FastAPI()
@@ -32,8 +32,8 @@ async def validation_exception_handler(request, exc):
 
 app.include_router(
     todo_resource.router,
-    prefix="/v1/todo",
-    tags=["todo"]
+    prefix="/v1/handlers",
+    tags=["handlers"]
 )
 
 set_up_pydiator()

app/data/todo/handlers/get_todo_by_id_data_handler.py

@@ -27,7 +27,7 @@ async def handle(self, req: BaseRequest) -> object:
                     return cached_obj
 
             response = await self.next().handle(req)
-            if response is not None or response is not "":
+            if response is not None or response != "":
                 self.add_to_cache(response, cache_key, cache_duration, no_cache)
 
         if response is None:

app/data/todo/handlers/update_todo_data_handler.py

@@ -1,5 +1,6 @@
+from app.data.todo.handlers.delete_todo_by_id_data_handler import DeleteTodoByIdDataHandler, DeleteTodoByIdDataRequest
 from app.utils.environment import redis_key_prefix, cache_pipeline_is_active, distributed_cache_is_active
-from app.utils.client_factory import get_redis_client
+from app.utils.client_factory import get_distributed_cache_provider
 from app.utils.distributed_cache_provider import DistributedCacheProvider
 
 from app.pydiator.mediatr import pydiator
@@ -12,7 +13,13 @@
 from app.resources.todo.handlers.add_todo_handler import AddTodoRequest, AddTodoHandler
 from app.resources.todo.handlers.update_todo_handler import UpdateTodoRequest, UpdateTodoHandler
 from app.resources.todo.handlers.delete_todo_by_id_handler import DeleteTodoByIdRequest, DeleteTodoByIdHandler
-from app.resources.todo.handlers.notifications.todo_cache_remove_handler import TodoChangeNotification, TodoCacheRemoveNotificationHandler
+from app.resources.todo.handlers.notifications.todo_cache_remove_handler import TodoChangeNotification, \
+    TodoCacheRemoveNotificationHandler
+
+from app.data.todo.handlers.get_todo_all_data_handler import GetTodoAllDataRequest, GetTodoAllDataHandler
+from app.data.todo.handlers.get_todo_by_id_data_handler import GetTodoByIdDataRequest, GetTodoByIdDataHandler
+from app.data.todo.handlers.add_todo_data_handler import AddTodoDataHandler, AddTodoDataRequest
+from app.data.todo.handlers.update_todo_data_handler import UpdateTodoDataRequest, UpdateTodoDataHandler
 
 DistributedCacheProvider.redis_key_prefix = redis_key_prefix
 
@@ -21,15 +28,24 @@ def set_up_pydiator():
     container = MediatrContainer()
     container.register_pipeline(LogPipeline())
     if cache_pipeline_is_active is True and distributed_cache_is_active is True:
-        cache_pipeline = CachePipeline(DistributedCacheProvider(get_redis_client()))
+        cache_pipeline = CachePipeline(get_distributed_cache_provider())
         container.register_pipeline(cache_pipeline)
 
+    # Service handlers mapping
     container.register_request(GetTodoAllRequest(), GetTodoAllHandler())
     container.register_request(GetTodoByIdRequest(), GetTodoByIdHandler())
     container.register_request(AddTodoRequest(), AddTodoHandler())
     container.register_request(UpdateTodoRequest(), UpdateTodoHandler())
     container.register_request(DeleteTodoByIdRequest(), DeleteTodoByIdHandler())
 
+    # Data handlers mapping
+    container.register_request(GetTodoAllDataRequest(), GetTodoAllDataHandler())
+    container.register_request(GetTodoByIdDataRequest(), GetTodoByIdDataHandler())
+    container.register_request(AddTodoDataRequest(), AddTodoDataHandler())
+    container.register_request(DeleteTodoByIdDataRequest(), DeleteTodoByIdDataHandler())
+    container.register_request(UpdateTodoDataRequest(), UpdateTodoDataHandler())
+
+    # Notification mapping
     container.register_notification(TodoChangeNotification(), [TodoCacheRemoveNotificationHandler()])
 
     pydiator.set_container(container)

app/main.py

@@ -1,7 +1,8 @@
 from pydantic import BaseModel, Field
+
+from app.data.todo.handlers.add_todo_data_handler import AddTodoDataRequest
 from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
 from app.pydiator.mediatr import pydiator
-from app.db.fake_db import fake_todo_db
 from app.resources.todo.handlers.notifications.todo_cache_remove_handler import TodoChangeNotification
 
 
@@ -16,11 +17,9 @@ class AddTodoResponse(BaseModel, BaseResponse):
 class AddTodoHandler(BaseHandler):
 
     async def handle(self, req: AddTodoRequest) -> AddTodoResponse:
-        fake_todo_db.append({
-            "id": len(fake_todo_db) + 1,
-            "title": req.title
-        })
-
-        await pydiator.publish(TodoChangeNotification())
+        data_response = await pydiator.send(AddTodoDataRequest(title=req.title))
+        if data_response.success:
+            await pydiator.publish(TodoChangeNotification())
+            return AddTodoResponse(success=True)
 
-        return AddTodoResponse(success=True)
+        return AddTodoResponse(success=False)

app/pydiator/pipelines/cache_pipeline.py

@@ -1,7 +1,8 @@
 from pydantic import BaseModel, Field
+
+from app.data.todo.handlers.delete_todo_by_id_data_handler import DeleteTodoByIdDataRequest
 from app.pydiator.mediatr import pydiator
 from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
-from app.db.fake_db import fake_todo_db
 from app.resources.todo.handlers.notifications.todo_cache_remove_handler import TodoChangeNotification
 
 
@@ -16,11 +17,9 @@ class DeleteTodoByIdResponse(BaseModel, BaseResponse):
 class DeleteTodoByIdHandler(BaseHandler):
 
     async def handle(self, req: DeleteTodoByIdRequest) -> DeleteTodoByIdResponse:
-        for it in fake_todo_db:
-            if it["id"] == req.id:
-                fake_todo_db.remove(it)
-                await pydiator.publish(TodoChangeNotification())
-
-                return DeleteTodoByIdResponse(success=True)
+        data_response = await pydiator.send(DeleteTodoByIdDataRequest(id=req.id))
+        if data_response.success:
+            await pydiator.publish(TodoChangeNotification())
+            return DeleteTodoByIdResponse(success=True)
 
         return DeleteTodoByIdResponse(success=False)

app/resources/pydiator_config.py renamed to app/pydiator_config.py

@@ -1,7 +1,8 @@
 from pydantic import BaseModel, Field
 from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler, BaseCacheable, CacheType
-from app.db.fake_db import fake_todo_db
 from typing import List
+from app.pydiator.mediatr import pydiator
+from app.data.todo.handlers.get_todo_all_data_handler import GetTodoAllDataRequest
 
 
 class GetTodoAllRequest(BaseModel, BaseRequest, BaseCacheable):
@@ -24,7 +25,8 @@ class GetTodoAllHandler(BaseHandler):
 
     async def handle(self, req: GetTodoAllRequest) -> List[GetTodoAllResponse]:
         response = []
-        for it in fake_todo_db:
-            response.append(GetTodoAllResponse(id=it["id"], title=it["title"]))
+        data_response = await pydiator.send(GetTodoAllDataRequest())
+        for d in data_response:
+            response.append(GetTodoAllResponse(id=d.id, title=d.title))
 
         return response

app/resources/todo/handlers/add_todo_handler.py

@@ -1,6 +1,7 @@
 from pydantic import BaseModel, Field
-from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler, BaseCacheable, CacheType
-from app.db.fake_db import fake_todo_db
+from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
+from app.pydiator.mediatr import pydiator
+from app.data.todo.handlers.get_todo_by_id_data_handler import GetTodoByIdDataRequest
 
 
 class GetTodoByIdRequest(BaseModel, BaseRequest):
@@ -15,8 +16,8 @@ class GetTodoByIdResponse(BaseModel, BaseResponse):
 class GetTodoByIdHandler(BaseHandler):
 
     async def handle(self, req: GetTodoByIdRequest) -> GetTodoByIdResponse:
-        for it in fake_todo_db:
-            if it["id"] == req.id:
-                return GetTodoByIdResponse(id=it["id"], title=it["title"])
+        todo_data = await pydiator.send(GetTodoByIdDataRequest(id=req.id))
+        if todo_data is not None:
+            return GetTodoByIdResponse(id=todo_data.id, title=todo_data.title)
 
         return None

app/resources/todo/handlers/delete_todo_by_id_handler.py

@@ -1,7 +1,6 @@
 from pydantic import BaseModel
-from app.utils.client_factory import get_redis_client
+from app.utils.client_factory import get_distributed_cache_provider
 from app.pydiator.interfaces import BaseNotification, BaseNotificationHandler
-from app.utils.distributed_cache_provider import DistributedCacheProvider
 from app.resources.todo.handlers.get_todo_all_handler import GetTodoAllRequest
 
 
@@ -11,7 +10,7 @@ class TodoChangeNotification(BaseModel, BaseNotification):
 
 class TodoCacheRemoveNotificationHandler(BaseNotificationHandler):
     def __init__(self):
-        self.cache_provider = DistributedCacheProvider(get_redis_client())
+        self.cache_provider = get_distributed_cache_provider()
 
     async def handle(self, notification: BaseNotification):
         self.cache_provider.delete(GetTodoAllRequest().get_cache_key())

app/resources/todo/handlers/get_todo_all_handler.py

@@ -1,7 +1,8 @@
 from pydantic import BaseModel, Field, Extra
+
+from app.data.todo.handlers.update_todo_data_handler import UpdateTodoDataRequest
 from app.pydiator.interfaces import BaseRequest, BaseResponse, BaseHandler
 from app.pydiator.mediatr import pydiator
-from app.db.fake_db import fake_todo_db
 from app.resources.todo.handlers.notifications.todo_cache_remove_handler import TodoChangeNotification
 
 
@@ -19,10 +20,9 @@ class UpdateTodoResponse(BaseModel, BaseResponse):
 class UpdateTodoHandler(BaseHandler):
 
     async def handle(self, req: UpdateTodoRequest) -> UpdateTodoResponse:
-        for it in fake_todo_db:
-            if it["id"] == req.CustomFields.id:
-                it["title"] = req.title
-                await pydiator.publish(TodoChangeNotification())
-                return UpdateTodoResponse(success=True)
+        data_response = await pydiator.send(UpdateTodoDataRequest(id=req.CustomFields.id, title=req.title))
+        if data_response.success:
+            await pydiator.publish(TodoChangeNotification())
+            return UpdateTodoResponse(success=True)
 
         return UpdateTodoResponse(success=False)

app/resources/todo/handlers/get_todo_by_id_handler.py

@@ -1,6 +1,6 @@
 from fastapi import APIRouter
 from typing import List
-from app.resources.pydiator_config import pydiator
+from app.pydiator.mediatr import pydiator
 from app.resources.todo.handlers.get_todo_all_handler import GetTodoAllRequest, GetTodoAllResponse
 from app.resources.todo.handlers.get_todo_by_id_handler import GetTodoByIdRequest, GetTodoByIdResponse
 from app.resources.todo.handlers.add_todo_handler import AddTodoRequest, AddTodoResponse

app/resources/todo/handlers/notifications/todo_cache_remove_handler.py

@@ -1,6 +1,15 @@
 import redis
+
+from app.utils import environment
+from app.utils.distributed_cache_provider import DistributedCacheProvider, FakeDistributedCacheProvider
 from app.utils.environment import redis_host, redis_port, redis_db
 
 
 def get_redis_client():
     return redis.Redis(host=redis_host, port=redis_port, db=redis_db)
+
+
+def get_distributed_cache_provider():
+    if environment.distributed_cache_is_active:
+        return DistributedCacheProvider(get_redis_client())
+    return FakeDistributedCacheProvider()

app/resources/todo/handlers/update_todo_handler.py

@@ -61,4 +61,22 @@ def __get_client(self):
 
         return self.client
 
-# distributed_cache_provider = RedisCacheProvider()
+
+class FakeDistributedCacheProvider(BaseCacheProvider):
+    def __init__(self):
+        pass
+
+    def add(self, key: str, value, expires):
+        pass
+
+    def get(self, key: str):
+        pass
+
+    def exist(self, key: str):
+        pass
+
+    def delete(self, key: str):
+        pass
+
+    def check_connection(self):
+        pass

app/resources/todo/todo_resource.py

@@ -5,5 +5,5 @@
 redis_db = int(os.getenv('RedisDb', 0))
 redis_key_prefix = os.getenv('RedisKeyPrefix', 'pydiator_api:')
 
-distributed_cache_is_active = bool(os.environ.get("DistributedCacheIsActive", True))
+distributed_cache_is_active = bool(os.environ.get("DistributedCacheIsActive", False))
 cache_pipeline_is_active = bool(os.environ.get("CachePipelineIsActive", True))