Add resource_identifier option

Author: RazerM

marshmallow_jsonapi/schema.py

@@ -79,6 +79,7 @@ class Meta:
 
     def __init__(self, *args, **kwargs):
         self.include_data = kwargs.pop('include_data', ())
+        self.resource_identifier = kwargs.pop('resource_identifier', False)
         super(Schema, self).__init__(*args, **kwargs)
         if self.include_data:
             self.check_relations(self.include_data)
@@ -336,13 +337,19 @@ def format_item(self, item):
                         ret['relationships'] = self.dict_class()
                     ret['relationships'][self.inflect(field_name)] = value
             else:
+                # Resource identifier objects don't get attributes.
+                if self.resource_identifier:
+                    continue
+
                 if 'attributes' not in ret:
                     ret['attributes'] = self.dict_class()
                 ret['attributes'][self.inflect(field_name)] = value
 
-        links = self.get_resource_links(item)
-        if links:
-            ret['links'] = links
+        # Resource identifier objects don't get links
+        if not self.resource_identifier:
+            links = self.get_resource_links(item)
+            if links:
+                ret['links'] = links
         return ret
 
     def format_items(self, data, many):

tests/test_schema.py

@@ -176,6 +176,34 @@ def test_dump_empty_list(self):
         assert 'links' in data
         assert data['links']['self'] == '/authors/'
 
+    def test_dump_single_resource_identifer(self, author):
+        data = AuthorSchema(resource_identifier=True).dump(author).data
+
+        assert data == {
+            'data': {'id': author.id, 'type': 'people'},
+            'links': {'self': '/authors/' + str(author.id)}
+        }
+
+    def test_dump_many_resource_identifer(self, authors):
+        schema = AuthorSchema(many=True, resource_identifier=True)
+        data = schema.dump(authors).data
+
+        assert set(data.keys()) == {'data', 'links'}
+        assert data['links'] == {'self': '/authors/'}
+        for i, author in enumerate(authors):
+            assert data['data'][i] == {'id': authors[i].id, 'type': 'people'}
+
+    def test_dump_none_resource_identifier(self):
+        data = AuthorSchema(resource_identifier=True).dump(None).data
+
+        assert 'data' in data
+        assert data['data'] is None
+        assert 'links' not in data
+
+    def test_dump_empty_list_resource_identifier(self):
+        data = AuthorSchema(many=True, resource_identifier=True).dump([]).data
+        assert data == {'data': [], 'links': {'self': '/authors/'}}
+
 
 class TestCompoundDocuments: