POP-2430 added close line item function

Author: wogsland

dynatademand/api.py

@@ -289,6 +289,24 @@ def add_line_item(self, project_id, lineitem_data):
             )
         return response_data
 
+    def close_line_item(self, project_id, line_item_id):
+        # Starts traffic to a line item.
+        self.validator.validate_request(
+            'close_line_item',
+            path_data={
+                'extProjectId': '{}'.format(project_id),
+                'extLineItemId': '{}'.format(line_item_id),
+            },
+        )
+        response_data = self._api_post('/projects/{}/lineItems/{}/close'.format(project_id, line_item_id), {})
+        if response_data.get('status').get('message') != 'success':
+            raise DemandAPIError(
+                "Could not close line item. Demand API responded with: {}".format(
+                    response_data
+                )
+            )
+        return response_data
+
     def launch_line_item(self, project_id, line_item_id):
         # Starts traffic to a line item.
         self.validator.validate_request(
@@ -301,7 +319,7 @@ def launch_line_item(self, project_id, line_item_id):
         response_data = self._api_post('/projects/{}/lineItems/{}/launch'.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(
+                "Could not launch line item. Demand API responded with: {}".format(
                     response_data
                 )
             )
@@ -319,7 +337,7 @@ def pause_line_item(self, project_id, 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(
+                "Could not pause line item. Demand API responded with: {}".format(
                     response_data
                 )
             )

dynatademand/schemas/request/path/close_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

@@ -17,6 +17,7 @@
     'get_project_detailed_report': ['path', ],
 
     # Line items
+    'close_line_item': ['path', ],
     'create_line_item': ['path', 'body', ],
     'get_line_item': ['path', ],
     'get_line_items': ['path', 'query'],

tests/test_line_items.py

@@ -18,6 +18,7 @@ def setUp(self):
 
     @responses.activate
     def test_get_line_item(self):
+        # Tests getting a line item.
         with open('./tests/test_files/get_line_item.json', 'r') as line_item_file:
             line_item_json = json.load(line_item_file)
         responses.add(
@@ -31,6 +32,7 @@ def test_get_line_item(self):
 
     @responses.activate
     def test_get_line_items(self):
+        # Tests getting all line items for a project.
         with open('./tests/test_files/get_line_items.json', 'r') as line_item_file:
             line_item_json = json.load(line_item_file)
         responses.add(responses.GET, '{}/sample/v1/projects/1/lineItems'.format(BASE_HOST), json=line_item_json, status=200)
@@ -40,6 +42,7 @@ def test_get_line_items(self):
 
     @responses.activate
     def test_get_line_item_detailed_report(self):
+        # Tests getting a line item detailed report.
         with open('./tests/test_files/get_line_item_detailed_report.json', 'r') as line_item_detailed_report_file:
             line_item_detailed_report_json = json.load(line_item_detailed_report_file)
         responses.add(
@@ -53,7 +56,7 @@ def test_get_line_item_detailed_report(self):
 
     @responses.activate
     def test_add_line_item(self):
-        # Tests creating a project. This also tests validating the project data as part of `api.create_project`.
+        # Tests creating a line item.
         with open('./tests/test_files/create_line_item.json', 'r') as new_lineitem_file:
             new_lineitem_data = json.load(new_lineitem_file)
         # Success response
@@ -76,9 +79,36 @@ def test_add_line_item(self):
             self.api.add_line_item(24, new_lineitem_data)
         self.assertEqual(len(responses.calls), 2)
 
+    @responses.activate
+    def test_close_line_item(self):
+        # Tests closing a line item.
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/69/lineItems/1337/close'.format(BASE_HOST),
+            json={'status': {'message': 'success'}},
+            status=200
+        )
+
+        # Response with error status
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/69/lineItems/1337/close'.format(BASE_HOST),
+            json={'status': {'message': 'error'}},
+            status=200
+        )
+
+        # Test successful response
+        self.api.close_line_item(69, 1337)
+        self.assertEqual(len(responses.calls), 1)
+
+        # Test error response
+        with self.assertRaises(DemandAPIError):
+            self.api.close_line_item(69, 1337)
+        self.assertEqual(len(responses.calls), 2)
+
     @responses.activate
     def test_launch_line_item(self):
-        # Tests closing a project.
+        # Tests launching a line item.
         responses.add(
             responses.POST,
             '{}/sample/v1/projects/24/lineItems/180/launch'.format(BASE_HOST),
@@ -131,6 +161,7 @@ def test_pause_line_item(self):
 
     @responses.activate
     def test_update_line_item(self):
+        # Tests updating a line item.
         with open('./tests/test_files/update_line_item.json', 'r') as new_lineitem_file:
             update_lineitem_data = json.load(new_lineitem_file)