11499211743

Committed 24 Oct 2024 12:24PM UTC coverage: 85.231% (+0.008%) from 85.223%

Build # 11499211743

Build Type

Pull #1402

github

Committed by

web-flow

Commit Message

Merge d1d1fc95a into 9aade4f49

Pull Request Pull Request #1402: add API time filters

Run Details

2956 of 3482 branches covered (84.89%)

Branch coverage included in aggregate %.

22 of 22 new or added lines in 4 files covered. (100.0%)

1 existing line in 1 file now uncovered.

11766 of 13791 relevant lines covered (85.32%)

0.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.37

/ephios/api/views/events.py

import django_filters
from django.db.models import Max, Min, Prefetch
from django_filters.filters import IsoDateTimeFilter
from django_filters.filterset import FilterSet
from oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope
from rest_framework import filters, serializers, viewsets
from rest_framework.permissions import DjangoObjectPermissions
from rest_framework_guardian import filters as guardian_filters

from ephios.api.fields import ChoiceDisplayField
from ephios.core.models import AbstractParticipation, Event, EventType, LocalParticipation, Shift
from ephios.core.templatetags.settings_extras import make_absolute


class SignupStatsSerializer(serializers.Serializer):
    # Stats are read only, so we don't implement create and update:
    # pylint: disable=abstract-method
    requested_count = serializers.IntegerField()
    confirmed_count = serializers.IntegerField()
    missing = serializers.IntegerField()
    free = serializers.IntegerField()
    min_count = serializers.IntegerField()
    max_count = serializers.IntegerField()


class ShiftSerializer(serializers.ModelSerializer):
    signup_stats = SignupStatsSerializer(source="get_signup_stats")

    class Meta:
        model = Shift
        fields = [
            "id",
            "meeting_time",
            "start_time",
            "end_time",
            "signup_flow_slug",
            "signup_flow_configuration",
            "structure_slug",
            "structure_configuration",
            "signup_stats",
        ]


class EventTypeSerializer(serializers.ModelSerializer):
    class Meta:
        model = EventType
        fields = ["id", "title"]


class EventSerializer(serializers.ModelSerializer):
    type = EventTypeSerializer()
    start_time = serializers.DateTimeField(source="get_start_time")
    end_time = serializers.DateTimeField(source="get_end_time")
    signup_stats = SignupStatsSerializer(source="get_signup_stats")
    shifts = ShiftSerializer(many=True)
    frontend_url = serializers.SerializerMethodField()

    def get_frontend_url(self, obj):
        return make_absolute(obj.get_absolute_url())

    class Meta:
        model = Event
        fields = [
            "id",
            "title",
            "description",
            "location",
            "type",
            "frontend_url",
            "start_time",
            "end_time",
            "signup_stats",
            "shifts",
        ]


class ShiftViewSet(viewsets.ReadOnlyModelViewSet):
    serializer_class = ShiftSerializer
    permission_classes = [DjangoObjectPermissions, IsAuthenticatedOrTokenHasScope]
    filter_backends = [guardian_filters.ObjectPermissionsFilter]
    required_scopes = ["PUBLIC_READ"]
    queryset = Shift.objects.all()


class EventFilterSet(FilterSet):
    start_time = IsoDateTimeFilter(field_name="start_time", label="start time")
    end_time = IsoDateTimeFilter(field_name="end_time", label="end time")

    class Meta:
        model = Event
        fields = [
            "type",
        ]


class EventViewSet(viewsets.ReadOnlyModelViewSet):
    serializer_class = EventSerializer
    filterset_class = EventFilterSet
    search_fields = ["title", "description", "location"]
    ordering_fields = ["start_time", "end_time", "title"]
    ordering = ("start_time", "end_time")
    permission_classes = [DjangoObjectPermissions, IsAuthenticatedOrTokenHasScope]
    required_scopes = ["PUBLIC_READ"]

    filter_backends = [
        django_filters.rest_framework.DjangoFilterBackend,
        filters.SearchFilter,
        filters.OrderingFilter,
        guardian_filters.ObjectPermissionsFilter,
    ]

    queryset = (
        Event.objects.all()
        .annotate(
            start_time=Min("shifts__start_time"),
            end_time=Max("shifts__end_time"),
        )
        .select_related("type")
        .prefetch_related("shifts")
        .prefetch_related(Prefetch("shifts__participations"))
        .order_by("start_time")
    )


class ParticipationSerializer(serializers.ModelSerializer):
    event_title = serializers.CharField(source="shift.event.title")
    state = ChoiceDisplayField(choices=AbstractParticipation.States.choices)
    duration = serializers.SerializerMethodField()

    class Meta:
        model = LocalParticipation
        fields = [
            "id",
            "shift",
            "event_title",
            "state",
            "comment",
            "start_time",
            "end_time",
            "duration",
            "structure_data",
        ]

    def build_unknown_field(self, field_name, model_class):
        if field_name in {"start_time", "end_time"}:
            return self.build_property_field(field_name, model_class)
        return super().build_unknown_field(field_name, model_class)

    def get_duration(self, obj):
        return (obj.end_time - obj.start_time).total_seconds()

