python 3 support

Author: sashahart

.gitignore

@@ -2,6 +2,7 @@ build/*
 docs/_build/*
 tests_output/*
 dist/*
+virtualenv/*
 *.egg-info
 *.pyc
 *.un~

.travis.yml

@@ -2,7 +2,10 @@ language: python
 python:
   - 2.6
   - 2.7
+  - 3.3
 install:
-  - pip install -r requirements-dev.txt --use-mirrors
+  - "if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install -r [email protected] --use-mirrors; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install -r [email protected] --use-mirrors; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '3.3' ]]; then pip install -r [email protected] --use-mirrors; fi"
   - pip install . --use-mirrors
 script: make check

AUTHORS.markdown renamed to AUTHORS.md

@@ -4,18 +4,17 @@ Rauth Changelog
 This provides a list of changes to rauth by release.
 
 
-Changes in Version 0.5.4
-
+Changes in Version 0.5.5
+------------------------
   * BUGFIX Fixed upstream CaseInsensitiveDict API changes
   * BUGFIX Corrected multiple quoting of oauth_token
 
-
 Changes in Version 0.5.4
-
+------------------------
   * BUGFIX Corrected adding header to OAuth 2.0 where no access token existed
 
 Changes in Version 0.5.3
-
+------------------------
   * Added an ad hoc check against double signing in OAuth 1.0/a
 
 Changes in Version 0.5.2
@@ -103,4 +102,4 @@ Changes in Version 0.5.0
 
   * Removed examples without correct, functioning credentials
 
-  * Test suite completely rewritten for more robust request checking
+  * Test suite completely rewritten for more robust request checking

CHANGELOG

@@ -1 +1 @@
-include README.markdown LICENSE CHANGELOG
+include README.md LICENSE CHANGELOG

MANIFEST.in

@@ -2,9 +2,7 @@
 
 all:
 	@echo 'test           run the unit tests'
-	@echo 'coverage       generate coverage statistics'
-	@echo 'pep8           check pep8 compliance'
-	@echo 'pyflakes       check for unused imports (requires pyflakes)'
+	@echo 'flake8         check for PEP8 compliance and unused imports'
 	@echo 'check          make sure you are ready to commit'
 	@echo 'clean          cleanup the source tree'
 
@@ -15,14 +13,10 @@ test: clean_coverage
 clean_coverage:
 	@rm -f .coverage
 
-pep8:
-	@echo 'Checking pep8 compliance...'
-	@pep8 rauth tests
+flake8:
+	@echo 'Running flake8...'
+	@flake8 rauth tests
 
-pyflakes:
-	@echo 'Running pyflakes...'
-	@pyflakes rauth tests
-
-check: pep8 pyflakes test
+check: flake8 test
 	@grep ^TOTAL tests_output/test.log | grep 100% >/dev/null || \
 	{ echo 'Unit tests coverage is incomplete.'; exit 1; }

Makefile

@@ -42,7 +42,7 @@ twitter = OAuth1Service(
     request_token_url='https://api.twitter.com/oauth/request_token',
     access_token_url='https://api.twitter.com/oauth/access_token',
     authorize_url='https://api.twitter.com/oauth/authorize',
-    base_url='https://api.twitter.com/1/')
+    base_url='https://api.twitter.com/1.1/')
 ```
 
 Then get an OAuth 1.0 request token:
@@ -58,7 +58,7 @@ application, Twitter will give you a PIN to enter.
 authorize_url = twitter.get_authorize_url(request_token)
 
 print 'Visit this URL in your browser: ' + authorize_url
-pin = raw_input('Enter PIN from browser: ')
+pin = raw_input('Enter PIN from browser: ')  # `input` if using Python 3!
 ```
 
 Exchange the authorized request token for an authenticated `OAuth1Session`:
@@ -79,9 +79,9 @@ params = {'include_rts': 1,  # Include retweets
 r = session.get('statuses/home_timeline.json', params=params)
 
 for i, tweet in enumerate(r.json(), 1):
-    handle = tweet['user']['screen_name'].encode('utf-8')
-    text = tweet['text'].encode('utf-8')
-    print '{0}. @{1} - {2}'.format(i, handle, text)
+    handle = tweet['user']['screen_name']
+    text = tweet['text']
+    print(u'{0}. @{1} - {2}'.format(i, handle, text))
 ```
 
 Here's the full example: [examples/twitter-timeline-cli.py](https://github.com/litl/rauth/blob/master/examples/twitter-timeline-cli.py).
@@ -103,7 +103,8 @@ Basically there's just a few steps to getting started:
 
 Note: Before you make a pull request, please run `make check`. If your code
 passes then you should be good to go! Requirements for running tests are in
-`requirements.txt`.
+`requirements-dev@<python-version>.txt`. You may also want to run `tox` to
+ensure that nothing broke in other supported environments, e.g. Python 3.
 
 ## Copyright and License
 

README.markdown renamed to README.md

@@ -1,5 +1,10 @@
-from rauth.service import OAuth1Service
-
+from rauth import OAuth1Service
+ 
+try:
+    read_input = raw_input
+except NameError:
+    read_input = input
+ 
 # Get a real consumer key & secret from https://dev.twitter.com/apps/new
 twitter = OAuth1Service(
     name='twitter',
@@ -8,26 +13,26 @@
     request_token_url='https://api.twitter.com/oauth/request_token',
     access_token_url='https://api.twitter.com/oauth/access_token',
     authorize_url='https://api.twitter.com/oauth/authorize',
-    base_url='https://api.twitter.com/1/')
-
+    base_url='https://api.twitter.com/1.1/')
+ 
 request_token, request_token_secret = twitter.get_request_token()
-
+ 
 authorize_url = twitter.get_authorize_url(request_token)
-
-print 'Visit this URL in your browser: ' + authorize_url
-pin = raw_input('Enter PIN from browser: ')
-
+ 
+print('Visit this URL in your browser: {url}'.format(url=authorize_url))
+pin = read_input('Enter PIN from browser: ')
+ 
 session = twitter.get_auth_session(request_token,
                                    request_token_secret,
                                    method='POST',
                                    data={'oauth_verifier': pin})
-
+ 
 params = {'include_rts': 1,  # Include retweets
           'count': 10}       # 10 tweets
-
-r = session.get('statuses/home_timeline.json', params=params)
-
+ 
+r = session.get('statuses/home_timeline.json', params=params, verify=True)
+ 
 for i, tweet in enumerate(r.json(), 1):
-    handle = tweet['user']['screen_name'].encode('utf-8')
-    text = tweet['text'].encode('utf-8')
-    print '{0}. @{1} - {2}'.format(i, handle, text)
+    handle = tweet['user']['screen_name']
+    text = tweet['text']
+    print(u'{0}. @{1} - {2}'.format(i, handle, text))

examples/facebook-cli.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+'''
+    rauth.compat
+    ------------
+
+    A module providing tools for cross-version compatibility.
+'''
+import sys
+
+
+if sys.version_info < (3, 0):  # pragma: no cover
+    from urllib import quote, urlencode
+    from urlparse import parse_qsl, urlsplit, urlunsplit, urljoin
+
+    def is_basestring(astring):
+        return isinstance(astring, basestring)  # NOQA
+
+    def iteritems(adict):
+        return adict.iteritems()
+
+else:  # pragma: no cover
+    from urllib.parse import (quote, urlencode, parse_qsl, urlsplit,
+                              urlunsplit, urljoin)
+
+    # placate pyflakes
+    (quote, urlencode, parse_qsl, urlsplit, urlunsplit, urljoin)
+
+    def is_basestring(astring):
+        return isinstance(astring, (str, bytes))
+
+    def iteritems(adict):
+        return adict.items()

examples/twitter-timeline-cli.py

@@ -10,18 +10,20 @@
 import hmac
 
 from hashlib import sha1
-from urllib import quote, urlencode
-from urlparse import urlsplit, urlunsplit
 
+from rauth.compat import is_basestring, quote, urlencode, urlsplit, urlunsplit
 from rauth.utils import FORM_URLENCODED
 
 
 class SignatureMethod(object):
-    '''A base class for signature methods providing a set of common methods.'''
-    def _encode_utf8(self, s):
-        if isinstance(s, unicode):
+    '''
+    A base class for signature methods providing a set of common methods.
+    '''
+
+    def _ensure_unicode(self, s):
+        if not isinstance(s, bytes):
             return s.encode('utf-8')
-        return unicode(s, 'utf-8').encode('utf-8')
+        return s.decode('utf-8')  # pragma: no cover
 
     def _escape(self, s):
         '''
@@ -30,7 +32,7 @@ def _escape(self, s):
         :param s: A string to be encoded.
         :type s: str
         '''
-        return quote(self._encode_utf8(s), safe='~')
+        return quote(self._ensure_unicode(s), safe='~').encode('utf-8')
 
     def _remove_qs(self, url):
         '''
@@ -134,12 +136,12 @@ def sign(self,
             self._normalize_request_parameters(oauth_params, req_kwargs)
         parameters = map(self._escape, [method, url, oauth_params])
 
-        key = self._escape(consumer_secret) + '&'
+        key = self._escape(consumer_secret) + b'&'
         if access_token_secret is not None:
             key += self._escape(access_token_secret)
 
         # build a Signature Base String
-        signature_base_string = '&'.join(parameters)
+        signature_base_string = b'&'.join(parameters)
 
         # hash the string with HMAC-SHA1
         hashed = hmac.new(key, signature_base_string, sha1)
@@ -164,7 +166,7 @@ def __init__(self):
             from Crypto.Signature import PKCS1_v1_5 as p
             self.RSA, self.SHA, self.PKCS1_v1_5 = r, s, p
         except ImportError:  # pragma: no cover
-            raise NotImplementedError("PyCrypto is required for "+self.NAME)
+            raise NotImplementedError("PyCrypto is required for " + self.NAME)
 
     def sign(self,
              consumer_secret,
@@ -196,16 +198,17 @@ def sign(self,
         parameters = map(self._escape, [method, url, oauth_params])
 
         # build a Signature Base String
-        signature_base_string = '&'.join(parameters)
+        signature_base_string = b'&'.join(parameters)
 
         # resolve the key
-        if isinstance(consumer_secret, basestring):
+        if is_basestring(consumer_secret):
             consumer_secret = self.RSA.importKey(consumer_secret)
         if not isinstance(consumer_secret, self.RSA._RSAobj):
             raise ValueError("invalid consumer_secret")
 
         # hash the string with RSA-SHA1
         s = self.PKCS1_v1_5.new(consumer_secret)
+        # PyCrypto SHA.new requires an encoded byte string
         h = self.SHA.new(signature_base_string)
         hashed = s.sign(h)
 

rauth/compat.py

@@ -6,11 +6,10 @@
     Provides OAuth 1.0/a, 2.0 and Ofly service containers.
 '''
 
+from rauth.compat import urlencode
 from rauth.session import OAuth1Session, OAuth2Session, OflySession
 from rauth.utils import ENTITY_METHODS, parse_utf8_qsl
 
-from urllib import urlencode
-
 PROCESS_TOKEN_ERROR = ('Decoder failed to handle {key} with data as returned '
                        'by provider. A different decoder may be needed. '
                        'Provider returned: {raw}')
@@ -20,7 +19,7 @@ def process_token_request(r, decoder, *args):
     try:
         data = decoder(r.content)
         return tuple(data[key] for key in args)
-    except KeyError, e:  # pragma: no cover
+    except KeyError as e:  # pragma: no cover
         bad_key = e.args[0]
         raise KeyError(PROCESS_TOKEN_ERROR.format(key=bad_key, raw=r.content))