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

automizor/vault/_container.py

@@ -0,0 +1,69 @@
+from dataclasses import dataclass, fields
+from typing import Any, Dict
+
+
+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[str, Any]
+    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[str, Any]) -> 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

@@ -1,42 +1,26 @@
-import json
-import os
 from dataclasses import asdict
 
 import requests
 
-from ._exceptions import AutomizorVaultError
-from ._secret import Secret
+from automizor.exceptions import AutomizorError, NotFound
+from automizor.utils import get_api_config, get_headers
+
+from ._container import SecretContainer
 
 
 class Vault:
     """
     `Vault` is a secure storage class within the `Automizor Platform` for managing
     secrets such as API keys, passwords, and other sensitive information. It offers
-    functionality to securely retrieve and update secrets, either through direct
-    interaction with the `Automizor API` or via a local secrets file, depending on
-    the operational environment and configuration.
+    functionality to securely retrieve and update secrets through direct interaction
+    with the `Automizor API`.
 
     Configuration for accessing and manipulating these secrets is driven by environment
     variables, which are essential for specifying the API's host and token for
-    authentication purposes, alongside the location of a local secrets file, should
-    local storage be preferred over API interaction.
+    authentication purposes.
 
     Environment variables requisite for operation include:
-    - ``AUTOMIZOR_API_HOST``: The host URL for the `Automizor API`.
-    - ``AUTOMIZOR_API_TOKEN``: The token for authenticate against the `Automizor API`.
-    - ``AUTOMIZOR_SECRET_FILE``: Optionally specifies the path to a local file where
-      secrets are stored, enabling operations in environments where direct API access
-      may be restricted or unavailable.
-
-    Example of a local secret file:
-
-    .. code-block:: json
-
-        {
-            "my_secret_name": {
-                "key": "value"
-            }
-        }
+    - ``AUTOMIZOR_AGENT_TOKEN``: The token for authenticating against the `Automizor API`.
 
     Example usage:
 
@@ -44,33 +28,48 @@ class Vault:
 
         from automizor import vault
 
+        # Create a new secret
+        vault.create_secret(name="MySecret", value={"username": "admin", "password": "*****"})
+
         # Retrieve a secret by its name
-        secret = vault.get_secret("my_secret_name")
-        print(secret["key"])  # Output: "value"
+        secret = vault.get_secret("MySecret")
+        print(secret.get("username"))  # Output: "admin"
+        print(secret.get("password"))  # Output: "*****"
 
         # Update a existing secret
-        secret = vault.get_secret("my_secret_name")
-        secret["new_key"] = "new_value"
+        secret = vault.get_secret("MySecret")
+        secret.update({"username": "user"})
         vault.set_secret(secret)
     """
 
     def __init__(self):
-        self._api_host = os.getenv("AUTOMIZOR_API_HOST")
-        self._api_token = os.getenv("AUTOMIZOR_API_TOKEN")
-        self._secret_file = os.getenv("AUTOMIZOR_SECRET_FILE")
-
+        self.url, self.token = get_api_config()
         self.session = requests.Session()
-        self.session.headers.update(
-            {
-                "Authorization": f"Token {self._api_token}",
-                "Content-Type": "application/json",
-            }
-        )
-
-    def get_secret(self, name) -> Secret:
+        self.session.headers.update(get_headers(self.token))
+
+    def create_secret(self, secret: SecretContainer) -> SecretContainer:
+        """
+        Creates a new secret. Stores the secret in the `Automizor API`.
+        If the secret already exists, it will be updated.
+
+        Args:
+            secret: The secret to create.
+
+        Returns:
+            The created secret.
+
+        Raises:
+            AutomizorVaultError: If creating the secret fails.
         """
-        Retrieves a secret by its name. Fetches from a local file or queries the
-        `Automizor API`, based on configuration.
+
+        try:
+            return self._update_secret(secret)
+        except NotFound:
+            return self._create_secret(secret)
+
+    def get_secret(self, name) -> SecretContainer:
+        """
+        Retrieves a secret by its name. Fetches from the `Automizor API`.
 
         Args:
             name: The name of the secret to retrieve.
@@ -82,14 +81,11 @@ class Vault:
             AutomizorVaultError: If retrieving the secret fails.
         """
 
-        if self._secret_file:
-            return self._read_file_secret(name)
-        return self._read_vault_secret(name)
+        return self._get_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.
+        Updates an existing secret. Updates to the `Automizor API`.
 
         Args:
             secret: The secret to update.
