get projects function

Author: wogsland

CmixAPIClient/api.py

@@ -418,3 +418,9 @@ def get_survey_simulations(self, survey_id):
                 )
             )
         return simulations_response.json()
+
+    def get_projects(self):
+        project_endpoint = 'projects'
+        project_error = 'CMIX returned a non-200 response code while getting projects'
+        project_response = self.api_get(project_endpoint, project_error)
+        return project_response

README.md

@@ -29,7 +29,7 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
     authenticate(*args, **kwargs)
     fetch_banner_filter(survey_id, question_a, question_b, response_id)
     fetch_raw_results(survey_id, payload)
-    get_project(project_id)
+    get_projects()
     get_surveys(status, *args, **kwargs)
     get_survey_data_layouts(survey_id)
     get_survey_definition(survey_id)
@@ -50,9 +50,15 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
 
 ### CmixProject
 
+    get_full_links()
     get_groups()
+    get_links()
+    get_locales()
+    get_markup_files()
     get_project()
+    get_respondent_links()
     get_sources()
+    get_surveys()
 
 ## Contributing
 

tests/test_api.py

@@ -24,6 +24,32 @@ def setUp(self):
         self.survey_id = 1337
         self.project_id = 1492
 
+    def helper_get(self, function_name, endpoint):
+        func = getattr(self.cmix_api, function_name)
+
+        # success case
+        with mock.patch('CmixAPIClient.api.requests') as mock_request:
+            mock_get = mock.Mock()
+            mock_get.status_code = 200
+            mock_get.json.return_value = {}
+            mock_request.get.return_value = mock_get
+
+            func()
+
+            base_url = CMIX_SERVICES['survey']['BASE_URL']
+            project_url = '{}/{}'.format(base_url, endpoint)
+            mock_request.get.assert_any_call(project_url, headers=self.cmix_api._authentication_headers)
+
+        # error case (survey not found)
+        with mock.patch('CmixAPIClient.api.requests') as mock_request:
+            mock_get = mock.Mock()
+            mock_get.status_code = 404
+            mock_get.json.return_value = {}
+            mock_request.get.return_value = mock_get
+
+            with self.assertRaises(CmixError):
+                func()
+
     def test_cmix_authentication_check(self):
         with self.assertRaises(CmixError):
             CmixAPI()
@@ -425,3 +451,6 @@ def test_get_survey_simulations(self):
 
             with self.assertRaises(CmixError):
                 self.cmix_api.get_survey_simulations(self.survey_id)
+
+    def test_get_projects(self):
+        self.helper_get('get_projects', 'projects')