Return decoded payload in authenticate

This allows for accessing it on `request.auth` easily then.

Author: blueyed

rest_framework_jwt/authentication.py

@@ -42,7 +42,7 @@ def authenticate(self, request):
 
         user = self.authenticate_credentials(payload)
 
-        return (user, jwt_value)
+        return (user, payload)
 
     def authenticate_credentials(self, payload):
         """

tests/test_authentication.py

@@ -29,6 +29,7 @@
 from rest_framework.test import APIRequestFactory
 
 from rest_framework_jwt import utils
+from rest_framework_jwt.authentication import JSONWebTokenAuthentication
 from rest_framework_jwt.compat import get_user_model
 from rest_framework_jwt.settings import DEFAULTS
 from rest_framework_jwt.settings import api_settings
@@ -284,3 +285,17 @@ def test_post_form_failing_jwt_auth_different_auth_header_prefix(self):
 
         # Restore original settings
         api_settings.JWT_AUTH_HEADER_PREFIX = DEFAULTS['JWT_AUTH_HEADER_PREFIX']
+
+    def test_authenticate_returns_decoded_payload(self):
+        """
+        Ensure `authenticate` returns the decoded payload, and not the
+        JWT value.
+        """
+        payload = utils.jwt_payload_handler(self.user)
+        token = utils.jwt_encode_handler(payload)
+        auth = 'JWT {0}'.format(token)
+        request = factory.request(HTTP_AUTHORIZATION=auth)
+        (user, payload) = JSONWebTokenAuthentication().authenticate(request)
+        self.assertIsInstance(payload, dict)
+        self.assertEqual(set(payload.keys()), {
+            'user_id', 'username', 'exp', 'email'})