Merge lp:~blr/launchpadlib/auth-token-script into lp:launchpadlib

[Kit Randel]

* Teach launchpad-request-token to also generate access tokens.
* Install launchpad-request-token.

[Colin Watson (cjwatson)]

launchpadlib has moved to git (https://code.launchpad.net/launchpadlib/+git). Sorry for not reviewing this in a timely fashion; if this is still relevant, then please update your branch and re-propose it against the git repository.

Unmerged revisions

157. By Kit Randel on 2016-07-31

Whitespace

156. By Kit Randel on 2016-07-31

Correct usage.

155. By Kit Randel on 2016-07-31

Call print func.

154. By Kit Randel on 2016-07-31

Remove unused import.

153. By Kit Randel on 2016-07-31

Install launchpad-request-token script.

152. By Kit Randel on 2016-07-31

Teach launchpad-request-token to also generate access tokens.

=== modified file 'setup.py'
--- setup.py	2014-07-04 14:55:48 +0000
+++ setup.py	2016-07-31 23:28:12 +0000
@@ -76,5 +76,8 @@
         "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
         "Operating System :: OS Independent",
         "Programming Language :: Python"],
+    scripts=[
+        'src/launchpadlib/bin/launchpad-request-token',
+    ],
     test_suite='launchpadlib.tests',
     )
 
=== modified file 'src/launchpadlib/bin/launchpad-request-token'
--- src/launchpadlib/bin/launchpad-request-token	2009-10-27 15:58:44 +0000
+++ src/launchpadlib/bin/launchpad-request-token	2016-07-31 23:28:12 +0000
@@ -1,6 +1,6 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
-# Copyright 2009 Canonical Ltd.
+# Copyright 2016 Canonical Ltd.
 
 # This file is part of launchpadlib.
 #
@@ -25,10 +25,46 @@
 __metaclass__ = type
 
 from optparse import OptionParser
+import time
+
 from launchpadlib.apps import RequestTokenApp
+from launchpadlib.credentials import Credentials
+from launchpadlib.uris import lookup_service_root
+from lazr.restfulclient.errors import HTTPError
+
+
+def print_local_settings(web_root, key, token, secret):
+    """Print access token settings in YAML format."""
+    print("\nAn access token has been generated with the following settings:"
+          "\n\n"
+          "LP_API_URL = '{api_url}'\n"
+          "LP_API_CONSUMER_KEY = '{key}'\n"
+          "LP_API_TOKEN = '{token}'\n"
+          "LP_API_TOKEN_SECRET = '{secret}'").format(
+              api_url=lookup_service_root(web_root),
+              key=key,
+              token=token,
+              secret=secret)
+
+
+def create_access_token(consumer_name, web_root, context=None):
+    credentials = Credentials(consumer_name)
+    authorise_url = credentials.get_request_token(
+        web_root=web_root, context=context)
+    print('\nPlease ensure you are logged in and visit {} to '
+          'authorise this request...'.format(authorise_url))
+    while True:
+        try:
+            credentials.exchange_request_token_for_access_token(
+                web_root=web_root)
+            return credentials.access_token
+        except HTTPError:
+            time.sleep(0.5)
+
 
 parser = OptionParser()
-parser.usage = "%prog CONSUMER_NAME [-r SITE NAME] [-c CONTEXT]"
+parser.usage = ("%prog CONSUMER_NAME [-s SITE NAME]"
+                "[-c CONTEXT] [--generate-access-token]")
 parser.add_option("-s", "--site", dest="web_root",
                   help=("The name of the Launchpad site to ask for a request "
                         "token (default: %default). This can also be the "
@@ -36,13 +72,23 @@
                   metavar="SITE", default="staging")
 parser.add_option("-c", "--context", dest="context",
                   help="Restrict the token to a specific context "
-                  "(example: firefox)", metavar="CONTEXT", default="")
+                  "(example: firefox)", metavar="CONTEXT", default=None)
+parser.add_option("--generate-access-token", action="store_true",
+                  dest="access_token",
+                  help="Generate an access token.")
+
 
 if __name__ == '__main__':
     (options, args) = parser.parse_args()
     if len(args) < 1:
         parser.error("No consumer name supplied")
     consumer_name = args[0]
-    app = RequestTokenApp(
-        options.web_root, consumer_name, options.context)
-    print app.run()
+    if options.access_token:
+        access_token = create_access_token(
+            consumer_name, options.web_root, options.context)
+        print_local_settings(options.web_root, consumer_name,
+                             access_token.key, access_token.secret)
+    else:
+        app = RequestTokenApp(options.web_root, consumer_name, options.context)
+        request_token = app.run()
+        print(request_token)