inertia-django-utils 0.1.0__tar.gz

inertia_django_utils-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Bellawatt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

inertia_django_utils-0.1.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: inertia-django-utils
+Version: 0.1.0
+Summary: Django Utilities for Inertia.js
+Author-Email: Paul Bailey <paul@neutron.studio>
+License: BSD3Clause
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Inertia Django Utils
+
+Django Utilities for Inertia.js
+
+## Installation
+
+`pdm add inertia-django-utils`
+
+## Login Required Decorator
+
+Decorator checks if the user is authenticated and redirects to a login page. Works like the standard `@login_required` except that it uses the Inertia `location` redirect if an Inertia request is detected.
+
+```python
+from inertia_utils import login_required
+
+@login_required
+def my_awesome_view(request):
+  return InertiaResponse(request, 'my_awesome_page', props={})
+```

inertia_django_utils-0.1.0/README.md

@@ -0,0 +1,19 @@
+# Inertia Django Utils
+
+Django Utilities for Inertia.js
+
+## Installation
+
+`pdm add inertia-django-utils`
+
+## Login Required Decorator
+
+Decorator checks if the user is authenticated and redirects to a login page. Works like the standard `@login_required` except that it uses the Inertia `location` redirect if an Inertia request is detected.
+
+```python
+from inertia_utils import login_required
+
+@login_required
+def my_awesome_view(request):
+  return InertiaResponse(request, 'my_awesome_page', props={})
+```

inertia_django_utils-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "inertia-django-utils"
+version = "0.1.0"
+description = "Django Utilities for Inertia.js"
+authors = [
+    { name = "Paul Bailey", email = "paul@neutron.studio" },
+]
+dependencies = []
+requires-python = ">=3.11"
+readme = "README.md"
+
+[project.license]
+text = "BSD3Clause"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm]
+distribution = true

inertia_django_utils-0.1.0/src/inertia_utils/__init__.py

@@ -0,0 +1,2 @@
+from .common import is_inertia_request
+from .auth import login_required

inertia_django_utils-0.1.0/src/inertia_utils/auth.py

@@ -0,0 +1,70 @@
+from functools import wraps
+from inspect import isawaitable, iscoroutinefunction
+from urllib.parse import quote
+
+from asgiref.sync import async_to_sync
+
+from inertia import location
+
+from django.conf import settings
+from django import http
+
+from .common import is_inertia_request
+
+
+REDIRECT_FIELD_NAME = getattr(settings, 'AUTH_REDIRECT_FIELD_NAME', 'next')
+LOGIN_URL = settings.LOGIN_URL
+
+
+async def run_test(request, test_func, redirect_field_name, login_url):
+  user = await request.auser()
+  passed = test_func(user)
+
+  if isawaitable(passed):
+    passed = await passed
+
+  if not passed:
+    nxt = request.get_full_path()
+    nxt = quote(nxt, safe='')
+    url = f'{login_url}?{redirect_field_name}={nxt}'
+
+    if is_inertia_request(request):
+      return location(url)
+
+    return http.HttpResponseRedirect(url)
+
+
+def user_passes_test(test_func, redirect_field_name=REDIRECT_FIELD_NAME, login_url=LOGIN_URL):
+  def decorator(view_func):
+    if iscoroutinefunction(view_func):
+      async def view_wrapper(request, *args, **kwargs):
+        response = await run_test(request, test_func, redirect_field_name, login_url)
+        if response:
+          return response
+
+        return await view_func(request, *args, **kwargs)
+
+    else:
+      def view_wrapper(request, *args, **kwargs):
+        response = async_to_sync(run_test)(request, test_func, redirect_field_name, login_url)
+        if response:
+          return response
+
+        return view_func(request, *args, **kwargs)
+
+    return wraps(view_func)(view_wrapper)
+
+
+  return decorator
+
+
+def login_required(function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=LOGIN_URL):
+  actual_decorator = user_passes_test(
+    lambda u: u.is_authenticated,
+    redirect_field_name,
+    login_url,
+  )
+  if function:
+    return actual_decorator(function)
+
+  return actual_decorator

inertia_django_utils-0.1.0/src/inertia_utils/common.py

@@ -0,0 +1,2 @@
+def is_inertia_request(request):
+  return "X-Inertia" in request.headers