Integrate support for token auth

Per upcoming changes in Patchwork.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

README.rst

@@ -71,25 +71,32 @@ Getting Started
 To begin, you'll need to configure Git settings appropriately. The following
 settings are **required**:
 
-pw.server
+``pw.server``
 
   The URL for the Patchwork instance. This will typically look like. For
   example::
 
       https://patchwork.ozlabs.org/
 
-pw.project
+``pw.project``
 
   The project name or list-id. This will appear in the URL when using the web
   UI::
 
       https://patchwork.ozlabs.org/project/{project_name}/list/
 
-pw.username
+You also require authentication - you can use either API tokens or a
+username/password combination:
+
+``pw.token``
+
+  The API token for you Patchwork account.
+
+``pw.username``
 
   The username for your Patchwork account.
 
-pw.password
+``pw.password``
 
   The password for your Patchwork account.
 

docs/index.rst

@@ -3,7 +3,7 @@ git-pw
 
 .. include:: ../README.rst
    :start-line: 19
-   :end-line: 124
+   :end-line: -7
 
 Usage
 -----

git_pw/api.py

@@ -9,17 +9,37 @@
 
 from git_pw import config
 
+if 0:  # noqa
+    from typing import Dict  # noqa
+
 CONF = config.CONF
 LOG = logging.getLogger(__name__)
 
 
-def _get_auth():  # type: () -> (str, str)
-    if CONF.username and CONF.password:
-        return (CONF.username, CONF.password)
+class HTTPTokenAuth(requests.auth.AuthBase):
+    """Attaches HTTP Token Authentication to the given Request object."""
+    def __init__(self, token):
+        self.token = token
+
+    def __call__(self, r):
+        r.headers['Authorization'] = self._token_auth_str(self.token)
+        return r
+
+    @staticmethod
+    def _token_auth_str(token):  # type: (str) -> str
+        """Return a Token auth string."""
+        return 'Token {}'.format(token.strip())
+
+
+def _get_auth():  # type: () -> requests.auth.AuthBase
+    if CONF.token:
+        return HTTPTokenAuth(CONF.token)
+    elif CONF.username and CONF.password:
+        return requests.auth.HTTPBasicAuth(CONF.username, CONF.password)
     else:
         LOG.error('Authentication information missing')
         LOG.error('You must configure authentication via git-config or via '
-                  '--username, --password')
+                  '--token or --username, --password')
         sys.exit(1)
 
 

git_pw/shell.py

@@ -16,6 +16,8 @@
 @click.group()
 @click.option('--debug', default=False, is_flag=True,
               help="Output more information about what's going on.")
+@click.option('--token', metavar='TOKEN', envvar='PW_TOKEN',
+              help='Authentication token.')
 @click.option('--username', metavar='USERNAME', envvar='PW_USERNAME',
               help='Authentication username.')
 @click.option('--password', metavar='PASSWORD', envvar='PW_PASSWORD',
@@ -25,7 +27,7 @@
 @click.option('--project', metavar='PROJECT', envvar='PW_PROJECT',
               help='Patchwork project.')
 @click.version_option()
-def cli(debug, username, password, server, project):
+def cli(debug, token, username, password, server, project):
     """git-pw is a tool for integrating Git with Patchwork.
 
     git-pw can interact with individual patches, complete patch series, and
@@ -34,19 +36,14 @@ def cli(debug, username, password, server, project):
 
     The git-pw utility is a wrapper which makes REST calls to the Patchwork
     service. To use git-pw, you must set up your environment by configuring
-    your Patchwork server URL, username, and password.
-
-    Configuring the patchwork URL::
+    your Patchwork server URL and either an API token or a username and
+    password. To configure the server URL, run::
 
       git config pw.server http://pw.server.com/path/to/patchwork
 
-    Configuring username::
-
-      git config pw.username userid
-
-    Configuring password::
+    To configure the token, run::
 
-      git config pw.password pass
+      git config pw.token token
 
     Alternatively, you can pass these options via command line parameters or
     environment variables.
@@ -57,6 +54,7 @@ def cli(debug, username, password, server, project):
     logger.configure_verbosity(debug)
 
     CONF.debug = debug
+    CONF.token = token
     CONF.username = username
     CONF.password = password
     CONF.server = server