add description field to place

oser_backend/api/urls.py

@@ -19,7 +19,7 @@ urlpatterns = [
     url(r'^auth/get-token/$', obtain_auth_token, name='get-auth-token'),
 ]
 
-router = routers.SimpleRouter()
+router = routers.DefaultRouter()
 
 # Visits views
 router.register('visits', visits_views.VisitViewSet)

oser_backend/tests/test_api/test_visit_participant_api.py

@@ -3,7 +3,7 @@
 from django.test import TestCase
 from rest_framework import status
 from tests.factory import VisitParticipantFactory
-from tests.factory import VisitFactory, StudentFactory, UserFactory
+from tests.factory import VisitFactory, StudentFactory
 from tests.utils import HyperlinkedAPITestCase
 from visits.serializers import (
     VisitParticipantWriteSerializer, VisitParticipantIdentifySerializer)

oser_backend/tests/test_visits/test_place.py

@@ -18,6 +18,10 @@ class PlaceTest(ModelTestCase):
             'verbose_name': 'adresse',
             'max_length': 200,
         },
+        'description': {
+            'default': '',
+            'blank': True,
+        }
     }
     model_tests = {
         'verbose_name': 'lieu',

oser_backend/visits/models.py

@@ -12,10 +12,7 @@ utc = pytz.UTC
 
 
 class VisitQuerySet(models.QuerySet):
-    """Custom Visit queryset.
-
-    Allow filtering by whether registrations are open or closed.
-    """
+    """Custom Visit queryset."""
 
     def registrations_open(self, state):
         """Filter visits whose registrations are open or closed.
@@ -28,13 +25,17 @@ class VisitQuerySet(models.QuerySet):
             True corresponds to open registrations,
             False to closed registrations.
         """
-        dt_now = now()
+        today = now()
         if state:
-            return self.filter(deadline__gte=dt_now)
+            return self.filter(deadline__gte=today)
         else:
-            return self.filter(deadline__lt=dt_now)
+            return self.filter(deadline__lt=today)
 
     def passed(self):
+        """Return a queryset containing only passed visits.
+
+        A visit is passed if its date is strictly after today.
+        """
         return self.filter(date__gt=now())
 
 
@@ -176,6 +177,7 @@ class Place(models.Model):
 
     name = models.CharField('nom', max_length=200)
     address = models.CharField('adresse', max_length=200)
+    description = MarkdownxField(default='', blank=True)
 
     class Meta:  # noqa
         verbose_name = 'lieu'

oser_backend/visits/serializers.py

@@ -9,10 +9,11 @@ from .models import Visit, VisitParticipant, Place
 
 
 class PlaceSerializer(serializers.ModelSerializer):
+    """Serializer for Place."""
 
     class Meta:  # noqa
         model = Place
-        fields = ('id', 'name', 'address')
+        fields = ('id', 'name', 'address', 'description')
 
 
 class VisitSerializer(serializers.HyperlinkedModelSerializer):

oser_backend/visits/views.py

@@ -33,11 +33,21 @@ class VisitParticipantsViewSet(mixins.CreateModelMixin,
     permission_classes = (DRYPermissions,)
 
     def get_queryset(self):
-        if self.action in ['retrieve']:
+        """Determine, among other things, what get_object() will return.
+
+        Return all visits for the retrieve action as the <pk> identifies
+        a visit there.
+        Otherwise return all visit participants.
+        """
+        if self.action == 'retrieve':
             return Visit.objects.all()
         return VisitParticipant.objects.all()
 
     def get_serializer_class(self):
+        """Return the right serializer class for each action.
+
+        Allows DRF to display arguments/parameters in the generated docs.
+        """
         if self.action == 'list':
             return VisitParticipantReadSerializer
         elif self.action == 'retrieve':
@@ -80,6 +90,7 @@ class VisitParticipantsViewSet(mixins.CreateModelMixin,
 
 
 class PlaceViewSet(viewsets.ReadOnlyModelViewSet):
+    """Simple read-only view set for places."""
 
     queryset = Place.objects.all()
     serializer_class = PlaceSerializer