Merge branch 'dev'

Author: viktoradavid

Procfile

@@ -0,0 +1 @@
+web: python3 labelbot/run.py -c -d hook_test web

README.md

@@ -1,6 +1,8 @@
 # Github Labelbot
 Configurable Github bot used for automatic issues labeling
 
+Sample webhook is running at https://labelbot-api.herokuapp.com/
+
 ## Configuration
 TBA
 
@@ -16,8 +18,16 @@ $ pip install -r requirements.txt
 
 Now you can run the command:
 
-`$ ./main.py --help`
+`$ labelbot/run.py --help`
+
+
+## Heroku deployment
+While deploying the app on Heroku, following environment variables have to be set:
 
+```
+WEBHOOK_TOKEN=webhook_token - GitHub webhook secret/token
+GITHUB_TOKEN=github_token - GitHub API token
+```
 
 ## About
-Github Labelbot is being developed as part of MI-PYT lecture at Faculty of Information technology, Czech Technical University in Prague.
+Github Labelbot is being developed as part of MI-PYT course at Faculty of Information technology, Czech Technical University in Prague.

labelbot/console.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+
+
+def run(labelbot, interval, repo_urls):
+    labelbot.interval = interval
+    labelbot.add_repos(repo_urls)
+    labelbot.run_scheduled()

labelbot/labelbot.py

@@ -22,27 +22,28 @@ class LabelBot(object):
     issue_comments_endpoint = urljoin(issue_endpoint,
                                       'comments')
 
