Merge pull request #71 from PortableProgrammer/dev

Better Slack Huddle/Call/custom status handling, linting

Author: PortableProgrammer

README.md

@@ -61,7 +61,7 @@ services:
       - "SLACK_CUSTOM_AVAILABLE_STATUS=''"
       - "SLACK_CUSTOM_SCHEDULED_STATUS=':spiral_calendar_pad: In a meeting'"
       - "SLACK_CUSTOM_BUSY_STATUS=':headphones: In a huddle',':slack_call:',':no_entry_sign: Do not disturb'"
-      - "SLACK_CUSTOM_OFF_STATUS=':no_entry: Out of office',':airplane:'"
+      - "SLACK_CUSTOM_OFF_STATUS=':no_entry: Out of office',':airplane:',':palm_tree: Vacationing'"
       - "ACTIVE_DAYS=Monday,Tuesday,Wednesday,Thursday,Friday"
       - "ACTIVE_HOURS_START=08:00:00"
       - "ACTIVE_HOURS_END=17:00:00"
@@ -234,26 +234,26 @@ While Slack only offers the `active` and `inactive` presence flags, it also offe
 These options accept a list of strings that should match the beginning of the Slack custom status.
 Take the following scenario:
 ```python
-SLACK_BUSY_STATUS = [':headphones: In a huddle', ':no_entry_sign: Do not disturb']
+SLACK_BUSY_STATUS = [':no_entry_sign: Do Not Disturb']
 BUSY_STATUS = [CALL, DONOTDISTURB, MEETING, PRESENTING, PENDING]
 AVAILABLE_STATUS = ACTIVE
 slack.Presence = ACTIVE
 slack.CustomStatus = ':no_entry_sign: Do not disturb, I need to finish project X today!'
 ```
-In the example above, the Slack custom status would match, and therefore take precedence over the Slack presence, causing Status-Light to treat Slack as `BUSY` instead of `AVAILABLE`.
+In the example above, the Slack custom status would match (since it is a case-insensitive comparison), and therefore take precedence over the Slack presence, causing Status-Light to treat Slack as `BUSY` instead of `AVAILABLE`.
 
 #### `SLACK_CUSTOM_AVAILABLE_STATUS`
-- *Optional*
+- *Optional*, case-insensitive
 - Default value: `''`
 - Slack's `active` presence lines up nicely with the default [`AVAILABLE_STATUS`](#availablestatus), so there is no default custom override for this option.
 
 #### `SLACK_CUSTOM_SCHEDULED_STATUS`
