pyramid-fullauth 0.4.0__py3.4.egg

EGG-INFO/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 1.1
+Name: pyramid-fullauth
+Version: 0.4.0
+Summary: This package intends to provide full authentication / authorisation
+    implementation for pyramid applications
+Home-page: https://github.com/fizyk/pyramid_fullauth
+Author: Grzegorz Sliwinski
+Author-email: fizyk@fizyk.net.pl
+License: MIT License
+Description: pyramid_fullauth
+        ================
+        
+        .. image:: https://pypip.in/v/pyramid_fullauth/badge.png
+            :target: https://pypi.python.org/pypi/pyramid_fullauth/
+            :alt: Latest PyPI version
+        
+        .. image:: https://pypip.in/d/pyramid_fullauth/badge.png
+            :target: https://pypi.python.org/pypi/pyramid_fullauth/
+            :alt: Number of PyPI downloads
+        
+        .. image:: https://pypip.in/wheel/pyramid_fullauth/badge.png
+            :target: https://pypi.python.org/pypi/pyramid_fullauth/
+            :alt: Wheel Status
+        
+        .. image:: https://pypip.in/egg/pyramid_fullauth/badge.png
+            :target: https://pypi.python.org/pypi/pyramid_fullauth/
+            :alt: Egg Status
+        
+        .. image:: https://pypip.in/license/pyramid_fullauth/badge.png
+            :target: https://pypi.python.org/pypi/pyramid_fullauth/
+            :alt: License
+        
+        Pyramid fullauth's goal is to provide full plug-in registration functionality for pyramid, with user managing
+        
+        Package status
+        --------------
+        
+        .. image:: https://travis-ci.org/fizyk/pyramid_fullauth.png?branch=master
+            :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
+            :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
+        
+        Package resources
+        -----------------
+        
+        * Bug tracker: https://github.com/fizyk/pyramid_fullauth/issues
+        * Documentation: http://pyramid-fullauth.readthedocs.org/
+        * PyPI: https://pypi.python.org/pypi/pyramid_fullauth
+        
+        Installation
+        ------------
+        
+        ``pip install pyramid_fullauth``
+        
+        or add **pyramid_fullauth** to your **setup.py** requirements.
+        
+        
+        Tests
+        -----
+        
+        You'll need: packages defined in extra_requires[tests] to run tests, and then:
+        
+        ``py.test``
+        
+        
+        CHANGELOG
+        =========
+        
+        0.4.0
+        -------
+        
+        - python 3 compatibility (without oauth2 though)
+        - cleared use of deprecated :func:`pyramid.security.authenticated_userid` in favour of :attr:`pyramid.request.Request.authenticated_userid`
+        - 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
+        -----
+        
+        - fixes MANIFEST.in to include yaml files - fixes `#33 <https://github.com/fizyk/pyramid_fullauth/issues/33>`_.
+        
+        0.3.0
+        -----
+        
+        Features
+        ++++++++
+        
+        - configure root factory if it hasn't been already done
+        - configure session factory only if it hasn't been configured before
+        - configure authorization policy only if it hasn't been configured before
+        - configure authentication policy only if it hasn't been configured before
+        - logged in user will be redirected always away from login page
+        - views reorganisation - grouping by their function
+        - replaced force_logout decorator with logout request method
+        - small login view simplification
+        
+        tests
+        +++++
+        
+        - rewritten tests to use pytest_pyramid
+        - unified session with pyramid_basemodel's
+        - parametrize tests against two most recent pyramid versions and sqlalchemy
+        - turned on pylama to check code with linters:
+            - pep8
+            - pep257
+            - pyflakes
+            - mccabe
+        - add pytest-dbfixtures, and run tests against postgresql and mysql as well
+        - drop python 2.6 from tests
+        - 100% test coverage
+        
+        
+        0.2.3
+        -----
+        - weaker pyramid_yml requirements. Use ``registry['config']`` instead of ``request.config`` which gets added only when explicitly including tzf.pyramid_yml package.
+        - remove default_config with permission set for forbidden views. Throwning errors in pyramid 1.5a3
+        - remove lazy='load' for relationship between AuthenticationProvider and User models as it was incorrect. Fixes error while using with sqlalchemy 0.9
+        
+        0.2.2
+        -----
+        - copy all headers when login user. fixes issue, when headers set in AfterLogin event would not get passed
+        
+        0.2.1
+        -----
+        - fixed csrf_check in password:reset:continue action
+        - updated translation files
+        
+        0.2.0
+        -----
+        - migrated tests to py.test
+        - removed nose and lxml from test requirements
+        - extracted UserEmailMixin from User model
+        - validation exception improvements
+        - set licensing to MIT License
+        - fixed general error message for register_POST processing
+        - activate action no longer gives 404 error after first use. Default is message about token being invalid or used [veronicazgirvaci]
+        - extending csrf_check predicate:
+            - Can be turned on/off in settings.
+            - Failed check rises 401 Unauthorised error
+        
+        Backwards Incompatibilities
+        +++++++++++++++++++++++++++
+        
+        - token variable is changed into csrf_token in fullatuh views
+        - view no longer returns error messages on failed csrf token. Rises 401 Unauthorised error instead.
+        
+        
+        0.1.0
+        -----
+        - add localize to requirements. Ability to translate registerlogin communicates
+        - ability to set custom session factory [with Veronica Zgirvaci help]
+        - moved password validation to one place
+        
+Keywords: python authentication authorisation pyramid
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+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

