Merge pull request #759 from CitrineInformatics/PLA-9734/list-projects-v3

make citrine.projects.list() v3 backward compatible with v1

Author: zoesyang

docs/source/FAQ/team_management_migration.rst

@@ -43,6 +43,8 @@ Previously:
 
 	project = citrine.projects.get(project_id)
 	# or
+	projects = citrine.projects.list()
+	# or
 	project = citrine.projects.register(name="My Project")
 	# or
 	project = find_or_create_project(
@@ -64,6 +66,8 @@ The ``Team`` equivalent:
 
 	# Then find your project within the team
 	project = team.projects.get("baaa467e-1758-43a8-97c7-76e569d0dcab")
+	# or 
+	projects = team.projects.list()
 	# or
 	project = team.projects.register(name="My Project")
 	# or
@@ -72,6 +76,17 @@ The ``Team`` equivalent:
 		project_name="My Project"
 	)
 
+You should modify your code to make use of these new access patterns, but for backward 
+compatibility purposes, the following methods will continue to work after the teams 
+migration:
+
+.. code-block:: python
+
+	project = citrine.projects.get(project_id)
+	
+	projects = citrine.projects.list()
+
+
 If your scripts managed user membership in projects, that user management now works on the team
 level instead.
 

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '1.31.2'
+__version__ = '1.32.0'

src/citrine/resources/project.py

@@ -721,9 +721,9 @@ def list(self, *,
 
     def _list_v3(self, *, page: Optional[int] = None, per_page: int = 1000) -> Iterator[Project]:
         if self.team_id is None:
-            raise NotImplementedError("Please use team.projects")
-
-        path = format_escaped_url('/teams/{team_id}/projects', team_id=self.team_id)
+            path = '/projects'
+        else:
+            path = format_escaped_url('/teams/{team_id}/projects', team_id=self.team_id)
 
         fetcher = partial(self._fetch_page, path=path)
         return self._paginator.paginate(page_fetcher=fetcher,

tests/resources/test_project.py

@@ -601,10 +601,17 @@ def test_list_projects_v3(collection_v3, session_v3):
     assert 5 == len(projects)
 
 
-def test_failed_list_v3_no_team(session_v3):
+def test_list_v3_no_team(session_v3):
     project_collection = ProjectCollection(session=session_v3)
-    with pytest.raises(NotImplementedError):
-        project_collection.list()
+    projects_data = ProjectDataFactory.create_batch(5)
+    session_v3.set_response({'projects': projects_data})
+
+    projects = list(project_collection.list())
+
+    assert 1 == session_v3.num_calls
+    expected_call = FakeCall(method='GET', path=f'/projects', params={'per_page': 1000})
+    assert expected_call == session_v3.last_call
+    assert 5 == len(projects)
 
 
 def test_list_projects_filters_non_projects(collection, session):