Merge pull request #7 from ngseer/allow-missing-attributes

Add support for resources without attributes
DeanWay · Oct 7, 2019 · 49eb4c5 · 49eb4c5
2 parents 135f9c7 + 28a649b
commit 49eb4c5
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 9 deletions.
diff --git a/pydantic_jsonapi/response.py b/pydantic_jsonapi/response.py
@@ -1,10 +1,8 @@
 from typing import Generic, TypeVar, Optional, List, Any, Type
 from typing_extensions import Literal
 
-from pydantic import validator
 from pydantic.generics import GenericModel
 
-from pydantic_jsonapi.errors import Error
 from pydantic_jsonapi.filter import filter_none
 from pydantic_jsonapi.relationships import RelationshipsType
 from pydantic_jsonapi.resource_links import ResourceLinks
@@ -17,9 +15,12 @@ class ResponseDataModel(GenericModel, Generic[TypeT, AttributesT]):
     """
     id: str
     type: TypeT
-    attributes: AttributesT
+    attributes: AttributesT = {}
     relationships: Optional[RelationshipsType]
 
+    class Config:
+        validate_all = True
+
 
 DataT = TypeVar('DataT')
 class ResponseModel(GenericModel, Generic[DataT]):

diff --git a/tests/test_response.py b/tests/test_response.py
@@ -13,8 +13,8 @@ def test_attributes_as_dict(self):
             'data': {'id': '123', 'type': 'item', 'attributes': {}},
             'included': [{'id': '456', 'type': 'not-an-item', 'attributes': {}}]
         }
-        my_request_obj = MyResponse(**obj_to_validate)
-        assert my_request_obj.dict() == {
+        my_response_object = MyResponse(**obj_to_validate)
+        assert my_response_object.dict() == {
             'data': {
                 'id': '123',
                 'type': 'item',
@@ -27,6 +27,38 @@ def test_attributes_as_dict(self):
             }]
         }
 
+    def test_missing_attributes_dict(self):
+        MyResponse = JsonApiResponse('item', dict)
+        obj_to_validate = {
+            'data': {'id': '123', 'type': 'item'}
+        }
+        my_response_object = MyResponse(**obj_to_validate)
+        assert my_response_object.dict() == {
+            'data': {
+                'id': '123',
+                'type': 'item',
+                'attributes': {},
+            }
+        }
+
+    def test_missing_attributes_empty_model(self):
+        class EmptyModel(BaseModel):
+            pass
+
+        MyResponse = JsonApiResponse('item', EmptyModel)
+        obj_to_validate = {
+            'data': {'id': '123', 'type': 'item'}
+        }
+        my_response_object = MyResponse(**obj_to_validate)
+        assert my_response_object.dict() == {
+            'data': {
+                'id': '123',
+                'type': 'item',
+                'attributes': {},
+            }
+        }
+        assert isinstance(my_response_object.data.attributes, EmptyModel)
+
     def test_attributes_as_item_model(self):
         ItemResponse = JsonApiResponse('item', ItemModel)
         obj_to_validate = {
@@ -47,8 +79,8 @@ def test_attributes_as_item_model(self):
                 },
             }
         }
-        my_request_obj = ItemResponse(**obj_to_validate)
-        assert my_request_obj.dict() == {
+        my_response_obj = ItemResponse(**obj_to_validate)
+        assert my_response_obj.dict() == {
             'data': {
                 'id': '123',
                 'type': 'item',
@@ -91,8 +123,8 @@ def test_list_item_model(self):
                 },
             ],
         }
-        my_request_obj = ItemResponse(**obj_to_validate)
-        assert my_request_obj.dict() == {
+        my_response_obj = ItemResponse(**obj_to_validate)
+        assert my_response_obj.dict() == {
             'data': [
                 {
                     'id': '123',