Upgrade to Django 3.2 and a bunch of other enhancements to codestyle and organization.

Author: feliphebueno

README.md

@@ -4,58 +4,50 @@ Django-based REST Micro-Framework
 
 # Install requires
 
-```PHP
+```bash
 pip install rinzler
 ```
 
 # Usage
 ```Python
-
 # urls.py
-
-import os
-import rinzler
+from rinzler import boot, Rinzler
 
 from rinzler.core.main_controller import MainController
 from your_controller import Controller
 
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
-app = rinzler.boot(BASE_DIR)
-assembler = app['url_assembler']
+app: Rinzler = boot("MyApp")
 
 urlpatterns = [
-    assembler.mount('hello', Controller),
-    assembler.mount('', MainController),
+    app.mount('hello', Controller),
+    app.mount('', MainController),
 ]
-
 ```
 
 ```Python
 # your_controller.py
-from collections import OrderedDict
-
 from django.http.request import HttpRequest
-from django.views.generic import TemplateView
 
+from rinzler import Rinzler
 from rinzler.core.response import Response
 
 
-class Controller(TemplateView):
+class Controller:
 
     def connect(self, app):
 
-        router = app['router']
+        router = app.get_end_point_register()
 
         # map end-points to callbacks here
         router.get('/world/', self.hello_world)
         router.get('/{name}/', self.hello_user)
 
-        return app
+        return router
 
     # end-point callbacks here:
     @staticmethod
-    def hello_world(request: HttpRequest, app: dict(), **params: dict):
+    def hello_world(request: HttpRequest, app: Rinzler, **params: dict):
         """
         Default route callback
         :param request HttpRequest
@@ -64,41 +56,34 @@ class Controller(TemplateView):
         :rtype: Response
         """
         try:
-            response = OrderedDict()
-            response["status"] = True
-            response["data"] = "Hello World!"
-
+            response = {
+                "status": True,
+                "data": "Hello World!",
+            }
             return Response(response, content_type="application/json")
         except BaseException as e:
-            response = OrderedDict()
-            response["status"] = False
-            response["mensagem"] = str(e)
-
+            response = {
+                "status": False,
+                "mensagem": str(e),
+            }
             return Response(response, content_type="application/json", status=500)\
 
     @staticmethod
-    def hello_user(request: HttpRequest, app: dict(), **params: dict):
-        """
-        Default route callback
-        :param request HttpRequest
-        :param app Rinzler's object
-        :param params dict url params, if present
-        :rtype: Response
-        """
+    def hello_user(request: HttpRequest, app: Rinzler, **params: dict) -> Response:
         try:
             user = params['name']
-            response = OrderedDict()
-            response["status"] = True
-            response["data"] = "Hello {0}!".format(user)
+            response = {
+                "status": True,
+                "data": f"Hello {user}!",
+            }
 
             return Response(response, content_type="application/json")
         except BaseException as e:
-            response = OrderedDict()
-            response["status"] = False
-            response["mensagem"] = str(e)
-
+            response = {
+                "status": False,
+                "mensagem": str(e),
+            }
             return Response(response, content_type="application/json", status=500)
-
 ```
 ### Run django
 ```shell
@@ -140,5 +125,109 @@ curl http://localhost:8000/foo/bar/
   },
   "message": "We are sorry, but something went terribly wrong."
 }
+# If project's settings has DEBUG=True, otherwise: empty response body with status-code 404
+```
+
+
+### Authentication
+Authentication can be done on a per-route basis thus allowing to have authenticated and non-authenticated routes on the application.
+
+To do so, first you need to create a class that inherits from `BaseAuthService` and implements the `authenticate` method.
+
+```Python
+from django.http.request import HttpRequest
+
+from rinzler.auth.base_auth_service import BaseAuthService
+
+class MyAuthenticationService(BaseAuthService):
+    def authenticate(self, request: HttpRequest, auth_route: str, params: dict) -> bool:
+        """
+        Implement your authentication logic here
+        :param request: HttpRequest Django's request object
+        :param auth_route: str route being requested
+        :param params: dict url params, if present
+        :return: bool if not True, the request will be promptly returned with status-code 403
+        """
+        # Non-authenticated route
+        if auth_route == 'GET_v1/hello/world/':
+            return True
+
+        # Authenticated routes
+        if request.META.get("HTTP_AUTHORIZATION"):
+            # after performing your authentication logic, you can append user data to the Rinzler object so it'll be available on the controller
+            self.auth_data = {
+                "user_id": 1,
+            }
+            return True
+```
+
+Then, you need to register your authentication service on the application's `urls.py` file.
+
+```Python
+# urls.py
+from rinzler import boot, Rinzler
+
+from rinzler.core.main_controller import MainController
+from your_controller import Controller
+from my_auth_service import MyAuthenticationService
+
+
+app: Rinzler = boot("MyApp")
+app.set_auth_service(MyAuthenticationService())
+
+urlpatterns = [
+    app.mount('hello', Controller),
+    app.mount('', MainController),
+]
+```
+    
+Finally, you can access the user data on the controller by accessing the `auth_data` attribute on the Rinzler object.
+```Python
+# your_controller.py
+from django.http.request import HttpRequest
+
+from rinzler import Rinzler
+from rinzler.core.response import Response
+
+
+class Controller:
+    # ...
+    @staticmethod
+    def hello_user(request: HttpRequest, app: Rinzler, **params: dict) -> Response:
+        try:
+            user = params['name']
+            user_id = app.auth_data['user_id']
+            response = {
+                "status": True,
+                "data": f"Hello {user}! Your user id is {user_id}.",
+            }
+
+            return Response(response, content_type="application/json")
+        except BaseException as e:
+            response = {
+                "status": False,
+                "mensagem": str(e),
+            }
+            return Response(response, content_type="application/json", status=500)
+```
+### Sample requests
+
+```shell
+# Non-authenticated request
+curl http://localhost:8000/hello/world/
+{
+  "status": true,
+  "data": "Hello World!"
+}
+
+# Improperly authenticated request
+curl http://localhost:8000/hello/bob/
+# (empty response body with status-code 403)
 
+# Properly authenticated request
+curl http://localhost:8000/hello/bob/ -H "Authorization: XYZ"
+{
+  "status": true,
+  "data": "Hello bob! Your user id is 1"
+}
 ```

pyproject.toml

@@ -0,0 +1,6 @@
+[tool.black]
+    line-length = 120
+
+[tool.flake8]
+    max-line-length = 120
+    exclude = ".tox,.git,*/migrations/*,*/static/CACHE/*,docs,venv"

requirements.txt

@@ -1,7 +1,6 @@
-Django==2.2.12
-pytz==2020.1
-PyYAML==5.3.1
-raven==6.9.0
-setuptools==40.6.2
-wheel==0.35.1
-twine==3.2.0
+Django~=3.2
+PyYAML==6.0.1
+setuptools==68.2.2
+wheel==0.41.2
+twine==4.0.2
+tox==4.11.3