ghhelper.py

import requests
from time import sleep
import ipdb
import time
import datetime
import sys

# TODO Move this to some utils file

def AsJSON(apiresponse):
	return json.loads(apiresponse.content)


class GithubClient:

	credentials = {}
	ignoring_errors = False
	api_base = "https://api.github.com"
	default_headers = {'User-Agent': "LOG6307-team-project", 'Accept': 'application/vnd.github.v3.raw+json'}
	verbose = False # For debugging
	
	# GitHub requests limits info
	limit=0
	remaining=0
	resetTime=0

	def __init__(self, credentials=None, verbose=False, ignoring_errors=False):
		if not credentials:
			raise Exception("Credentials must be provided, fill keysconfig.txt")
		self.credentials = credentials
		self.verbose = verbose
		self.ignoring_errors = ignoring_errors

		# We first get the api requests limit
		self.get_rate_limit_info()
		resetTime = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(self.resetTime))
		print "GitHub api request limit info:\nlimit : %s\nremaining : %s\nreset : %s\n"%(self.limit, self.remaining, resetTime)


	def make_request(self, resource_uri, headers=''):

		if not headers:
			headers = self.default_headers		

		# Sign and make request
		if self.verbose:
			print "Fetching %s" % resource_uri
		auth=(self.credentials["username"], self.credentials["oauth_token"])

		if self.remaining <= 0:
			print "GitHub api request limit reached."
			self.wait_for_limit_reset()

		response = requests.get(resource_uri, auth=auth, headers=headers)

		if response.status_code == 404:
			response = None
		elif response.status_code != 200:
			if not self.ignoring_errors:
				print "Status code returned was not 200, setting breakpoint. set ignoring_errors to True to ignore and keep going"
				ipdb.set_trace()
			else:
				print "Status code : %s\tContent : %s"%(response.status_code, response.text)
		#sleep(0.1)
		self.remaining = self.remaining - 1
		return response

	# Specific resources begin here
	def get_pull_request_for_repo(self, user_repo):
		query = '%s/repos/%s/pulls?state=all&per_page=100'%(self.api_base, user_repo)
		response = self.make_request(query)
		return response

	def get_single_pull_request(self, user_repo, pull_id):
		query = '%s/repos/%s/pulls/%s'%(self.api_base, user_repo, int(pull_id))
		response = self.make_request(query)
		return response

	def get_repo_comments(self, user_repo):
		query = "%s/repos/%s/comments?per_page=100"%(self.api_base,user_repo)
		response = self.make_request(query)
		return response

	def get_pull_request_comments(self, user_repo):
		query = "%s/repos/%s/pulls/comments?per_page=100"%(self.api_base,user_repo)
		response = self.make_request(query)
		return response

	def get_pull_request_commits(self, user_repo, pull_id):
		query = "%s/repos/%s/pulls/%s/commits?per_page=100"%(self.api_base,user_repo, pull_id)
		response = self.make_request(query)
		return response

	def get_issue_comments(self, user_repo):
		query = "%s/repos/%s/issues/comments?per_page=100"%(self.api_base,user_repo)
		response = self.make_request(query)
		return response

	def get_single_commit(self, user_repo, commit_sha):
		query = "%s/repos/%s/git/commits/%s"%(self.api_base,user_repo,commit_sha)
		response = self.make_request(query)
		return response

	def check_rate_limit(self):
		query = "%s/rate_limit?"%(self.api_base)
		auth=(self.credentials["username"], self.credentials["oauth_token"])
		response = requests.get(query, auth=auth, headers=self.default_headers)
		return response

	def get_rate_limit_info(self):
		response = self.check_rate_limit()
		if response != None and response.status_code == 200:
			self.limit = response.json()["rate"]["limit"]
			self.remaining = response.json()["rate"]["remaining"]
			self.resetTime = response.json()["rate"]["reset"]

	def wait_for_limit_reset(self):
		# We wait the specified amount of time if the api request limit is reached
		resetTime = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(self.resetTime))
		print "The limit will be reset at : %s"%(resetTime)
		waitTime = self.resetTime - time.time()
		while waitTime > 0:
			remaining = datetime.timedelta(seconds=waitTime)
			print "Remaining : %s"%(str(remaining))
			sleep(min(10*60, waitTime))
			waitTime = waitTime - 10*60
		self.get_rate_limit_info()