upgrade to django-browserid==0.7.1

lib/python/django_browserid/__init__.py

@@ -5,5 +5,7 @@
 License, v. 2.0. If a copy of the MPL was not distributed with this
 file, You can obtain one at http://mozilla.org/MPL/2.0/.
 """
-from django_browserid.auth import BrowserIDBackend
-from django_browserid.base import get_audience, verify
+__version__ = '0.7.1'
+
+from django_browserid.auth import BrowserIDBackend  # NOQA
+from django_browserid.base import get_audience, verify  # NOQA

lib/python/django_browserid/auth.py

@@ -6,24 +6,24 @@
 import base64
 import hashlib
 import logging
-from warnings import warn
 
 from django.conf import settings
-from django.contrib.auth.models import User
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.importlib import import_module
 
-from django_browserid.base import get_audience as base_get_audience, verify
+from django_browserid.base import verify
 from django_browserid.signals import user_created
 
+try:
+    from django.contrib.auth import get_user_model
+except ImportError:
+    from django.contrib.auth.models import User
 
-log = logging.getLogger(__name__)
+    def get_user_model(*args, **kwargs):
+        return User
 
 
-def get_audience(*args):
-    warn('Deprecated, please use the standalone function '
-         'django_browserid.get_audience instead.', DeprecationWarning)
-    return base_get_audience(*args)
+log = logging.getLogger(__name__)
 
 
 def default_username_algo(email):
@@ -40,14 +40,17 @@ class BrowserIDBackend(object):
     supports_inactive_user = True
     supports_object_permissions = False
 
-    def verify(self, *args):
-        warn('Deprecated, please use the standalone function '
-             'django_browserid.verify instead.', DeprecationWarning)
-        return verify(*args)
+    def __init__(self):
+        """
+        Store the current user model on creation to avoid issues if
+        settings.AUTH_USER_MODEL changes, which usually only happens during
+        tests.
+        """
+        self.User = get_user_model()
 
     def filter_users_by_email(self, email):
         """Return all users matching the specified email."""
-        return User.objects.filter(email=email)
+        return self.User.objects.filter(email=email)
 
     def create_user(self, email):
         """Return object for a newly created user account."""
@@ -57,7 +60,7 @@ def create_user(self, email):
         else:
             username = default_username_algo(email)
 
-        return User.objects.create_user(username, email)
+        return self.User.objects.create_user(username, email)
 
     def authenticate(self, assertion=None, audience=None):
         """``django.contrib.auth`` compatible authentication method.
@@ -81,7 +84,8 @@ def authenticate(self, assertion=None, audience=None):
         # log and bail. randomly selecting one seems really wrong.
         users = self.filter_users_by_email(email=email)
         if len(users) > 1:
-            log.warn('%d users with email address %s.' % (len(users), email))
+            log.warn('{0} users with email address {1}.'.format(len(users),
+                                                                email))
             return None
         if len(users) == 1:
             return users[0]
@@ -90,7 +94,7 @@ def authenticate(self, assertion=None, audience=None):
         if not create_user:
             return None
         else:
-            if create_user == True:
+            if create_user is True:
                 create_function = self.create_user
             else:
                 # Find the function to call.
@@ -102,8 +106,8 @@ def authenticate(self, assertion=None, audience=None):
 
     def get_user(self, user_id):
         try:
-            return User.objects.get(pk=user_id)
-        except User.DoesNotExist:
+            return self.User.objects.get(pk=user_id)
+        except self.User.DoesNotExist:
             return None
 
     def _load_module(self, path):
@@ -125,6 +129,6 @@ def _load_module(self, path):
         try:
             create_user = getattr(mod, attr)
         except AttributeError:
-            raise ImproperlyConfigured('Module "%s" does not define a "%s" '
-                                       'function.' % (module, attr))
+            raise ImproperlyConfigured('Module {0} does not define a {1} '
+                                       'function.'.format(module, attr))
         return create_user

lib/python/django_browserid/base.py

@@ -9,7 +9,7 @@
 try:
     import json
 except ImportError:
-    import simplejson as json
+    import simplejson as json  # NOQA
 
 
 from django.conf import settings
@@ -21,7 +21,7 @@
 
 
 DEFAULT_HTTP_TIMEOUT = 5
