Use best-practice <@user_id> to mention a user in Slack

[turbot] / turbot / interaction.py

diff --git a/turbot/interaction.py b/turbot/interaction.py
index 7f93c040ce8c4a5406adecf80104ab84c8e47d27..ec64706658f3126bfc1974921d12e4cdece78ffe 100644 (file)
--- a/turbot/interaction.py
+++ b/turbot/interaction.py
@@ -13,7 +13,8 @@ from turbot.puzzle import (
     puzzle_update_channel_and_sheet,
     puzzle_id_from_name,
     puzzle_blocks,
-    puzzle_sort_key
+    puzzle_sort_key,
+    puzzle_copy
 )
 from turbot.round import round_quoted_puzzles_titles_answers
 import turbot.rot
@@ -82,6 +83,7 @@ def multi_static_select(turb, payload):
 actions['multi_static_select'] = {"*": multi_static_select}
 
 def edit(turb, body, args):
+
     """Implementation of the `/edit` command
 
     To edit the puzzle for the current channel.
@@ -880,8 +882,8 @@ def state(turb, body, args):
         return bot_reply(
             "Sorry, the /state command only works in a puzzle channel")
 
-    # Make a copy of the puzzle object
-    puzzle = old_puzzle.copy()
+    # Make a deep copy of the puzzle object
+    puzzle = puzzle_copy(old_puzzle)
 
     # Update the puzzle in the database
     puzzle['state'] = args
@@ -893,13 +895,79 @@ def state(turb, body, args):
 
 commands["/state"] = state
 
+def tag(turb, body, args):
+    """Implementation of the `/tag` command.
+
+    Arg is either a tag to add (optionally prefixed with '+'), or if
+    prefixed with '-' is a tag to remove.
+    """
+
+    if not args:
+        return bot_reply("Usage: `/tag [+]TAG_TO_ADD` "
+                         + "or `/tag -TAG_TO_REMOVE`.")
+
+    channel_id = body['channel_id'][0]
+
+    old_puzzle = puzzle_for_channel(turb, channel_id)
+
+    if not old_puzzle:
+        return bot_reply(
+            "Sorry, the /tag command only works in a puzzle channel")
+
+    if args[0] == '-':
+        tag = args[1:]
+        action = 'remove'
+    else:
+        tag = args
+        if tag[0] == '+':
+            tag = tag[1:]
+        action = 'add'
+
+    # Force tag to all uppercase
+    tag = tag.upper()
+
+    # Reject a tag that is not alphabetic or underscore A-Z_
+    if not re.match(r'^[A-Z_]*$', tag):
+        return bot_reply("Sorry, tags can only contain letters "
+                         + "and the underscore character.")
+
+    if action == 'remove':
+        if 'tags' not in old_puzzle or tag not in old_puzzle['tags']:
+            return bot_reply("Nothing to do. This puzzle is not tagged "
+                             + "with the tag: {}".format(tag))
+    else:
+        if 'tags' in old_puzzle and tag in old_puzzle['tags']:
+            return bot_reply("Nothing to do. This puzzle is already tagged "
+                             + "with the tag: {}".format(tag))
+
+    # OK. Error checking is done. Let's get to work
+
+    # Make a deep copy of the puzzle object
+    puzzle = puzzle_copy(old_puzzle)
+
+    if action == 'remove':
+        puzzle['tags'] = [t for t in puzzle['tags'] if t != tag]
+    else:
+        if 'tags' not in puzzle:
+            puzzle['tags'] = [tag]
+        else:
+            puzzle['tags'].append(tag)
+
+    turb.table.put_item(Item=puzzle)
+
+    puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
+
+    return lambda_ok
+
+commands["/tag"] = tag
+
 def solved(turb, body, args):
     """Implementation of the /solved command
 
     The args string should be a confirmed solution."""
 
     channel_id = body['channel_id'][0]
-    user_name = body['user_name'][0]
+    user_id = body['user_id'][0]
 
     old_puzzle = puzzle_for_channel(turb, channel_id)
 
@@ -910,8 +978,8 @@ def solved(turb, body, args):
         return bot_reply(
             "Error, no solution provided. Usage: `/solved SOLUTION HERE`")
 
-    # Make a copy of the puzzle object
-    puzzle = old_puzzle.copy()
+    # Make a deep copy of the puzzle object
+    puzzle = puzzle_copy(old_puzzle)
 
     # Set the status and solution fields in the database
     puzzle['status'] = 'solved'
@@ -923,7 +991,7 @@ def solved(turb, body, args):
     # Report the solution to the puzzle's channel
     slack_send_message(
         turb.slack_client, channel_id,
-        "Puzzle mark solved by {}: `{}`".format(user_name, args))
+        "Puzzle mark solved by <@{}>: `{}`".format(user_id, args))
 
     # Also report the solution to the hunt channel
     hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
@@ -956,9 +1024,10 @@ def hunt(turb, body, args):
     character in a term). All terms must match on a puzzle in order
     for that puzzle to be included. But a puzzle will be considered to
     match if any of the puzzle title, round title, puzzle URL, puzzle
-    state, or puzzle solution match. Matching will be performed
-    without regard to case sensitivity and the search terms can
-    include regular expression syntax.
+    state, puzzle type, tags, or puzzle solution match. Matching will
+    be performed without regard to case sensitivity and the search
+    terms can include regular expression syntax.
+
     """
 
     channel_id = body['channel_id'][0]