interactive bots: Create comment on issue GitHub bot.

interactive bots: Create comment on issue GitHub bot.

interactive bots: Create comment on issue GitHub bot.

interactive bots: Create comment on issue GitHub bot.

interactive bots: Create comment on issue GitHub bot.

contrib_bots/lib/git_hub_comment.py

@@ -0,0 +1,143 @@
+# See readme-github-comment-bot.md for instructions on running this code.
+from __future__ import print_function
+import requests
+import json
+import os
+import logging
+
+
+class InputError(IndexError):
+    '''raise this when there is an error with the information the user has entered'''
+
+
+class GitHubHandler(object):
+    '''
+    This plugin allows you to comment on a GitHub issue, under a certain repository.
+    It looks for messages starting with '@comment' or '@gcomment'.
+    '''
+
+    def usage(self):
+        return '''
+            This bot will allow users to comment on a GitHub issue.
+            Users should preface messages with '@comment' or '@gcomment'.
+            You will need to have a GitHub account.
+
+            Before running this, make sure to get a GitHub OAuth token.
+            The token will need to be authorized for the following scopes:
+            'gist, public_repo, user'.
+            Store it in the 'github_token.txt' file.
+            The 'github_token.txt' file should be located at '~/github_token.txt'.
+            Please input info like this:
+            '/<username>/<repository_owner>/<repository>/<issue_number>/<your_comment>'.
+            '''
+
+    def triage_message(self, message):
+        # return True iff we want to (possibly) response to this message
+
+        original_content = message['content']
+
+        is_comment = (original_content.startswith('@comment') or
+                      original_content.startswith('@gcomment'))
+
+        return is_comment
+
+    def handle_message(self, message, client, state_handler):
+        original_content = message['content']
+        original_sender = message['sender_email']
+
+        # this handles the message if its starts with @comment
+        if original_content.startswith('@comment'):
+            handle_input(client, original_content, original_sender)
+
+        # handle if message starts with @gcomment
+        elif original_content.startswith('@gcomment'):
+            handle_input(client, original_content, original_sender)
+
+handler_class = GitHubHandler
+
+
+def send_to_github(user, repo_owner, repo, issue, comment_body):
+    session = requests.session()
+
+    oauth_token = get_github_token()
+    session.auth = (user, oauth_token)
+    comment = {
+        'body': comment_body
+    }
+    r = session.post('https://api.github.com/repos/%s/%s/issues/%s/comments' % (repo_owner, repo, issue),
+                     json.dumps(comment))
+
+    return r.status_code
+
+
+def get_values_message(original_content):
+    # gets rid of whitespace around the edges, so that they aren't a problem in the future
+    message_content = original_content.strip()
+    # splits message by '/' which will work if the information was entered correctly
+    message_content = message_content.split('/')
+    try:
+        # this will work if the information was entered correctly
+        user = message_content[1]
+        repo_owner = message_content[2]
+        repo = message_content[3]
+        issue = message_content[4]
+        comment_body = message_content[5]
+
+        return dict(user=user, repo_owner=repo_owner, repo=repo, issue=issue, comment_body=comment_body)
+    except IndexError:
+        raise InputError
+
+
+def handle_input(client, original_content, original_sender):
+    try:
+        params = get_values_message(original_content)
+
+        status_code = send_to_github(params['user'], params['repo_owner'], params['repo'],
+                                     params['issue'], params['comment_body'])
+
+        if status_code == 201:
+            # sending info to github was successful!
+            reply_message = "You commented on issue number " + params['issue'] + " under " + \
+                            params['repo_owner'] + "'s repository " + params['repo'] + "!"
+
+            send_message(client, reply_message, original_sender)
+
+        elif status_code == 404:
+            # this error could be from an error with the OAuth token
+            reply_message = "Error code: " + str(status_code) + " :( There was a problem commenting on issue number " \
+                            + params['issue'] + " under " + \
+                            params['repo_owner'] + "'s repository " + params['repo'] + \
+                            ". Do you have the right OAuth token?"
+
+            send_message(client, reply_message, original_sender)
+
+        else:
+            # sending info to github did not work
+            reply_message = "Error code: " + str(status_code) +\
+                            " :( There was a problem commenting on issue number " \
+                            + params['issue'] + " under " + \
+                            params['repo_owner'] + "'s repository " + params['repo'] + \
+                            ". Did you enter the information in the correct format?"
+
+            send_message(client, reply_message, original_sender)
+    except InputError:
+            message = "It doesn't look like the information was entered in the correct format." \
+                      " Did you input it like this? " \
+                      "'/<username>/<repository_owner>/<repository>/<issue_number>/<your_comment>'."
+            send_message(client, message, original_sender)
+            logging.error('there was an error with the information you entered')
+
+
+def get_github_token():
+    home = os.path.expanduser('~')
+    oauth_token = open(home + '/github_token.txt').read().strip()
+    return oauth_token
+
+
+def send_message(client, message, original_sender):
+    # function for sending a message
+    client.send_message(dict(
+        type='private',
+        to=original_sender,
+        content=message,
+    ))

contrib_bots/lib/readme-github-comment-bot.md

@@ -0,0 +1,51 @@
+# Overview
+
+This is the documentation for how to set up and run the GitHub comment bot. (`git_hub_comment.py`)
+
+This directory contains library code for running Zulip
+bots that react to messages sent by users.
+
+This bot will allow you to comment on a GitHub issue.
+You should preface messages with `@comment` or `@gcomment`.
+You will need to have a GitHub account, and a GitHub OAuth token.
+
+## Setup
+Before running this bot, make sure to get a GitHub OAuth token.
+You can look at this tutorial if you need help:
+<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>
+The token will need to be authorized for the following scopes: `gist, public_repo, user`.
+Store it in the `github_token.txt` file.
+The `github_token.txt` file should be located at `~/github_token.txt`.
+Please input info like this:
+`/<username>/<repository_owner>/<repository>/<issue_number>/<your_comment`.
+
+## Running the bot
+
+Here is an example of running the `git_hub_comment` bot from
+inside a Zulip repo:
+
+    `cd ~/zulip/contrib_bots`
+    `./run.py lib/git_hub_comment.py --config-file ~/.zuliprc-prod`
+
+Once the bot code starts running, you will see a
+message explaining how to use the bot, as well as
+some log messages.  You can use the `--quiet` option
+to suppress some of the informational messages.
+
+The bot code will run continuously until you kill them with
+control-C (or otherwise).
+
+### Configuration
+
+For this document we assume you have some prior experience
+with using the Zulip API, but here is a quick review of
+what a `.zuliprc` files looks like.  You can connect to the
+API as your own human user, or you can go into the Zulip settings
+page to create a user-owned bot.
+
+    [api]
+    email=someuser@example.com
+    key=<your api key>
+    site=https://zulip.somewhere.com
+
+