wbcore 1.59.9__py2.py3-none-any.whl

wbcore/contrib/agenda/release_notes/1_0_0.md

@@ -0,0 +1,13 @@
+Date: 2023-04-26
+Module: Agenda
+Summary: Initial Release Note
+Version: 1.0.0
+
+## New Features
+- Bootstrap module versioning
+
+## Enhancements
+./.
+
+## Bugfixes
+./.

wbcore/contrib/agenda/serializers/__init__.py

@@ -0,0 +1,10 @@
+from .calendar_item import (
+    CalendarItemModelSerializer,
+    CalendarItemRepresentationSerializer,
+)
+from .conference_room import (
+    BuildingModelSerializer,
+    BuildingRepresentationSerializer,
+    ConferenceRoomModelSerializer,
+    ConferenceRoomRepresentationSerializer,
+)

wbcore/contrib/agenda/serializers/calendar_item.py

@@ -0,0 +1,77 @@
+from collections import OrderedDict
+
+from django.utils.translation import gettext as _
+from rest_framework.reverse import NoReverseMatch, reverse
+
+from wbcore import serializers
+from wbcore.contrib.agenda.models import CalendarItem
+
+
+class CalendarItemRepresentationSerializer(serializers.RepresentationSerializer):
+    _detail = serializers.SerializerMethodField()
+
+    def get__detail(self, obj) -> str:
+        try:
+            return reverse(f"{obj.endpoint_basename}-detail", args=[obj.id], request=self.context["request"])
+        except (NoReverseMatch, KeyError):
+            return ""
+
+    class Meta:
+        model = CalendarItem
+        fields = (
+            "id",
+            "title",
+            "_detail",
+        )
+
+
+class CalendarItemModelSerializer(serializers.ModelSerializer):
+    activity_id = serializers.CharField()
+    endpoint = serializers.SerializerMethodField()
+    is_confidential = serializers.BooleanField(default=False, read_only=True)
+    is_draggable = serializers.BooleanField(default=False, read_only=True)
+    is_private = serializers.BooleanField(default=False, read_only=True)
+
+    def get_endpoint(self, obj):
+        try:
+            return reverse(f"{obj.endpoint_basename}-detail", args=[obj.id], request=self.context["request"])
+        except (NoReverseMatch, KeyError):
+            return ""
+
+    def to_representation(self, instance: CalendarItem) -> OrderedDict:
+        representation = super().to_representation(instance)
+
+        is_private: bool
+        if (is_private := representation.get("is_private", False)) or representation.get("is_confidential", False):
+            item_type = instance.item_type.split(".")[1] if instance.item_type else _("Item")
+            representation["title"] = (
+                _("Private {}").format(item_type) if is_private else _("Confidential {}").format(item_type)
+            )
+            if not is_private:
+                representation["_entities"] = ""
+                representation["entities"] = ""
+                representation["entity_list"] = ""
+
+        return representation
+
+    class Meta:
+        model = CalendarItem
+        read_only_fields = ("is_cancelled",)
+        fields = (
+            "id",
+            "title",
+            "entities",
+            "all_day",
+            "activity_id",
+            "color",
+            "endpoint",
+            "entity_list",
+            "icon",
+            "is_cancelled",
+            "is_confidential",
+            "is_draggable",
+            "is_private",
+            "period",
+            "is_deletable",
+        )
+        read_only_fields = ("endpoint",)

wbcore/contrib/agenda/serializers/conference_room.py

