Add notes on how to update the Google sheets credentials

[turbot] / turbot / puzzle.py

diff --git a/turbot/puzzle.py b/turbot/puzzle.py
index a6d3ffd809b2af59e44f564e1ae78092588d7f4c..316620c085da5d8936d808f06ec0e747a8c88c26 100644 (file)
--- a/turbot/puzzle.py
+++ b/turbot/puzzle.py
@@ -223,6 +223,12 @@ def puzzle_matches_all(puzzle, patterns):
 def puzzle_id_from_name(name):
     return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
 
+def round_id_from_name(name):
+    """Normalize and abbreviate round name for use as a prefix
+       in a channel name."""
+
+    return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()[:7]
+
 def puzzle_sort_key(puzzle):
     """Return an appropriate sort key for a puzzle in the database
 
@@ -272,12 +278,43 @@ def puzzle_channel_topic(puzzle):
 
     return topic
 
+def puzzle_channel_description(puzzle):
+    """Compute the channel description for a puzzle"""
+
+    url = puzzle.get('url', None)
+    sheet_url = puzzle.get('sheet_url', None)
+    tags = puzzle.get('tags', [])
+    state = puzzle.get('state', None)
+
+    description = (
+        "Puzzle: \"{}\".\n".format(puzzle['name'])
+    )
+
+    links = ''
+    if url:
+        links += " <{}|Original puzzle> ".format(url)
+
+    if sheet_url:
+        links += " <{}|Sheet>".format(sheet_url)
+
+    if links:
+        description += "Links:{}\n".format(links)
+
+    if tags:
+        description += "Tags: {}\n".format(
+            " ".join(["`{}`".format(t) for t in tags]))
+
+    if state:
+        description += "State: {}\n".format(state)
+
+    return description
+
 def puzzle_channel_name(puzzle):
     """Compute the channel name for a puzzle"""
 
     round = ''
     if 'rounds' in puzzle:
-        round = '-' + puzzle_id_from_name(puzzle['rounds'][0])
+        round = '-' + round_id_from_name(puzzle['rounds'][0])
 
     meta = ''
     if puzzle.get('type', 'plain') == 'meta':
@@ -325,6 +362,20 @@ def puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=None):
         turb.slack_client.conversations_setTopic(channel=channel_id,
                                                  topic=channel_topic)
 
+    # Compute the channel description and set it if it has changed
+    channel_description = puzzle_channel_description(puzzle)
+
+    old_channel_description = None
+    if old_puzzle:
+        old_channel_description = puzzle_channel_description(old_puzzle)
+
+    if channel_description != old_channel_description:
+        # Slack also only allows 250 characters for a description
+        if len(channel_description) > 250:
+            channel_description = channel_description[:247] + "..."
+        turb.slack_client.conversations_setPurpose(channel=channel_id,
+                                                   purpose=channel_description)
+
     # Compute the sheet name and set it if it has changed
     sheet_name = puzzle_sheet_name(puzzle)