Ask potential speakers about their time slot availability (#1379)

* initial

* renamed to something more sensible

* Add a required checkbox to the CfP proposal submission page. The checkbox content is not stored in the database, but submission will fail unless checked.

* added test to verify that speakers do have to agree to the speaker release agreement

* initial

* renamed to something more sensible

* Added a template simple_tag to list a user tickets for the current conference. Uses functionality already implemented.

* Added documentation

* Added a template simple_tag to list a user tickets for the current conference. Uses functionality already implemented.

* Upgraded jquery-flot to v0.8.3 for compatibility with django admin jquery version - v3.5.1

* Added timeslot availability selector in talk proposal form and admin. The admin might need some more work to make it nice

* typo

* implemented tests and updated talk factory for timezone availability

Author: fpierfed

conference/forms/forms.py

@@ -157,6 +157,25 @@ class TalkBaseForm(forms.Form):
         help_text=_('<p>Please add anything you may find useful for the review of your session proposal, e.g. references of where you have held talks, blogs, YouTube channels, books you have written, etc. This information will only be shown for talk review purposes.</p>'),
         widget=forms.Textarea,
         required=False)
+
+    # For online conference we want to know availability in the defined
+    # timeslots. Of course no timeslot defined, no need to ask :-)
+    # Timeslots are defined in settings.py
+    timeslots = getattr(settings, 'CONFERENCE_TIMESLOTS', None)
+    if timeslots:
+        availability = forms.MultipleChoiceField(
+            label='Timezone Availability',
+            choices=timeslots,
+            help_text=_(
+                '<p>Please select yout timezone availability. You can '
+                'select multiple time-slots using SHIFT. Select '
+                'non-contigous slots using CMD (macOS) or CTRL. You can '
+                'deselect a selcted entry using CMD (macOS) or CTRL.</p>'
+            ),
+            required=True,
+        )
+
+    # Make sure that they agree to the Speaker Release Terms.
     i_accept_speaker_release = forms.BooleanField(
         label=RELEASE_AGREEMENT_CHECKBOX,
         required=True

conference/forms/talks.py

@@ -20,6 +20,8 @@ class TalkUpdateForm(forms.ModelForm):
     prerequisites = TalkBaseForm.base_fields["prerequisites"]
     level = TalkBaseForm.base_fields["level"]
     domain_level = TalkBaseForm.base_fields["domain_level"]
+    if 'availability' in TalkBaseForm.base_fields:
+        availability = TalkBaseForm.base_fields["availability"]
     i_accept_speaker_release  = TalkBaseForm.base_fields[
         'i_accept_speaker_release'
     ]
@@ -42,6 +44,7 @@ def __init__(self, *args, **kwargs):
 
         if kwargs.get("instance"):
             self.fields["abstract"].initial = kwargs["instance"].getAbstract().body
+            self.fields['availability'].initial = kwargs['instance'].get_availability()
 
     def save(self, user):
         """
@@ -52,6 +55,7 @@ def save(self, user):
         talk.created_by = user
         talk.slug = f"{talk.uuid}-{slugify(talk.title)}"
         talk.conference = Conference.objects.current().code
+        talk.set_availability(self.cleaned_data['availability'])
         talk.save()
         talk.setAbstract(self.cleaned_data["abstract"])
 

conference/migrations/0029_talk_availability.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.19 on 2021-04-24 14:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('conference', '0028_changes_to_conferencetag_and_conferencetaggeditem'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='talk',
+            name='availability',
+            field=models.TextField(blank=True, default='', help_text='<p>Please enter your time availability.</p>', verbose_name='Timezone availability'),
+        ),
+    ]

conference/models.py

@@ -647,6 +647,13 @@ class Talk(models.Model):
         default="",
     )
 
+    availability = models.TextField(
+        verbose_name=_('Timezone availability'),
+        help_text=_('<p>Please enter your time availability.</p>'),
+        blank=True,
+        default='',
+    )
+
     slides = models.FileField(upload_to=_fs_upload_to("slides"), blank=True)
     slides_url = models.URLField(blank=True)
     repository_url = models.URLField(blank=True)
@@ -803,6 +810,13 @@ def get_abstract(self, language=None):
         else:
             return self.abstract_short
 
+    def set_availability(self, values, language=None):
+        encoded_value = '|'.join(values)
+        self.availability = encoded_value
+
+    def get_availability(self):
+        return self.availability.split('|')
+
 
 class TalkSpeaker(models.Model):
     talk = models.ForeignKey(Talk, on_delete=models.CASCADE)

conference/talks.py

@@ -134,11 +134,15 @@ def dump_relevant_talk_information_to_dict(talk: Talk, speaker_tickets=None):
 
     """ Dumps information about talk to a dictionary suitable for sending
         back as JSON.
-        
+
         speaker_tickets may be given as dictionary mapping assigned to email
         to Ticket object and is used for defining has_ticket.
-        
+
     """
+    if not talk.availability:
+        availability = None
+    else:
+        availability = talk.availability.split('|')
     event = talk.get_event()
     if event is not None:
         event = event.json_dump()
@@ -163,6 +167,7 @@ def dump_relevant_talk_information_to_dict(talk: Talk, speaker_tickets=None):
         "event": event,
         "schedule_url": talk.get_schedule_url(),
         "slides_url": talk.get_slides_url(),
+        "availability": availability,
     }
 
     for speaker in talk.get_all_speakers():

pycon/settings.py

@@ -454,6 +454,14 @@ def _(x):
 
 CONFERENCE_CONFERENCE = 'ep2021'
 CONFERENCE_NAME = "EuroPython 2021"
+# IF The conference has timeslots and IF we want to ask speakers for their
+# availability in these timeslots, add/edit below. Otherwise just set to None
+# CONFERENCE_TIMESLOTS = None
+CONFERENCE_TIMESLOTS = (
+    ('morning', _('08-12 CEST / 06-10 UTC')),
+    ('afternoon', _('12-16 CEST / 10-14 UTC')),
+    ('evening', _('16-20 CEST / 14-18 UTC')),
+)
 CONFERENCE_SEND_EMAIL_TO = ["[email protected]"]
 CONFERENCE_TALK_SUBMISSION_NOTIFICATION_EMAIL = []
 CONFERENCE_VOTING_DISALLOWED = 'https://ep2021.europython.eu/talk-voting/'

tests/factories.py

@@ -28,6 +28,10 @@
 )
 from conference.fares import ALL_POSSIBLE_FARE_CODES, TALK_VOTING_FARE_CODES
 from p3.models import TICKET_CONFERENCE_SHIRT_SIZES, TICKET_CONFERENCE_DIETS
+try:
+    from pycon.settings import CONFERENCE_TIMESLOTS
+except ImportError:
+    CONFERENCE_TIMESLOTS = None
 
 
 fake = Faker()
@@ -340,6 +344,11 @@ class Meta:
         Conference.objects.all().values_list("code", flat=True)
     )
     language = factory.Iterator(TALK_LANGUAGES, getter=lambda x: x[0])
+    _slots = [ts[0] for ts in CONFERENCE_TIMESLOTS]
+    if CONFERENCE_TIMESLOTS:
+        availability = '|'.join(
+            random.choices(_slots, k=random.randint(1, len(_slots)))
+        )
 
     @factory.post_generation
     def abstract(self, create, extracted, **kwargs):

tests/test_cfp.py

@@ -10,6 +10,10 @@
     dump_relevant_talk_information_to_dict,
     AddSpeakerToTalkForm,
 )
+try:
+    from pycon.settings import CONFERENCE_TIMESLOTS
+except ImportError:
+    CONFERENCE_TIMESLOTS = None
 
 from tests.common_tools import redirects_to, template_used
 from tests.factories import TalkFactory
@@ -140,22 +144,23 @@ def test_if_user_can_submit_talk_details_and_is_redirect_to_step2(user_client):
     )
     step1_url = reverse("cfp:step1_submit_proposal")
 
-    response = user_client.post(
-        step1_url,
-        {
-            "type": TALK_TYPE_CHOICES.t_30,
-            "abstract": "Abstract goes here",
-            "title": "A title",
-            "sub_title": "A sub title",
-            "abstract_short": "Short abstract",
-            "abstract_extra": "Abstract _extra",
-            "tags": "abc, defg",
-            "level": TALK_LEVEL.beginner,
-            "domain_level": TALK_LEVEL.advanced,
-            "i_accept_speaker_release": True,
-        },
-    )
-
+    data = {
+        "type": TALK_TYPE_CHOICES.t_30,
+        "abstract": "Abstract goes here",
+        "title": "A title",
+        "sub_title": "A sub title",
+        "abstract_short": "Short abstract",
+        "abstract_extra": "Abstract _extra",
+        "tags": "abc, defg",
+        "level": TALK_LEVEL.beginner,
+        "domain_level": TALK_LEVEL.advanced,
+        "i_accept_speaker_release": True,
+    }
+    if CONFERENCE_TIMESLOTS and \
+       isinstance(CONFERENCE_TIMESLOTS, (list, tuple)):
+        data['availability'] = [CONFERENCE_TIMESLOTS[0][0], ]
+
+    response = user_client.post(step1_url, data)
     assert response.status_code == STEP1_CORRECT_REDIRECT_302
 
     talk = Talk.objects.get()
@@ -169,12 +174,45 @@ def test_if_user_can_submit_talk_details_and_is_redirect_to_step2(user_client):
     assert talk_dict["python_level"] == "Beginner"
     assert talk_dict["domain_level"] == "Advanced"
     assert talk_dict["speakers"] == []
+    if 'availability' in data:
+        assert talk_dict['availability'] == data['availability']
 
     assert redirects_to(
         response, reverse("cfp:step2_add_speakers", args=[talk.uuid])
     )
 
 
+@mark.skipif(CONFERENCE_TIMESLOTS is None, reason='no timeslot defined')
+def test_if_user_cannot_submit_talk_if_availability_not_selected(user_client):
+    STEP1_VALIDATION_FAIL_200 = 200
+
+    Conference.objects.create(
+        code=settings.CONFERENCE_CONFERENCE,
+        name=settings.CONFERENCE_CONFERENCE,
+        cfp_start=timezone.now().date() - timedelta(days=2),
+        cfp_end=timezone.now().date() + timedelta(days=1),
+    )
+    step1_url = reverse("cfp:step1_submit_proposal")
+
+    response = user_client.post(
+        step1_url,
+        {
+            "type": TALK_TYPE_CHOICES.t_30,
+            "abstract": "Abstract goes here",
+            "title": "A title",
+            "sub_title": "A sub title",
+            "abstract_short": "Short abstract",
+            "abstract_extra": "Abstract _extra",
+            "tags": "abc, defg",
+            "level": TALK_LEVEL.beginner,
+            "domain_level": TALK_LEVEL.advanced,
+            "i_accept_speaker_release": True,
+        },
+    )
+
+    assert response.status_code == STEP1_VALIDATION_FAIL_200
+
+
 def test_if_user_cannot_submit_talk_if_release_not_selected(user_client):
     STEP1_VALIDATION_FAIL_200 = 200
 
@@ -469,21 +507,23 @@ def test_update_proposal_updates_proposal(user_client):
 
     edit_url = reverse("cfp:update", args=[talk.uuid])
 
-    response = user_client.post(
-        edit_url,
-        {
-            "type": TALK_TYPE_CHOICES.t_45,
-            "abstract": "New abstract",
-            "abstract_short": "New short abstract",
-            "abstract_extra": "New extra abstract",
-            "level": TALK_LEVEL.intermediate,
-            "domain_level": TALK_LEVEL.advanced,
-            "title": "New title",
-            "sub_title": "New sub title",
-            "tags": "Some, tags",
-            "i_accept_speaker_release": True,
-        },
-    )
+    data = {
+        "type": TALK_TYPE_CHOICES.t_45,
+        "abstract": "New abstract",
+        "abstract_short": "New short abstract",
+        "abstract_extra": "New extra abstract",
+        "level": TALK_LEVEL.intermediate,
+        "domain_level": TALK_LEVEL.advanced,
+        "title": "New title",
+        "sub_title": "New sub title",
+        "tags": "Some, tags",
+        "i_accept_speaker_release": True,
+    }
+    if CONFERENCE_TIMESLOTS and \
+       isinstance(CONFERENCE_TIMESLOTS, (list, tuple)):
+        data['availability'] = [CONFERENCE_TIMESLOTS[0][0], ]
+
+    response = user_client.post(edit_url, data)
 
     assert response.status_code == 302
     talk.refresh_from_db()

tests/test_talks.py

@@ -8,6 +8,10 @@
 
 from conference.cfp import dump_relevant_talk_information_to_dict
 from conference.models import TALK_STATUS, TALK_LEVEL
+try:
+    from pycon.settings import CONFERENCE_TIMESLOTS
+except ImportError:
+    CONFERENCE_TIMESLOTS = None
 from tests.factories import (
     EventFactory,
     UserFactory,
@@ -136,6 +140,9 @@ def test_update_talk_post(user_client):
         "tags": ",".join(tag.name for tag in tags),
         "i_accept_speaker_release": True,
     }
+    if CONFERENCE_TIMESLOTS and \
+       isinstance(CONFERENCE_TIMESLOTS, (list, tuple)):
+        post_data['availability'] = [CONFERENCE_TIMESLOTS[0][0], ]
     resp = user_client.post(url, data=post_data)
 
     talk.refresh_from_db()