Take advantage of features from API v1.1

This allows us to avoid making multiple queries for a given operation.

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

Author: stephenfin

git_pw/api.py

@@ -14,6 +14,7 @@
 if 0:  # noqa
     from typing import Dict  # noqa
     from typing import List  # noqa
+    from typing import Optional  # noqa
     from typing import Tuple  # noqa
 
     Filters = List[Tuple[str, str]]
@@ -116,6 +117,19 @@ def _handle_error(operation, exc):
         sys.exit(1)
 
 
+def version():
+    # type: () -> Optional[Tuple[int, int]]
+    """Get the version of the server from the URL, if present."""
+    server = _get_server()
+
+    version = re.match(r'.*/(\d)\.(\d)$', server)
+    if version:
+        return (int(version.group(1)), int(version.group(2)))
+
+    # return the oldest version we support if no version provided
+    return (1, 0)
+
+
 def get(url, params=None, stream=False):
     # type: (str, Filters, bool) -> requests.Response
     """Make GET request and handle errors."""

git_pw/bundle.py

@@ -95,6 +95,7 @@ def _format_patch(patch):
     output = [
         ('ID', bundle.get('id')),
         ('Name', bundle.get('name')),
+        ('URL', bundle.get('web_url')),
         ('Owner', bundle.get('owner').get('username')),
         ('Project', bundle.get('project').get('name')),
         ('Public', bundle.get('public'))]
@@ -131,17 +132,19 @@ def list_cmd(owner, limit, page, sort, name):
 
     params = []
 
-    # TODO(stephenfin): It should be possible to filter bundles by owner email
-    for own in owner:
-        users = api.index('users', [('q', own)])
-        if len(users) == 0:
-            LOG.error('No matching owner found: %s', own)
-            sys.exit(1)
-        elif len(users) > 1:
-            LOG.error('More than one owner found: %s', own)
-            sys.exit(1)
-
-        params.append(('owner', users[0]['id']))
+    if api.version() >= (1, 1):
+        params.extend([('owner', own) for own in owner])
+    else:
+        for own in owner:
+            users = api.index('users', [('q', own)])
+            if len(users) == 0:
+                LOG.error('No matching owner found: %s', own)
+                sys.exit(1)
+            elif len(users) > 1:
+                LOG.error('More than one owner found: %s', own)
+                sys.exit(1)
+
+            params.append(('owner', users[0]['id']))
 
     params.extend([
         ('q', name),

git_pw/patch.py

@@ -95,6 +95,7 @@ def _format_series(series):
         ('Message ID', patch.get('msgid')),
         ('Date', patch.get('date')),
         ('Name', patch.get('name')),
+        ('URL', patch.get('web_url')),
         ('Submitter', '%s (%s)' % (patch.get('submitter').get('name'),
                                    patch.get('submitter').get('email'))),
         ('State', patch.get('state')),
@@ -220,28 +221,31 @@ def list_cmd(state, submitter, delegate, archived, limit, page, sort, name):
     for state in state:
         params.append(('state', state))
 
-    # TODO(stephenfin): It should be possible to filter patches submitter email
-    for subm in submitter:
-        people = api.index('people', [('q', subm)])
-        if len(people) == 0:
-            LOG.error('No matching submitter found: %s', subm)
-            sys.exit(1)
-        elif len(people) > 1:
-            LOG.error('More than one submitter found: %s', subm)
-            sys.exit(1)
-
-        params.append(('submitter', people[0]['id']))
-
-    for delg in delegate:
-        users = api.index('users', [('q', delg)])
-        if len(users) == 0:
-            LOG.error('No matching delegates found: %s', delg)
-            sys.exit(1)
-        elif len(users) > 1:
-            LOG.error('More than one delegate found: %s', delg)
-            sys.exit(1)
-
-        params.append(('delegate', users[0]['id']))
+    if api.version() >= (1, 1):
+        params.extend([('submitter', subm) for subm in submitter])
+        params.extend([('delegate', delg) for delg in delegate])
+    else:
+        for subm in submitter:
+            people = api.index('people', [('q', subm)])
+            if len(people) == 0:
+                LOG.error('No matching submitter found: %s', subm)
+                sys.exit(1)
+            elif len(people) > 1:
+                LOG.error('More than one submitter found: %s', subm)
+                sys.exit(1)
+
+            params.append(('submitter', people[0]['id']))
+
+        for delg in delegate:
+            users = api.index('users', [('q', delg)])
+            if len(users) == 0:
+                LOG.error('No matching delegates found: %s', delg)
+                sys.exit(1)
+            elif len(users) > 1:
+                LOG.error('More than one delegate found: %s', delg)
+                sys.exit(1)
+
+            params.append(('delegate', users[0]['id']))
 
     params.extend([
         ('q', name),

git_pw/series.py

@@ -76,6 +76,7 @@ def _format_submission(submission):
         ('ID', series.get('id')),
         ('Date', series.get('date')),
         ('Name', series.get('name')),
+        ('URL', series.get('web_url')),
         ('Submitter', '%s (%s)' % (series.get('submitter').get('name'),
                                    series.get('submitter').get('email'))),
         ('Project', series.get('project').get('name')),
@@ -118,18 +119,19 @@ def list_cmd(submitter, limit, page, sort, name):
 
     params = []
 
-    # TODO(stephenfin): It should be possible to filter series by submitter
-    # email
-    for subm in submitter:
-        people = api.index('people', [('q', subm)])
-        if len(people) == 0:
-            LOG.error('No matching submitter found: %s', subm)
-            sys.exit(1)
-        elif len(people) > 1:
-            LOG.error('More than one submitter found: %s', subm)
-            sys.exit(1)
-
-        params.append(('submitter', people[0]['id']))
+    if api.version() >= (1, 1):
+        params.extend([('submitter', subm) for subm in submitter])
+    else:
+        for subm in submitter:
+            people = api.index('people', [('q', subm)])
+            if len(people) == 0:
+                LOG.error('No matching submitter found: %s', subm)
+                sys.exit(1)
+            elif len(people) > 1:
+                LOG.error('More than one submitter found: %s', subm)
+                sys.exit(1)
+
+            params.append(('submitter', people[0]['id']))
 
     params.extend([
         ('q', name),

releasenotes/notes/api-v1-1-5c804713ef435739.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Patchwork API v1.1 is now supported.