Add support for API Keys

djmitche · crobinso · commit 6cbe2890319f · 2017-02-21T16:36:47.000-05:00
Currently only via Bugzilla(api_key=XXX) parameter
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -235,7 +235,7 @@ def fix_url(url):
         return url
 
     def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
-                 sslverify=True, tokenfile=-1, use_creds=True):
+                 sslverify=True, tokenfile=-1, use_creds=True, api_key=None):
         """
         :param url: The bugzilla instance URL, which we will connect
             to immediately. Most users will want to specify this at
@@ -258,6 +258,7 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         # Settings the user might want to tweak
         self.user = user or ''
         self.password = password or ''
+        self.api_key = api_key
         self.url = ''
 
         self._proxy = None
@@ -507,6 +508,10 @@ def connect(self, url=None):
             log.info("user and password present - doing login()")
             self.login()
 
+        if self.api_key:
+            log.debug("using API key")
+            self._proxy.use_api_key(self.api_key)
+
         version = self._proxy.Bugzilla.version()["version"]
         log.debug("Bugzilla version string: %s", version)
         self._set_bz_version(version)
@@ -542,6 +547,9 @@ def login(self, user=None, password=None):
         and password are both set. So under most circumstances you won't need
         to call this yourself.
         '''
+        if self.api_key:
+            raise ValueError("cannot login when using an API key")
+
         if user:
             self.user = user
         if password:
diff --git a/bugzilla/transport.py b/bugzilla/transport.py
@@ -77,15 +77,22 @@ def __init__(self, uri, tokenfile, *args, **kwargs):
         # No idea why pylint complains here, must be a bug
         ServerProxy.__init__(self, uri, *args, **kwargs)
         self.token_cache = _BugzillaTokenCache(uri, tokenfile)
+        self.api_key = None
+
+    def use_api_key(self, api_key):
+        self.api_key = api_key
 
     def clear_token(self):
         self.token_cache.value = None
 
     def _ServerProxy__request(self, methodname, params):
-        if self.token_cache.value is not None:
-            if len(params) == 0:
-                params = ({}, )
+        if len(params) == 0:
+            params = ({}, )
 
+        if self.api_key is not None:
+            if 'Bugzilla_api_key' not in params[0]:
+                params[0]['Bugzilla_api_key'] = self.api_key
+        elif self.token_cache.value is not None:
             if 'Bugzilla_token' not in params[0]:
                 params[0]['Bugzilla_token'] = self.token_cache.value
 
diff --git a/examples/apikey.py b/examples/apikey.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
+# the full text of the license.
+
+# create.py: Create a new bug report
+
+from __future__ import print_function
+
+import bugzilla
+
+# Don't worry, changing things here is fine, and won't send any email to
+# users or anything. It's what landfill.bugzilla.org is for!
+URL = "https://landfill.bugzilla.org/bugzilla-5.0-branch/xmlrpc.cgi"
+
+print("You can get an API key at "
+      "https://landfill.bugzilla.org/bugzilla-5.0-branch/userprefs.cgi")
+print("after creating an account, if necessary.  "
+      "This is a test site, so no harm will come!")
+api_key = raw_input("Enter Bugzilla API Key: ")
+
+# API key usage assumes the API caller is storing the API key; if you would
+# like to use one of the login options that stores credentials on-disk for
+# command-line usage, use tokens or cookies.
+bzapi = bugzilla.Bugzilla(URL, api_key=api_key)
+assert bzapi.logged_in
