Allow users to show, download and apply bundles by name

This was another ask from my colleague. As noted in the code, this is
done in the client as the functionality doesn't really make sense in the
server.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

git_pw/api.py

@@ -150,8 +150,13 @@ def download(url, params=None):
     rsp = get(url, params, stream=True)
 
     # we don't catch anything here because we should break if these are missing
-    header = rsp.headers['content-disposition']
-    output_path = re.search('filename=(.+)', header).group(1)
+    header = re.search('filename=(.+)',
+                       rsp.headers.get('content-disposition') or '')
+    if not header:
+        LOG.error('Filename was expected but was not provided in response')
+        sys.exit(1)
+
+    output_path = header.group(1)
 
     with open(output_path, 'wb') as output_file:
         LOG.debug('Saving to %s', output_path)

git_pw/bundle.py

@@ -14,24 +14,45 @@
 LOG = logging.getLogger(__name__)
 
 
+def _get_bundle(bundle_id):
+    """Fetch bundle by ID or name.
+
+    Allow users to provide a string to search for bundles. This doesn't make
+    sense to expose via the API since there's no uniqueness constraint on
+    bundle names.
+    """
+    if bundle_id.isdigit():
+        return api.detail('bundles', bundle_id)
+
+    bundles = api.index('bundles', [('q', bundle_id)])
+    if len(bundles) == 0:
+        LOG.error('No matching bundle found: %s', bundle_id)
+        sys.exit(1)
+    elif len(bundles) > 1:
+        LOG.error('More than one bundle found: %s', bundle_id)
+        sys.exit(1)
+
+    return bundles[0]
+
+
 @click.command(name='apply')
-@click.argument('bundle_id', type=click.INT)
+@click.argument('bundle_id')
 @click.argument('args', nargs=-1)
 def apply_cmd(bundle_id, args):
     """Apply bundle.
 
     Apply a bundle locally using the 'git-am' command.
     """
-    LOG.debug('Applying bundle: id=%d', bundle_id)
+    LOG.debug('Applying bundle: id=%s', bundle_id)
 
-    bundle = api.detail('bundles', bundle_id)
+    bundle = _get_bundle(bundle_id)
     mbox = api.download(bundle['mbox']).text
 
     utils.git_am(mbox, args)
 
 
 @click.command(name='download')
-@click.argument('bundle_id', type=click.INT)
+@click.argument('bundle_id')
 @click.argument('output', type=click.File('wb'), required=False)
 def download_cmd(bundle_id, output):
     """Download bundle in mbox format.
@@ -40,10 +61,10 @@ def download_cmd(bundle_id, output):
     output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
     provided, the output path will be automatically chosen.
     """
-    LOG.debug('Downloading bundle: id=%d', bundle_id)
+    LOG.debug('Downloading bundle: id=%s', bundle_id)
 
     path = None
-    bundle = api.detail('bundles', bundle_id)
+    bundle = _get_bundle(bundle_id)
 
     if output:
         output.write(api.get(bundle['mbox']).text)
@@ -58,15 +79,15 @@ def download_cmd(bundle_id, output):
 
 
 @click.command(name='show')
-@click.argument('bundle_id', type=click.INT)
+@click.argument('bundle_id')
 def show_cmd(bundle_id):
     """Show information about bundle.
 
     Retrieve Patchwork metadata for a bundle.
     """
-    LOG.debug('Showing bundle: id=%d', bundle_id)
+    LOG.debug('Showing bundle: id=%s', bundle_id)
 
-    bundle = api.detail('bundles', bundle_id)
+    bundle = _get_bundle(bundle_id)
 
     def _format_patch(patch):
         return '%-4d %s' % (patch.get('id'), patch.get('name'))

releasenotes/notes/use-bundle-names-b1b3ee5c2858c96b.yaml

@@ -0,0 +1,11 @@
+---
+features:
+  - |
+    It's now possible to use a bundle name in addition to the numeric ID for
+    the ``bundle download``, ``bundle apply`` and ``bundle show`` commands.
+    For example::
+
+        $ git pw bundle show 'My sample bundle'
+
+    As bundle names are not necessarily unique, this will fail if multiple
+    bundles match the provided string.