Updated pause line item function with validation and fixed test.

Author: RidleyLarsen

dynatademand/api.py

@@ -170,6 +170,13 @@ def get_project_detailed_report(self, project_id):
 
     def pause_line_item(self, project_id, line_item_id):
         # Stops traffic to a line item.
+        self.validator.validate_request(
+            'pause_line_item',
+            path_data={
+                'extProjectId': '{}'.format(project_id),
+                'extLineItemId': '{}'.format(line_item_id),
+            },
+        )
         response_data = self._api_post('/projects/{}/lineItems/{}/pause'.format(project_id, line_item_id), {})
         if response_data.get('status').get('message') != 'success':
             raise DemandAPIError(

dynatademand/schemas/request/path/pause_line_item.json

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

dynatademand/validator.py

@@ -0,0 +1,69 @@
+import json
+import jsonschema
+
+ENDPOINTS = {
+    # Authorization
+    'obtain_access_token': ['body', ],
+    'refresh_access_token': ['body', ],
+    'logout': ['body', ],
+
+    # Projects
+    'create_project': ['body', ],
+    'get_projects': ['query', ],
+    'get_project': ['path', ],
+    'update_project': ['path', 'body', ],
+    'get_project_detailed_report': ['path', ],
+
+    # Line items
+    'get_line_item': ['path', ],
+    'get_line_items': ['path', 'query'],
+    'get_line_item_detailed_report': ['path', ],
+    'pause_line_item': ['path', ],
+    'update_line_item': ['path', 'body'],
+
+    # Events
+    'get_events': ['query', ],
+    'get_event': ['path', ],
+
+    # Attributes
+    'get_attributes': ['path', 'query', ],
+
+    # Categories
+    'get_survey_topics': ['query', ],
+
+    # Countries & Languages
+    'get_countries': ['query', ],
+
+    # Pricing & Feasibility
+    'get_feasibility': ['path', ],
+
+    # Supplier Sources
+    'get_sources': [],
+}
+
+
+class DemandAPIValidator(object):
+    def __init__(self, ):
+        self.schemas = {
+            'path': {},
+            'query': {},
+            'body': {},
+        }
+        for endpoint_name, schemas in ENDPOINTS.items():
+            for schema in schemas:
+                with open('dynatademand/schemas/request/{}/{}.json'.format(schema, endpoint_name), 'r') as schema_file:
+                    self.schemas[schema][endpoint_name] = json.load(schema_file)
+
+    def _validate_object(self, schema_type, endpoint_name, data):
+        jsonschema.validate(schema=self.schemas[schema_type][endpoint_name], instance=data)
+
+    def validate_request(self, endpoint_name, path_data={}, query_params={}, request_body={}):
+        '''
+            # TODO: None of the path schemas from the documentation are currently valid.
+            if 'path' in ENDPOINTS[endpoint_name]:
+                self._validate_object('path', endpoint_name, path_data)
+        '''
+        if 'query' in ENDPOINTS[endpoint_name]:
+            self._validate_object('query', endpoint_name, query_params)
+        if 'body' in ENDPOINTS[endpoint_name]:
+            self._validate_object('body', endpoint_name, request_body)