EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removing vcs contribution backends. Their last usage was removed in commit 44061e62b9.

front-end-standardization
Gregor Müllegger 2015-06-25 11:48:06 +02:00
parent b4c6c7bcd7
commit 9ab7862d6b
5 changed files with 0 additions and 257 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
readthedocs/projects/models.py
View File

@ -634,17 +634,6 @@ class Project(models.Model):
repo = backend(proj, version)
return repo
@property
def contribution_backend(self):
if hasattr(self, '_contribution_backend'):
return self._contribution_backend
if not self.vcs_repo:
cb = None
else:
cb = self.vcs_repo.get_contribution_backend()
self._contribution_backend = cb
return cb
def repo_nonblockinglock(self, version, max_lock_age=5):
return NonBlockingLock(project=self, version=version, max_lock_age=max_lock_age)

2
readthedocs/vcs_support/backends/git.py
View File

@ -5,7 +5,6 @@ import os
from StringIO import StringIO
from projects.exceptions import ProjectImportError
from vcs_support.backends.github import GithubContributionBackend
from vcs_support.base import BaseVCS, VCSVersion
log = logging.getLogger(__name__)
@ -14,7 +13,6 @@ log = logging.getLogger(__name__)
class Backend(BaseVCS):
supports_tags = True
supports_branches = True
contribution_backends = [GithubContributionBackend]
fallback_branch = 'master' # default branch

183
readthedocs/vcs_support/backends/github.py
View File

@ -1,183 +0,0 @@
import logging
import base64
import os
import urllib
import urllib2
from django.conf import settings
from github2.client import Github
from vcs_support.base import BaseContributionBackend
log = logging.getLogger(__name__)
GITHUB_URLS = ('git://github.com', 'https://github.com', 'http://github.com')
GITHUB_TOKEN = getattr(settings, 'GITHUB_TOKEN', None)
GITHUB_USERNAME = getattr(settings, 'GITHUB_USERNAME', None)
GITHUB_OKAY = GITHUB_TOKEN and GITHUB_USERNAME
class GithubContributionBackend(BaseContributionBackend):
fallback_branch = 'master'
def __init__(self, *args, **kwargs):
super(GithubContributionBackend, self).__init__(*args, **kwargs)
self.gh = Github(username=GITHUB_USERNAME, api_token=GITHUB_TOKEN)
def run(self, *args):
log.debug(args)
ret = super(GithubContributionBackend, self).run(*args)
log.debug(ret)
return ret
@classmethod
def accepts(cls, url):
return url.startswith(GITHUB_URLS) and GITHUB_OKAY
def get_branch_identifier(self, branch):
identifier = 'rtd-%s-%s' % (branch.user.username, branch.pk)
if self._branch_exists(identifier):
return identifier
self.create_branch(identifier)
return identifier
def branch_exists(self, identifier):
return identifier in self.run('git', 'branch')[1]
def create_branch(self, identifier):
self.repo.update()
branch = self.fallback_branch
if self.default_branch:
branch = self.default_branch
self.run('git', 'branch', '--track', identifier, branch)
def get_branch_file(self, branch, filename):
"""
git show branch:file
"""
identifier = self.get_branch_identifier(branch)
return self.run('git', 'show', '%s:%s' % (identifier, filename))[1]
def set_branch_file(self, branch, filename, contents, comment=''):
"""
git checkout branch
git commit --author "Name Surname <email@address.com>" -m comment
git checkout master
"""
identifier = self.get_branch_identifier(branch)
self.run('git', 'checkout', identifier)
with self._open_file(filename, 'wb') as fobj:
fobj.write(contents)
self.run('git', 'add', filename)
if not comment:
comment = 'no comment'
name, email = branch.user.get_profile().get_contribution_details()
author = u"%s <%s>" % (name, email)
self.run('git', 'commit', '-m', comment, '--author', author)
branch = self.fallback_branch
if self.default_branch:
branch = self.default_branch
self.run('git', 'checkout', branch)
def push_branch(self, branch, title='', comment=''):
"""Pushes a branch upstream.
Since the python github API libraries don't support pull requests,
we'll have to do it manually using urllib2 :(
"""
identifier = self.get_branch_identifier(branch)
log.info('pushing branch %s in %s' % (identifier, self._gh_name()))
# first push the branch to the rtd-account on github.
self.check_remote()
self.push_remote(identifier)
# now make the pull request.
if not title:
title = 'Documentation changes from readthedocs.org'
if not comment:
comment = 'These changes have been done on readthedocs.org'
self.pull_request(identifier, title, comment)
self.run('git', 'branch', '-D', identifier)
def pull_request(self, identifier, title, comment):
"""
Open an actual pull request
"""
log.info('pull request %s:%s to %s (%s/%s)' % (
GITHUB_USERNAME, identifier, self.gh_name(), title, comment))
url = 'https://github.com/api/v2/json/pulls/%s' % self._gh_name()
log.debug(url)
request = urllib2.Request(url)
auth = base64.encodestring('%s/token:%s' % (GITHUB_USERNAME,
GITHUB_TOKEN))[:-1]
request.add_header("Authorization", 'Basic %s' % auth)
branch = self.fallback_branch
if self.default_branch:
branch = self.default_branch
data = {
'base': branch,
'head': '%s:%s' % (GITHUB_USERNAME, identifier),
'title': title,
'body': comment,
}
pull_request_data = [("pull[%s]" % k, v) for k, v in data.items()]
postdata = urllib.urlencode(pull_request_data)
log.debug('postdata: %s' % postdata)
handler = urllib2.urlopen(request, postdata)
log.debug(handler.headers.dict)
log.debug(handler.read())
def gh_name(self):
return '%s/%s' % (self.gh_user(), self.gh_reponame())
def gh_user(self):
return self.repo_url.split('/')[-2]
def gh_reponame(self):
name = self.repo_url.split('/')[-1]
if name.endswith('.git'):
return name[:-4]
return name
def check_remote(self):
"""
Check if the RTD remote is available in this repository, if not,
add it.
"""
log.info('checking remote')
if not self.has_fork():
log.info('no fork available')
self.fork()
else:
log.info('fork found')
if 'rtd' not in self.run('git', 'remote')[1]:
log.info('rtd remote not yet specified')
self.run('git', 'remote', 'add', 'rtd', self.get_remote_name())
else:
log.info('rtd remote found')
def get_remote_name(self):
return 'git@github.com:%s/%s.git' % (
GITHUB_USERNAME, self.gh_reponame())
def push_remote(self, identifier):
"""
push a local branch to the RTD remote
"""
log.info('pushing %s to remote %s' % (identifier,
self.get_remote_name()))
self.run('git', 'push', 'rtd', identifier)
def has_fork(self):
return self.gh_reponame() in [
r.name for r in self.gh.repos.list(GITHUB_USERNAME)]
def fork(self):
log.info('forking %s to %s' % (self.gh_name(), GITHUB_USERNAME))
log.info(self.gh.repos.fork(self.gh_name()))
@property
def env(self):
env = super(GithubContributionBackend, self).env
env['GIT_DIR'] = os.path.join(self.working_dir, '.git')
return env

