Unify code to rename channel, set channel description, and rename sheet

[turbot] / turbot / puzzle.py

diff --git a/turbot/puzzle.py b/turbot/puzzle.py
index 3c85df487f7298a42370f13bc5e91d1553dbb1e5..1a36bfb9be433460d850672733c4bfed92d6728e 100644 (file)
--- a/turbot/puzzle.py
+++ b/turbot/puzzle.py
@@ -3,8 +3,28 @@ from turbot.blocks import (
 )
 from turbot.channel import channel_url
 from boto3.dynamodb.conditions import Key
+import turbot.sheets
 import re
 
+def find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id):
+    """Given a hunt_id and puzzle_id, return that puzzle
+
+    Returns None if no puzzle with the given hunt_id and puzzle_id
+    exists in the database, otherwise a dictionary with all fields
+    from the puzzle's row in the database.
+    """
+
+    response = turb.table.get_item(
+        Key={
+            'hunt_id': hunt_id,
+            'SK': 'puzzle-{}'.format(puzzle_id)
+        })
+
+    if 'Item' in response:
+        return response['Item']
+    else:
+        return None
+
 def find_puzzle_for_url(turb, hunt_id, url):
     """Given a hunt_id and URL, return the puzzle with that URL
 
@@ -69,10 +89,15 @@ def puzzle_blocks(puzzle):
         ', '.join(links), state_str
     )
 
+    # Combining hunt ID and puzzle ID together here is safe because
+    # both IDs are restricted to not contain a hyphen, (see
+    # valid_id_re in interaction.py)
+    hunt_and_puzzle = "{}-{}".format(puzzle['hunt_id'], puzzle['puzzle_id'])
+
     return [
         accessory_block(
             section_block(text_block(puzzle_text)),
-            button_block("✏", puzzle['puzzle_id'])
+            button_block("✏", "edit_puzzle", hunt_and_puzzle)
         )
     ]
 
@@ -124,3 +149,66 @@ def puzzle_matches_all(puzzle, patterns):
             return False
 
     return True
+
+def puzzle_id_from_name(name):
+    return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
+
+def puzzle_update_channel_and_sheet(turb, puzzle):
+
+    channel_id = puzzle['channel_id']
+    name = puzzle['name']
+    url = puzzle.get('url', None)
+    sheet_url = puzzle.get('sheet_url', None)
+    state = puzzle.get('state', None)
+    status = puzzle['status']
+
+    topic = ''
+
+    if status == 'solved':
+        topic += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
+
+    topic += name
+
+    links = []
+    if url:
+        links.append("<{}|Puzzle>".format(url))
+    if sheet_url:
+        links.append("<{}|Sheet>".format(sheet_url))
+
+    if len(links):
+        topic += "({})".format(', '.join(links))
+
+    if state:
+        topic += " {}".format(state)
+
+    # Slack only allows 250 characters for a topic
+    if len(topic) > 250:
+        topic = topic[:247] + "..."
+
+    turb.slack_client.conversations_setTopic(channel=channel_id,
+                                             topic=topic)
+
+    # Rename the sheet to include indication of solved/solution status
+    sheet_name = puzzle['name']
+    if puzzle['status'] == 'solved':
+        sheet_name += " - Solved {}".format(", ".join(puzzle['solution']))
+
+    turbot.sheets.renameSheet(turb, puzzle['sheet_url'], sheet_name)
+
+    # Finally, rename the Slack channel to reflect the latest name and
+    # the solved status
+    #
+    # Note: We don't use puzzle['hunt_id'] here because we're keeping
+    # that as a persistent identifier in the database. Instead we
+    # create a new ID-like identifier from the current name.
+    channel_name = "{}-{}".format(
+        puzzle['hunt_id'],
+        puzzle_id_from_name(puzzle['name'])
+    )
+    if puzzle['status'] == 'solved':
+        channel_name += "-solved"
+
+    turb.slack_client.conversations_rename(
+        channel=puzzle['channel_id'],
+        name=channel_name
+    )