--wip-- [skip ci]

Author: tdstein

integration/Makefile

@@ -137,5 +137,5 @@ test:
 	set -o pipefail; \
 		CONNECT_VERSION=${CONNECT_VERSION} \
 		CONNECT_API_KEY="$(shell $(UV) run rsconnect bootstrap -i -s http://connect:3939 --raw)" \
-		$(UV) run pytest -s --junit-xml=./reports/$(CONNECT_VERSION).xml | \
+		$(UV) run pytest -s -k TestJobs --junit-xml=./reports/$(CONNECT_VERSION).xml | \
 		tee ./logs/$(CONNECT_VERSION).log;

integration/tests/posit/connect/test_jobs.py

@@ -36,3 +36,17 @@ def test(self):
 
         jobs = content.jobs
         assert len(jobs) == 1
+
+    def test_find_by(self):
+        content = self.content
+
+        path = Path("../../../resources/connect/bundles/example-quarto-minimal/bundle.tar.gz")
+        path = Path(__file__).parent / path
+        path = path.resolve()
+        path = str(path)
+
+        bundle = content.bundles.create(path)
+        bundle.deploy()
+
+        jobs = content.jobs.find_by(status=1)
+        assert len(jobs) == 1

src/posit/connect/client.py

@@ -14,6 +14,7 @@
 from .groups import Groups
 from .metrics import Metrics
 from .oauth import OAuth
+from .packages import Packages
 from .resources import ResourceParameters
 from .tasks import Tasks
 from .users import User, Users
@@ -269,6 +270,10 @@ def oauth(self) -> OAuth:
         """
         return OAuth(self.resource_params, self.cfg.api_key)
 
+    @property
+    def packages(self) -> Packages:
+        return Packages(self.ctx, "v1/packages")
+
     @property
     def vanities(self) -> Vanities:
         return Vanities(self.resource_params)

src/posit/connect/content.py

@@ -37,7 +37,7 @@ class ContentItemOwner(Resource):
     pass
 
 
-class ContentItem(JobsMixin, VanityMixin, Resource):
+class ContentItem(JobsMixin, PackagesMixin, VanityMixin, Resource):
     def __init__(self, /, params: ResourceParameters, **kwargs):
         ctx = Context(params.session, params.url)
         uid = kwargs["guid"]

src/posit/connect/packages.py

@@ -1,89 +1,64 @@
-from typing import Literal, Optional, Sequence, TypedDict
+import posixpath
+from typing import Optional, TypedDict, overload
 
 from typing_extensions import NotRequired, Required, Unpack
 
-from .resources import Resource, ResourceParameters, Resources
+from .resources import Active, ActiveFinderMethods, ActiveSequence
 
 
-class Package(Resource):
-    """A package resource."""
-
-    class PackageAttributes(TypedDict):
-        """Package attributes."""
-
-        language: Required[Literal["r", "python"]]
+class Package(Active):
+    class _Package(TypedDict):
+        language: Required[str]
         name: Required[str]
         version: Required[str]
-        hash: NotRequired[str]
+        hash: Required[Optional[str]]
 
-    def __init__(self, params: ResourceParameters, **kwargs: Unpack[PackageAttributes]):
-        super().__init__(params, **kwargs)
+    def __init__(self, ctx, path, /, **attributes: Unpack[_Package]):
+        super().__init__(ctx, path, **attributes)
 
 
-class Packages(Resources, Sequence[Package]):
+class Packages(ActiveFinderMethods["Package"], ActiveSequence["Package"]):
     """A collection of packages."""
 
-    def __init__(self, params, endpoint):
-        super().__init__(params)
-        self._endpoint = endpoint
-        self._packages = []
-        self.reload()
-
-    def __getitem__(self, index):
-        """Retrieve an item or slice from the sequence."""
-        return self._packages[index]
+    def __init__(self, ctx, path):
+        super().__init__(ctx, path, "name")
 
-    def __len__(self):
-        """Return the length of the sequence."""
-        return len(self._packages)
+    def _create_instance(self, path, /, **attributes):
+        return Package(self._ctx, path, **attributes)
 
-    def __repr__(self):
-        """Return the string representation of the sequence."""
-        return f"Packages({', '.join(map(str, self._packages))})"
+    class _FindBy(TypedDict, total=False):
+        language: NotRequired[str]
+        name: NotRequired[str]
+        version: NotRequired[str]
+        hash: NotRequired[Optional[str]]
 
-    def count(self, value):
-        """Return the number of occurrences of a value in the sequence."""
-        return self._packages.count(value)
+    @overload
+    def find_by(self, **conditions: Unpack[_FindBy]):
+        ...
 
-    def index(self, value, start=0, stop=None):
-        """Return the index of the first occurrence of a value in the sequence."""
-        if stop is None:
-            stop = len(self._packages)
-        return self._packages.index(value, start, stop)
+    @overload
+    def find_by(self, **conditions):
+        ...
 
-    def reload(self) -> "Packages":
-        """Reload packages from the Connect server.
-
-        Returns
-        -------
-        List[Package]
-        """
-        response = self.params.session.get(self._endpoint)
-        results = response.json()
-        packages = [Package(self.params, **result) for result in results]
-        self._packages = packages
-        return self
+    def find_by(self, **conditions):
+        return super().find_by(**conditions)
 
+class PackagesMixin(Active):
+    """Mixin class to add a packages attribute."""
 
-class PackagesMixin(Resource):
-    """Mixin class to add a packages to a resource."""
+    def __init__(self, ctx, path, /, **attributes):
+        """Mixin class which adds a `packages` attribute.
 