-DEFAULT_VERIFICATION_URL = 'https://browserid.org/verify'
+DEFAULT_VERIFICATION_URL = 'https://verifier.login.persona.org/verify'
 OKAY_RESPONSE = 'okay'
 
 
@@ -36,17 +36,6 @@ def get_audience(request):
         SITE_URL = 'https://example.com'
         SITE_URL = 'http://example.com'
 
-    If you don't have a SITE_URL you can also use these varables:
-    PROTOCOL, DOMAIN, and (optionally) PORT.
-    Example 1:
-        PROTOCOL = 'https://'
-        DOMAIN = 'example.com'
-
-    Example 2:
-        PROTOCOL = 'http://'
-        DOMAIN = '127.0.0.1'
-        PORT = '8001'
-
     If none are set, we trust the request to populate the audience.
     This is *not secure*!
     """
@@ -59,32 +48,11 @@ def get_audience(request):
         req_proto = 'http://'
     req_domain = request.get_host()
 
-    # If we don't define it explicitly
-    if not site_url:
-        warn('Using DOMAIN and PROTOCOL to specify your BrowserID audience is '
-             'deprecated. Please use the SITE_URL setting instead.',
-             DeprecationWarning)
-
-        # DOMAIN is example.com req_domain is example.com:8001
-        domain = getattr(settings, 'DOMAIN', req_domain.split(':')[0])
-        protocol = getattr(settings, 'PROTOCOL', req_proto)
-
-        standards = {'https://': 443, 'http://': 80}
-        if ':' in req_domain:
-            req_port = req_domain.split(':')[1]
-        else:
-            req_port = None
-        port = getattr(settings, 'PORT', req_port or standards[protocol])
-        if port == standards[protocol]:
-            site_url = ''.join(map(str, (protocol, domain)))
-        else:
-            site_url = ''.join(map(str, (protocol, domain, ':', port)))
-
     req_url = "%s%s" % (req_proto, req_domain)
     if site_url != "%s%s" % (req_proto, req_domain):
-        log.warning('Misconfigured SITE_URL? settings has [%s], but '
-                    'actual request was [%s] BrowserID may fail on '
-                    'audience' % (site_url, req_url))
+        log.warning('Misconfigured SITE_URL? settings has {0}, but '
+                    'actual request was {1} BrowserID may fail on '
+                    'audience'.format(site_url, req_url))
     return site_url
 
 
@@ -94,10 +62,8 @@ def _verify_http_request(url, qs):
         'proxies': getattr(settings, 'BROWSERID_PROXY_INFO', None),
         'verify': not getattr(settings, 'BROWSERID_DISABLE_CERT_CHECK', False),
         'headers': {'Content-type': 'application/x-www-form-urlencoded'},
-        'params': {
-            'timeout': getattr(settings, 'BROWSERID_HTTP_TIMEOUT',
-                               DEFAULT_HTTP_TIMEOUT)
-        }
+        'timeout': getattr(settings, 'BROWSERID_HTTP_TIMEOUT',
+                           DEFAULT_HTTP_TIMEOUT),
     }
 
     if parameters['verify']:
@@ -108,8 +74,7 @@ def _verify_http_request(url, qs):
     try:
         rv = json.loads(r.content)
     except ValueError:
-        log.debug('Failed to decode JSON. Resp: %s, Content: %s' %
-                  (r.status_code, r.content))
+        log.debug('Failed to decode JSON. Resp: {0}, Content: {1}'.format(r.status_code, r.content))
         return dict(status='failure')
 
     return rv
@@ -120,7 +85,7 @@ def verify(assertion, audience):
     verify_url = getattr(settings, 'BROWSERID_VERIFICATION_URL',
                          DEFAULT_VERIFICATION_URL)
 
-    log.info("Verification URL: %s" % verify_url)
+    log.info("Verification URL: {0}".format(verify_url))
 
     result = _verify_http_request(verify_url, urllib.urlencode({
         'assertion': assertion,
@@ -130,7 +95,7 @@ def verify(assertion, audience):
     if result['status'] == OKAY_RESPONSE:
         return result
 
-    log.error('BrowserID verification failure. Response: %r '
-              'Audience: %r' % (result, audience))
-    log.error("BID assert: %r" % assertion)
+    log.error('BrowserID verification failure. Response: {0} '
+              'Audience: {1}'.format(result, audience))
+    log.error("BID assert: {0}".format(assertion))
     return False

lib/python/django_browserid/forms.py

@@ -10,4 +10,4 @@ class BrowserIDForm(forms.Form):
     assertion = forms.CharField(widget=forms.HiddenInput())
 
     class Media:
-        js = ('browserid/browserid.js', 'https://browserid.org/include.js')
+        js = ('browserid/browserid.js', 'https://login.persona.org/include.js')

lib/python/django_browserid/static/browserid/browserid.js

@@ -1,15 +1,67 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
- $(document).ready(function() {
-    $('#browserid').bind('click', function(e) {
-        e.preventDefault();
-        navigator.id.getVerifiedEmail(function(assertion) {
-            if (assertion) {
-                var $e = $('#id_assertion');
-                $e.val(assertion.toString());
-                $e.parent().submit();
+
+(function($) {
+    'use strict';
+
+    $(function() {
+        // State? Ewwwwww.
+        var logoutButton = null;
+        var requestOptions = [
+            'siteName',
+            'siteLogo',
+            'oncancel',
+            'privacyPolicy',
+            'returnTo',
+            'termsOfService'
+        ];
+
+        $(document).delegate('.browserid-login, #browserid', 'click', function(e) {
+            e.preventDefault();
+
+            // Arguments to navigator.id.request can be specified by data-attributes
+            // on the BrowserID link: <a href="#" data-site-name="Site Name">
+            var options = {};
+            var $link = $(e.target);
+            for (var k = 0; k < requestOptions.length; k++) {
+                var name = requestOptions[k];
+                var value = $link.data(name);
+                if (value !== undefined) {
+                    options[name] = value;
+                }
+            }
+
+            navigator.id.request(options); // Triggers BrowserID login dialog.
+        });
+
+        $('.browserid-logout').bind('click', function(e) {
+            e.preventDefault();
+            logoutButton = e.target;
+            navigator.id.logout(); // Clears User Agent BrowserID state.
+        });
+
+        navigator.id.watch({
+            onlogin: function(assertion) {
+                // Don't bother if login just failed.
+                if (location.search.indexOf('bid_login_failed=1') !== -1) {
+                    navigator.id.logout();
+                } else if (assertion) {
+                    var $e = $('#id_assertion');
+                    $e.val(assertion.toString());
+                    $e.parent().submit();
+                }
+            },
+
+            onlogout: function() {
+                var currentButton = logoutButton;
+                if (currentButton !== null) {
+                    logoutButton = null;
+                    if (currentButton.href) {
+                        window.location = currentButton.href;
+                    }
+                }
             }
         });
     });
-});
+})(jQuery);

lib/python/django_browserid/tests/__init__.py

@@ -31,7 +31,7 @@ def __init__(self, email=None, audience=None):
         self.return_value = {
             u'audience': audience,
             u'email': email,
-            u'issuer': u'browserid.org:443',
+            u'issuer': u'login.persona.org:443',
             u'status': u'okay' if email is not None else u'failure',
             u'valid-until': 1311377222765
         }

lib/python/django_browserid/tests/models.py

@@ -0,0 +1,23 @@
+"""
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at http://mozilla.org/MPL/2.0/.
+"""
+from django.db import models
+
+try:
+    from django.contrib.auth.models import AbstractBaseUser
+except ImportError:
+    AbstractBaseUser = object
+
+
+class CustomUser(AbstractBaseUser):
+    USERNAME_FIELD = 'email'
+
+    email = models.EmailField(unique=True, db_index=True)
+
+    def get_full_name(self):
+        return self.email
+
+    def get_short_name(self):
+        return self.email

lib/python/django_browserid/tests/settings.py

@@ -5,6 +5,8 @@
 """
 TEST_RUNNER = 'django_nose.runner.NoseTestSuiteRunner'
 
+SECRET_KEY = 'asdf'
+
 DATABASES = {
     'default': {
         'NAME': 'test.db',
@@ -15,6 +17,7 @@
 INSTALLED_APPS = (
     'django_nose',
     'django_browserid',
+    'django_browserid.tests',
 
     'django.contrib.auth',
     'django.contrib.contenttypes',