Merge lp:~barry/piston-mini-client/lp1077083 into lp:piston-mini-client

[Barry Warsaw]

Switches from the long abandoned and not-Python-3-compatible python-oauth library to the well-supported-upstream and Python 3 compatible python-oauthlib library. Fixes a bogus dictionary order dependency which breaks Python 3.3. Re-enables a Python 3 test.

[Barry Warsaw (barry)]

Note that you will have some trouble testing this on today's Raring. The problem is that tox is not yet in Raring (it will soon land in Debian and then be synced to Raring), and the python-virtualenv version that is currently in Raring is not compatible with Python 3.3. This should be fixed upstream today and will make it into Ubuntu shortly thereafter.

To test this on Raring, your best bet is to install virtualenv from upstream git (where the Python 3.3 bug is fixed), create a Python 2.7 and separate Python 3.3 virtualenvs, install the dependencies into them (via pip), and then run nosetests into the virtualenv.

Hopefully by next week you'll be able to just run `tox -e py27,py33` in Raring.

[Michael Vogt (mvo)]

Thanks for this branch. Looks good to me, +1

review: Approve

[Anthony Lenton (elachuni)]

Thanks Barry!!

=== modified file 'README'
--- README	2012-07-31 16:33:45 +0000
+++ README	2012-11-21 15:46:35 +0000
@@ -29,8 +29,7 @@
   tox
 
 This will ensure the tests run on Python 2.6, 2.7 and 3.2, and the docs build
-correctly.  Tests pass against Python 3, but oauth tests are skipped as the
-oauth module still doesn't have Python 3 support.
+correctly.
 
 Building the docs locally
 =========================

=== modified file 'doc/index.rst'
--- doc/index.rst	2012-04-02 18:21:11 +0000
+++ doc/index.rst	2012-11-21 15:46:35 +0000
@@ -33,8 +33,8 @@
 
 * It should have a small set of dependencies.  We depend on httplib2 mainly
   because it provides caching, but you should not need to install a pile of
-  packages just to use a rest client.  Other dependencies like ``oauth`` and
-  ``socks`` are only imported if you need to use oauth authentication or
+  packages just to use a rest client.  Other dependencies like ``oauthlib``
+  and ``socks`` are only imported if you need to use oauth authentication or
   support proxies, respectively.
 
 * Errors should be informative.  Backtraces should point you in the right

=== modified file 'piston_mini_client/auth.py'
--- piston_mini_client/auth.py	2012-07-30 17:09:26 +0000
+++ piston_mini_client/auth.py	2012-11-21 15:46:35 +0000
@@ -8,11 +8,15 @@
 instantiate a ``PistonAPI`` object.
 """
 
-from functools import wraps
-
 import base64
 
 
+def _unicodeify(s):
+    if isinstance(s, bytes):
+        return s.decode('utf-8')
+    return s
+
+
 class OAuthAuthorizer(object):
     """Authenticate to OAuth protected APIs."""
     def __init__(self, token_key, token_secret, consumer_key, consumer_secret,
@@ -23,25 +27,33 @@
         ``consumer_secret`` are required for signing OAuth requests.  The
         ``oauth_realm`` to use is optional.
         """
-        self.token_key = token_key
-        self.token_secret = token_secret
-        self.consumer_key = consumer_key
-        self.consumer_secret = consumer_secret
+        # 2012-11-19 BAW: python-oauthlib requires unicodes for its tokens and
+        # secrets.  Assume utf-8 values.
+        # https://github.com/idan/oauthlib/issues/68
+        self.token_key = _unicodeify(token_key)
+        self.token_secret = _unicodeify(token_secret)
+        self.consumer_key = _unicodeify(consumer_key)
+        self.consumer_secret = _unicodeify(consumer_secret)
         self.oauth_realm = oauth_realm
 
     def sign_request(self, url, method, body, headers):
         """Sign a request with OAuth credentials."""
