splight-lib 5.11.5__tar.gz → 5.11.5.dev0__tar.gz

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-lib
-Version: 5.11.5
+Version: 5.11.5.dev0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-lib"
-version = "5.11.5"
+version = "5.11.5.dev0"
 description = "Splight Library"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/auth/__init__.py

@@ -1,5 +1,7 @@
+from splight_lib.auth.mac_auth import HmacSignature
 from splight_lib.auth.token import SplightAuthToken
 
 __all__ = [
+    HmacSignature,
     SplightAuthToken,
 ]

splight_lib-5.11.5.dev0/splight_lib/auth/exceptions.py

@@ -0,0 +1,12 @@
+class SignatureVerificationError(Exception):
+    def __init__(self, message, sig_header, http_body=None):
+        super(SignatureVerificationError, self).__init__(message)
+        self.sig_header = sig_header
+        self._message = message
+        self.http_body = http_body
+
+    def __repr__(self):
+        return f"{self.message} {self.http_body}"
+
+    def __str__(self):
+        return self._message

splight_lib-5.11.5.dev0/splight_lib/auth/mac_auth.py

@@ -0,0 +1,96 @@
+import hmac
+import time
+from hashlib import sha256
+
+import six
+
+from splight_lib.auth.exceptions import SignatureVerificationError
+
+
+def utf8(value):
+    if six.PY2 and isinstance(value, six.text_type):
+        return value.encode("utf-8")
+    else:
+        return value
+
+
+class HmacSignature(object):
+    EXPECTED_SCHEME = "v1"
+    DEFAULT_TOLERANCE = 300
+
+    def __init__(self, secret="", *args, **kwargs):
+        self.secret = secret
+        super().__init__(*args, **kwargs)
+
+    @staticmethod
+    def _compute_signature(payload, secret):
+        mac = hmac.new(
+            secret.encode("utf-8"),
+            msg=payload.encode("utf-8"),
+            digestmod=sha256,
+        )
+        return mac.hexdigest()
+
+    def compute_header_signature(self, payload: str):
+        """
+        Compute headers signature using hmac auth method.
+        """
+        timestamp = int(time.time())
+        signed_payload = "%d.%s" % (timestamp, payload.decode("ascii"))
+        mac_hexdigest = self._compute_signature(signed_payload, self.secret)
+        return f"t={timestamp},{self.EXPECTED_SCHEME}={mac_hexdigest}"
+
+    @staticmethod
+    def _get_timestamp_and_signatures(header, scheme):
+        list_items = [i.split("=", 2) for i in header.split(",")]
+        timestamp = int([i[1] for i in list_items if i[0] == "t"][0])
+        signatures = [i[1] for i in list_items if i[0] == scheme]
+        return timestamp, signatures
+
+    @classmethod
+    def verify_header(
+        cls, payload, header, secret, tolerance=DEFAULT_TOLERANCE
+    ):
+        if hasattr(payload, "decode"):
+            payload = payload.decode("utf-8")
+
+        try:
+            timestamp, signatures = cls._get_timestamp_and_signatures(
+                header, cls.EXPECTED_SCHEME
+            )
+        except Exception:
+            raise SignatureVerificationError(
+                "Unable to extract timestamp and signatures from header",
+                header,
+                payload,
+            )
+
+        if not signatures:
+            raise SignatureVerificationError(
+                "No signatures found with expected scheme "
+                "%s" % cls.EXPECTED_SCHEME,
+                header,
+                payload,
+            )
+
+        signed_payload = "%d.%s" % (timestamp, payload)
+        expected_sig = cls._compute_signature(signed_payload, secret)
+        if not any(
+            hmac.compare_digest(utf8(expected_sig), utf8(s))
+            for s in signatures
+        ):
+            raise SignatureVerificationError(
+                "No signatures found matching the expected signature for "
+                "payload",
+                header,
+                payload,
+            )
+
+        if tolerance and timestamp < time.time() - tolerance:
+            raise SignatureVerificationError(
+                "Timestamp outside the tolerance zone (%d)" % timestamp,
+                header,
+                payload,
+            )
+
+        return True

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/database/abstract.py

@@ -1,18 +1,19 @@
 from abc import abstractmethod
 from tempfile import NamedTemporaryFile
+from typing import Dict, List, Union
 
 from splight_lib.abstract.client import AbstractClient, QuerySet
 
 
 class AbstractDatabaseClient(AbstractClient):
     @abstractmethod
-    def save(self, resource_name: str, instance: dict) -> dict:
+    def save(self, resource_name: str, instance: Dict) -> Dict:
         pass
 
     @abstractmethod
     def _get(
         self, resource_name: str, first: bool = False, **kwargs
-    ) -> dict | list[dict]:
+    ) -> Union[Dict, List[Dict]]:
         pass
 
     def get(self, resource_name: str, *args, **kwargs) -> QuerySet:
