From d198b1abe6b96bbdd84e4c2622d996f770c69edd Mon Sep 17 00:00:00 2001 From: Andrea Grandi Date: Mon, 29 May 2017 17:07:50 +0100 Subject: [PATCH 01/20] Add Django manage command to create a DRF user Token --- .../authtoken/management/__init__.py | 0 .../authtoken/management/commands/__init__.py | 0 .../management/commands/drf_create_token.py | 20 +++++++++++++++++++ tests/test_authtoken.py | 15 ++++++++++++++ 4 files changed, 35 insertions(+) create mode 100644 rest_framework/authtoken/management/__init__.py create mode 100644 rest_framework/authtoken/management/commands/__init__.py create mode 100644 rest_framework/authtoken/management/commands/drf_create_token.py diff --git a/rest_framework/authtoken/management/__init__.py b/rest_framework/authtoken/management/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/rest_framework/authtoken/management/commands/__init__.py b/rest_framework/authtoken/management/commands/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/rest_framework/authtoken/management/commands/drf_create_token.py b/rest_framework/authtoken/management/commands/drf_create_token.py new file mode 100644 index 000000000..ccd400ed5 --- /dev/null +++ b/rest_framework/authtoken/management/commands/drf_create_token.py @@ -0,0 +1,20 @@ +from django.contrib.auth.models import User +from django.core.management.base import BaseCommand +from rest_framework.authtoken.models import Token + + +class Command(BaseCommand): + help = 'Create DRF Token for a given user' + + def create_user_token(self, username): + user = User.objects.get(username=username) + token = Token.objects.get_or_create(user=user) + return token[0] + + def add_arguments(self, parser): + parser.add_argument('username', type=str, nargs='+') + + def handle(self, *args, **options): + username = options['username'] + token = self.create_user_token(username) + print('Generated token {0} for user {1}'.format(token.key, username)) diff --git a/tests/test_authtoken.py b/tests/test_authtoken.py index 54ac1848d..3b5a618e3 100644 --- a/tests/test_authtoken.py +++ b/tests/test_authtoken.py @@ -4,6 +4,8 @@ from django.contrib.auth.models import User from django.test import TestCase from rest_framework.authtoken.admin import TokenAdmin +from rest_framework.authtoken.management.commands.drf_create_token import \ + Command as AuthTokenCommand from rest_framework.authtoken.models import Token from rest_framework.authtoken.serializers import AuthTokenSerializer from rest_framework.exceptions import ValidationError @@ -33,3 +35,16 @@ class AuthTokenTests(TestCase): self.user.set_password(data['password']) self.user.save() assert AuthTokenSerializer(data=data).is_valid() + + +class AuthTokenCommandTests(TestCase): + + def setUp(self): + self.site = site + self.user = User.objects.create_user(username='test_user') + + def test_command_create_user_token(self): + token = AuthTokenCommand().create_user_token(self.user.username) + assert token is not None + token_saved = Token.objects.first() + assert token.key == token_saved.key From 84e22cc2f3866078a06a464636e4ec6c1a7fec47 Mon Sep 17 00:00:00 2001 From: Bekhzod Tillakhanov Date: Tue, 30 May 2017 00:15:07 +0500 Subject: [PATCH 02/20] Scheme fix when unauth and Flask8 lint fix --- rest_framework/templates/rest_framework/docs/document.html | 3 ++- rest_framework/templates/rest_framework/docs/sidebar.html | 2 ++ tests/test_atomic_requests.py | 1 + tests/test_fields.py | 1 - tests/test_permissions.py | 3 +++ tests/test_renderers.py | 1 + tests/test_request.py | 1 + tests/test_response.py | 1 + tests/test_reverse.py | 1 + tests/test_schemas.py | 1 + tests/test_validation.py | 1 + 11 files changed, 14 insertions(+), 2 deletions(-) diff --git a/rest_framework/templates/rest_framework/docs/document.html b/rest_framework/templates/rest_framework/docs/document.html index ef5f5966b..274eee4e3 100644 --- a/rest_framework/templates/rest_framework/docs/document.html +++ b/rest_framework/templates/rest_framework/docs/document.html @@ -13,7 +13,7 @@ {% if 'javascript' in langs %}{% include "rest_framework/docs/langs/javascript-intro.html" %}{% endif %} - +{% if document.data %} {% for section_key, section in document.data|items %} {% if section_key %}

