automizor 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

automizor/__init__.py

@@ -1 +1 @@
-version = "0.3.0"
+version = "0.3.1"

automizor/vault/__init__.py

@@ -1,7 +1,7 @@
 from functools import lru_cache
 
+from ._container import SecretContainer
 from ._exceptions import AutomizorVaultError
-from ._secret import Secret
 
 
 @lru_cache
@@ -11,7 +11,7 @@ def _get_vault():
     return Vault()
 
 
-def get_secret(name: str) -> Secret:
+def get_secret(name: str) -> SecretContainer:
     """
     Retrieves a secret by its name. Fetches from a local file or queries the
     `Automizor API`, based on configuration.
@@ -30,7 +30,7 @@ def get_secret(name: str) -> Secret:
     return vault.get_secret(name)
 
 
-def set_secret(secret: Secret) -> Secret:
+def set_secret(secret: SecretContainer) -> SecretContainer:
     """
     Updates an existing secret. Updates to a local file or to the
     `Automizor API`, based on configuration.
@@ -51,7 +51,7 @@ def set_secret(secret: Secret) -> Secret:
 
 __all__ = [
     "AutomizorVaultError",
-    "Secret",
+    "SecretContainer",
     "get_secret",
     "set_secret",
 ]

automizor/vault/_container.py

@@ -0,0 +1,68 @@
+from dataclasses import dataclass, fields
+
+
+def ignore_extra_fields(cls):
+    original_post_init = getattr(cls, "__post_init__", None)
+
+    def __init__(self, **kwargs):
+        cls_fields = {field.name: field for field in fields(cls)}
+        for name, value in kwargs.items():
+            if name in cls_fields:
+                setattr(self, name, value)
+        if original_post_init:
+            original_post_init(self)
+
+    setattr(cls, "__init__", __init__)
+    return cls
+
+
+@ignore_extra_fields
+@dataclass
+class SecretContainer:
+    """
+    Represents a secret, comprising a name and its associated values.
+
+    Attributes:
+        description: A description of the secret.
+        name: The name of the secret.
+        value: The secret's values, stored in a dictionary as key-value pairs.
+    """
+
+    name: str
+    value: dict
+    description: str = ""
+
+    def get(self, key, default=None):
+        """Return the value for key if key is in the dictionary, else default."""
+        return self.value.get(key, default)
+
+    def items(self):
+        """Secret.items() -> a set-like object providing a view on secret's items."""
+        return self.value.items()
+
+    def keys(self):
+        """Secret.keys() -> a set-like object providing a view on secret's keys."""
+        return self.value.keys()
+
+    def update(self, pairs: dict) -> None:
+        """Update the secret's dictionary with the key-value pairs from pairs."""
+        self.value.update(pairs)
+
+    def __getitem__(self, key):
+        return self.value[key]
+
+    def __setitem__(self, key, value):
+        self.value[key] = value
+
+    def __contains__(self, key):
+        return key in self.value
+
+    def __iter__(self):
+        return iter(self.value)
+
+    def __len__(self):
+        return len(self.value)
+
+    def __repr__(self):
+        keys = ", ".join(self.keys())
+        return f"Secret(name={self.name}, keys=[{keys}])"

automizor/vault/_vault.py

@@ -4,8 +4,8 @@ from dataclasses import asdict
 
 import requests
 
+from ._container import SecretContainer
 from ._exceptions import AutomizorVaultError
-from ._secret import Secret
 
 
 class Vault:
@@ -67,7 +67,7 @@ class Vault:
             }
         )
 
-    def get_secret(self, name) -> Secret:
+    def get_secret(self, name) -> SecretContainer:
         """
         Retrieves a secret by its name. Fetches from a local file or queries the
         `Automizor API`, based on configuration.
@@ -86,7 +86,7 @@ class Vault:
             return self._read_file_secret(name)
         return self._read_vault_secret(name)
 
-    def set_secret(self, secret: Secret) -> Secret:
+    def set_secret(self, secret: SecretContainer) -> SecretContainer:
         """
         Updates an existing secret. Updates to a local file or to the
         `Automizor API`, based on configuration.
@@ -105,22 +105,22 @@ class Vault:
             return self._write_file_secret(secret)
         return self._write_vault_secret(secret)
 
-    def _read_file_secret(self, name: str) -> Secret:
+    def _read_file_secret(self, name: str) -> SecretContainer:
         with open(self._secret_file, "r", encoding="utf-8") as file:
             secrets = json.load(file)
             value = secrets.get(name, {})
-        return Secret(name=name, value=value)
+        return SecretContainer(name=name, value=value)
 
