mentorbot.py

from bottle import route, run, get, post, request
import os
import time
import json
import pprint
from slackclient import SlackClient

pp = pprint.PrettyPrinter(indent=1)

# starterbot's ID as an environment variable
BOT_ID = os.environ.get("BOT_ID")

# instantiate Slack client
sc = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))

# channels
channels = {}
channels["mentor"] = "#mentorschannel"

# List of admins
admins = ['organizer-sampurna', 'jaminche', 'justinhe']

# List of all mentors
# mentors = ['msharan', 'nathanyang', 'justinhe', 'aqshi', 'dmdsouza', 'jaminche', 'janson', 'jeff_chen', 'jonluca', 'jwang', 'kryptonite', 'mark.klein', 'matthelb', 'navaneek', 'organizer-sampurna', 'sagarp', 'snidelyhazel', 'tonytu']
mentors = ['justinhe','wwillie','abrar','andrewszot','aqshi','chaitanya','cjglover','coding_idiot','conorhay','dkoo','dmdsouza','ethan_yu','jaminche','janson','jasmine','jeff_chen','jonluca','jwang','jzeiders','kryptonite','mark.klein','matthelb','mayukhdas','melanie_h','mentor-maegan','msharan','nathanyang','navaneek','nisha','nishir','organizer-sampurna','respiritu','sagarp','snidelyhazel','talab','tonytu','vivek']
# List of active mentors
activeMentors = []

def getUsers():
    users = sc.api_call("users.list")
    usernames = []
    for user in users['members']:
        usernames.append(user['name'])
    return usernames;

def getChannels():
    channelsList = sc.api_call("channels.list")["channels"]
    channelNames = []
    for channel in channelsList:
        channelNames.append(channel["name"])
    return channelNames;

def validUser(user):
    if user in getUsers():
        return True
    else:
        return False

@post('/mentor')
def mentor():
    """
    Usage: /mentor [category]
    Requests a mentor for a particular category.
    """
    category = request.forms.get("text")
    user = request.forms.get("user_name")
    user_id = request.forms.get("user_id")
    requestText = user + " is looking for a mentor for " + category + "! "
    sendMentorConfirm(channels["mentor"], requestText, user_id)

@post('/sudo')
def sudo():
    """
    Usage: /sudo [username]
    This is an admin-only command. Using this will add another admin.
    """
    caller = request.forms.get("user_name")
    if caller not in admins:
        return "You do not have permission to use this command."
    newAdmin = request.forms.get("text")
    channel_id = request.forms.get("channel_id")
    if validUser(newAdmin):
        admins.append("newAdmin")
        sendTextMessage(channel_id, "*" + newAdmin + "* has been given admin privileges.")
        print("Current admins are: ")
        print(admins)
    else:
        sendTextMessage(channel_id, "*" + newAdmin + "* is not an existing user!")

@post('/addmentor')
def addMentor():
    """
    Usage: /addmentor [username]
    This is an admin-only command. This adds a person with [username] to a
    list of registered mentors and can now accept/deal with help tickets.
    """
    caller = request.forms.get("user_name")
    if caller not in admins:
        return "You do not have permission to use this command."

    mentor = request.forms.get("text")
    if mentor in mentors:
        return mentor + " is already a mentor."
    channel_id = request.forms.get("channel_id")
    print(sc.api_call(
        "channels.invite",
        channel=channels["mentor"],
        user=mentor
    ))
    if mentor in getUsers():
        mentors.append(mentor);
        sendTextMessage(channel_id, "Successfully added *" + mentor + "* to the list of mentors!")
        sendTextMessage(channel_id, "Current mentors are: " + str(mentors))
        print("Adding " + mentor + " to list of mentors.")
        return "Make sure to invite *" + mentor + "* to " + channels["mentor"] + " as well."
    else:
        sendTextMessage(channel_id, "Sorry, the user *" + mentor + "* does not exist!")
        print("Attempted to add " + mentor + " to list of mentors but user does not exist")
    print("Current mentors:")
    print(mentors)

