first working version

Author: tedivm

.gitignore

@@ -99,3 +99,5 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+.gitcredentials

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Robert Hafner
+Copyright (c) 2017 Robert Hafner <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,51 @@
-# GitByCommittee
+# GitConsensus
+
+This simple project allows github projects to be automated. It uses "reaction" as a voting mechanism to automatically
+merge (or close) pull requests.
+
+## Consensus Rules
+
+The file `.gitconsensus.yaml` needs to be placed in the repository to be managed. Any rule set to `false` or ommitted
+will be skipped.
+
+```yaml
+# minimum number of votes
+quorum: 5
+
+# Required percentage of "yes" votes
+threshold: 0.65
+
+# Only process votes by contributors
+contributors_only: false
+
+# Number of days after last commit before issue can be merged
+mergedelay: 3
+
+# Number of days after last commit before issue is autoclosed
+timeout: 3
+```
+
+## Authentication
+
+```shell
+gitconsensus auth
+```
+
+You will be asked for your username, password, and 2fa token (if configured). This will be used to get an authentication
+token from Github that will be used in place of your username and password (which are never saved).
+
+## Merge
+
+Merge all pull requests that meet consensus rules.
+
+```shell
+gitconsensus auth USERNAME REPOSITORY
+```
+
+## Merge
+
+Merge all pull requests that have passed the "timeout" date (if it is set).
+
+```shell
+gitconsensus close USERNAME REPOSITORY
+```

bin/gitconsensus

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# Get real directory in case of symlink
+if [[ -L "${BASH_SOURCE[0]}" ]]
+then
+  DIR="$( cd "$( dirname $( readlink "${BASH_SOURCE[0]}" ) )" && pwd )"
+else
+  DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+fi
+
+ENV="$DIR/../env/bin/activate"
+if [ ! -f $ENV ]; then
+    echo 'Virtual Environment Not Installed- Run `make`'
+    exit -1
+fi
+source $ENV
+
+SCRIPT="$DIR/../gitconsensus/gitconsensus"
+$SCRIPT "$@"

gitconsensus/__init__.py

@@ -0,0 +1,31 @@
+import os
+import yaml
+
+settings = False
+cwd = os.getcwd()
+path = "%s/%s" % (os.getcwd(), '/.gitconsensus.yaml')
+
+
+def getSettings():
+    global settings
+    return settings
+
+
+def reloadSettings():
+    global settings
+    if os.path.isfile(path):
+        with open(path, 'r') as f:
+            settings = yaml.load(f)
+    return settings
+
+
+def getGitToken():
+    token = id = ''
+    with open("%s/%s" % (os.getcwd(), '/.gitcredentials'), 'r') as fd:
+        return {
+            "id": fd.readline().strip(),
+            "token": fd.readline().strip()
+        }
+    return False
+
+reloadSettings()

gitconsensus/config.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+import click
+import github3
+import os
+import random
+from repository import Repository
+import string
+
+@click.group()
+@click.pass_context
+def cli(ctx):
+    if ctx.parent:
+        print(ctx.parent.get_help())
+
+
+@cli.command(short_help="obtain an authorization token")
+def auth():
+    username = click.prompt('Username')
+    password = click.prompt('Password', hide_input=True)
+    def twofacallback(*args):
+        return click.prompt('2fa Code')
+
+    hostid = ''.join(random.choice(string.ascii_lowercase + string.digits) for _ in range(8))
+    note = 'gitconsensus - %s' % (hostid,)
+    note_url = 'https://github.com/tedivm/GitConsensus'
+    scopes = ['repo']
+    auth = github3.authorize(username, password, scopes, note, note_url, two_factor_callback=twofacallback)
+
+    with open("%s/%s" % (os.getcwd(), '/.gitcredentials'), 'w') as fd:
+        fd.write(str(auth.id) + '\n')
+        fd.write(auth.token + '\n')
+
+
+@cli.command(short_help="list open pull requests and their status")
+@click.argument('username')
+@click.argument('repository_name')
+def list(username, repository_name):
+    repo = Repository(username, repository_name)
+    requests = repo.getPullRequests()
+    for request in requests:
+        print("PR#%s: %s" % (request.number, request.validate()))
+
+
+@cli.command(short_help="merge open pull requests that validate")
+@click.argument('username')
+@click.argument('repository_name')
+def merge(username, repository_name):
+    repo = Repository(username, repository_name)
+    requests = repo.getPullRequests()
+    for request in requests:
+        if request.validate():
+            print("Merging PR#%s" % (request.number,))
+            request.merge()
+
+
+@cli.command(short_help="close older unmerged opened pull requests")
+@click.argument('username')
+@click.argument('repository_name')
+def close(username, repository_name):
+    repo = Repository(username, repository_name)
+    requests = repo.getPullRequests()
+    for request in requests:
+        if request.shouldClose():
+            print("Closing PR#%s" % (request.number,))
+            request.pr.close()
+
+
+
+if __name__ == '__main__':
+    cli()

gitconsensus/gitconsensus

