feat: extended Phase to utilize all phase_io utils

Author: nimish-ks

src/phase/__init__.py

@@ -1,3 +1,19 @@
-from .phase import Phase
+from .phase import (
+    Phase,
+    GetSecretOptions,
+    GetAllSecretsOptions,
+    CreateSecretsOptions,
+    SecretUpdateOptions,
+    DeleteSecretOptions,
+    PhaseSecret
+)
 
-__all__ = ['Phase']
+__all__ = [
+    'Phase',
+    'GetSecretOptions',
+    'GetAllSecretsOptions',
+    'CreateSecretsOptions',
+    'SecretUpdateOptions',
+    'DeleteSecretOptions',
+    'PhaseSecret'
+]

src/phase/phase.py

@@ -1,29 +1,89 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import List, Dict, Optional
 from .utils.phase_io import Phase as PhaseIO
 from .utils.secret_referencing import resolve_all_secrets
 
+@dataclass
+class GetSecretOptions:
+    env_name: str
+    app_name: str
+    key_to_find: Optional[str] = None
+    tag: Optional[str] = None
+    secret_path: str = "/"
+
+@dataclass
+class GetAllSecretsOptions:
+    env_name: str
+    app_name: str
+    tag: Optional[str] = None
+    secret_path: str = "/"
+
+@dataclass
+class CreateSecretsOptions:
+    env_name: str
+    app_name: str
+    key_value_pairs: List[Dict[str, str]]
+    secret_path: str = "/"
+
+@dataclass
+class SecretUpdateOptions:
+    env_name: str
+    app_name: str
+    key: str
+    value: Optional[str] = None
+    secret_path: str = "/"
+    destination_path: Optional[str] = None
+    override: bool = False
+    toggle_override: bool = False
+
+@dataclass
+class DeleteSecretOptions:
+    env_name: str
+    app_name: str
+    key_to_delete: str
+    secret_path: str = "/"
+
 @dataclass
 class PhaseSecret:
     key: str
     value: str
-    comment: str
-    path: str
-    tags: List[str]
-    overridden: bool
+    comment: str = ""
+    path: str = "/"
+    tags: List[str] = field(default_factory=list)
+    overridden: bool = False
 
 class Phase:
     def __init__(self, init=True, pss=None, host=None):
         self._phase_io = PhaseIO(init=init, pss=pss, host=host)
 
-    def create(self, env_name: str, app_name: str, secrets: List[PhaseSecret], path: str = '/') -> str:
-        key_value_pairs = [(secret.key, secret.value) for secret in secrets]
-        response = self._phase_io.create(key_value_pairs, env_name, app_name, path)
-        return "Success" if response.status_code == 200 else f"Error: {response.status_code}"
+    def get_secret(self, options: GetSecretOptions) -> Optional[PhaseSecret]:
+        secrets = self._phase_io.get(
+            env_name=options.env_name,
+            keys=[options.key_to_find] if options.key_to_find else None,
+            app_name=options.app_name,
+            tag=options.tag,
+            path=options.secret_path
+        )
+        if secrets:
+            secret = secrets[0]
+            return PhaseSecret(
+                key=secret['key'],
+                value=secret['value'],
+                comment=secret.get('comment', ''),
+                path=secret.get('path', '/'),
+                tags=secret.get('tags', []),
+                overridden=secret.get('overridden', False)
+            )
+        return None
 
-    def get(self, env_name: str, keys: List[str] = None, app_name: str = None, tag: str = None, path: str = '') -> List[PhaseSecret]:
-        secrets = self._phase_io.get(env_name, keys, app_name, tag, path)
-        phase_secrets = [
+    def get_all_secrets(self, options: GetAllSecretsOptions) -> List[PhaseSecret]:
+        secrets = self._phase_io.get(
+            env_name=options.env_name,
+            app_name=options.app_name,
+            tag=options.tag,
+            path=options.secret_path
+        )
+        return [
             PhaseSecret(
                 key=secret['key'],
                 value=secret['value'],
@@ -34,22 +94,40 @@ def get(self, env_name: str, keys: List[str] = None, app_name: str = None, tag:
             )
             for secret in secrets
         ]
-        return self._resolve_references(phase_secrets, env_name, app_name)
 
-    def update(self, env_name: str, secret: PhaseSecret, app_name: str = None) -> str:
-        response = self._phase_io.update(
-            env_name, 
-            secret.key, 
-            secret.value, 
-            app_name, 
-            source_path=secret.path
+    def create_secrets(self, options: CreateSecretsOptions) -> str:
+        # Convert the list of dictionaries to a list of tuples
+        key_value_tuples = [(list(item.keys())[0], list(item.values())[0]) for item in options.key_value_pairs]
+        
+        response = self._phase_io.create(
+            key_value_pairs=key_value_tuples,
+            env_name=options.env_name,
+            app_name=options.app_name,
+            path=options.secret_path
+        )
+        return "Success" if response.status_code == 200 else f"Error: {response.status_code}"
+
+    def update_secret(self, options: SecretUpdateOptions) -> str:
+        return self._phase_io.update(
+            env_name=options.env_name,
+            key=options.key,
+            value=options.value,
+            app_name=options.app_name,
+            source_path=options.secret_path,
+            destination_path=options.destination_path,
+            override=options.override,
+            toggle_override=options.toggle_override
         )
-        return response
 
-    def delete(self, env_name: str, keys: List[str], app_name: str = None, path: str = None) -> List[str]:
-        return self._phase_io.delete(env_name, keys, app_name, path)
+    def delete_secret(self, options: DeleteSecretOptions) -> List[str]:
+        return self._phase_io.delete(
+            env_name=options.env_name,
+            keys_to_delete=[options.key_to_delete],
+            app_name=options.app_name,
+            path=options.secret_path
+        )
 
-    def _resolve_references(self, secrets: List[PhaseSecret], env_name: str, app_name: str) -> List[PhaseSecret]:
+    def resolve_references(self, secrets: List[PhaseSecret], env_name: str, app_name: str) -> List[PhaseSecret]:
         all_secrets = [
             {
                 'environment': env_name,