Merge pull request #1000 from CitrineInformatics/feature/pne-7426-expose-project-archive-status

[PNE-7426] Expose Project.archived.

Author: anoto-moniz

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = "3.24.1"
+__version__ = "3.25.0"

src/citrine/resources/project.py

@@ -1,5 +1,6 @@
 """Resources that represent both individual and collections of projects."""
 from deprecation import deprecated
+from functools import partial
 from typing import Optional, Dict, List, Union, Iterable, Tuple, Iterator
 from uuid import UUID
 from warnings import warn
@@ -77,6 +78,8 @@ class Project(Resource['Project']):
     """str: Status of the project."""
     created_at = properties.Optional(properties.Datetime(), 'created_at')
     """int: Time the project was created, in seconds since epoch."""
+    archived = properties.Optional(properties.Boolean, 'archived')
+    """bool: Whether the project is archived."""
     _team_id = properties.Optional(properties.UUID, "team.id", serializable=False)
 
     def __init__(self,
@@ -599,9 +602,57 @@ def register(self, name: str, *, description: Optional[str] = None) -> Project:
         project = Project(name, description=description)
         return super().register(project)
 
+    def _list_base(self, *, per_page: int = 1000, archived: Optional[bool] = None):
+        filters = {}
+        if archived is not None:
+            filters["archived"] = str(archived).lower()
+
+        fetcher = partial(self._fetch_page, additional_params=filters, version=self._api_version)
+        return self._paginator.paginate(page_fetcher=fetcher,
+                                        collection_builder=self._build_collection_elements,
+                                        per_page=per_page)
+
     def list(self, *, per_page: int = 1000) -> Iterator[Project]:
         """
-        List projects using pagination.
+        List all projects using pagination.
+
+        Parameters
+        ---------
+        per_page: int, optional
+            Max number of results to return per page. Default is 1000.  This parameter
+            is used when making requests to the backend service.  If the page parameter
+            is specified it limits the maximum number of elements in the response.
+
+        Returns
+        -------
+        Iterator[Project]
+            Projects in this collection.
+
+        """
+        return self._list_base(per_page=per_page)
+
+    def list_active(self, *, per_page: int = 1000) -> Iterator[Project]:
+        """
+        List non-archived projects using pagination.
+
+        Parameters
+        ---------
+        per_page: int, optional
+            Max number of results to return per page. Default is 1000.  This parameter
+            is used when making requests to the backend service.  If the page parameter
+            is specified it limits the maximum number of elements in the response.
+
+        Returns
+        -------
+        Iterator[Project]
+            Projects in this collection.
+
+        """
+        return self._list_base(per_page=per_page, archived=False)
+
+    def list_archived(self, *, per_page: int = 1000) -> Iterable[Project]:
+        """
+        List archived projects using pagination.
 
         Parameters
         ---------
@@ -616,7 +667,7 @@ def list(self, *, per_page: int = 1000) -> Iterator[Project]:
             Projects in this collection.
 
         """
-        return super().list(per_page=per_page)
+        return self._list_base(per_page=per_page, archived=True)
 
     def search_all(self, search_params: Optional[Dict]) -> Iterable[Dict]:
         """

tests/resources/test_project.py

@@ -418,7 +418,46 @@ def test_list_projects(collection, session):
 
     # Then
     assert 1 == session.num_calls
-    expected_call = FakeCall(method='GET', path=f'/teams/{collection.team_id}/projects', params={'per_page': 1000, 'page': 1})
+    expected_call = FakeCall(method='GET',
+                             path=f'/teams/{collection.team_id}/projects',
+                             params={'per_page': 1000, 'page': 1},
+                             version="v3")
+    assert expected_call == session.last_call
+    assert 5 == len(projects)
+
+
+def test_list_archived_projects(collection, session):
+    # Given
+    projects_data = ProjectDataFactory.create_batch(5)
+    session.set_response({'projects': projects_data})
+
+    # When
+    projects = list(collection.list_archived())
+
+    # Then
+    assert 1 == session.num_calls
+    expected_call = FakeCall(method='GET',
+                             path=f'/teams/{collection.team_id}/projects',
+                             params={'per_page': 1000, 'page': 1, 'archived': "true"},
+                             version="v3")
+    assert expected_call == session.last_call
+    assert 5 == len(projects)
+
+
+def test_list_active_projects(collection, session):
+    # Given
+    projects_data = ProjectDataFactory.create_batch(5)
+    session.set_response({'projects': projects_data})
+
+    # When
+    projects = list(collection.list_active())
+
+    # Then
+    assert 1 == session.num_calls
+    expected_call = FakeCall(method='GET',
+                             path=f'/teams/{collection.team_id}/projects',
+                             params={'per_page': 1000, 'page': 1, 'archived': "false"},
+                             version="v3")
     assert expected_call == session.last_call
     assert 5 == len(projects)