Merge pull request #82 from PortableProgrammer/dev

Make calendar lookahead configurable

Author: PortableProgrammer

README.md

@@ -65,6 +65,7 @@ services:
       - "ACTIVE_DAYS=Monday,Tuesday,Wednesday,Thursday,Friday"
       - "ACTIVE_HOURS_START=08:00:00"
       - "ACTIVE_HOURS_END=17:00:00"
+      - "CALENDAR_LOOKAHEAD=5"
       - "SLEEP_SECONDS=5"
       - "LOGLEVEL=INFO"
     volumes:
@@ -158,13 +159,13 @@ If specificed, requires at least one of the available options. This will control
 #### `AVAILABLE_STATUS`
 
 - Default value: `active`
-- By default, denotes that there is no ongoing collaboration call or meeting, and no calendar meetings scheduled within the next `5` minutes.
+- By default, denotes that there is no ongoing collaboration call or meeting, and no calendar meetings scheduled within the configured [`CALENDAR_LOOKAHEAD`](#calendar_lookahead) interval.
   - This is the default *not busy* state. See [`OFF_STATUS`](#off_status) for an explanation of why the calendar `free` status is not included in this list by default, and why you may want to change that.
 
 #### `SCHEDULED_STATUS`
 
 - Default value: `busy,tentative`
-- By default, denotes that there is no ongoing collaboration call or meeting, but a calendar meeting, that was either accepted or tentatively accepted, is scheduled within the next `5` minutes.
+- By default, denotes that there is no ongoing collaboration call or meeting, but a calendar meeting, that was either accepted or tentatively accepted, is scheduled within the configured [`CALENDAR_LOOKAHEAD`](#calendar_lookahead) interval.
   - This is the default *about to be busy* state.
 
 #### `BUSY_STATUS`
@@ -183,7 +184,8 @@ If specificed, requires at least one of the available options. This will control
 - In the case of `outofoffice` and `workingelsewhere`, this is a personal preference. I don't need Status-Light to tell my family that I'm somewhere else; they can see that.
 - In the case of `free`, there are a few reasons why it's in `OFF_STATUS` by default.
   - Typically, if the user is asking for both collaboration and calendar statuses, the user will be `active` (from collaboration) and `free` (from calendar) simultaneously, so `active` will always win.
-  - Status-Light makes a  determination of `free`/`busy`/`tentative` by checking the user's availability within the next `5` minutes. There is typically no 'off-hours' status in calendaring applications, which means, at the end of the working day, the user is technically `free`. In that instance, the light would be on during off hours, showing the selected [`AVAIALBLE_COLOR`](#available_color). Again, this is a personal preference; I don't want the light on while I'm not at work, and I am using Webex to handle [`AVAILABLE_STATUS`](#available_status).
+  - Status-Light makes a determination of `free`/`busy`/`tentative` by checking the user's calendar availability within the configured [`CALENDAR_LOOKAHEAD`](#calendar_lookahead) interval. There is typically no 'off-hours' status in calendaring applications, which means, at the end of the working day, the user is technically `free`. In that instance, the light would be on during off hours, showing the selected [`AVAIALBLE_COLOR`](#available_color). Again, this is a personal preference; I don't want the light on while I'm not at work, and I am using Webex to handle [`AVAILABLE_STATUS`](#available_status).
+  - This behavior can be further refined with the [`ACTIVE_*`](#active-times) variables.
   - In the case that no collaboration sources are present in [`SOURCES`](#sources), it is recommended to move `free` to [`AVAILABLE_STATUS`](#available_status), but the caveat above will apply in that scenario: the light may stay on all the time.
 
 **Note 1:** Status-Light makes no attempt to handle invalid values in a list. In the case of an error, Status-Light will simply revert to the default value for that list.
@@ -390,6 +392,8 @@ To retrieve your `SLACK_BOT_TOKEN`, see below:
 
 ### **Office 365**
 
+**Note:** See [`CALENDAR_LOOKAHEAD`](#calendar_lookahead) to configure lookahead timing for Calendar sources.
+
 #### `O365_APPID`
 
 #### `O365_APPSECRET`
@@ -416,6 +420,8 @@ Defines a writable location on disk where the Office 365 tokens are stored. This
 
 ### **Google**
 
+**Note:** See [`CALENDAR_LOOKAHEAD`](#calendar_lookahead) to configure lookahead timing for Calendar sources.
+
 #### `GOOGLE_CREDENTIALSTORE`
 
 - *Optional, only valid if `google` is present in [`SOURCES`](#sources)*
@@ -480,6 +486,16 @@ A time, in 24-hour format, signifying the start and end of the active hours on a
 
 ---
 
+### `CALENDAR_LOOKAHEAD`
+
+- *Optional*
+- Acceptable range: `5`-`60`
+- Default value: `5`
+
+Set the number of minutes that Calendar [`SOURCES`](#sources) lookahead to determine free/busy.
+
+---
+
 ### `SLEEP_SECONDS`
 
 - *Optional*

status-light/sources/calendar/google.py

@@ -32,6 +32,9 @@ class GoogleCalendarAPI:
     credentialStore = '~'
     tokenStore = '~'
 
+    # 81 - Make calendar lookahead configurable
+    lookahead: int
+
     CREDENTIALS_FILENAME = 'client_secret.json'
 
     # If modifying these scopes, delete the file token.json.
@@ -77,17 +80,17 @@ def get_calendar_service(self):
 
     def get_current_status(self):
         """Connects to the Google Calendar API to retrieve the user's free/busy
-        status within the next 5 minutes.
+        status within the lookahead period.
 
         Returns the status returned from Google, or 'unknown' if an error occurs."""
         try:
             service = self.get_calendar_service()
             now = datetime.utcnow().isoformat() + 'Z'
-            now_plus = (datetime.utcnow() +
-                        timedelta(minutes=5)).isoformat() + 'Z'
+            now_plus_lookahead = (datetime.utcnow() +
+                        timedelta(minutes=self.lookahead)).isoformat() + 'Z'
             query = {
                 "timeMin": now,
-                "timeMax": now_plus,
+                "timeMax": now_plus_lookahead,
                 "items": [
                     {
                         "id": "primary"

status-light/sources/calendar/office365.py

@@ -27,6 +27,9 @@ class OfficeAPI:
     tokenStore = '~'
     account: Account
 
+    # 81 - Make calendar lookahead configurable
+    lookahead: int
+
     def authenticate(self):
         """Authenticates against Office 365"""
         token_backend = FileSystemTokenBackend(token_path=self.tokenStore,
@@ -47,19 +50,22 @@ def get_calendar(self):
         return self.account.schedule().get_default_calendar()
 
     def get_current_status(self):
-        """Retrieves the Office 365 status within the next 5 minutes"""
+        """Retrieves the Office 365 status within the lookahead period"""
         try:
             schedule = self.get_schedule()
             schedules = [self.account.get_current_user().mail]  # type: ignore
             availability = schedule.get_availability(schedules, datetime.now(),
-                                                     datetime.now() + timedelta(minutes=5), 5)
+                                                     datetime.now() + timedelta(
+                                                            minutes=self.lookahead
+                                                        ),
+                                                     self.lookahead)
             availability_view = availability[0]["availabilityView"][0]
             logger.debug('Got availabilityView: %s', availability_view)
 
             return enum.Status[availability_view.replace(' ', '').lower()]
         except (SystemExit, KeyboardInterrupt):
             return enum.Status.UNKNOWN
-        except Exception as ex: # pylint: disable=broad-except
+        except Exception as ex:  # pylint: disable=broad-except
             logger.warning('Exception while getting Office 365 status: %s', ex)
             logger.exception(ex)
             return enum.Status.UNKNOWN

status-light/status-light.py

@@ -57,6 +57,7 @@ def init(self):
                      self.local_env.get_colors(),
                      self.local_env.get_status(),
                      self.local_env.get_active_time(),
+                     self.local_env.get_lookahead(),
                      self.local_env.get_sleep(),
                      self.local_env.get_log_level()]:
 
@@ -106,6 +107,8 @@ def init(self):
                 self.office_api.appID = self.local_env.office_app_id
                 self.office_api.appSecret = self.local_env.office_app_secret
                 self.office_api.tokenStore = self.local_env.office_token_store
+                # 81 - Make calendar lookahead configurable
+                self.office_api.lookahead = self.local_env.calendar_lookahead
                 self.office_api.authenticate()
             else:
                 logger.error(
@@ -118,6 +121,8 @@ def init(self):
                 logger.info('Requested Google')
                 self.google_api.credentialStore = self.local_env.google_credential_store
                 self.google_api.tokenStore = self.local_env.google_token_store
+                # 81 - Make calendar lookahead configurable
+                self.google_api.lookahead = self.local_env.calendar_lookahead
             else:
                 logger.error(
                     'Requested Google, but could not find all environment variables!')

status-light/utility/env.py

@@ -81,6 +81,9 @@ class Environment:
     active_hours_start: time = time(hour=0, minute=0, second=0)
     active_hours_end: time = time(hour=23, minute=59, second=59)
 
+    # 81 - Make calendar lookahead configurable
+    calendar_lookahead: int = 5
+
     # 22 - Make sleep timeout configurable
     sleep_seconds: int = 5
 
@@ -221,6 +224,13 @@ def get_active_time(self) -> bool:
         return ('' not in [self.active_days, self.active_hours_start,
                            self.active_hours_end])
 
+    def get_lookahead(self) -> bool:
+        """Retrieves and validates the `CALENDAR_LOOKAHEAD` variable."""
+        # 41: Replace decorator with utility function
+        self.calendar_lookahead = util.try_parse_int(os.environ.get('CALENDAR_LOOKAHEAD', ''),
+                                                self.calendar_lookahead)
+        return self.calendar_lookahead >= 5 and self.calendar_lookahead <= 60
+
     def get_sleep(self) -> bool:
         """Retrieves and validates the `SLEEP_SECONDS` variable."""
         # 41: Replace decorator with utility function