Merge lp:~cjwatson/lazr.restfulclient/access-token-compat into lp:lazr.restfulclient

[Colin Watson]

Restore some AccessToken methods.

Restore from_string, to_string, and __str__ methods of lazr.restfulclient.authorize.oauth.AccessToken, unintentionally removed in 0.14.0. This caused a test failure when attempting to upgrade Launchpad from 0.13.2 to 0.14.2.

AccessToken.from_string doesn't have particularly clean error handling, but this was true of the previous oauth-based version as well.

The test regression was caused by https://code.launchpad.net/~cjwatson/lazr.restfulclient/oauthlib/+merge/344716.

[Thiago F. Pappacena (pappacena)]

LGTM

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2019-11-02 21:55:16 +0000
+++ NEWS.rst	2020-01-26 11:00:16 +0000
@@ -2,6 +2,13 @@
 NEWS for lazr.restfulclient
 ===========================
 
+0.14.3
+======
+
+  - Restore from_string, to_string, and __str__ methods of
+    lazr.restfulclient.authorize.oauth.AccessToken, unintentionally removed
+    in 0.14.0.
+
 0.14.2 (2018-11-17)
 ===================
 

=== modified file 'src/lazr/restfulclient/authorize/oauth.py'
--- src/lazr/restfulclient/authorize/oauth.py	2018-11-17 14:43:04 +0000
+++ src/lazr/restfulclient/authorize/oauth.py	2020-01-26 11:00:16 +0000
@@ -31,6 +31,10 @@
 
 from oauthlib import oauth1
 import six
+from six.moves.urllib.parse import (
+    parse_qs,
+    urlencode,
+    )
 
 from lazr.restfulclient.authorize import HttpAuthorizer
 from lazr.restfulclient.errors import CredentialsFileError
@@ -75,6 +79,21 @@
         self.secret = secret
         self.context = context
 
+    def to_string(self):
+        return urlencode([
+            ("oauth_token_secret", self.secret),
+            ("oauth_token", self.key),
+            ])
+
+    __str__ = to_string
+
+    @classmethod
+    def from_string(cls, s):
+        params = parse_qs(s, keep_blank_values=False)
+        key = params["oauth_token"][0]
+        secret = params["oauth_token_secret"][0]
+        return cls(key, secret)
+
 
 class TruthyString(six.text_type):
     """A Unicode string which is always true."""

=== modified file 'src/lazr/restfulclient/tests/test_oauth.py'
--- src/lazr/restfulclient/tests/test_oauth.py	2018-04-28 12:29:24 +0000
+++ src/lazr/restfulclient/tests/test_oauth.py	2020-01-26 11:00:16 +0000
@@ -53,6 +53,32 @@
         self.assertEqual(consumer.application_name, None)
 
 
+class TestAccessToken(TestCase):
+
+    def test_data_fields(self):
+        access_token = AccessToken("key", "secret", "context")
+        self.assertEqual(access_token.key, "key")
+        self.assertEqual(access_token.secret, "secret")
+        self.assertEqual(access_token.context, "context")
+
+    def test_default_context(self):
+        # Context defaults to None.
+        access_token = AccessToken("key", "secret")
+        self.assertIsNone(access_token.context)
+
+    def test___str__(self):
+        access_token = AccessToken("lock&key", "secret=password")
+        self.assertEqual(
+            "oauth_token_secret=secret%3Dpassword&oauth_token=lock%26key",
+            str(access_token))
+
+    def test_from_string(self):
+        access_token = AccessToken.from_string(
+            "oauth_token_secret=secret%3Dpassword&oauth_token=lock%26key")
+        self.assertEqual(access_token.key, "lock&key")
+        self.assertEqual(access_token.secret, "secret=password")
+
+
 class TestSystemWideConsumer(TestCase):
 
     def test_useful_distro_name(self):