{{ section_key }} @@ -28,3 +28,4 @@ {% for link_key, link in document.links|items %} {% include "rest_framework/docs/link.html" %} {% endfor %} +{% endif %} diff --git a/rest_framework/templates/rest_framework/docs/sidebar.html b/rest_framework/templates/rest_framework/docs/sidebar.html index c6ac26f66..f5f84a2e5 100644 --- a/rest_framework/templates/rest_framework/docs/sidebar.html +++ b/rest_framework/templates/rest_framework/docs/sidebar.html @@ -5,6 +5,7 @@
{% endfor %} + {% endif %}
    diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index 9085bfc89..f925ce3d3 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -45,6 +45,7 @@ class NonAtomicAPIExceptionView(APIView): BasicModel.objects.all() raise Http404 + urlpatterns = ( url(r'^$', NonAtomicAPIExceptionView.as_view()), ) diff --git a/tests/test_fields.py b/tests/test_fields.py index 968c41d3f..e370326f5 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1132,7 +1132,6 @@ class TestDateTimeField(FieldValues): valid_inputs = { '2001-01-01 13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), '2001-01-01T13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), - '2001-01-01T13:00Z': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), datetime.datetime(2001, 1, 1, 13, 00): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), # Django 1.4 does not support timezone string parsing. diff --git a/tests/test_permissions.py b/tests/test_permissions.py index cabf66883..6fbf766a0 100644 --- a/tests/test_permissions.py +++ b/tests/test_permissions.py @@ -246,6 +246,7 @@ class ObjectPermissionInstanceView(generics.RetrieveUpdateDestroyAPIView): authentication_classes = [authentication.BasicAuthentication] permission_classes = [ViewObjectPermissions] + object_permissions_view = ObjectPermissionInstanceView.as_view() @@ -255,6 +256,7 @@ class ObjectPermissionListView(generics.ListAPIView): authentication_classes = [authentication.BasicAuthentication] permission_classes = [ViewObjectPermissions] + object_permissions_list_view = ObjectPermissionListView.as_view() @@ -443,6 +445,7 @@ class DeniedObjectView(PermissionInstanceView): class DeniedObjectViewWithDetail(PermissionInstanceView): permission_classes = (BasicObjectPermWithDetail,) + denied_view = DeniedView.as_view() denied_view_with_detail = DeniedViewWithDetail.as_view() diff --git a/tests/test_renderers.py b/tests/test_renderers.py index 09cef435e..1625b0b70 100644 --- a/tests/test_renderers.py +++ b/tests/test_renderers.py @@ -108,6 +108,7 @@ class HTMLView1(APIView): def get(self, request, **kwargs): return Response('text') + urlpatterns = [ url(r'^.*\.(?P.+)$', MockView.as_view(renderer_classes=[RendererA, RendererB])), url(r'^$', MockView.as_view(renderer_classes=[RendererA, RendererB])), diff --git a/tests/test_request.py b/tests/test_request.py index 428b969f5..2cf9320ea 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -120,6 +120,7 @@ class MockView(APIView): return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR) + urlpatterns = [ url(r'^$', MockView.as_view()), ] diff --git a/tests/test_response.py b/tests/test_response.py index 33c51e773..e92bf54c1 100644 --- a/tests/test_response.py +++ b/tests/test_response.py @@ -32,6 +32,7 @@ class MockJsonRenderer(BaseRenderer): class MockTextMediaRenderer(BaseRenderer): media_type = 'text/html' + DUMMYSTATUS = status.HTTP_200_OK DUMMYCONTENT = 'dummycontent' diff --git a/tests/test_reverse.py b/tests/test_reverse.py index 2ca44ab77..47eda256e 100644 --- a/tests/test_reverse.py +++ b/tests/test_reverse.py @@ -13,6 +13,7 @@ factory = APIRequestFactory() def null_view(request): pass + urlpatterns = [ url(r'^view$', null_view, name='view'), ] diff --git a/tests/test_schemas.py b/tests/test_schemas.py index 24131480f..2b8673480 100644 --- a/tests/test_schemas.py +++ b/tests/test_schemas.py @@ -70,6 +70,7 @@ class ExampleViewSet(ModelViewSet): assert self.action return super(ExampleViewSet, self).get_serializer(*args, **kwargs) + if coreapi: schema_view = get_schema_view(title='Example API') else: diff --git a/tests/test_validation.py b/tests/test_validation.py index 8ff4aaf38..8b71693c5 100644 --- a/tests/test_validation.py +++ b/tests/test_validation.py @@ -243,6 +243,7 @@ class RegexSerializer(serializers.Serializer): validators=[RegexValidator(regex=re.compile('^[0-9]{4,6}$'), message='A PIN is 4-6 digits')]) + expected_repr = """ RegexSerializer(): pin = CharField(validators=[]) From c96fa224c70964e4384a803d9ae9b18347388a80 Mon Sep 17 00:00:00 2001 From: Bekhzod Tillakhanov Date: Tue, 30 May 2017 00:29:11 +0500 Subject: [PATCH 03/20] Fix ul inner li --- rest_framework/templates/rest_framework/docs/sidebar.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rest_framework/templates/rest_framework/docs/sidebar.html b/rest_framework/templates/rest_framework/docs/sidebar.html index f5f84a2e5..7e20e2485 100644 --- a/rest_framework/templates/rest_framework/docs/sidebar.html +++ b/rest_framework/templates/rest_framework/docs/sidebar.html @@ -9,12 +9,12 @@ {% for section_key, section in document.data|items %} - + {% endfor %} {% endif %}
