Merge pull request #59 from dynata/feature-expose-studytype

Feature expose studytype

Author: DynataRidley

dynatademand/api.py

@@ -158,6 +158,9 @@ def get_countries(self, **kwargs):
         )
         return self._api_get('/countries', kwargs)
 
+    def get_study_metadata(self):
+        return self._api_get('/studyMetadata')
+
     def get_event(self, event_id):
         self.validator.validate_request(
             'get_event',

dynatademand/schemas/request/body/create_line_item.json

@@ -45,12 +45,7 @@
     "deliveryType": {
       "type": "string",
       "default": "BALANCED",
-      "description": "The plan on how responses will flow into the survey.",
-      "enum": [
-        "SLOW",
-        "BALANCED",
-        "FAST"
-      ]
+      "description": "The plan on how responses will flow into the survey."
     },
     "sources": {
       "type": "array",

dynatademand/schemas/request/body/create_project.json

@@ -55,6 +55,20 @@
             "type": "string",
             "minLength": 1
           }
+        },
+        "studyType": {
+          "type": "array",
+          "description": "List of possible types of survey.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "surveyRequirements": {
+          "type": "array",
+          "description": "List of possible requirements for a survey.",
+          "items": {
+            "type": "string"
+          }
         }
       }
     },
@@ -118,12 +132,7 @@
           "deliveryType": {
             "type": "string",
             "default": "BALANCED",
-            "description": "The plan on how responses will flow into the survey.",
-            "enum": [
-              "SLOW",
-              "BALANCED",
-              "FAST"
-            ]
+            "description": "The plan on how responses will flow into the survey."
           },
           "sources": {
             "type": "array",

dynatademand/schemas/request/body/update_project.json

@@ -25,6 +25,18 @@
           "items": {
             "type": "string"
           }
+        },
+        "studyType": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "studyRequirements": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       }
     },

tests/test_categories.py

@@ -27,3 +27,22 @@ def test_get_survey_topics(self):
         self.api.get_survey_topics()
         self.assertEqual(len(responses.calls), 1)
         self.assertEqual(responses.calls[0].response.json(), survey_topics_json)
+
+
+class TestStudyMetadataEndpoint(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_study_metadata(self):
+        with open('./tests/test_files/get_study_metadata.json', 'r') as survey_metadata_file:
+            survey_metadata_json = json.load(survey_metadata_file)
+        responses.add(
+            responses.GET,
+            '{}/sample/v1/studyMetadata'.format(BASE_HOST),
+            json=survey_metadata_json,
+            status=200)
+        self.api.get_study_metadata()
+        self.assertEqual(len(responses.calls), 1)
+        self.assertEqual(responses.calls[0].response.json(), survey_metadata_json)

tests/test_files/get_study_metadata.json

@@ -0,0 +1,20 @@
+{
+    "category": {
+        "studyRequirements": [
+            {
+                "allowed": false,
+                "description": "PII Collection",
+                "id": "PII_COLLECTION",
+                "name": "PII Collection"
+            }
+        ]
+    },
+    "deliveryTypes": [
+        {
+            "allowed": true,
+            "description": "Completes come in at an even pace throughout fielding",
+            "id": "SLOW",
+            "name": "Slow"
+        }
+    ]
+}

tests/test_files/get_survey_topics.json

@@ -2,4 +2,4 @@
   "survey": {
     "topic": "milk"
   }
-}
+}