everysk-lib 1.8.14__tar.gz → 1.8.16__tar.gz

{everysk_lib-1.8.14/src/everysk_lib.egg-info → everysk_lib-1.8.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: everysk-lib
-Version: 1.8.14
+Version: 1.8.16
 Summary: Generic lib to share python code on Everysk.
 License-Expression: LicenseRef-Proprietary
 Project-URL: Homepage, https://everysk.com/

everysk_lib-1.8.16/src/everysk/sdk/entities/secrets/base.py

@@ -0,0 +1,123 @@
+# -*- coding: utf_8 -*-
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from typing import Any
+
+from everysk.config import settings
+from everysk.core.exceptions import FieldValueError
+from everysk.core.fields import DictField, ListField, StrField
+from everysk.core.object import BaseDict
+from everysk.sdk.entities.base import BaseEntity
+from everysk.sdk.entities.fields import EntityDescriptionField, EntityNameField
+
+
+###############################################################################
+#   Secrets Class Implementation
+###############################################################################
+class Secrets(BaseEntity):
+    _orderable_attributes = ListField(default=['created_on', 'updated_on', 'name'], readonly=True)
+
+    id = StrField(regex=settings.SECRETS_ID_REGEX, required_lazy=True, empty_is_none=True)
+
+    name = EntityNameField()
+    description = EntityDescriptionField()
+    data = DictField(required_lazy=True, empty_is_none=True)
+
+    def to_dict(self, add_class_path: bool = False, recursion: bool = False) -> dict:
+        """
+        Convert the entity to a dictionary.
+
+        Args:
+            add_class_path (bool): If True, include the class path in the dictionary. Defaults to False.
+            recursion (bool): If True, recursively convert nested entities to dictionaries. Defaults to False.
+
+        Returns:
+            dict: The entity as a dictionary.
+        """
+        dct = super().to_dict(add_class_path, recursion)
+
+        if add_class_path is False and self.data and isinstance(self.data, BaseDict):
+            dct['data'] = self.data.to_dict()
+
+        return dct
+
+    @staticmethod
+    def get_id_prefix() -> str:
+        """Get the ID prefix for the Secrets entity."""
+        return settings.SECRETS_ID_PREFIX
+
+    def _validate_data(self) -> None:
+        """Validates the data field."""
+        if not self.data:
+            raise FieldValueError('data is required')
+
+        if not isinstance(self.data, dict):
+            raise FieldValueError('data must be a dictionary of version to Secret')
+
+    def validate(self) -> bool:
+        """
+        Validate the entity properties.
+
+        Raises:
+            FieldValueError: If the entity properties are invalid.
+            RequiredFieldError: If a required field is missing.
+
+        Returns:
+            bool: True if the entity properties are valid, False otherwise.
+
+        Example usage:
+            >>> entity = Secrets()
+            >>> entity.validate()
+            Traceback (most recent call last):
+                ...
+            everysk.sdk.exceptions.RequiredFieldError: The field 'name' is required.
+        """
+        super().validate()
+        self._validate_data()
+        return True
+
+    @classmethod
+    def _split_path(cls, path: str) -> tuple[str, list[str]]:
+        """
+        Split a path into id and keys.
+
+        Args:
+            path (str): The path to split.
+
+        Returns:
+            tuple[str, list[str]]: The id and keys.
+
+        Raises:
+            ValueError: If the path is invalid.
+        """
+        if not path or not isinstance(path, str) or '.' not in path:
+            raise ValueError('Invalid path format. Expected format: "<secret_id>.<key1>.<key2>..."')
+
+        values: list[str] = path.split('.')
+        id, keys = values[0], values[1:]
+
+        if cls.validate_id(id) is False:
+            raise ValueError(f'Invalid id format: {id}')
+
+        return id, keys
+
+    @classmethod
+    def value_from_path(cls, path: str) -> Any:
+        """
+        Retrieve a value from a given path.
+
+        Args:
+            path (str): The path to retrieve the value from.
+
+        Returns:
+            Any: The value retrieved from the path.
+        """
+        _, _ = cls._split_path(path)
+        return cls.get_response(params={'path': path})

everysk_lib-1.8.16/src/everysk/sdk/entities/secrets/settings.py

@@ -0,0 +1,17 @@
+###############################################################################
+#
+# (C) Copyright 2023 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.core.fields import IntField, RegexField, StrField
+
+###############################################################################
+#   Settings Implementation
+###############################################################################
+SECRETS_ID_PREFIX = StrField(default='scrt_', readonly=True)
+SECRETS_ID_REGEX = RegexField(default=r'^scrt_[a-zA-Z0-9]{25}', readonly=True)
+SECRETS_ID_MAX_LENGTH = IntField(default=30, readonly=True)  # len(SECRETS_ID_PREFIX) + ENTITY_ID_LENGTH

{everysk_lib-1.8.14 → everysk_lib-1.8.16}/src/everysk/sdk/settings.py

@@ -49,6 +49,7 @@ EVERYSK_SDK_ENTITIES_MODULES_PATH = DictField(
         'WorkerExecution': 'everysk.sdk.entities.worker_execution.base.WorkerExecution',
         'WorkflowExecution': 'everysk.sdk.entities.workflow_execution.base.WorkflowExecution',
         'Workspace': 'everysk.sdk.entities.workspace.base.Workspace',
+        'Secrets': 'everysk.sdk.entities.secrets.base.Secrets',
     },
     readonly=True,
 )

