meringue 1.2.0.dev2__tar.gz → 1.2.0.dev4__tar.gz

meringue-1.2.0.dev4/AUTHORS

@@ -0,0 +1 @@
+Dmitry Dobrynin <dd@tovarisch.engineer>

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/PKG-INFO

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: meringue
-Version: 1.2.0.dev2
+Version: 1.2.0.dev4
 Summary: A set of various functionality for a Django based web application.
-Project-URL: Homepage, https://github.com/dd/Meringue
-Project-URL: Documentation, https://dd.github.io/Meringue/
+Project-URL: Documentation, https://dd.github.io/Meringue
 Project-URL: Repository, https://github.com/dd/Meringue
 Project-URL: Changelog, https://github.com/dd/Meringue/blob/master/CHANGELOG.md
 Project-URL: Bug Tracker, https://github.com/dd/Meringue/issues
-Author-email: Dmitry Dobrynin <dd@manin.space>
+Author-email: Dmitry Dobrynin <dd@tovarisch.engineer>
 License-Expression: LGPL-3.0
 License-File: AUTHORS
 License-File: LICENSE
@@ -47,6 +46,8 @@ Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Requires-Dist: django>=1.11.17
+Provides-Extra: cryptodome
+Requires-Dist: pycryptodome==3.20.0; extra == 'cryptodome'
 Provides-Extra: drf
 Requires-Dist: djangorestframework<4,>=3.13; extra == 'drf'
 Provides-Extra: drf-spectacular
@@ -85,7 +86,7 @@ Description-Content-Type: text/markdown
 		<img src="https://img.shields.io/github/actions/workflow/status/dd/Meringue/test.yml?logo=github&label=tests" alt="Tests - Running" />
 	</a>
 	<a href="https://codecov.io/gh/dd/Meringue" >
-		<img src="https://codecov.io/gh/dd/Meringue/branch/release/1.0.0/graph/badge.svg?token=HV1QGD74EK" alt="Tests - Coverage" />
+		<img src="https://codecov.io/gh/dd/Meringue/branch/master/graph/badge.svg?token=HV1QGD74EK" alt="Tests - Coverage" />
 	</a>
 </p>
 <p align="center">
@@ -109,15 +110,15 @@ Description-Content-Type: text/markdown
 	</a>
 </p>
 