@@ -0,0 +1,99 @@
+from django.forms import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+from wbcore import serializers
+from wbcore.contrib.agenda.models import Building, ConferenceRoom
+from wbcore.contrib.directory.serializers.contacts import (
+    AddressContactRepresentationSerializer,
+)
+
+
+class BuildingRepresentationSerializer(serializers.RepresentationSerializer):
+    endpoint = "wbcore:agenda:buildingrepresentation-list"
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:agenda:building-detail")
+    _address = AddressContactRepresentationSerializer(source="address")
+
+    class Meta:
+        model = Building
+        fields = (
+            "id",
+            "name",
+            "address",
+            "_address",
+            "_detail",
+        )
+
+
+class ConferenceRoomRepresentationSerializer(serializers.RepresentationSerializer):
+    endpoint = "wbcore:agenda:conferenceroomrepresentation-list"
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:agenda:conferenceroom-detail")
+    _building = BuildingRepresentationSerializer(source="building")
+
+    class Meta:
+        model = ConferenceRoom
+        fields = (
+            "id",
+            "name",
+            "building",
+            "_building",
+            "_detail",
+        )
+
+
+class BuildingModelSerializer(serializers.ModelSerializer):
+    _address = AddressContactRepresentationSerializer(source="address")
+
+    class Meta:
+        model = Building
+        fields = (
+            "id",
+            "name",
+            "address",
+            "_address",
+        )
+
+    def validate(self, data):
+        name = data.get("name", None)
+        address = data.get("address", None)
+
+        if address:
+            building = Building.objects.filter(name=name, address=address)
+        else:
+            building = Building.objects.filter(name=name)
+        if obj := self.instance:
+            building = building.exclude(id=obj.id)
+        if building.exists():
+            raise ValidationError({"name": _("A building with this name and address already exists.")})
+        return data
+
+
+class ConferenceRoomModelSerializer(serializers.ModelSerializer):
+    _building = BuildingRepresentationSerializer(source="building")
+
+    class Meta:
+        model = ConferenceRoom
+        fields = (
+            "id",
+            "name",
+            "email",
+            "building",
+            "_building",
+            "capacity",
+            "is_videoconference_capable",
+        )
+
+    def validate(self, data):
+        name = data.get("name", None)
+        building = data.get("building", None)
+        email = data.get("email", None)
+
+        mail_dupl = ConferenceRoom.objects.filter(email=email)
+        conference_room_dupl = ConferenceRoom.objects.filter(name=name, building=building)
+        if obj := self.instance:
+            mail_dupl = mail_dupl.exclude(id=obj.id)
+            conference_room_dupl = conference_room_dupl.exclude(id=obj.id)
+        if mail_dupl.exists():
+            raise ValidationError({("email"): _("A conference room with this email address already exists.")})
+        if conference_room_dupl.exists():
+            raise ValidationError({("name"): _("A conference room with this name already exists in this building.")})
+        return data

wbcore/contrib/agenda/signals.py

@@ -0,0 +1,5 @@
+from django.db.models.signals import ModelSignal
+
+draggable_calendar_item_ids = (
+    ModelSignal()
+)  # Signal called to gather the list of calendar items that are considered draggable.

wbcore/contrib/agenda/static/agenda/markdown/documentation/building.md

@@ -0,0 +1,11 @@
+# Buildings
+This is a list of every company building in the database where you can modify, delete and add new buildings. Typing in the search field filters the buildings by name.
+
+## Columns:
+Each column has a triangle on the right. Click on the triangle to show filter options for that column. Click on the arrows next to the column name to order by that column in ascending or descending order. Hold shift while clicking to order multiple columns with individual weight.
+
+### Name:
+The name of the building.
+
+### Address:
+The building's location. You can add new addresses for use when pressing the "New Address" button at the top of the list.

wbcore/contrib/agenda/static/agenda/markdown/documentation/conferenceroom.md

@@ -0,0 +1,20 @@
+# Conference Rooms
+This is a list of every conference room in the database where you can modify, delete and add new rooms. Typing in the search field filters the conference rooms by name.
+
+## Columns:
+Each column has a triangle on the right. Click on the triangle to show filter options for that column. Click on the arrows next to the column name to order by that column in ascending or descending order. Hold shift while clicking to order multiple columns with individual weight.
+
+### Name:
+The name of the room.
+
+### E-Mail-Address:
+The room's email address. Must be unique.
+
+### Building:
+The building in which the room is located. You can add buildings under CRM > Administration > Conference Room > Buildings.
+
+### Capacity:
+The maximum amount of people that can be seated in the room. Is used to warn users when they add too many participants to a conference room meeting.
+
+### Capable of Videoconferencing:
+Indicates if a conference room is equipped to take part in a video conference. If it is not, participants won't be able to set their attendance as "Attend Digitally".

wbcore/contrib/agenda/tests/conftest.py

@@ -0,0 +1,14 @@
+from pytest_factoryboy import register
+from wbcore.contrib.authentication.factories import UserFactory
+from wbcore.contrib.directory.factories import EntryFactory, PersonFactory
+from wbcore.tests.conftest import *
+
+from ..factories import BuildingFactory, CalendarItemFactory, ConferenceRoomFactory
+from .signals import *
+
+register(CalendarItemFactory)
+register(BuildingFactory)
+register(EntryFactory)
+register(PersonFactory)
+register(UserFactory)
+register(ConferenceRoomFactory)

