Merge pull request #14 from dynata/feature/pause-line-item

Added pause line item function.

Author: dynata-bradley

dynatademand/api.py

@@ -242,6 +242,24 @@ def get_project_detailed_report(self, project_id):
         )
         return self._api_get('/projects/{}/detailedReport'.format(project_id))
 
+    def pause_line_item(self, project_id, line_item_id):
+        # Stops traffic to a line item.
+        self.validator.validate_request(
+            'pause_line_item',
+            path_data={
+                'extProjectId': '{}'.format(project_id),
+                'extLineItemId': '{}'.format(line_item_id),
+            },
+        )
+        response_data = self._api_post('/projects/{}/lineItems/{}/pause'.format(project_id, line_item_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_line_item(self, project_id, line_item_id):
         self.validator.validate_request(
             'get_line_item',

dynatademand/schemas/request/path/pause_line_item.json

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

dynatademand/validator.py

@@ -19,6 +19,7 @@
     'get_line_item': ['path', ],
     'get_line_items': ['path', 'query'],
     'get_line_item_detailed_report': ['path', ],
+    'pause_line_item': ['path', ],
     'update_line_item': ['path', 'body'],
 
     # Events

tests/test_line_items.py

@@ -51,6 +51,32 @@ def test_get_line_item_detailed_report(self):
         self.assertEqual(len(responses.calls), 1)
         self.assertEqual(responses.calls[0].response.json(), line_item_detailed_report_json)
 
+    @responses.activate
+    def test_pause_line_item(self):
+        # Tests pausing a line item.
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/lineItems/180/pause'.format(BASE_HOST),
+            json={'status': {'message': 'success'}},
+            status=200
+        )
+        # Response with error
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/lineItems/180/pause'.format(BASE_HOST),
+            json={'status': {'message': 'error'}},
+            status=200
+        )
+
+        # Test successful response
+        self.api.pause_line_item(24, 180)
+        self.assertEqual(len(responses.calls), 1)
+
+        # Test error response
+        with self.assertRaises(DemandAPIError):
+            self.api.pause_line_item(24, 180)
+        self.assertEqual(len(responses.calls), 2)
+
     @responses.activate
     def test_update_line_item(self):
         with open('./tests/test_files/update_line_item.json', 'r') as new_lineitem_file: