code refactor

Author: eadwinCode

CHANGELOG.md

@@ -31,7 +31,7 @@
 * Fix BrowsableAPIRenderer needing `media_type` ([#426](https://github.com/jazzband/django-rest-framework-simplejwt/pull/426))
 * Fix blacklist migrations for multiple databases ([#429](https://github.com/jazzband/django-rest-framework-simplejwt/pull/429))
 * Fix Django 3.2 `default_app_config` deprecation ([#415](https://github.com/jazzband/django-rest-framework-simplejwt/pull/415))
-* Fix docs specifying `INSTALLED_APPS` for SimpleJWT iff you want translations ([#420](https://github.com/jazzband/django-rest-framework-simplejwt/pull/420))
+* Fix docs specifying `INSTALLED_APPS` for NinjaJWT if you want translations ([#420](https://github.com/jazzband/django-rest-framework-simplejwt/pull/420))
 * Fix drf-yasg API Schema generation for `TokenRefreshSerializer` ([#396](https://github.com/jazzband/django-rest-framework-simplejwt/pull/396))
 * Fix invalid syntax in docs for `INSTALLED_APPS` ([#416](https://github.com/jazzband/django-rest-framework-simplejwt/pull/416))
 

README.md

@@ -1,7 +1,7 @@
 # Ninja JWT
 ![Test](https://github.com/eadwinCode/django-ninja-jwt/workflows/Test/badge.svg)
 [![PyPI version](https://badge.fury.io/py/django-ninja-jwt.svg)](https://badge.fury.io/py/django-ninja-jwt)
-[![PyPI version](https://img.shields.io/pypi/v/djangorestframework-simplejwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
+[![PyPI version](https://img.shields.io/pypi/v/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 [![PyPI version](https://img.shields.io/pypi/pyversions/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 [![PyPI version](https://img.shields.io/pypi/djversions/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 
@@ -12,3 +12,98 @@ Ninja JWT is JSON Web Token plugin for Django-Ninja. The library is a fork of [S
 This library does not fix any issues from the parent source. It only added support for Django-Ninja and removed restframework dependency, but be rest assured that updates from SIMPLE JWT will reflect here.
 
 For full documentation, [visit](https://eadwincode.github.io/django-ninja-jwt/).
+
+#### Requirements
+- Python >= 3.6
+- Django >= 2.1
+- Django-Ninja >= 0.16.1
+- Ninja-Schema >= 0.12.2
+- Django-Ninja-Extra >= 0.11.0
+
+
+Installation
+============
+
+Ninja JWT can be installed with pip:
+
+    pip install django-ninja-jwt
+
+Also, you need to register `NinjaJWTDefaultController` controller to you Django-Ninja api.
+The `NinjaJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`
+
+``` {.sourceCode .python}
+from ninja_jwt.controller import NinjaJWTDefaultController
+from ninja_extra import NinjaExtraAPI
+
+api = NinjaExtraAPI()
+api.register_controller(NinjaJWTDefaultController)
+
+```
+
+The `NinjaJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`. 
+It is a combination of two subclass `TokenVerificationController` and `TokenObtainPairController`.
+If you wish to customize these routes, you can inherit from these controllers and change its implementation
+
+``` {.sourceCode .python}
+from ninja_jwt.controller import TokenObtainPairController, router
+
+@router('token', tags=['Auth']
+class MyCustomController(TokenObtainPairController):
+    """obtain_token and refresh_token only"
+...
+api.register_controller(MyCustomController)
+```
+
+If you wish to use localizations/translations, simply add `ninja_jwt` to
+`INSTALLED_APPS`.
+
+``` {.sourceCode .python}
+INSTALLED_APPS = [
+    ...
+    'ninja_jwt',
+    ...
+]
+```
+
+Usage
+=====
+
+To verify that Ninja JWT is working, you can use curl to issue a couple
+of test requests:
+
+``` {.sourceCode .bash}
+curl \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{"username": "davidattenborough", "password": "boatymcboatface"}' \
+  http://localhost:8000/api/token/pair
+
+...
+{
+  "access":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiY29sZF9zdHVmZiI6IuKYgyIsImV4cCI6MTIzNDU2LCJqdGkiOiJmZDJmOWQ1ZTFhN2M0MmU4OTQ5MzVlMzYyYmNhOGJjYSJ9.NHlztMGER7UADHZJlxNG0WSi22a2KaYSfd1S-AuT7lU",
+  "refresh":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImNvbGRfc3R1ZmYiOiLimIMiLCJleHAiOjIzNDU2NywianRpIjoiZGUxMmY0ZTY3MDY4NDI3ODg5ZjE1YWMyNzcwZGEwNTEifQ.aEoAYkSJjoWH1boshQAaTkf8G3yn0kapko6HFRt7Rh4"
+}
+```
+
+You can use the returned access token to prove authentication for a
+protected view:
+
+``` {.sourceCode .bash}
+curl \
+  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiY29sZF9zdHVmZiI6IuKYgyIsImV4cCI6MTIzNDU2LCJqdGkiOiJmZDJmOWQ1ZTFhN2M0MmU4OTQ5MzVlMzYyYmNhOGJjYSJ9.NHlztMGER7UADHZJlxNG0WSi22a2KaYSfd1S-AuT7lU" \
+  http://localhost:8000/api/some-protected-view/
+```
+
+When this short-lived access token expires, you can use the longer-lived
+refresh token to obtain another access token:
+
+``` {.sourceCode .bash}
+curl \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{"refresh":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImNvbGRfc3R1ZmYiOiLimIMiLCJleHAiOjIzNDU2NywianRpIjoiZGUxMmY0ZTY3MDY4NDI3ODg5ZjE1YWMyNzcwZGEwNTEifQ.aEoAYkSJjoWH1boshQAaTkf8G3yn0kapko6HFRt7Rh4"}' \
+  http://localhost:8000/api/token/refresh/
+
+...
+{"access":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiY29sZF9zdHVmZiI6IuKYgyIsImV4cCI6MTIzNTY3LCJqdGkiOiJjNzE4ZTVkNjgzZWQ0NTQyYTU0NWJkM2VmMGI0ZGQ0ZSJ9.ekxRxgb9OKmHkfy-zs1Ro_xs1eMLXiR17dIDBVxeT-w"}
+```

docs/docs/customizing_token_claims.md

@@ -1,6 +1,6 @@
 
 If you wish to customize the claims contained in web tokens which are
-generated by the `SimpleJWTDefaultController` and `SimpleJWTSlidingController`
+generated by the `NinjaJWTDefaultController` and `NinjaJWTSlidingController`
 views, create a subclass for the desired controller as well as a subclass for
 its corresponding serializer. Here\'s an example :
 

docs/docs/getting_started.md

@@ -7,29 +7,29 @@
 - Django-Ninja-Extra >= 0.11.0
 
 These are the officially supported python and package versions. Other
-versions will probably work. You\'re free to modify the tox config and
+versions will probably work. You 're free to modify the tox config and
 see what is possible.
 
 Installation
 ============
 
 Ninja JWT can be installed with pip:
 
-    pip install ninja-jwt
+    pip install django-ninja-jwt
 
-Also, you need to register `SimpleJWTDefaultController` controller to you Django-Ninja api.
-The `SimpleJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`
+Also, you need to register `NinjaJWTDefaultController` controller to you Django-Ninja api.
+The `NinjaJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`
 
 ``` {.sourceCode .python}
-from ninja_jwt.controller import SimpleJWTDefaultController
+from ninja_jwt.controller import NinjaJWTDefaultController
 from ninja_extra import NinjaExtraAPI
 
 api = NinjaExtraAPI()
-api.register_controller(SimpleJWTDefaultController)
+api.register_controller(NinjaJWTDefaultController)
 
 ```
 
-The `SimpleJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`. 
+The `NinjaJWTDefaultController` comes with three routes `obtain_token`, `refresh_token` and `verify_token`. 
 It is a combination of two subclass `TokenVerificationController` and `TokenObtainPairController`.
 If you wish to customize these routes, you can inherit from these controllers and change its implementation
 

docs/docs/index.md

@@ -1,7 +1,7 @@
 
 ![Test](https://github.com/eadwinCode/django-ninja-jwt/workflows/Test/badge.svg)
 [![PyPI version](https://badge.fury.io/py/django-ninja-jwt.svg)](https://badge.fury.io/py/django-ninja-jwt)
-[![PyPI version](https://img.shields.io/pypi/v/djangorestframework-simplejwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
+[![PyPI version](https://img.shields.io/pypi/v/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 [![PyPI version](https://img.shields.io/pypi/pyversions/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 [![PyPI version](https://img.shields.io/pypi/djversions/django-ninja-jwt.svg)](https://pypi.python.org/pypi/django-ninja-jwt)
 

docs/docs/settings.md

@@ -9,7 +9,7 @@ from datetime import timedelta
 from django.conf import settings
 ...
 
-SIMPLE_JWT = {
+NINJA_JWT = {
     'ACCESS_TOKEN_LIFETIME': timedelta(minutes=5),
     'REFRESH_TOKEN_LIFETIME': timedelta(days=1),
     'ROTATE_REFRESH_TOKENS': False,

docs/docs/token_types.md

@@ -37,13 +37,13 @@ setting to `('ninja_jwt.tokens.SlidingToken',)`. (Alternatively, the
 module if you want to allow both token types to be used for
 authentication.)
 
-Also, register `SimpleJWTSlidingController` to the `api`:
+Also, register `NinjaJWTSlidingController` to the `api`:
 ``` {.sourceCode .python}
-from ninja_jwt.controller import SimpleJWTSlidingController
+from ninja_jwt.controller import NinjaJWTSlidingController
 from ninja_extra import NinjaExtraAPI
 
 api = NinjaExtraAPI()
-api.register_controller(SimpleJWTSlidingController)
+api.register_controller(NinjaJWTSlidingController)
 
 ```
 

ninja_jwt/controller.py

@@ -60,20 +60,20 @@ def refresh_token(self, refresh_token: schema.TokenRefreshSlidingSchema):
 
 
 @router("/token", permissions=[AllowAny], tags=["token"])
-class SimpleJWTDefaultController(
+class NinjaJWTDefaultController(
     TokenVerificationController, TokenObtainPairController
 ):
-    """SimpleJWT Default controller for obtaining and refreshing tokens"""
+    """NinjaJWT Default controller for obtaining and refreshing tokens"""
 
     auto_import = False
 
 
 @router("/token", permissions=[AllowAny], tags=["token"])
-class SimpleJWTSlidingController(
+class NinjaJWTSlidingController(
     TokenVerificationController, TokenObtainSlidingController
 ):
     """
-    SimpleJWT Sliding controller for obtaining and refreshing tokens
+    NinjaJWT Sliding controller for obtaining and refreshing tokens
     Add 'ninja_jwt.tokens.SlidingToken' in AUTH_TOKEN_CLASSES in Settings
     """
 

ninja_jwt/settings.py

@@ -8,23 +8,23 @@
 from pydantic import AnyUrl, Field, root_validator
 
 
-class SimpleJWTUserDefinedSettings:
+class NinjaJWTUserDefinedSettingsMapper:
     def __init__(self, data: dict) -> None:
         self.__dict__ = data
 
 
-SimpleJWT_SETTINGS_DEFAULTS = dict(
+NinjaJWT_SETTINGS_DEFAULTS = dict(
     USER_AUTHENTICATION_RULE="ninja_jwt.authentication.default_user_authentication_rule",
     AUTH_TOKEN_CLASSES=["ninja_jwt.tokens.AccessToken"],
     TOKEN_USER_CLASS="ninja_jwt.models.TokenUser",
 )
 
-USER_SETTINGS = SimpleJWTUserDefinedSettings(
-    getattr(settings, "SIMPLE_JWT", SimpleJWT_SETTINGS_DEFAULTS)
+USER_SETTINGS = NinjaJWTUserDefinedSettingsMapper(
+    getattr(settings, "NINJA_JWT", NinjaJWT_SETTINGS_DEFAULTS)
 )
 
 
-class SimpleJWTSettings(Schema):
+class NinjaJWTSettings(Schema):
     class Config:
         orm_mode = True
         validate_assignment = True
@@ -61,8 +61,8 @@ class Config:
     SLIDING_TOKEN_REFRESH_LIFETIME: timedelta = Field(timedelta(minutes=5))
 
     @root_validator
-    def validate_settings(cls, values):
-        for item in SimpleJWT_SETTINGS_DEFAULTS.keys():
+    def validate_ninja_jwt_settings(cls, values):
+        for item in NinjaJWT_SETTINGS_DEFAULTS.keys():
             if isinstance(values[item], (tuple, list)) and isinstance(
                 values[item][0], str
             ):
@@ -73,16 +73,16 @@ def validate_settings(cls, values):
 
 
 # convert to lazy object
-api_settings = SimpleJWTSettings.from_orm(USER_SETTINGS)
+api_settings = NinjaJWTSettings.from_orm(USER_SETTINGS)
 
 
 def reload_api_settings(*args: Any, **kwargs: Any) -> None:
     global api_settings
 
     setting, value = kwargs["setting"], kwargs["value"]
 
-    if setting == "SIMPLE_JWT":
-        api_settings = SimpleJWTSettings.from_orm(SimpleJWTUserDefinedSettings(value))
+    if setting == "NINJA_JWT":
+        api_settings = NinjaJWTSettings.from_orm(NinjaJWTUserDefinedSettingsMapper(value))
 
 
 setting_changed.connect(reload_api_settings)

tests/test_integration.py

@@ -7,7 +7,7 @@
 from ninja_jwt.settings import api_settings
 from ninja_jwt.tokens import AccessToken
 
-from .utils import APIViewTestCase, override_api_settings
+from .utils import APIViewTestCase
 
 User = get_user_model()