PEP 8

CHANGES

@@ -3,6 +3,21 @@ Flask-Security Changelog
 
 Here you can see the full list of changes between each Flask-Security release.
 
+Version 1.2.3
+-------------
+
+Released June 12th, 2012
+
+- Fixed a bug in the RoleMixin eq/ne functions
+
+Version 1.2.2
+-------------
+
+Released April 27th, 2012
+
+- Fixed bug where `roles_required` and `roles_accepted` did not pass the next
+  argument to the login view
+
 Version 1.2.1
 -------------
 

docs/conf.py

@@ -18,7 +18,7 @@ import sys, os
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.abspath('_themes'))
-from flask_security import __version__
+#from setup import __version__
 
 # -- General configuration -----------------------------------------------------
 
@@ -50,7 +50,7 @@ copyright = u'2012, Matt Wright'
 # built documents.
 #
 # The short X.Y version.
-version = __version__
+version = '1.2.3'
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/index.rst

@@ -85,7 +85,7 @@ First thing you'll want to do is setup your application and datastore::
     from flask.ext.sqlalchemy import SQLAlchemy
     from flask.ext.security import (User, Security, LoginForm,  login_required, 
                                     roles_accepted, user_datastore)
-    from flask.ext.security.datastore.sqlalchemy import SQLAlchemyUserDataStore
+    from flask.ext.security.datastore.sqlalchemy import SQLAlchemyUserDatastore
     
     app = Flask(__name__)
     app.config['SECRET_KEY'] = 'secret'
@@ -94,14 +94,14 @@ First thing you'll want to do is setup your application and datastore::
     db = SQLAlchemy(app)
     Security(app, SQLAlchemyUserDatastore(db))
 
-You'll probably want to at least one user to the database to test this out, so 
+You'll probably want to at least one user to the database to test this out. 
-you can add something such as the following to quickly add an initial user::
+There are many ways to do this, but this is a quick and dirty way to do it::
 
     @app.before_first_request
     def before_first_request():
         user_datastore.create_role(name='admin')
         user_datastore.create_user(username='matt', email='matt@something.com',
-                                   password='password', roles['admin'])
+                                   password='password', roles=['admin'])
         
 Next you'll want to setup your login screen. Setup your view::
 

example/templates/login.html

@@ -5,6 +5,7 @@
   {{ form.username.label }} {{ form.username }}<br/>
   {{ form.password.label }} {{ form.password }}<br/>
   {{ form.remember.label }} {{ form.remember }}<br/>
+  {{ form.next }}
   {{ form.submit }}
 </form>
 <p>{{ content }}</p>

flask_security/__init__.py

