import re import os import sys import logging import six.moves.configparser import requests class GithubHandler(object): ''' This bot provides details on github issues and pull requests when they're referenced in the chat. ''' GITHUB_ISSUE_URL_TEMPLATE = 'https://api.github.com/repos/{owner}/{repo}/issues/{id}' HANDLE_MESSAGE_REGEX = re.compile("(?:([\w-]+)\/)?([\w-]+)?#(\d+)") def initialize(self, bot_handler): self.config_info = bot_handler.get_config_info('github_detail', optional=True) self.owner = self.config_info.get("owner", False) self.repo = self.config_info.get("repo", False) def usage(self): # type: () -> None return ("This plugin displays details on github issues and pull requests. " "To reference an issue or pull request usename mention the bot then " "anytime in the message type its id, for example:\n" "@**Github detail** #3212 zulip#3212 zulip/zulip#3212\n" "The default owner is {} and the default repo is {}.".format(self.owner, self.repo)) def format_message(self, details): # type: (Dict[Text, Union[Text, int, bool]]) -> Text number = details['number'] title = details['title'] link = details['html_url'] author = details['user']['login'] owner = details['owner'] repo = details['repo'] description = details['body'] status = details['state'].title() message_string = ('**[{owner}/{repo}#{id}]'.format(owner=owner, repo=repo, id=number), '({link}) - {title}**\n'.format(title=title, link=link), 'Created by **[{author}](https://github.com/{author})**\n'.format(author=author), 'Status - **{status}**\n```quote\n{description}\n```'.format(status=status, description=description)) return ''.join(message_string) def get_details_from_github(self, owner, repo, number): # type: (Text, Text, Text) -> Dict[Text, Union[Text, Int, Bool]] # Gets the details of an issues or pull request try: r = requests.get( self.GITHUB_ISSUE_URL_TEMPLATE.format(owner=owner, repo=repo, id=number)) except requests.exceptions.RequestException as e: logging.exception(e) return if r.status_code == 404: try: r = requests.get( self.GITHUB_PULL_URL_TEMPLATE.format(owner=owner, repo=repo, id=number)) except requests.exceptions.RequestException as e: logging.exception(e) return if r.status_code != requests.codes.ok: return return r.json() def get_owner_and_repo(self, issue_pr): owner = issue_pr.group(1) repo = issue_pr.group(2) if owner is None: owner = self.owner if repo is None: repo = self.repo return (owner, repo) def handle_message(self, message, bot_handler, state_handler): # type: () -> None # Send help message if message['content'] == '@**{}** help'.format(bot_handler.full_name): bot_handler.send_message(dict( type='stream', to=message['display_recipient'], subject=message['subject'], content=self.usage(), )) # Capture owner, repo, id issue_prs = re.finditer( self.HANDLE_MESSAGE_REGEX, message['content']) bot_messages = [] for issue_pr in issue_prs: owner, repo = self.get_owner_and_repo(issue_pr) if owner and repo: details = self.get_details_from_github(owner, repo, issue_pr.group(3)) if details is not None: details['owner'] = owner details['repo'] = repo bot_messages.append(self.format_message(details)) else: bot_messages.append("Failed to find issue/pr: {owner}/{repo}#{id}" .format(owner=owner, repo=repo, id=issue_pr.group(3))) else: bot_messages.append("Failed to detect owner and repository name.") if len(bot_messages) == 0: bot_messages.append("Failed to find any issue or PR.") bot_message = '\n'.join(bot_messages) bot_handler.send_reply(message, bot_message) handler_class = GithubHandler