@@ -23,5 +24,5 @@ class AbstractDatabaseClient(AbstractClient):
         pass
 
     @abstractmethod
-    def download(self, instance: dict) -> NamedTemporaryFile:
+    def download(self, instance: Dict) -> NamedTemporaryFile:
         pass

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/database/builder.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Dict
 
 from splight_lib.client.database.abstract import AbstractDatabaseClient
 from splight_lib.client.database.remote_client import RemoteDatabaseClient
@@ -6,6 +6,6 @@ from splight_lib.client.database.remote_client import RemoteDatabaseClient
 
 class DatabaseClientBuilder:
     @staticmethod
-    def build(parameters: dict[str, Any] = {}) -> AbstractDatabaseClient:
+    def build(parameters: Dict[str, Any] = {}) -> AbstractDatabaseClient:
         db_client = RemoteDatabaseClient(**parameters)
         return db_client

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/database/remote_client.py

@@ -1,5 +1,5 @@
 from tempfile import NamedTemporaryFile
-from typing import Any, Generator
+from typing import Any, Dict, Generator, List, Optional, Union
 
 import progressbar
 import requests
@@ -31,9 +31,9 @@ logger = get_splight_logger()
 
 class PaginatedResponse(TypedDict):
     count: int
-    next: str | None
-    previous: str | None
-    results: list[Any]
+    next: Optional[str]
+    previous: Optional[str]
+    results: List[Any]
 
 
 class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
@@ -66,9 +66,9 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
     def save(
         self,
         resource_name: str,
-        instance: dict,
-        files: dict[str, str] | None = None,
-    ) -> dict:
+        instance: Dict,
+        files: Optional[Dict[str, str]] = None,
+    ) -> Dict:
         """Creates or updates a resource depending on the name if
         it contains the id or not.
 
@@ -126,7 +126,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         resource_name: str,
         first: bool = False,
         **kwargs,
-    ) -> dict | list[dict]:
+    ) -> Union[Dict, List[Dict]]:
         """Retrieves one or multiple resources. If the parameter id is passed
         as a kwarg, the instance with that id will be retrieved.
 
@@ -149,7 +149,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
             )
         return instances
 
-    def operate(self, resource_name: str, instance: dict) -> dict:
+    def operate(self, resource_name: str, instance: Dict) -> Dict:
         model_name = resource_name.lower()
         api_path = CUSTOM_PATHS_MAP.get(model_name)
         if not api_path:
@@ -163,7 +163,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
 
     def _retrieve_multiple(
         self, resource_name: str, first: bool = False, **kwargs
-    ) -> list[dict]:
+    ) -> List[Dict]:
         logger.debug(f"Retrieving objects {resource_name}")
         api_path = self._get_api_path(resource_name)
         url = self._base_url / api_path
@@ -176,7 +176,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         return instances
 
     @retry(SPLIGHT_REQUEST_EXCEPTIONS, tries=3, delay=1)
-    def _retrieve_single(self, resource_name: str, id: str) -> dict:
+    def _retrieve_single(self, resource_name: str, id: str) -> Dict:
         logger.debug(f"Retrieving object {resource_name} with id {id}")
         api_path = self._get_api_path(resource_name)
         url = self._base_url / api_path / f"{id}/"
@@ -191,8 +191,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
     def download(
         self,
         resource_name: str,
-        instance: dict,
-        type_: str | None = None,
+        instance: Dict,
+        type_: Optional[str] = None,
         **kwargs,
     ) -> NamedTemporaryFile:
         """Returns the number of resources in the database for a given model
@@ -271,9 +271,9 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
     def _create(
         self,
         resource_name: str,
-        instance: dict,
-        files: dict[str, str] | None = None,
-    ) -> dict:
+        instance: Dict,
+        files: Optional[Dict[str, str]] = None,
+    ) -> Dict:
         logger.debug("Saving new instance", tags=LogTags.DATABASE)
         model_name = resource_name.lower()
         api_path = self._get_api_path(resource_name)
@@ -305,9 +305,9 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         self,
         resource_name: str,
         resource_id: str,
-        instance: dict,
-        files: dict[str, str] | None = None,
-    ) -> dict:
+        instance: Dict,
+        files: Optional[Dict[str, str]] = None,
+    ) -> Dict:
         logger.debug("Saving instance %s", resource_id, tags=LogTags.DATABASE)
         model_name = resource_name.lower()
         api_path = self._get_api_path(resource_name)
@@ -323,7 +323,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
             raise RequestError(response.status_code, response.text)
         return response.json()
 
-    def _create_file(self, instance: dict, url: furl):
+    def _create_file(self, instance: Dict, url: furl):
         response = self._restclient.post(url, data=instance)
         if response.is_error:
             raise RequestError(response.status_code, response.text)
@@ -333,7 +333,7 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         self._upload_file(created_instance, file_path=file_path)
         return created_instance
 
-    def _upload_file(self, instance: dict, file_path: str):
+    def _upload_file(self, instance: Dict, file_path: str):
         api_path = self._get_api_path("file")
         resource_id = instance.get("id")
         url = self._base_url / api_path / f"{resource_id}/upload_url/"
@@ -358,9 +358,9 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
     def upload(
         self,
         resource_name: str,
-        instance: dict,
+        instance: Dict,
         file_path: str,
-        type_: str | None = None,
+        type_: Optional[str] = None,
     ):
         api_path = self._get_api_path(resource_name)
         resource_id = instance.get("id")

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/datalake/buffer.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timezone
+from typing import Dict, List
 
 
 class DatalakeDocumentBuffer:
@@ -7,13 +8,13 @@ class DatalakeDocumentBuffer:
     def __init__(self, buffer_size: int, buffer_timeout: float):
         self._size = buffer_size
         self._timeout = buffer_timeout
-        self._buffer: list[dict] = []
+        self._buffer: List[Dict] = []
         self._last_flush = datetime.now(timezone.utc)
 
         self.reset()
 
     @property
-    def data(self) -> list[dict]:
+    def data(self) -> List[Dict]:
         """Retrieves the buffer data
 
         Returns
