Adds a custom encoder to serialize resources

Author: benedikt

src/userlist/client.py

@@ -1,5 +1,6 @@
 import json
 import requests
+from .encoder import Encoder
 
 
 class Client:
@@ -21,7 +22,11 @@ def _request(self, method, endpoint, payload=None):
         response = self.session.request(
             method,
             url,
-            **({"data": json.dumps(payload)} if payload is not None else {}),
+            **(
+                {"data": json.dumps(payload, cls=Encoder)}
+                if payload is not None
+                else {}
+            ),
             timeout=self.timeout,
         )
         response.raise_for_status()

src/userlist/encoder.py

@@ -0,0 +1,10 @@
+from json import JSONEncoder
+from .resource import Resource
+
+
+class Encoder(JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Resource):
+            return obj.to_dict()
+
+        return super().default(obj)

tests/test_encoder.py

@@ -0,0 +1,34 @@
+import json
+import pytest
+from userlist.encoder import Encoder
+from userlist.resource import Resource
+
+
+def test_encoder_with_resource():
+    class TestResource(Resource):
+        pass
+
+    test_data = {"name": "test", "value": 123}
+    resource = TestResource(test_data)
+    encoded = json.dumps(resource, cls=Encoder)
+    assert json.loads(encoded) == test_data
+
+
+def test_encoder_with_regular_types():
+    test_data = {
+        "string": "test",
+        "number": 123,
+        "boolean": True,
+        "list": [1, 2, 3],
+        "dict": {"key": "value"},
+    }
+    encoded = json.dumps(test_data, cls=Encoder)
+    assert json.loads(encoded) == test_data
+
+
+def test_encoder_with_unsupported_type():
+    class UnsupportedType:
+        pass
+
+    with pytest.raises(TypeError):
+        json.dumps(UnsupportedType(), cls=Encoder)