Merge pull request #11 from dynata/POP-2289

[POP-2289] Added buy project function and tests.

Author: dynata-bradley

dynatademand/api.py

@@ -187,6 +187,26 @@ def create_project(self, project_data):
             )
         return response_data
 
+    def buy_project(self, project_id, buy_data):
+        '''
+            Buy the line items for a project, agreeing to the price. A Line Item
+            can only be bought if the feasibility for the line item is in status=READY
+            and totalCount > 0.
+        '''
+        self.validator.validate_request(
+            'buy_project',
+            path_data={'extProjectId': '{}'.format(project_id)},
+            request_body=buy_data,
+        )
+        response_data = self._api_post('/projects/{}/buy'.format(project_id), buy_data)
+        if response_data.get('status').get('message') != 'success':
+            raise DemandAPIError(
+                "Could not buy project. Demand API responded with: {}".format(
+                    response_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.

dynatademand/schemas/request/body/buy_project.json

@@ -0,0 +1,22 @@
+{
+  "type": "array",
+  "items": {
+    "type": "object",
+    "required": [
+      "extLineItemId",
+      "surveyURL",
+      "surveyTestURL"
+    ],
+    "properties": {
+      "extLineItemId": {
+        "type": "string"
+      },
+      "surveyURL": {
+        "type": "string"
+      },
+      "surveyTestURL": {
+        "type": "string"
+      }
+    }
+  }
+}

dynatademand/schemas/request/path/buy_project.json

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

dynatademand/validator.py

@@ -13,6 +13,7 @@
     'get_project': ['path', ],
     'close_project': ['path', ],
     'update_project': ['path', 'body', ],
+    'buy_project': ['path', 'body', ],
     'get_project_detailed_report': ['path', ],
 
     # Line items

tests/test_files/buy_project.json

@@ -0,0 +1,12 @@
+[
+  {
+    "extLineItemId": "lineItem001",
+    "surveyURL": "www.mysurvey.com/live/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>",
+    "surveyTestURL": "www.mysurvey.com/test/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>"
+  },
+  {
+    "extLineItemId": "lineItem002",
+    "surveyURL": "www.mysurvey.com/live/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>",
+    "surveyTestURL": "www.mysurvey.com/test/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>"
+  }
+]

tests/test_projects.py

@@ -60,6 +60,31 @@ def test_create_project(self):
         self.api.create_project(new_project_data)
         self.assertEqual(len(responses.calls), 1)
 
+    @responses.activate
+    def test_buy_project(self):
+        # Tests buying a project.
+        with open('./tests/test_files/buy_project.json', 'r') as buy_project_file:
+            buy_project_data = json.load(buy_project_file)
+        # Success response
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/buy'.format(BASE_HOST),
+            json={'status': {'message': 'success'}},
+            status=200)
+        # Response with error status
+        responses.add(
+            responses.POST,
+            '{}/sample/v1/projects/24/buy'.format(BASE_HOST),
+            json={'status': {'message': 'error'}},
+            status=200)
+        # Test success response
+        self.api.buy_project(24, buy_project_data)
+        self.assertEqual(len(responses.calls), 1)
+        # Test error response
+        with self.assertRaises(DemandAPIError):
+            self.api.buy_project(24, buy_project_data)
+        self.assertEqual(len(responses.calls), 2)
+
     @responses.activate
     def test_close_project(self):
         # Tests closing a project.