X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=turbot%2Finteraction.py;h=1638b7391eac709d42a84cd40192056d8cc4b777;hb=336dbca354f48277e2166ba3f2ec6bc8023a3ba2;hp=4e626f39fc0c7adc4ec2a3be32c63d9aec632216;hpb=1b5f5fe117c987ddb6cb446efea31b179f9a5c79;p=turbot diff --git a/turbot/interaction.py b/turbot/interaction.py index 4e626f3..1638b73 100644 --- a/turbot/interaction.py +++ b/turbot/interaction.py @@ -12,8 +12,10 @@ actions = {} commands = {} submission_handlers = {} -# Hunt and Puzzle IDs are restricted to letters, numbers, and underscores -valid_id_re = r'^[_a-zA-Z0-9]+$' +# Hunt/Puzzle IDs are restricted to lowercase letters, numbers, and underscores +valid_id_re = r'^[_a-z0-9]+$' + +lambda_ok = {'statusCode': 200} def bot_reply(message): """Construct a return value suitable for a bot reply @@ -70,10 +72,7 @@ def new_hunt(turb, payload): if (result['ok']): submission_handlers[result['view']['id']] = new_hunt_submission - return { - 'statusCode': 200, - 'body': 'OK' - } + return lambda_ok actions['button'] = {"new_hunt": new_hunt} @@ -92,7 +91,7 @@ def new_hunt_submission(turb, payload, metadata): # Validate that the hunt_id contains no invalid characters if not re.match(valid_id_re, hunt_id): return submission_error("hunt_id", - "Hunt ID can only contain letters, " + "Hunt ID can only contain lowercase letters, " + "numbers, and underscores") # Check to see if the hunts table exists @@ -148,9 +147,7 @@ def new_hunt_submission(turb, payload, metadata): # Invite the initiating user to the channel turb.slack_client.conversations_invite(channel=channel_id, users=user_id) - return { - 'statusCode': 200, - } + return lambda_ok def view_submission(turb, payload): """Handler for Slack interactive view submission @@ -198,13 +195,54 @@ def rot(turb, body, args): else: turb.slack_client.chat_postMessage(channel=channel_id, text=result) - return { - 'statusCode': 200, - 'body': "" - } + return lambda_ok commands["/rot"] = rot +def get_table_item(turb, table_name, key, value): + """Get an item from the database 'table_name' with 'key' as 'value' + + Returns a tuple of (item, table) if found and (None, None) otherwise.""" + + table = turb.db.Table(table_name) + + response = table.get_item(Key={key: value}) + + if 'Item' in response: + return (response['Item'], table) + else: + return (None, None) + +def channel_is_puzzle(turb, channel_id, channel_name): + """Given a channel ID/name return the database item for the puzzle + + If this channel is a puzzle, this function returns a tuple: + + (puzzle, table) + + Where puzzle is dict filled with database entries, and table is a + database table that can be used to update the puzzle in the + database. + + Otherwise, this function returns (None, None).""" + + hunt_id = channel_name.split('-')[0] + + # Not a puzzle channel if there is no hyphen in the name + if hunt_id == channel_name: + return (None, None) + + return get_table_item(turb, hunt_id, 'channel_id', channel_id) + +def channel_is_hunt(turb, channel_id): + + """Given a channel ID/name return the database item for the hunt + + Returns a dict (filled with database entries) if there is a hunt + for this channel, otherwise returns None.""" + + return get_table_item(turb, "hunts", 'channel_id', channel_id) + def find_hunt_for_channel(turb, channel_id, channel_name): """Given a channel ID/name find the id/name of the hunt for this channel @@ -213,23 +251,23 @@ def find_hunt_for_channel(turb, channel_id, channel_name): Returns a tuple of (hunt_name, hunt_id) or (None, None).""" - hunts_table = turb.db.Table("hunts") - response = hunts_table.get_item(Key={'channel_id': channel_id}) + (hunt, _) = channel_is_hunt(turb, channel_id) - if 'Item' in response: - item = response['Item'] - return (item['hunt_id'], item['name']) + if hunt: + return (hunt['hunt_id'], hunt['name']) # So we're not a hunt channel, let's look to see if we are a # puzzle channel with a hunt-id prefix. hunt_id = channel_name.split('-')[0] + hunts_table = turb.db.Table("hunts") + response = hunts_table.scan( FilterExpression='hunt_id = :hunt_id', ExpressionAttributeValues={':hunt_id': hunt_id} ) - if 'Items' in response: + if 'Items' in response and len(response['Items']): item = response['Items'][0] return (item['hunt_id'], item['name']) @@ -245,7 +283,9 @@ def puzzle(turb, body, args): channel_name = body['channel_name'][0] trigger_id = body['trigger_id'][0] - (hunt_id, hunt_name) = find_hunt_for_channel(turb, channel_id, channel_name) + (hunt_id, hunt_name) = find_hunt_for_channel(turb, + channel_id, + channel_name) if not hunt_id: return bot_reply("Sorry, this channel doesn't appear to " @@ -275,9 +315,7 @@ def puzzle(turb, body, args): if (result['ok']): submission_handlers[result['view']['id']] = puzzle_submission - return { - 'statusCode': 200 - } + return lambda_ok commands["/puzzle"] = puzzle @@ -298,8 +336,8 @@ def puzzle_submission(turb, payload, metadata): # Validate that the puzzle_id contains no invalid characters if not re.match(valid_id_re, puzzle_id): return submission_error("puzzle_id", - "Puzzle ID can only contain letters, " - + "numbers, and underscores") + "Puzzle ID can only contain lowercase letters," + + " numbers, and underscores") # Create a channel for the puzzle hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id) @@ -327,6 +365,73 @@ def puzzle_submission(turb, payload, metadata): } ) - return { - 'statusCode': 200 - } + return lambda_ok + +# XXX: This duplicates functionality eith events.py:set_channel_description +def set_channel_topic(turb, puzzle): + channel_id = puzzle['channel_id'] + description = puzzle['name'] + url = puzzle.get('url', None) + sheet_url = puzzle.get('sheet_url', None) + state = puzzle.get('state', 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)) + + if state: + description += " {}".format(state) + + turb.slack_client.conversations_setTopic(channel=channel_id, + topic=description) + +def state(turb, body, args): + """Implementation of the /state command + + The args string should be a brief sentence describing where things + stand or what's needed.""" + + channel_id = body['channel_id'][0] + channel_name = body['channel_name'][0] + + (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name) + + if not puzzle: + return bot_reply("Sorry, this is not a puzzle channel.") + + # Set the state field in the database + puzzle['state'] = args + table.put_item(Item=puzzle) + + set_channel_topic(turb, puzzle) + + return lambda_ok + +commands["/state"] = state + +def solved(turb, body, args): + """Implementation of the /solved command + + The args string should be a confirmed solution.""" + + channel_id = body['channel_id'][0] + channel_name = body['channel_name'][0] + + (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name) + + if not puzzle: + return bot_reply("Sorry, this is not a puzzle channel.") + + # Set the status and solution fields in the database + puzzle['status'] = 'solved' + puzzle['solution'].append(args) + table.put_item(Item=puzzle) + + return lambda_ok + +commands["/solved"] = solved