@@ -101,39 +97,43 @@ class Vault:
             AutomizorVaultError: If updating the secret fails.
         """
 
-        if self._secret_file:
-            return self._write_file_secret(secret)
-        return self._write_vault_secret(secret)
+        return self._update_secret(secret)
 
-    def _read_file_secret(self, name: str) -> Secret:
-        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)
+    def _create_secret(self, secret: SecretContainer) -> SecretContainer:
+        url = f"https://{self.url}/api/v1/vault/secret/"
+        try:
+            response = self.session.post(url, timeout=10, json=asdict(secret))
+            response.raise_for_status()
+            return SecretContainer(**response.json())
+        except requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to create secret"
+            ) from exc
+        except Exception as exc:
+            raise AutomizorError("Failed to create secret") from exc
 
-    def _read_vault_secret(self, name: str) -> Secret:
-        url = f"https://{self._api_host}/api/v1/vault/secret/{name}/"
+    def _get_secret(self, name: str) -> SecretContainer:
+        url = f"https://{self.url}/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 requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to get secret"
+            ) from exc
         except Exception as exc:
-            raise AutomizorVaultError(f"Failed to get secret: {exc}") from exc
-
-    def _write_file_secret(self, secret: Secret):
-        with open(self._secret_file, "r+", encoding="utf-8") as file:
-            secrets = json.load(file)
-            secrets[secret.name] = secret.value
-            file.seek(0)
-            file.write(json.dumps(secrets, indent=4))
-            file.truncate()
-        return secret
-
-    def _write_vault_secret(self, secret: Secret) -> Secret:
-        url = f"https://{self._api_host}/api/v1/vault/secret/{secret.name}/"
+            raise AutomizorError("Failed to get secret") from exc
+
+    def _update_secret(self, secret: SecretContainer) -> SecretContainer:
+        url = f"https://{self.url}/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 requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to update secret"
+            ) from exc
         except Exception as exc:
-            raise AutomizorVaultError(f"Failed to set secret: {exc}") from exc
+            raise AutomizorError("Failed to update secret") from exc

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

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

automizor-0.4.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+automizor/__init__.py,sha256=yhiWOz0HoJGRRI9-JQ2eh_0AbByy-6psK08-kpTSHJw,18
+automizor/exceptions.py,sha256=P5imySIOtG3ZIk2kh41Yod4RnlgTj7Vf0P3M-RuxQJs,1382
+automizor/job/__init__.py,sha256=DNRuT6cyPQBaPRG4vNalCmEvcJQl-73b5ZDFOfNOwIg,1019
+automizor/job/_job.py,sha256=62T_eMEqsJlxhlQ8_3nupTvvwsEysgx5JZAz7ui1WLo,5245
+automizor/storage/__init__.py,sha256=DUVVvetBgsrF69mfiM9iu1PvSBjFPLxrgH1o18mvReA,4000
+automizor/storage/_storage.py,sha256=rKWxaCA_kFr5cW_RrHqL4uEVzNqdWjTQAOXFTfIxlfY,11021
+automizor/utils/__init__.py,sha256=2trRoR5lljYKbYdxmioSlvzajjQM0Wnoq3bvF9lEZ6w,811
+automizor/vault/__init__.py,sha256=UjRiW3J0R9ABXc1gXIPyS3cqNCwMWxx0l-C0PsIg7R0,1699
+automizor/vault/_container.py,sha256=TXwNhjK-qrfu_5iDJm1J0Kkuyq22dLdES1DqjAAKnWA,1953
+automizor/vault/_vault.py,sha256=uRsjOjzsstZpYwJoHNg_cpv803Dzo4T2oF6hwiG3Eww,4688
+automizor-0.4.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+automizor-0.4.0.dist-info/METADATA,sha256=Ky_rwJrB2JUutCKAYo9Rzkwo_j6UPyQaS8HRORjr6O8,661
+automizor-0.4.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+automizor-0.4.0.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
+automizor-0.4.0.dist-info/RECORD,,

{automizor-0.3.0.dist-info → automizor-0.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

automizor/job/_exceptions.py

@@ -1,2 +0,0 @@
-class AutomizorJobError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Job."""

automizor/job.py

