-import turbot.views
+from turbot.blocks import (
+ section_block, text_block, button_block, actions_block, divider_block
+)
+from turbot.sheets import sheets_create, sheets_create_for_puzzle
+from turbot.slack import slack_send_message, slack_channel_members
+from turbot.hunt import find_hunt_for_hunt_id
+from boto3.dynamodb.conditions import Key
-def app_home_opened(slack_client, body):
- user_id = body['event']['user']
- view = turbot.views.home(user_id, body)
- slack_client.views_publish(user_id=user_id, view=view)
- return "OK"
+TURBOT_USER_ID = 'U01B9QM4P9R'
-events = {
- "app_home_opened": app_home_opened
-}
+events = {}
+
+lambda_success = {'statusCode': 200}
+lambda_error = {'statusCode': 400}
+
+def channel_url(channel_id):
+ return "https://halibutthatbass.slack.com/archives/{}".format(channel_id)
+
+def puzzle_block(puzzle):
+ name = puzzle['name']
+ status = puzzle['status']
+ solution = puzzle['solution']
+ channel_id = puzzle['channel_id']
+ url = puzzle.get('url', None)
+ sheet_url = puzzle.get('sheet_url', None)
+ state = puzzle.get('state', None)
+ status_emoji = ''
+ solution_str = ''
+
+ if status == 'solved':
+ status_emoji = ":ballot_box_with_check:"
+ else:
+ status_emoji = ":white_square:"
+
+ if len(solution):
+ solution_str = "*`" + '`, `'.join(solution) + "`*"
+
+ links = []
+ if url:
+ links.append("<{}|Puzzle>".format(url))
+ if sheet_url:
+ links.append("<{}|Sheet>".format(sheet_url))
+
+ state_str = ''
+ if state:
+ state_str = "\n{}".format(state)
+
+ puzzle_text = "{}{} <{}|{}> ({}){}".format(
+ status_emoji, solution_str,
+ channel_url(channel_id), name,
+ ', '.join(links), state_str
+ )
+
+ return section_block(text_block(puzzle_text))
+
+def hunt_block(turb, hunt):
+ name = hunt['name']
+ hunt_id = hunt['hunt_id']
+ channel_id = hunt['channel_id']
+
+ response = turb.table.query(
+ KeyConditionExpression=(
+ Key('hunt_id').eq(hunt_id) &
+ Key('SK').begins_with('puzzle-')
+ )
+ )
+ puzzles = response['Items']
+
+ hunt_text = "*<{}|{}>*".format(channel_url(channel_id), name)
+
+ return [
+ section_block(text_block(hunt_text)),
+ *[puzzle_block(puzzle) for puzzle in puzzles],
+ divider_block()
+ ]
+
+def home(turb, user_id):
+ """Returns a view to be published as the turbot home tab for user_id
+
+ The return value is a dictionary suitable to be published to the
+ Slack views_publish API."""
+
+ # Behave cleanly if there is no "turbot" table at all yet.
+ try:
+ response = turb.table.scan(
+ IndexName="is_hunt_index",
+ )
+ hunts = response['Items']
+ except Exception:
+ hunts = []
+
+ hunt_blocks = []
+ for hunt in hunts:
+ if not hunt['active']:
+ continue
+ if user_id not in slack_channel_members(turb.slack_client,
+ hunt['channel_id']):
+ continue
+ hunt_blocks += hunt_block(turb, hunt)
+
+ if len(hunt_blocks):
+ hunt_blocks = [
+ section_block(text_block("*Hunts you belong to*")),
+ divider_block(),
+ * hunt_blocks
+ ]
+ else:
+ hunt_blocks = [
+ section_block(text_block("You do not belong to any hunts"))
+ ]
+
+ return {
+ "type": "home",
+ "blocks": [
+ * hunt_blocks,
+ actions_block(button_block("New hunt", "new_hunt"))
+ ]
+ }
+
+def app_home_opened(turb, event):
+ """Handler for the app_home_opened event
+
+ This event occurs when a user visits the home tab for the turbot app.
+ In response to this event we need to publish a view for the user."""
+
+ user_id = event['user']
+ view = home(turb, user_id)
+ turb.slack_client.views_publish(user_id=user_id, view=view)
+ return lambda_success
+
+events['app_home_opened'] = app_home_opened
+
+def hunt_channel_created(turb, channel_name, channel_id):
+ """Creates a Google sheet for a newly-created hunt channel"""
+
+ # First see if we can find an entry for this hunt in the database.
+ # If not, simply return an error and let Slack retry
+ response = turb.table.query(
+ IndexName='channel_id_index',
+ KeyConditionExpression=Key("channel_id").eq(channel_id)
+ )
+ if 'Items' not in response:
+ print("Warning: Cannot find channel_id {} in turbot table. "
+ .format(channel_id) + "Letting Slack retry this event")
+ return lambda_error
+
+ item = response['Items'][0]
+
+ if 'sheet_url' in item:
+ print("Info: channel_id {} already has sheet_url {}. Exiting."
+ .format(channel_id, item['sheet_url']))
+ return lambda_success
+
+ # Before launching into sheet creation, indicate that we're doing this
+ # in the database. This way, if we take too long to create the sheet
+ # and Slack retries the event, that next event will see this 'pending'
+ # string and cleanly return (eliminating all future retries).
+ item['sheet_url'] = 'pending'
+ turb.table.put_item(Item=item)
+
+ # Also, let the channel users know what we are up to
+ slack_send_message(
+ turb.slack_client, channel_id,
+ "Welcome to the channel for the {} hunt! ".format(item['name'])
+ + "Please wait a minute or two while I create some backend resources.")
+
+ # Create a sheet for the hunt
+ sheet = sheets_create(turb, item['name'])
+
+ # Update the database with the URL of the sheet
+ item['sheet_url'] = sheet['url']
+ turb.table.put_item(Item=item)
+
+ # Message the channel with the URL of the sheet
+ slack_send_message(turb.slack_client, channel_id,
+ "Sheet created for this hunt: {}".format(sheet['url']))
+
+ # Mark the hunt as active in the database
+ item['active'] = True
+ turb.table.put_item(Item=item)
+
+ # Message the hunt channel that the database is ready
+ slack_send_message(
+ turb.slack_client, channel_id,
+ "Thank you for waiting. This hunt is now ready to begin! "
+ + "Use `/puzzle` to create puzzles for the hunt.")
+
+ return lambda_success
+
+def set_channel_description(turb, puzzle):
+ channel_id = puzzle['channel_id']
+ description = puzzle['name']
+ url = puzzle.get('url', None)
+ sheet_url = puzzle.get('sheet_url', None)
+
+ links = []
+ if url:
+ links.append("<{}|Puzzle>".format(url))
+ if sheet_url:
+ links.append("<{}|Sheet>".format(sheet_url))
+
+ if len(links):
+ description += "({})".format(', '.join(links))
+
+ turb.slack_client.conversations_setPurpose(channel=channel_id,
+ purpose=description)
+ turb.slack_client.conversations_setTopic(channel=channel_id,
+ topic=description)
+
+def puzzle_channel_created(turb, channel_name, channel_id):
+ """Creates sheet and invites user for a newly-created puzzle channel"""
+
+ # First see if we can find an entry for this puzzle in the database.
+ # If not, simply return an error and let Slack retry
+ response = turb.table.query(
+ IndexName="channel_id_index",
+ KeyConditionExpression=Key("channel_id").eq(channel_id),
+ )
+ if 'Items' not in response:
+ print("Warning: Cannot find channel_id {} in turbot table. "
+ .format(channel_id) + "Letting Slack retry this event")
+ return lambda_error
+
+ puzzle = response['Items'][0]
+
+ if 'sheet_url' in puzzle:
+ print("Info: channel_id {} already has sheet_url {}. Exiting."
+ .format(channel_id, puzzle['sheet_url']))
+ return lambda_success
+
+ # Before launching into sheet creation, indicate that we're doing this
+ # in the database. This way, if we take too long to create the sheet
+ # and Slack retries the event, that next event will see this 'pending'
+ # string and cleanly return (eliminating all future retries).
+ puzzle['sheet_url'] = 'pending'
+ puzzle['channel_url'] = channel_url(channel_id)
+ turb.table.put_item(Item=puzzle)
+
+ # Create a sheet for the puzzle
+ sheet = sheets_create_for_puzzle(turb, puzzle)
+
+ # Update the database with the URL of the sheet
+ puzzle['sheet_url'] = sheet['url']
+ turb.table.put_item(Item=puzzle)
+
+ # Get the new sheet_url into the channel description
+ set_channel_description(turb, puzzle)
+
+ # And finally, give a welcome message with some documentation
+ # on how to update the state of the puzzle in the database.
+ welcome_msg = (
+ "Welcome! This channel is the primary place to "
+ + "discuss things as the team works together to solve the "
+ + "puzzle '{}'. ".format(puzzle['name'])
+ )
+
+ if 'url' in puzzle:
+ welcome_msg += (
+ "See the <{}|puzzle itself> ".format(puzzle['url'])
+ + "for what was originally presented to us."
+ )
+
+ sheet_msg = (
+ "Actual puzzle solving work will take place within the following "
+ + "<{}|shared spreadsheet> ".format(puzzle['sheet_url'])
+ )
+
+ state_msg = (
+ "Whenever the status of the puzzle progress changes "
+ + "significantly, please type `/state` with a brief message "
+ + "explaining where things stand. This could be something "
+ + "like `/state Grid is filled. Need insight for extraction.` "
+ + "or `/state Nathan has printed this and is cutting/assembling`. "
+ + "It's especially important to put information in `/state` "
+ + "when you step away from a puzzle so the next team members "
+ + "to arrive will know what is going on."
+ )
+
+ solved_msg = (
+ "When a puzzle has been solved, submitted, and the solution is "
+ + "confirmed, please type `/solved THE PUZZLE ANSWER HERE`. All "
+ + "information given in `/state` and `/solved` will be presented "
+ + "in this channel's topic as well as in the hunt overview "
+ + "(which is available by selecting \"Turbot\" from the Slack "
+ + "list of members)."
+ )
+
+ turb.slack_client.chat_postMessage(
+ channel=channel_id,
+ text="New puzzle: {}".format(['name']),
+ blocks=[
+ section_block(text_block(welcome_msg)),
+ section_block(text_block(sheet_msg)),
+ section_block(text_block(state_msg)),
+ section_block(text_block(solved_msg))
+ ])
+
+ # Finally, finally, notify the hunt channel about the new puzzle
+ hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
+ slack_send_message(
+ turb.slack_client, hunt['channel_id'],
+ "New puzzle available: <{}|{}>".format(
+ puzzle['channel_url'],
+ puzzle['name'])
+ )
+
+ return lambda_success
+
+def channel_created(turb, event):
+
+ channel = event['channel']
+ channel_id = channel['id']
+ channel_name = channel['name']
+ creator = channel['creator']
+
+ # Ignore any channels that turbot didn't create
+ if creator != TURBOT_USER_ID:
+ print("channel_created: Not a turbot-created channel. Exiting.")
+ return lambda_success
+
+ # The presence of a hyphen determines whether this is a puzzle
+ # channel or a hunt channel.
+ if '-' in channel_name:
+ return puzzle_channel_created(turb, channel_name, channel_id)
+ else:
+ return hunt_channel_created(turb, channel_name, channel_id)
+
+events['channel_created'] = channel_created
projects / turbot / blobdiff