pyramid-fullauth 0.3.1__py2.7.egg → 0.5.0__py2.7.egg

EGG-INFO/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: pyramid-fullauth
-Version: 0.3.1
+Version: 0.5.0
 Summary: This package intends to provide full authentication / authorisation
     implementation for pyramid applications
 Home-page: https://github.com/fizyk/pyramid_fullauth
@@ -14,6 +14,10 @@ Description: pyramid_fullauth
             :target: https://pypi.python.org/pypi/pyramid_fullauth/
             :alt: Latest PyPI version
         
+        .. image:: https://readthedocs.org/projects/pyramid_fullauth/badge/?version=v0.4.1
+            :target: https://readthedocs.org/projects/pyramid_fullauth/?badge=v0.4.1
+            :alt: Documentation Status
+        
         .. image:: https://pypip.in/d/pyramid_fullauth/badge.png
             :target: https://pypi.python.org/pypi/pyramid_fullauth/
             :alt: Number of PyPI downloads
@@ -35,17 +39,17 @@ Description: pyramid_fullauth
         Package status
         --------------
         
-        .. image:: https://travis-ci.org/fizyk/pyramid_fullauth.png?branch=master
+        .. image:: https://travis-ci.org/fizyk/pyramid_fullauth.png?branch=v0.4.1
             :target: https://travis-ci.org/fizyk/pyramid_fullauth
             :alt: Tests
         
-        .. image:: https://coveralls.io/repos/fizyk/pyramid_fullauth/badge.png?branch=master
-            :target: https://coveralls.io/r/fizyk/pyramid_fullauth?branch=master
+        .. image:: https://coveralls.io/repos/fizyk/pyramid_fullauth/badge.png?branch=v0.4.1
+            :target: https://coveralls.io/r/fizyk/pyramid_fullauth?branch=v0.4.1
             :alt: Coverage Status
         
-        .. image:: https://requires.io/github/fizyk/pyramid_fullauth/requirements.png?branch=master
-           :target: https://requires.io/github/fizyk/pyramid_fullauth/requirements/?branch=master
-           :alt: Requirements Status
+        .. image:: https://requires.io/github/fizyk/pyramid_fullauth/requirements.svg?tag=v0.4.1
+             :target: https://requires.io/github/fizyk/pyramid_fullauth/requirements/?tag=v0.4.1
+             :alt: Requirements Status
         
         Package resources
         -----------------
@@ -54,8 +58,8 @@ Description: pyramid_fullauth
         * Documentation: http://pyramid-fullauth.readthedocs.org/
         * PyPI: https://pypi.python.org/pypi/pyramid_fullauth
         
-        Instalation
-        -----------
+        Installation
+        ------------
         
         ``pip install pyramid_fullauth``
         
@@ -73,6 +77,39 @@ Description: pyramid_fullauth
         CHANGELOG
         =========
         
+        0.5.0
+        -------
+        
+        - full python3 compatibility, since velruse migrated to py3 enabled requests-oauth
+        -require velruse 1.1.1
+        - run tests with sqlalchemy 1.0.x
+        - small updates to conform with new linters versions embedded in pylama
+        
+        0.4.1
+        -------
+        
+        - fixed spelling for error message when user does not exist while trying to reset password.
+        - require pyramid_basemodel at least version 0.3
+        
+        0.4.0
+        -------
+        
+        - python 3 compatibility (without oauth2 though)
+        - cleared use of deprecated function `pyramid.security.authenticated_userid` in favour of `pyramid.request.Request.authenticated_userid` attribute.
+        - make email fields case insensitive by using hybrid properties and CaseInsensitive comparator for model.
+        
+        0.3.3
+        -------
+        
+        - Fix issue where groupfined was returning empty list instead of None when user did not existed
+        
+        0.3.2
+        -----
+        
+        - catch all HTTPRedirect instead of just HTTPFound.
+        - redirect with HTTPSeeOther instead of HTTPFound where applicable.
+        
+        
         0.3.1
         -----
         
@@ -159,6 +196,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.6
 Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

EGG-INFO/SOURCES.txt

@@ -25,6 +25,7 @@ docs/source/api/request.rst
 docs/source/api/tools.rst
 pyramid_fullauth/__init__.py
 pyramid_fullauth/auth.py
+pyramid_fullauth/compat.py
 pyramid_fullauth/events.py
 pyramid_fullauth/exceptions.py
 pyramid_fullauth/request.py
@@ -37,6 +38,7 @@ pyramid_fullauth.egg-info/requires.txt
 pyramid_fullauth.egg-info/top_level.txt
 pyramid_fullauth/config/default.yaml
 pyramid_fullauth/models/__init__.py
