Merge branch 'features/requests' into devel

Author: guyzmo

README.md

@@ -48,9 +48,22 @@ and of course, you can delete it using:
 
     % git bb delete guyzmo/git-repo
 
-You can open the repository's page, using the `open` command:
+Once you're all set with your repository, you can check requests to merge 
+(aka Pull Requests on github) using the `request` command:
+
+    % git hub request guyzmo/git-repo list
+    List of open requests to merge:
+    id     title                                                           URL
+    2     prefer gitrepo.<target>.token > privatekey, docs                https://api.github.com/repos/guyzmo/git-repo/issues/2
+
+And fetch it locally to check and/or amend it before merging:
+
+    % git hub request guyzmo/git-repo fetch 2
+
+Finally, you can open the repository's page, using the `open` command:
 
     % git lab open guyzmo/git-repo
+    Successfully fetched branch `2` of `guyzmo/git-repo` into `request-2`!
 
 Finally, another extra feature you can play with is the gist handling:
 
@@ -210,9 +223,9 @@ To use your own credentials, you can setup the following environment variables:
   * [ ] gitlab support
   * [ ] bitbucket support
 * [ ] add support for handling pull requests
-  * [ ] list them
-  * [ ] fetch them as local branches
-  * [ ] github support
+  * [x] list them
+  * [x] fetch them as local branches
+  * [x] github support
   * [ ] gitlab support
   * [ ] bitbucket support
 * [ ] add OAuth support for bitbucket

git_repo/repo.py

@@ -8,6 +8,8 @@
     {self} [--path=<path>] [-v -v...] <target> create <user>/<repo> [--add]
     {self} [--path=<path>] [-v -v...] <target> delete <user>/<repo> [-f]
     {self} [--path=<path>] [-v -v...] <target> open [<user>/<repo>]
+    {self} [--path=<path>] [-v -v...] <target> request [<user>/<repo>] (list|ls)
+    {self} [--path=<path>] [-v -v...] <target> request [<user>/<repo>] fetch <request>
     {self} [--path=<path>] [-v -v...] <target> gist (list|ls) [<gist>]
     {self} [--path=<path>] [-v -v...] <target> gist clone <gist>
     {self} [--path=<path>] [-v -v...] <target> gist fetch <gist> [<gist_file>]
@@ -24,6 +26,7 @@
     create                   Make this repository a new remote on the service
     delete                   Delete the remote repository
     gist                     Manages gist files
+    request                  Handles requests for merge
     open                     Open the given or current repository in a browser
 
 Options:
@@ -159,7 +162,7 @@ def main(args):
             user = None
             repo = args['<user>/<repo>']
 
-        if args['create'] and not args['gist'] or args['add'] or args['delete'] and not args['gist'] or args['open']:
+        if args['create'] and not args['gist'] or args['add'] or args['delete'] and not args['gist'] or args['open'] or args['request']:
             # Try to resolve existing repository path
             try:
                 try:
@@ -202,6 +205,20 @@ def main(args):
                     service.name)
                 )
 
+            elif args['request']:
+                if args['list'] or args['ls']:
+                    log.info('List of open requests to merge:')
+                    log.info(" {}\t{}\t{}".format('id', 'title'.ljust(60), 'URL'))
+                    for pr in service.request_list(user, repo):
+                        print("{}\t{}\t{}".format(pr[0].rjust(3), pr[1][:60].ljust(60), pr[2]))
+                elif args['fetch'] and args['<request>']:
+                    new_branch = service.request_fetch(user, repo, args['<request>'])
+                    log.info('Successfully fetched request id `{}` of `{}` into `{}`!'.format(
+                        args['<request>'],
+                        args['<user>/<repo>'],
+                        new_branch)
+                    )
+
             elif args['open']:
                 RepositoryService.get_service(None, args['<target>']).open(user, repo)
 

git_repo/services/ext/github.py

@@ -8,6 +8,8 @@
 
 import github3
 
+from git.exc import GitCommandError
+
 @register_target('hub', 'github')
 class GithubService(RepositoryService):
     fqdn = 'github.com'
@@ -147,6 +149,32 @@ def gist_delete(self, gist_id):
             raise ResourceNotFoundError('Could not find gist')
         gist.delete()
 
+    def request_list(self, user, repo):
+        repository = self.gh.repository(user, repo)
+        for pull in repository.iter_pulls():
+            yield ( pull.number, pull.title, pull.links['issue'] )
+
+    def request_fetch(self, user, repo, request, pull=False):
+        if pull:
+            raise NotImplementedError('Pull operation on requests for merge are not yet supported')
+        log.info('remotes: {}'.format(self.repository.remotes))
+        try:
+            for remote in self.repository.remotes:
+                log.info('request_fetch, remote_name {}'.format(remote.name))
+                if remote.name == self.name:
+                    local_branch_name = 'request-{}'.format(request)
+                    self.fetch(
+                        remote,
+                        'pull/{}/head'.format(request),
+                        local_branch_name
+                    )
+                    return local_branch_name
+            else:
+                raise ResourceNotFoundError('Could not find remote {}'.format(self.name))
+        except GitCommandError as err:
+            if 'Error when fetching: fatal: Couldn\'t find remote ref' in err.command[0]:
+                raise ResourceNotFoundError('Could not find opened request #{}'.format(request)) from err
+            raise err
 
     @property
     def user(self):