-    class HasGuid(TypedDict):
-        """Has a guid."""
-
-        guid: Required[str]
-
-    def __init__(self, params: ResourceParameters, **kwargs: Unpack[HasGuid]):
-        super().__init__(params, **kwargs)
-        self._guid = kwargs["guid"]
-        self._packages: Optional[Packages] = None
-
-    @property
-    def packages(self) -> Packages:
-        """Get the packages."""
-        if self._packages:
-            return self._packages
+        Parameters
+        ----------
+        ctx : Context
+            The context object containing the session and URL for API interactions
+        path : str
+            The HTTP path component for the resource endpoint
+        **attributes : dict
+            Resource attributes passed
+        """
+        super().__init__(ctx, path, **attributes)
 
-        endpoint = self.params.url + f"v1/content/{self._guid}/packages"
-        self._packages = Packages(self.params, endpoint)
-        return self._packages
+        path = posixpath.join(path, "packages")
+        self.packages = Packages(ctx, path)

src/posit/connect/resources.py

@@ -1,6 +1,7 @@
 import posixpath
 import warnings
 from abc import ABC, abstractmethod
+from copy import copy
 from dataclasses import dataclass
 from typing import Any, Generic, List, Optional, Sequence, TypeVar, overload
 
@@ -81,7 +82,7 @@ class ActiveSequence(ABC, Generic[T], Sequence[T]):
 
     _cache: Optional[List[T]]
 
-    def __init__(self, ctx: Context, path: str, uid: str = "guid"):
+    def __init__(self, ctx: Context, path: str, uid: str = "guid", params: dict = {}):
         """A sequence abstraction for any HTTP GET endpoint that returns a collection.
 
         Parameters
@@ -97,6 +98,7 @@ def __init__(self, ctx: Context, path: str, uid: str = "guid"):
         self._ctx = ctx
         self._path = path
         self._uid = uid
+        self._params = params
         self._cache = None
 
     @abstractmethod
@@ -114,7 +116,7 @@ def fetch(self) -> List[T]:
         List[T]
         """
         endpoint = self._ctx.url + self._path
-        response = self._ctx.session.get(endpoint)
+        response = self._ctx.session.get(endpoint, params=self._params)
         results = response.json()
         return [self._to_instance(result) for result in results]
 

tests/posit/connect/__api__/v1/content/f2f37341-e21d-3d80-c698-a935ad614066/packages.json

@@ -0,0 +1,7 @@
+[
+    {
+        "language": "python",
+        "name": "posit",
+        "version": "0.6.0"
+    }
+]

tests/posit/connect/__api__/v1/packages.json

@@ -0,0 +1,11 @@
+{
+    "results": [
+        {
+            "language": "python",
+            "name": "posit",
+            "version": "0.6.0"
+        }
+    ],
+    "current_page": 1,
+    "total": 1
+}