Merge pull request #90 from rgant/format-id-error

Special case for id field error formatting.

Author: sloria

marshmallow_jsonapi/schema.py

@@ -277,26 +277,28 @@ def format_error(self, field_name, message, index=None):
 
         See: http://jsonapi.org/format/#error-objects
         """
+        pointer = ['/data']
+
+        if index is not None:
+            pointer.append(str(index))
+
         relationship = isinstance(
             self.declared_fields.get(field_name), BaseRelationship)
         if relationship:
-            container = 'relationships'
-        else:
-            container = 'attributes'
+            pointer.append('relationships')
+        elif field_name != 'id':
+            # JSONAPI identifier is a special field that exists above the attribute object.
+            pointer.append('attributes')
 
-        inflected_name = self.inflect(field_name)
-        if index is not None:
-            pointer = '/data/{}/{}/{}'.format(index, container, inflected_name)
-        else:
-            pointer = '/data/{}/{}'.format(container, inflected_name)
+        pointer.append(self.inflect(field_name))
 
         if relationship:
-            pointer = '{}/data'.format(pointer)
+            pointer.append('data')
 
         return {
             'detail': message,
             'source': {
-                'pointer': pointer
+                'pointer': '/'.join(pointer)
             }
         }
 

tests/test_schema.py

@@ -375,7 +375,8 @@ class Meta:
 
 def get_error_by_field(errors, field):
     for err in errors['errors']:
-        if err['source']['pointer'].split('/data/attributes/')[1] == field:
+        # Relationship error pointers won't match with this.
+        if err['source']['pointer'].endswith('/' + field):
             return err
     return None
 
@@ -489,6 +490,24 @@ def test_validate_type(self):
             ]
         }
 
+    def test_validate_id(self):
+        """ the pointer for id should be at the data object, not attributes """
+        author = {'data': {'type': 'people', 'id': 'invalid',
+                           'attributes': {'first_name': 'Rob', 'password': 'correcthorses'}}}
+        errors = AuthorSchema().validate(author)
+        assert 'errors' in errors
+        assert len(errors['errors']) == 2
+
+        lname_err = get_error_by_field(errors, 'last_name')
+        assert lname_err
+        assert lname_err['source']['pointer'] == '/data/attributes/last_name'
+        assert lname_err['detail'] == 'Missing data for required field.'
+
+        id_err = get_error_by_field(errors, 'id')
+        assert id_err
+        assert id_err['source']['pointer'] == '/data/id'
+        assert id_err['detail'] == 'Not a valid integer.'
+
     def test_load(self):
         _, errors = AuthorSchema().load(make_author({'first_name': 'Dan', 'password': 'short'}))
         assert 'errors' in errors
@@ -520,6 +539,27 @@ def test_errors_many(self):
         assert 'source' in err
         assert err['source']['pointer'] == '/data/0/attributes/password'
 
+    def test_many_id_errors(self):
+        """ the pointer for id should be at the data object, not attributes """
+        author = {'data': [{'type': 'people', 'id': 'invalid',
+                            'attributes': {'first_name': 'Rob', 'password': 'correcthorses'}},
+                           {'type': 'people', 'id': '37',
+                            'attributes': {'first_name': 'Dan', 'last_name': 'Gebhardt',
+                                           'password': 'supersecret'}}]}
+        errors = AuthorSchema(many=True).validate(author)
+        assert 'errors' in errors
+        assert len(errors['errors']) == 2
+
+        lname_err = get_error_by_field(errors, 'last_name')
+        assert lname_err
+        assert lname_err['source']['pointer'] == '/data/0/attributes/last_name'
+        assert lname_err['detail'] == 'Missing data for required field.'
+
+        id_err = get_error_by_field(errors, 'id')
+        assert id_err
+        assert id_err['source']['pointer'] == '/data/0/id'
+        assert id_err['detail'] == 'Not a valid integer.'
+
 def dasherize(text):
     return text.replace('_', '-')