1 from slack.errors import SlackApiError
2 from turbot.blocks import input_block, section_block, text_block
9 from botocore.exceptions import ClientError
13 submission_handlers = {}
15 # Hunt and Puzzle IDs are restricted to letters, numbers, and underscores
16 valid_id_re = r'^[_a-zA-Z0-9]+$'
18 def bot_reply(message):
19 """Construct a return value suitable for a bot reply
21 This is suitable as a way to give an error back to the user who
22 initiated a slash command, for example."""
29 def submission_error(field, error):
30 """Construct an error suitable for returning for an invalid submission.
32 Returning this value will prevent a submission and alert the user that
33 the given field is invalid because of the given error."""
35 print("Rejecting invalid modal submission: {}".format(error))
40 "Content-Type": "application/json"
43 "response_action": "errors",
50 def new_hunt(turb, payload):
51 """Handler for the action of user pressing the new_hunt button"""
55 "private_metadata": json.dumps({}),
56 "title": { "type": "plain_text", "text": "New Hunt" },
57 "submit": { "type": "plain_text", "text": "Create" },
59 input_block("Hunt name", "name", "Name of the hunt"),
60 input_block("Hunt ID", "hunt_id",
61 "Used as puzzle channel prefix "
62 + "(no spaces nor punctuation)"),
63 input_block("Hunt URL", "url", "External URL of hunt",
68 result = turb.slack_client.views_open(trigger_id=payload['trigger_id'],
71 submission_handlers[result['view']['id']] = new_hunt_submission
78 actions['button'] = {"new_hunt": new_hunt}
80 def new_hunt_submission(turb, payload, metadata):
81 """Handler for the user submitting the new hunt modal
83 This is the modal view presented to the user by the new_hunt
86 state = payload['view']['state']['values']
87 user_id = payload['user']['id']
88 name = state['name']['name']['value']
89 hunt_id = state['hunt_id']['hunt_id']['value']
90 url = state['url']['url']['value']
92 # Validate that the hunt_id contains no invalid characters
93 if not re.match(valid_id_re, hunt_id):
94 return submission_error("hunt_id",
95 "Hunt ID can only contain letters, "
96 + "numbers, and underscores")
98 # Check to see if the hunts table exists
99 hunts_table = turb.db.Table("hunts")
102 exists = hunts_table.table_status in ("CREATING", "UPDATING",
107 # Create the hunts table if necessary.
109 hunts_table = turb.db.create_table(
112 {'AttributeName': 'channel_id', 'KeyType': 'HASH'},
114 AttributeDefinitions=[
115 {'AttributeName': 'channel_id', 'AttributeType': 'S'},
117 ProvisionedThroughput={
118 'ReadCapacityUnits': 5,
119 'WriteCapacityUnits': 5
122 return submission_error("hunt_id",
123 "Still bootstrapping hunts table. Try again.")
125 # Create a channel for the hunt
127 response = turb.slack_client.conversations_create(name=hunt_id)
128 except SlackApiError as e:
129 return submission_error("hunt_id",
130 "Error creating Slack channel: {}"
131 .format(e.response['error']))
133 channel_id = response['channel']['id']
135 # Insert the newly-created hunt into the database
136 # (leaving it as non-active for now until the channel-created handler
137 # finishes fixing it up with a sheet and a companion table)
138 hunts_table.put_item(
140 'channel_id': channel_id,
148 # Invite the initiating user to the channel
149 turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
155 def view_submission(turb, payload):
156 """Handler for Slack interactive view submission
158 Specifically, those that have a payload type of 'view_submission'"""
160 view_id = payload['view']['id']
161 metadata = payload['view']['private_metadata']
163 if view_id in submission_handlers:
164 return submission_handlers[view_id](turb, payload, metadata)
166 print("Error: Unknown view ID: {}".format(view_id))
171 def rot(turb, body, args):
172 """Implementation of the /rot command
174 The args string should be as follows:
176 [count|*] String to be rotated
178 That is, the first word of the string is an optional number (or
179 the character '*'). If this is a number it indicates an amount to
180 rotate each character in the string. If the count is '*' or is not
181 present, then the string will be rotated through all possible 25
184 The result of the rotation is returned (with Slack formatting) in
185 the body of the response so that Slack will provide it as a reply
186 to the user who submitted the slash command."""
188 channel_name = body['channel_name'][0]
189 response_url = body['response_url'][0]
190 channel_id = body['channel_id'][0]
192 result = turbot.rot.rot(args)
194 if (channel_name == "directmessage"):
195 requests.post(response_url,
196 json = {"text": result},
197 headers = {"Content-type": "application/json"})
199 turb.slack_client.chat_postMessage(channel=channel_id, text=result)
206 commands["/rot"] = rot
208 def puzzle(turb, body, args):
209 """Implementation of the /puzzle command
211 The args string is currently ignored (this command will bring up
212 a modal dialog for user input instead)."""
214 channel_id = body['channel_id'][0]
215 trigger_id = body['trigger_id'][0]
217 hunts_table = turb.db.Table("hunts")
218 response = hunts_table.get_item(Key={'channel_id': channel_id})
220 if 'Item' in response:
221 hunt_name = response['Item']['name']
222 hunt_id = response['Item']['hunt_id']
224 return bot_reply("Sorry, this channel doesn't appear to "
225 + "be a hunt channel")
229 "private_metadata": json.dumps({
231 "hunt_channel_id": channel_id
233 "title": {"type": "plain_text", "text": "New Puzzle"},
234 "submit": { "type": "plain_text", "text": "Create" },
236 section_block(text_block("*For {}*".format(hunt_name))),
237 input_block("Puzzle name", "name", "Name of the puzzle"),
238 input_block("Puzzle ID", "puzzle_id",
239 "Used as part of channel name "
240 + "(no spaces nor punctuation)"),
241 input_block("Puzzle URL", "url", "External URL of puzzle",
246 result = turb.slack_client.views_open(trigger_id=trigger_id,
250 submission_handlers[result['view']['id']] = puzzle_submission
256 commands["/puzzle"] = puzzle
258 def puzzle_submission(turb, payload, metadata):
259 """Handler for the user submitting the new puzzle modal
261 This is the modal view presented to the user by the puzzle function
264 meta = json.loads(metadata)
265 hunt_id = meta['hunt_id']
266 hunt_channel_id = meta['hunt_channel_id']
268 state = payload['view']['state']['values']
269 name = state['name']['name']['value']
270 puzzle_id = state['puzzle_id']['puzzle_id']['value']
271 url = state['url']['url']['value']
273 # Validate that the puzzle_id contains no invalid characters
274 if not re.match(valid_id_re, puzzle_id):
275 return submission_error("puzzle_id",
276 "Puzzle ID can only contain letters, "
277 + "numbers, and underscores")
279 # Create a channel for the puzzle
280 hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
283 response = turb.slack_client.conversations_create(
284 name=hunt_dash_channel)
285 except SlackApiError as e:
286 return submission_error("puzzle_id",
287 "Error creating Slack channel: {}"
288 .format(e.response['error']))
290 puzzle_channel_id = response['channel']['id']
292 # Insert the newly-created puzzle into the database
293 table = turb.db.Table(hunt_id)
296 "channel_id": puzzle_channel_id,
298 "status": 'unsolved',
300 "puzzle_id": puzzle_id,