git.cworth.org Git - turbot/blob - turbot/events.py

   1 from turbot.blocks import (
   2     section_block, text_block, button_block, actions_block, divider_block
   3 )
   4 import turbot.slack
   5 from turbot.sheets import sheets_create, sheets_create_for_puzzle
   6 from turbot.slack import slack_send_message, slack_channel_members
   7 from boto3.dynamodb.conditions import Key
   8
   9 TURBOT_USER_ID = 'U01B9QM4P9R'
  10
  11 events = {}
  12
  13 lambda_success = {'statusCode': 200}
  14 lambda_error = {'statusCode': 400}
  15
  16 def channel_url(channel_id):
  17     return "https://halibutthatbass.slack.com/archives/{}".format(channel_id)
  18
  19 def puzzle_block(puzzle):
  20     name = puzzle['name']
  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)
  27     status_emoji = ''
  28     solution_str = ''
  29
  30     if status == 'solved':
  31         status_emoji = ":ballot_box_with_check:"
  32     else:
  33         status_emoji = ":white_square:"
  34
  35     if len(solution):
  36         solution_str = "*`" + '`, `'.join(solution) + "`*"
  37
  38     links = []
  39     if url:
  40         links.append("<{}|Puzzle>".format(url))
  41     if sheet_url:
  42         links.append("<{}|Sheet>".format(sheet_url))
  43
  44     state_str = ''
  45     if state:
  46         state_str = "\n{}".format(state)
  47
  48     puzzle_text = "{}{} <{}|{}> ({}){}".format(
  49         status_emoji, solution_str,
  50         channel_url(channel_id), name,
  51         ', '.join(links), state_str
  52     )
  53
  54     return section_block(text_block(puzzle_text))
  55
  56 def hunt_block(turb, hunt):
  57     name = hunt['name']
  58     hunt_id = hunt['hunt_id']
  59     channel_id = hunt['channel_id']
  60
  61     response = turb.db.Table(hunt_id).scan()
  62     puzzles = response['Items']
  63
  64     hunt_text = "*<{}|{}>*".format(channel_url(channel_id), name)
  65
  66     return [
  67         section_block(text_block(hunt_text)),
  68         *[puzzle_block(puzzle) for puzzle in puzzles],
  69         divider_block()
  70     ]
  71
  72 def home(turb, user_id):
  73     """Returns a view to be published as the turbot home tab for user_id
  74
  75     The return value is a dictionary suitable to be published to the
  76     Slack views_publish API."""
  77
  78     # Behave cleanly if there is no "turbot" table at all yet.
  79     try:
  80         response = turb.table.scan()
  81         hunts = response['Items']
  82     except Exception:
  83         hunts = []
  84
  85     hunt_blocks = []
  86     for hunt in hunts:
  87         if not hunt['active']:
  88             continue
  89         if user_id not in slack_channel_members(turb.slack_client,
  90                                                 hunt['channel_id']):
  91             continue
  92         hunt_blocks += hunt_block(turb, hunt)
  93
  94     return {
  95         "type": "home",
  96         "blocks": [
  97             section_block(text_block("*Hunts you belong to*")),
  98             divider_block(),
  99             * hunt_blocks,
 100             actions_block(button_block("New hunt", "new_hunt"))
 101         ]
 102     }
 103
 104 def app_home_opened(turb, event):
 105     """Handler for the app_home_opened event
 106
 107     This event occurs when a user visits the home tab for the turbot app.
 108     In response to this event we need to publish a view for the user."""
 109
 110     user_id = event['user']
 111     view = home(turb, user_id)
 112     turb.slack_client.views_publish(user_id=user_id, view=view)
 113     return lambda_success
 114
 115 events['app_home_opened'] = app_home_opened
 116
 117 def hunt_channel_created(turb, channel_name, channel_id):
 118     """Creates a Google sheet for a newly-created hunt channel"""
 119
 120     # First see if we can find an entry for this hunt in the database.
 121     # If not, simply return an error and let Slack retry
 122     response = turb.table.query(
 123         IndexName='channel_id_index',
 124         KeyConditionExpression=Key("channel_id").eq(channel_id)
 125     )
 126     if 'Items' not in response:
 127         print("Warning: Cannot find channel_id {} in hunts table. "
 128               .format(channel_id) + "Letting Slack retry this event")
 129         return lambda_error
 130
 131     item = response['Items'][0]
 132
 133     if 'sheet_url' in item:
 134         print("Info: channel_id {} already has sheet_url {}. Exiting."
 135               .format(channel_id, item['sheet_url']))
 136         return lambda_success
 137
 138     # Before launching into sheet creation, indicate that we're doing this
 139     # in the database. This way, if we take too long to create the sheet
 140     # and Slack retries the event, that next event will see this 'pending'
 141     # string and cleanly return (eliminating all future retries).
 142     item['sheet_url'] = 'pending'
 143     turb.table.put_item(Item=item)
 144
 145     # Also, let the channel users know what we are up to
 146     slack_send_message(
 147         turb.slack_client, channel_id,
 148         "Welcome to the channel for the {} hunt! ".format(item['name'])
 149         + "Please wait a minute or two while I create some backend resources.")
 150
 151     # Create a sheet for the hunt
 152     sheet = sheets_create(turb, item['name'])
 153
 154     # Update the database with the URL of the sheet
 155     item['sheet_url'] = sheet['url']
 156     turb.table.put_item(Item=item)
 157
 158     # Message the channel with the URL of the sheet
 159     slack_send_message(turb.slack_client, channel_id,
 160                        "Sheet created for this hunt: {}".format(sheet['url']))
 161
 162     # Mark the hunt as active in the database
 163     item['active'] = True
 164     turb.table.put_item(Item=item)
 165
 166     # Message the hunt channel that the database is ready
 167     slack_send_message(
 168         turb.slack_client, channel_id,
 169         "Thank you for waiting. This hunt is now ready to begin! "
 170         + "Use `/puzzle` to create puzzles for the hunt.")
 171
 172     return lambda_success
 173
 174 def set_channel_description(turb, puzzle):
 175     channel_id = puzzle['channel_id']
 176     description = puzzle['name']
 177     url = puzzle.get('url', None)
 178     sheet_url = puzzle.get('sheet_url', None)
 179
 180     links = []
 181     if url:
 182         links.append("<{}|Puzzle>".format(url))
 183     if sheet_url:
 184         links.append("<{}|Sheet>".format(sheet_url))
 185
 186     if len(links):
 187         description += "({})".format(', '.join(links))
 188
 189     turb.slack_client.conversations_setPurpose(channel=channel_id,
 190                                                purpose=description)
 191     turb.slack_client.conversations_setTopic(channel=channel_id,
 192                                              topic=description)
 193
 194 def puzzle_channel_created(turb, puzzle_channel_name, puzzle_channel_id):
 195     """Creates sheet and invites user for a newly-created puzzle channel"""
 196
 197     hunt_id = puzzle_channel_name.split('-')[0]
 198
 199     # First see if we can find an entry for this puzzle in the database.
 200     # If not, simply return an error and let Slack retry
 201     response = turb.table.get_item(
 202         Key={'channel_id': puzzle_channel_id},
 203         ConsistentRead=True
 204     )
 205     if 'Item' not in response:
 206         print("Warning: Cannot find channel_id {} in {} table. "
 207               .format(puzzle_channel_id, hunt_id)
 208               + "Letting Slack retry this event")
 209         return lambda_error
 210
 211     item = response['Item']
 212
 213     if 'sheet_url' in item:
 214         print("Info: channel_id {} already has sheet_url {}. Exiting."
 215               .format(puzzle_channel_id, item['sheet_url']))
 216         return lambda_success
 217
 218     # Before launching into sheet creation, indicate that we're doing this
 219     # in the database. This way, if we take too long to create the sheet
 220     # and Slack retries the event, that next event will see this 'pending'
 221     # string and cleanly return (eliminating all future retries).
 222     item['sheet_url'] = 'pending'
 223     item['channel_url'] = channel_url(puzzle_channel_id)
 224     puzzle_table.put_item(Item=item)
 225
 226     # Create a sheet for the puzzle
 227     sheet = sheets_create_for_puzzle(turb, item)
 228
 229     # Update the database with the URL of the sheet
 230     item['sheet_url'] = sheet['url']
 231     puzzle_table.put_item(Item=item)
 232
 233     # Get the new sheet_url into the channel description
 234     set_channel_description(turb, item)
 235
 236     # Lookup and invite all users from this hunt to this new puzzle
 237     hunts_table = turb.db.Table('hunts')
 238     response = hunts_table.scan(
 239         FilterExpression='hunt_id = :hunt_id',
 240         ExpressionAttributeValues={':hunt_id': hunt_id}
 241     )
 242
 243     if 'Items' in response:
 244
 245         hunt_channel_id = response['Items'][0]['channel_id']
 246
 247         # Find all members of the hunt channel
 248         members = turbot.slack.slack_channel_members(turb.slack_client,
 249                                                      hunt_channel_id)
 250
 251         # Filter out Turbot's own ID to avoid inviting itself
 252         members = [m for m in members if m != TURBOT_USER_ID]
 253
 254         slack_send_message(
 255             turb.slack_client, puzzle_channel_id,
 256             "Inviting all members from the hunt channel: "
 257             + "<#{}>".format(hunt_channel_id))
 258
 259         # Invite those members to the puzzle channel (in chunks of 500)
 260         cursor = 0
 261         while cursor < len(members):
 262             turb.slack_client.conversations_invite(
 263                 channel=puzzle_channel_id,
 264                 users=members[cursor:cursor + 500])
 265             cursor += 500
 266
 267     # And finally, give a welcome message with some documentation
 268     # on how to update the state of the puzzle in the database.
 269     welcome_msg = (
 270         "Welcome! This channel is the primary place to "
 271         + "discuss things as the team works together to solve the "
 272         + "puzzle '{}'. ".format(item['name'])
 273     )
 274
 275     if 'url' in item:
 276         welcome_msg += (
 277             "See the <{}|puzzle itself> ".format(item['url'])
 278             + "for what was originally presented to us."
 279         )
 280
 281     sheet_msg = (
 282         "Actual puzzle solving work will take place within the following "
 283         + "<{}|shared spreadsheet> ".format(item['sheet_url'])
 284     )
 285
 286     state_msg = (
 287         "Whenever the status of the puzzle progress changes "
 288         + "significantly, please type `/state` with a brief message "
 289         + "explaining where things stand. This could be something "
 290         + "like `/state Grid is filled. Need insight for extraction.` "
 291         + "or `/state Nathan has printed this and is cutting/assembling`. "
 292         + "It's especially important to put information in `/state` "
 293         + "when you step away from a puzzle so the next team members "
 294         + "to arrive will know what is going on."
 295     )
 296
 297     solved_msg = (
 298         "When a puzzle has been solved, submitted, and the solution is "
 299         + "confirmed, please type `/solved THE PUZZLE ANSWER HERE`. All "
 300         + "information given in `/state` and `/solved` will be presented "
 301         + "in this channel's topic as well as in the hunt overview "
 302         + "(which is available by selecting \"Turbot\" from the Slack "
 303         + "list of members)."
 304     )
 305
 306     turb.slack_client.chat_postMessage(
 307         channel=puzzle_channel_id,
 308         text="New puzzle: {}".format(item['name']),
 309         blocks=[
 310             section_block(text_block(welcome_msg)),
 311             section_block(text_block(sheet_msg)),
 312             section_block(text_block(state_msg)),
 313             section_block(text_block(solved_msg))
 314         ])
 315
 316     return lambda_success
 317
 318 def channel_created(turb, event):
 319
 320     channel = event['channel']
 321     channel_id = channel['id']
 322     channel_name = channel['name']
 323     creator = channel['creator']
 324
 325     # Ignore any channels that turbot didn't create
 326     if creator != TURBOT_USER_ID:
 327         print("channel_created: Not a turbot-created channel. Exiting.")
 328         return lambda_success
 329
 330     # The presence of a hyphen determines whether this is a puzzle
 331     # channel or a hunt channel.
 332     if '-' in channel_name:
 333         return puzzle_channel_created(turb, channel_name, channel_id)
 334     else:
 335         return hunt_channel_created(turb, channel_name, channel_id)
 336
 337 events['channel_created'] = channel_created