-    def __init__(self, token_file, rules_file, default_label, interval,
+    def __init__(self, token_file, github_token, rules_file, default_label,
                  check_comments, skip_labeled):
         self.last_issue_checked = 0
+        self.iterval = 0
         self.scheduler = sched.scheduler(time.time, time.sleep)
         self.default_label = default_label
-        self.interval = interval
         self.check_comments = check_comments
         self.skip_labeled = skip_labeled
 
         # get GitHub token
-        self.token = self._get_token(token_file)
+        if github_token:
+            self.token = github_token
+        else:
+            self.token = self._get_token(token_file)
 
         # get request session and validate token
         self.session = self._get_requests_session(self.token)
 
         # load and validate rules
         self.rules = self._get_rules(rules_file)
 
-        # TODO check status_code
-        self.available_repos_json = self.session.get(
-            self.repos_endpoint).json()
+        self._update_accessible_repos()
 
     def add_repos(self, repos):
         """Check provided URLs are valid GitHub repositories.
@@ -65,16 +66,37 @@ def add_repos(self, repos):
 
         # start labeling issues in given repos
         for repo in repo_names:
-            self.scheduler.enter(0, 1, self._label_issues,
+            self.scheduler.enter(0, 1, self._label_repo,
                                  argument=(repo,))
 
-    def run(self):
+    def check_repo_accessible(self, repo):
+        """Updates list of available repos and checks whether given repo is
+        accessible by labelbot.
+
+        Args:
+            repo: full_name of github repository
+        """
+        # update available repos
+        self._update_accessible_repos()
+
+        if repo in [available_repo['full_name'] for available_repo
+                    in self.available_repos_json]:
+            return True
+        else:
+            return False
+
+    def _update_accessible_repos(self):
+        # TODO check status_code
+        self.available_repos_json = self.session.get(
+            self.repos_endpoint).json()
+
+    def run_scheduled(self):
         """Initiate labeling by running a scheduler"""
         self.scheduler.run()
 
-    def _label_issues(self, repo):
-        """Iterates through all issues in given repo, tries to match all rules
-        and sets a new labels if needed.
+    def _label_repo(self, repo, reschedule=True):
+        """Iterates through all issues in given repo and runs _label_issue() on
+        each of them.
 
         Args:
             repo: Full name of repository in form 'user/repo_name' as returned
@@ -98,53 +120,64 @@ def _label_issues(self, repo):
 
         # iterate through all isues
         for issue in issues:
-            labels_to_add = []
-            matched = False
-
-            # get existing label strings
-            existing_labels = [label['name'] for label in issue['labels']]
-
-            # skip this issue if it is already labeled and skip_labeled
-            # flag was used
-            if self.skip_labeled and len(existing_labels) > 0:
-                continue
-
-            # match rules in issue body and title
-            for rule in self.rules:
-                if rule.pattern.findall(issue['body'])\
-                        or rule.pattern.findall(issue['title']):
-                    labels_to_add.append(rule.label)
-                    matched = True
-
-            # match rules in issue comments if needed
-            if self.check_comments:
-                response = self.session.get(self.issue_comments_endpoint
-                                            .format(
-                                                issue=str(issue['number']),
-                                                repo=repo))
-                # TODO check status_code
-                comments = response.json()
-                for comment in comments:
-                    for rule in self.rules:
-                        if rule.pattern.findall(comment['body']):
-                            labels_to_add.append(rule.label)
-                            matched = True
-
-            # set default label if needed
-            if self.default_label and matched == 0:
-                labels_to_add.append(self.default_label)
-
-            # set new labels
-            labels_to_add = list(set(labels_to_add))  # make values unique
-            new_labels = existing_labels + labels_to_add
-            if not new_labels == existing_labels:
-                response = self.session.patch(self.issue_endpoint.format(
-                    issue=str(issue['number']), repo=repo),
-                    data=json.dumps({'labels': new_labels}))
+            self._label_issue(repo, issue)
 
         # run this again after given interval
-        self.scheduler.enter(self.interval, 1, self._label_issues,
-                             argument=(repo,))
+        if reschedule:
+            self.scheduler.enter(self.interval, 1, self._label_repo,
+                                 argument=(repo,))
+
+    def label_issue(self, repo, issue):
+        """Iterates through an issue and labels it.
+
+        Args:
+            repo: Full name of repository in form 'user/repo_name' as returned
+            by GitHub API
+            issue: json interpretation of issue as returned by GitHub API
+        """
+        labels_to_add = []
+        matched = False
+
+        # get existing label strings
+        existing_labels = [label['name'] for label in issue['labels']]
+
+        # skip this issue if it is already labeled and skip_labeled
+        # flag was used
+        if self.skip_labeled and len(existing_labels) > 0:
+            return
+
+        # match rules in issue body and title
+        for rule in self.rules:
+            if rule.pattern.findall(issue['body'])\
+                    or rule.pattern.findall(issue['title']):
+                labels_to_add.append(rule.label)
+                matched = True
+
+        # match rules in issue comments if needed
+        if self.check_comments:
+            response = self.session.get(self.issue_comments_endpoint
+                                        .format(
+                                            issue=str(issue['number']),
+                                            repo=repo))
+            # TODO check status_code
+            comments = response.json()
+            for comment in comments:
+                for rule in self.rules:
+                    if rule.pattern.findall(comment['body']):
+                        labels_to_add.append(rule.label)
+                        matched = True
+
+        # set default label if needed
+        if self.default_label and matched == 0:
+            labels_to_add.append(self.default_label)
+
+        # set new labels
+        labels_to_add = list(set(labels_to_add))  # make values unique
+        new_labels = existing_labels + labels_to_add
+        if not new_labels == existing_labels:
+            response = self.session.patch(self.issue_endpoint.format(
+                issue=str(issue['number']), repo=repo),
+                data=json.dumps({'labels': new_labels}))
 
     def _get_rules(self, rules_file):
         """Parse labeling rules from the provided file.

labelbot/main.py labelbot/run.pylabelbot/main.py renamed to labelbot/run.py

@@ -1,17 +1,20 @@
 #!/usr/bin/env python3
 
 import click
+import console as labelbot_console
+import os
 
 from labelbot import LabelBot, UrlParam
+from web import app
 
 
-@click.command()
+@click.group()
 @click.option('--token-file',
               '-t',
               type=click.Path(exists=True,
                               file_okay=True,
                               readable=True),
-              default='token.cfg',
+              default='token.cfg.sample',
               help='file containing GitHub token information')
 @click.option('--rules-file',
               '-u',
@@ -20,11 +23,10 @@
                               readable=True),
               default='rules.cfg.sample',
               help='file containing issues labeling rules')