git_repo/services/service.py

@@ -199,7 +199,17 @@ def pull(self, remote, branch=None):
             remote.pull(progress=pb)
         print()
 
-    def clone(self, user, repo, branch='master'):
+    def fetch(self, remote, remote_branch, local_branch):
+        '''Pull a repository
+        :param remote: git-remote instance
+        :param branch: name of the branch to pull
+        '''
+        pb = ProgressBar()
+        pb.setup(self.name)
+        remote.fetch(':'.join([remote_branch, local_branch]), progress=pb)
+        print()
+
+    def clone(self, user, repo, branch='master', rw=True):
         '''Clones a new repository
 
         :param user: namespace of the repository
@@ -212,10 +222,10 @@ def clone(self, user, repo, branch='master'):
         '''
         log.info('Cloning {}…'.format(repo))
 
-        remote = self.add(user=user, repo=repo, tracking=True)
+        remote = self.add(user=user, repo=repo, tracking=True, rw=rw)
         self.pull(remote, branch)
 
-    def add(self, repo, user=None, name=None, tracking=False, alone=False):
+    def add(self, repo, user=None, name=None, tracking=False, alone=False, rw=True):
         '''Adding repository as remote
 
         :param repo: Name slug of the repository to add
@@ -252,16 +262,16 @@ def add(self, repo, user=None, name=None, tracking=False, alone=False):
         if not alone:
             # if remote all does not exists
             if not all_remote:
-                self.repository.create_remote('all', self.format_path(repo, user, rw=True))
+                self.repository.create_remote('all', self.format_path(repo, user, rw=rw))
             else:
                 url = self.format_path(repo, user, rw=True)
                 # check if url not already in remote all
                 if url not in all_remote.list:
-                    all_remote.set_url(url=self.format_path(repo, user, rw=True), add=True)
+                    all_remote.set_url(url=self.format_path(repo, user, rw=rw), add=True)
 
         # adding "self" as the tracking remote
         if tracking:
-            remote = self.repository.create_remote(name, self.format_path(repo, user, rw=True))
+            remote = self.repository.create_remote(name, self.format_path(repo, user, rw=rw))
             # lookup tracking branch (usually master)
             for branch in self.repository.branches:
                 if tracking == branch.name:
@@ -270,7 +280,7 @@ def add(self, repo, user=None, name=None, tracking=False, alone=False):
                     break
             return remote
         else:
-            return self.repository.create_remote(name, self.format_path(repo, user, rw=True))
+            return self.repository.create_remote(name, self.format_path(repo, user, rw=rw))
 
     def open(self, user=None, repo=None):
         '''Open the URL of a repository in the user's browser'''
@@ -332,7 +342,6 @@ def gist_clone(self, gist): #pragma: no cover
         '''
         raise NotImplementedError
 
-
     def gist_create(self, gist_path, secret=False): #pragma: no cover
         '''Pushes a new gist
 