@@ -0,0 +1,93 @@
+AUTHORS.rst
+CHANGES.rst
+MANIFEST.in
+README.rst
+setup.cfg
+setup.py
+docs/Makefile
+docs/make.bat
+docs/source/advanced.rst
+docs/source/api.rst
+docs/source/authors.rst
+docs/source/basic.rst
+docs/source/changelog.rst
+docs/source/conf.py
+docs/source/customise.rst
+docs/source/index.rst
+docs/source/narrative.rst
+docs/source/social.rst
+docs/source/api/auth.rst
+docs/source/api/events.rst
+docs/source/api/exceptions.rst
+docs/source/api/models.rst
+docs/source/api/predicates.rst
+docs/source/api/request.rst
+docs/source/api/tools.rst
+pyramid_fullauth/__init__.py
+pyramid_fullauth/auth.py
+pyramid_fullauth/events.py
+pyramid_fullauth/exceptions.py
+pyramid_fullauth/request.py
+pyramid_fullauth/tools.py
+pyramid_fullauth.egg-info/PKG-INFO
+pyramid_fullauth.egg-info/SOURCES.txt
+pyramid_fullauth.egg-info/dependency_links.txt
+pyramid_fullauth.egg-info/not-zip-safe
+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
+pyramid_fullauth/resources/helpers/social.mako
+pyramid_fullauth/resources/locale/pyramid_fullauth.pot
+pyramid_fullauth/resources/templates/403.mako
+pyramid_fullauth/resources/templates/_form.login.mako
+pyramid_fullauth/resources/templates/_form.register.mako
+pyramid_fullauth/resources/templates/_social.login.mako
+pyramid_fullauth/resources/templates/activate.mako
+pyramid_fullauth/resources/templates/email_change.mako
+pyramid_fullauth/resources/templates/layout.mako
+pyramid_fullauth/resources/templates/login.mako
+pyramid_fullauth/resources/templates/register.mako
+pyramid_fullauth/resources/templates/reset.mako
+pyramid_fullauth/resources/templates/reset.proceed.mako
+pyramid_fullauth/routing/__init__.py
+pyramid_fullauth/routing/predicates.py
+pyramid_fullauth/views/__init__.py
+pyramid_fullauth/views/social.py
+pyramid_fullauth/views/basic/__init__.py
+pyramid_fullauth/views/basic/activate.py
+pyramid_fullauth/views/basic/forbidden.py
+pyramid_fullauth/views/basic/login.py
+pyramid_fullauth/views/basic/logout.py
+pyramid_fullauth/views/basic/register.py
+pyramid_fullauth/views/basic/profile/__init__.py
+pyramid_fullauth/views/basic/profile/email.py
+pyramid_fullauth/views/basic/profile/password.py
+tests/__init__.py
+tests/conftest.py
+tests/tools.py
+tests/unit/test_default_settings.py
+tests/unit/test_groupfinder.py
+tests/unit/test_social_view.py
+tests/unit/test_tools.py
+tests/unit/test_user_active.py
+tests/unit/test_user_admin.py
+tests/unit/test_user_email.py
+tests/unit/test_user_password.py
+tests/unit/test_user_providers.py
+tests/unit/test_user_repr.py
+tests/unit/test_validators.py
+tests/views/__init__.py
+tests/views/conftest.py
+tests/views/test_activation.py
+tests/views/test_email.py
+tests/views/test_events.py
+tests/views/test_login.py
+tests/views/test_login_social.py
+tests/views/test_logout.py
+tests/views/test_register.py
+tests/views/test_reset.py

