From 3063a50fc20f0bfb7308e668cf083c5ae0876dac Mon Sep 17 00:00:00 2001 From: Edmond Wong Date: Fri, 30 Aug 2013 18:03:44 -0700 Subject: [PATCH 1/2] Allow OPTIONS to retrieve PUT field metadata on empty objects This allows OPTIONS to return the PUT endpoint's object serializer metadata when the object hasn't been created yet. --- rest_framework/generics.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/rest_framework/generics.py b/rest_framework/generics.py index 14feed204..4d909ef1c 100644 --- a/rest_framework/generics.py +++ b/rest_framework/generics.py @@ -356,8 +356,13 @@ class GenericAPIView(views.APIView): self.check_permissions(cloned_request) # Test object permissions if method == 'PUT': - self.get_object() - except (exceptions.APIException, PermissionDenied, Http404): + try: + self.get_object() + except Http404: + # Http404 should be acceptable and the serializer + # metadata should be populated. + pass + except (exceptions.APIException, PermissionDenied): pass else: # If user has appropriate permissions for the view, include From 6e7e4fc01c5ddaf668f17f1d1f201a14a26f72f3 Mon Sep 17 00:00:00 2001 From: Edmond Wong Date: Tue, 3 Sep 2013 12:30:18 -0700 Subject: [PATCH 2/2] Added test for OPTIONS before object creation from a PUT --- rest_framework/generics.py | 4 ++- rest_framework/tests/test_generics.py | 42 +++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/rest_framework/generics.py b/rest_framework/generics.py index 4d909ef1c..7d1bf7945 100644 --- a/rest_framework/generics.py +++ b/rest_framework/generics.py @@ -360,7 +360,9 @@ class GenericAPIView(views.APIView): self.get_object() except Http404: # Http404 should be acceptable and the serializer - # metadata should be populated. + # metadata should be populated. Except this so the + # outer "else" clause of the try-except-else block + # will be executed. pass except (exceptions.APIException, PermissionDenied): pass diff --git a/rest_framework/tests/test_generics.py b/rest_framework/tests/test_generics.py index 7a87d3892..79cd99ac5 100644 --- a/rest_framework/tests/test_generics.py +++ b/rest_framework/tests/test_generics.py @@ -272,6 +272,48 @@ class TestInstanceView(TestCase): self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data, expected) + def test_options_before_instance_create(self): + """ + OPTIONS requests to RetrieveUpdateDestroyAPIView should return metadata + before the instance has been created + """ + request = factory.options('/999') + with self.assertNumQueries(1): + response = self.view(request, pk=999).render() + expected = { + 'parses': [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ], + 'renders': [ + 'application/json', + 'text/html' + ], + 'name': 'Instance', + 'description': 'Example description for OPTIONS.', + 'actions': { + 'PUT': { + 'text': { + 'max_length': 100, + 'read_only': False, + 'required': True, + 'type': 'string', + 'label': 'Text comes here', + 'help_text': 'Text description.' + }, + 'id': { + 'read_only': True, + 'required': False, + 'type': 'integer', + 'label': 'ID', + }, + } + } + } + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.data, expected) + def test_get_instance_view_incorrect_arg(self): """ GET requests with an incorrect pk type, should raise 404, not 500.