{everysk_lib-1.8.14 → everysk_lib-1.8.16}/src/everysk/sdk/tests.py

@@ -1,3 +1,4 @@
+# ruff: noqa: F401
 ###############################################################################
 #
 # (C) Copyright 2023 EVERYSK TECHNOLOGIES
@@ -13,74 +14,76 @@
 try:
     from everysk.sdk._tests.base import TestBaseSDK as EveryskLibTestBaseSDK
     from everysk.sdk._tests.init import SDKInitTestCase as EveryskLibSDKInitTestCase
-    from everysk.sdk._tests.serialize import (
-        SerializeDumpsSDKTestCase as EveryskLibSerializeDumpsSDKTestCase,
-        SerializeLoadsSDKTestCase as EveryskLibSerializeLoadsSDKTestCase
-    )
+    from everysk.sdk._tests.serialize import SerializeDumpsSDKTestCase as EveryskLibSerializeDumpsSDKTestCase
+    from everysk.sdk._tests.serialize import SerializeLoadsSDKTestCase as EveryskLibSerializeLoadsSDKTestCase
     from everysk.sdk._tests.worker_base import WorkerBaseTestCase as EveryskLibWorkerBaseTestCase
-
-    from everysk.sdk.entities._tests.init import InitTestCase as EveryskLibInitTestCase
-
+    from everysk.sdk.engines._tests.cache import CacheTestCase as EveryskLibCacheTestCase
+    from everysk.sdk.engines._tests.compliance import ComplianceTestCase as EveryskLibComplianceTestCase
     from everysk.sdk.engines._tests.cryptography import TestCryptography as EveryskLibTestCryptography
     from everysk.sdk.engines._tests.init import EnginesInitTestCase as EveryskLibEnginesInitTestCase
-    from everysk.sdk.engines._tests.compliance import ComplianceTestCase as EveryskLibComplianceTestCase
-    from everysk.sdk.engines._tests.cache import CacheTestCase as EveryskLibCacheTestCase
-    from everysk.sdk.engines._tests.market_data import (
-        MarketDataTestCase as EveryskLibMarketDataTestCase,
-        MarketDataPublicTestCase as EveryskLibMarketDataPublicTestCase
-    )
     from everysk.sdk.engines._tests.lock import UserLockTestCase as EveryskLibUserLockTestCase
+    from everysk.sdk.engines._tests.market_data import MarketDataPublicTestCase as EveryskLibMarketDataPublicTestCase
     from everysk.sdk.engines._tests.market_data import MarketDataTestCase as EveryskLibMarketDataTestCase
