Implement calendar events scheduling (#2211)

* Add Google Calendar Client

* Parse events

* Add event to reminder

* Add tests for client and parsing events

* Add viewing events button

* Apply check spelling

* Add reminder blocks and setting a reminder

* Refactor

* Apply sonar

* Add command to manifest and fix bugs

* Add constraint and remove null possibility from event

* Add RQ

* Refactor

* Merge migrations

* Refactor

* Move parse_args to nest app

* Update calendar events blocks

* Use user_id as an argument name instead of slack_user_id

* Add rq to settings

* Update event tests

* Add rq scheduler and add base scheduler

* Fix scheduling

* Add worker and scheduler to docker compose

* Refactor

* Apply check spelling

* Apply rabbit's suggestions

* Add tests

* Apply sonar suggestions

* Apply check spelling

* Update event number

* Optimize docker compose

* Add job id to reminder schedule model and cancel method to the base scheduler

* Update poetry lock

* Update tests

* Merge migrations

* Update tests

* Clean up reminder schedule after completing the job if the recurrence is once and update the object to the next scheduled date if recurrence is otherwise and add list_reminders button

* Update tests

* Apply check-spelling

* Add cancel reminder command and update update_reminder_schedule_date function

* Fix schedule month update

* Fix tests

* Add tests

* Apply rabbit's suggestions

* Apply suggestions

* Update tests

* Clean up migrations

* Add atomic transaction to set_reminder handler

* Update poetry.lock

Author: ahmedxgouda

backend/apps/common/utils.py

@@ -6,8 +6,10 @@
 from datetime import UTC, datetime
 from urllib.parse import urlparse
 
+from dateutil import parser
 from django.conf import settings
 from django.template.defaultfilters import pluralize
+from django.utils import timezone
 from django.utils.text import Truncator
 from django.utils.text import slugify as django_slugify
 from humanize import intword, naturaltime
@@ -33,6 +35,42 @@ def convert_to_camel_case(text: str) -> str:
     return "".join(segments)
 
 
+def parse_date(date_string: str | None) -> datetime | None:
+    """Parse a date string into a datetime object.
+
+    Args:
+        date_string (str | None): The date string to parse.
+
+    Returns:
+        datetime | None: The parsed datetime object, or None if input is None or invalid.
+
+    """
+    if not date_string:
+        return None
+    try:
+        return parser.parse(date_string)
+    except (ValueError, TypeError):
+        return None
+
+
+def convert_to_local(dt: datetime | None) -> datetime | None:
+    """Convert a datetime object to the local timezone.
+
+    Args:
+        dt (datetime | None): The datetime object to convert.
+
+    Returns:
+        datetime | None: The converted datetime object in the local timezone,
+        or None if the input is None.
+
+    """
+    if not dt:
+        return None
+    if timezone.is_naive(dt):
+        dt = timezone.make_aware(dt, timezone=UTC)
+    return timezone.localtime(dt)
+
+
 def convert_to_snake_case(text: str) -> str:
     """Convert a string to snake_case.
 

backend/apps/nest/clients/google_calendar.py

@@ -0,0 +1,42 @@
+"""Google Calendar API Client."""
+
+from django.utils import timezone
+from googleapiclient.discovery import build
+
+from apps.nest.models.google_account_authorization import GoogleAccountAuthorization
+
+
+class GoogleCalendarClient:
+    """Google Calendar API Client Class."""
+
+    def __init__(self, google_account_authorization: GoogleAccountAuthorization):
+        """Initialize the Google Calendar API Client."""
+        self.google_account_authorization = google_account_authorization
+        self.service = build(
+            "calendar", "v3", credentials=google_account_authorization.credentials
+        )
+
+    def get_events(self, min_time=None, max_time=None) -> list[dict]:
+        """Retrieve events from Google Calendar."""
+        if not min_time:
+            min_time = timezone.now()
+        if not max_time:
+            max_time = min_time + timezone.timedelta(days=1)
+        events_result = (
+            self.service.events()
+            .list(
+                calendarId="primary",
+                timeMin=min_time.isoformat(),
+                timeMax=max_time.isoformat(),
+                singleEvents=True,
+                orderBy="startTime",
+            )
+            .execute()
+        )
+        return events_result.get("items", [])
+
+    def get_event(self, google_calendar_id: str) -> dict:
+        """Retrieve a specific event from Google Calendar."""
+        return (
+            self.service.events().get(calendarId="primary", eventId=google_calendar_id).execute()
+        )

backend/apps/nest/handlers/__init__.py

@@ -0,0 +1,88 @@
+"""Handlers for Calendar Events."""
+
+from django.core.cache import cache
+from django.core.exceptions import ValidationError
+from django.db import transaction
+from django.utils import timezone
+
+from apps.nest.clients.google_calendar import GoogleCalendarClient
+from apps.nest.models.google_account_authorization import GoogleAccountAuthorization
+from apps.nest.models.reminder import Reminder
+from apps.nest.models.reminder_schedule import ReminderSchedule
+from apps.owasp.models.event import Event
+from apps.slack.models.member import Member
+
+
+def schedule_reminder(
+    reminder: Reminder,
+    scheduled_time: timezone.datetime,
+    recurrence=ReminderSchedule.Recurrence.ONCE,
+) -> ReminderSchedule:
+    """Schedule a reminder."""
+    if scheduled_time < timezone.now():
+        message = "Scheduled time must be in the future."
+        raise ValidationError(message)
+    if recurrence not in ReminderSchedule.Recurrence.values:
+        message = "Invalid recurrence value."
+        raise ValidationError(message)
+    return ReminderSchedule.objects.create(
+        reminder=reminder,
+        scheduled_time=scheduled_time,
+        recurrence=recurrence,
+    )
+
+
+def set_reminder(
+    channel: str,
+    event_number: str,
+    user_id: str,
+    minutes_before: int,
+    recurrence: str | None = None,
+    message: str = "",
+) -> ReminderSchedule:
+    """Set a reminder for a user."""
+    if minutes_before <= 0:
+        message = "Minutes before must be a positive integer."
+        raise ValidationError(message)
+    auth = GoogleAccountAuthorization.authorize(user_id)
+    if not isinstance(auth, GoogleAccountAuthorization):
+        message = "User is not authorized with Google. Please sign in first."
+        raise ValidationError(message)
+    google_calendar_id = cache.get(f"{user_id}_{event_number}")
+    if not google_calendar_id:
+        message = (
+            "Invalid or expired event number. Please get a new event number from the events list."
+        )
+        raise ValidationError(message)
+
+    client = GoogleCalendarClient(auth)
+    event = Event.parse_google_calendar_event(client.get_event(google_calendar_id))
+    if not event:
+        message = "Could not retrieve the event details. Please try again later."
+        raise ValidationError(message)
+
+    reminder_time = event.start_date - timezone.timedelta(minutes=minutes_before)
+    if reminder_time < timezone.now():
+        message = "Reminder time must be in the future. Please adjust the minutes before."
+        raise ValidationError(message)
+
+    if recurrence and recurrence not in ReminderSchedule.Recurrence.values:
+        message = "Invalid recurrence value."
+        raise ValidationError(message)
+
+    with transaction.atomic():
+        # Saving event to the database after validation
+        event.save()
+
+        member = Member.objects.get(slack_user_id=user_id)
+        reminder, _ = Reminder.objects.get_or_create(
+            channel_id=channel,
+            event=event,
+            member=member,
+            defaults={"message": f"{event.name} - {message}" if message else event.name},
+        )
+        return schedule_reminder(
+            reminder=reminder,
+            scheduled_time=reminder_time,
+            recurrence=recurrence or ReminderSchedule.Recurrence.ONCE,
+        )

backend/apps/nest/handlers/calendar_events.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.2.4 on 2025-09-03 14:26
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("nest", "0008_reminder_reminderschedule"),
+        ("owasp", "0052_remove_event_calendar_id_event_google_calendar_id"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reminder",
+            name="event",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="reminders",
+                to="owasp.event",
+                verbose_name="Event",
+            ),
+        ),
+    ]

backend/apps/nest/migrations/0009_reminder_event.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.4 on 2025-09-07 21:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("nest", "0009_reminder_event"),
+    ]
+
+    operations = [
+        migrations.AddConstraint(
+            model_name="reminderschedule",
+            constraint=models.UniqueConstraint(
+                fields=("reminder", "scheduled_time"), name="unique_reminder_schedule"
+            ),
+        ),
+    ]

backend/apps/nest/migrations/0010_reminderschedule_unique_reminder_schedule.py

@@ -0,0 +1,12 @@
+# Generated by Django 5.2.4 on 2025-09-08 05:48
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("nest", "0005_alter_userbadge_user"),
+        ("nest", "0010_reminderschedule_unique_reminder_schedule"),
+    ]
+
+    operations = []

backend/apps/nest/migrations/0011_merge_20250908_0548.py

@@ -0,0 +1,22 @@
+# Generated by Django 5.2.6 on 2025-09-12 04:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("nest", "0011_merge_20250908_0548"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reminderschedule",
+            name="job_id",
+            field=models.CharField(
+                blank=True,
+                help_text="ID of the scheduled job in the task queue.",
+                max_length=255,
+                verbose_name="Job ID",
+            ),
+        ),
+    ]

backend/apps/nest/migrations/0012_reminderschedule_job_id.py

@@ -0,0 +1,12 @@
+# Generated by Django 5.2.6 on 2025-09-15 04:11
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("nest", "0006_delete_apikey"),
+        ("nest", "0012_reminderschedule_job_id"),
+    ]
+
+    operations = []

backend/apps/nest/migrations/0013_merge_0006_delete_apikey_0012_reminderschedule_job_id.py

@@ -155,13 +155,34 @@ def get_flow():
             raise ValueError(AUTH_ERROR_MESSAGE)
         return get_google_auth_client()
 
+    @property
+    def credentials(self):
+        """The Google API credentials."""
+        if not settings.IS_GOOGLE_AUTH_ENABLED:
+            raise ValueError(AUTH_ERROR_MESSAGE)
+        return Credentials(
+            token=self.access_token,
+            refresh_token=self.refresh_token,
+            scopes=self.scope,
+            # Google expects naive date in the request
+            expiry=self.naive_expires_at,
+            token_uri=settings.GOOGLE_AUTH_TOKEN_URI,
+            client_id=settings.GOOGLE_AUTH_CLIENT_ID,
+            client_secret=settings.GOOGLE_AUTH_CLIENT_SECRET,
+        )
+
     @property
     def is_token_expired(self):
         """Check if the access token is expired."""
         return self.expires_at is None or self.expires_at <= timezone.now() + timezone.timedelta(
             seconds=60
         )
 
+    @property
+    def naive_expires_at(self):
+        """Get the naive datetime of token expiry."""
+        return timezone.make_naive(self.expires_at)
+
     @staticmethod
     def refresh_access_token(auth):
         """Refresh the access token using the refresh token."""