@@ -1,132 +0,0 @@
-import json
-import os
-from typing import Any, Dict, List, Union
-
-import requests
-
-JSONType = Union[str, int, float, bool, None, Dict[str, Any], List[Any]]
-
-
-class AutomizorJobError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Job."""
-
-
-class Job:
-    """
-    Represents a job in the `Automizor Platform`, managing the retrieval and storage of job
-    context and results.
-
-    This class provides functionality to interact with the `Automizor API` or local files to
-    obtain job context and persist job results.
-
-    For testing purposes, you may want to set the environment variables in your local environment.
-    The required variables are:
-
-    - ``AUTOMIZOR_API_HOST``: The host URL of the `Automizor API`
-    - ``AUTOMIZOR_API_TOKEN``: The token used for authenticating with the `Automizor API`
-    - ``AUTOMIZOR_JOB_ID``: The ID of the job from which to retrieve context
-
-    Additionally, you can specify a local context file; in this case, you don't need to set the
-    above environment variables:
-
-    - ``AUTOMIZOR_CONTEXT_FILE``: The path to a local file containing the job context.
-
-    Example of a local context file:
-
-    .. code-block:: json
-
-        {
-            "key": "value"
-        }
-
-    Example usage:
-
-    .. code-block:: python
-
-        from automizor.job import Job
-
-        job = Job()
-
-        def read_context():
-            context = job.get_job_context()
-            print(context["key"])  # Output: "value"
-
-        def save_result():
-            job.set_job_result("result_key", "result_value")
-
-    """
-
-    def __init__(self):
-        self._api_host = os.getenv("AUTOMIZOR_API_HOST")
-        self._api_token = os.getenv("AUTOMIZOR_API_TOKEN")
-        self._context_file = os.getenv("AUTOMIZOR_CONTEXT_FILE")
-        self._job_id = os.getenv("AUTOMIZOR_JOB_ID")
-
-    @property
-    def headers(self) -> dict:
-        """Headers for API requests, including Authorization and Content-Type."""
-        return {
-            "Authorization": f"Token {self._api_token}",
-            "Content-Type": "application/json",
-        }
-
-    def get_job_context(self) -> dict:
-        """
-        Retrieves the job's context from either a local file or via an API call, based on
-        the configuration.
-
-        If a local context file is specified (via `AUTOMIZOR_CONTEXT_FILE`), it reads the context
-        from the file. Otherwise, it fetches the context from the Automizor API using the job ID
-        and API credentials.
-
-        Returns:
-            A dictionary with the job's context.
-
-        Raises:
-            AutomizorJobError: If retrieving the job context fails.
-        """
-
-        if self._context_file:
-            return self._read_file_context()
-        return self._read_job_context()
-
-    def set_job_result(self, name: str, value: JSONType):
-        """
-        Saves a job result into a JSON file (`output/result.json`).
-
-        Updates the file with the new result, creating or overwriting the file as necessary.
-        If the file exists and contains data, it merges the new result with the existing data.
-
-        Parameters:
-            name (str): The key under which to store the result.
-            value (JSONType): The result value, must be JSON serializable.
-
-        Note: Errors during file operations will raise unhandled exceptions.
-        """
-
-        data = {}
-        file_path = "output/result.json"
-        try:
-            if os.path.exists(file_path):
-                with open(file_path, "r", encoding="utf-8") as file:
-                    data = json.load(file)
-        except json.JSONDecodeError:
-            pass
-
-        data[name] = value
-
-        with open(file_path, "w", encoding="utf-8") as file:
-            json.dump(data, file, ensure_ascii=False, indent=4)
-
-    def _read_file_context(self) -> dict:
-        with open(self._context_file, "r", encoding="utf-8") as file:
-            return json.load(file)
-
-    def _read_job_context(self) -> dict:
-        url = f"https://{self._api_host}/api/v1/rpa/job/{self._job_id}/"
-        try:
-            response = requests.get(url, headers=self.headers, timeout=10)
-            response.raise_for_status()
-            return response.json().get("context", {})
-        except Exception as exc:
-            raise AutomizorJobError(f"Failed to get job context: {exc}") from exc

automizor/storage/_exceptions.py

@@ -1,2 +0,0 @@
-class AutomizorStorageError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Storage."""

automizor/vault/_exceptions.py

@@ -1,2 +0,0 @@
-class AutomizorVaultError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Vault."""

automizor/vault/_secret.py

@@ -1,45 +0,0 @@
-from dataclasses import dataclass
-
-
-@dataclass
-class Secret:
-    """
-    Represents a secret, comprising a name and its associated values.
-
-    Attributes:
-        name: The name of the secret.
-        value: The secret's values, stored in a dictionary as key-value pairs.
-    """
-
-    name: str
-    value: dict
-
-    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 update(self, pairs: dict) -> None:
-        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.value.keys())
-        return f"Secret(name={self.name}, keys={keys})"