wbcore/contrib/agenda/tests/signals.py

@@ -0,0 +1,17 @@
+from django.dispatch import receiver
+
+from wbcore.test.signals import get_custom_factory
+
+from ..factories import CalendarItemFactory
+from ..viewsets import (
+    CalendarItemViewSet,
+    InfiniteCalendarItemViewSet,
+    OwnCalendarItemViewSet,
+)
+
+
+@receiver(get_custom_factory, sender=CalendarItemViewSet)
+@receiver(get_custom_factory, sender=InfiniteCalendarItemViewSet)
+@receiver(get_custom_factory, sender=OwnCalendarItemViewSet)
+def receive_factory_employee(sender, *args, **kwargs):
+    return CalendarItemFactory

wbcore/contrib/agenda/tests/test_models.py

@@ -0,0 +1,34 @@
+import pytest
+from django.contrib.auth.models import Permission
+
+
+@pytest.mark.django_db
+class TestCalendarItemTest:
+    def test_to_ics(self, calendar_item_factory):
+        calendar_item1 = calendar_item_factory()
+        assert calendar_item1.to_ics(calendar_item1.period.upper, calendar_item1.period.lower) is None
+        calendar_item2 = calendar_item_factory()
+        assert calendar_item2.to_ics(calendar_item1.period.lower, calendar_item1.period.upper)
+
+    def test_get_item_type(self, calendar_item_factory):
+        calendar_item = calendar_item_factory()
+        assert calendar_item.get_item_type() == "agenda.CalendarItem"
+
+    @pytest.mark.parametrize("calendar_item__is_deletable", [True, False])
+    def test_cannot_delete_calendar_item(self, calendar_item, user):
+        assert not calendar_item.can_delete(
+            user
+        )  # as user is not a manger nor among the entities, he cannot delete the event
+
+    @pytest.mark.parametrize("calendar_item__is_deletable", [True, False])
+    def test_can_manager_delete_event(self, calendar_item, user):
+        permission = Permission.objects.get(
+            content_type__app_label="agenda", codename="administrate_confidential_items"
+        )
+        user.user_permissions.add(permission)
+        assert calendar_item.can_delete(user) == calendar_item.is_deletable
+
+    @pytest.mark.parametrize("calendar_item__is_deletable", [True, False])
+    def test_can_participants_delete_event(self, calendar_item, user):
+        calendar_item.entities.add(user.profile.id)
+        assert calendar_item.can_delete(user) == calendar_item.is_deletable

wbcore/contrib/agenda/tests/test_viewsets.py