@@ -347,6 +356,25 @@ def gist_delete(self, gist_path, secret=False): #pragma: no cover
         '''
         raise NotImplementedError
 
+    def request_list(self, user, repo): #pragma: no cover
+        '''Lists all available request for merging code
+        sent to the remote repository
+
+        :param repo: name of the repository to create
+
+        Meant to be implemented by subclasses
+        '''
+        raise NotImplementedError
+
+    def request_fetch(self, user, repo, request, pull=False): #pragma: no cover
+        '''Fetches given request as a branch, and switch if pull is true
+
+        :param repo: name of the repository to create
+
+        Meant to be implemented by subclasses
+        '''
+        raise NotImplementedError
+
     @property
     def user(self): #pragma: no cover
         raise NotImplementedError

tests/helpers.py

@@ -30,6 +30,8 @@ def __init__(self, *args, **kwarg):
         self._did_gist_clone = None
         self._did_gist_create = None
         self._did_gist_delete = None
+        self._did_request_list = None
+        self._did_request_fetch = None
 
     def pull(self, *args, **kwarg):
         self._did_pull = (args, kwarg)
@@ -94,6 +96,18 @@ def gist_delete(self, *args, **kwarg):
         if args[0] == 'bad':
             raise Exception('bad gist!')
 
+    def request_list(self, *args, **kwarg):
+        self._did_request_list = (args, kwarg)
+        return [('1', 'desc1', 'http://request/1'),
+                ('2', 'desc2', 'http://request/2'),
+                ('3', 'desc3', 'http://request/3')]
+
+    def request_fetch(self, *args, **kwarg):
+        self._did_request_fetch = (args, kwarg)
+        if args[-1] == 'bad':
+            raise Exception('bad request for merge!')
+        return "pr/42"
+
     @property
     def user(self):
         self._did_user = True
@@ -152,6 +166,8 @@ def setup_args(self, d, args={}):
             '<gist>': None,
             '<gist_file>': None,
             '<gist_path>': [],
+            'request': False,
+            '<request>': None,
             '<user>/<repo>': None,
         }
         cli_args.update(d)
@@ -247,6 +263,26 @@ def main_gist_delete(self, rc=0, args={}):
         }, args)), "Non {} result for gist delete".format(rc)
         return RepositoryService._current._did_gist_delete
 
+    def main_request_list(self, repo, rc=0, args={}):
+        assert rc == main(self.setup_args({
+            'request': True,
+            'list': True,
+            '<user>/<repo>': repo,
+            '--clone': True,
+            '--path': self.tempdir.name
+        }, args)), "Non {} result for request list".format(rc)
+        return RepositoryService._current._did_request_list
+
+    def main_request_fetch(self, repo, rc=0, args={}):
+        assert rc == main(self.setup_args({
+            'request': True,
+            'fetch': True,
+            '<user>/<repo>': repo,
+            '--clone': True,
+            '--path': self.tempdir.name
+        }, args)), "Non {} result for request fetch".format(rc)
+        return RepositoryService._current._did_request_fetch
+
     def main_open(self, repo, rc=0, args={}):
         os.mkdir(os.path.join(self.tempdir.name, repo.split('/')[-1]))
         Repo.init(os.path.join(self.tempdir.name, repo.split('/')[-1]))
@@ -506,7 +542,7 @@ def action_request_list(self, cassette_name, namespace, repository, rq_list_data
     def action_request_fetch(self, cassette_name, namespace, repository, request, pull=False):
         with self.recorder.use_cassette('_'.join(['test', self.service.name, cassette_name])):
             self.service.connect()
-            self.service.clone(namespace, repository)
+            self.service.clone(namespace, repository, rw=False)
             self.service.request_fetch(repository, namespace, request)
             assert self.repository.branches[-1].name == 'request-{}'.format(request)
 

tests/integration/cassettes/test_github_test_14_request_fetch.json

@@ -0,0 +1,62 @@
+{
+  "http_interactions": [
+    {
+      "recorded_at": "2016-05-12T17:07:00",
+      "request": {
+        "body": {
+          "encoding": "utf-8",
+          "string": ""
+        },
+        "headers": {
+          "Accept": "application/vnd.github.v3.full+json",
+          "Accept-Charset": "utf-8",
+          "Accept-Encoding": "identity",
+          "Authorization": "token <PRIVATE_KEY_GITHUB>",
+          "Connection": "keep-alive",
+          "Content-Type": "application/json",
+          "User-Agent": "github3.py/0.9.5"
+        },
+        "method": "GET",
+        "uri": "https://api.github.com/user"
+      },
+      "response": {
+        "body": {
+          "encoding": "utf-8",
+          "string": "{\"login\":\"<GITHUB_NAMESPACE>\",\"id\":254441,\"avatar_url\":\"https://avatars.githubusercontent.com/u/254441?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>\",\"html_url\":\"https://github.com/<GITHUB_NAMESPACE>\",\"followers_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/followers\",\"following_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/subscriptions\",\"organizations_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/orgs\",\"repos_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/repos\",\"events_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/<GITHUB_NAMESPACE>/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"<GITHUB_NAMESPACE>\",\"company\":null,\"blog\":\"http://<GITHUB_NAMESPACE>.got.nothing.to/blog/\",\"location\":\"Paris\",\"email\":null,\"hireable\":true,\"bio\":null,\"public_repos\":72,\"public_gists\":10,\"followers\":44,\"following\":13,\"created_at\":\"2010-04-27T14:04:09Z\",\"updated_at\":\"2016-03-26T00:48:05Z\"}"
+        },
+        "headers": {
+          "Access-Control-Allow-Origin": "*",
+          "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval",
+          "Cache-Control": "private, max-age=60, s-maxage=60",
+          "Content-Length": "1118",
+          "Content-Security-Policy": "default-src 'none'",
+          "Content-Type": "application/json; charset=utf-8",
+          "Date": "Thu, 12 May 2016 17:07:08 GMT",
+          "ETag": "\"0aa481b18bc60170aa178c9983d294fc\"",
+          "Last-Modified": "Sat, 26 Mar 2016 00:48:05 GMT",
+          "Server": "GitHub.com",
+          "Status": "200 OK",
+          "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
+          "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP",
+          "X-Accepted-OAuth-Scopes": "",
+          "X-Content-Type-Options": "nosniff",
+          "X-Frame-Options": "deny",
+          "X-GitHub-Media-Type": "github.v3; param=full; format=json",
+          "X-GitHub-Request-Id": "4EC11365:CA11:CB5BF38:5734B83C",
+          "X-OAuth-Scopes": "delete_repo, gist, repo",
+          "X-RateLimit-Limit": "5000",
+          "X-RateLimit-Remaining": "4997",
+          "X-RateLimit-Reset": "1463075761",
+          "X-Served-By": "a474937f3b2fa272558fa6dc951018ad",
+          "X-XSS-Protection": "1; mode=block"
+        },
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "url": "https://api.github.com/user"
+      }
+    }
+  ],
+  "recorded_with": "betamax/0.5.1"
+}