@@ -0,0 +1,137 @@
+import config
+import datetime
+import github3
+import json
+import requests
+import yaml
+
+def githubApiRequest(url):
+    auth = config.getGitToken()
+    headers = {
+        'Accept': 'application/vnd.github.squirrel-girl-preview',
+        'user-agent': 'gitconsensus',
+        'Authorization': "token %s" % (auth['token'],)
+    }
+    return requests.get(url, headers=headers)
+
+
+class Repository:
+
+    def __init__(self, user, repository):
+        self.user = user
+        self.name = repository
+        auth = config.getGitToken()
+        self.client = github3.login(token=auth['token'])
+        self.client.set_user_agent('gitconsensus')
+        self.repository = self.client.repository(self.user, self.name)
+        consensusurl = "https://raw.githubusercontent.com/%s/%s/master/.gitconsensus.yaml" % (self.user, self.name)
+        res = githubApiRequest(consensusurl)
+        self.rules = False
+        if res.status_code == 200:
+            self.rules = yaml.load(res.text)
+
+    def getPullRequests(self):
+        prs = self.repository.iter_pulls(state="open")
+        retpr = []
+        for pr in prs:
+            newpr = PullRequest(self, pr.number)
+            retpr.append(newpr)
+        return retpr
+
+
+class PullRequest:
+
+    def __init__(self, repository, number):
+        self.repository = repository
+        self.number = number
+        self.pr = self.repository.client.pull_request(self.repository.user, self.repository.name, number)
+
+        # https://api.github.com/repos/OWNER/REPO/issues/1/reactions
+        reacturl = "https://api.github.com/repos/%s/%s/issues/%s/reactions" % (self.repository.user, self.repository.name, self.number)
+        res = githubApiRequest(reacturl)
+        reactions = json.loads(res.text)
+
+        self.yes = []
+        self.no = []
+        self.users = []
+        for reaction in reactions:
+            content = reaction['content']
+            user = reaction['user']
+            if content == '+1':
+                self.yes.append(user['login'])
+            elif content == '-1':
+                self.no.append(user['login'])
+            else:
+                continue
+
+            if user['login'] not in self.users:
+                self.users.append(user['login'])
+
+    def daysSinceLastCommit(self):
+        commits = self.pr.iter_commits()
+
+        for commit in commits:
+            commit_date_string = commit._json_data['commit']['author']['date']
+
+        # 2017-08-19T23:29:31Z
+        commit_date = datetime.datetime.strptime(commit_date_string, '%Y-%m-%dT%H:%M:%SZ')
+        now = datetime.datetime.now()
+        delta = commit_date - now
+        return delta.days
+
+    def validate(self):
+        if self.repository.rules == False:
+            return False
+        consenttest = Consensus(self.repository.rules)
+        return consenttest.validate(self)
+
+    def shouldClose(self):
+        if 'timeout' in self.repository.rules:
+            if self.repository.rules['timeout'] < self.daysSinceLastCommit():
+                return True
+        return False
+
+    def merge(self):
+        self.pr.merge('Consensus Merge')
+
+
+
+class Consensus:
+    def __init__(self, rules):
+        self.rules = rules
+
+    def validate(self, pr):
+        if not self.isMergeable(pr):
+            return False
+        if not self.hasQuorum(pr):
+            return False
+        if not self.hasVotes(pr):
+            return False
+        if not self.hasAged(pr):
+            return False
+        return False
+
+    def isMergeable(self, pr):
+        if not pr.mergeable:
+            return False
+        return True
+
+    def hasQuorum(self, pr):
+        if 'quorum' in self.rules:
+            if len(pr.users) < self.rules['quorum']:
+                return False
+        return True
+
+    def hasVotes(self, pr):
+        if 'threshold' in self.rules:
+            ratio = len(pr.yes) / (len(pr.yes) + len(pr.no))
+            if ratio < self.rules['threshold']:
+                return False
+        return True
+
+    def hasAged(self, pr):
+        if 'mergedelay' in self.rules:
+            days = pr.daysSinceLastCommit()
+            if days < self.rules['mergdelay']:
+                return False
+        return True

gitconsensus/repository.py

@@ -0,0 +1,30 @@
+
+SHELL:=/bin/bash
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+
+.PHONY: all fresh dependencies install fulluninstall uninstall removedeps
+
+all: dependencies
+
+fresh: fulluninstall dependencies
+
+fulluninstall: uninstall cleancode
+
+install:
+	ln -s -f $(ROOT_DIR)/bin/gitconsensus /usr/local/bin/gitconsensus
+
+dependencies:
+	if [ ! -d $(ROOT_DIR)/env ]; then virtualenv $(ROOT_DIR)/env; fi
+	source $(ROOT_DIR)/env/bin/activate; yes w | pip install -r $(ROOT_DIR)/requirements.txt
+
+uninstall:
+	if [ -L /usr/local/bin/gitconsensus ]; then \
+		rm /usr/local/bin/gitconsensus; \
+	fi;
+
+cleancode:
+	rm -rf $(ROOT_DIR)/*.pyc
+	# Remove existing environment
+	if [ -d $(ROOT_DIR)/env ]; then \
+		rm -rf $(ROOT_DIR)/env; \
+	fi;

makefile

@@ -0,0 +1,4 @@
+click==0.5
+github3.py==0.9.6
+PyYAML==3.12
+requests==2.18.4