EGG-INFO/dependency_links.txt

@@ -0,0 +1 @@
+

EGG-INFO/not-zip-safe

@@ -0,0 +1 @@
+

EGG-INFO/requires.txt

@@ -0,0 +1,13 @@
+pyramid_localize
+pyramid >=1.4
+pyramid_mako
+tzf.pyramid_yml >=1.0
+pyramid_basemodel
+
+[docs]
+sphinx
+
+[tests]
+mock
+pytest_pyramid
+pytest-cov

EGG-INFO/top_level.txt

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

pyramid_fullauth/__init__.py

@@ -0,0 +1,106 @@
+# Copyright (c) 2013 - 2014 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
+"""Fullauth's configuration module."""
+import sys
+import logging
+
+from tzf.pyramid_yml import config_defaults
+from pyramid.authorization import ACLAuthorizationPolicy
+from pyramid.authentication import AuthTktAuthenticationPolicy
+from pyramid.interfaces import (
+    IAuthorizationPolicy, IAuthenticationPolicy, IRootFactory, ISessionFactory
+)
+
+from pyramid_fullauth.auth import groupfinder
+from pyramid_fullauth.routing import predicates
+from pyramid_fullauth.request import login_perform, logout, user
+
+__version__ = '0.4.0'
+
+
+logger = logging.getLogger(__name__)
+
+
+def includeme(configurator):
+    """
+    Configure pyramid_fullauth on application.
+
+    :param pyramid.configurator.Configurator configurator: pyramid's configurator object
+    """
+    config_defaults(configurator, 'pyramid_fullauth:config/default.yaml')
+    configurator.include('pyramid_localize')
+    configurator.include('pyramid_mako')
+    fullauth_config = configurator.registry['config'].fullauth
+
+    if configurator.registry.queryUtility(IAuthorizationPolicy) is None:
+        configurator.set_authorization_policy(ACLAuthorizationPolicy())
+
+    # register authentication policy, only if not set already
+    if configurator.registry.queryUtility(IAuthenticationPolicy) is None:
+        configurator.set_authentication_policy(
+            AuthTktAuthenticationPolicy(callback=groupfinder,
+                                        **fullauth_config.AuthTkt))
+
+    # register root factory, only if not set already
+    if configurator.registry.queryUtility(IRootFactory) is None:
+        configurator.set_root_factory(
+            'pyramid_fullauth.auth.BaseACLRootFactoryMixin')
+
+    # register session factory, only, if not already registered
+    if configurator.registry.queryUtility(ISessionFactory) is None:
+        # loading and setting session factory
+        # first, divide provided path for module, and factory name
+        module, factory = fullauth_config.session.factory.rsplit('.', 1)
+        # import session module first
+        session_module = __import__(module, fromlist=[module])
+        # get the  factory class
+        session_factory = getattr(session_module, factory)
+
+        # set the new session factory
+        configurator.set_session_factory(
+            session_factory(**fullauth_config.session.settings))
+
+    configurator.add_view_predicate(
+        'check_csrf', predicates.CSRFCheckPredicate)
+
+    # add routes
+    configurator.add_route(name='login', pattern='/login')
+    configurator.add_route(name='logout', pattern='/logout')
+    configurator.add_route(name='register', pattern='/register')
+    configurator.add_route(
+        name='register:activate', pattern='/register/activate/{hash}')
+    configurator.add_route(name='password:reset', pattern='/password/reset')
+    configurator.add_route(
+        name='password:reset:continue', pattern='/password/reset/{hash}',
+        custom_predicates=(predicates.reset_hash,))
+    configurator.add_route(name='email:change', pattern='/email/change')
+    configurator.add_route(
+        name='email:change:continue', pattern='/email/change/{hash}',
+        custom_predicates=(predicates.change_email_hash,))
+    # scan base views
+    configurator.scan('pyramid_fullauth.views.basic')
+
+    # check for the social. (And python 2)
+    # If social is not available, we will not turn it on!
+    if 'social' in fullauth_config and sys.version_info.major == 2:
+        # Velruse init (for social auth)
+
+        # scan social views
+        configurator.scan('pyramid_fullauth.views.social')
+        providers = fullauth_config.social
+        configurator.registry['config']['login_providers'] = providers
+        for provider in providers:
+            # Ugly hack for using google oauth2, not OpenID + Oauth2 from google
+            provider_settings = fullauth_config['social'][provider]
+            if provider == 'google':  # pragma: no cover
+                provider = 'google_oauth2'
+
+            configurator.include('velruse.providers.' + provider)
+            getattr(configurator, 'add_{0}_login'.format(provider))(**provider_settings)
+
+    # we'll add some request methods:
+    configurator.add_request_method(login_perform, name='login_perform')
+    configurator.add_request_method(logout, name='logout')
+    configurator.add_request_method(user, name='user', reify=True)