60
readthedocs/vcs_support/base.py
View File

@ -5,7 +5,6 @@ import subprocess
from collections import namedtuple
from os.path import basename
from django.template.defaultfilters import slugify
log = logging.getLogger(__name__)
@ -81,7 +80,6 @@ class BaseVCS(BaseCLI):
"""
supports_tags = False # Whether this VCS supports tags or not.
supports_branches = False # Whether this VCS supports branches or not.
contribution_backends = []
#==========================================================================
# General methods
@ -150,61 +148,3 @@ class BaseVCS(BaseCLI):
backend is responsible to understand it's identifiers.
"""
self.check_working_dir()
#==========================================================================
# Contribution related methods
# These methods only apply if supports_contribution = True
#==========================================================================
def get_contribution_backend(self):
"""
Returns a contribution backend or None for this repository. The backend
is detected via the repository URL.
"""
for backend in self.contribution_backends:
if backend.accepts(self.repo_url):
return backend(self)
return None
class BaseContributionBackend(BaseCLI):
"""
Base class for contribution backends.
The main purpose of this base class is to define the API.
"""
def __init__(self, repo):
self.repo = repo
self.slug = slugify(repo.name)
self.default_branch = repo.default_branch
self.repo_url = repo.repo_url
self.working_dir = repo.working_dir
@classmethod
def accepts(cls, url):
"""
Classmethod that checks if a given repository URL is supported by this
backend.
"""
return False
def get_branch_file(self, branch, filename):
"""
Returns the contents of a file as it is in the specified branch.
"""
raise NotImplementedError
def set_branch_file(self, branch, filename, contents, comment=''):
"""
Saves the file in the specified branch.
"""
raise NotImplementedError
def push_branch(self, branch, title='', comment=''):
"""
Pushes a branch upstream.
"""
raise NotImplementedError
def _open_file(self, filename, mode='r'):
return open(os.path.join(self.repo.working_dir, filename), mode)

1
requirements/pip.txt
View File

@ -39,7 +39,6 @@ django-allauth==0.16.1
# VCS
bzr==2.5b4
mercurial==2.6.3
github2==0.5.2
httplib2==0.7.7
# Search