wbcore 2.2.1__py2.py3-none-any.whl → 2.2.4__py2.py3-none-any.whl

wbcore/contrib/documents/static/documents/markdown/documentation/document_types.md

@@ -0,0 +1,21 @@
+# Document Types:
+A list of document types used to categorize documents. Types are saved as a tree with the possibility of adding parent types to each node.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the document type.
+### Parent:
+The document type's parent type.
+
+## Buttons:
+### All Children:
+Displays a list of all child types of this document type.
+
+### All Documents:
+Displays a list with all documents of this type.
+
+## Search Field:
+Typing in the search field allows to filter the document types by name.

wbcore/contrib/documents/static/documents/markdown/documentation/documents.md

@@ -0,0 +1,18 @@
+# Documents:
+A list of documents uploaded to the workbench.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the document.
+### Type:
+The document's type. Types can be added and edited under DMS > Document Types.
+
+## Buttons:
+### Download:
+Download this document on your computer.
+
+## Search Field:
+Typing in the search field allows to filter the documents by name.

wbcore/contrib/documents/static/documents/markdown/documentation/shareablelink.md

@@ -0,0 +1,28 @@
+# Shareable Links:
+A list of links to share the selected document.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+### Valid Until:
+Date and time at which the link loses its validity.
+### One Time Link:
+Specifies if the link can be accessed only one time or and infinite amount.
+### Link:
+The URL under which the document can be accessed.
+
+## Buttons:
+### Invalidate:
+Invalidate the selected link manually even if the validation date lies in the future.
+
+## Legend:
+Click on the legend to filter by link validity.
+
+## Filters:
+### Valid:
+Filter by link validity.
+### Document:
+Display links for a specific document. Will default to the current document displayed.
+
+## Search Field:
+Typing in the search field allows to filter by link uuid.

wbcore/contrib/documents/static/documents/markdown/documentation/shareablelinkaccess.md

@@ -0,0 +1,20 @@
+# Hits:
+A list of IP addresses that accessed the selected link.
+
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Accessed:
+Date and time at which the link was accessed.
+### IP Address:
+The IP address that accessed the link.
+### Meta Data:
+The meta data that was provided when the link was accessed. Comprised of things like operating system and browser name.
+
+## Filters:
+### Shareable Link:
+Display hits for a specific link. Will default to the current link displayed.
+
+## Search Field:
+Typing in the search field allows to filter by IP address.

wbcore/contrib/documents/tests/conftest.py

@@ -0,0 +1,30 @@
+import pytest
+from django.apps import apps
+from django.db import connection
+from django.db.models.signals import pre_migrate
+from pytest_factoryboy import register
+from wbcore.contrib.documents.factories import (
+    DocumentFactory,
+    DocumentTypeFactory,
+    ShareableLinkAccessFactory,
+    ShareableLinkFactory,
+)
+from wbcore.contrib.geography.tests.signals import app_pre_migration
+from wbcore.tests.conftest import *
+
+register(DocumentFactory)
+register(DocumentTypeFactory)
+register(ShareableLinkAccessFactory)
+register(ShareableLinkFactory)
+
+
+@pytest.fixture(
+    autouse=True, scope="session"
+)  # Might want to find a way to registered default conftest logic automatically
+def django_test_environment(django_test_environment):
+    from django.apps import apps
+
+    get_models = apps.get_models
+
+    for m in [m for m in get_models() if not m._meta.managed]:
+        m._meta.managed = True

wbcore/contrib/documents/tests/test_models.py