@@ -10,47 +10,43 @@
     :license: MIT, see LICENSE for more details.
 """
 
-__version__ = '1.2.1'
-
-import sys
-
-from datetime import datetime
-from types import StringType
-
-from flask import (current_app, Blueprint, flash, redirect, request, 
-    session, _request_ctx_stack, url_for, abort, g)
-
-from flask.ext.login import (AnonymousUser as AnonymousUserBase, 
-    UserMixin as BaseUserMixin, LoginManager, login_required, login_user, 
-    logout_user, current_user, user_logged_in, user_logged_out)
-
-from flask.ext.principal import (Identity, Principal, RoleNeed, UserNeed,
-    Permission, AnonymousIdentity, identity_changed, identity_loaded)
-
-from flask.ext.wtf import (Form, TextField, PasswordField, SubmitField, 
-    HiddenField, Required, ValidationError, BooleanField, Email)
-
 from functools import wraps
+
+from flask import current_app, Blueprint, flash, redirect, request, \
+     session, url_for
+
+from flask.ext.login import AnonymousUser as AnonymousUserBase, \
+     UserMixin as BaseUserMixin, LoginManager, login_required, login_user, \
+     logout_user, current_user, login_url
+
+from flask.ext.principal import Identity, Principal, RoleNeed, UserNeed, \
+     Permission, AnonymousIdentity, identity_changed, identity_loaded
+
+from flask.ext.wtf import Form, TextField, PasswordField, SubmitField, \
+     HiddenField, Required, BooleanField
+
 from passlib.context import CryptContext
-from werkzeug.utils import import_string
+
 from werkzeug.local import LocalProxy
 
+
 class User(object):
     """User model"""
 
+
 class Role(object):
     """Role model"""
 
-URL_PREFIX_KEY =     'SECURITY_URL_PREFIX'
+URL_PREFIX_KEY = 'SECURITY_URL_PREFIX'
-AUTH_PROVIDER_KEY =  'SECURITY_AUTH_PROVIDER'
+AUTH_PROVIDER_KEY = 'SECURITY_AUTH_PROVIDER'
-PASSWORD_HASH_KEY =  'SECURITY_PASSWORD_HASH'
+PASSWORD_HASH_KEY = 'SECURITY_PASSWORD_HASH'
 USER_DATASTORE_KEY = 'SECURITY_USER_DATASTORE'
-LOGIN_FORM_KEY =     'SECURITY_LOGIN_FORM'
+LOGIN_FORM_KEY = 'SECURITY_LOGIN_FORM'
-AUTH_URL_KEY =       'SECURITY_AUTH_URL'
+AUTH_URL_KEY = 'SECURITY_AUTH_URL'
-LOGOUT_URL_KEY =     'SECURITY_LOGOUT_URL'
+LOGOUT_URL_KEY = 'SECURITY_LOGOUT_URL'
-LOGIN_VIEW_KEY =     'SECURITY_LOGIN_VIEW'
+LOGIN_VIEW_KEY = 'SECURITY_LOGIN_VIEW'
-POST_LOGIN_KEY =     'SECURITY_POST_LOGIN'
+POST_LOGIN_KEY = 'SECURITY_POST_LOGIN'
-POST_LOGOUT_KEY =    'SECURITY_POST_LOGOUT'
+POST_LOGOUT_KEY = 'SECURITY_POST_LOGOUT'
 FLASH_MESSAGES_KEY = 'SECURITY_FLASH_MESSAGES'
 
 DEBUG_LOGIN = 'User %s logged in. Redirecting to: %s'
@@ -80,34 +76,41 @@ class BadCredentialsError(Exception):
     provided credentials.
     """
 
+
 class AuthenticationError(Exception):
     """Raised when an authentication attempt fails due to invalid configuration
     or an unknown reason.
     """
 
+
 class UserNotFoundError(Exception):
     """Raised by a user datastore when there is an attempt to find a user by
     their identifier, often username or email, and the user is not found.
     """
 
+
 class RoleNotFoundError(Exception):
     """Raised by a user datastore when there is an attempt to find a role and
     the role cannot be found.
     """
 
+
 class UserIdNotFoundError(Exception):
     """Raised by a user datastore when there is an attempt to find a user by
     ID and the user is not found.
     """
 
+
 class UserDatastoreError(Exception):
     """Raised when a user datastore experiences an unexpected error
     """
 
+
 class UserCreationError(Exception):
     """Raised when an error occurs when creating a user
     """
 
+
 class RoleCreationError(Exception):
     """Raised when an error occurs when creating a role
     """
@@ -129,6 +132,7 @@ pwd_context = LocalProxy(lambda: current_app.pwd_context)
 user_datastore = LocalProxy(lambda: getattr(current_app,
     current_app.config[USER_DATASTORE_KEY]))
 
+
 def roles_required(*args):
     """View decorator which specifies that a user must have all the specified
     roles. Example::
@@ -145,11 +149,13 @@ def roles_required(*args):
     """
     roles = args
     perm = Permission(*[RoleNeed(role) for role in roles])
+
     def wrapper(fn):
         @wraps(fn)
         def decorated_view(*args, **kwargs):
             if not current_user.is_authenticated():
