Merge branch 'devel' ; Version bump to 1.6.0!

* Adding gist feature support
* Adding request for merges feature support
* Applied PR #2 and #3 (token and documentation updates)
* Applied fix for issues #7 and #8, thanks to patch applied on upstream
* Improved testing framework (removed dep to unittest, and made it to
  work for travis and locally in a smoother way)
* Version pinning for important deps to avoid uncontrolled breakage in
  the future

Author: guyzmo

README.md

@@ -48,9 +48,55 @@ and of course, you can delete it using:
 
     % git bb delete guyzmo/git-repo
 
+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:
+
+    % git hub gist list
+    id                                                              title
+    https://gist.github.com/4a0dd9177524b2b125e9166640666737        This is a test gist
+
+Then you can list files within it:
+
+    % git hub gist list a7ce4fddba7744ddf335
+    language         size  name
+    Python           1048  unicode_combined.py
+    % git hub -v gist list https://gist.github.com/4a0dd9177524b2b125e9166640666737
+    language         size  name
+    Markdown         16    README.md
+    Text             14    LICENSE
+    reStructuredText 17    README.rst
+
+to output it locally, you can use the fetch command (and specify the file if there's more than one):
+
+    % git hub gist fetch https://gist.github.com/a7ce4fddba7744ddf335 > mygist.py
+    % git hub gist fetch 4a0dd9177524b2b125e9166640666737 LICENSE > LICENSE_from_gist
+
+but for more thorough modifications or consulting, you can as well clone it:
+
+    % git hub gist clone 4a0dd9177524b2b125e9166640666737
+    Pulling from github |████████████████████████████████|
+    Successfully cloned `4a0dd9177524b2b125e9166640666737` into `./4a0dd9177524b2b125e9166640666737`!
+
+And when you're done you just get rid of it:
+
+    % git hub gist -f delete 4a0dd9177524b2b125e9166640666737
+    Successfully deleted gist!
 
 > *Nota Bene*: Thanks to `git` CLI flexibility, by installing `git-repo` you directly
 > have acces to the tool using `git-repo hub …` or `git repo hub …`. For the
@@ -77,13 +123,13 @@ To configure `git-repo` you need to tweak your `~/.gitconfig`. For each service
 you've got an account on, you have to make a section in the gitconfig:
 
     [gitrepo "gitlab"]
-        private_token = YourVerySecretKey
+        token = YourVerySecretKey
 
     [gitrepo "github"]
-        private_token = YourOtherVerySecretKey
+        token = YourOtherVerySecretKey
 
     [gitrepo "bitbucket"]
-        private_token = username:password
+        token = username:password
 
 Here, we're setting the basics: just the private token. You'll notice that for bitbucket
 the private token is your username and password seperated by a column. That's because
@@ -94,7 +140,7 @@ You also have the ability to set up an alias:
 
     [gitrepo "bitbucket"]
         alias = bit
-        private_token = username:password
+        token = username:password
 
 that will change the command you use for a name you'll prefer to handle actions
 for the service you use:
@@ -105,7 +151,7 @@ Also, you can setup your own gitlab self-hosted server, using that configuration
 
     [gitrepo "myprecious"]
         type = gitlab
-        private_token = YourSuperPrivateKey
+        token = YourSuperPrivateKey
         fqdn = gitlab.example.org
 
 Finally, to make it really cool, you can make a few aliases in your gitconfig:
@@ -173,13 +219,20 @@ To use your own credentials, you can setup the following environment variables:
 * [x] add regression tests (and actually find a smart way to implement them…)
 * [x] add travis build
 * [ ] add support for handling gists
-* [ ] add support for handling pull requests 
-  * [ ] list them
-  * [ ] fetch them as local branches
+  * [x] github support
+  * [ ] gitlab support
+  * [ ] bitbucket support
+* [ ] add support for handling pull requests
+  * [x] list them
+  * [x] fetch them as local branches
+  * [x] github support
+  * [ ] gitlab support
+  * [ ] bitbucket support
 * [ ] add OAuth support for bitbucket
 * [ ] show a nice progress bar, while it's fetching
   * partly implemented: the issue looks like that gitpython expects output from git
     on stderr, whereas it's outputing on stdout.
+* [ ] do what's needed to make a nice documentation (if possible in markdown !@#$)
 * for more features, write an issue or, even better, a PR!
 
 ### License

buildout.cfg

@@ -7,7 +7,9 @@ develop = .
 eggs-directory     = ${buildout:directory}/var/eggs
 develop-eggs-directory = ${buildout:directory}/var/develop-eggs
 parts-directory    = ${buildout:directory}/var/parts
-#develop-dir        = ${buildout:directory}/var/clone/
+develop-dir        = ${buildout:directory}/var/clone/
+extensions=gp.vcsdevelop
+vcs-extend-develop=git+https://github.com/gitpython-developers/GitPython#egg=GitPython
 
 [git_repo]
 recipe = zc.recipe.egg
@@ -22,7 +24,8 @@ eggs = pytest
        pytest-cov
        pytest-xdist
        pytest-sugar
-       pytest-capturelog
+       pytest-catchlog
+       pytest-datadir-ng
        testfixtures
        mock
        betamax==0.5.1

git_repo/repo.py

@@ -8,6 +8,13 @@
     {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>]
+    {self} [--path=<path>] [-v -v...] <target> gist create [--secret] <description> [<gist_path> <gist_path>...]
+    {self} [--path=<path>] [-v -v...] <target> gist delete <gist> [-f]
     {self} --help
 
 Tool for managing remote repository services.
@@ -18,15 +25,13 @@
     fork                     Fork (and clone) the repository from the service
     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:
     <user>/<repo>            Repository to work with
-    <branch>                 Branch to pull (when cloning) [default: master]
     -p,--path=<path>         Path to work on [default: .]
-    -f,--force               Do not ask for confirmation
-    --clone                  Clone locally after fork
-    --add                    Add to local repository after creation
     -v,--verbose             Makes it more chatty (repeat twice to see git commands)
     -h,--help                Shows this message
 
@@ -35,22 +40,41 @@
     -t,--tracking <branch>   Makes this remote tracking for the current branch
     -a,--alone               Does not add the remote to the 'all' remote
 
+Options for fork and clone:
+    <branch>                 Branch to pull (when cloning) [default: master]
+    --clone                  Clone locally after fork
+
+Options for create:
+    --add                    Add to local repository after creation
+
+Options for delete:
+    -f,--force               Do not ask for confirmation
+
+Options for gist:
+    <gist>                   Identifier of the gist to fetch
+    <gist_file>              Name of the file to fetch
+    <gist_path>              Name of the file or directory to use for a new gist.
+                             If path is a directory, all files directly within it
+                             will be pushed. If a list of path is given, all files
+                             from them will be pushed.
+    --secret                 Do not publicize gist when pushing
+
 Configuration options:
     alias                    Name to use for the git remote
     url                      URL of the repository
-    private-key              Private key to use for connecting to the service
+    fqdn                     URL of the repository
     type                     Name of the service to use (github, gitlab, bitbucket)
 
 Configuration example:
 
 [gitrepo "gitlab"]
-    private-key = YourSecretKey
+    token = yourapitoken
     alias = lab
 
 [gitrepo "personal"]
     type = gitlab
-    private-key = YourSecretKey
-    url = http://custom.org
+    token = yourapitoken
+    fqdn = custom.org
 
 {self} version {version}, Copyright ⓒ2016 Bernard `Guyzmo` Pratz
 {self} comes with ABSOLUTELY NO WARRANTY; for more informations
@@ -83,6 +107,19 @@
 from git import Repo, Git
 from git.exc import InvalidGitRepositoryError, NoSuchPathError
 
+def confirm(what, where):
+    ans = input('Are you sure you want to delete the '
+                '{} {} from the service?\n[yN]> '.format(what, where))
+    if 'y' in ans:
+        ans = input('Are you really sure? there\'s no coming back!\n'
+                    '[type \'burn!\' to proceed]> ')
+        if 'burn!' != ans:
+            return False
+    else:
+        return False
+    return True
+
+
 def main(args):
     try:
         if args['--verbose'] >= 5:  # pragma: no cover
@@ -116,7 +153,7 @@ def main(args):
         if 'GIT_WORK_TREE' in os.environ.keys() or 'GIT_DIR' in os.environ.keys(): #pragma: no cover
             del os.environ['GIT_WORK_TREE']
 
-        if '/' in args['<user>/<repo>']:
+        if args['<user>/<repo>'] and '/' in args['<user>/<repo>']:
             if len(args['<user>/<repo>'].split('/')) > 2:
                 raise ArgumentError('Too many slashes.'
                                     'Format of the parameter is <user>/<repo> or <repo>.')
@@ -125,7 +162,7 @@ def main(args):
             user = None
             repo = args['<user>/<repo>']
 
-        if args['create'] or args['add'] or args['delete'] 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:
@@ -156,14 +193,7 @@ def main(args):
 
             elif args['delete']:
                 if not args['--force']: # pragma: no cover
-                    ans = input('Are you sure you want to delete the repository '
-                                '{} from the server?\n[yN]> '.format(args['<user>/<repo>']))
-                    if 'y' in ans:
-                        ans = input('Are you really sure? there\'s no coming back!\n'
-                                    '[type \'burn!\' to proceed]> ')
-                        if 'burn!' != ans:
-                            return 0
-                    else:
+                    if not confirm('repository', args['<user>/<repo>']):
                         return 0
 
                 if user:
@@ -175,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)
 