@post('/setmentorchannel')
def setMentorChannel():
    """
    Usage: /setmentorchannel [channel]
    This is an admin-only command. This sets the slack channel in which
    help tickets are ushered into, and where mentors can choose to pick up
    tickets. 
    """
    caller = request.forms.get("user_name")
    if caller not in admins:
        return "You do not have permission to use this command."
    mentorChannel = request.forms.get("text")
    user_id = request.forms.get("user_id")
    channel_id = request.forms.get("channel_id")
    channelsList = sc.api_call("channels.list")["channels"]
    channelNames = getChannels();
    print (channelNames)
    if mentorChannel not in channelNames:
        return "The channel *" + mentorChannel + "* does not exist!"
    else:
        channels["mentor"] = "#" + mentorChannel
        sendTextMessage(channel_id, "Mentor channel successfully set to *" + mentorChannel + "*!")
        return "Make sure that you have invited the mentorbot to the channel, otherwise it cannot post messages."

@post('/buttons')
def buttons():
    """
    Callback URL for interactive buttons.
    """
    payload = json.loads(request.forms.get("payload"))
    callback_id = payload["callback_id"]
    message_ts = payload["message_ts"]
    mentee_id = payload["actions"][0]["value"]
    mentor_id = payload["user"]["id"]
    mentor_name = payload["user"]["name"]
    if callback_id == "mentor_confirm":
        """
        Called when a mentor accepts a mentee's help request. Opens a
        multi-party message between the mentee, mentor, and the slackbot.
        Change mentor status to "checked-in" in the database if they have not
        done so yet.
        """
        new_im = (sc.api_call(
            "mpim.open",
            users=mentee_id + "," + mentor_id + "," + BOT_ID
        ))
        sendMentorFinish(new_im["group"]["name"], "Hey there! " + mentor_name + " will be able to help you.")
        sc.api_call(
            "chat.update",
            ts=message_ts,
            channel=payload["channel"]["id"],
            text="*Assigned* " + mentor_name + " to: " + payload["original_message"]["text"],
            as_user=True,
            attachments=[]
        )
    elif callback_id == "mentor_finish":
        """
        Change mentor status in database to "finished" and closes IM channel between mentor and mentee.
        """
        sc.api_call(
            "mpim.close",
            channel=payload["channel"]["id"]
        )
        sc.api_call(
            "chat.update",
            ts=message_ts,
            channel=payload["channel"]["id"],
            text="We hope we were able to help you! This thread is now closed.",
            as_user=True,
            attachments=[]
        )


def sendTextMessage(channel, text):
    """
    Sends text message to specific channel.
    """
    return sc.api_call(
        "chat.postMessage",
        channel=channel,
        text=text,
        as_user=True
    )

def sendMentorConfirm(channel, text, user_id):
    """
    Sends a one-button help request confirmation message to a channel.
    """
    return sc.api_call(
        "chat.postMessage",
        channel=channel,
        text=text,
        as_user=True,
        attachments=json.dumps(
        [
            {
                "text":"If you feel like you're the right person to take this person's issue, press the button below and we'll setup a chatroom between you two.",
                "fallback":"You are unable to choose an option",
                "callback_id":"mentor_confirm",
                "color":"#3AA3E3",
                "attachment_type":"default",
                "actions":[
                    {
                        "name":"mentor confirm",
                        "text":"Take this job!",
                        "type":"button",
                        "value":user_id
                    }
                ]
            }
        ])
    )

def sendMentorFinish(channel, text):
    """
    Sends a message with a "done" button allowing mentor/mentee to close the
    thread. Mentor status will now be set as "free" in database.
    """
    return sc.api_call(
        "chat.postMessage",
        channel=channel,
        text=text,
        as_user=True,
        attachments=json.dumps(
        [
            {
                "text":"When you guys are finished, feel free to click the button below.",
                "fallback":"You are unable to choose an option",
                "callback_id":"mentor_finish",
                "color":"#3AA3E3",
                "attachment_type":"default",
                "actions":[
                    {
                        "name":"mentor finish",
                        "text":"Done!",
                        "type":"button",
                        "value":True
                    }
                ]
            }
        ])
    )

if __name__ == "__main__":
    # activates and runs the server
    port = int(os.environ.get("PORT", 5000))
    run(host='0.0.0.0', port=port)