Merge pull request #12 from dynata/POP-2287

[POP-2287] Added close project function and tests.

Author: dynata-bradley

dynatademand/api.py

@@ -187,6 +187,22 @@ def create_project(self, project_data):
             )
         return response_data
 
+    def close_project(self, project_id):
+        # Closes the requested project. Once a project is closed, all traffic
+        # is stopped, and the project is automatically sent for invoicing.
+        self.validator.validate_request(
+            'close_project',
+            path_data={'extProjectId': '{}'.format(project_id)},
+        )
+        response_data = self._api_post('/projects/{}/close'.format(project_id), {})
+        if response_data.get('status').get('message') != 'success':
+            raise DemandAPIError(
+                "Could not close project. Demand API responded with: {}".format(
+                    response_data
+                )
+            )
+        return response_data
+
     def get_project(self, project_id):
         self.validator.validate_request(
             'get_project',

dynatademand/schemas/request/path/close_project.json

@@ -0,0 +1,12 @@
+{
+  "type": "object",
+  "properties": {
+    "extProjectId": {
+      "type": "string",
+      "required": true
+    }
+  },
+  "required": [
+    "extProjectId"
+  ]
+}

dynatademand/validator.py

@@ -11,6 +11,7 @@
     'create_project': ['body', ],
     'get_projects': ['query', ],
     'get_project': ['path', ],
+    'close_project': ['path', ],
     'update_project': ['path', 'body', ],
     'get_project_detailed_report': ['path', ],
 

tests/test_projects.py

@@ -60,6 +60,27 @@ def test_create_project(self):
         self.api.create_project(new_project_data)
         self.assertEqual(len(responses.calls), 1)
 
+    @responses.activate
+    def test_close_project(self):
+        # Tests closing a project.
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/close'.format(BASE_HOST),
+            json={'status': {'message': 'success'}},
+            status=200
+        )
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/close'.format(BASE_HOST),
+            json={'status': {'message': 'error'}},
+            status=200
+        )
+        self.api.close_project(24)
+        self.assertEqual(len(responses.calls), 1)
+        with self.assertRaises(DemandAPIError):
+            self.api.close_project(24)
+        self.assertEqual(len(responses.calls), 2)
+
     @responses.activate
     def test_update_project(self):
         # Tests creating a project. This also tests validating the project data as part of `api.create_project`.