pyramid_fullauth/auth.py

@@ -0,0 +1,67 @@
+# Copyright (c) 2013 - 2014 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
+"""Auth related methods and classes."""
+
+from pyramid.security import Allow, Everyone, ALL_PERMISSIONS
+
+
+def groupfinder(userid, request):
+    """
+    Read all user's groups.
+
+    .. note::
+
+        Adds **s:inactive** group to users who has not activated their account, and **s:user** group to those, who did.
+        If user has is_admin flag, he gets **s:superadmin** group set
+
+        Might be useful, when you want restrict access to some parts of your application, but still allow log in, and access to some other parts.
+
+    :param int userid: user identity
+    :param pyramid.request.Request request: request object
+    :returns: list of groups
+    :rtype: list
+    """
+    user = request.user
+    groups = []
+    if user and user.id == userid:
+        groups = [group.name for group in user.groups]
+
+        # let's add inactive group for users that have not activated their account
+
+        if user.is_admin:
+            groups.append('s:superadmin')
+
+        if user.is_active:
+            groups.append('s:user')
+        else:
+            groups.append('s:inactive')
+
+        return groups
+    return None
+
+
+class BaseACLRootFactoryMixin(object):
+
+    """
+    ACL list factory Mixin.
+
+    __acl__ is the attribute which stores the list.
+
+    :return: tuple (Allow|Deny, Group name, Permission)
+    :rtype: list
+
+    .. note::
+
+        Can be converted later to database stored (sqlalchemy session is accessible through request.db)
+    """
+
+    __acl__ = [(Allow, Everyone, 'view'),
+               (Allow, 's:superadmin', ALL_PERMISSIONS),
+               (Allow, 's:user', ('password_change', 'email_change'))
+               ]
+
+    def __init__(self, request):
+        """Assing request as instance attribute."""
+        self.request = request

pyramid_fullauth/config/default.yaml

@@ -0,0 +1,26 @@
+# Copyright (c) 2013 - 2014 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 default configuration
+fullauth:
+    check_csrf: True    # Whether login processes should work with csrf token, or without
+    register:
+        password:
+            require: True   # set to false to not read password during register, and generate random one
+            length_min: 6   # will be used either to check password's length or generate this length random password
+            confirm: True   # by default there will be a field for password confirmation on the registration form
+    AuthTkt:
+        secret: fullauth_psst   # default secret used to hash auth_tk cookie
+        hashalg: sha512         # default authentication policy hash algorithm
+    login:
+        cookie_max_age: 2592000     # 30 days
+    redirects: # route name, to redirect to. If False, then redirects just to /
+        logout: False
+    session: # session factory settings
+        # factory key is responsible for providing full path to factory class (module.submodule.SessionFactory)
+        factory: pyramid.session.UnencryptedCookieSessionFactoryConfig
+        # settings are key: value pairs of all factory initialize attributes
+        settings:
+            secret: THATS_NOT_SECRET_ITS_A_SECRET