Merge pull request #7 from researchnow/feature/get-lineitem-endpoint

Added get line item endpoint and test module.

Author: DynataRidley

dynatademand/api.py

@@ -113,5 +113,8 @@ def logout(self):
     def get_project(self, project_id):
         return self._api_get('/projects/{}'.format(project_id))
 
+    def get_lineitem(self, project_id, lineitem_id):
+        return self._api_get('/projects/{}/lineItems/{}'.format(project_id, lineitem_id))
+
     def get_feasibility(self, project_id):
         return self._api_get('/projects/{}/feasibility'.format(project_id))

tests/test_files/get_lineitem.json

@@ -0,0 +1,78 @@
+{
+  "extLineItemId": "lineItem002",
+  "title": "US College",
+  "countryISOCode": "US",
+  "languageISOCode": "en",
+  "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]>",
+  "indicativeIncidence": 20,
+  "daysInField": 20,
+  "lengthOfInterview": 10,
+  "deliveryType": "BALANCED",
+  "sources": [
+    {
+      "id": 100
+    }
+  ],
+  "targets": [
+    {
+      "count": 200,
+      "dailyLimit": 0,
+      "type": "COMPLETE"
+    }
+  ],
+  "quotaPlan": {
+    "filters": [
+      {
+        "attributeId": "61961",
+        "options": [
+          "3",
+          "4"
+        ],
+        "operator": "include"
+      }
+    ],
+    "quotaGroups": [
+      {
+        "name": "Gender Distribution",
+        "quotaCells": [
+          {
+            "quotaNodes": [
+              {
+                "attributeId": "11",
+                "options": [
+                  "1"
+                ]
+              }
+            ],
+            "count": 130
+          },
+          {
+            "quotaNodes": [
+              {
+                "attributeId": "11",
+                "options": [
+                  "2"
+                ]
+              }
+            ],
+            "count": 70
+          }
+        ]
+      }
+    ]
+  },
+  "state": "PROVISIONED",
+  "stateReason": "Created by Client",
+  "stateLastUpdatedAt": "04/01/2018 00:00:00",
+  "createdAt": "04/01/2018 00:00:00",
+  "updatedAt": "04/01/2018 00:00:00",
+  "launchedAt": null,
+  "endLinks": {
+    "complete": "https://api.researchnow.com/respondent/exit?rst=1&psid={psid}&med={calculatedSecurityCode}",
+    "screenout": "https://api.researchnow.com/respondent/exit?rst=2&psid={psid}",
+    "overquota": "https://api.researchnow.com/respondent/exit?rst=3&psid={psid}",
+    "securityKey1": "35040",
+    "securityLevel": "MEDIUM"
+  }
+}

tests/test_lineitems.py

@@ -0,0 +1,30 @@
+# encoding: utf-8
+from __future__ import unicode_literals, print_function
+
+import json
+import unittest
+import responses
+
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
+
+from dynatademand.api import DemandAPIClient
+
+BASE_HOST = "http://test-url.example"
+
+
+class TestLineItemEndpoints(unittest.TestCase):
+    def setUp(self):
+        self.api = DemandAPIClient(client_id='test', username='testuser', password='testpass', base_host=BASE_HOST)
+        self.api._access_token = 'Bearer testtoken'
+
+    @responses.activate
+    def test_get_lineitem(self):
+        with open('./tests/test_files/get_lineitem.json', 'r') as lineitem_file:
+            lineitem_json = json.load(lineitem_file)
+        responses.add(responses.GET, '{}/sample/v1/projects/1/lineItems/100'.format(BASE_HOST), json=lineitem_json, status=200)
+        self.api.get_lineitem(1, 100)
+        self.assertEqual(len(responses.calls), 1)
+        self.assertEqual(responses.calls[0].response.json(), lineitem_json)