latest version of apis event and cahce ablitites added

Events/AllEvents/validations/__init__.py

@@ -0,0 +1,10 @@
+"""
+Validations package initialization.
+"""
+
+from .validation.cluster import ValidationsCluster
+
+
+__all__ = [
+    "ValidationsCluster",
+]

Events/AllEvents/validations/validation/api_events.py

@@ -0,0 +1,78 @@
+from typing import Any
+from fastapi import Request
+
+from Events.Engine.abstract_class import Event
+
+from .models import ValidationsPydantic, ClusterPydantic, PagePydantic
+from .function_handlers import RetrieveValidation, RetrievePage
+
+# Validation Event
+validation_event = Event(
+    name="validation_event",
+    key="02b5a596-14ba-4361-90d7-c6755727c63f",
+    request_validator=ValidationsPydantic,
+    language_models=[],
+    statics=None,
+    description="Get Validations by event function code",
+)
+
+
+def get_validation_by_event_function_code(request: Request, data: Any):
+    return RetrieveValidation.retrieve_validation(data=data)
+
+
+validation_event.endpoint_callable = get_validation_by_event_function_code
+
+
+# Menu Event
+menu_event = Event(
+    name="menu_event",
+    key="a1613ca0-4843-498b-bfff-07ecea6777b2",
+    request_validator=ValidationsPydantic,
+    language_models=[],
+    statics=None,
+    description="Get Left Menu of the user",
+)
+
+
+def get_menu_by_event_function_code(request: Request, data: Any):
+    return RetrieveValidation.retrieve_validation(data=data)
+
+
+menu_event.endpoint_callable = get_menu_by_event_function_code
+
+
+# Cluster Event
+cluster_event = Event(
+    name="cluster_event",
+    key="eed3fe12-cec1-4f35-b43d-62fca0682f73",
+    request_validator=ClusterPydantic,
+    language_models=[],
+    statics=None,
+    description="Get Left Menu of the user",
+)
+
+
+def get_cluster_by_event_function_code(request: Request, data: Any):
+    return RetrievePage.retrieve_cluster(data=data)
+
+
+cluster_event.endpoint_callable = get_cluster_by_event_function_code
+
+
+# Page Event
+page_event = Event(
+    name="page_event",
+    key="",
+    request_validator=PagePydantic,
+    language_models=[],
+    statics=None,
+    description="Get Left Menu of the user",
+)
+
+
+def get_page_by_event_function_code(request: Request, data: Any):
+    return RetrievePage.retrieve_page(data=data)
+
+
+page_event.endpoint_callable = get_page_by_event_function_code

Events/AllEvents/validations/validation/cluster.py

@@ -0,0 +1,24 @@
+from Events.Engine.abstract_class import CategoryCluster
+
+from .validation import (
+    ValidationEventMethods,
+    MenuEventMethods,
+    ClusterEventMethods,
+    PageEventMethods,
+)
+
+
+ValidationsCluster = CategoryCluster(
+    name="ValidationsCluster",
+    tags=["Validations"],
+    prefix="/validations",
+    description="Validations cluster",
+    endpoints={
+        "ValidationEventMethods": ValidationEventMethods,
+        "MenuEventMethods": MenuEventMethods,
+        "ClusterEventMethods": ClusterEventMethods,
+        "PageEventMethods": PageEventMethods,
+    },
+    include_in_schema=True,
+    sub_category=[],
+)

Events/AllEvents/validations/validation/function_handlers.py

