feat(users): add initial function with test

Author: SplinterHead

.gitignore

@@ -1,2 +1,5 @@
 .idea/
-.venv/
+.venv/
+
+__pycache__/
+*.pyc

kasm_python/__init__.py

@@ -0,0 +1,22 @@
+from .users import get_users
+
+
+class Kasm:
+    base_url: str
+    authorisation_json: dict
+
+    def __init__(
+        self,
+        url: str,
+        api_key: str,
+        api_key_secret: str,
+    ):
+        # Ensure the http protocol is prefixed to the URL
+        self.base_url = url if "://" in url else f"https://{url}"
+        self.authorisation_json = {"api_key": api_key, "api_key_secret": api_key_secret}
+
+    ################
+    # Users
+    ################
+    def get_users(self):
+        return get_users(self.base_url, self.authorisation_json)

kasm_python/kasm.py

@@ -0,0 +1,9 @@
+import json
+
+import requests
+
+
+def get_users(url: str, auth: dict):
+    api_url = f"{url}/api/public/get_users"
+    res = requests.post(api_url, json=auth).json()
+    return json.loads(res)

kasm_python/users.py

@@ -0,0 +1,10 @@
+from kasm_python.kasm import Kasm
+
+
+def test_can_initialise_kasm_instance():
+    assert Kasm(url="https://localhost.com", api_key="abc", api_key_secret="abcd1234")
+
+
+def test_can_initialise_kasm_without_protocol():
+    kasm = Kasm(url="localhost.com", api_key="abc", api_key_secret="abcd1234")
+    assert kasm.base_url == "https://localhost.com"

tests/test_kasm.py

@@ -0,0 +1,59 @@
+import json
+
+from pytest import fixture
+
+
+@fixture
+def user_object():
+    return json.dumps(
+        {
+            "users": [
+                {
+                    "kasms": [],
+                    "company": {},
+                    "username": "user@kasm.local",
+                    "locked": False,
+                    "realm": "local",
+                    "phone": None,
+                    "first_name": None,
+                    "notes": None,
+                    "user_id": "57e8fc1a-fa86-4ff4-9474-60d9831f42d5",
+                    "last_session": "2020-11-12 14:29:25.808258",
+                    "groups": [
+                        {
+                            "name": "All Users",
+                            "group_id": "68d557ac4cac42cca9f31c7c853de0f3",
+                        }
+                    ],
+                    "disabled": True,
+                    "organization": None,
+                    "last_name": None,
+                },
+                {
+                    "kasms": [],
+                    "company": {},
+                    "username": "admin@kasm.local",
+                    "locked": False,
+                    "realm": "local",
+                    "phone": None,
+                    "first_name": None,
+                    "notes": None,
+                    "user_id": "4acb13bf-1215-4972-9f0d-8c537d17f2da",
+                    "last_session": "2020-11-12 14:35:19.700863",
+                    "groups": [
+                        {
+                            "name": "All Users",
+                            "group_id": "68d557ac4cac42cca9f31c7c853de0f3",
+                        },
+                        {
+                            "name": "Administrators",
+                            "group_id": "31aa063c670648589533d3c42092d02a",
+                        },
+                    ],
+                    "disabled": False,
+                    "organization": None,
+                    "last_name": None,
+                },
+            ]
+        }
+    )

tests/users/conftest.py

@@ -0,0 +1,18 @@
+import requests_mock
+from pytest import fixture
+
+from kasm_python.kasm import Kasm
+
+
+@fixture
+def kasm():
+    return Kasm(
+        url="https://localhost.com", api_key="abcd123", api_key_secret="abcdef12345678"
+    )
+
+
+def test_can_get_current_users(requests_mock, kasm, user_object):
+    requests_mock.post("https://localhost.com/api/public/get_users", json=user_object)
+    users = kasm.get_users()
+    print(users)
+    assert len(users["users"]) == 2