let request objects specify custom body validations

Nat Williams · Nat Williams · commit 2ca15bb8e847 · 2012-04-17T14:39:12.000-05:00
diff --git a/pygithub3/requests/base.py b/pygithub3/requests/base.py
@@ -17,10 +17,11 @@
 
 class Body(object):
 
-    def __init__(self, content, schema, required):
+    def __init__(self, content, valid_body, validate_body=None):
         self.content = content
-        self.schema = schema
-        self.required = required
+        self.schema = valid_body['schema']
+        self.required = valid_body['required']
+        self.validate_body = validate_body or (lambda x: None)
 
     def dumps(self):
         if not self.schema:
@@ -33,6 +34,7 @@ def parse(self):
                                    % self.__class__.__name__)
         parsed = dict([(key, self.content[key]) for key in self.schema
                       if key in self.content])
+        self.validate_body(parsed)
         for attr_required in self.required:
             if attr_required not in parsed:
                 raise ValidationError("'%s' attribute is required" %
@@ -58,7 +60,8 @@ def __init__(self, **kwargs):
 
     def clean(self):
         self.uri = self.clean_uri() or self.uri
-        self.body = Body(self.clean_body(), **self.clean_valid_body())
+        self.body = Body(self.clean_body(), self.clean_valid_body(),
+                         self.validate_body)
 
     def clean_body(self):
         return self.body
@@ -94,6 +97,9 @@ def populate_uri(self):
     def get_body(self):
         return self.body.dumps()
 
+    def validate_body(self, *args):
+        pass
+
 
 class Factory(object):
     """ Request builder """
diff --git a/pygithub3/tests/requests/test_core.py b/pygithub3/tests/requests/test_core.py
@@ -2,12 +2,14 @@
 # -*- encoding: utf-8 -*-
 
 from mock import Mock
+from nose.tools import raises
 
 from pygithub3.tests.utils.core import TestCase
 from pygithub3.requests.base import Factory, Body, json, Request
 from pygithub3.exceptions import (UriInvalid, DoesNotExists, ValidationError,
                                   InvalidBodySchema)
-from pygithub3.tests.utils.base import mock_json, DummyRequest
+from pygithub3.tests.utils.base import (mock_json, DummyRequest,
+                                        DummyRequestValidation)
 from pygithub3.tests.utils.requests import (
     RequestWithArgs, RequestCleanedUri, RequestBodyInvalidSchema,
     RequestCleanedBody)
@@ -74,7 +76,7 @@ class TestRequestBodyWithSchema(TestCase):
 
     def setUp(self):
         valid_body = dict(schema=('arg1', 'arg2'), required=('arg1', ))
-        self.b = Body({}, **valid_body)
+        self.b = Body({}, valid_body)
 
     def test_with_body_empty_and_schema_permissive(self):
         self.b.schema = ('arg1', 'arg2', '...')
@@ -100,3 +102,14 @@ def test_with_body_as_None(self):
     def test_only_valid_keys(self):
         self.b.content = dict(arg1='arg1', arg2='arg2', fake='test')
         self.assertEqual(self.b.dumps(), dict(arg1='arg1', arg2='arg2'))
+
+
+class TestBodyValidation(TestCase):
+    @raises(ValidationError)
+    def test_with_error(self):
+        req = DummyRequestValidation(
+            body={'foo': 'bar', 'error': 'yes'},
+        )
+        req.body_schema = {'schema': ('foo',),
+                           'required': ('foo',)}
+        req.get_body()
diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py
@@ -4,7 +4,7 @@
 from mock import Mock
 
 from pygithub3.resources.base import Resource
-from pygithub3.requests.base import Request
+from pygithub3.requests.base import Request, ValidationError
 
 
 def mock_json(content):
@@ -37,3 +37,14 @@ def loads_mock(content):
 class DummyRequest(Request):
     uri = 'dummyrequest'
     resource = DummyResource
+
+
+class DummyRequestValidation(DummyRequest):
+    body_schema = {
+        'schema': ('foo', 'error'),
+        'required': ('foo',)
+    }
+
+    def validate_body(self, body):
+        if body.get('error') == 'yes':
+            raise ValidationError('yes')