-                return redirect(current_app.config[LOGIN_VIEW_KEY])
+                return redirect(
+                    login_url(current_app.config[LOGIN_VIEW_KEY], request.url))
 
             if perm.can():
                 return fn(*args, **kwargs)
@@ -179,11 +185,13 @@ def roles_accepted(*args):
     """
     roles = args
     perms = [Permission(RoleNeed(role)) for role in roles]
+
     def wrapper(fn):
         @wraps(fn)
         def decorated_view(*args, **kwargs):
             if not current_user.is_authenticated():
-                return redirect(current_app.config[LOGIN_VIEW_KEY])
+                return redirect(
+                    login_url(current_app.config[LOGIN_VIEW_KEY], request.url))
 
             for perm in perms:
                 if perm.can():
@@ -201,10 +209,10 @@ def roles_accepted(*args):
 class RoleMixin(object):
     """Mixin for `Role` model definitions"""
     def __eq__(self, other):
-        return self.name == other.name
+        return self.name == other or self.name == getattr(other, 'name', None)
 
     def __ne__(self, other):
-        return self.name != other.name
+        return self.name != other and self.name != getattr(other, 'name', None)
 
     def __str__(self):
         return '<Role name=%s, description=%s>' % (self.name, self.description)
@@ -221,8 +229,6 @@ class UserMixin(BaseUserMixin):
         """Returns `True` if the user identifies with the specified role.
 
         :param role: A role name or `Role` instance"""
-        if not isinstance(role, Role):
-            role = Role(name=role)
         return role in self.roles
 
     def __str__(self):
@@ -233,7 +239,7 @@ class UserMixin(BaseUserMixin):
 class AnonymousUser(AnonymousUserBase):
     def __init__(self):
         super(AnonymousUser, self).__init__()
-        self.roles = [] # TODO: Make this immutable?
+        self.roles = []  # TODO: Make this immutable?
 
     def has_role(self, *args):
         """Returns `False`"""
@@ -256,7 +262,8 @@ class Security(object):
         :param app: The application.
         :param datastore: An instance of a user datastore.
         """
-        if app is None or datastore is None: return
+        if app is None or datastore is None:
+            return
 
         # TODO: change blueprint name
         blueprint = Blueprint('auth', __name__)
@@ -308,6 +315,7 @@ class Security(object):
                 return None
 
         auth_url = config[AUTH_URL_KEY]
+
         @blueprint.route(auth_url, methods=['POST'], endpoint='authenticate')
         def authenticate():
             try:
@@ -424,6 +432,7 @@ class AuthenticationProvider(object):
         logger.error(msg)
         raise AuthenticationError(msg)
 
+
 def do_flash(message, category):
     if current_app.config[FLASH_MESSAGES_KEY]:
         flash(message, category)
@@ -433,11 +442,12 @@ def get_class_by_name(clazz):
     """Get a reference to a class by its string representation."""
     parts = clazz.split('.')
     module = ".".join(parts[:-1])
-    m = __import__( module )
+    m = __import__(module)
     for comp in parts[1:]:
         m = getattr(m, comp)
     return m
 
+
 def get_class_from_config(key, config):
     """Get a reference to a class by its configuration key name."""
     try:
@@ -447,6 +457,7 @@ def get_class_from_config(key, config):
             "Could not get class '%s' for Auth setting '%s' >> %s" %
             (config[key], key, e))
 
+
 def get_url(endpoint_or_url):
     """Returns a URL if a valid endpoint is found. Otherwise, returns the
     provided value."""
@@ -455,12 +466,14 @@ def get_url(endpoint_or_url):
     except:
         return endpoint_or_url
 
+
 def get_post_login_redirect():
     """Returns the URL to redirect to after a user logs in successfully"""
     return (get_url(request.args.get('next')) or
             get_url(request.form.get('next')) or
             find_redirect(POST_LOGIN_KEY))
 
