from turbot.blocks import (
section_block, text_block, button_block, actions_block, divider_block
)
-import turbot.sheets
-import turbot.slack
-from turbot.slack import slack_send_message
+from turbot.hunt import find_hunt_for_hunt_id
+from turbot.sheets import (
+ sheets_create, sheets_create_for_puzzle, sheets_create_folder
+)
+from turbot.slack import slack_send_message, slack_channel_members
+from turbot.channel import channel_url
+from boto3.dynamodb.conditions import Key
TURBOT_USER_ID = 'U01B9QM4P9R'
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)
+def hunt_link_block(turb, hunt):
- 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.db.Table(hunt_id).scan()
- puzzles = response['Items']
+ hunt_link = "*<{}|{}>*".format(channel_url(channel_id), name)
- hunt_text = "*<{}|{}>*".format(channel_url(channel_id), name)
-
- return [
- section_block(text_block(hunt_text)),
- *[puzzle_block(puzzle) for puzzle in puzzles],
- divider_block()
- ]
+ return section_block(text_block(hunt_link))
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 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(
+ IndexName="is_hunt_index",
+ )
hunts = response['Items']
except Exception:
hunts = []
- hunt_blocks = []
+ my_hunt_blocks = []
+ available_hunt_blocks = []
for hunt in hunts:
- if hunt['active']:
- hunt_blocks += hunt_block(turb, hunt)
+ print("Generating turbot home view for hunt '" + hunt['hunt_id'] + "'")
+ if not hunt['active']:
+ print("Never mind, that hunt is not active.")
+ continue
+ print("Hunt '" + hunt['hunt_id'] + "' is active, moving forward.")
+ if user_id in slack_channel_members(turb.slack_client,
+ hunt['channel_id']):
+ my_hunt_blocks.append(hunt_link_block(turb, hunt))
+ else:
+ available_hunt_blocks.append(hunt_link_block(turb, hunt))
+
+ if len(my_hunt_blocks):
+ my_hunt_blocks = [
+ section_block(text_block("*Hunts you belong to:*")),
+ divider_block(),
+ * my_hunt_blocks
+ ]
+ else:
+ my_hunt_blocks.append([
+ section_block(text_block("You do not belong to any hunts"))
+ ])
+
+ if len(available_hunt_blocks):
+ available_hunt_blocks = [
+ section_block(text_block("*Hunts you can join:*")),
+ divider_block(),
+ * available_hunt_blocks
+ ]
return {
"type": "home",
"blocks": [
- section_block(text_block("*Active hunts*")),
- divider_block(),
- * hunt_blocks,
+ * my_hunt_blocks,
+ * available_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:
- print("Warning: Cannot find channel_id {} in hunts table. "
+ 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['Item']
+ hunt = response['Items'][0]
- if 'sheet_url' in item:
+ if 'sheet_url' in hunt:
print("Info: channel_id {} already has sheet_url {}. Exiting."
- .format(channel_id, item['sheet_url']))
+ .format(channel_id, hunt['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)
+ hunt['sheet_url'] = 'pending'
+ turb.table.put_item(Item=hunt)
# 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.")
+ "Welcome to the channel for the {} hunt! ".format(hunt['name'])
+ + "Please wait a moment or two while I create some backend resources.")
- # Create a sheet for the channel
- sheet = turbot.sheets.sheets_create(turb, channel_name)
+ # Create a new folder within Google drive for the hunt
+ hunt['folder_id'] = sheets_create_folder(turb, hunt['hunt_id'])
- # Update the database with the URL of the sheet
- item['sheet_url'] = sheet['url']
- hunts_table.put_item(Item=item)
+ # Create a sheet for the hunt
+ sheet = sheets_create(turb, hunt['name'], hunt['folder_id'])
+ hunt['sheet_url'] = sheet['url']
# 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']))
- # 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)
+ # Mark the hunt as active now
+ hunt['active'] = True
- # Mark the hunt as active in the database
- item['active'] = True
- hunts_table.put_item(Item=item)
+ # Update the database with all the changes we have made to the hunt
+ turb.table.put_item(Item=hunt)
# 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.")
+ + "Type `/new` to create a puzzle for the hunt and `/help` for help.")
return lambda_success
turb.slack_client.conversations_setTopic(channel=channel_id,
topic=description)
-def puzzle_channel_created(turb, puzzle_channel_name, puzzle_channel_id):
+def puzzle_channel_created(turb, channel_name, channel_id):
"""Creates sheet and invites user for a newly-created puzzle channel"""
- hunt_id = puzzle_channel_name.split('-')[0]
-
# 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(
- Key={'channel_id': puzzle_channel_id},
- ConsistentRead=True
+ response = turb.table.query(
+ IndexName="channel_id_index",
+ KeyConditionExpression=Key("channel_id").eq(channel_id),
)
- if 'Item' not in response:
- print("Warning: Cannot find channel_id {} in {} table. "
- .format(puzzle_channel_id, hunt_id)
- + "Letting Slack retry this event")
+ 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['Item']
+ puzzle = response['Items'][0]
- if 'sheet_url' in item:
+ if 'sheet_url' in puzzle:
print("Info: channel_id {} already has sheet_url {}. Exiting."
- .format(puzzle_channel_id, item['sheet_url']))
+ .format(channel_id, puzzle['sheet_url']))
return lambda_success
- # Remove any None items from our item before updating
- if not item['url']:
- del item['url']
+ # We need hunt from the database to know which folder to create
+ # the sheet in.
+ hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
# 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'
- puzzle_table.put_item(Item=item)
+ puzzle['sheet_url'] = 'pending'
+ puzzle['channel_url'] = channel_url(channel_id)
+ turb.table.put_item(Item=puzzle)
# Create a sheet for the puzzle
- sheet = turbot.sheets.sheets_create_for_puzzle(turb, puzzle_channel_name)
+ sheet = sheets_create_for_puzzle(turb, puzzle, hunt['folder_id'])
# Update the database with the URL of the sheet
- item['sheet_url'] = sheet['url']
- puzzle_table.put_item(Item=item)
+ puzzle['sheet_url'] = sheet['url']
+ turb.table.put_item(Item=puzzle)
# Get the new sheet_url into the channel description
- set_channel_description(turb, item)
-
- hunts_table = turb.db.Table('hunts')
- response = hunts_table.scan(
- FilterExpression='hunt_id = :hunt_id',
- ExpressionAttributeValues={':hunt_id': hunt_id}
+ 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 'Items' in response:
-
- hunt_channel_id = response['Items'][0]['channel_id']
-
- # Find all members of the hunt channel
- members = turbot.slack.slack_channel_members(turb.slack_client,
- hunt_channel_id)
-
- # Filter out Turbot's own ID to avoid inviting itself
- members = [m for m in members if m != TURBOT_USER_ID]
+ if 'url' in puzzle:
+ welcome_msg += (
+ "See the <{}|puzzle itself> ".format(puzzle['url'])
+ + "for what was originally presented to us. "
+ )
+
+ welcome_msg += (
+ "Actual puzzle solving work will take place within the following " +
+ "<{}|shared spreadsheet> ".format(puzzle['sheet_url']) +
+ "\n\n"
+ "Common commands for updating the puzzle are `/state NEW STATE`, " +
+ "`/tag NEW_TAG`, and `/solved SOLUTION` . See `/help` for details " +
+ "and for additional commands."
+ )
- slack_send_message(
- turb.slack_client, puzzle_channel_id,
- "Inviting all members from the hunt channel: {}"
- .format(hunt_id))
+ turb.slack_client.chat_postMessage(channel=channel_id, text=welcome_msg)
- # Invite those members to the puzzle channel (in chunks of 500)
- cursor = 0
- while cursor < len(members):
- turb.slack_client.conversations_invite(
- channel=puzzle_channel_id,
- users=members[cursor:cursor + 500])
- cursor += 500
+ # 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):
- print("In channel_created with event: {}".format(str(event)))
channel = event['channel']
channel_id = channel['id']
else:
return hunt_channel_created(turb, channel_name, channel_id)
-
-
events['channel_created'] = channel_created
projects / turbot / blobdiff