forked from commitsto/commits.to
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCommitBot.py
84 lines (70 loc) · 3.37 KB
/
CommitBot.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#Import dependencies for Slack Bot as mentioned in CommitBot.txt
import os
import time
import re
from slackclient import SlackClient
#Grabs secret token exported in previous setup when CommitBot was created.
# instantiate Slack client
slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))
# commitbot's user ID in Slack: value is assigned after the bot starts up
commitbot_id = None
# commit command reference. might not agree with constants below.
commitsto("user_id.commits.to/")
# constants
RTM_READ_DELAY = 1 # 1 second delay between reading from RTM
commit = "iwill, commitsto"
MENTION_REGEX = "/"
#Defines user IDs for each workspace the bot is installed in, in the event the bot is mentioned.
#Then goes into an infinite loop to check for mentions.
#Definition for commands (making commits; not sure if bot will do this automatically yet or if we'll trigger to test).
def parse_bot_commands(slack_events):
"""
Parses a list of events coming from the Slack RTM API to find bot commands.
If a bot command is found, this function returns a tuple of command and channel.
If its not found, then this function returns None, None.
"""
for event in slack_events:
if event["type"] == "message" and not "subtype" in event:
user_id, message = parse_direct_mention(event["text"])
if user_id == commitbot_id:
return message, event["channel"]
return None, None
def parse_direct_mention(message_text):
"""
Finds a direct mention (a mention that is at the beginning, ie @CommitBot) in message text
and returns the user ID which was mentioned. If there is no direct mention, returns None
"""
matches = re.search(MENTION_REGEX, message_text)
# the first group contains the username, the second group contains the remaining message
return (matches.group(1), matches.group(2).strip()) if matches else (None, None)
def handle_command(command, channel):
"""
Executes bot command if the command is known. Bot will only know one command right now.
"""
# Default response is help text for the user
default_response = "Hmm. Doesn't look quite right. Try *{}*.".format(commit)
# Finds and executes the given command, filling in response
response = None
# This is where you start to implement more commands!
if command.startswith(commit):
response = "Woohoo! Finish that string and you're making a commitment."
# Sends the response back to the channel
slack_client.api_call(
"chat.postMessage",
channel=channel,
text=response or default_response
)
#Connection parameters.
if __name__ == "__main__":
if slack_client.rtm_connect(with_team_state=False):
print("Commit Bot connected and running!")
# Read bot's user ID by calling Web API method `auth.test`
commitbot_id = slack_client.api_call("auth.test")["user_id"]
while True:
command, channel = parse_bot_commands(slack_client.rtm_read())
if command:
handle_command(command, channel)
time.sleep(RTM_READ_DELAY)
else:
print("Connection failed. Exception traceback printed above.")
#parse_bot_commands() function determines event contains command for CommitBot (ie making a commit). If it does, then command will contain a value and the handle_command() function determines what to do.