Include metadata in Parser output

The JSONParser will add metadata in the request under a top level key '_meta'.

Author: Hamed Ahmadi

example/tests/test_parsers.py

@@ -0,0 +1,38 @@
+import json
+
+from django.test import TestCase
+from io import BytesIO
+from rest_framework_json_api.parsers import JSONParser
+
+
+class TestJSONParser(TestCase):
+
+    def setUp(self):
+        class MockRequest(object):
+
+            def __init__(self):
+                self.method = 'GET'
+
+        request = MockRequest()
+
+        self.parser_context = {'request': request, 'kwargs': {}, 'view': 'BlogViewSet'}
+
+        data = {
+            'data': {
+                'id': 123,
+                'type': 'Blog'
+            },
+            'meta': {
+                'random_key': 'random_value'
+            }
+        }
+
+        self.string = json.dumps(data)
+
+    def test_parse_include_metadata(self):
+        parser = JSONParser()
+
+        stream = BytesIO(self.string.encode('utf-8'))
+        data = parser.parse(stream, None, self.parser_context)
+
+        self.assertEqual(data['_meta'], {'random_key': 'random_value'})

rest_framework_json_api/parsers.py

@@ -46,6 +46,14 @@ def parse_relationships(data):
                 parsed_relationships[field_name] = list(relation for relation in field_data)
         return parsed_relationships
 
+    @staticmethod
+    def parse_metadata(result):
+        metadata = result.get('meta')
+        if metadata:
+            return {'_meta': metadata}
+        else:
+            return {}
+
     def parse(self, stream, media_type=None, parser_context=None):
         """
         Parses the incoming bytestream as JSON and returns the resulting data
@@ -87,6 +95,7 @@ def parse(self, stream, media_type=None, parser_context=None):
             parsed_data = {'id': data.get('id')}
             parsed_data.update(self.parse_attributes(data))
             parsed_data.update(self.parse_relationships(data))
+            parsed_data.update(self.parse_metadata(result))
             return parsed_data
 
         else: