feat: add default routers autentication (#35)

* feat: add default routers autentication

* feat: add documentation for router authentication

---------

Co-authored-by: Pedro Barbosa <[email protected]>

Author: pedrohsbarbosa99

docs/customizing_token_claims.md

@@ -1,12 +1,11 @@
-
 If you wish to customize the claims contained in web tokens which are
 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 :
 
 !!! info
-    if you are interested in Asynchronous version of the class, use `AsyncNinjaJWTDefaultController` and `AsyncNinjaJWTSlidingController`.
-    Also note, it's only available for Django versions that supports asynchronous actions.
+if you are interested in Asynchronous version of the class, use `AsyncNinjaJWTDefaultController` and `AsyncNinjaJWTSlidingController`.
+Also note, it's only available for Django versions that supports asynchronous actions.
 
 ```python
 from ninja_jwt.schema import TokenObtainPairInputSchema
@@ -18,8 +17,8 @@ from ninja import Schema
 class UserSchema(Schema):
     first_name: str
     email: str
-    
-    
+
+
 class MyTokenObtainPairOutSchema(Schema):
     refresh: str
     access: str
@@ -40,34 +39,34 @@ class MyTokenObtainPairController(TokenObtainPairController):
     )
     def obtain_token(self, user_token: MyTokenObtainPairSchema):
         return user_token.output_schema()
-    
+
 ```
 
 As with the standard controller, you\'ll also need to include register the controller as shown in `getting_started`
 
 #### Use Django Ninja Router
+
 If you interested in using functions rather than classes, then you are also covered.
 Here is an example
 
 ```python
-from ninja import router
-
-router = router('/token')
-
-@router.post(
-    "/pair", response=MyTokenObtainPairOutSchema, url_name="token_obtain_pair"
-)
-def obtain_token(self, user_token: MyTokenObtainPairSchema):
-    return user_token.output_schema()
+from ninja_jwt.routers.blacklist import blacklist_router
+from ninja_jwt.routers.obtain import obtain_pair_router, sliding_router
+from ninja_jwt.routers.verify import verify_router
 ```
 
 Register the `router` to the django-ninja `api` like so:
+
 ```python
 from ninja import NinjaAPI
 
 api = NinjaAPI()
-api.add_router('', tags=['Auth'], router=router)
+api.add_router('/token', tags=['Auth'], router=obtain_pair_router)
+...
 ```
+
+If you are interested in customize the token claims, you can do so by creating a subclass of `TokenObtainPairInputSchema` and `TokenObtainPairController`. See [Controller Schema Swapping](#controller-schema-swapping)
+
 Also, its important to note that `NinjaExtra` registers a handler for `APIException` class which is not available in `NinjaAPI` instance.
 To fix that, you need the extra code below:
 
@@ -95,8 +94,6 @@ def api_exception_handler(request, exc):
 api.exception_handler(exceptions.APIException)(api_exception_handler)
 ```
 
-
-
 ### Controller Schema Swapping
 
 You can now swap controller schema in `NINJA_JWT` settings without having to inherit or override Ninja JWT controller function.
@@ -128,7 +125,7 @@ class MyTokenObtainPairInputSchema(TokenObtainInputSchemaBase):
     @classmethod
     def get_response_schema(cls) -> Type[Schema]:
         return MyTokenObtainPairOutSchema
-    
+
     @classmethod
     def get_token(cls, user) -> Dict:
         values = {}
@@ -139,7 +136,7 @@ class MyTokenObtainPairInputSchema(TokenObtainInputSchemaBase):
         return values
 ```
 
-In the  `MyTokenObtainPairInputSchema` we override `get_token` to define our token and some data needed for our output schema.
+In the `MyTokenObtainPairInputSchema` we override `get_token` to define our token and some data needed for our output schema.
 We also override `get_response_schema` to define our output schema `MyTokenObtainPairOutSchema`.
 
 Next, we apply the `MyTokenObtainPairInputSchema` schema to controller. This is simply done in `NINJA_JWT` settings.
@@ -151,11 +148,10 @@ NINJA_JWT = {
     'TOKEN_OBTAIN_PAIR_INPUT_SCHEMA': 'project.schema.MyTokenObtainPairInputSchema',
 }
 ```
+
 Other swappable schemas can be found in [settings](../settings)
 
 ![token_customization_git](./img/token_customize.gif)
 
 !!! Note
-    `Controller Schema Swapping` is only available from **v5.2.4**
-
-    
+`Controller Schema Swapping` is only available from **v5.2.4**

ninja_jwt/routers/__init__.py

@@ -0,0 +1,19 @@
+from ninja import Schema
+from ninja.router import Router
+
+from ninja_jwt.schema_control import SchemaControl
+from ninja_jwt.settings import api_settings
+
+blacklist_router = Router()
+
+schema = SchemaControl(api_settings)
+
+
+@blacklist_router.post(
+    "/blacklist",
+    response={200: Schema},
+    url_name="token_blacklist",
+    auth=None,
+)
+def blacklist_token(request, refresh: schema.blacklist_schema):
+    return refresh.to_response_schema()

ninja_jwt/routers/blacklist.py

@@ -0,0 +1,51 @@
+from ninja.router import Router
+
+from ninja_jwt.schema_control import SchemaControl
+from ninja_jwt.settings import api_settings
+
+schema = SchemaControl(api_settings)
+
+obtain_pair_router = Router()
+sliding_router = Router()
+
+
+@obtain_pair_router.post(
+    "/pair",
+    response=schema.obtain_pair_schema.get_response_schema(),
+    url_name="token_obtain_pair",
+    auth=None,
+)
+def obtain_token(request, user_token: schema.obtain_pair_schema):
+    user_token.check_user_authentication_rule()
+    return user_token.output_schema()
+
+
+@obtain_pair_router.post(
+    "/refresh",
+    response=schema.obtain_pair_refresh_schema.get_response_schema(),
+    url_name="token_refresh",
+    auth=None,
+)
+def refresh_token(request, refresh_token: schema.obtain_pair_refresh_schema):
+    return refresh_token.to_response_schema()
+
+
+@sliding_router.post(
+    "/sliding",
+    response=schema.obtain_sliding_schema.get_response_schema(),
+    url_name="token_obtain_sliding",
+    auth=None,
+)
+def obtain_token_sliding_token(request, user_token: schema.obtain_sliding_schema):
+    user_token.check_user_authentication_rule()
+    return user_token.to_response_schema()
+
+
+@sliding_router.post(
+    "/sliding/refresh",
+    response=schema.obtain_sliding_refresh_schema.get_response_schema(),
+    url_name="token_refresh_sliding",
+    auth=None,
+)
+def refresh_token_sliding(request, refresh_token: schema.obtain_sliding_refresh_schema):
+    return refresh_token.to_response_schema()

ninja_jwt/routers/obtain.py

@@ -0,0 +1,19 @@
+from ninja import Schema
+from ninja.router import Router
+
+from ninja_jwt.schema_control import SchemaControl
+from ninja_jwt.settings import api_settings
+
+schema = SchemaControl(api_settings)
+
+verify_router = Router()
+
+
+@verify_router.post(
+    "/verify",
+    response={200: Schema},
+    url_name="token_verify",
+    auth=None,
+)
+def verify_token(request, token: schema.verify_schema):
+    return token.to_response_schema()