Merge branch 'dev' into 10-termination-codes

Author: wogsland

CmixAPIClient/api.py

@@ -348,3 +348,16 @@ def create_survey(self, xml_string):
         response_json = response.json()
         self.update_project(response_json.get('projectId'), status=self.SURVEY_STATUS_DESIGN)
         return response_json
+
+    def get_survey_simulations(self, survey_id):
+        self.check_auth_headers()
+        simulations_url = '{}/surveys/{}/simulations'.format(CMIX_SERVICES['survey'][self.url_type], survey_id)
+        simulations_response = requests.get(simulations_url, headers=self._authentication_headers)
+        if simulations_response.status_code != 200:
+            raise CmixError(
+                'CMIX returned a non-200 response code while getting simulations: {} and error {}'.format(
+                    simulations_response.status_code,
+                    simulations_response.text
+                )
+            )
+        return simulations_response.json()

README.md

@@ -31,6 +31,7 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
     get_surveys(status, *args, **kwargs)
     get_survey_definition(survey_id)
     get_survey_xml(survey_id)
+    get_survey_simulations(survey_id)
     get_survey_test_url(survey_id)
     get_survey_respondents(survey_id, respondent_type, live)
     get_survey_status(survey_id)

tests/test_api.py

@@ -296,3 +296,29 @@ def test_add_extra_url_params(self):
         extra_params_formatted = '&{}&{}'.format(extra_params[0], extra_params[1])
         expected = '{}{}'.format(url, extra_params_formatted)
         self.assertEqual(result, expected)
+
+    def test_get_survey_simulations(self):
+        self.cmix_api._authentication_headers = {'Authentication': 'Bearer test'}
+
+        # 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
+
+            self.cmix_api.get_survey_simulations(self.survey_id)
+
+            base_url = CMIX_SERVICES['survey']['BASE_URL']
+            surveys_url = '{}/surveys/{}/simulations'.format(base_url, self.survey_id)
+            mock_request.get.assert_any_call(surveys_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):
+                self.cmix_api.get_survey_simulations(self.survey_id)