-@click.option('--interval',
-              '-i',
-              type=int,
-              default=10,
-              help='time interval in seconds in which to check issues')
+@click.option('--github-token',
+              '-g',
+              help='github token used for authentication',
+              default=lambda: os.environ.get('GITHUB_TOKEN'))
 @click.option('--default-label',
               '-d',
               help='default label to use after no rule is matched')
@@ -36,16 +38,34 @@
               '-s',
               is_flag=True,
               help='skip labeling issues that already have any label')
+@click.pass_context
+def cli(ctx, token_file, github_token, rules_file, default_label,
+        check_comments, skip_labeled):
+    ctx.obj = LabelBot(token_file, github_token, rules_file, default_label,
+                       check_comments, skip_labeled)
+
+
+@cli.command(short_help='Run console daemon periodically checking issues')
+@click.option('--interval',
+              '-i',
+              type=int,
+              default=10,
+              help='time interval in seconds in which to check issues')
 @click.argument('repo_urls',
                 nargs=-1,
                 required=True,
                 type=UrlParam())
-def cli(repo_urls, token_file, rules_file, interval, default_label,
-        check_comments, skip_labeled):
-    labelbot = LabelBot(token_file, rules_file, default_label, interval,
-                        check_comments, skip_labeled)
-    labelbot.add_repos(repo_urls)
-    labelbot.run()
+@click.pass_obj
+def console(labelbot, interval, repo_urls):
+    labelbot_console.run(labelbot, interval, repo_urls)
+
+
+@cli.command(short_help='Run web API listening for issue updates')
+@click.pass_obj
+def web(labelbot):
+    port = int(os.environ.get('PORT', 80))
+    app.config['labelbot'] = labelbot
+    app.run(host='0.0.0.0', port=port, debug=True)
 
 if __name__ == '__main__':
     cli()

labelbot/static/custom.css

@@ -0,0 +1,66 @@
+/* Space out content a bit */
+body {
+  padding-top: 1.5rem;
+  padding-bottom: 1.5rem;
+}
+
+/* Everything but the jumbotron gets side spacing for mobile first views */
+.header,
+.marketing,
+.footer {
+  padding-right: 1rem;
+  padding-left: 1rem;
+}
+
+/* Custom page header */
+.header {
+  padding-bottom: 1rem;
+  border-bottom: .05rem solid #e5e5e5;
+}
+/* Make the masthead heading the same height as the navigation */
+.header h3 {
+  margin-top: 0;
+  margin-bottom: 0;
+  line-height: 3rem;
+}
+
+/* Custom page footer */
+.footer {
+  padding-top: 1.5rem;
+  color: #777;
+  border-top: .05rem solid #e5e5e5;
+}
+
+/* Customize container */
+@media (min-width: 48em) {
+  .container {
+    max-width: 46rem;
+  }
+}
+.container-narrow > hr {
+  margin: 2rem 0;
+}
+
+
+/* Supporting marketing content */
+.marketing {
+  margin: 3rem 0;
+}
+.marketing p + h4 {
+  margin-top: 1.5rem;
+}
+
+/* Responsive: Portrait tablets and up */
+@media screen and (min-width: 48em) {
+  /* Remove the padding we set earlier */
+  .header,
+  .marketing,
+  .footer {
+    padding-right: 0;
+    padding-left: 0;
+  }
+  /* Space out the masthead */
+  .header {
+    margin-bottom: 2rem;
+  }
+}