Merge pull request #48 from salesforce/bugfix/apply-filters-to-dicts

Bugfix/apply filters to dicts

Author: dshafer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.22.1
+current_version = 0.22.2
 
 [bumpversion:file:setup.py]
 

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic
 Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [0.22.2] - 2020-08-11
+### Fixed
+- [PR](https://github.com/salesforce/django-declarative-apis/pull/48) Apply filters to dict values
+
 # [0.22.1] - 2020-08-11
 ### Fixed
 - [PR]() Fix travis config

django_declarative_apis/machinery/__init__.py

@@ -182,19 +182,6 @@ def get_response(self):
                     return status_code, data
                 else:
                     raise HttpStatusCode(data)
-            elif isinstance(data, dict):
-                result = {}
-                for key, value in data.items():
-                    if isinstance(value, (list, tuple, models.query.QuerySet)):
-                        result[key] = []
-                        for item in value:
-                            result[key].append(
-                                apply_filters_to_object(item, filter_def)
-                            )
-                    else:
-                        result[key] = value
-
-                return status_code, result
             else:
                 return (
                     status_code,

django_declarative_apis/machinery/filtering.py

@@ -115,6 +115,13 @@ def _apply_filters_to_object(inst, filter_def, expand_children=None, klass=None)
             )
             for item in inst
         ]
+    elif isinstance(inst, (dict,)):
+        return {
+            k: _apply_filters_to_object(
+                v, filter_def, expand_children=expand_children, klass=v.__class__
+            )
+            for k, v in inst.items()
+        }
 
     fields_def = filter_def.get(klass)
     if fields_def is None:

docs/source/conf.py

@@ -73,7 +73,7 @@
 # built documents.
 
 # The full version, including alpha/beta/rc tags.
-release = '0.22.1'  # set by bumpversion
+release = '0.22.2'  # set by bumpversion
 
 # The short X.Y version.
 version = release.rsplit('.', 1)[0]

setup.py

@@ -20,7 +20,7 @@
 
 setuptools.setup(
     name="django-declarative-apis",
-    version="0.22.1",  # set by bumpversion
+    version="0.22.2",  # set by bumpversion
     author="Drew Shafer",
     url="https://salesforce.com",
     description="Simple, readable, declarative APIs for Django",

tests/machinery/test_base.py

@@ -14,6 +14,7 @@
 import kombu.exceptions
 import mock
 from django.core.cache import cache
+from django.http import HttpRequest
 
 import tests.models
 from django_declarative_apis import machinery, models as dda_models
@@ -291,10 +292,15 @@ def resource(self):
             def response(self):
                 return {"people": self.resource}
 
+            def __call__(self):
+                return self
+
         endpoint = _TestEndpoint()
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
+
         status, resp = manager.get_response()
         self.assertEqual(status, http.HTTPStatus.OK)
         # make sure the list is in the expected order
@@ -723,7 +729,12 @@ def __init__(self, expected_response, *args, **kwargs):
         super(_TestEndpoint, self).__init__(*args, **kwargs)
         self.expected_response = expected_response
 
-    @machinery.endpoint_resource(type=tests.models.TestModel, filter={"foo": "bar"})
+    def __call__(self):
+        return self
+
+    @machinery.endpoint_resource(
+        type=tests.models.TestModel, filter={str: filtering.ALWAYS}
+    )
     def resource(self):
         return tests.models.TestModel(int_field=0)
 
@@ -785,6 +796,7 @@ def test_get_response_kombu_error_retried(self):
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
 
         conf = tasks.future_task_runner.app.conf
         old_val = conf["task_always_eager"]
@@ -824,6 +836,7 @@ def test_async_task_falls_back_to_synchronous_when_configured(self):
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
 
         conf = tasks.future_task_runner.app.conf
         old_val = conf["task_always_eager"]
@@ -852,6 +865,7 @@ def test_force_synchronous_tasks(self):
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
 
         conf = tasks.future_task_runner.app.conf
         old_val = conf["task_always_eager"]
@@ -881,6 +895,7 @@ def test_get_response_kombu_error_attempts_exceeded(self):
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
 
         conf = tasks.future_task_runner.app.conf
         old_val = conf["task_always_eager"]
@@ -924,6 +939,7 @@ def test_get_response_success(self):
         manager = machinery.EndpointBinder.BoundEndpointManager(
             machinery._EndpointRequestLifecycleManager(endpoint), endpoint
         )
+        machinery.EndpointBinder(endpoint).create_bound_endpoint(manager, HttpRequest())
 
         # can't use mock.patch.dict here because it doesn't implement the api that the unpatcher expects
         conf = tasks.future_task_runner.app.conf

tests/tests.py

@@ -28,6 +28,29 @@ def test_simplest_endpoint(self):
             "/simple", consumer=self.consumer, expected_status_code=HTTPStatus.OK
         )
 
+    def test_dict_endpoint(self):
+        resp = self.client.get(
+            "/dict", consumer=self.consumer, expected_status_code=HTTPStatus.OK
+        )
+        data = resp.json()
+        self.assertEqual(
+            data,
+            {
+                "test": {
+                    "pk": 1,
+                    "int_field": 1,
+                    "__expandable__": ["expandable_dict", "expandable_string"],
+                },
+                "deep_test": {
+                    "test": {
+                        "pk": 1,
+                        "int_field": 1,
+                        "__expandable__": ["expandable_dict", "expandable_string"],
+                    }
+                },
+            },
+        )
+
     def test_typed_parameter(self):
         response = self.client.get(
             "/simple?int_type_field=not_an_int",

tests/urls.py

@@ -13,4 +13,7 @@
 
 UUID4_REGEX = r"[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}"
 
-urlpatterns = [url(r"^simple", resource_adapter(get=views.SimpleEndpointDefinition))]
+urlpatterns = [
+    url(r"^simple", resource_adapter(get=views.SimpleEndpointDefinition)),
+    url(r"^dict", resource_adapter(get=views.DictEndpointDefinition)),
+]

tests/views.py

@@ -34,3 +34,13 @@ def execution_decider(self):
     @staticmethod
     def deferred_task(inst):
         cache.set("deferred_task_called", True)
+
+
+class DictEndpointDefinition(EndpointDefinition):
+    def is_authorized(self):
+        return True
+
+    @endpoint_resource(type=TestModel)
+    def resource(self):
+        inst = TestModel.objects.create(int_field=1)
+        return {"test": inst, "deep_test": {"test": inst}}