1 from turbot.blocks import (
2 section_block, text_block, button_block, actions_block, divider_block
4 from turbot.sheets import sheets_create, sheets_create_for_puzzle
5 from turbot.slack import slack_send_message, slack_channel_members
6 from turbot.hunt import find_hunt_for_hunt_id
7 from boto3.dynamodb.conditions import Key
9 TURBOT_USER_ID = 'U01B9QM4P9R'
13 lambda_success = {'statusCode': 200}
14 lambda_error = {'statusCode': 400}
16 def channel_url(channel_id):
17 return "https://halibutthatbass.slack.com/archives/{}".format(channel_id)
19 def puzzle_block(puzzle):
21 status = puzzle['status']
22 solution = puzzle['solution']
23 channel_id = puzzle['channel_id']
24 url = puzzle.get('url', None)
25 sheet_url = puzzle.get('sheet_url', None)
26 state = puzzle.get('state', None)
30 if status == 'solved':
31 status_emoji = ":ballot_box_with_check:"
33 status_emoji = ":white_square:"
36 solution_str = "*`" + '`, `'.join(solution) + "`*"
40 links.append("<{}|Puzzle>".format(url))
42 links.append("<{}|Sheet>".format(sheet_url))
46 state_str = "\n{}".format(state)
48 puzzle_text = "{}{} <{}|{}> ({}){}".format(
49 status_emoji, solution_str,
50 channel_url(channel_id), name,
51 ', '.join(links), state_str
54 return section_block(text_block(puzzle_text))
56 def hunt_details_block(turb, hunt):
58 hunt_id = hunt['hunt_id']
59 channel_id = hunt['channel_id']
61 response = turb.table.query(
62 KeyConditionExpression=(
63 Key('hunt_id').eq(hunt_id) &
64 Key('SK').begins_with('puzzle-')
67 puzzles = response['Items']
69 hunt_text = "*<{}|{}>*".format(channel_url(channel_id), name)
72 section_block(text_block(hunt_text)),
73 *[puzzle_block(puzzle) for puzzle in puzzles],
77 def available_hunt_block(turb, hunt):
80 channel_id = hunt['channel_id']
82 hunt_link = "*<{}|{}>*".format(channel_url(channel_id), name)
85 section_block(text_block(hunt_link)),
88 def home(turb, user_id):
89 """Returns a view to be published as the turbot home tab for user_id
91 The return value is a dictionary suitable to be published to the
92 Slack views_publish API."""
94 # Behave cleanly if there is no "turbot" table at all yet.
96 response = turb.table.scan(
97 IndexName="is_hunt_index",
99 hunts = response['Items']
104 available_hunt_blocks = []
106 if not hunt['active']:
108 if user_id in slack_channel_members(turb.slack_client,
110 my_hunt_blocks += hunt_details_block(turb, hunt)
112 available_hunt_blocks += available_hunt_block(turb, hunt)
114 if len(my_hunt_blocks):
116 section_block(text_block("*Hunts you belong to:*")),
122 section_block(text_block("You do not belong to any hunts"))
125 if len(available_hunt_blocks):
126 available_hunt_blocks = [
127 section_block(text_block("*Hunts you can join:*")),
129 * available_hunt_blocks
136 * available_hunt_blocks,
137 actions_block(button_block("New hunt", "new_hunt"))
141 def app_home_opened(turb, event):
142 """Handler for the app_home_opened event
144 This event occurs when a user visits the home tab for the turbot app.
145 In response to this event we need to publish a view for the user."""
147 user_id = event['user']
148 view = home(turb, user_id)
149 turb.slack_client.views_publish(user_id=user_id, view=view)
150 return lambda_success
152 events['app_home_opened'] = app_home_opened
154 def hunt_channel_created(turb, channel_name, channel_id):
155 """Creates a Google sheet for a newly-created hunt channel"""
157 # First see if we can find an entry for this hunt in the database.
158 # If not, simply return an error and let Slack retry
159 response = turb.table.query(
160 IndexName='channel_id_index',
161 KeyConditionExpression=Key("channel_id").eq(channel_id)
163 if 'Items' not in response:
164 print("Warning: Cannot find channel_id {} in turbot table. "
165 .format(channel_id) + "Letting Slack retry this event")
168 item = response['Items'][0]
170 if 'sheet_url' in item:
171 print("Info: channel_id {} already has sheet_url {}. Exiting."
172 .format(channel_id, item['sheet_url']))
173 return lambda_success
175 # Before launching into sheet creation, indicate that we're doing this
176 # in the database. This way, if we take too long to create the sheet
177 # and Slack retries the event, that next event will see this 'pending'
178 # string and cleanly return (eliminating all future retries).
179 item['sheet_url'] = 'pending'
180 turb.table.put_item(Item=item)
182 # Also, let the channel users know what we are up to
184 turb.slack_client, channel_id,
185 "Welcome to the channel for the {} hunt! ".format(item['name'])
186 + "Please wait a minute or two while I create some backend resources.")
188 # Create a sheet for the hunt
189 sheet = sheets_create(turb, item['name'])
191 # Update the database with the URL of the sheet
192 item['sheet_url'] = sheet['url']
193 turb.table.put_item(Item=item)
195 # Message the channel with the URL of the sheet
196 slack_send_message(turb.slack_client, channel_id,
197 "Sheet created for this hunt: {}".format(sheet['url']))
199 # Mark the hunt as active in the database
200 item['active'] = True
201 turb.table.put_item(Item=item)
203 # Message the hunt channel that the database is ready
205 turb.slack_client, channel_id,
206 "Thank you for waiting. This hunt is now ready to begin! "
207 + "Use `/puzzle` to create puzzles for the hunt.")
209 return lambda_success
211 def set_channel_description(turb, puzzle):
212 channel_id = puzzle['channel_id']
213 description = puzzle['name']
214 url = puzzle.get('url', None)
215 sheet_url = puzzle.get('sheet_url', None)
219 links.append("<{}|Puzzle>".format(url))
221 links.append("<{}|Sheet>".format(sheet_url))
224 description += "({})".format(', '.join(links))
226 turb.slack_client.conversations_setPurpose(channel=channel_id,
228 turb.slack_client.conversations_setTopic(channel=channel_id,
231 def puzzle_channel_created(turb, channel_name, channel_id):
232 """Creates sheet and invites user for a newly-created puzzle channel"""
234 # First see if we can find an entry for this puzzle in the database.
235 # If not, simply return an error and let Slack retry
236 response = turb.table.query(
237 IndexName="channel_id_index",
238 KeyConditionExpression=Key("channel_id").eq(channel_id),
240 if 'Items' not in response:
241 print("Warning: Cannot find channel_id {} in turbot table. "
242 .format(channel_id) + "Letting Slack retry this event")
245 puzzle = response['Items'][0]
247 if 'sheet_url' in puzzle:
248 print("Info: channel_id {} already has sheet_url {}. Exiting."
249 .format(channel_id, puzzle['sheet_url']))
250 return lambda_success
252 # Before launching into sheet creation, indicate that we're doing this
253 # in the database. This way, if we take too long to create the sheet
254 # and Slack retries the event, that next event will see this 'pending'
255 # string and cleanly return (eliminating all future retries).
256 puzzle['sheet_url'] = 'pending'
257 puzzle['channel_url'] = channel_url(channel_id)
258 turb.table.put_item(Item=puzzle)
260 # Create a sheet for the puzzle
261 sheet = sheets_create_for_puzzle(turb, puzzle)
263 # Update the database with the URL of the sheet
264 puzzle['sheet_url'] = sheet['url']
265 turb.table.put_item(Item=puzzle)
267 # Get the new sheet_url into the channel description
268 set_channel_description(turb, puzzle)
270 # And finally, give a welcome message with some documentation
271 # on how to update the state of the puzzle in the database.
273 "Welcome! This channel is the primary place to "
274 + "discuss things as the team works together to solve the "
275 + "puzzle '{}'. ".format(puzzle['name'])
280 "See the <{}|puzzle itself> ".format(puzzle['url'])
281 + "for what was originally presented to us."
285 "Actual puzzle solving work will take place within the following "
286 + "<{}|shared spreadsheet> ".format(puzzle['sheet_url'])
290 "Whenever the status of the puzzle progress changes "
291 + "significantly, please type `/state` with a brief message "
292 + "explaining where things stand. This could be something "
293 + "like `/state Grid is filled. Need insight for extraction.` "
294 + "or `/state Nathan has printed this and is cutting/assembling`. "
295 + "It's especially important to put information in `/state` "
296 + "when you step away from a puzzle so the next team members "
297 + "to arrive will know what is going on."
301 "When a puzzle has been solved, submitted, and the solution is "
302 + "confirmed, please type `/solved THE PUZZLE ANSWER HERE`. All "
303 + "information given in `/state` and `/solved` will be presented "
304 + "in this channel's topic as well as in the hunt overview "
305 + "(which is available by selecting \"Turbot\" from the Slack "
306 + "list of members)."
309 turb.slack_client.chat_postMessage(
311 text="New puzzle: {}".format(['name']),
313 section_block(text_block(welcome_msg)),
314 section_block(text_block(sheet_msg)),
315 section_block(text_block(state_msg)),
316 section_block(text_block(solved_msg))
319 # Finally, finally, notify the hunt channel about the new puzzle
320 hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
322 turb.slack_client, hunt['channel_id'],
323 "New puzzle available: <{}|{}>".format(
324 puzzle['channel_url'],
328 return lambda_success
330 def channel_created(turb, event):
332 channel = event['channel']
333 channel_id = channel['id']
334 channel_name = channel['name']
335 creator = channel['creator']
337 # Ignore any channels that turbot didn't create
338 if creator != TURBOT_USER_ID:
339 print("channel_created: Not a turbot-created channel. Exiting.")
340 return lambda_success
342 # The presence of a hyphen determines whether this is a puzzle
343 # channel or a hunt channel.
344 if '-' in channel_name:
345 return puzzle_channel_created(turb, channel_name, channel_id)
347 return hunt_channel_created(turb, channel_name, channel_id)
349 events['channel_created'] = channel_created