1	import django_filters	1✔
2	from django.db.models import Max, Min, Prefetch	1✔
3	from django_filters.filters import IsoDateTimeFilter	1✔
4	from django_filters.filterset import FilterSet	1✔
5	from oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope	1✔
6	from rest_framework import filters, serializers, viewsets	1✔
7	from rest_framework.permissions import DjangoObjectPermissions	1✔
8	from rest_framework_guardian import filters as guardian_filters	1✔
9
10	from ephios.api.fields import ChoiceDisplayField	1✔
11	from ephios.core.models import AbstractParticipation, Event, EventType, LocalParticipation, Shift	1✔
12	from ephios.core.templatetags.settings_extras import make_absolute	1✔
13
14
15	class SignupStatsSerializer(serializers.Serializer):	1✔
16	# Stats are read only, so we don't implement create and update:
17	# pylint: disable=abstract-method
18	requested_count = serializers.IntegerField()	1✔
19	confirmed_count = serializers.IntegerField()	1✔
20	missing = serializers.IntegerField()	1✔
21	free = serializers.IntegerField()	1✔
22	min_count = serializers.IntegerField()	1✔
23	max_count = serializers.IntegerField()	1✔
24
25
26	class ShiftSerializer(serializers.ModelSerializer):	1✔
27	signup_stats = SignupStatsSerializer(source="get_signup_stats")	1✔
28
29	class Meta:	1✔
30	model = Shift	1✔
31	fields = [	1✔
32	"id",
33	"meeting_time",
34	"start_time",
35	"end_time",
36	"signup_flow_slug",
37	"signup_flow_configuration",
38	"structure_slug",
39	"structure_configuration",
40	"signup_stats",
41	]
42
43
44	class EventTypeSerializer(serializers.ModelSerializer):	1✔
45	class Meta:	1✔
46	model = EventType	1✔
47	fields = ["id", "title"]	1✔
48
49
50	class EventSerializer(serializers.ModelSerializer):	1✔
51	type = EventTypeSerializer()	1✔
52	start_time = serializers.DateTimeField(source="get_start_time")	1✔
53	end_time = serializers.DateTimeField(source="get_end_time")	1✔
54	signup_stats = SignupStatsSerializer(source="get_signup_stats")	1✔
55	shifts = ShiftSerializer(many=True)	1✔
56	frontend_url = serializers.SerializerMethodField()	1✔
57
58	def get_frontend_url(self, obj):	1✔
59	return make_absolute(obj.get_absolute_url())	1✔
60
61	class Meta:	1✔
62	model = Event	1✔
63	fields = [	1✔
64	"id",
65	"title",
66	"description",
67	"location",
68	"type",
69	"frontend_url",
70	"start_time",
71	"end_time",
72	"signup_stats",
73	"shifts",
74	]
75
76
77	class ShiftViewSet(viewsets.ReadOnlyModelViewSet):	1✔
78	serializer_class = ShiftSerializer	1✔
79	permission_classes = [DjangoObjectPermissions, IsAuthenticatedOrTokenHasScope]	1✔
80	filter_backends = [guardian_filters.ObjectPermissionsFilter]	1✔
81	required_scopes = ["PUBLIC_READ"]	1✔
82	queryset = Shift.objects.all()	1✔
83
84
85	class EventFilterSet(FilterSet):	1✔
86	start_time = IsoDateTimeFilter(field_name="start_time", label="start time")	1✔
87	end_time = IsoDateTimeFilter(field_name="end_time", label="end time")	1✔
88
89	class Meta:	1✔
90	model = Event	1✔
91	fields = [	1✔
92	"type",
93	]
94
95
96	class EventViewSet(viewsets.ReadOnlyModelViewSet):	1✔
97	serializer_class = EventSerializer	1✔
98	filterset_class = EventFilterSet	1✔
99	search_fields = ["title", "description", "location"]	1✔
100	ordering_fields = ["start_time", "end_time", "title"]	1✔
101	ordering = ("start_time", "end_time")	1✔
102	permission_classes = [DjangoObjectPermissions, IsAuthenticatedOrTokenHasScope]	1✔
103	required_scopes = ["PUBLIC_READ"]	1✔
104
105	filter_backends = [	1✔
106	django_filters.rest_framework.DjangoFilterBackend,
107	filters.SearchFilter,
108	filters.OrderingFilter,
109	guardian_filters.ObjectPermissionsFilter,
110	]
111
112	queryset = (	1✔
113	Event.objects.all()
114	.annotate(
115	start_time=Min("shifts__start_time"),
116	end_time=Max("shifts__end_time"),
117	)
118	.select_related("type")
119	.prefetch_related("shifts")
120	.prefetch_related(Prefetch("shifts__participations"))
121	.order_by("start_time")
122	)
123
124
125	class ParticipationSerializer(serializers.ModelSerializer):	1✔
126	event_title = serializers.CharField(source="shift.event.title")	1✔
127	state = ChoiceDisplayField(choices=AbstractParticipation.States.choices)	1✔
128	duration = serializers.SerializerMethodField()	1✔
129
130	class Meta:	1✔
131	model = LocalParticipation	1✔
132	fields = [	1✔
133	"id",
134	"shift",
135	"event_title",
136	"state",
137	"comment",
138	"start_time",
139	"end_time",
140	"duration",
141	"structure_data",
142	]
143
144	def build_unknown_field(self, field_name, model_class):	1✔
145	if field_name in {"start_time", "end_time"}:	1!
146	return self.build_property_field(field_name, model_class)	1✔
UNCOV 147	return super().build_unknown_field(field_name, model_class)	×
148
149	def get_duration(self, obj):	1✔
150	return (obj.end_time - obj.start_time).total_seconds()	1✔

ephios-dev / ephios / 11499211743

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous