refactor service module

Author: Jens Kürten

csfunctions/service/__init__.py

@@ -0,0 +1,10 @@
+from csfunctions.service.numgen import NumberGeneratorService
+
+
+class Service:
+    """
+    Provides access to services on the elements instance, e.g. generating numbers.
+    """
+
+    def __init__(self, service_url: str | None, service_token: str | None):
+        self.generator = NumberGeneratorService(service_url, service_token)

csfunctions/service/base.py

@@ -0,0 +1,38 @@
+from typing import Optional
+
+import requests
+
+
+class Unauthorized(Exception):
+    pass
+
+
+class BaseService:
+    """
+    Base class for services.
+    """
+
+    def __init__(self, service_url: str | None, service_token: str | None):
+        self.service_url = service_url
+        self.service_token = service_token
+
+    def request(self, endpoint: str, method: str = "GET", params: Optional[dict] = None) -> dict | list:
+        """
+        Make a request to the access service.
+        """
+        if self.service_url is None:
+            raise ValueError("No service url given.")
+        if self.service_token is None:
+            raise ValueError("No service token given.")
+
+        headers = {"Authorization": f"Bearer {self.service_token}"}
+        params = params or {}
+        url = self.service_url.rstrip("/") + "/" + endpoint.lstrip("/")
+        response = requests.request(method, url=url, params=params, headers=headers, timeout=10)
+
+        if response.status_code == 401:
+            raise Unauthorized
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise ValueError(f"Access service responded with status code {response.status_code}.")

csfunctions/service.py csfunctions/service/numgen.pycsfunctions/service.py renamed to csfunctions/service/numgen.py

@@ -1,50 +1,4 @@
-from typing import Optional
-
-import requests
-
-
-class Service:
-    """
-    Provides access to services on the elements instance, e.g. generating numbers.
-    """
-
-    def __init__(self, service_url: str | None, service_token: str | None):
-        self.generator = NumberGeneratorService(service_url, service_token)
-
-
-class Unauthorized(Exception):
-    pass
-
-
-class BaseService:
-    """
-    Base class for services.
-    """
-
-    def __init__(self, service_url: str | None, service_token: str | None):
-        self.service_url = service_url
-        self.service_token = service_token
-
-    def request(self, endpoint: str, method: str = "GET", params: Optional[dict] = None) -> dict | list:
-        """
-        Make a request to the access service.
-        """
-        if self.service_url is None:
-            raise ValueError("No service url given.")
-        if self.service_token is None:
-            raise ValueError("No service token given.")
-
-        headers = {"Authorization": f"Bearer {self.service_token}"}
-        params = params or {}
-        url = self.service_url.rstrip("/") + "/" + endpoint.lstrip("/")
-        response = requests.request(method, url=url, params=params, headers=headers, timeout=10)
-
-        if response.status_code == 401:
-            raise Unauthorized
-        if response.status_code == 200:
-            return response.json()
-        else:
-            raise ValueError(f"Access service responded with status code {response.status_code}.")
+from csfunctions.service.base import BaseService
 
 
 class NumberGeneratorService(BaseService):

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "contactsoftware-functions"
-version = "0.14.0"
+version = "0.15.0.dev0"
 readme = "README.md"
 
 license = "MIT"
@@ -33,6 +33,7 @@ requests-mock = "^1.12.1"
 mkdocs = "^1.6.1"
 mkdocs-material = "^9.6.14"
 mkdocs-link-marker = "^0.1.3"
+types-requests = "^2.32.4.20250809"
 
 [tool.ruff]
 line-length = 120