@@ -196,7 +240,7 @@ def main(args):
                 raise FileExistsError('Cannot clone repository, '
                                       'a folder named {} already exists!'.format(repo))
 
-        elif args['clone']:
+        elif args['clone'] and not args['gist']:
             repo_path = os.path.join(args['--path'], repo)
             repository = Repo.init(repo_path)
             service = RepositoryService.get_service(repository, args['<target>'])
@@ -207,6 +251,38 @@ def main(args):
             )
             return 0
 
+        elif args['gist']:
+            service = RepositoryService.get_service(None, args['<target>'])
+            service.connect()
+            if args['list'] or args['ls']:
+                if args['<gist>']:
+                    log.info("{:15}\t{:>7}\t{}".format('language', 'size', 'name'))
+                    for gist_file in service.gist_list(args['<gist>']):
+                        print("{:15}\t{:7}\t{}".format(*gist_file))
+                else:
+                    log.info("{:56}\t{}".format('id', 'title'.ljust(60)))
+                    for gist in service.gist_list():
+                        print( "{:56}\t{}".format(gist[0], gist[1]))
+            elif args['fetch']:
+                # send gist to stdout, not using log.info on purpose here!
+                print(service.gist_fetch(args['<gist>'], args['<gist_file>']))
+            elif args['clone']:
+                repo_path = os.path.join(args['--path'], args['<gist>'].split('/')[-1])
+                service.repository = Repo.init(repo_path)
+                service.gist_clone(args['<gist>'])
+                log.info('Successfully cloned `{}` into `{}`!'.format( args['<gist>'], repo_path))
+            elif args['create']:
+                url = service.gist_create(args['<gist_path>'], args['<description>'], args['--secret'])
+                log.info('Successfully created gist `{}`!'.format(url))
+            elif args['delete']:
+                if not args['--force']: # pragma: no cover
+                    if not confirm('gist', args['<gist>']):
+                        return 0
+
+                service.gist_delete(args['<gist>'])
+                log.info('Successfully deleted gist!')
+            return 0
+
         log.error('Unknown action.')
         log.error('Please consult help page (--help).')
         return 1