from turbot.blocks import (
- section_block, text_block, button_block, actions_block
+ section_block, text_block, button_block, actions_block, divider_block
)
-import turbot.sheets
import turbot.slack
+from turbot.sheets import sheets_create, sheets_create_for_puzzle
+from turbot.slack import slack_send_message, slack_channel_members
+from boto3.dynamodb.conditions import Key
TURBOT_USER_ID = 'U01B9QM4P9R'
lambda_success = {'statusCode': 200}
lambda_error = {'statusCode': 400}
-def hunt_block(hunt):
+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']
- text = "{}: ".format(name)
+ response = turb.db.Table(hunt_id).scan()
+ puzzles = response['Items']
- if (channel_id.startswith("placeholder-")):
- text += "[Slack channel is still being created. Please wait.]"
- else:
- text += "<#{}>".format(channel_id)
+ hunt_text = "*<{}|{}>*".format(channel_url(channel_id), name)
- return section_block(text_block(text))
+ 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 not hunts table at all yet.
+ # Behave cleanly if there is no "turbot" table at all yet.
try:
- response = turb.db.Table("hunts").scan()
+ response = turb.table.scan()
hunts = response['Items']
- except:
+ 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)
+
return {
"type": "home",
"blocks": [
- section_block(text_block("*Active hunts*")),
- *[hunt_block(hunt) for hunt in hunts if hunt['active']],
+ section_block(text_block("*Hunts you belong to*")),
+ divider_block(),
+ * hunt_blocks,
actions_block(button_block("New hunt", "new_hunt"))
]
}
events['app_home_opened'] = app_home_opened
def hunt_channel_created(turb, channel_name, channel_id):
- """Creates sheet and a DynamoDB table for a newly-created hunt channel"""
+ """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
- hunts_table = turb.db.Table("hunts")
- response = hunts_table.get_item(
- Key={'channel_id': channel_id},
- ConsistentRead=True
+ response = turb.table.query(
+ IndexName='channel_id_index',
+ KeyConditionExpression=Key("channel_id").eq(channel_id)
)
- if 'Item' not in response:
+ if 'Items' not in response:
print("Warning: Cannot find channel_id {} in hunts table. "
.format(channel_id) + "Letting Slack retry this event")
return lambda_error
- item = response['Item']
+ 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
- # Remove any None items from our item before updating
- if not item['url']:
- del item['url']
-
# 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'
- hunts_table.put_item(Item=item)
+ turb.table.put_item(Item=item)
# Also, let the channel users know what we are up to
- turb.slack_client.chat_postMessage(
- channel=channel_id,
- text="Welcome to the channel for the {} hunt! ".format(item['name'])
+ 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 channel
- sheet = turbot.sheets.sheets_create(turb, channel_name)
+ # 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']
- hunts_table.put_item(Item=item)
+ turb.table.put_item(Item=item)
# Message the channel with the URL of the sheet
- turb.slack_client.chat_postMessage(channel=channel_id,
- text="Sheet created for this hunt: {}"
- .format(sheet['url']))
-
- # Create a database table for this hunt's puzzles
- table = turb.db.create_table(
- TableName=channel_name,
- KeySchema=[
- {'AttributeName': 'channel_id', 'KeyType': 'HASH'}
- ],
- AttributeDefinitions=[
- {'AttributeName': 'channel_id', 'AttributeType': 'S'}
- ],
- ProvisionedThroughput={
- 'ReadCapacityUnits': 5,
- 'WriteCapacityUnits': 5
- }
- )
-
- # Wait until the table exists
- table.meta.client.get_waiter('table_exists').wait(TableName=channel_name)
+ 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
- hunts_table.put_item(Item=item)
+ turb.table.put_item(Item=item)
# Message the hunt channel that the database is ready
- turb.slack_client.chat_postMessage(
- channel=channel_id,
- text="Thank you for waiting. This hunt is now ready to begin! "
+ 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, puzzle_channel_name, puzzle_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
- puzzle_table = turb.db.Table(hunt_id)
- response = puzzle_table.get_item(
+ response = turb.table.get_item(
Key={'channel_id': puzzle_channel_id},
ConsistentRead=True
)
.format(puzzle_channel_id, item['sheet_url']))
return lambda_success
- # Remove any None items from our item before updating
- if not item['url']:
- del item['url']
-
# 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'
+ item['channel_url'] = channel_url(puzzle_channel_id)
puzzle_table.put_item(Item=item)
# Create a sheet for the puzzle
- sheet = turbot.sheets.sheets_create_for_puzzle(turb, puzzle_channel_name)
+ sheet = sheets_create_for_puzzle(turb, item)
# Update the database with the URL of the sheet
item['sheet_url'] = sheet['url']
puzzle_table.put_item(Item=item)
- # Message the channel with the URL of the puzzle's sheet
- turb.slack_client.chat_postMessage(channel=puzzle_channel_id,
- text="Sheet created for this puzzle: {}"
- .format(sheet['url']))
+ # Get the new sheet_url into the channel description
+ set_channel_description(turb, item)
+ # Lookup and invite all users from this hunt to this new puzzle
hunts_table = turb.db.Table('hunts')
response = hunts_table.scan(
FilterExpression='hunt_id = :hunt_id',
- ExpressionAttributeValues={':hunt_id': hunt_id},
+ ExpressionAttributeValues={':hunt_id': hunt_id}
)
if 'Items' in response:
- hunt_channel_id=response['Items'][0]['channel_id']
+ hunt_channel_id = response['Items'][0]['channel_id']
# Find all members of the hunt channel
members = turbot.slack.slack_channel_members(turb.slack_client,
# Filter out Turbot's own ID to avoid inviting itself
members = [m for m in members if m != TURBOT_USER_ID]
- turb.slack_client.chat_postMessage(
- channel=puzzle_channel_id,
- text="Inviting all members from the hunt channel: {}"
- .format(hunt_id))
+ slack_send_message(
+ turb.slack_client, puzzle_channel_id,
+ "Inviting all members from the hunt channel: "
+ + "<#{}>".format(hunt_channel_id))
# Invite those members to the puzzle channel (in chunks of 500)
cursor = 0
users=members[cursor:cursor + 500])
cursor += 500
+ # 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(item['name'])
+ )
+
+ if 'url' in item:
+ welcome_msg += (
+ "See the <{}|puzzle itself> ".format(item['url'])
+ + "for what was originally presented to us."
+ )
+
+ sheet_msg = (
+ "Actual puzzle solving work will take place within the following "
+ + "<{}|shared spreadsheet> ".format(item['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=puzzle_channel_id,
+ text="New puzzle: {}".format(item['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))
+ ])
+
return lambda_success
def channel_created(turb, event):
- print("In channel_created with event: {}".format(str(event)))
channel = event['channel']
channel_id = channel['id']
projects / turbot / blobdiff