@@ -0,0 +1,144 @@
+import os
+from datetime import timedelta
+from unittest.mock import patch
+
+import pytest
+from django.core import mail
+from django.core.validators import URLValidator
+from django.utils import timezone
+from faker import Faker
+from slugify import slugify
+from wbcore.contrib.documents.models.documents import (
+    Document,
+    send_email_as_task,
+    upload_to,
+)
+
+fake = Faker()
+
+
+@pytest.mark.django_db
+class TestDocumentModel:
+    def test_init(self, document):
+        assert document.id is not None
+
+    @pytest.mark.parametrize(
+        "filename",
+        [(fake.file_name())],
+    )
+    def test_upload_to(self, document, document_type_factory, filename):
+        parent_document_type = document_type_factory.create()
+        document_type = document_type_factory.create(parent=parent_document_type)
+        document.document_type = document_type
+        document.save()
+        assert (
+            upload_to(document, filename)
+            == f"dms/document/{slugify(parent_document_type.name)}/{slugify(document_type.name)}/{filename}"
+        )
+
+    @pytest.mark.parametrize(
+        "document__file",
+        [(fake.file_path())],
+    )
+    def test_filename(self, document):
+        assert document.filename == os.path.basename(document.file.name)
+
+    def test_linked_objects(self, document_factory):
+        document = document_factory.create()
+        link_obj = document_factory.create()
+        document.link(link_obj)
+        assert list(document.linked_objects)[0] == link_obj
+
+    @pytest.mark.parametrize(
+        "sharing_seconds_duration, one_time_link",
+        [(0, False), (fake.pyint(min_value=1), False), (0, True), (fake.pyint(min_value=1), True)],
+    )
+    def test_generate_shareable_link(self, document, sharing_seconds_duration, one_time_link):
+        document.generate_shareable_link(
+            sharing_seconds_duration=sharing_seconds_duration, one_time_link=one_time_link
+        )
+        assert (
+            document.shareable_links.filter(
+                valid_until__isnull=sharing_seconds_duration == 0, one_time_link=one_time_link
+            ).count()
+            == 1
+        )
+
+    @patch("wbcore.contrib.documents.models.documents.send_email_as_task.delay")
+    @pytest.mark.parametrize(
+        "to_emails",
+        [(fake.email())],
+    )
+    def test_send_email(self, mock_fct, document, to_emails):
+        document.send_email(to_emails)
+        assert mock_fct.call_count == 1
+
+    def test_get_for_object(self, document_factory):
+        document = document_factory.create()
+        link_obj = document_factory.create()
+        document.link(link_obj)
+        assert Document.get_for_object(link_obj).first() == document
+
+    @pytest.mark.parametrize(
+        "to_emails, as_link, subject, from_email, body",
+        [
+            (fake.email(), False, None, None, None),
+            (fake.email(), False, fake.paragraph(), fake.email(), fake.paragraph()),
+            (fake.email(), True, None, None, None),
+        ],
+    )
+    def test_send_email_as_task(self, document, to_emails, as_link, subject, from_email, body):
+        assert len(mail.outbox) == 0
+        send_email_as_task(document.id, to_emails, as_link=as_link, subject=subject, from_email=from_email, body=body)
+        assert len(mail.outbox) == 1
+        msg = mail.outbox[0]
+        if as_link:
+            assert document.shareable_links.count() == 1
+            assert len(msg.attachments) == 0
+            assert len(msg.alternatives) == 1
+        else:
+            assert document.shareable_links.count() == 0
+            assert len(msg.attachments) == 1
+            assert len(msg.alternatives) == 2
+        assert msg
+
+
+@pytest.mark.django_db
+class TestDocumentTypeModel:
+    def test_init(self, document_type):
+        assert document_type.id is not None
+
+    def test_str(self, document_type_factory):
+        document_type = document_type_factory.create(parent=document_type_factory.create())
+        document_type.save()
+        assert str(document_type) == document_type.compute_str()
+
+
+@pytest.mark.django_db
+class TestShareableLinkModel:
+    @pytest.mark.parametrize(
+        "shareable_link__manual_invalid, shareable_link__valid_until, shareable_link__one_time_link",
+        [(True, None, False), (False, timezone.now() - timedelta(seconds=60), False), (False, None, True)],
+    )
+    def test_unvalid_link(self, shareable_link):
+        if shareable_link.one_time_link:
+            assert shareable_link.is_valid()
+            shareable_link.access()
+        assert not shareable_link.is_valid()
+
+    def test_link(self, shareable_link):
+        URLValidator()(shareable_link.link)
+
+    def test_access(self, shareable_link):
+        assert shareable_link.accesses.count() == 0
+        shareable_link.access()
+        assert shareable_link.accesses.count() == 1
+
+    def test_init(self, shareable_link):
+        assert shareable_link.id is not None
+
+
+@pytest.mark.django_db
+class TestShareableLinkAccessModel:
+    def test_init(self, shareable_link_access):
+        assert shareable_link_access.id is not None