Skip to content

Commit e3a1ba5

Browse files
committed
Added tests for JWT, fixed merge issues
1 parent f8a9cc1 commit e3a1ba5

File tree

5 files changed

+82
-11
lines changed

5 files changed

+82
-11
lines changed

docs/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Configuration
1010

1111
- TOKEN_SERIALIZER - response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.TokenSerializer``
1212

13+
- JWT_SERIALIZER - (Using REST_USE_JWT=True) response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.JWTSerializer``
14+
1315
- USER_DETAILS_SERIALIZER - serializer class in ``rest_auth.views.UserDetailsView``, default value ``rest_auth.serializers.UserDetailsSerializer``
1416

1517
- PASSWORD_RESET_SERIALIZER - serializer class in ``rest_auth.views.PasswordResetView``, default value ``rest_auth.serializers.PasswordResetSerializer``
@@ -42,6 +44,8 @@ Configuration
4244

4345
- **REST_SESSION_LOGIN** - Enable session login in Login API view (default: True)
4446

47+
- **REST_USE_JWT** - Enable JWT Authentication instead of Token/Session based. This is built on top of django-rest-framework-jwt http://getblimp.github.io/django-rest-framework-jwt/ , which much also be installed. (default: False)
48+
4549
- **OLD_PASSWORD_FIELD_ENABLED** - set it to True if you want to have old password verification on password change enpoint (default: False)
4650

4751
- **LOGOUT_ON_PASSWORD_CHANGE** - set to False if you want to keep the current user logged in after a password change

docs/installation.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,18 @@ Using ``django-allauth``, ``django-rest-auth`` provides helpful class for creati
109109
)
110110
111111
.. note:: Starting from v0.21.0, django-allauth has dropped support for context processors. Check out http://django-allauth.readthedocs.org/en/latest/changelog.html#from-0-21-0 for more details.
112+
113+
114+
JWT Support (optional)
115+
----------------------
116+
117+
By default, ``django-rest-auth`` uses Django's Token-based authentication. If you want to use JWT authentication, you need to install the following:
118+
119+
1. Install ``django-rest-framework-jwt`` http://getblimp.github.io/django-rest-framework-jwt/ . Right now this is the only supported JWT library.
120+
121+
2. Add the following to your settings
122+
123+
.. code-block:: python
124+
125+
REST_USE_JWT = True
126+

rest_auth/registration/views.py

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
from allauth.account import app_settings as allauth_settings
1313

1414
from rest_auth.app_settings import (TokenSerializer,
15+
JWTSerializer,
1516
create_token)
1617
from rest_auth.registration.serializers import (SocialLoginSerializer,
1718
VerifyEmailSerializer)
@@ -31,7 +32,14 @@ def get_response_data(self, user):
3132
allauth_settings.EmailVerificationMethod.MANDATORY:
3233
return {}
3334

34-
return TokenSerializer(user.auth_token).data
35+
if getattr(settings, 'REST_USE_JWT', False):
36+
data = {
37+
'user': user,
38+
'token': self.token
39+
}
40+
return JWTSerializer(data).data
41+
else:
42+
return TokenSerializer(user.auth_token).data
3543

3644
def create(self, request, *args, **kwargs):
3745
serializer = self.get_serializer(data=request.data)
@@ -43,7 +51,10 @@ def create(self, request, *args, **kwargs):
4351

4452
def perform_create(self, serializer):
4553
user = serializer.save(self.request)
46-
create_token(self.token_model, user, serializer)
54+
if getattr(settings, 'REST_USE_JWT', False):
55+
self.token = jwt_encode(user)
56+
else:
57+
create_token(self.token_model, user, serializer)
4758
complete_signup(self.request._request, user,
4859
allauth_settings.EMAIL_VERIFICATION,
4960
None)

rest_auth/tests/test_api.py

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,19 @@ def test_login(self):
9191
# test empty payload
9292
self.post(self.login_url, data={}, status_code=400)
9393

94+
@override_settings(REST_USE_JWT=True)
95+
def test_login_jwt(self):
96+
payload = {
97+
"username": self.USERNAME,
98+
"password": self.PASS
99+
}
100+
user = get_user_model().objects.create_user(self.USERNAME, '', self.PASS)
101+
102+
self.post(self.login_url, data=payload, status_code=200)
103+
self.assertEqual('token' in self.response.json.keys(), True)
104+
self.token = self.response.json['token']
105+
106+
94107
def test_login_by_email(self):
95108
# starting test without allauth app
96109
settings.INSTALLED_APPS.remove('allauth')
@@ -307,6 +320,22 @@ def test_user_details(self):
307320
self.assertEqual(user.last_name, self.response.json['last_name'])
308321
self.assertEqual(user.email, self.response.json['email'])
309322

323+
@override_settings(REST_USE_JWT=True)
324+
def test_user_details_using_jwt(self):
325+
user = get_user_model().objects.create_user(self.USERNAME, self.EMAIL, self.PASS)
326+
payload = {
327+
"username": self.USERNAME,
328+
"password": self.PASS
329+
}
330+
self.post(self.login_url, data=payload, status_code=200)
331+
self.token = self.response.json['token']
332+
self.get(self.user_url, status_code=200)
333+
334+
self.patch(self.user_url, data=self.BASIC_USER_DATA, status_code=200)
335+
user = get_user_model().objects.get(pk=user.pk)
336+
self.assertEqual(user.email, self.response.json['email'])
337+
338+
310339
def test_registration(self):
311340
user_count = get_user_model().objects.all().count()
312341

@@ -323,6 +352,20 @@ def test_registration(self):
323352
self._login()
324353
self._logout()
325354

355+
@override_settings(REST_USE_JWT=True)
356+
def test_registration_with_jwt(self):
357+
user_count = get_user_model().objects.all().count()
358+
359+
self.post(self.register_url, data={}, status_code=400)
360+
361+
result = self.post(self.register_url, data=self.REGISTRATION_DATA, status_code=201)
362+
self.assertIn('token', result.data)
363+
self.assertEqual(get_user_model().objects.all().count(), user_count + 1)
364+
365+
self._login()
366+
self._logout()
367+
368+
326369
def test_registration_with_invalid_password(self):
327370
data = self.REGISTRATION_DATA.copy()
328371
data['password2'] = 'foobar'

rest_auth/views.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
from .app_settings import (
1313
TokenSerializer, UserDetailsSerializer, LoginSerializer,
1414
PasswordResetSerializer, PasswordResetConfirmSerializer,
15-
PasswordChangeSerializer, create_token
15+
PasswordChangeSerializer, JWTSerializer, create_token
1616
)
1717
from .models import TokenModel
1818

@@ -43,17 +43,15 @@ def get_response_serializer(self):
4343

4444
def login(self):
4545
self.user = self.serializer.validated_data['user']
46-
self.token = create_token(self.token_model, self.user, self.serializer)
47-
if getattr(settings, 'REST_SESSION_LOGIN', True):
48-
login(self.request, self.user)
49-
46+
5047
if getattr(settings, 'REST_USE_JWT', False):
5148
self.token = jwt_encode(self.user)
5249
else:
53-
self.token, created = self.token_model.objects.get_or_create(
54-
user=self.user)
55-
if getattr(settings, 'REST_SESSION_LOGIN', True):
56-
login(self.request, self.user)
50+
self.token = create_token(self.token_model, self.user, self.serializer)
51+
52+
if getattr(settings, 'REST_SESSION_LOGIN', True):
53+
login(self.request, self.user)
54+
5755

5856
def get_response(self):
5957
serializer_class = self.get_response_serializer()

0 commit comments

Comments
 (0)