Various fixes to bring the example app up to speed (#55)

* various fixes to bring the example app up to speed

* black format, changelog update

* review feedback

Author: demianbrecht

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.3] - 2021-05-18
+### Fixed
+- [PR 55](https://github.com/salesforce/django-declarative-apis/pull/55) Backwards compatibility fix for field expansion headers, update example app
+
 # [0.22.2] - 2020-08-11
 ### Fixed
 - [PR](https://github.com/salesforce/django-declarative-apis/pull/48) Apply filters to dict values

django_declarative_apis/machinery/__init__.py

@@ -183,13 +183,14 @@ def get_response(self):
                 else:
                     raise HttpStatusCode(data)
             else:
+                try:
+                    x_expand = self.bound_endpoint.request.META.get("HTTP_X_EXPAND")
+                except AttributeError:
+                    x_expand = ""
+
                 return (
                     status_code,
-                    apply_filters_to_object(
-                        data,
-                        filter_def,
-                        self.bound_endpoint.request.META.get("HTTP_X_EXPAND"),
-                    ),
+                    apply_filters_to_object(data, filter_def, x_expand),
                 )
 
     def __init__(self, endpoint_definition):

example/example/settings.py

@@ -126,6 +126,12 @@
 DECLARATIVE_ENDPOINT_RESOURCE_ADAPTER = (
     "django_declarative_apis.adapters.EndpointResource"
 )
-DECLARATIVE_ENDPOINT_AUTHENTICATION_HANDLERS = (
-    "django_declarative_apis.authentication.oauthlib.oauth1.TwoLeggedOauth1",
-)
+DECLARATIVE_ENDPOINT_AUTHENTICATION_HANDLERS = [
+    (
+        (
+            None,
+            "django_declarative_apis.authentication.oauthlib.oauth1.TwoLeggedOauth1Hint",
+        ),
+        "django_declarative_apis.authentication.oauthlib.oauth1.TwoLeggedOauth1",
+    )
+]

example/manage.py

@@ -1,11 +1,11 @@
+#!/usr/bin/env python
 #
 # Copyright (c) 2019, salesforce.com, inc.
 # All rights reserved.
 # SPDX-License-Identifier: BSD-3-Clause
 # For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 #
 
-#!/usr/bin/env python
 import os
 import sys
 

example/myapp/models.py

@@ -10,5 +10,7 @@
 
 
 class User(models.Model):
-    consumer = models.ForeignKey(django_declarative_apis.models.OauthConsumer)
+    consumer = models.ForeignKey(
+        django_declarative_apis.models.OauthConsumer, on_delete=models.CASCADE
+    )
     name = models.CharField(max_length=50, null=False, blank=False)

example/myapp/resources.py

@@ -5,6 +5,10 @@
 # For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 #
 
+import json
+
+import django.http
+
 from django_declarative_apis import machinery, models
 from django_declarative_apis.machinery import filtering
 
@@ -65,6 +69,10 @@ class PingDefinition(machinery.BaseEndpointDefinition):
     """A basic "ping" endpoint
     """
 
+    # filter definition for the resource. values will be masked by default (i.e. without this, the user would get
+    # '{"ping": null}' in the response body.
+    response_filter = {str: filtering.ALWAYS}
+
     def is_authorized(self):
         """User should always be authorized
         """
@@ -73,8 +81,5 @@ def is_authorized(self):
     @property
     def resource(self):
         """The endpoint resource
-
-        Endpoint resources can be implemented as either properties or machinery.endpoint_resources.
-        The latter will require filters to be defined.
         """
         return {"ping": "pong"}

example/myapp/urls.py

@@ -7,12 +7,13 @@
 
 from django.conf.urls import url
 
+from django_declarative_apis import authentication
 from django_declarative_apis.adapters import resource_adapter
 
 from myapp import resources
 
 
-class NoAuth:
+class NoAuth(authentication.Authenticator):
     """A custom NoAuth class to treat all requests as authenticated
 
     By default, django-declarative-apis requires authentication. This allows us to get around that.
@@ -22,13 +23,19 @@ class NoAuth:
     def is_authenticated(request):
         return True
 
+    def challenge(self, error):
+        super().challenge(error)
+
 
 urlpatterns = [
     url(
         r"^me$",
         resource_adapter(get=resources.MeDefinition, post=resources.MeUpdateDefinition),
     ),
     url(
-        r"^ping$", resource_adapter(get=resources.PingDefinition, authentication=NoAuth)
+        r"^ping$",
+        resource_adapter(
+            get=resources.PingDefinition, authentication={None: (NoAuth(),)}
+        ),
     ),
 ]