-    def _read_vault_secret(self, name: str) -> Secret:
+    def _read_vault_secret(self, name: str) -> SecretContainer:
         url = f"https://{self._api_host}/api/v1/vault/secret/{name}/"
         try:
             response = self.session.get(url, timeout=10)
             response.raise_for_status()
-            return Secret(**response.json())
+            return SecretContainer(**response.json())
         except Exception as exc:
             raise AutomizorVaultError(f"Failed to get secret: {exc}") from exc
 
-    def _write_file_secret(self, secret: Secret):
+    def _write_file_secret(self, secret: SecretContainer):
         with open(self._secret_file, "r+", encoding="utf-8") as file:
             secrets = json.load(file)
             secrets[secret.name] = secret.value
@@ -129,11 +129,11 @@ class Vault:
             file.truncate()
         return secret
 
-    def _write_vault_secret(self, secret: Secret) -> Secret:
+    def _write_vault_secret(self, secret: SecretContainer) -> SecretContainer:
         url = f"https://{self._api_host}/api/v1/vault/secret/{secret.name}/"
         try:
             response = self.session.put(url, timeout=10, json=asdict(secret))
             response.raise_for_status()
-            return Secret(**response.json())
+            return SecretContainer(**response.json())
         except Exception as exc:
             raise AutomizorVaultError(f"Failed to set secret: {exc}") from exc

{automizor-0.3.0.dist-info → automizor-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: automizor
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python Automizor framework
 Home-page: https://github.com/automizor/automizor
 Author: Christian Fischer

{automizor-0.3.0.dist-info → automizor-0.3.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-automizor/__init__.py,sha256=EqIccytbgmIh3EOfv7QIiksdjJSlB-o2LbyXxRtoMGs,18
+automizor/__init__.py,sha256=sEAhGxRzEBE5t0VjAcJ-336II62pGIQ0eLrs42I-sGU,18
 automizor/job.py,sha256=L2NkM-BkvJpeO_SH0BMgternD9M83K_Yv_ANhf1k3FI,4354
 automizor/storage.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 automizor/vault.py,sha256=mluaCcJCMxu2g0iTBJ6ntoZATn8eotfZb4rdzWsBslU,5845
@@ -8,12 +8,13 @@ automizor/job/_job.py,sha256=NkoNnJxmdkqdF-Qxm4taal-Go0COVFo57tZAaWM1ihI,5365
 automizor/storage/__init__.py,sha256=KuWO-Pb4FQXj68Ewv8QZR9XeKsROCR-wusdWf0osaLw,1674
 automizor/storage/_exceptions.py,sha256=LOtgshWg3gOFhDZlcMWhXLT_q11zpTBEA85NqKnSi4A,129
 automizor/storage/_storage.py,sha256=IwTw6PYYNwJtGI4ZfiqY0-SkgCoaYnykkP_hHVuy9IU,5777
-automizor/vault/__init__.py,sha256=37KiP4K9y6rphpzW7xAlnQiLjubRBfxzkH_kNRSNg2k,1092
+automizor/vault/__init__.py,sha256=Y3FsdG5cdksVO8nBzIPt8Wwxg8VkFtkpu-kn1xWxrGo,1140
+automizor/vault/_container.py,sha256=QgTZtBQrX8wZSEjJqTkn2_S-rwIRxukdBQYIRd7md_g,1904
 automizor/vault/_exceptions.py,sha256=Wblvmaj6F0pIiTAH7X3JuxqTprUA5tvuuRAs9YgbiBI,125
 automizor/vault/_secret.py,sha256=pks_3uvD1IhYirOaZ2cAOxX2r9vzvXqLa-aDzJysreE,1136
-automizor/vault/_vault.py,sha256=d8ymE-qSHY31GDEToql9KHUQNLpMzb469MCzvtpie_U,4714
-automizor-0.3.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-automizor-0.3.0.dist-info/METADATA,sha256=olJvbx__hqQFXHeaXPlSkOzcd4vBKuFAY8Nu1lLyARg,661
-automizor-0.3.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-automizor-0.3.0.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
-automizor-0.3.0.dist-info/RECORD,,
+automizor/vault/_vault.py,sha256=G1IryuPfXeMUMoAFmGgPibD70zn307KQLNcNitd3D1A,4825
+automizor-0.3.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+automizor-0.3.1.dist-info/METADATA,sha256=SkNNe2kHyA9aGX2275j7RFOy6GqKb9eN3WwQBT3sRpM,661
+automizor-0.3.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+automizor-0.3.1.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
+automizor-0.3.1.dist-info/RECORD,,