+pyramid_fullauth/models/extensions/__init__.py
 pyramid_fullauth/models/mixins/__init__.py
 pyramid_fullauth/models/mixins/email.py
 pyramid_fullauth/models/mixins/password.py

EGG-INFO/requires.txt

@@ -2,8 +2,8 @@ pyramid_localize
 pyramid >=1.4
 pyramid_mako
 tzf.pyramid_yml >=1.0
-pyramid_basemodel
-velruse
+pyramid_basemodel>=0.3
+velruse >=1.1.1
 
 [docs]
 sphinx
@@ -11,7 +11,5 @@ sphinx
 [tests]
 mock
 pytest_pyramid
-pytest-dbfixtures
-mysql-python
-psycopg2
-pytest-cov
+pytest-cov
+pytest-dbfixtures[mysql,postgresql]

EGG-INFO/top_level.txt

@@ -1,2 +1,2 @@
-tests
 pyramid_fullauth
+tests

pyramid_fullauth/__init__.py

@@ -3,7 +3,6 @@
 # This module is part of pyramid_fullauth and is released under
 # the MIT License (MIT): http://opensource.org/licenses/MIT
 """Fullauth's configuration module."""
-
 import logging
 
 from tzf.pyramid_yml import config_defaults
@@ -17,7 +16,7 @@ from pyramid_fullauth.auth import groupfinder
 from pyramid_fullauth.routing import predicates
 from pyramid_fullauth.request import login_perform, logout, user
 
-__version__ = '0.3.1'
+__version__ = '0.5.0'
 
 
 logger = logging.getLogger(__name__)
@@ -82,7 +81,8 @@ def includeme(configurator):
     # scan base views
     configurator.scan('pyramid_fullauth.views.basic')
 
-    # check for the social. If social is not available, we will not turn it on!
+    # check for the social.
+    # If social is not available, we will not turn it on!
     if 'social' in fullauth_config:
         # Velruse init (for social auth)
 

pyramid_fullauth/auth.py

@@ -38,7 +38,8 @@ def groupfinder(userid, request):
         else:
             groups.append('s:inactive')
 
-    return groups
+        return groups
+    return None
 
 
 class BaseACLRootFactoryMixin(object):

pyramid_fullauth/compat.py

@@ -0,0 +1,18 @@
+
+# Copyright (c) 2013 - 2015 by pyramid_fullauth authors and contributors <see AUTHORS file>
+#
+# This module is part of pyramid_fullauth and is released under
+# the MIT License (MIT): http://opensource.org/licenses/MIT
+"""pyramid_fullauth's compatibility file for python2 and 3."""
+
+import sys
+
+
+if sys.version_info.major == 2:
+    from urllib import urlencode
+    from urlparse import urlparse, parse_qs
+else:
+    from urllib.parse import urlencode, urlparse, parse_qs
+
+
+__all__ = ('urlencode', 'urlparse', 'parse_qs')

pyramid_fullauth/events.py

@@ -60,10 +60,12 @@ class AfterRegister(_BaseRegisterEvent):
         User object is already in a session.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
 
     .. warning::
-        If HTTPFound is risen from event listener, then response_values will not be used!
+        If HTTPRedirection is risen from event listener, then response_values
+        will not be used!
 
     """
 
@@ -85,7 +87,8 @@ class AfterActivate(_BaseRegisterEvent):
     Add custom post-processing logic after user gets activated.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     pass
@@ -97,7 +100,8 @@ class AfterResetRequest(_BaseRegisterEvent):
     Add custom post-processing after user sends request to reset password.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     pass
@@ -116,7 +120,8 @@ class AfterReset(_BaseRegisterEvent):
     Add custom post-processing after the actual reset-password process.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     pass
@@ -128,7 +133,8 @@ class AlreadyLoggedIn(object):
     Allow execute custom logic, when logged in user tries to log in again.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
 
     """
 
@@ -147,7 +153,8 @@ class BeforeLogIn(_BaseRegisterEvent):
     Add custom logic before user gets logged in.
 
     .. note::
-        Action emitting this event, should catch all AttributeError that might be risen in event listener.
+        Action emitting this event, should catch all AttributeError that might
+        be risen in event listener.
         User param set to None when user is not found or request method is GET.
     """
 
@@ -194,7 +201,8 @@ class AfterSocialRegister(_BaseSocialRegister):
     Add custom logic after user registers through social network.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     def __init__(self, request, user, profile, response_values):
@@ -216,7 +224,8 @@ class AfterSocialLogIn(_BaseSocialRegister):
     Custom logic after user logs in through social network.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     pass
@@ -225,10 +234,14 @@ class AfterSocialLogIn(_BaseSocialRegister):
 class SocialAccountAlreadyConnected(_BaseSocialRegister):
 
     """