-Full documentation for the project is available at [dd.github.io/Meringue](https://dd.github.io/Meringue/).
-
 Package with various functional (such as mixins, form utils, upload handlers and other) for Django Framework.
 
 This library is a set of various functionality that I use from project to project.
 
 The main task of this package is to clean up this functionality, test it, and also organize the documentation so that colleagues can understand how and what works.
 
-However, if someone decides to use this functionality in their project, and even more so to add functionality or change the implementation to a more correct, beautiful or understandable one, I will only be happy, do not worry and feel free to write to me by [mail](mailto:dd@manin.space), create an [issue](https://github.com/dd/Meringue/issues) or [pull request](https://github.com/dd/Meringue/pulls) on [github](https://github.com/dd/Meringue).
+However, if someone decides to use this functionality in their project, and even more so to add functionality or change the implementation to a more correct, beautiful or understandable one, I will only be happy, do not worry and feel free to write to me by [mail](mailto:dd@tovarisch.engineer), create an [issue](https://github.com/dd/Meringue/issues) or [pull request](https://github.com/dd/Meringue/pulls) on [github](https://github.com/dd/Meringue).
+
+Read more in the [documentation](https://dd.github.io/Meringue/).
 
 
 ## Roadmap
@@ -133,7 +134,7 @@ Adding new functionality. Can change.
 	* [ ] Tests
 	* [ ] Docs
 * [ ] Functionality similar to that described in the previous paragraph only for video.
-* [ ] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).
+* [x] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).
 
 
 ## Contributing

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/README.md

@@ -28,7 +28,7 @@
 		<img src="https://img.shields.io/github/actions/workflow/status/dd/Meringue/test.yml?logo=github&label=tests" alt="Tests - Running" />
 	</a>
 	<a href="https://codecov.io/gh/dd/Meringue" >
-		<img src="https://codecov.io/gh/dd/Meringue/branch/release/1.0.0/graph/badge.svg?token=HV1QGD74EK" alt="Tests - Coverage" />
+		<img src="https://codecov.io/gh/dd/Meringue/branch/master/graph/badge.svg?token=HV1QGD74EK" alt="Tests - Coverage" />
 	</a>
 </p>
 <p align="center">
@@ -52,15 +52,15 @@
 	</a>
 </p>
 
-Full documentation for the project is available at [dd.github.io/Meringue](https://dd.github.io/Meringue/).
-
 Package with various functional (such as mixins, form utils, upload handlers and other) for Django Framework.
 
 This library is a set of various functionality that I use from project to project.
 
 The main task of this package is to clean up this functionality, test it, and also organize the documentation so that colleagues can understand how and what works.
 
-However, if someone decides to use this functionality in their project, and even more so to add functionality or change the implementation to a more correct, beautiful or understandable one, I will only be happy, do not worry and feel free to write to me by [mail](mailto:dd@manin.space), create an [issue](https://github.com/dd/Meringue/issues) or [pull request](https://github.com/dd/Meringue/pulls) on [github](https://github.com/dd/Meringue).
+However, if someone decides to use this functionality in their project, and even more so to add functionality or change the implementation to a more correct, beautiful or understandable one, I will only be happy, do not worry and feel free to write to me by [mail](mailto:dd@tovarisch.engineer), create an [issue](https://github.com/dd/Meringue/issues) or [pull request](https://github.com/dd/Meringue/pulls) on [github](https://github.com/dd/Meringue).
+
+Read more in the [documentation](https://dd.github.io/Meringue/).
 
 
 ## Roadmap
@@ -76,7 +76,7 @@ Adding new functionality. Can change.
 	* [ ] Tests
 	* [ ] Docs
 * [ ] Functionality similar to that described in the previous paragraph only for video.
-* [ ] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).
+* [x] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).
 
 
 ## Contributing

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/meringue/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.2.0.dev2"
+__version__ = "1.2.0.dev4"
 """
 To update the version, use [hatch version](https://hatch.pypa.io/latest/version/#updating)
 

meringue-1.2.0.dev4/meringue/api/handlers.py

@@ -0,0 +1,38 @@
+from django.core.exceptions import PermissionDenied
+from django.http.response import Http404
+
+from rest_framework import exceptions
+from rest_framework import views
+
+from meringue.api.utils import render_error_details
+
+try:
+    from rest_framework_simplejwt.exceptions import DetailDictMixin
+except ImportError:
+    DetailDictMixin = None
+
+
+def exception_handler(exc, context):
+    """
+    Error handler returning message and error code pairs.
+
+    The handler is a wrapper over the standard handler `rest_framework.views.exception_handler`.
+    """
+
+    response = views.exception_handler(exc, context)
+
+    if response is None:
+        return response
+
+    if isinstance(exc, (Http404, PermissionDenied)):
+        # django Http404 and PermissionDenied errors are substituted for drf errors,
+        # in `rest_framework.views.exception_handler` method.
+        response.data = render_error_details(response.data["detail"])
+
+    elif DetailDictMixin and isinstance(exc, DetailDictMixin):
+        response.data = render_error_details(exc)
+
+    elif isinstance(exc, exceptions.APIException):
+        response.data = render_error_details(exc.detail)
+
+    return response

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/meringue/api/utils.py

@@ -1,5 +1,10 @@
 from rest_framework.exceptions import ErrorDetail
 
+try:
+    from rest_framework_simplejwt.exceptions import DetailDictMixin
+except ImportError:
+    DetailDictMixin = None
+
 
 def render_error_details(error_detail: list | dict | ErrorDetail) -> list | dict:
     """
@@ -14,7 +19,14 @@ def render_error_details(error_detail: list | dict | ErrorDetail) -> list | dict
     Returns:
         Rendered errors.
     """
-    if isinstance(error_detail, list):
+
+    if DetailDictMixin and isinstance(error_detail, DetailDictMixin):
+        return {
+            "message": error_detail.detail["detail"],
+            "code": error_detail.detail["code"],
+        }
+
+    elif isinstance(error_detail, list):
         error_list = [render_error_details(e) for e in error_detail]
         return error_list
 

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/meringue/conf/default_settings.py

@@ -42,7 +42,7 @@ Domain for generating absolute links
 
 # API ##############################################################################################
 
-API_ENABLE_ROOT_VIEW: Final[str] = settings.DEBUG
+API_ENABLE_ROOT_VIEW: Final[bool] = settings.DEBUG
 """
 Option to enable or disable the root view of the [Router][meringue.api.routers.MeringueRouter]
 """
@@ -114,3 +114,14 @@ THUMBNAIL_DEFAULT_FORMAT: Final[str] = "PNG"
 """
 Default thumbnail image format.
 """
+
+
+# PROTECTED ########################################################################################
+
+PROTECTED_SERVE_WITH_NGINX: Final[bool] = not settings.DEBUG
+"""
+The option implies the distribution of protected files by nginx. Instead of serving the file in
+response.
+
+The view [protected_file_view][meringue.protected.views.protected_file_view] adds the X-Accel-Redirect header with a link to the file.
+"""

meringue-1.2.0.dev4/meringue/protected/__init__.py

@@ -0,0 +1,5 @@
+import django
+
+
+if django.VERSION < (3, 2):
+    default_app_config = "meringue.protected.apps.Config"

meringue-1.2.0.dev4/meringue/protected/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class Config(AppConfig):
+    name = "meringue.protected"
+    verbose_name = _("Protected")
+    label = "meringue_protected"

meringue-1.2.0.dev4/meringue/protected/fields.py

@@ -0,0 +1,49 @@
+from django.contrib.contenttypes.models import ContentType
+from django.db.models.fields.files import FileField
+from django.db.models.fields.files import FieldFile
+from django.db.models.fields.files import ImageField
+from django.db.models.fields.files import ImageFieldFile
+from django.urls import reverse
+
+
+class ProtectedFileMixin:
+    @property
+    def url(self):
+        self._require_file()
+        result_url = reverse(
+            "meringue-protected-file",
+            kwargs={
+                "contenttype_id": ContentType.objects.get_for_model(self.instance.__class__).id,
+                "field": self.field.name,
+                "pk": self.instance.pk,
+            },
+        )
+        return result_url
+
+    @property
+    def original_url(self):
+        self._require_file()
+        return self.storage.url(self.name)
+
+
+class ProtectedFieldFile(ProtectedFileMixin, FieldFile):
+    pass
+
+
+class ProtectedFileField(FileField):
+    attr_class = ProtectedFieldFile
+
+    def __init__(self, verbose_name=None, name=None, upload_to="protected", storage=None, **kwargs):
+        super().__init__(verbose_name, name, upload_to, storage, **kwargs)
+
+
+class ProtectedImageFieldFile(ProtectedFileMixin, ImageFieldFile):
+    pass
+
+
+class ProtectedImageField(ImageField):
+    attr_class = ProtectedImageFieldFile
+
+    def __init__(self, verbose_name=None, name=None, width_field=None, height_field=None, **kwargs):
+        kwargs.setdefault("upload_to", "protected")
+        super().__init__(verbose_name, name, width_field, height_field, **kwargs)

meringue-1.2.0.dev4/meringue/protected/views.py

@@ -0,0 +1,57 @@
+import mimetypes
+from pathlib import Path
+from urllib.parse import quote
+from urllib.parse import urljoin
+
+from django.conf import settings
+from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import PermissionDenied
+from django.http import FileResponse
+from django.http import Http404
+from django.http import HttpResponse
+
+from meringue.conf import m_settings
+from meringue.protected.fields import ProtectedFieldFile
+from meringue.protected.fields import ProtectedImageFieldFile
+
+
+def protected_file_view(request, contenttype_id, field, pk):
+    """
+    В продакшен моде вьха редиректит на урл файла, где нжинкс отдаёт этот файл
+    Защита работает за счёт параметра internal
+    https://nginx.org/en/docs/http/ngx_http_core_module.html#internal
+
+    ```conf
+    location /media/protected/ {
+        internal;
+        alias /home/rpl/rpl-2023-back/public/media/protected/;
+    }
+    ```
+    """
+
+    contenttype = ContentType.objects.get(id=contenttype_id)
+
+    if not request.user.has_perm(f"{contenttype.app_label}.view_{contenttype.model}"):
+        raise PermissionDenied()
+
+    model = contenttype.model_class().objects.get(pk=pk)
+    file = getattr(model, field)
+
+    if not file:
+        raise Http404()
+
+    if m_settings.PROTECTED_SERVE_WITH_NGINX:
+        file_name = Path(file.name).name
+        response = HttpResponse()
+        response["Content-Type"] = mimetypes.guess_type(file.path)[0]
+        response["Content-Disposition"] = f"inline; filename={quote(file_name)}"
+
+        if isinstance(file, ProtectedFieldFile | ProtectedImageFieldFile):
+            redirect_url = file.original_url
+        else:
+            redirect_url = file.url
+
+        response["X-Accel-Redirect"] = redirect_url
+        return response
+
+    return FileResponse(open(file.path, "rb"))

{meringue-1.2.0.dev2 → meringue-1.2.0.dev4}/pyproject.toml

@@ -9,7 +9,7 @@ readme = "README.md"
 requires-python = ">=3.10"
 license = "LGPL-3.0"
 authors = [
-	{ name = "Dmitry Dobrynin", email = "dd@manin.space" },
+	{ name = "Dmitry Dobrynin", email = "dd@tovarisch.engineer" },
 ]
 keywords = ["django", "utils"]
 classifiers = [
@@ -57,10 +57,10 @@ dynamic = ["version"]
 modeltranslation = ["django-modeltranslation>=0.17,<0.19"]
 drf = ["djangorestframework>=3.13,<4"]
 drf-spectacular = ["drf-spectacular>=0.26.3,<1"]
+cryptodome = ["pycryptodome==3.20.0"]
 
 [project.urls]
-"Homepage" = "https://github.com/dd/Meringue"
-"Documentation" = "https://dd.github.io/Meringue/"
+"Documentation" = "https://dd.github.io/Meringue"
 "Repository" = "https://github.com/dd/Meringue"
 "Changelog" = "https://github.com/dd/Meringue/blob/master/CHANGELOG.md"
 "Bug Tracker" = "https://github.com/dd/Meringue/issues"
@@ -83,21 +83,21 @@ exclude = [
 
 [tool.hatch.envs.default]
 description = "Dev environment"
-python = "3.11"
+python = "3.12"
 dependencies = [
-	"pre-commit==3.3.3",
-	"ipython==8.14.0",
-	"django==4.2",
-	"pytz==2023.3",
+	"pre-commit==3.5.0",
+	"ipython==8.17.1",
+	"django==4.2.7",
+	"pytz==2023.3.post1",
 	"django-modeltranslation==0.18.11",
-	"pycryptodome==3.18.0",
+	"pycryptodome==3.20.0",
 	"djangorestframework==3.14.0",
-	"drf-spectacular==0.26.4",
-	"Pillow==10.0.0",
+	"drf-spectacular==0.26.5",
+	"Pillow==10.1.0",
 ]
 [tool.hatch.envs.default.env-vars]
-DJANGO_SETTINGS_MODULE = 'test_project.settings'
-PYTHONPATH  = '.'
+DJANGO_SETTINGS_MODULE = "test_project.settings"
+PYTHONPATH  = "."
 [tool.hatch.envs.default.scripts]
 precommit_install = "pre-commit install {args}"
 precommit_uninstall = "pre-commit uninstall {args}"
@@ -114,11 +114,12 @@ init = [
 	"precommit_install",
 ]
 remove = [
+	"git config --local --remove-section gitflow.branch",
+	"git config --local --remove-section gitflow.prefix",
+	"git config --local --remove-section gitflow.path",
 	"precommit_uninstall",
 ]
-makemessages = [
-	"cd meringue/core && django-admin makemessages -l en -l ru --no-obsolete {args}",
-]
+makemessages = "cd meringue/core && django-admin makemessages -l en -l ru --no-obsolete {args}"
 compilemessages = "cd meringue && django-admin compilemessages -l en -l ru {args}"
 
 [tool.hatch.envs.lint]
@@ -126,8 +127,8 @@ description = "Lint environment"
 detached = true
 python = "3.11"
 dependencies = [
-	"ruff==0.0.280",
-	"black==23.7.0",
+	"ruff==0.3.4",
+	"black==24.3.0",
 ]
 [tool.hatch.envs.lint.scripts]
 check = [
@@ -144,20 +145,22 @@ description = "Tests environment"
 detached = true
 python = "3.11"
 dependencies = [
-	"pytest==7.4.0",
+	"pytest==7.4.2",
 	"pytest-django==4.5.2",
 	"pytest-cov==4.1.0",
-	"Faker==19.2.0",
+	"Faker==19.6.1",
 	"django==4.2",
-	"pytz==2023.3",
+	"pytz==2023.3.post1",
 	"django-modeltranslation==0.18.11",
-	"pycryptodome==3.18.0",
+	"pycryptodome==3.20.0",
 	"djangorestframework==3.14.0",
+	"djangorestframework-simplejwt==5.3.1",
 	"drf-spectacular==0.26.4",
+	"pillow==10.3.0",
 ]
 [tool.hatch.envs.test.env-vars]
-DJANGO_SETTINGS_MODULE = 'test_project.settings'
-PYTHONPATH  = '.'
+DJANGO_SETTINGS_MODULE = "test_project.settings"
+PYTHONPATH  = "."
 [tool.hatch.envs.test.scripts]
 check = "pytest {args:--cov=meringue --cov-report term-missing}"
 makemigrations = "django-admin makemigrations {args}"
@@ -166,56 +169,66 @@ makemigrations = "django-admin makemigrations {args}"
 description = "Test matrix environment"
 detached = true
 dependencies = [
-	"pytest==7.4.0",
+	"pytest==7.4.2",
 	"pytest-django==4.5.2",
 	"pytest-cov==4.1.0",  # for ci tests with cover
-	"Faker==19.2.0",
-	"pytz==2023.3",
-	"pycryptodome==3.18.0",
+	"Faker==19.6.1",
+	"pytz==2023.3.post1",
+	"pycryptodome==3.20.0",
 	"drf-spectacular==0.26.4",
+	"pillow==10.3.0",
 ]
 [tool.hatch.envs.mtest.overrides]
 matrix.django.dependencies = [
 	{ value = "django~={matrix:django}" },
 	{ value = "django-modeltranslation=={matrix:modeltranslation}" },
 	{ value = "djangorestframework=={matrix:djangorestframework}" },
+	{ value = "djangorestframework-simplejwt=={matrix:simplejwt}" },
 ]
 [tool.hatch.envs.mtest.env-vars]
-DJANGO_SETTINGS_MODULE = 'test_project.settings'
-PYTHONPATH  = '.'
+DJANGO_SETTINGS_MODULE = "test_project.settings"
+PYTHONPATH  = "."
 [tool.hatch.envs.mtest.scripts]
 check = "pytest {args:-q}"
 [[tool.hatch.envs.mtest.matrix]]
 python = ["3.10", "3.11"]
 django = ["2.0"]
-modeltranslation = ["0.17.7"]
-djangorestframework = ["3.13.1"]
+modeltranslation = ["0.17.0"]
+djangorestframework = ["3.13.0"]
+simplejwt = ["5.2.0"]
+[[tool.hatch.envs.mtest.matrix]]
+python = ["3.10", "3.11"]
+django = ["3.0"]
+modeltranslation = ["0.17.0"]
+djangorestframework = ["3.13.0", "3.14.0", "3.15.0"]
+simplejwt = ["5.2.0", "5.3.0"]
 [[tool.hatch.envs.mtest.matrix]]
 python = ["3.10", "3.11"]
-django = ["3.0", "4.0"]
-modeltranslation = ["0.18.11"]
+django = ["4.0"]
+modeltranslation = ["0.17.0"]
 djangorestframework = ["3.14.0"]
+simplejwt = ["5.2.0", "5.3.0"]
 
 [tool.hatch.envs.docs]
 description = "Docs environment"
 detached = true
 python = "3.11"
 dependencies = [
-	"mkdocs[i18n]==1.5.1",
-	"mkdocs-literate-nav==0.6.0",
-	"mkdocs-material==9.1.21",
-	"mkdocs-git-revision-date-localized-plugin==1.2.0",
-	"mkdocs-git-authors-plugin==0.7.2",
-	"mkdocstrings[python]==0.22.0",
-	"black==23.7.0",
-	"mkdocs-minify-plugin==0.7.0",
+	"mkdocs[i18n]==1.5.3",
+	"mkdocs-literate-nav==0.6.1",
+	"mkdocs-material==9.5.16",
+	"mkdocs-git-revision-date-localized-plugin==1.2.4",
+	"mkdocs-git-authors-plugin==0.8.0",
+	"mkdocstrings[python]==0.24.1",
+	"black==24.3.0",
+	"mkdocs-minify-plugin==0.8.0",
 	"mkdocs-gen-files==0.5.0",
-	"Pygments==2.15.1",
+	"Pygments==2.17.2",
 	"mike==1.1.2",
-	"linkchecker==10.2.1",
+	"linkchecker==10.4.0",
 ]
 [tool.hatch.envs.docs.env-vars]
-MERINGUE_MKDOCS_ENABLE_MINIFY = 'false'
+MERINGUE_MKDOCS_ENABLE_MINIFY = "false"
 MKDOCS_CONFIG = "mkdocs.yml"
 [tool.hatch.envs.docs.scripts]
 build = "mkdocs build --config-file {env:MKDOCS_CONFIG} --clean --strict {args}"

meringue-1.2.0.dev2/AUTHORS

@@ -1 +0,0 @@
-Dmitry Dobrynin <dd@manin.space>

meringue-1.2.0.dev2/meringue/api/handlers.py

@@ -1,25 +0,0 @@
-from rest_framework import exceptions
-from rest_framework import views
-
-from meringue.api.utils import render_error_details
-
-
-def exception_handler(exc, context):
-    """
-    Error handler returning message and error code pairs.
-
-    The handler is a wrapper over the standard handler `rest_framework.views.exception_handler`.
-    """
-    response = views.exception_handler(exc, context)
-
-    if response is None:
-        return response
-
-    if isinstance(exc, exceptions.APIException):
-        if isinstance(exc.detail, list):
-            response.data = [render_error_details(e) for e in exc.detail]
-
-        elif isinstance(exc.detail, dict):
-            response.data = {f: render_error_details(e) for f, e in exc.detail.items()}
-
-    return response