@@ -0,0 +1,216 @@
+"""
+Validation function handlers
+"""
+
+from typing import Dict, Any
+from fastapi import Request
+
+from ApiLayers.AllConfigs.Redis.configs import (
+    RedisValidationKeysAction,
+    RedisCategoryKeys,
+)
+from Services.Redis.Actions.actions import RedisActions
+from Events.base_request_model import BaseRouteModel
+
+from config import ValidationsConfig
+
+
+class ValidateBase:
+
+    redis_key: str = f"{RedisCategoryKeys.METHOD_FUNCTION_CODES}:*:"
+
+    def __init__(self, url: str, reachable_codes: list):
+        self.url = url
+        self.reachable_codes = reachable_codes
+
+    @property
+    def function_codes(self):
+        redis_function_codes = RedisActions.get_json(
+            list_keys=[f"{self.redis_key}{self.url}"]
+        )
+        if redis_function_codes.status:
+            return redis_function_codes.first
+        raise ValueError("Function code not found")
+
+    @property
+    def intersection(self):
+        intersection = list(
+            set(self.function_codes).intersection(set(self.reachable_codes))
+        )
+        if not len(intersection) == 1:
+            raise ValueError(
+                "Users reachable function codes does not match or match more than one."
+            )
+        return intersection[0]
+
+
+class RedisHeaderRetrieve(ValidateBase):
+
+    redis_key: str = RedisValidationKeysAction.dynamic_header_request_key
+
+    @property
+    def header(self):
+        """
+        Headers: Headers which is merged with response model && language models of event
+        """
+        redis_header = RedisActions.get_json(
+            list_keys=[f"{self.redis_key}:{self.intersection}"]
+        )
+        if redis_header.status:
+            return redis_header.first
+        raise ValueError("Header not found")
+
+
+class RedisValidationRetrieve(ValidateBase):
+
+    redis_key: str = RedisValidationKeysAction.dynamic_validation_key
+
+    @property
+    def validation(self):
+        """
+        Validation: Validation of event which is merged with response model && language models of event
+        """
+        redis_validation = RedisActions.get_json(
+            list_keys=[f"{self.redis_key}:{self.intersection}"]
+        )
+        if redis_validation.status:
+            return redis_validation.first
+        raise ValueError("Header not found")
+
+
+class ValidationsBoth(RedisHeaderRetrieve, RedisValidationRetrieve):
+
+    @property
+    def both(self) -> Dict[str, Any]:
+        """
+        Headers: Headers which is merged with response model && language models of event
+        Validation: Validation of event which is merged with response model && language models of event
+        """
+        return {"headers": self.header, "validation": self.validation}
+
+
+class RetrieveValidation(BaseRouteModel):
+
+    @classmethod
+    def retrieve_validation(cls, data: Any):
+        """
+        Retrieve validation by event function code
+        """
+        if (
+            getattr(data, "asked_field", "")
+            not in ValidationsConfig.SUPPORTED_VALIDATIONS
+        ):
+            raise ValueError(
+                f"Invalid asked field please retry with valid fields {ValidationsConfig.SUPPORTED_VALIDATIONS}"
+            )
+
+        reachable_codes = []
+        if cls.context_retriever.token.is_employee:
+            reachable_codes = (
+                cls.context_retriever.token.selected_company.reachable_event_codes
+            )
+        elif cls.context_retriever.token.is_occupant:
+            reachable_codes = (
+                cls.context_retriever.token.selected_occupant.reachable_event_codes
+            )
+
+        validate_dict = dict(url=data.url, reachable_code=reachable_codes)
+        if data.asked_field == "all":
+            return ValidationsBoth(**validate_dict).both
+        elif data.asked_field == "headers":
+            return RedisHeaderRetrieve(**validate_dict).header
+        elif data.asked_field == "validation":
+            return RedisValidationRetrieve(**validate_dict).validation
+
+
+class RetrievePage(BaseRouteModel):
+
+    @staticmethod
+    def get_site_cluster(page_name: str):
+        """
+        /dashboard?site=clusterName retrieves clusterName
+        """
+        if page_name:
+            return page_name.split("?")[1].split("=")[1]
+        raise ValueError("Page name not found")
+
+    @classmethod
+    def retrieve_cluster(cls, data: Any):
+        """
+        Retrieve cluster by event function code
+        """
+        reachable_codes = []
+        if cls.context_retriever.token.is_employee:
+            reachable_codes = (
+                cls.context_retriever.token.selected_company.reachable_event_codes
+            )
+        elif cls.context_retriever.token.is_occupant:
+            reachable_codes = (
+                cls.context_retriever.token.selected_occupant.reachable_event_codes
+            )
+        validate_dict = dict(url=data.url, reachable_code=reachable_codes)
+        print("validate_dict", validate_dict)
+        cluster_name = data.get("name")
+        print("cluster_name", cluster_name)
+        raise NotImplementedError("Cluster not found")
+
+    @classmethod
+    def retrieve_page(cls, data: Any):
+        """
+        Retrieve page by event function code
+        """
+        from Events.Engine import CategoryCluster
+        from Events.JustEvents.events_file import retrieve_cluster_by_name
+
+        reachable_codes = []
+        if cls.context_retriever.token.is_employee:
+            reachable_codes = (
+                cls.context_retriever.token.selected_company.reachable_event_codes
+            )
+        elif cls.context_retriever.token.is_occupant:
+            reachable_codes = (
+                cls.context_retriever.token.selected_occupant.reachable_event_codes
+            )
+        cluster_from_all_events = cls.get_site_cluster(page_name=data.page)
+        if not cluster_from_all_events:
+            raise ValueError(f"Cluster not found : {data.page}")
+
+        cluster_name: CategoryCluster = retrieve_cluster_by_name(cluster_from_all_events)
+        if not cluster_name:
+            raise ValueError("Cluster not found")
+
+        page_info = cluster_name.retrieve_page_info().get(data.page, None)
+        if not page_info:
+            raise ValueError("Page not found")
+
+        endpoints: dict = dict(page_info).get("endpoints", {})
+        if not endpoints:
+            raise ValueError("Endpoints not found")
+
+        new_page_info_dict = dict(
+            name=cluster_name.name,
+            prefix=cluster_name.PREFIX,
+            url=dict(page_info).get("url", None),
+            icon=dict(page_info).get("icon", None),
+            mapping=cluster_name.MAPPING,
+            page_info=dict(page_info).get("page_info", None),
+            endpoints={},
+            language_models={},
+            instructions={},
+        )
+        for key, event_codes in dict(endpoints).items():
+            # Meaning client can reach this endpoint [] & [] intersection
+            if set(event_codes) & set(reachable_codes):
+                language_models = dict(page_info).get("language_models", {})
+                instructions = dict(page_info).get("instructions", {})
+                new_page_info_dict["endpoints"][key] = True
+                if language_models.get(key, None):
+                    if key in language_models[key].keys():   # key has sub key blocks inside lang model
+                        for key_model, val_model in dict(language_models[key]).items():
+                            if key_model in new_page_info_dict["endpoints"].keys():
+                                new_page_info_dict["language_models"][key_model] = language_models[key][key_model]
+                    else:
+                        new_page_info_dict["language_models"][key] = language_models[key]
+                if instructions.get(key, None):
+                    new_page_info_dict["instructions"][key] = instructions.get(key, None)
+        return new_page_info_dict

