Merge pull request #48 from wogsland/POP-2442

[POP-2442] added reconciliation request function

Author: DynataRidley

dynatademand/api.py

@@ -424,3 +424,33 @@ def get_sources(self):
             'get_sources',
         )
         return self._api_get('/sources')
+
+    def reconcile_project(self, project_id, file, message):
+        '''
+            Sends a reconciliation request
+        '''
+        """
+            # Awaiting valid body & path schemas
+            self.validator.validate_request(
+                'update_line_item',
+                path_data={
+                    'extProjectId': '{}'.format(project_id),
+                },
+                request_body={
+                    'file': file,
+                    'message': message,
+                },
+            )
+        """
+        self._check_authentication()
+        url = '{}{}'.format(self.base_url, '/projects/{}/reconcile'.format(project_id))
+        request_headers = {
+            'Authorization': 'Bearer {}'.format(self._access_token),
+            'Content-Type': "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        }
+        response = requests.post(url=url, data=file, headers=request_headers)
+        if response.status_code > 399:
+            raise DemandAPIError('Demand API request to {} failed with status {}. Response: {}'.format(
+                url, response.status_code, response.content
+            ))
+        return response.json()

dynatademand/schemas/request/body/reconcile_project.json

@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "file": {
+      "type": "file"
+    },
+    "message": {
+      "type": "string"
+    }
+  }
+}

dynatademand/schemas/request/path/reconcile_project.json

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

dynatademand/validator.py

@@ -16,6 +16,7 @@
     'update_project': ['path', 'body', ],
     'buy_project': ['path', 'body', ],
     'get_project_detailed_report': ['path', ],
+    'reconcile_project': ['path', ],
 
     # Invoices
     'get_invoice': ['path', ],

tests/test_files/Data+Quality+Request+Template.xlsx

@@ -108,7 +108,7 @@ def test_close_project(self):
 
     @responses.activate
     def test_update_project(self):
-        # Tests creating a project. This also tests validating the project data as part of `api.create_project`.
+        # Tests updating a project.
         with open('./tests/test_files/update_project.json', 'r') as update_project_file:
             update_project_data = json.load(update_project_file)
 
@@ -133,3 +133,30 @@ def test_update_project(self):
         with self.assertRaises(DemandAPIError):
             self.api.update_project(24, update_project_data)
         self.assertEqual(len(responses.calls), 2)
+
+    @responses.activate
+    def test_reconcile_project(self):
+        # Tests reconciling a project.
+        message = 'testing reconciliation'
+        with open('./tests/test_files/Data+Quality+Request+Template.xlsx', 'rb') as file:
+            # Success response
+            responses.add(
+                responses.POST,
+                '{}/sample/v1/projects/24/reconcile'.format(BASE_HOST),
+                json={'status': {'message': 'success'}},
+                status=200)
+            # Error message included
+            responses.add(
+                responses.POST,
+                '{}/sample/v1/projects/24/reconcile'.format(BASE_HOST),
+                json={'status': {'message': 'error'}},
+                status=400)
+
+            # Test successful response.
+            self.api.reconcile_project(24, file, message)
+            self.assertEqual(len(responses.calls), 1)
+
+            # Test response with error included.
+            with self.assertRaises(DemandAPIError):
+                self.api.reconcile_project(24, file, message)
+            self.assertEqual(len(responses.calls), 2)