Added buy project function and tests.

Additionally, fixed issue with schema validator not having keyword-args in the validate call. This caused an issue with the new project schema, which this commit fixes.

Author: RidleyLarsen

dynatademand/api.py

@@ -7,6 +7,7 @@
 
 SCHEMAS = [
     "project_new",
+    "project_buy",
 ]
 
 
@@ -50,7 +51,7 @@ def _load_schemas(self):
     def _validate_object(self, schema_type, data):
         # jsonschema.validate will return none if there is no error,
         # otherwise it will raise its' own error with details on the failure.
-        jsonschema.validate(self._schemas[schema_type], data)
+        jsonschema.validate(schema=self._schemas[schema_type], instance=data)
 
     def _check_authentication(self):
         # This doesn't check if the access token is valid, just that it exists.
@@ -158,6 +159,22 @@ 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._validate_object("project_buy", 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 get_project(self, project_id):
         return self._api_get('/projects/{}'.format(project_id))
 

dynatademand/schemas/project_buy.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/project_new.json

@@ -28,18 +28,18 @@
     "devices": {
       "type": "array",
       "description": "Device targeting for the project",
-      "enum": [
-        "mobile",
-        "desktop",
-        "tablet"
-      ],
       "default": [
         "mobile",
         "desktop",
         "tablet"
       ],
       "items": {
-        "type": "string"
+        "type": "string",
+        "enum": [
+          "mobile",
+          "desktop",
+          "tablet"
+        ]
       }
     },
     "category": {

tests/test_files/examples/project_buy.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

@@ -11,6 +11,7 @@
     from mock import patch
 
 from dynatademand.api import DemandAPIClient
+from dynatademand.errors import DemandAPIError
 
 BASE_HOST = "http://test-url.example"
 
@@ -55,3 +56,20 @@ def test_create_project(self):
         responses.add(responses.POST, '{}/sample/v1/projects'.format(BASE_HOST), json={'status': {'message': 'success'}}, status=200)
         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/examples/project_buy.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)