Make the /solved command report to the hunt's channel

[turbot] / turbot / interaction.py

diff --git a/turbot/interaction.py b/turbot/interaction.py
index 180de8b923c175676ef2b0993a38256e966158b1..d2514e5d6543878b58483e582eea381db24e3313 100644 (file)
--- a/turbot/interaction.py
+++ b/turbot/interaction.py
@@ -250,12 +250,16 @@ def find_hunt_for_channel(turb, channel_id, channel_name):
     This works whether the original channel is a primary hunt channel,
     or if it is one of the channels of a puzzle belonging to the hunt.
 
-    Returns a tuple of (hunt_name, hunt_id) or (None, None)."""
+    Returns None if channel does not belong to a hunt, otherwise a
+    dictionary with all fields from the hunt's row in the table,
+    (channel_id, active_, hun_id, name, url, sheet_url, etc.).
+
+    """
 
     (hunt, _) = channel_is_hunt(turb, channel_id)
 
     if hunt:
-        return (hunt['hunt_id'], hunt['name'])
+        return hunt
 
     # So we're not a hunt channel, let's look to see if we are a
     # puzzle channel with a hunt-id prefix.
@@ -270,9 +274,9 @@ def find_hunt_for_channel(turb, channel_id, channel_name):
 
     if 'Items' in response and len(response['Items']):
         item = response['Items'][0]
-        return (item['hunt_id'], item['name'])
+        return item
 
-    return (None, None)
+    return None
 
 def puzzle(turb, body, args):
     """Implementation of the /puzzle command
@@ -284,27 +288,24 @@ def puzzle(turb, body, args):
     channel_name = body['channel_name'][0]
     trigger_id = body['trigger_id'][0]
 
-    (hunt_id, hunt_name) = find_hunt_for_channel(turb,
-                                                 channel_id,
-                                                 channel_name)
+    hunt = find_hunt_for_channel(turb,
+                                 channel_id,
+                                 channel_name)
 
-    if not hunt_id:
+    if not hunt:
         return bot_reply("Sorry, this channel doesn't appear to "
                          + "be a hunt or puzzle channel")
 
     view = {
         "type": "modal",
         "private_metadata": json.dumps({
-            "hunt_id": hunt_id,
+            "hunt_id": hunt['hunt_id'],
         }),
         "title": {"type": "plain_text", "text": "New Puzzle"},
         "submit": { "type": "plain_text", "text": "Create" },
         "blocks": [
-            section_block(text_block("*For {}*".format(hunt_name))),
+            section_block(text_block("*For {}*".format(hunt['name']))),
             input_block("Puzzle name", "name", "Name of the puzzle"),
-            input_block("Puzzle ID", "puzzle_id",
-                        "Used as part of channel name "
-                        + "(no spaces nor punctuation)"),
             input_block("Puzzle URL", "url", "External URL of puzzle",
                         optional=True)
         ]
@@ -331,14 +332,10 @@ def puzzle_submission(turb, payload, metadata):
 
     state = payload['view']['state']['values']
     name = state['name']['name']['value']
-    puzzle_id = state['puzzle_id']['puzzle_id']['value']
     url = state['url']['url']['value']
 
-    # Validate that the puzzle_id contains no invalid characters
-    if not re.match(valid_id_re, puzzle_id):
-        return submission_error("puzzle_id",
-                                "Puzzle ID can only contain lowercase letters,"
-                                + " numbers, and underscores")
+    # Create a Slack-channel-safe puzzle_id
+    puzzle_id = re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
 
     # Create a channel for the puzzle
     hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
@@ -347,9 +344,10 @@ def puzzle_submission(turb, payload, metadata):
         response = turb.slack_client.conversations_create(
             name=hunt_dash_channel)
     except SlackApiError as e:
-        return submission_error("puzzle_id",
-                                "Error creating Slack channel: {}"
-                                .format(e.response['error']))
+        return submission_error(
+            "name",
+            "Error creating Slack channel {}: {}"
+            .format(hunt_dash_channel, e.response['error']))
 
     puzzle_channel_id = response['channel']['id']
 
@@ -358,6 +356,7 @@ def puzzle_submission(turb, payload, metadata):
     table.put_item(
         Item={
             "channel_id": puzzle_channel_id,
+            "orig_channel_name": hunt_dash_channel,
             "solution": [],
             "status": 'unsolved',
             "name": name,
@@ -368,6 +367,13 @@ def puzzle_submission(turb, payload, metadata):
 
     return lambda_ok
 
+def rename_channel_to_solved(turb, puzzle):
+    orig_channel_name = puzzle['orig_channel_name']
+    channel_id = puzzle['channel_id']
+    newName = orig_channel_name + '-solved'
+    turb.slack_client.conversations_rename(channel=channel_id,
+                                           name=newName)
+
 # XXX: This duplicates functionality eith events.py:set_channel_description
 def set_channel_topic(turb, puzzle):
     channel_id = puzzle['channel_id']
@@ -380,7 +386,7 @@ def set_channel_topic(turb, puzzle):
     description = ''
 
     if status == 'solved':
-        description += "Solved: `{}` ".format('`, `'.join(puzzle['solution']))
+        description += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
 
     description += name
 
@@ -447,9 +453,24 @@ def solved(turb, body, args):
         turb.slack_client, channel_id,
         "Puzzle mark solved by {}: `{}`".format(user_name, args))
 
+    # Also report the solution to the hunt channel
+    (hunt, _) = get_table_item(turb, "hunts", "hunt_id", puzzle['hunt_id'])
+    slack_send_message(
+        turb.slack_client, hunt['channel_id'],
+        "Puzzle '<{}|{}>' has been solved!".format(
+            puzzle['channel_url'],
+            puzzle['name'])
+    )
+
     # And update the puzzle's description
     set_channel_topic(turb, puzzle)
 
+    # And rename the sheet to prefix with "SOLVED: "
+    turbot.sheets.renameSheet(turb, puzzle['sheet_url'], 'SOLVED: ' + puzzle['name'])
+
+    # Finally, rename the Slack channel to add the suffix '-solved'
+    rename_channel_to_solved(turb, puzzle)
+
     return lambda_ok
 
 commands["/solved"] = solved