get project function

Author: wogsland

CmixAPIClient/api.py

@@ -139,6 +139,22 @@ def fetch_raw_results(self, survey_id, payload):
         response = requests.post(url, headers=self._authentication_headers, json=payload)
         return response.json()
 
+    def api_get(self, endpoint, error=''):
+        self.check_auth_headers()
+        url = '{}/{}'.format(CMIX_SERVICES['survey'][self.url_type], endpoint)
+        response = requests.get(url, headers=self._authentication_headers)
+        if response.status_code != 200:
+            if '' == error:
+                error = 'CMIX returned a non-200 response code'
+            raise CmixError(
+                '{}: {} and error {}'.format(
+                    error,
+                    response.status_code,
+                    response.text
+                )
+            )
+        return response.json()
+
     def get_surveys(self, status, *args, **kwargs):
         '''kwargs:
 

CmixAPIClient/project.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from .error import CmixError
+
+
+class CmixProject(object):
+    def __init__(self, client, project_id):
+        if None in [client, project_id]:
+            raise CmixError("Client and project id are required.")
+        self.client = client
+        self.project_id = project_id
+
+    def get_project(self):
+        project_endpoint = 'projects/{}'.format(self.project_id)
+        project_error = 'CMIX returned a non-200 response code while getting project'
+        project_response = self.client.api_get(project_endpoint, project_error)
+        return project_response

README.md

@@ -25,9 +25,11 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
 
 ## Supported API Functions
 
+### CmixAPI
     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_surveys(status, *args, **kwargs)
     get_survey_data_layouts(survey_id)
     get_survey_definition(survey_id)
@@ -46,6 +48,10 @@ A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/
     update_project(project_id, status=None)
     create_survey(xml_string)
 
+### CmixProject
+
+    get_project(project_id)
+
 ## Contributing
 
 Information on [contributing](https://github.com/dynata/python-cmixapi-client/blob/dev/CONTRIBUTING.md) to this python library.

test.py

@@ -0,0 +1,14 @@
+listc=["London", "Rome", "Moscow", "Paris"]
+nfile=open("towns.txt", 'w')
+
+i = 0
+
+for town in listc:
+       nfile.write(town)
+       if line == 2:
+           nfile.write('\n')
+           i = 0
+           continue
+       i += 1
+
+nfile.close()

tests/test_api.py

@@ -22,6 +22,7 @@ def setUp(self):
         self.cmix_api = default_cmix_api()
         self.cmix_api._authentication_headers = {'Authorization': 'Bearer test'}
         self.survey_id = 1337
+        self.project_id = 1492
 
     def test_cmix_authentication_check(self):
         with self.assertRaises(CmixError):

tests/test_project.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+from __future__ import unicode_literals
+import mock
+
+from unittest import TestCase
+from CmixAPIClient.api import CMIX_SERVICES
+from CmixAPIClient.project import CmixProject
+from CmixAPIClient.error import CmixError
+from .test_api import default_cmix_api
+
+
+class TestCmixProject(TestCase):
+    def setUp(self):
+        self.cmix_api = default_cmix_api()
+        self.cmix_api._authentication_headers = {'Authorization': 'Bearer test'}
+        self.project_id = 1492
+
+    def test_get_project(self):
+        project = CmixProject(self.cmix_api, self.project_id)
+
+        # 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
+
+            project.get_project()
+
+            base_url = CMIX_SERVICES['survey']['BASE_URL']
+            project_url = '{}/projects/{}'.format(base_url, self.project_id)
+            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):
+                project.get_project()

towns.txt

@@ -0,0 +1 @@
+London