Merge pull request #101 from wogsland/10-termination-codes

add get termination codes function

Author: dynata-bradley

CmixAPIClient/api.py

@@ -264,6 +264,19 @@ def get_survey_sources(self, survey_id):
     def get_survey_completes(self, survey_id):
         return self.get_survey_respondents(survey_id, "COMPLETE", True)
 
+    def get_survey_termination_codes(self, survey_id):
+        self.check_auth_headers()
+        termination_codes_url = '{}/surveys/{}/termination-codes'.format(CMIX_SERVICES['survey'][self.url_type], survey_id)
+        termination_codes_response = requests.get(termination_codes_url, headers=self._authentication_headers)
+        if termination_codes_response.status_code != 200:
+            raise CmixError(
+                'CMIX returned a non-200 response code while getting termination_codes: {} and error {}'.format(
+                    termination_codes_response.status_code,
+                    termination_codes_response.text
+                )
+            )
+        return termination_codes_response.json()
+
     def create_export_archive(self, survey_id, export_type):
         self.check_auth_headers()
         archive_url = '{}/surveys/{}/archives'.format(CMIX_SERVICES['survey'][self.url_type], survey_id)

README.md

@@ -35,6 +35,7 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
     get_survey_xml(survey_id)
     get_survey_sections(survey_id)
     get_survey_simulations(survey_id)
+    get_survey_termination_codes(survey_id)
     get_survey_sources(survey_id)
     get_survey_test_url(survey_id)
     get_survey_respondents(survey_id, respondent_type, live)

tests/test_api.py

@@ -285,6 +285,32 @@ def test_get_survey_completes(self):
             ]
             self.assertEqual(self.cmix_api.get_survey_completes(self.survey_id), mock_respondents)
 
+    def test_get_survey_termination_codes(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_termination_codes(self.survey_id)
+
+            base_url = CMIX_SERVICES['survey']['BASE_URL']
+            surveys_url = '{}/surveys/{}/termination-codes'.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_termination_codes(self.survey_id)
+
     def test_get_surveys(self):
         with mock.patch('CmixAPIClient.api.requests') as mock_request:
             mock_post = mock.Mock()