-- *Optional*
+- *Optional*, case-insensitive
 - Default value: `':spiral_calendar_pad: In a meeting'`
 - If you have a calendaring source configured in Slack but not in Status-Light, this default [`SCHEDULED_STATUS`](#scheduledstatus) is an easy way to obtain both collaboration and calendar status from a single source. If you also have the same calendaring source configured in Status-Light, this will duplicate it, assuming that they're fully in sync.
 
 #### `SLACK_CUSTOM_BUSY_STATUS`
-- *Optional*
+- *Optional*, case-insensitive
 - Default value: `':headphones: In a huddle',':slack_call:',':no_entry_sign: Do not disturb'`
 - This custom status allows Status-Light to recognize Slack A/V collaboration modes, like [Huddles](https://slack.com/help/articles/4402059015315-Use-huddles-in-Slack) and [Calls](https://slack.com/help/articles/216771908-Make-calls-in-Slack).
 
@@ -262,8 +262,8 @@ In the example above, the Slack custom status would match, and therefore take pr
 **Note 2:** Slack, by default, will not automatically change your custom status when you join a Call or Huddle, if you already have one set. In this instance, Status-Light will react to your existing custom status and other Source statuses.
 
 #### `SLACK_CUSTOM_OFF_STATUS`
-- *Optional*
-- Default value: `':no_entry: Out of office',':airplane:'`
+- *Optional*, case-insensitive
+- Default value: `':no_entry: Out of office',':airplane:',':palm_tree: vacationing'`
 - If you have a calendaring source configured in Slack but not in Status-Light, this default [`OFF_STATUS`](#offstatus) is an easy way to obtain both collaboration and calendar status from a single source. If you also have the same calendaring source configured in Status-Light, this will duplicate it, assuming that they're fully in sync.
 
 ---

status-light/sources/collaboration/slack.py

@@ -81,24 +81,40 @@ def _parse_custom_status(self, client:WebClient,  default:enum.Status = enum.Sta
         try:
             # Get the latest user info
             user_info = self.get_user_info(client)
+
+            if not user_info['profile']:
+                return enum.Status.UNKNOWN
+
             # Join the emoji and text with a space
-            custom_status = user_info['profile']['status_emoji'] + ' ' \
-                + user_info['profile']['status_text']
+            custom_status = (user_info['profile']['status_emoji'] + ' ' \
+                + user_info['profile']['status_text']).casefold()
 
             # For each of the Slack custom statuses, check them in reverse precedence order
             # Off, Available, Scheduled, Busy
             if self.custom_off_status and custom_status.startswith(tuple(self.custom_off_status)):
                 return_value = self.custom_off_status_map
 
-            if self.custom_available_status and custom_status.startswith(tuple(self.custom_available_status)):
+            if self.custom_available_status and \
+                custom_status.startswith(tuple(self.custom_available_status)):
+
                 return_value = self.custom_available_status_map
 
-            if self.custom_scheduled_status and custom_status.startswith(tuple(self.custom_scheduled_status)):
+            if self.custom_scheduled_status and \
+                custom_status.startswith(tuple(self.custom_scheduled_status)):
+
                 return_value = self.custom_scheduled_status_map
 
-            if self.custom_busy_status and custom_status.startswith(tuple(self.custom_busy_status)):
+            if self.custom_busy_status and \
+                custom_status.startswith(tuple(self.custom_busy_status)):
+
                 return_value = self.custom_busy_status_map
 
+            # Check for Huddle and Call
+            if user_info['profile']['huddle_state'] == 'in_a_huddle' or \
+                user_info['profile']['status_emoji'] == ':slack_call:':
+
+                return_value = enum.Status.CALL
+
             return return_value
         except (SystemExit, KeyboardInterrupt):
             pass

status-light/utility/env.py

@@ -31,10 +31,10 @@ class Environment:
     slack_user_id = None
     slack_bot_token = None
     # 66 - Add Slack custom status support
-    slack_off_status = [':no_entry: Out of office',':airplane:']
+    slack_off_status = [':no_entry: Out of Office',':airplane:',':palm_tree: Vacationing']
     slack_available_status = None
     slack_scheduled_status = ':spiral_calendar_pad: In a meeting'
-    slack_busy_status = [':headphones: In a huddle',':slack_call:',':no_entry_sign: Do not disturb']
+    slack_busy_status = [':no_entry_sign: Do not Disturb']
 
     office_app_id = None
     office_app_secret = None
@@ -117,13 +117,13 @@ def get_slack(self):
         # NOTE: Since these are all optional, and at least one defaults to None,
         # they should not be checked in the return statement
         self.slack_available_status = util.parse_str_array(os.environ.get('SLACK_AVAILABLE_STATUS'),
-            default=self.slack_available_status)
+            default=self.slack_available_status, casefold=True)
         self.slack_busy_status = util.parse_str_array(os.environ.get('SLACK_BUSY_STATUS'),
-            self.slack_busy_status)
+            self.slack_busy_status, casefold=True)
         self.slack_off_status = util.parse_str_array(os.environ.get('SLACK_OFF_STATUS'),
-            self.slack_off_status)
+            self.slack_off_status, casefold=True)
         self.slack_scheduled_status = util.parse_str_array(os.environ.get('SLACK_SCHEDULED_STATUS'),
-            self.slack_scheduled_status)
+            self.slack_scheduled_status, casefold=True)
         return (None not in [self.slack_user_id, self.slack_bot_token])
 
     def get_office(self):

status-light/utility/util.py

@@ -111,19 +111,32 @@ def parse_enum(value_string, value_enum:Enum, description, default, value_is_lis
     return temp_value
 
 # 66 - Support Slack custom statuses
-def parse_str_array(value_string, default, delimiter:str = ','):
-    """Given a string containing an array of strings, attempts to parse the string into an array"""
+def parse_str_array(value_string, default, delimiter:str = ',', casefold:bool = False):
+    """Given a string containing an array of strings, attempts to parse the string into an array.
+    Pass casefold=True to build an array ready for case-insensitive comparison."""
     temp_value = default
     if value_string in [None, '']:
         value_string = temp_value
 
     try:
+        # If we were passed None, and the default is None, just return None
+        if not value_string:
+            return None
+
         # Ensure that we return a true list, since the incoming string
         # might have a single element only.
-        if value_string and not isinstance(value_string, list):
+        if not isinstance(value_string, list):
             temp_value = []
             for value in value_string.split(delimiter):
+                if casefold:
+                    value = value.casefold()
                 temp_value.append(value)
+        else:
+            if casefold:
+                temp_value = []
+                for value in value_string:
+                    temp_value.append(value.casefold())
+
     except BaseException as ex: # pylint: disable=broad-except
         logger.warning('Exception while parsing a string array: %s', ex)
         temp_value = default