-
+    from everysk.sdk.engines.expression.functions.tests.base import (
+        FunctionsBaseTestCase as EveryskLibFunctionsBaseTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.date import (
+        FunctionsDateTestCase as EveryskLibFunctionsDateTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.list import (
+        FunctionsListTestCase as EveryskLibFunctionsListTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.logic import (
+        FunctionsLogicTestCase as EveryskLibFunctionsLogicTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.math import (
+        FunctionsMathTestCase as EveryskLibFunctionsMathTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.miscellaneous import (
+        FunctionsMiscellaneousTestCase as EveryskLibFunctionsMiscellaneousTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.functions.tests.string import (
+        FunctionsStringTestCase as EveryskLibFunctionsStringTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.tests.base import (
+        ExpressionEngineTestCase as EveryskLibExpressionEngineTestCaseNew,
+    )
+    from everysk.sdk.engines.expression.tests.interpreter import InterpreterTestCase as EveryskLibInterpreterTestCaseNew
+    from everysk.sdk.engines.expression.tests.validator import ValidatorTestCase as EveryskLibValidatorTestCaseNew
+    from everysk.sdk.engines.helpers.tests.algorithms import NpSortTestCase as EveryskLibHelpersNpSortTestCase
+    from everysk.sdk.engines.helpers.tests.algorithms import NpUniqueTestCase as EveryskLibHelpersNpUniqueTestCase
+    from everysk.sdk.entities._tests.base import TestBaseEntity as EveryskLibTestBaseEntity
     from everysk.sdk.entities._tests.base_list import TestEntityList as EveryskLibTestEntityList
-
+    from everysk.sdk.entities._tests.fields import TestBaseCurrencyField as EveryskLibTestBaseCurrencyField
+    from everysk.sdk.entities._tests.fields import TestEntityDateTimeField as EveryskLibTestEntityDateTimeField
+    from everysk.sdk.entities._tests.fields import TestEntityDescriptionField as EveryskLibTestEntityDescriptionField
+    from everysk.sdk.entities._tests.fields import TestEntityLinkUIDField as EveryskLibTestEntityLinkUIDField
+    from everysk.sdk.entities._tests.fields import TestEntityNameField as EveryskLibTestEntityNameField
+    from everysk.sdk.entities._tests.fields import TestEntityTagsField as EveryskLibTestEntityTagsField
+    from everysk.sdk.entities._tests.fields import TestEntityWorkspaceField as EveryskLibTestEntityWorkspaceField
+    from everysk.sdk.entities._tests.init import InitTestCase as EveryskLibInitTestCase
+    from everysk.sdk.entities._tests.query import QueryTestCase as EveryskLibQueryTestCase
     from everysk.sdk.entities._tests.script import ScriptTestCase as EveryskLibScriptTestCase
-    from everysk.sdk.entities._tests.base import TestBaseEntity as EveryskLibTestBaseEntity
     from everysk.sdk.entities._tests.tags import TagsTestCase as EveryskLibTestTagsList
-    from everysk.sdk.entities._tests.query import QueryTestCase as EveryskLibQueryTestCase
-
-    from everysk.sdk.entities.portfolio._tests.security import TestSecurity as EveryskLibTestSecurity
-    from everysk.sdk.entities.portfolio._tests.securities import TestSecurities as EveryskLibTestSecurities
-    from everysk.sdk.entities.portfolio._tests.base import (
-        TestSecuritiesField as EveryskLibTestTestSecuritiesField,
-        TestPortfolio as EveryskLibTestPortfolio
-    )
-
-    from everysk.sdk.entities._tests.fields import (
-        TestBaseCurrencyField as EveryskLibTestBaseCurrencyField,
-        TestEntityTagsField as EveryskLibTestEntityTagsField,
-        TestEntityNameField as EveryskLibTestEntityNameField,
-        TestEntityDescriptionField as EveryskLibTestEntityDescriptionField,
-        TestEntityLinkUIDField as EveryskLibTestEntityLinkUIDField,
-        TestEntityWorkspaceField as EveryskLibTestEntityWorkspaceField,
-        TestEntityDateTimeField as EveryskLibTestEntityDateTimeField
-    )
-
     from everysk.sdk.entities.custom_index._tests.base import CustomIndexTestCase as EveryskLibCustomIndexTestCase
     from everysk.sdk.entities.datastore.tests.base import DatastoreTestCase as EveryskLibDatastoreTestCase
-    from everysk.sdk.entities.private_security._tests.base import PrivateSecurityTestCase as EveryskLibPrivateSecurityTestCase
     from everysk.sdk.entities.file._tests.base import FileTestCase as EveryskLibFileTestCase
+    from everysk.sdk.entities.portfolio._tests.base import TestPortfolio as EveryskLibTestPortfolio
+    from everysk.sdk.entities.portfolio._tests.base import TestSecuritiesField as EveryskLibTestTestSecuritiesField
+    from everysk.sdk.entities.portfolio._tests.securities import TestSecurities as EveryskLibTestSecurities
+    from everysk.sdk.entities.portfolio._tests.security import TestSecurity as EveryskLibTestSecurity
+    from everysk.sdk.entities.private_security._tests.base import (
+        PrivateSecurityTestCase as EveryskLibPrivateSecurityTestCase,
+    )
     from everysk.sdk.entities.report.tests.base import ReportTestCase as EveryskLibReportTestCase
-    from everysk.sdk.entities.worker_execution.tests.base import WorkerExecutionTestCase as EveryskLibWorkerExecutionTestCase
-    from everysk.sdk.entities.workflow_execution.tests.base import WorkflowExecutionTestCase as EveryskLibWorkflowExecutionTestCase
-    from everysk.sdk.entities.workspace._tests.base import TestWorkspace as EveryskLibTestWorkspace
-
-    from everysk.sdk.engines.helpers.tests.algorithms import (
-        NpUniqueTestCase as EveryskLibHelpersNpUniqueTestCase,
-        NpSortTestCase as EveryskLibHelpersNpSortTestCase
+    from everysk.sdk.entities.secrets.tests.base import SecretsTestCase as EveryskLibSecretsTestCase
+    from everysk.sdk.entities.worker_execution.tests.base import (
+        WorkerExecutionTestCase as EveryskLibWorkerExecutionTestCase,
     )
-
-    from everysk.sdk.engines.expression.tests.base import ExpressionEngineTestCase as EveryskLibExpressionEngineTestCaseNew
-    from everysk.sdk.engines.expression.tests.validator import ValidatorTestCase as EveryskLibValidatorTestCaseNew
-    from everysk.sdk.engines.expression.tests.interpreter import InterpreterTestCase as EveryskLibInterpreterTestCaseNew
-
-    from everysk.sdk.engines.expression.functions.tests.base import FunctionsBaseTestCase as EveryskLibFunctionsBaseTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.date import FunctionsDateTestCase as EveryskLibFunctionsDateTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.list import FunctionsListTestCase as EveryskLibFunctionsListTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.math import FunctionsMathTestCase as EveryskLibFunctionsMathTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.string import FunctionsStringTestCase as EveryskLibFunctionsStringTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.miscellaneous import FunctionsMiscellaneousTestCase as EveryskLibFunctionsMiscellaneousTestCaseNew
-    from everysk.sdk.engines.expression.functions.tests.logic import FunctionsLogicTestCase as EveryskLibFunctionsLogicTestCaseNew
+    from everysk.sdk.entities.workflow_execution.tests.base import (
+        WorkflowExecutionTestCase as EveryskLibWorkflowExecutionTestCase,
+    )
+    from everysk.sdk.entities.workspace._tests.base import TestWorkspace as EveryskLibTestWorkspace
 
 except ModuleNotFoundError as error:
     # This will prevent running these tests if requests is not installed

{everysk_lib-1.8.14 → everysk_lib-1.8.16/src/everysk_lib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: everysk-lib
-Version: 1.8.14
+Version: 1.8.16
 Summary: Generic lib to share python code on Everysk.
 License-Expression: LicenseRef-Proprietary
 Project-URL: Homepage, https://everysk.com/

{everysk_lib-1.8.14 → everysk_lib-1.8.16}/src/everysk_lib.egg-info/SOURCES.txt

@@ -101,6 +101,8 @@ src/everysk/sdk/entities/private_security/base.py
 src/everysk/sdk/entities/private_security/settings.py
 src/everysk/sdk/entities/report/base.py
 src/everysk/sdk/entities/report/settings.py
+src/everysk/sdk/entities/secrets/base.py
+src/everysk/sdk/entities/secrets/settings.py
 src/everysk/sdk/entities/worker_execution/base.py
 src/everysk/sdk/entities/worker_execution/settings.py
 src/everysk/sdk/entities/workflow_execution/base.py