@@ -44,7 +45,7 @@ class DatalakeDocumentBuffer:
         self._last_flush = datetime.now(timezone.utc)
         self._buffer = []
 
-    def add_documents(self, documents: list[dict]):
+    def add_documents(self, documents: List[Dict]):
         """Adds new documents to the buffer.
 
         Parameters

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/datalake/builder.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Dict
 
 from splight_lib.client.datalake.abstract import AbstractDatalakeClient
 from splight_lib.client.datalake.remote_client import (
@@ -19,6 +19,6 @@ class DatalakeClientBuilder:
     @staticmethod
     def build(
         dl_client_type: DatalakeClientType = DatalakeClientType.BUFFERED_ASYNC,
-        parameters: dict[str, Any] = {},
+        parameters: Dict[str, Any] = {},
     ) -> AbstractDatalakeClient:
         return DL_CLIENT_TYPE_MAP[dl_client_type](**parameters)

splight_lib-5.11.5.dev0/splight_lib/client/file_handler.py

@@ -0,0 +1,34 @@
+import os
+from typing import List
+
+
+class FixedLineNumberFileHandler:
+    def __init__(self, file_path: str, total_lines: int = 10000):
+        self._file_path = file_path
+        if not os.path.exists(self._file_path):
+            self._write_file([])
+        self._total_lines = total_lines
+
+    def write(self, lines: List[str], override=False):
+        all_lines = self._read_file()
+
+        if override:
+            all_lines = lines
+        else:
+            all_lines.extend(lines)
+
+        lines = all_lines[-self._total_lines :]
+        lines = [f"{x}\n" for x in lines]
+        self._write_file(lines)
+
+    def read(self) -> List[str]:
+        return self._read_file()
+
+    def _write_file(self, lines: List[str]):
+        with open(self._file_path, "w") as fid:
+            fid.writelines(lines)
+
+    def _read_file(self) -> List[str]:
+        with open(self._file_path, "r") as fid:
+            all_lines = [x.strip() for x in fid.readlines()]
+        return all_lines

splight_lib-5.11.5.dev0/splight_lib/client/filter.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, Tuple
+
+
+def value_filter(name: str, value: Any, item: Dict):
+    satisfied = False
+    if "__icontains" in name:
+        variable_name = name.split("__")[0]
+        satisfied = value in item.get(variable_name, None)
+    elif "__in" in name:
+        variable_name = name.split("__in")[0]
+        satisfied = item.get(variable_name, None) in value
+    else:
+        satisfied = item.get(name, None) == value
+    return satisfied
+
+
+def value_filter_on_tuple(name: str, value: Any, item: Tuple[str, Dict]):
+    return value_filter(name=name, value=value, item=item[1])

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/hub/abstract.py

@@ -1,4 +1,5 @@
 from abc import abstractmethod
+from typing import Dict, List, Tuple
 
 from pydantic import BaseModel
 
@@ -16,7 +17,7 @@ class AbstractHubClient(AbstractClient):
         limit_: int = -1,
         skip_: int = 0,
         **kwargs,
-    ) -> list[BaseModel]:
+    ) -> List[BaseModel]:
         pass
 
     @abstractmethod
@@ -24,7 +25,7 @@ class AbstractHubClient(AbstractClient):
         pass
 
     @abstractmethod
-    def download(self, data: dict) -> tuple:
+    def download(self, data: Dict) -> Tuple:
         pass
 
     @abstractmethod
@@ -32,5 +33,5 @@ class AbstractHubClient(AbstractClient):
         pass
 
     @abstractmethod
-    def save(self, instance: dict) -> dict:
+    def save(self, instance: Dict) -> Dict:
         pass

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/client/hub/client.py

@@ -1,5 +1,5 @@
 from tempfile import NamedTemporaryFile
-from typing import Any, Generator, TypedDict
+from typing import Any, Dict, Generator, List, Optional, TypedDict
 
 import progressbar
 import requests
@@ -13,9 +13,9 @@ from splight_lib.client.hub.abstract import AbstractHubClient
 
 class PaginatedResponse(TypedDict):
     count: int
-    next: str | None
-    previous: str | None
-    results: list[Any]
+    next: Optional[str]
+    previous: Optional[str]
+    results: List[Any]
 
 
 class SplightHubClient(AbstractHubClient):
@@ -58,7 +58,7 @@ class SplightHubClient(AbstractHubClient):
         limit_: int = -1,
         skip_: int = 0,
         **kwargs,
-    ) -> list[BaseModel]:
+    ) -> List[BaseModel]:
         url = self._hub_url / "versions/"
         params = self._get_params(limit_, skip_, **kwargs)
         instances = []
@@ -71,14 +71,14 @@ class SplightHubClient(AbstractHubClient):
     def get_org_id(self):
         return self._org_id
 
-    def _create(self, instance: dict) -> dict:
+    def _create(self, instance: Dict) -> Dict:
         url = self._hub_url / "components/"
         response = self._session.post(url, json=instance)
         response.raise_for_status()
         instance = response.json()
         return instance
 
-    def _update(self, instance: dict) -> dict:
+    def _update(self, instance: Dict) -> Dict:
         instance_id = instance.get("id")
         url = self._hub_url / "versions" / f"{instance_id}/"
         response = self._session.put(url, json=instance)
@@ -86,12 +86,12 @@ class SplightHubClient(AbstractHubClient):
         instance = response.json()
         return instance
 
-    def build(self, id: str) -> None:
+    def build(self, id: str):
         url = self._hub_url / f"versions/{id}/build/"
         response = self._session.post(url)
         response.raise_for_status()
 
-    def upload(self, id: str, file_path: str, type_: str) -> None:
+    def upload(self, id: str, file_path: str, type_: str):
         url = self._hub_url / f"versions/{id}/upload_url/"
         params = {"type": type_}
         response = self._session.get(url, params=params)
@@ -135,7 +135,7 @@ class SplightHubClient(AbstractHubClient):
             response.status_code == 204
         ), f"Failed to delete component: {response.json()}"
 
-    def save(self, instance: dict) -> dict:
+    def save(self, instance: Dict) -> Dict:
         if instance.get("id"):
             return self._update(instance)
         else:

{splight_lib-5.11.5 → splight_lib-5.11.5.dev0}/splight_lib/component/abstract.py

@@ -5,7 +5,7 @@ from collections import namedtuple
 from tempfile import NamedTemporaryFile
 from threading import Thread
 from time import sleep
-from typing import Callable, Type
+from typing import Callable, Dict, Optional, Type
 
 from pydantic import BaseModel
 from pydantic_core import ValidationError
@@ -70,7 +70,7 @@ class HealthCheckProcessor:
 class SplightBaseComponent(ABC):
     def __init__(
         self,
-        component_id: str | None = None,
+        component_id: Optional[str] = None,
     ):
         self._component_id = component_id
         self._execution_engine = ExecutionEngine()
@@ -185,7 +185,7 @@ class SplightBaseComponent(ABC):
         return wrapper
 
     def _get_custom_type_model(
-        self, component_object: dict[str, Type[ComponentObjectInstance]]
+        self, component_object: Dict[str, Type[ComponentObjectInstance]]
     ) -> BaseModel:
         custom_type_model = namedtuple(
             "CustomTypes", [k for k in component_object.keys()]
@@ -193,7 +193,7 @@ class SplightBaseComponent(ABC):
         return custom_type_model(**component_object)
 
     def _get_routine_model(
-        self, routine_objects: dict[str, Type[RoutineObjectInstance]]
+        self, routine_objects: Dict[str, Type[RoutineObjectInstance]]
     ) -> namedtuple:
         routine_model = namedtuple(
             "ComponentRoutine", [k for k in routine_objects.keys()]
@@ -209,9 +209,9 @@ class SplightBaseComponent(ABC):
         return spec
 
     @abstractmethod
-    def start(self) -> None:
+    def start(self):
         raise NotImplementedError()
 
-    def stop(self) -> None:
+    def stop(self):
         self._execution_engine.stop()
         sys.exit(1)