From 31d6ef1ba2829189c9aac6bd669a32c25d93840d Mon Sep 17 00:00:00 2001 From: Bekhzod Tillakhanov Date: Tue, 30 May 2017 20:36:46 +0500 Subject: [PATCH 04/20] Remove new line --- tests/test_request.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_request.py b/tests/test_request.py index 2cf9320ea..428b969f5 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -120,7 +120,6 @@ class MockView(APIView): return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR) - urlpatterns = [ url(r'^$', MockView.as_view()), ] From be590d61c09805955d89231cff84fd6fd1ab1ecb Mon Sep 17 00:00:00 2001 From: Andrea Grandi Date: Wed, 31 May 2017 23:01:35 +0100 Subject: [PATCH 05/20] Handle invalid User situation --- .../authtoken/management/commands/drf_create_token.py | 8 +++++++- tests/test_authtoken.py | 4 ++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/rest_framework/authtoken/management/commands/drf_create_token.py b/rest_framework/authtoken/management/commands/drf_create_token.py index ccd400ed5..8419614de 100644 --- a/rest_framework/authtoken/management/commands/drf_create_token.py +++ b/rest_framework/authtoken/management/commands/drf_create_token.py @@ -16,5 +16,11 @@ class Command(BaseCommand): def handle(self, *args, **options): username = options['username'] - token = self.create_user_token(username) + + try: + token = self.create_user_token(username) + except User.DoesNotExist: + print('Cannot create the Token: user {0} does not exist'.format( + username + )) print('Generated token {0} for user {1}'.format(token.key, username)) diff --git a/tests/test_authtoken.py b/tests/test_authtoken.py index 3b5a618e3..407d82944 100644 --- a/tests/test_authtoken.py +++ b/tests/test_authtoken.py @@ -48,3 +48,7 @@ class AuthTokenCommandTests(TestCase): assert token is not None token_saved = Token.objects.first() assert token.key == token_saved.key + + def test_command_create_user_token_invalid_user(self): + with pytest.raises(User.DoesNotExist): + AuthTokenCommand().create_user_token('not_existing_user') From cf196a442490339032ecfeefe4e88581d579e209 Mon Sep 17 00:00:00 2001 From: Andrea Grandi Date: Sat, 3 Jun 2017 10:38:01 +0100 Subject: [PATCH 06/20] Get UserModel from get_user_model and do not infer the natural key --- .../authtoken/management/commands/drf_create_token.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/rest_framework/authtoken/management/commands/drf_create_token.py b/rest_framework/authtoken/management/commands/drf_create_token.py index 8419614de..2dc333a6b 100644 --- a/rest_framework/authtoken/management/commands/drf_create_token.py +++ b/rest_framework/authtoken/management/commands/drf_create_token.py @@ -1,13 +1,16 @@ -from django.contrib.auth.models import User +from django.contrib.auth import get_user_model from django.core.management.base import BaseCommand from rest_framework.authtoken.models import Token +UserModel = get_user_model() + + class Command(BaseCommand): help = 'Create DRF Token for a given user' def create_user_token(self, username): - user = User.objects.get(username=username) + user = UserModel._default_manager.get_by_natural_key(username) token = Token.objects.get_or_create(user=user) return token[0] @@ -19,7 +22,7 @@ class Command(BaseCommand): try: token = self.create_user_token(username) - except User.DoesNotExist: + except UserModel.DoesNotExist: print('Cannot create the Token: user {0} does not exist'.format( username )) From 34c38e0cfe5e880e678704c4d473f082787fca64 Mon Sep 17 00:00:00 2001 From: Andrea Grandi Date: Sat, 3 Jun 2017 11:06:14 +0100 Subject: [PATCH 07/20] Use self.sdtout and CommandError to print output --- .../management/commands/drf_create_token.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/rest_framework/authtoken/management/commands/drf_create_token.py b/rest_framework/authtoken/management/commands/drf_create_token.py index 2dc333a6b..8fe47c44a 100644 --- a/rest_framework/authtoken/management/commands/drf_create_token.py +++ b/rest_framework/authtoken/management/commands/drf_create_token.py @@ -1,5 +1,5 @@ from django.contrib.auth import get_user_model -from django.core.management.base import BaseCommand +from django.core.management.base import BaseCommand, CommandError from rest_framework.authtoken.models import Token @@ -23,7 +23,9 @@ class Command(BaseCommand): try: token = self.create_user_token(username) except UserModel.DoesNotExist: - print('Cannot create the Token: user {0} does not exist'.format( - username - )) - print('Generated token {0} for user {1}'.format(token.key, username)) + raise CommandError( + 'Cannot create the Token: user {0} does not exist'.format( + username) + ) + self.stdout.write( + 'Generated token {0} for user {1}'.format(token.key, username)) From d2459710cae9e17b785e1d67b11d7bc9aa39678a Mon Sep 17 00:00:00 2001 From: Andrea Grandi Date: Sat, 3 Jun 2017 11:58:01 +0100 Subject: [PATCH 08/20] Implement option to reset User token --- .../management/commands/drf_create_token.py | 18 +++++++++++++++-- tests/test_authtoken.py | 20 +++++++++++++++++-- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/rest_framework/authtoken/management/commands/drf_create_token.py b/rest_framework/authtoken/management/commands/drf_create_token.py index 8fe47c44a..417bdd780 100644 --- a/rest_framework/authtoken/management/commands/drf_create_token.py +++ b/rest_framework/authtoken/management/commands/drf_create_token.py @@ -9,19 +9,33 @@ UserModel = get_user_model() class Command(BaseCommand): help = 'Create DRF Token for a given user' - def create_user_token(self, username): + def create_user_token(self, username, reset_token): user = UserModel._default_manager.get_by_natural_key(username) + + if reset_token: + Token.objects.filter(user=user).delete() + token = Token.objects.get_or_create(user=user) return token[0] def add_arguments(self, parser): parser.add_argument('username', type=str, nargs='+') + parser.add_argument( + '-r', + '--reset', + action='store_true', + dest='reset_token', + default=False, + help='Reset existing User token and create a new one', + ) + def handle(self, *args, **options): username = options['username'] + reset_token = options['reset_token'] try: - token = self.create_user_token(username) + token = self.create_user_token(username, reset_token) except UserModel.DoesNotExist: raise CommandError( 'Cannot create the Token: user {0} does not exist'.format( diff --git a/tests/test_authtoken.py b/tests/test_authtoken.py index 407d82944..6374d7141 100644 --- a/tests/test_authtoken.py +++ b/tests/test_authtoken.py @@ -44,11 +44,27 @@ class AuthTokenCommandTests(TestCase): self.user = User.objects.create_user(username='test_user') def test_command_create_user_token(self): - token = AuthTokenCommand().create_user_token(self.user.username) + token = AuthTokenCommand().create_user_token(self.user.username, False) assert token is not None token_saved = Token.objects.first() assert token.key == token_saved.key def test_command_create_user_token_invalid_user(self): with pytest.raises(User.DoesNotExist): - AuthTokenCommand().create_user_token('not_existing_user') + AuthTokenCommand().create_user_token('not_existing_user', False) + + def test_command_reset_user_token(self): + AuthTokenCommand().create_user_token(self.user.username, False) + first_token_key = Token.objects.first().key + AuthTokenCommand().create_user_token(self.user.username, True) + second_token_key = Token.objects.first().key + + assert first_token_key != second_token_key + + def test_command_do_not_reset_user_token(self): + AuthTokenCommand().create_user_token(self.user.username, False) + first_token_key = Token.objects.first().key + AuthTokenCommand().create_user_token(self.user.username, False) + second_token_key = Token.objects.first().key + + assert first_token_key == second_token_key From 0e5d26fa6a261e5437489cb4010bcd25d6632443 Mon Sep 17 00:00:00 2001 From: Venelin Stoykov Date: Thu, 22 Jun 2017 16:22:17 +0300 Subject: [PATCH 09/20] Fixed #5228 Set ViewSet args/kwargs/request before dispatch --- rest_framework/viewsets.py | 4 ++++ tests/test_viewsets.py | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/rest_framework/viewsets.py b/rest_framework/viewsets.py index 70fe72f84..7f3c550a9 100644 --- a/rest_framework/viewsets.py +++ b/rest_framework/viewsets.py @@ -82,6 +82,10 @@ class ViewSetMixin(object): if hasattr(self, 'get') and not hasattr(self, 'head'): self.head = self.get + self.request = request + self.args = args + self.kwargs = kwargs + # And continue as usual return self.dispatch(request, *args, **kwargs) diff --git a/tests/test_viewsets.py b/tests/test_viewsets.py index 78ad24dea..846a36807 100644 --- a/tests/test_viewsets.py +++ b/tests/test_viewsets.py @@ -13,6 +13,15 @@ class BasicViewSet(GenericViewSet): return Response({'ACTION': 'LIST'}) +class InstanceViewSet(GenericViewSet): + + def dispatch(self, request, *args, **kwargs): + return self.dummy(request, *args, **kwargs) + + def dummy(self, request, *args, **kwargs): + return Response({'view': self}) + + class InitializeViewSetsTestCase(TestCase): def test_initialize_view_set_with_actions(self): request = factory.get('/', '', content_type='application/json') @@ -42,3 +51,17 @@ class InitializeViewSetsTestCase(TestCase): "For example `.as_view({'get': 'list'})`") else: self.fail("actions must not be empty.") + + def test_args_kwargs_request_action_map_on_self(self): + """ + Test a view only has args, kwargs, request, action_map + once `as_view` has been called. + """ + bare_view = InstanceViewSet() + view = InstanceViewSet.as_view(actions={ + 'get': 'dummy', + })(factory.get('/')).data['view'] + + for attribute in ('args', 'kwargs', 'request', 'action_map'): + self.assertNotIn(attribute, dir(bare_view)) + self.assertIn(attribute, dir(view)) From 302a9d089eb239c17526482ec39b7c2b26733356 Mon Sep 17 00:00:00 2001 From: dmmatson Date: Fri, 23 Jun 2017 23:11:17 -0600 Subject: [PATCH 10/20] Fixed tests on Windows. Added unicode support to SlugField --- rest_framework/fields.py | 12 ++++++++---- tests/test_api_client.py | 24 ++++++++++++------------ tests/test_fields.py | 11 +++++++++++ 3 files changed, 31 insertions(+), 16 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 41d6105ca..769f11466 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -791,13 +791,17 @@ class RegexField(CharField): class SlugField(CharField): default_error_messages = { - 'invalid': _('Enter a valid "slug" consisting of letters, numbers, underscores or hyphens.') + 'invalid': _('Enter a valid "slug" consisting of letters, numbers, underscores or hyphens.'), + 'invalid_unicode': _('Enter a valid "slug" consisting of Unicode letters, numbers, underscores, or hyphens.') } - def __init__(self, **kwargs): + def __init__(self, allow_unicode=False, **kwargs): super(SlugField, self).__init__(**kwargs) - slug_regex = re.compile(r'^[-a-zA-Z0-9_]+$') - validator = RegexValidator(slug_regex, message=self.error_messages['invalid']) + self.allow_unicode = allow_unicode + if self.allow_unicode: + validator = RegexValidator(re.compile(r'^[-\w]+\Z', re.UNICODE), message=self.error_messages['invalid_unicode']) + else: + validator = RegexValidator(re.compile(r'^[-a-zA-Z0-9_]+$'), message=self.error_messages['invalid']) self.validators.append(validator) diff --git a/tests/test_api_client.py b/tests/test_api_client.py index 60c918701..e4354ec60 100644 --- a/tests/test_api_client.py +++ b/tests/test_api_client.py @@ -275,13 +275,13 @@ class APIClientTests(APITestCase): client = CoreAPIClient() schema = client.get('http://api.example.com/') - temp = tempfile.NamedTemporaryFile() - temp.write(b'example file content') - temp.flush() + with tempfile.NamedTemporaryFile() as temp: + temp.write(b'example file content') + temp.flush() + temp.seek(0) - with open(temp.name, 'rb') as upload: - name = os.path.basename(upload.name) - data = client.action(schema, ['encoding', 'multipart'], params={'example': upload}) + name = os.path.basename(temp.name) + data = client.action(schema, ['encoding', 'multipart'], params={'example': temp}) expected = { 'method': 'POST', @@ -407,13 +407,13 @@ class APIClientTests(APITestCase): client = CoreAPIClient() schema = client.get('http://api.example.com/') - temp = tempfile.NamedTemporaryFile() - temp.write(b'example file content') - temp.flush() + with tempfile.NamedTemporaryFile(delete=False) as temp: + temp.write(b'example file content') + temp.flush() + temp.seek(0) - with open(temp.name, 'rb') as upload: - name = os.path.basename(upload.name) - data = client.action(schema, ['encoding', 'raw_upload'], params={'example': upload}) + name = os.path.basename(temp.name) + data = client.action(schema, ['encoding', 'raw_upload'], params={'example': temp}) expected = { 'method': 'POST', diff --git a/tests/test_fields.py b/tests/test_fields.py index 968c41d3f..bb3d349b4 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -704,6 +704,17 @@ class TestSlugField(FieldValues): outputs = {} field = serializers.SlugField() + def test_allow_unicode_true(self): + field = serializers.SlugField(allow_unicode=True) + + validation_error = False + try: + field.run_validation(u'slug-99-\u0420') + except serializers.ValidationError: + validation_error = True + + assert not validation_error + class TestURLField(FieldValues): """ From 4091607d943362f58309d0f18bdcede011ab9ad0 Mon Sep 17 00:00:00 2001 From: David Sanders Date: Wed, 5 Jul 2017 14:48:54 -0600 Subject: [PATCH 11/20] Add information in docs about djangorestframework-simplejwt package --- docs/api-guide/authentication.md | 3 ++- docs/topics/third-party-packages.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 3dc2acbc4..05b8523f8 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -330,7 +330,7 @@ The [Django OAuth2 Consumer][doac] library from [Rediker Software][rediker] is a ## JSON Web Token Authentication -JSON Web Token is a fairly new standard which can be used for token-based authentication. Unlike the built-in TokenAuthentication scheme, JWT Authentication doesn't need to use a database to validate a token. [Blimp][blimp] maintains the [djangorestframework-jwt][djangorestframework-jwt] package which provides a JWT Authentication class as well as a mechanism for clients to obtain a JWT given the username and password. +JSON Web Token is a fairly new standard which can be used for token-based authentication. Unlike the built-in TokenAuthentication scheme, JWT Authentication doesn't need to use a database to validate a token. [Blimp][blimp] maintains the [djangorestframework-jwt][djangorestframework-jwt] package which provides a JWT Authentication class as well as a mechanism for clients to obtain a JWT given the username and password. An alternative package for JWT authentication is [djangorestframework-simplejwt][djangorestframework-simplejwt] which provides different features as well as a pluggable token blacklist app. ## Hawk HTTP Authentication @@ -388,6 +388,7 @@ HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a [doac-rest-framework]: https://github.com/Rediker-Software/doac/blob/master/docs/integrations.md# [blimp]: https://github.com/GetBlimp [djangorestframework-jwt]: https://github.com/GetBlimp/django-rest-framework-jwt +[djangorestframework-simplejwt]: https://github.com/davesque/django-rest-framework-simplejwt [etoccalino]: https://github.com/etoccalino/ [djangorestframework-httpsignature]: https://github.com/etoccalino/django-rest-framework-httpsignature [amazon-http-signature]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html diff --git a/docs/topics/third-party-packages.md b/docs/topics/third-party-packages.md index 44639f3d2..035335a82 100644 --- a/docs/topics/third-party-packages.md +++ b/docs/topics/third-party-packages.md @@ -185,6 +185,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque * [django-oauth-toolkit][django-oauth-toolkit] - Provides OAuth 2.0 support. * [doac][doac] - Provides OAuth 2.0 support. * [djangorestframework-jwt][djangorestframework-jwt] - Provides JSON Web Token Authentication support. +* [djangorestframework-simplejwt][djangorestframework-simplejwt] - An alternative package that provides JSON Web Token Authentication support. * [hawkrest][hawkrest] - Provides Hawk HTTP Authorization. * [djangorestframework-httpsignature][djangorestframework-httpsignature] - Provides an easy to use HTTP Signature Authentication mechanism. * [djoser][djoser] - Provides a set of views to handle basic actions such as registration, login, logout, password reset and account activation. @@ -284,6 +285,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [django-oauth-toolkit]: https://github.com/evonove/django-oauth-toolkit [doac]: https://github.com/Rediker-Software/doac [djangorestframework-jwt]: https://github.com/GetBlimp/django-rest-framework-jwt +[djangorestframework-simplejwt]: https://github.com/davesque/django-rest-framework-simplejwt [hawkrest]: https://github.com/kumar303/hawkrest [djangorestframework-httpsignature]: https://github.com/etoccalino/django-rest-framework-httpsignature [djoser]: https://github.com/sunscrapers/djoser From bf7fcc495b36a692570f6fe9210c96e746f75bf8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 10 Jul 2017 10:14:31 +0100 Subject: [PATCH 12/20] Raise validation error on invalid timezone parsing. --- rest_framework/fields.py | 8 +++----- tests/test_fields.py | 1 + 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 769f11466..14b264ff9 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1137,18 +1137,16 @@ class DateTimeField(Field): if input_format.lower() == ISO_8601: try: parsed = parse_datetime(value) - except (ValueError, TypeError): - pass - else: if parsed is not None: return self.enforce_timezone(parsed) + except (ValueError, TypeError): + pass else: try: parsed = self.datetime_parser(value, input_format) + return self.enforce_timezone(parsed) except (ValueError, TypeError): pass - else: - return self.enforce_timezone(parsed) humanized_format = humanize_datetime.datetime_formats(input_formats) self.fail('invalid', format=humanized_format) diff --git a/tests/test_fields.py b/tests/test_fields.py index bb3d349b4..cf5721187 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1152,6 +1152,7 @@ class TestDateTimeField(FieldValues): invalid_inputs = { 'abc': ['Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z].'], '2001-99-99T99:00': ['Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z].'], + '2018-08-16 22:00-24:00': ['Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z].'], datetime.date(2001, 1, 1): ['Expected a datetime but got a date.'], } outputs = { From 7d240a2e50ce5e634bb193f3478f9671ed10655f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 10 Jul 2017 10:30:39 +0100 Subject: [PATCH 13/20] Minor cleanup in test. --- tests/test_fields.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tests/test_fields.py b/tests/test_fields.py index a73aa0c16..bb0e3edde 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1143,10 +1143,9 @@ class TestDateTimeField(FieldValues): valid_inputs = { '2001-01-01 13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), '2001-01-01T13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), + '2001-01-01T13:00Z': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc) datetime.datetime(2001, 1, 1, 13, 00): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), - # Django 1.4 does not support timezone string parsing. - '2001-01-01T13:00Z': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc) } invalid_inputs = { 'abc': ['Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z].'], From 41901185d271cbc99a98df81a4d0e420040465e3 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 10 Jul 2017 11:18:26 +0100 Subject: [PATCH 14/20] Ignore timezone test case for Django 1.8, due to differing behavior. --- tests/test_fields.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/test_fields.py b/tests/test_fields.py index cf5721187..4a9722849 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -5,6 +5,7 @@ import unittest import uuid from decimal import Decimal +import django import pytest from django.http import QueryDict from django.test import TestCase, override_settings @@ -1166,6 +1167,11 @@ class TestDateTimeField(FieldValues): field = serializers.DateTimeField(default_timezone=utc) +if django.VERSION[:2] <= (1, 8): + # Doesn't raise an error on earlier versions of Django + TestDateTimeField.invalid_inputs.pop('2018-08-16 22:00-24:00') + + class TestCustomInputFormatDateTimeField(FieldValues): """ Valid and invalid values for `DateTimeField` with a custom input format. From b905197f24a74066e79888c56ddcf676c994cefc Mon Sep 17 00:00:00 2001 From: elmccarthy Date: Mon, 10 Jul 2017 03:43:36 -0700 Subject: [PATCH 15/20] Fix issue #5258 (#5259) Sanitize serializer.data to remove hidden fields before rendering template JSON instance to raw data form. * Fix lint issues --- rest_framework/renderers.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 406dda72c..779f0dd44 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -556,7 +556,10 @@ class BrowsableAPIRenderer(BaseRenderer): accepted = self.accepted_media_type context = self.renderer_context.copy() context['indent'] = 4 - content = renderer.render(serializer.data, accepted, context) + data = {k: v for (k, v) in serializer.data.items() + if not isinstance(serializer.fields[k], + serializers.HiddenField)} + content = renderer.render(data, accepted, context) else: content = None From 6d4d4dfd046e85253194f6bfe33574c080abf432 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 10 Jul 2017 13:42:02 +0100 Subject: [PATCH 16/20] Ensure closables in request.FILES get closed. (#5262) Ensure closables on `.FILES` get closed. --- rest_framework/request.py | 4 ++++ tests/test_fields.py | 2 +- tests/test_request.py | 31 +++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 1 deletion(-) diff --git a/rest_framework/request.py b/rest_framework/request.py index ffbe4a367..6f4269fe5 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -250,6 +250,10 @@ class Request(object): else: self._full_data = self._data + # copy files refs to the underlying request so that closable + # objects are handled appropriately. + self._request._files = self._files + def _load_stream(self): """ Return the content body of the request, as a stream. diff --git a/tests/test_fields.py b/tests/test_fields.py index 47dd274e8..38dc5f7a7 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1144,7 +1144,7 @@ class TestDateTimeField(FieldValues): valid_inputs = { '2001-01-01 13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), '2001-01-01T13:00': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), - '2001-01-01T13:00Z': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc) + '2001-01-01T13:00Z': datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), datetime.datetime(2001, 1, 1, 13, 00): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc): datetime.datetime(2001, 1, 1, 13, 00, tzinfo=utc), } diff --git a/tests/test_request.py b/tests/test_request.py index 428b969f5..208d2737e 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -3,6 +3,9 @@ Tests for content parsing, and form-overloaded content parsing. """ from __future__ import unicode_literals +import os.path +import tempfile + from django.conf.urls import url from django.contrib.auth import authenticate, login, logout from django.contrib.auth.models import User @@ -120,11 +123,39 @@ class MockView(APIView): return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR) + +class FileUploadView(APIView): + def post(self, request): + filenames = [file.temporary_file_path() for file in request.FILES.values()] + + for filename in filenames: + assert os.path.exists(filename) + + return Response(status=status.HTTP_200_OK, data=filenames) + + urlpatterns = [ url(r'^$', MockView.as_view()), + url(r'^upload/$', FileUploadView.as_view()) ] +@override_settings( + ROOT_URLCONF='tests.test_request', + FILE_UPLOAD_HANDLERS=['django.core.files.uploadhandler.TemporaryFileUploadHandler']) +class FileUploadTests(TestCase): + + def test_fileuploads_closed_at_request_end(self): + with tempfile.NamedTemporaryFile() as f: + response = self.client.post('/upload/', {'file': f}) + + # sanity check that file was processed + assert len(response.data) == 1 + + for file in response.data: + assert not os.path.exists(file) + + @override_settings(ROOT_URLCONF='tests.test_request') class TestContentParsingWithAuthentication(TestCase): def setUp(self): From f02b7f1329012aafca3851df3340b719c28d4586 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Mon, 10 Jul 2017 14:20:23 -0400 Subject: [PATCH 17/20] Add failing test for #4655 --- tests/test_filters.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/tests/test_filters.py b/tests/test_filters.py index b2de80998..f803d0957 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -645,6 +645,48 @@ class SearchFilterM2MTests(TestCase): ) +class Blog(models.Model): + name = models.CharField(max_length=20) + + +class Entry(models.Model): + blog = models.ForeignKey(Blog, on_delete=models.CASCADE) + headline = models.CharField(max_length=120) + pub_date = models.DateField(null=True) + + +class BlogSerializer(serializers.ModelSerializer): + class Meta: + model = Blog + fields = '__all__' + + +class SearchFilterToManyTests(TestCase): + + @classmethod + def setUpTestData(cls): + b1 = Blog.objects.create(name='Blog 1') + b2 = Blog.objects.create(name='Blog 2') + + Entry.objects.create(blog=b1, headline='Something about Lennon', pub_date=datetime.date(1979, 1, 1)) + Entry.objects.create(blog=b1, headline='Another thing about Lennon', pub_date=datetime.date(1979, 6, 1)) + + Entry.objects.create(blog=b2, headline='Something unrelated', pub_date=datetime.date(1979, 1, 1)) + Entry.objects.create(blog=b2, headline='Retrospective on Lennon', pub_date=datetime.date(1990, 6, 1)) + + def test_multiple_filter_conditions(self): + class SearchListView(generics.ListAPIView): + queryset = Blog.objects.all() + serializer_class = BlogSerializer + filter_backends = (filters.SearchFilter,) + search_fields = ('=name', 'entry__headline', '=entry__pub_date__year') + + view = SearchListView.as_view() + request = factory.get('/', {'search': 'Lennon,1979'}) + response = view(request) + assert len(response.data) == 1 + + class OrderingFilterModel(models.Model): title = models.CharField(max_length=20, verbose_name='verbose title') text = models.CharField(max_length=100) From d1cfec8d871a473f4c1e4b45ead959b07d813988 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Mon, 10 Jul 2017 14:24:58 -0400 Subject: [PATCH 18/20] Fix SearchFilter to-many behavior by ANDing cond's --- rest_framework/filters.py | 4 +++- tests/test_filters.py | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index bdab97b58..63ebf05ef 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -140,12 +140,14 @@ class SearchFilter(BaseFilterBackend): ] base = queryset + conditions = [] for search_term in search_terms: queries = [ models.Q(**{orm_lookup: search_term}) for orm_lookup in orm_lookups ] - queryset = queryset.filter(reduce(operator.or_, queries)) + conditions.append(reduce(operator.or_, queries)) + queryset = queryset.filter(reduce(operator.and_, conditions)) if self.must_call_distinct(queryset, search_fields): # Filtering against a many-to-many field requires us to diff --git a/tests/test_filters.py b/tests/test_filters.py index f803d0957..6df0a3169 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -5,6 +5,7 @@ import unittest import warnings from decimal import Decimal +import django import pytest from django.conf.urls import url from django.core.exceptions import ImproperlyConfigured @@ -668,12 +669,15 @@ class SearchFilterToManyTests(TestCase): b1 = Blog.objects.create(name='Blog 1') b2 = Blog.objects.create(name='Blog 2') + # Multiple entries on Lennon published in 1979 - distinct should deduplicate Entry.objects.create(blog=b1, headline='Something about Lennon', pub_date=datetime.date(1979, 1, 1)) Entry.objects.create(blog=b1, headline='Another thing about Lennon', pub_date=datetime.date(1979, 6, 1)) + # Entry on Lennon *and* a separate entry in 1979 - should not match Entry.objects.create(blog=b2, headline='Something unrelated', pub_date=datetime.date(1979, 1, 1)) Entry.objects.create(blog=b2, headline='Retrospective on Lennon', pub_date=datetime.date(1990, 6, 1)) + @unittest.skipIf(django.VERSION < (1, 9), "Django 1.8 does not support transforms") def test_multiple_filter_conditions(self): class SearchListView(generics.ListAPIView): queryset = Blog.objects.all() From 2a1fd3b45a2d1f5fa61056fcf151f9345e6a3327 Mon Sep 17 00:00:00 2001 From: Tommy Beadle Date: Wed, 12 Jul 2017 11:45:41 -0400 Subject: [PATCH 19/20] Add link to third-party package for LinkHeaderPagination. (#5270) --- docs/api-guide/pagination.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/docs/api-guide/pagination.md b/docs/api-guide/pagination.md index 888390018..d767e45de 100644 --- a/docs/api-guide/pagination.md +++ b/docs/api-guide/pagination.md @@ -242,29 +242,6 @@ We'd then need to setup the custom class in our configuration: Note that if you care about how the ordering of keys is displayed in responses in the browsable API you might choose to use an `OrderedDict` when constructing the body of paginated responses, but this is optional. -## Header based pagination - -Let's modify the built-in `PageNumberPagination` style, so that instead of include the pagination links in the body of the response, we'll instead include a `Link` header, in a [similar style to the GitHub API][github-link-pagination]. - - class LinkHeaderPagination(pagination.PageNumberPagination): - def get_paginated_response(self, data): - next_url = self.get_next_link() - previous_url = self.get_previous_link() - - if next_url is not None and previous_url is not None: - link = '<{next_url}>; rel="next", <{previous_url}>; rel="prev"' - elif next_url is not None: - link = '<{next_url}>; rel="next"' - elif previous_url is not None: - link = '<{previous_url}>; rel="prev"' - else: - link = '' - - link = link.format(next_url=next_url, previous_url=previous_url) - headers = {'Link': link} if link else {} - - return Response(data, headers=headers) - ## Using your custom pagination class To have your custom pagination class be used by default, use the `DEFAULT_PAGINATION_CLASS` setting: @@ -328,10 +305,15 @@ The [`DRF-extensions` package][drf-extensions] includes a [`PaginateByMaxMixin` The [`drf-proxy-pagination` package][drf-proxy-pagination] includes a `ProxyPagination` class which allows to choose pagination class with a query parameter. +## link-header-pagination + +The [`django-rest-framework-link-header-pagination` package][drf-link-header-pagination] includes a `LinkHeaderPagination` class which provides pagination via an HTTP `Link` header as desribed in [Github's developer documentation](github-link-pagination). + [cite]: https://docs.djangoproject.com/en/stable/topics/pagination/ [github-link-pagination]: https://developer.github.com/guides/traversing-with-pagination/ [link-header]: ../img/link-header-pagination.png [drf-extensions]: http://chibisov.github.io/drf-extensions/docs/ [paginate-by-max-mixin]: http://chibisov.github.io/drf-extensions/docs/#paginatebymaxmixin [drf-proxy-pagination]: https://github.com/tuffnatty/drf-proxy-pagination +[drf-link-header-pagination]: https://github.com/tbeadle/django-rest-framework-link-header-pagination [disqus-cursor-api]: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api From 089887d56e4ff7584ce4e65ed490029a55bd8616 Mon Sep 17 00:00:00 2001 From: Erick Delfin Date: Sun, 16 Jul 2017 09:12:29 -0700 Subject: [PATCH 20/20] Simplified chained comparisons and minor code fixes (#5276) --- rest_framework/pagination.py | 4 ++-- rest_framework/status.py | 10 +++++----- rest_framework/utils/formatting.py | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 0255cfc7f..a4a5230ef 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -31,7 +31,7 @@ def _positive_int(integer_string, strict=False, cutoff=None): if ret < 0 or (ret == 0 and strict): raise ValueError() if cutoff: - ret = min(ret, cutoff) + return min(ret, cutoff) return ret @@ -95,7 +95,7 @@ def _get_displayed_page_numbers(current, final): # Now sort the page numbers and drop anything outside the limits. included = [ idx for idx in sorted(list(included)) - if idx > 0 and idx <= final + if 0 < idx <= final ] # Finally insert any `...` breaks diff --git a/rest_framework/status.py b/rest_framework/status.py index c016b63c6..d4522df3d 100644 --- a/rest_framework/status.py +++ b/rest_framework/status.py @@ -9,23 +9,23 @@ from __future__ import unicode_literals def is_informational(code): - return code >= 100 and code <= 199 + return 100 <= code <= 199 def is_success(code): - return code >= 200 and code <= 299 + return 200 <= code <= 299 def is_redirect(code): - return code >= 300 and code <= 399 + return 300 <= code <= 399 def is_client_error(code): - return code >= 400 and code <= 499 + return 400 <= code <= 499 def is_server_error(code): - return code >= 500 and code <= 599 + return 500 <= code <= 599 HTTP_100_CONTINUE = 100 diff --git a/rest_framework/utils/formatting.py b/rest_framework/utils/formatting.py index 78cb37e56..aa805f14e 100644 --- a/rest_framework/utils/formatting.py +++ b/rest_framework/utils/formatting.py @@ -52,8 +52,8 @@ def camelcase_to_spaces(content): Translate 'CamelCaseNames' to 'Camel Case Names'. Used when generating names from view classes. """ - camelcase_boundry = '(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))' - content = re.sub(camelcase_boundry, ' \\1', content).strip() + camelcase_boundary = '(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))' + content = re.sub(camelcase_boundary, ' \\1', content).strip() return ' '.join(content.split('_')).title()