Feat: Adding more details to the reminder messages generated.

Author: theofficialvedantjoshi

zulip/integrations/google/google-calendar

@@ -9,7 +9,7 @@ import logging
 import os
 import sys
 import time
-from typing import List, Optional, Set, Tuple
+from typing import List, Optional, Set, Tuple, TypedDict
 
 import dateutil.parser
 import pytz
@@ -28,8 +28,22 @@ CLIENT_SECRET_FILE = "client_secret.json"  # noqa: S105
 APPLICATION_NAME = "Zulip"
 HOME_DIR = os.path.expanduser("~")
 
+
+class Event(TypedDict):
+    id: int
+    start: datetime.datetime
+    end: datetime.datetime
+    summary: str
+    html_link: str
+    status: str
+    location: str
+    description: str
+    organizer: str
+    hangout_link: str
+
+
 # Our cached view of the calendar, updated periodically.
-events: List[Tuple[int, datetime.datetime, str]] = []
+events: List[Event] = []
 
 # Unique keys for events we've already sent, so we don't remind twice.
 sent: Set[Tuple[int, datetime.datetime]] = set()
@@ -123,63 +137,108 @@ def populate_events() -> Optional[None]:
         )
         .execute()
     )
-
     events.clear()
     for event in feed["items"]:
         try:
             start = dateutil.parser.parse(event["start"]["dateTime"])
+            end = dateutil.parser.parse(event["end"]["dateTime"])
             # According to the API documentation, a time zone offset is required
             # for start.dateTime unless a time zone is explicitly specified in
             # start.timeZone.
-            if start.tzinfo is None:
+            if start.tzinfo is None or end.tzinfo is None:
                 event_timezone = pytz.timezone(event["start"]["timeZone"])
                 # pytz timezones include an extra localize method that's not part
                 # of the tzinfo base class.
                 start = event_timezone.localize(start)
+                end = event_timezone.localize(end)
         except KeyError:
             # All-day events can have only a date.
             start_naive = dateutil.parser.parse(event["start"]["date"])
-
+            end_naive = dateutil.parser.parse(event["end"]["date"])
             # All-day events don't have a time zone offset; instead, we use the
             # time zone of the calendar.
             calendar_timezone = pytz.timezone(feed["timeZone"])
             # pytz timezones include an extra localize method that's not part
             # of the tzinfo base class.
             start = calendar_timezone.localize(start_naive)
+            end = calendar_timezone.localize(end_naive)
+        id = event["id"]
+        summary = event.get("summary", "(No Title)")
+        html_link = event["htmlLink"]
+        status = event.get("status", "confirmed")
+        location = event.get("location", "")
+        description = event.get("description", "")
+        organizer = (
+            ""
+            if (event["organizer"]["email"] == options.zulip_email or event["organizer"]["self"])
+            else event["organizer"]["displayName"]
+        )
+        hangout_link = event.get("hangoutLink", "")
+        events.append(
+            {
+                "id": id,
+                "start": start,
+                "end": end,
+                "summary": summary,
+                "html_link": html_link,
+                "status": status,
+                "location": location,
+                "description": description,
+                "organizer": organizer,
+                "hangout_link": hangout_link,
+            }
+        )
 
-        try:
-            events.append((event["id"], start, event["summary"]))
-        except KeyError:
-            events.append((event["id"], start, "(No Title)"))
+
+def event_to_message(event: Event) -> str:
+    """Parse the event dictionary and return a string that can be sent as a message.
+
+    The message includes the event title, start and end times, location, organizer, hangout link, and description.
+
+    Returns:
+        str: The message to be sent.
+    """
+    line = f"**[{event['summary']}]({event['html_link']})**\n"
+    if event["start"].hour == 0 and event["start"].minute == 0:
+        line += "Scheduled for today.\n"
+    else:
+        line += f"Scheduled from **{event['start'].strftime('%H:%M')}** to **{event['end'].strftime('%H:%M')}**.\n"
+    line += f"**Location:** {event['location']}\n" if event["location"] else ""
+    line += f"**Organizer:** {event['organizer']}\n" if event["organizer"] else ""
+    line += (
+        f"**Hangout Link:** [{event['hangout_link'].split('/')[2]}]({event['hangout_link']})\n"
+        if event["hangout_link"]
+        else ""
+    )
+    line += f"**Description:** {event['description']}\n" if event["description"] else ""
+    return line
 
 
 def send_reminders() -> Optional[None]:
     messages = []
     keys = set()
     now = datetime.datetime.now(tz=pytz.utc)
 
-    for id, start, summary in events:
-        dt = start - now
+    for event in events:
+        dt = event["start"] - now
         if dt.days == 0 and dt.seconds < 60 * options.interval:
             # The unique key includes the start time, because of
             # repeating events.
-            key = (id, start)
+            key = (event["id"], event["start"])
             if key not in sent:
-                if start.hour == 0 and start.minute == 0:
-                    line = f"{summary} is today."
-                else:
-                    line = "{} starts at {}".format(summary, start.strftime("%H:%M"))
+                line = event_to_message(event)
                 print("Sending reminder:", line)
                 messages.append(line)
                 keys.add(key)
-
     if not messages:
         return
 
     if len(messages) == 1:
-        message = "Reminder: " + messages[0]
+        message = "**Reminder:**\n\n " + messages[0]
     else:
-        message = "Reminder:\n\n" + "\n".join("* " + m for m in messages)
+        message = "**Reminders:**\n\n" + "\n".join(
+            str(i + 1) + ". " + m for i, m in enumerate(messages)
+        )
 
     zulip_client.send_message(dict(type="private", to=options.zulip_email, content=message))