-    Allow to add custom logic, when someone tries to connect social account to second user in application.
+    Event raised when social account is already connected to some other user.
+
+    Allow to add custom logic, when someone tries to connect social account to
+    second user in application.
 
     .. note::
-        Action emitting this event, should catch all HTTPFound that might be risen in event listener.
+        Action emitting this event, should catch all HTTPRedirection that might
+        be risen in event listener.
     """
 
     def __init__(self, request, user, profile, response_values):

pyramid_fullauth/models/__init__.py

@@ -6,6 +6,7 @@
 
 import sys
 import uuid
+from datetime import datetime
 
 from sqlalchemy import (
     Column, Unicode, String, Integer, Boolean, Sequence, DateTime,
@@ -15,11 +16,11 @@ from sqlalchemy.sql import func
 from sqlalchemy.orm import validates, relationship
 from sqlalchemy.orm.session import object_session
 from sqlalchemy.orm.util import has_identity
-
+from pyramid.compat import text_type
 from pyramid_basemodel import Base
+
 from pyramid_fullauth import exceptions
 from pyramid_fullauth.models.mixins import UserPasswordMixin, UserEmailMixin
-from datetime import datetime
 
 
 class User(UserPasswordMixin, UserEmailMixin, Base):
@@ -93,7 +94,7 @@ class User(UserPasswordMixin, UserEmailMixin, Base):
 
     def __repr__(self):
         """Object representation."""
-        return "<User ('{0}', '{1}')>".format(self.id, str(self))
+        return "<User ('{0}')>".format(self.id)
 
     def __unicode__(self):
         """Unicode cast rules."""
@@ -102,7 +103,7 @@ class User(UserPasswordMixin, UserEmailMixin, Base):
         elif self.email:
             return self.email.split('@')[0] + '@...'
         else:
-            return str(self.id)
+            return text_type(self.id)
 
     def __str__(self):  # pragma: no cover
         """String cast rules."""

pyramid_fullauth/models/extensions/__init__.py

@@ -0,0 +1,39 @@
+# Copyright (c) by SQLAlchemy authors and contributors.
+#
+# This module's code is part of SQLAlchemy's documentation
+# http://docs.sqlalchemy.org/en/rel_0_9/orm/extensions/hybrid.html#hybrid-value-objects
+# and released under
+# the MIT License (MIT): http://opensource.org/licenses/MIT
+"""CaseInsensitive comparator for sqlalchemy models."""
+
+from sqlalchemy import func
+from sqlalchemy.ext.hybrid import Comparator
+from pyramid.compat import string_types
+
+
+class CaseInsensitive(Comparator):
+
+    """Hybrid value representing a lower case representation."""
+
+    def __init__(self, word):
+        """Initialise comparator object."""
+        if isinstance(word, string_types):
+            self.word = word.lower()
+        elif isinstance(word, CaseInsensitive):
+            self.word = word.word
+        else:
+            self.word = func.lower(word)
+
+    def operate(self, op, other):
+        """Operate."""
+        if not isinstance(other, CaseInsensitive):
+            other = CaseInsensitive(other)
+        return op(self.word, other.word)
+
+    def __clause_element__(self):
+        """Get clause element for comparator.."""
+        return self.word
+
+    def __str__(self):
+        """Cast element to."""
+        return self.word

pyramid_fullauth/models/mixins/email.py

@@ -7,13 +7,13 @@
 import re
 import uuid
 
-from sqlalchemy import Column
-from sqlalchemy import Unicode
-from sqlalchemy import String
+from sqlalchemy import Column, Unicode, String
 from sqlalchemy.orm import validates
+from sqlalchemy.ext.hybrid import hybrid_property
 
 
 from pyramid_fullauth.exceptions import EmptyError, EmailValidationError
+from pyramid_fullauth.models.extensions import CaseInsensitive
 
 pattern_mail = re.compile(
     r"(^[-!#$%&'*+/=?^_`{}|~0-9A-Z]{0,256}(\.[-!#$%&'*+/=?^_`{}|~0-9A-Z]+){0,256}"  # dot-atom
@@ -29,11 +29,58 @@ class UserEmailMixin(object):
 
     __pattern_mail = pattern_mail
 
-    email = Column(Unicode(254), unique=True, nullable=False)  # RFC5321 and RFC3696(errata)
-    new_email = Column(Unicode(254), unique=True, nullable=True)  # RFC5321 and RFC3696(errata)
+    _email = Column('email', Unicode(254), unique=True, nullable=False)  # RFC5321 and RFC3696(errata)
+    _new_email = Column('new_email', Unicode(254), unique=True, nullable=True)  # RFC5321 and RFC3696(errata)
     email_change_key = Column(String(255), default=None, unique=True)
 
-    @validates('email', 'new_email')
+    def __init__(self, *args, **kwargs):
+        """Switch possible email and new_email kwarg into new column attribute names."""
+        if 'email' in kwargs:
+            kwargs['_email'] = kwargs.pop('email')
+        if 'new_email' in kwargs:
+            kwargs['_new_email'] - kwargs.pop('new_email')
+
+        super(UserEmailMixin, self).__init__(*args, **kwargs)
+
+    @hybrid_property
+    def email(self):
+        """Email field getter."""
+        if self._email:
+            return self._email.lower()
+        return self._email
+
+    @email.setter
+    def email(self, value):
+        """Email field setter."""
+        if value:
+            value = value.lower()
+        self._email = value
+
+    @email.comparator
+    def email(cls):
+        """Email field comparator."""
+        return CaseInsensitive(cls._email)
+
+    @hybrid_property
+    def new_email(self):
+        """New email field getter."""
+        if self._new_email:
+            return self._new_email.lower()
+        return self._new_email
+
+    @new_email.setter
+    def new_email(self, value):
+        """New email field setter."""
+        if value:
+            value = value.lower()
+        self._new_email = value
+
+    @new_email.comparator
+    def new_email(cls):
+        """New email field comparator."""
+        return CaseInsensitive(cls._new_email)
+
+    @validates('_email', '_new_email')
     def validate_email(self, key, address):
         """
         Validate email addresses.

