Merge pull request #6 from researchnow/feature/get-project-endpoint

Get Project

Author: DynataRidley

dynatademand/api.py

@@ -1,18 +1,33 @@
 import os
 import requests
+
 from .errors import DemandAPIError
 
 
 class DemandAPIClient(object):
-    def __init__(self):
-        self.client_id = os.getenv('DYNATA_DEMAND_CLIENT_ID', None)
-        self.username = os.getenv('DYNATA_DEMAND_USERNAME', None)
-        self.password = os.getenv('DYNATA_DEMAND_PASSWORD', None)
+    def __init__(self, client_id=None, username=None, password=None, base_host=None):
+        if client_id is not None:
+            self.client_id = client_id
+        else:
+            self.client_id = os.getenv('DYNATA_DEMAND_CLIENT_ID', None)
+        if username is not None:
+            self.username = username
+        else:
+            self.username = os.getenv('DYNATA_DEMAND_USERNAME', None)
+        if password is not None:
+            self.password = password
+        else:
+            self.password = os.getenv('DYNATA_DEMAND_PASSWORD', None)
+        if base_host is not None:
+            self.base_host = base_host
+        else:
+            self.base_host = os.getenv('DYNATA_DEMAND_BASE_URL', default='https://api.researchnow.com')
+
         if None in [self.client_id, self.username, self.password]:
             raise DemandAPIError("All authentication data is required.")
+
         self._access_token = None
         self._refresh_token = None
-        self.base_host = os.getenv('DYNATA_DEMAND_BASE_URL', default='https://api.researchnow.com')
         self.auth_base_url = '{}/auth/v1'.format(self.base_host)
         self.base_url = '{}/sample/v1'.format(self.base_host)
 
@@ -35,6 +50,21 @@ def _api_post(self, uri, payload):
             ))
         return response.json()
 
+    def _api_get(self, uri, query_params=None):
+        # Send an authenticated POST request to an API endpoint.
+        self._check_authentication()
+        url = '{}{}'.format(self.base_url, uri)
+        request_headers = {
+            'oauth_access_token': self._access_token,
+            'Content-Type': "application/json",
+        }
+        response = requests.get(url=url, params=query_params, 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()
+
     def authenticate(self):
         url = '{}/token/password'.format(self.auth_base_url)
         auth_response = requests.post(url, json={
@@ -79,3 +109,12 @@ def logout(self):
                 logout_response.status_code, logout_response.content
             ))
         return logout_response.json()
+
+    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_authentication.py

@@ -16,6 +16,33 @@
 
 
 class AuthenticationTestMissingCredentials(unittest.TestCase):
+    def test_authentication_params(self):
+        DemandAPIClient(client_id="test", username="test", password="test", base_host=BASE_URL)
+
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient(username="test", password="test", base_host=BASE_URL)
+
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient(client_id="test", password="test", base_host=BASE_URL)
+
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient(client_id="test", username="test", base_host=BASE_URL)
+
+    @patch('os.getenv')
+    def test_authentication_params_with_env(self, mock_getenv):
+        mock_getenv.side_effect = [
+            "test_client_id",
+            "test_username",
+            "test_password",
+            BASE_URL
+        ]
+
+        # None of these should raise an error if the appropriate missing data is available in the environment.
+        DemandAPIClient(client_id="test", username="test", password="test", base_host=BASE_URL)
+        DemandAPIClient(username="test", password="test", base_host=BASE_URL)
+        DemandAPIClient(client_id="test", password="test", base_host=BASE_URL)
+        DemandAPIClient(client_id="test", username="test", base_host=BASE_URL)
+
     @patch('os.getenv')
     def test_missing_client_id(self, mock_getenv):
         mock_getenv.side_effect = [

tests/test_feasibility_pricing.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 TestFeasibilityEndpoints(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_feasibility(self):
+        with open('./tests/test_files/get_feasibility.json', 'r') as project_file:
+            project_json = json.load(project_file)
+        responses.add(responses.GET, '{}/sample/v1/projects/1/feasibility'.format(BASE_HOST), json=project_json, status=200)
+        self.api.get_feasibility(1)
+        self.assertEqual(len(responses.calls), 1)
+        self.assertEqual(responses.calls[0].response.json(), project_json)

tests/test_files/get_feasibility.json

@@ -0,0 +1,76 @@
+{
+  "data": [
+    {
+      "extLineItemId": "lineItem001",
+      "feasibility": {
+        "status": "READY",
+        "costPerInterview": 3.14,
+        "expiry": "05/01/2018 00:00:00",
+        "currency": "USD",
+        "feasible": true,
+        "totalCount": 50343,
+        "valueCounts": [
+          {
+            "quotaCells": [
+              {
+                "quotaNodes": [
+                  {
+                    "attributeId": "11",
+                    "options": [
+                      "1"
+                    ]
+                  }
+                ],
+                "feasibilityCount": 1000
+              },
+              {
+                "quotaNodes": [
+                  {
+                    "attributeId": "11",
+                    "options": [
+                      "2"
+                    ]
+                  }
+                ],
+                "feasibilityCount": 1200
+              }
+            ]
+          }
+        ]
+      },
+      "quote": {
+        "costPerUnit": 3.14,
+        "currency": "USD",
+        "detailedQuote": [
+          {
+            "costPerUnit": 2.14,
+            "estimatedCost": 2140,
+            "title": "Completes",
+            "type": "BASE",
+            "units": 1000
+          },
+          {
+            "costPerUnit": 1,
+            "estimatedCost": 1000,
+            "title": "Completes",
+            "type": "PREMIUM",
+            "units": 1000
+          }
+        ],
+        "estimatedCost": 3140
+      }
+    },
+    {
+      "extLineItemId": "lineItem002",
+      "feasibility": {
+        "status": "PROCESSING",
+        "costPerInterview": null,
+        "expiry": null,
+        "currency": null,
+        "feasible": null,
+        "totalCount": null,
+        "valueCounts": []
+      }
+    }
+  ]
+}

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"
+  }
+}