-        # Import oauth here so that you don't need it if you're not going
+        # 2012-11-19 BAW: In order to preserve API backward compatibility,
+        # convert empty string body to None.  The old python-oauth library
+        # would treat the empty string as "no body", but python-oauthlib
+        # requires None.
+        if not body:
+            body = None
+        # Import oauthlib here so that you don't need it if you're not going
         # to use it.  Plan B: move this out into a separate oauth module.
-        from oauth.oauth import (OAuthRequest, OAuthConsumer, OAuthToken,
-                                 OAuthSignatureMethod_PLAINTEXT)
-        consumer = OAuthConsumer(self.consumer_key, self.consumer_secret)
-        token = OAuthToken(self.token_key, self.token_secret)
-        oauth_request = OAuthRequest.from_consumer_and_token(
-            consumer, token, http_url=url)
-        oauth_request.sign_request(OAuthSignatureMethod_PLAINTEXT(),
-                                   consumer, token)
-        headers.update(oauth_request.to_header(self.oauth_realm))
+        from oauthlib.oauth1 import Client, SIGNATURE_PLAINTEXT
+        oauth_client = Client(self.consumer_key, self.consumer_secret,
+                              self.token_key, self.token_secret,
+                              signature_method=SIGNATURE_PLAINTEXT,
+                              realm=self.oauth_realm)
+        uri, signed_headers, body = oauth_client.sign(
+            url, method, body, headers)
+        headers.update(signed_headers)
 
 
 class BasicAuthorizer(object):

=== modified file 'piston_mini_client/tests/test_auth.py'
--- piston_mini_client/tests/test_auth.py	2012-07-30 17:09:26 +0000
+++ piston_mini_client/tests/test_auth.py	2012-11-21 15:46:35 +0000
@@ -2,7 +2,6 @@
 # Copyright 2010-2012 Canonical Ltd.  This software is licensed under the
 # GNU Lesser General Public License version 3 (see the file LICENSE).
 
-import sys
 from piston_mini_client.auth import OAuthAuthorizer, BasicAuthorizer
 from unittest import TestCase
 
@@ -20,10 +19,6 @@
 
 class OAuthAuthorizerTestCase(TestCase):
     def test_sign_request(self):
-        if sys.version_info[0] == 3:
-            # Skip on Python 3 as oauth is still broken there.
-            # don't use skipIf as it's missing on python2.6
-            return
         auth = OAuthAuthorizer('tkey', 'tsecret', 'ckey', 'csecret')
         url = 'http://example.com/api'
         headers = {}

=== modified file 'piston_mini_client/tests/test_serializers.py'
--- piston_mini_client/tests/test_serializers.py	2012-07-30 17:09:26 +0000
+++ piston_mini_client/tests/test_serializers.py	2012-11-21 15:46:35 +0000
@@ -7,6 +7,13 @@
 from piston_mini_client.serializers import JSONSerializer, FormSerializer
 from piston_mini_client import PistonSerializable
 
+try:
+    # Python 3.
+    from urllib.parse import parse_qs
+except ImportError:
+    # Python 2.
+    from urlparse import parse_qs
+
 
 class JSONSerializerTestCase(TestCase):
     def test_simple_serialize(self):
@@ -38,7 +45,11 @@
 
         myarg = MySerializable(foo='baz', bar=42)
         serializer = FormSerializer()
-        self.assertEqual('foo=baz&bar=42', serializer.serialize(myarg))
+        # Argument order is undefined, so parse these into dictionaries which
+        # can be compared.
+        want = parse_qs('foo=baz&bar=42')
+        got = parse_qs(serializer.serialize(myarg))
+        self.assertEqual(want, got)
 
     def test_serialize_nested(self):
         # Maybe we should flatly refuse to serialize nested structures?

=== modified file 'setup.py'
--- setup.py	2012-09-24 13:22:12 +0000
+++ setup.py	2012-11-21 15:46:35 +0000
@@ -11,7 +11,7 @@
     packages=['piston_mini_client'],
     license='LGPLv3',
     install_requires=[
-        'oauth',
+        'oauthlib',
         'httplib2',
     ],
 )