Events/AllEvents/validations/validation/info.py

@@ -0,0 +1,11 @@
+from Events.Engine.abstract_class import PageInfo
+
+
+template_page_info = PageInfo(
+    name="template",
+    title={"en": "template"},
+    description={"en": "template"},
+    icon="",
+    parent="",
+    url="",
+)

Events/AllEvents/validations/validation/models.py

@@ -0,0 +1,19 @@
+"""
+Validation records request and response models.
+"""
+
+from typing import Optional
+from pydantic import BaseModel
+
+
+class ValidationsPydantic(BaseModel):
+    event_code: str
+    asked_field: Optional[str] = "all"
+
+
+class ClusterPydantic(BaseModel):
+    name: str
+
+
+class PagePydantic(BaseModel):
+    page: str

Events/AllEvents/validations/validation/validation.py

@@ -0,0 +1,119 @@
+"""
+Validation related API endpoints.
+"""
+
+from typing import Any, Dict
+from fastapi import Request
+
+from Events.Engine.abstract_class import MethodToEvent
+from Events.base_request_model import EndpointBaseRequestModel, ContextRetrievers
+from ApiLayers.Middleware.auth_middleware import MiddlewareModule
+
+from .api_events import validation_event, menu_event, cluster_event, page_event
+from .function_handlers import RetrieveValidation, RetrievePage
+
+
+ValidationEventMethods = MethodToEvent(
+    name="ValidationEventMethods",
+    events={validation_event.key: validation_event},
+    headers=[],
+    errors=[],
+    url="/validations",
+    method="POST",
+    decorators_list=[MiddlewareModule.auth_required],
+    summary="Get Validations by event function code",
+    description="Get Validations by event function code by All, Header, Validation & request url",
+)
+
+
+def validations_endpoint(
+    request: Request, data: EndpointBaseRequestModel
+) -> Dict[str, Any]:
+    function = ValidationEventMethods.retrieve_event(
+        event_function_code=f"{validation_event.key}"
+    )
+    data = function.REQUEST_VALIDATOR(**data.data)
+    RetrieveValidation.context_retriever = ContextRetrievers(func=validations_endpoint)
+    return function.endpoint_callable(request=request, data=data)
+
+
+ValidationEventMethods.endpoint_callable = validations_endpoint
+
+
+MenuEventMethods = MethodToEvent(
+    name="MenuEventMethods",
+    events={menu_event.key: menu_event},
+    headers=[],
+    errors=[],
+    url="/menu",
+    method="POST",
+    decorators_list=[MiddlewareModule.auth_required],
+    summary="Get Left Menu of the user",
+    description="Get Left Menu of the user",
+)
+
+
+def menu_endpoint(request: Request, data: EndpointBaseRequestModel) -> Dict[str, Any]:
+    function = MenuEventMethods.retrieve_event(
+        event_function_code=f"{menu_event.key}"
+    )
+    data = function.REQUEST_VALIDATOR(**data.data)
+    RetrieveValidation.context_retriever = ContextRetrievers(func=menu_endpoint)
+    return function.endpoint_callable(request=request, data=data)
+
+
+MenuEventMethods.endpoint_callable = menu_endpoint
+
+
+# Cluster Event
+ClusterEventMethods = MethodToEvent(
+    name="ClusterEventMethods",
+    events={cluster_event.key: cluster_event},
+    headers=[],
+    errors=[],
+    url="/cluster",
+    method="POST",
+    decorators_list=[MiddlewareModule.auth_required],
+    summary="Get Left Menu of the user",
+    description="Get Left Menu of the user",
+)
+
+
+def cluster_endpoint(
+    request: Request, data: EndpointBaseRequestModel
+) -> Dict[str, Any]:
+    function = ClusterEventMethods.retrieve_event(
+        event_function_code=f"{cluster_event.key}"
+    )
+    data = function.REQUEST_VALIDATOR(**data.data)
+    RetrievePage.context_retriever = ContextRetrievers(func=cluster_endpoint)
+    return function.endpoint_callable(request=request, data=data)
+
+
+ClusterEventMethods.endpoint_callable = cluster_endpoint
+
+
+# Page Event
+PageEventMethods = MethodToEvent(
+    name="PageEventMethods",
+    events={page_event.key: page_event},
+    headers=[],
+    errors=[],
+    url="/page",
+    method="POST",
+    decorators_list=[MiddlewareModule.auth_required],
+    summary="Get Left Menu of the user",
+    description="Get Left Menu of the user",
+)
+
+
+def page_endpoint(request: Request, data: EndpointBaseRequestModel) -> Dict[str, Any]:
+    function = PageEventMethods.retrieve_event(
+        event_function_code=f"{page_event.key}"
+    )
+    data = function.REQUEST_VALIDATOR(**data.data)
+    RetrievePage.context_retriever = ContextRetrievers(func=page_endpoint)
+    return function.endpoint_callable(request=request, data=data)
+
+
+PageEventMethods.endpoint_callable = page_endpoint