From 701f89767882efe8dce9114b5333debe1b83e84f Mon Sep 17 00:00:00 2001
From: Kenneth Bingham <kenneth.bingham@netfoundry.io>
Date: Tue, 28 Jan 2025 15:20:21 -0500
Subject: [PATCH] make overview a class with data types instead of a function
 that returns JSON

---
 sdk/python/sdk/zrok/zrok/overview.py | 89 ++++++++++++++++++++++------
 1 file changed, 72 insertions(+), 17 deletions(-)

diff --git a/sdk/python/sdk/zrok/zrok/overview.py b/sdk/python/sdk/zrok/zrok/overview.py
index b8d64649a..0ee063dd5 100644
--- a/sdk/python/sdk/zrok/zrok/overview.py
+++ b/sdk/python/sdk/zrok/zrok/overview.py
@@ -1,20 +1,75 @@
-from zrok.environment.root import Root
+import json
+from dataclasses import dataclass, field
+from typing import List
+
 import urllib3
+from zrok.environment.root import Root
+
+from zrok_api.models.environment import Environment
+from zrok_api.models.share import Share
+
+
+@dataclass
+class EnvironmentAndShares:
+    environment: Environment
+    shares: List[Share] = field(default_factory=list)
+
+
+@dataclass
+class Overview:
+    environments: List[EnvironmentAndShares] = field(default_factory=list)
+
+    @classmethod
+    def create(cls, root: Root) -> 'Overview':
+        if not root.IsEnabled():
+            raise Exception("environment is not enabled; enable with 'zrok enable' first!")
+
+        http = urllib3.PoolManager()
+        apiEndpoint = root.ApiEndpoint().endpoint
+        try:
+            response = http.request(
+                'GET',
+                apiEndpoint + "/api/v1/overview",
+                headers={
+                    "X-TOKEN": root.env.Token
+                })
+        except Exception as e:
+            raise Exception("unable to get account overview", e)
+
+        json_data = json.loads(response.data.decode('utf-8'))
+        overview = cls()
 
+        for env_data in json_data.get('environments', []):
+            env_dict = env_data['environment']
+            # Map the JSON keys to the Environment class parameters
+            environment = Environment(
+                description=env_dict.get('description'),
+                host=env_dict.get('host'),
+                address=env_dict.get('address'),
+                z_id=env_dict.get('zId'),
+                activity=env_dict.get('activity'),
+                limited=env_dict.get('limited'),
+                created_at=env_dict.get('createdAt'),
+                updated_at=env_dict.get('updatedAt')
+            )
+            # Map the JSON keys to the Share class parameters
+            shares = []
+            for share_data in env_data.get('shares', []):
+                share = Share(
+                    token=share_data.get('token'),
+                    z_id=share_data.get('zId'),
+                    share_mode=share_data.get('shareMode'),
+                    backend_mode=share_data.get('backendMode'),
+                    frontend_selection=share_data.get('frontendSelection'),
+                    frontend_endpoint=share_data.get('frontendEndpoint'),
+                    backend_proxy_endpoint=share_data.get('backendProxyEndpoint'),
+                    reserved=share_data.get('reserved'),
+                    activity=share_data.get('activity'),
+                    limited=share_data.get('limited'),
+                    created_at=share_data.get('createdAt'),
+                    updated_at=share_data.get('updatedAt')
+                )
+                shares.append(share)
+            overview.environments.append(EnvironmentAndShares(environment=environment, shares=shares))
 
-def Overview(root: Root) -> str:
-    if not root.IsEnabled():
-        raise Exception("environment is not enabled; enable with 'zrok enable' first!")
-
-    http = urllib3.PoolManager()
-    apiEndpoint = root.ApiEndpoint().endpoint
-    try:
-        response = http.request(
-            'GET',
-            apiEndpoint + "/api/v1/overview",
-            headers={
-                "X-TOKEN": root.env.Token
-            })
-    except Exception as e:
-        raise Exception("unable to get account overview", e)
-    return response.data.decode('utf-8')
+        return overview