pyramid_fullauth/request.py

@@ -4,8 +4,8 @@
 # the MIT License (MIT): http://opensource.org/licenses/MIT
 """These method gets added to each ``pyramid.request.Request`` object."""
 
-from pyramid.httpexceptions import HTTPFound
-from pyramid.security import remember, unauthenticated_userid, forget
+from pyramid.httpexceptions import HTTPSeeOther
+from pyramid.security import remember, forget
 from sqlalchemy.sql.expression import func
 from sqlalchemy.orm.exc import NoResultFound
 import pyramid_basemodel
@@ -23,7 +23,7 @@ def login_perform(request, user, location=None, remember_me=False):
     :param bool remember_me: if True set cookie max_age to one month (60 * 60 * 24 * 30 seconds)
 
     :returns: redirect exception
-    :rtype: pyramid.httpexceptions.HTTPFound
+    :rtype: pyramid.httpexceptions.HTTPSeeOther
     """
     user.logged_at = func.now()
     if remember_me:  # if remember in POST set cookie timeout to one from configure
@@ -36,7 +36,7 @@ def login_perform(request, user, location=None, remember_me=False):
 
     # this remembers user immediately, without the need to redirect (see below)
     request.response.headers.extend(headers)
-    return HTTPFound(location=location, headers=request.response.headers)
+    return HTTPSeeOther(location=location, headers=request.response.headers)
 
 
 def user(request):
@@ -49,10 +49,11 @@ def user(request):
     :returns: logged in user object, or None
     :rtype: pyramid_fullauth.models.User
     """
-    userid = unauthenticated_userid(request)
-    if userid:
+    if request.unauthenticated_userid:
         try:
-            user = pyramid_basemodel.Session.query(User).filter(User.id == userid).one()
+            user = pyramid_basemodel.Session.query(User).filter(
+                User.id == request.unauthenticated_userid
+            ).one()
             return user
         except NoResultFound:  # pragma: no cover
             pass

pyramid_fullauth/resources/helpers/social.mako

@@ -1,6 +1,6 @@
 ## -*- coding: utf-8 -*-
 <%doc>
-Copyright (c) 2013 - 2014 by pyramid_fullauth authors and contributors <see AUTHORS file>
+Copyright (c) 2013 - 2015 by pyramid_fullauth authors and contributors <see AUTHORS file>
 
 This module is part of pyramid_fullauth and is released under
 the MIT License (MIT): http://opensource.org/licenses/MIT
@@ -9,9 +9,9 @@ the MIT License (MIT): http://opensource.org/licenses/MIT
 <%def name="social_auth_uri(name, **kw)">
 <%
     from velruse import login_url
-    import urllib
+    from pyramid_fullauth.compat import urlencode
 %>
 % if name in request.registry['config'].fullauth.social:
-${login_url(request, name) + ('?{0}'.format(urllib.urlencode(kw)) if kw else '')}
+${login_url(request, name) + ('?{0}'.format(urlencode(kw)) if kw else '')}
 % endif
 </%def>