feat: add version check support

Author: tdstein

Makefile

@@ -58,7 +58,7 @@ lint:
 	$(PYTHON) -m ruff check
 
 test:
-	$(PYTHON) -m coverage run --source=src -m pytest tests
+	$(PYTHON) -m coverage run --source=src -m pytest -s tests
 
 uninstall: ensure-uv
 	$(UV) pip uninstall $(PROJECT_NAME)

integration/tests/posit/connect/test_client.py

@@ -4,3 +4,8 @@
 def test_version():
     client = connect.Client()
     assert client.version
+
+
+def test_oauth():
+    client = connect.Client()
+    assert client.oauth

src/posit/connect/client.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import overload
+from typing import Optional, overload
 
 from requests import Response, Session
 
@@ -14,8 +14,10 @@
 from .metrics import Metrics
 from .oauth import OAuth
 from .resources import ResourceParameters
+from .settings import Settings
 from .tasks import Tasks
 from .users import User, Users
+from .version import requires_version
 
 
 class Client:
@@ -158,7 +160,7 @@ def __init__(self, *args, **kwargs) -> None:
         self.resource_params = ResourceParameters(session, self.cfg.url)
 
     @property
-    def version(self) -> str:
+    def version(self) -> Optional[str]:
         """
         The server version.
 
@@ -167,7 +169,8 @@ def version(self) -> str:
         str
             The version of the Posit Connect server.
         """
-        return self.get("server_settings").json()["version"]
+        settings = Settings(self.session, self.cfg.url)
+        return settings.version
 
     @property
     def me(self) -> User:
@@ -257,6 +260,7 @@ def metrics(self) -> Metrics:
         return Metrics(self.resource_params)
 
     @property
+    @requires_version("2024.08.0")
     def oauth(self) -> OAuth:
         """
         The OAuth API interface.

src/posit/connect/errors.py renamed to src/posit/connect/exceptions.py

@@ -2,7 +2,10 @@
 from typing import Any
 
 
-class ClientError(Exception):
+class PositConnectException(RuntimeError):
+    pass
+
+class ClientError(PositConnectException):
     def __init__(
         self,
         error_code: int,
@@ -27,3 +30,11 @@ def __init__(
                 }
             )
         )
+
+
+class VersionUpgradeRequiredException(PositConnectException):
+    def __init__(self, found: str, expected: str, *args) -> None:
+        super().__init__(
+            f"This API is not available in Connect version {found}. Please upgrade to version {expected} or later.",
+            *args,
+        )

src/posit/connect/hooks.py

@@ -3,7 +3,7 @@
 
 from requests import JSONDecodeError, Response
 
-from .errors import ClientError
+from .exceptions import ClientError
 
 
 def handle_errors(response: Response, *args, **kwargs) -> Response:

src/posit/connect/settings.py

@@ -0,0 +1,30 @@
+from typing import Optional
+
+import requests
+
+from .urls import Url
+
+
+class Settings:
+    def __init__(self, session: requests.Session, url: Url) -> None:
+        self.session = session
+        self.url = url
+
+    @property
+    def version(self) -> Optional[str]:
+        return self.settings.get("version")
+
+    @property
+    def settings(self) -> dict:
+        url = self.url + "server_settings"
+        try:
+            response = self.session.get(url)
+            return response.json()
+        except requests.exceptions.RequestException as e:
+            import logging
+
+            logging.debug(
+                f"Failed to retrieve server settings from {url}. Error: {str(e)}", exc_info=True
+            )
+
+            return {}

src/posit/connect/version.py

@@ -0,0 +1,20 @@
+from functools import wraps
+
+from packaging.version import Version
+
+from .exceptions import VersionUpgradeRequiredException
+
+
+def requires_version(expected: str):
+    def decorator(func):
+        @wraps(func)
+        def wrapper(self, *args, **kwargs):
+            if hasattr(self, "version"):
+                version = getattr(self, "version")
+                if version and Version(version) < Version(expected):
+                    raise VersionUpgradeRequiredException(version, expected)
+            return func(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator

tests/posit/connect/test_errors.py

@@ -1,6 +1,6 @@
 import pytest
 
-from posit.connect.errors import ClientError
+from posit.connect.exceptions import ClientError
 
 
 def test():

tests/posit/connect/test_hooks.py

@@ -6,7 +6,7 @@
 from requests import HTTPError, Response
 
 from posit.connect import Client
-from posit.connect.errors import ClientError
+from posit.connect.exceptions import ClientError
 from posit.connect.hooks import handle_errors