+
 def find_redirect(key):
     """Returns the URL to redirect to after a user logs in successfully"""
     result = (get_url(session.pop(key.lower(), None)) or

flask_security/datastore/__init__.py

@@ -13,6 +13,7 @@ from datetime import datetime
 from flask.ext import security
 from flask.ext.security import UserCreationError, RoleCreationError, pwd_context
 
+
 class UserDatastore(object):
     """Abstracted user datastore. Always extend this class and implement the
     :attr:`get_models`, :attr:`_save_model`, :attr:`_do_with_id`,
@@ -127,7 +128,8 @@ class UserDatastore(object):
 
         :param id: User ID"""
         user = self._do_with_id(id)
-        if user: return user
+        if user:
+            return user
         raise security.UserIdNotFoundError()
 
     def find_user(self, user):
@@ -136,7 +138,8 @@ class UserDatastore(object):
         :param user: User identifier, usually a username or email address
         """
         user = self._do_find_user(user)
-        if user: return user
+        if user:
+            return user
         raise security.UserNotFoundError()
 
     def find_role(self, role):
@@ -145,7 +148,8 @@ class UserDatastore(object):
         :param role: Role name
         """
         role = self._do_find_role(role)
-        if role: return role
+        if role:
+            return role
         raise security.RoleNotFoundError()
 
     def create_role(self, **kwargs):

flask_security/datastore/mongoengine.py

@@ -13,6 +13,7 @@ from flask.ext import security
 from flask.ext.security import UserMixin, RoleMixin
 from flask.ext.security.datastore import UserDatastore
 
+
 class MongoEngineUserDatastore(UserDatastore):
     """A MongoEngine datastore implementation for Flask-Security.
     Example usage::
@@ -48,7 +49,7 @@ class MongoEngineUserDatastore(UserDatastore):
             email = db.StringField(unique=True, max_length=255)
             password = db.StringField(required=True, max_length=120)
             active = db.BooleanField(default=True)
-            roles= db.ListField(db.ReferenceField(Role), default=[])
+            roles = db.ListField(db.ReferenceField(Role), default=[])
             created_at = db.DateTimeField()
             modified_at = db.DateTimeField()
 
@@ -59,8 +60,10 @@ class MongoEngineUserDatastore(UserDatastore):
         return model
 
     def _do_with_id(self, id):
-        try: return security.User.objects.get(id=id)
+        try:
-        except: return None
+            return security.User.objects.get(id=id)
+        except:
+            return None
 
     def _do_find_user(self, user):
         return security.User.objects(username=user).first() or \
@@ -68,4 +71,3 @@ class MongoEngineUserDatastore(UserDatastore):
 
     def _do_find_role(self, role):
         return security.Role.objects(name=role).first()
-    

flask_security/datastore/sqlalchemy.py

@@ -13,6 +13,7 @@ from flask.ext import security
 from flask.ext.security import UserMixin, RoleMixin
 from flask.ext.security.datastore import UserDatastore
 
+
 class SQLAlchemyUserDatastore(UserDatastore):
     """A SQLAlchemy datastore implementation for Flask-Security.
     Example usage::
@@ -59,7 +60,7 @@ class SQLAlchemyUserDatastore(UserDatastore):
             created_at = db.Column(db.DateTime())
             modified_at = db.Column(db.DateTime())
 
-            roles= db.relationship('Role', secondary=roles_users,
+            roles = db.relationship('Role', secondary=roles_users,
                                     backref=db.backref('users', lazy='dynamic'))
 
             def __init__(self, username=None, email=None, password=None,
@@ -89,4 +90,3 @@ class SQLAlchemyUserDatastore(UserDatastore):
 
     def _do_find_role(self, role):
         return security.Role.query.filter_by(name=role).first()
-    

flask_security/script.py

@@ -11,9 +11,11 @@
 
 import json
 import re
+
 from flask.ext.script import Command, Option
-from flask.ext.security import (UserCreationError, UserNotFoundError, 
+
-                                RoleNotFoundError, user_datastore) 
+from flask.ext.security import user_datastore
+
 
 def pprint(obj):
     print json.dumps(obj, sort_keys=True, indent=4)
@@ -33,7 +35,7 @@ class CreateUserCommand(Command):
     def run(self, **kwargs):
         # sanitize active input
         ai = re.sub(r'\s', '', str(kwargs['active']))
-        kwargs['active'] = ai.lower() in ['', 'y','yes', '1', 'active']
+        kwargs['active'] = ai.lower() in ['', 'y', 'yes', '1', 'active']
 
         # sanitize role input a bit
         ri = re.sub(r'\s', '', kwargs['roles'])
@@ -55,7 +57,7 @@ class CreateRoleCommand(Command):
     )
 
     def run(self, **kwargs):
-        role = user_datastore.create_role(**kwargs)
+        user_datastore.create_role(**kwargs)
         print 'Role "%(name)s" created successfully.' % kwargs
 
 
@@ -87,6 +89,7 @@ class _ToggleActiveCommand(Command):
         Option('-u', '--user', dest='user_identifier'),
     )
 
+
 class DeactivateUserCommand(_ToggleActiveCommand):
     """Deactive a user"""
 
@@ -94,6 +97,7 @@ class DeactivateUserCommand(_ToggleActiveCommand):
         user_datastore.deactivate_user(user_identifier)
         print "User '%s' has been deactivated" % user_identifier
 
+
 class ActivateUserCommand(_ToggleActiveCommand):
     """Deactive a user"""
 

requirements.txt

@@ -0,0 +1,6 @@
+Flask==0.8
+Flask-Login==0.1
+Flask-Principal==0.2
+Flask-Script==0.3.2
+Flask-WTF==0.5.4
+passlib=1.5.3

setup.py

@@ -12,12 +12,12 @@ Links
   <https://github.com/mattupstate/flask-security/raw/develop#egg=Flask-Security-dev>`_
 
 """
-from flask_security import __version__
+
 from setuptools import setup
 
 setup(
     name='Flask-Security',
-    version=__version__,
+    version='1.2.3',
     url='https://github.com/mattupstate/flask-security',
     license='MIT',
     author='Matthew Wright',

tests/functional_tests.py

@@ -1,6 +1,7 @@
 import unittest
 from example import app
 
+
 class SecurityTest(unittest.TestCase):
 
     AUTH_CONFIG = None
@@ -26,7 +27,6 @@ class SecurityTest(unittest.TestCase):
                 follow_redirects=follow_redirects,
                 content_type=content_type or 'text/html')
 
-    
     def authenticate(self, username, password, endpoint=None):
         data = dict(username=username, password=password)
         return self._post(endpoint or '/auth', data=data,
@@ -35,6 +35,7 @@ class SecurityTest(unittest.TestCase):
     def logout(self, endpoint=None):
         return self._get(endpoint or '/logout', follow_redirects=True)
 
+
 class DefaultSecurityTests(SecurityTest):
 
     def test_login_view(self):
@@ -100,6 +101,10 @@ class DefaultSecurityTests(SecurityTest):
         r = self._get("/admin_or_editor", follow_redirects=True)
         self.assertIn('Home Page', r.data)
 
+    def test_unauthenticated_role_required(self):
+        r = self._get('/admin', follow_redirects=True)
+        self.assertIn('<input id="next"', r.data)
+
 
 class ConfiguredSecurityTests(SecurityTest):
 

tests/unit_tests.py

@@ -2,6 +2,7 @@ import unittest
 import flask_security
 from flask_security import RoleMixin, UserMixin, AnonymousUser
 
+
 class Role(RoleMixin):
     def __init__(self, name, description=None):
         self.name = name
@@ -24,6 +25,7 @@ editor = Role('editor')
 
 user = User('matt', 'matt@lp.com', [admin, editor])
 
+
 class SecurityEntityTests(unittest.TestCase):
 
     def test_role_mixin_equal(self):