@@ -0,0 +1,172 @@
+import pytest
+from django.contrib.auth.models import Permission
+from rest_framework import status
+from rest_framework.reverse import reverse
+from rest_framework.test import APIClient, APIRequestFactory
+
+from wbcore.contrib.agenda.models import CalendarItem
+from wbcore.contrib.agenda.viewsets import CalendarItemViewSet
+from wbcore.contrib.authentication.factories import UserFactory
+from wbcore.test.utils import get_kwargs, get_or_create_superuser
+
+from ..factories import CalendarItemFactory
+
+
+@pytest.mark.django_db
+class TestCalendarItemViewSet:
+    api_factory = APIRequestFactory()
+
+    def test_activity_is_draggable(self, calendar_item_factory, user_factory):
+        calendar_item = calendar_item_factory()
+        request = self.api_factory.get("")
+        request.user = user_factory(is_active=True, is_superuser=True)
+        view = CalendarItemViewSet.as_view({"get": "retrieve"})
+        response = view(request, pk=calendar_item.id).render()
+        assert response.data["instance"]["is_draggable"] is False
+
+    # =================================================================================================================
+    #                                            TESTING PRIVATE CALENDAR ITEMS
+    # =================================================================================================================
+
+    def test_entity_can_see_private_item(self, calendar_item_factory, user_factory):
+        user = user_factory(is_active=True, is_superuser=True)
+        activity = calendar_item_factory(entities=[user.profile], visibility=CalendarItem.Visibility.PRIVATE)
+        request = self.api_factory.get("")
+        request.user = user
+        view = CalendarItemViewSet.as_view({"get": "list"})
+        response = view(request).render()
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data["results"]
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["id"] == activity.id
+        assert response.data["results"][0]["is_private"] is False
+        assert response.data["results"][0]["title"] == activity.title
+
+    @pytest.mark.parametrize("mvs", [CalendarItemViewSet])
+    def test_random_cannot_see_private_item(self, mvs, calendar_item_factory, user_factory):
+        user = user_factory(is_active=True, is_superuser=True)
+        item = calendar_item_factory(visibility=CalendarItem.Visibility.PRIVATE)
+        request = self.api_factory.get("")
+        request.user = user
+        view = mvs.as_view({"get": "list"})
+        response = view(request).render()
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data["results"]
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["id"] == item.id
+        assert response.data["results"][0]["is_private"] is True
+        assert response.data["results"][0]["title"] == "Private CalendarItem"
+
+    # =================================================================================================================
+    #                                            TESTING CONFIDENTIAL CALENDAR ITEMS
+    # =================================================================================================================
+
+    @pytest.mark.parametrize("mvs", [CalendarItemViewSet])
+    def test_manager_can_see_confidential_item(self, mvs, calendar_item_factory, user_factory):
+        user = user_factory(is_active=True, is_superuser=True)
+        permission = Permission.objects.get(
+            content_type__app_label="agenda", codename="administrate_confidential_items"
+        )
+        user.user_permissions.add(permission)
+        item = calendar_item_factory(visibility=CalendarItem.Visibility.CONFIDENTIAL)
+        request = self.api_factory.get("")
+        request.user = user
+        view = mvs.as_view({"get": "list"})
+        response = view(request).render()
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data["results"]
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["id"] == item.id
+        assert response.data["results"][0]["is_confidential"] is False
+        assert response.data["results"][0]["title"] == item.title
+
+    @pytest.mark.parametrize("mvs", [CalendarItemViewSet])
+    def test_random_cannot_see_confidential_item(self, mvs, calendar_item_factory, user_factory):
+        user = user_factory(is_active=True, is_superuser=True)
+        item = calendar_item_factory(visibility=CalendarItem.Visibility.CONFIDENTIAL)
+        request = self.api_factory.get("")
+        request.user = user
+        view = mvs.as_view({"get": "list"})
+        response = view(request).render()
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data["results"]
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["id"] == item.id
+        assert response.data["results"][0]["is_confidential"] is True
+        assert response.data["results"][0]["title"] == "Confidential CalendarItem"
+
+
+@pytest.mark.django_db
+class TestSpecificsInfiniteViewsets:
+    @pytest.mark.parametrize(
+        "mvs, factory",
+        [
+            (CalendarItemViewSet, CalendarItemFactory),
+        ],
+    )
+    def test_option_request(self, mvs, factory, entry):
+        request = APIRequestFactory().options("")
+        request.user = get_or_create_superuser()
+        obj = factory(entities=(entry,))
+        request.GET = request.GET.copy()
+        request.GET["date_gte"] = str(obj.period.lower.date())
+        kwargs = {}
+        mvs.request = request
+        vs = mvs.as_view({"options": "options"})
+        kwargs = get_kwargs(obj, mvs, request=request)
+        response = vs(request, **kwargs).render()
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data
+
+    @pytest.mark.parametrize(
+        "mvs, factory",
+        [
+            (CalendarItemViewSet, CalendarItemFactory),
+        ],
+    )
+    def test_viewsets(self, mvs, factory, entry):
+        request = APIRequestFactory().get("")
+        request.user = get_or_create_superuser()
+        obj = factory(entities=(entry,))
+        request.GET = request.GET.copy()
+        request.GET["date_gte"] = str(obj.period.lower.date())
+        kwargs = {}
+        mvs.request = request
+        vs = mvs.as_view({"get": "list"})
+        response = vs(request, **kwargs).render()
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data
+
+    @pytest.mark.parametrize(
+        "mvs, factory",
+        [
+            (CalendarItemViewSet, CalendarItemFactory),
+        ],
+    )
+    def test_viewsets_without_date_gte(self, mvs, factory, entry):
+        request = APIRequestFactory().get("")
+        request.user = get_or_create_superuser()
+        factory(entities=(entry,))
+        request.GET = request.GET.copy()
+        request.GET["date_gte"] = None
+        kwargs = {}
+        mvs.request = request
+        vs = mvs.as_view({"get": "list"})
+        response = vs(request, **kwargs).render()
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data
+
+    def test_get_ics(self, calendar_item_factory):
+        client = APIClient()
+        user = UserFactory(is_active=True, is_superuser=True)
+        calendar_item_factory(
+            entities=(user.profile,),
+        )
+
+        client.force_authenticate(user)
+        response = client.get(reverse("wbcore:agenda:get_ics", args=[]))
+        assert response.status_code == status.HTTP_200_OK

