Announce to the hunt whenever a puzzle receives a new tag

[turbot] / turbot / interaction.py

diff --git a/turbot/interaction.py b/turbot/interaction.py
index d7e8da6ff905bd086046ce499e82e47be319192a..21e741e8c19ac84776e8c36330c295876315d553 100644 (file)
--- a/turbot/interaction.py
+++ b/turbot/interaction.py
@@ -216,6 +216,10 @@ def edit_puzzle(turb, puzzle, trigger_id):
                         "New round(s) this puzzle belongs to " +
                         "(comma separated)",
                         optional=True),
+            input_block("Tag(s)", "tags",
+                        "Tags for this puzzle (comma separated)",
+                        initial_value=", ".join(puzzle.get("tags", [])),
+                        optional=True),
             input_block("State", "state",
                         "State of this puzzle (partial progress, next steps)",
                         initial_value=puzzle.get("state", None),
@@ -273,6 +277,7 @@ def edit_puzzle_submission(turb, payload, metadata):
         if rounds:
             puzzle['rounds'] = rounds
     new_rounds = state['new_rounds']['new_rounds']['value']
+    tags = state['tags']['tags']['value']
     puzzle_state = state['state']['state']['value']
     if puzzle_state:
         puzzle['state'] = puzzle_state
@@ -315,6 +320,24 @@ def edit_puzzle_submission(turb, payload, metadata):
                 }
             )
 
+    # Process any tags
+    puzzle['tags'] = []
+    if tags:
+        for tag in tags.split(','):
+            # Drop any leading/trailing spaces from the tag
+            tag = tag.strip().upper()
+            # Ignore any empty string
+            if not len(tag):
+                continue
+            # Reject a tag that is not alphabetic or underscore A-Z_
+            if not re.match(r'^[A-Z0-9_]*$', tag):
+                return submission_error(
+                    "tags",
+                    "Error: Tags can only contain letters, numbers, "
+                    + "and the underscore character."
+                )
+            puzzle['tags'].append(tag)
+
     # Get old puzzle from the database (to determine what's changed)
     old_puzzle = find_puzzle_for_sort_key(turb,
                                           puzzle['hunt_id'],
@@ -349,9 +372,20 @@ def edit_puzzle_submission(turb, payload, metadata):
         turb.slack_client, puzzle['channel_id'],
         edit_message, blocks=blocks)
 
+    # Advertize any tag additions to the hunt
+    hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
+
+    new_tags = set(puzzle['tags']) - set(old_puzzle['tags'])
+    if new_tags:
+        message = "Puzzle <{}|{}> has been tagged: {}".format(
+            puzzle['channel_url'],
+            puzzle['name'],
+            ", ".join(['`{}`'.format(t) for t in new_tags])
+        )
+        slack_send_message(turb.slack_client, hunt['channel_id'], message)
+
     # Also inform the hunt if the puzzle's solved status changed
     if puzzle['status'] != old_puzzle['status']:
-        hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
         if puzzle['status'] == 'solved':
             message = "Puzzle <{}|{}> has been solved!".format(
                 puzzle['channel_url'],
@@ -965,7 +999,10 @@ def new_puzzle(turb, body):
             input_block("New round(s)", "new_rounds",
                         "New round(s) this puzzle belongs to " +
                         "(comma separated)",
-                        optional=True)
+                        optional=True),
+            input_block("Tag(s)", "tags",
+                        "Tags for this puzzle (comma separated)",
+                        optional=True),
         ]
     }
 
@@ -1007,6 +1044,7 @@ def new_puzzle_submission(turb, payload, metadata):
     else:
         rounds = []
     new_rounds = state['new_rounds']['new_rounds']['value']
+    tags = state['tags']['tags']['value']
 
     # Create a Slack-channel-safe puzzle_id
     puzzle['puzzle_id'] = puzzle_id_from_name(puzzle['name'])
@@ -1042,6 +1080,24 @@ def new_puzzle_submission(turb, payload, metadata):
                 }
             )
 
+    # Process any tags
+    puzzle['tags'] = []
+    if tags:
+        for tag in tags.split(','):
+            # Drop any leading/trailing spaces from the tag
+            tag = tag.strip().upper()
+            # Ignore any empty string
+            if not len(tag):
+                continue
+            # Reject a tag that is not alphabetic or underscore A-Z_
+            if not re.match(r'^[A-Z0-9_]*$', tag):
+                return submission_error(
+                    "tags",
+                    "Error: Tags can only contain letters, numbers, "
+                    + "and the underscore character."
+                )
+            puzzle['tags'].append(tag)
+
     if rounds:
         puzzle['rounds'] = rounds
 
@@ -1159,6 +1215,17 @@ def tag(turb, body, args):
 
     puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
 
+    # Advertize any tag additions to the hunt
+    new_tags = set(puzzle['tags']) - set(old_puzzle['tags'])
+    if new_tags:
+        hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
+        message = "Puzzle <{}|{}> has been tagged: {}".format(
+            puzzle['channel_url'],
+            puzzle['name'],
+            ", ".join(['`{}`'.format(t) for t in new_tags])
+        )
+        slack_send_message(turb.slack_client, hunt['channel_id'], message)
+
     return lambda_ok
 
 commands["/tag"] = tag