wbcore/contrib/agenda/tests/tests.py

@@ -0,0 +1,26 @@
+import pytest
+
+from wbcore.contrib.agenda.typings import ConferenceRoom as ConferenceRoomDTO
+
+
+@pytest.mark.django_db
+class TestDTO:
+    @pytest.mark.parametrize(
+        "id, name, email",
+        [
+            (None, None, None),
+            (None, "test", None),
+            (None, "test", "test@test.com"),
+            (1, None, None),
+            (1, "test", None),
+            (1, "test", "test@test.com"),
+        ],
+    )
+    def test_comparison(self, id, name, email):
+        conf_room1 = ConferenceRoomDTO(1, "test", "test@test.com")
+        conf_room2 = ConferenceRoomDTO(id=id, name=name, email=email)
+        if (conf_room1.id == conf_room2.id is not None) or (conf_room1.email == conf_room2.email is not None):
+            assert conf_room1 == conf_room2
+        else:
+            assert conf_room1 != conf_room2
+        assert conf_room2 is not None

wbcore/contrib/agenda/typings.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class ConferenceRoom:
+    name: str
+    email: str
+    name_building: str = None
+    capacity: int = None
+    is_videoconference_capable: bool = True
+    id: str = None
+
+    def __eq__(self, other):
+        if other and (
+            (self.id and other.id and self.id == other.id)
+            or (self.email and other.email and self.email == other.email)
+        ):
+            return True
+        return super().__eq__(other)

wbcore/contrib/agenda/urls.py

@@ -0,0 +1,26 @@
+from django.urls import include, path
+
+from wbcore.routers import WBCoreRouter
+
+from . import viewsets
+
+router = WBCoreRouter()
+router.register(r"calendaritem", viewsets.InfiniteCalendarItemViewSet, basename="calendaritem")
+router.register(
+    r"calendaritemrepresentation", viewsets.CalendarItemRepresentationViewSet, basename="calendaritemrepresentation"
+)
+router.register(r"owncalendar", viewsets.OwnCalendarItemViewSet, basename="owncalendar")
+router.register(
+    r"conferenceroomrepresentation",
+    viewsets.ConferenceRoomRepresentationViewSet,
+    basename="conferenceroomrepresentation",
+)
+router.register(r"conferenceroom", viewsets.ConferenceRoomModelViewSet, basename="conferenceroom")
+router.register(r"buildingrepresentation", viewsets.BuildingRepresentationViewSet, basename="buildingrepresentation")
+router.register(r"building", viewsets.BuildingModelViewSet, basename="building")
+
+
+urlpatterns = [
+    path("", include(router.urls)),
+    path("ics/", viewsets.get_ics, name="get_ics"),
+]

wbcore/contrib/agenda/viewsets/__init__.py

@@ -0,0 +1,13 @@
+from .calendar_items import (
+    CalendarItemRepresentationViewSet,
+    CalendarItemViewSet,
+    InfiniteCalendarItemViewSet,
+    OwnCalendarItemViewSet,
+    get_ics,
+)
+from .conference_room import (
+    BuildingModelViewSet,
+    BuildingRepresentationViewSet,
+    ConferenceRoomModelViewSet,
+    ConferenceRoomRepresentationViewSet,
+)

wbcore/contrib/agenda/viewsets/buttons/__init__.py

@@ -0,0 +1 @@
+from .conference_room import BuildingButtonConfig

wbcore/contrib/agenda/viewsets/buttons/conference_room.py

@@ -0,0 +1,21 @@
+from django.utils.translation import gettext as _
+from rest_framework.reverse import reverse
+
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.buttons.view_config import ButtonViewConfig
+
+
+class BuildingButtonConfig(ButtonViewConfig):
+    def get_custom_buttons(self):
+        if not self.view.kwargs.get("pk", None):
+            base_url = reverse("wbcore:directory:addresscontact-list", args=[], request=self.request)
+
+            return {
+                bt.WidgetButton(
+                    endpoint=base_url,
+                    label=_("New Address"),
+                    icon="add_location",
+                    new_mode=True,
+                )
+            }
+        return {}