pyramid-fullauth 0.4.0__py3.4.egg

pyramid_fullauth/models/mixins/email.py

@@ -0,0 +1,128 @@
+# 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
+"""Email mixin related module."""
+
+import re
+import uuid
+
+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
+    # quoted-string, see also http://tools.ietf.org/html/rfc2822#section-3.2.5
+    r'|^"([\001-\010\013\014\016-\037!#-\[\]-\177 ]|\\[\001-\011\013\014\016-\177 ]){0,256}"'
+    r')@((?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2}\.?)$)'  # domain
+    r'|\[(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\]$', re.IGNORECASE)  # literal form, ipv4 address (SMTP 4.1.3)
+
+
+class UserEmailMixin(object):
+
+    """User email fields and functionality."""
+
+    __pattern_mail = pattern_mail
+
+    _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)
+
+    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.
+
+        .. note::
+
+            See pyramid docs about `simple validators <http://docs.sqlalchemy.org/en/latest/orm/mapper_config.html#simple-validators>`_
+
+        :param str key: field key
+        :param str address: email address
+
+        :raises EmailValidationError:
+        :raises EmptyError:
+        """
+        if address:
+            if pattern_mail.match(address):
+                return address
+            else:
+                raise EmailValidationError('Incorrect e-mail format')
+
+        raise EmptyError('E-mail is empty')
+
+    def set_new_email(self, email_new):
+        """
+        Set new email and generate new email change hash.
+
+        :param str email_new: email address
+
+        :returns: generated email_change_key
+        :trype: str
+
+        """
+        self.new_email = email_new
+        self.email_change_key = str(uuid.uuid4())
+        return self.email_change_key
+
+    def change_email(self):
+        """
+        Change email after activation.
+
+        We don't clear new email field because of validator of email which won't allow to None value.
+
+        """
+        self.email = self.new_email
+        self.email_change_key = None

pyramid_fullauth/models/mixins/password.py

@@ -0,0 +1,141 @@
+# 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
+"""Password mixin related module."""
+
+import os
+import hashlib
+import uuid
+
+from sqlalchemy import Column
+from sqlalchemy import Unicode
+from sqlalchemy import Enum
+from sqlalchemy import String
+from sqlalchemy.orm import validates
+from pyramid.compat import text_type
+from pyramid_fullauth.exceptions import EmptyError
+
+try:  # pragma: no cover
+    algorithms = hashlib.algorithms
+except AttributeError:  # pragma: no cover
+    # Simple tuple for Python 2.6
+    algorithms = ('md5', 'sha1')
+
+
+class UserPasswordMixin(object):
+
+    """Authentication field definition along with appropriate methods."""
+
+    #: password field
+    password = Column(Unicode(40), nullable=False)
+
+    #: hash_algorithm field
+    _hash_algorithm = Column('hash_algorithm',
+                             Enum(*algorithms, name="hash_algorithms_enum"),
+                             default=text_type('sha1'), nullable=False)
+
+    #: salt field
+    _salt = Column('salt', Unicode(50), nullable=False)
+
+    #: reset key field
+    reset_key = Column(String(255), unique=True)
+
+    def check_password(self, password):
+        """
+        Check if password correspond to the saved one.
+
+        :param str password: password to compare
+
+        :returns: True, if password is same, False if not
+        :rtype: bool
+        """
+        if password and self.hash_password(password, self._salt, self._hash_algorithm) == self.password:
+                return True
+
+        return False
+
+    def set_reset(self):
+        """Generate password reset key."""
+        self.reset_key = str(uuid.uuid4())
+
+    @classmethod
+    def hash_password(cls, password, salt, hash_method):
+        """
+        Produce hash out of a password.
+
+        :param str password: password string, not hashed
+        :param str salt: salt
+        :param callable hash_method: a hash method which will be used to generate hash
+
+        :returns: hashed password
+        :rtype: str
+
+        """
+        # let's allow passing just method name
+        if not callable(hash_method):
+            hash_method = getattr(hashlib, hash_method)
+
+        # let's convert password to string from unicode
+        if isinstance(password, text_type):
+            password = password.encode('utf-8')
+
+        # it's actually for Python 3, where str is unicode not bytestring,
+        # and haslib methods accepts only bytestr
+        if isinstance(salt, text_type):
+            salt = salt.encode('utf-8')
+
+        # generating salted hash
+        return hash_method(password + salt).hexdigest()
+
+    @validates('password')
+    def password_validator(self, key, password):
+        """
+        Validate password.
+
+        Password validator keeps new password hashed.
+        Rises Value error on empty password
+
+        :param str key: field key
+        :param str password: new password
+
+        :returns: hashed and salted password
+        :rtype: str
+        :raises: pyramid_fullauth.exceptions.EmptyError
+
+        .. note::
+
+            If you're using this Mixin on your own User object,
+            don't forget to add a listener as well, like that:
+
+            .. code-block:: python
+
+                from sqlalchemy.event import listen
+
+                listen(User.password, 'set', User.password_listener, retval=True)
+
+        .. note::
+
+            For more information on Attribute Events in sqlalchemy see:
+
+            :meth:`sqlalchemy.orm.events.AttributeEvents.set`
+
+        """
+        if not password:
+            raise EmptyError('password-empty')
+
+        # reading default hash_algorithm
+        hash_algorithm = self.__class__._hash_algorithm.property.columns[0].default.arg
+
+        # getting currently used hash method
+        hash_method = getattr(hashlib, hash_algorithm)
+
+        # generating salt
+        salt = hash_method()
+        salt.update(os.urandom(60))
+        salt_value = salt.hexdigest()
+
+        # storing used hash algorithm
+        self._hash_algorithm = hash_algorithm
+        self._salt = text_type(salt_value)
+        return text_type(self.__class__.hash_password(password, salt_value, hash_method))

pyramid_fullauth/request.py

@@ -0,0 +1,70 @@
+# 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
+"""These method gets added to each ``pyramid.request.Request`` object."""
+
+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
+
+from pyramid_fullauth.models import User
+
+
+def login_perform(request, user, location=None, remember_me=False):
+    """
+    Perform login action.
+
+    :param pyramid.request.Request request: a request object
+    :param pyramid_fullauth.models.User user: a user object
+    :param str location: where user should be redirected after login
+    :param bool remember_me: if True set cookie max_age to one month (60 * 60 * 24 * 30 seconds)
+
+    :returns: redirect exception
+    :rtype: pyramid.httpexceptions.HTTPSeeOther
+    """
+    user.logged_at = func.now()
+    if remember_me:  # if remember in POST set cookie timeout to one from configure
+        headers = remember(request, user.id,
+                           max_age=request.registry['config'].fullauth.login.cookie_max_age)
+    else:
+        headers = remember(request, user.id)
+    if not location:
+        location = '/'
+
+    # this remembers user immediately, without the need to redirect (see below)
+    request.response.headers.extend(headers)
+    return HTTPSeeOther(location=location, headers=request.response.headers)
+
+
+def user(request):
+    """
+    Return user object.
+
+    When called for the first time, it queries for user, which is later available as a pure property
+    overriding this method. See :meth:`pyramid_fullauth.includeme` for logic behind property.
+
+    :returns: logged in user object, or None
+    :rtype: pyramid_fullauth.models.User
+    """
+    if request.unauthenticated_userid:
+        try:
+            user = pyramid_basemodel.Session.query(User).filter(
+                User.id == request.unauthenticated_userid
+            ).one()
+            return user
+        except NoResultFound:  # pragma: no cover
+            pass
+
+
+def logout(request):
+    """
+    Log user out.
+
+    :param pyramid.request.Request request: a request object
+    """
+    if request.user:
+        request.response.headerlist.extend(forget(request))
+        request.user = None

pyramid_fullauth/resources/helpers/social.mako

@@ -0,0 +1,17 @@
+## -*- coding: utf-8 -*-
+<%doc>
+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
+</%doc>
+
+<%def name="social_auth_uri(name, **kw)">
+<%
+    from velruse import login_url
+    import urllib
+%>
+% if name in request.registry['config'].fullauth.social:
+${login_url(request, name) + ('?{0}'.format(urllib.urlencode(kw)) if kw else '')}
+% endif
+</%def>

pyramid_fullauth/resources/locale/pyramid_fullauth.pot

@@ -0,0 +1,216 @@
+# Translations template for pyramid_fullauth.
+# Copyright (C) 2014 ORGANIZATION
+# This file is distributed under the same license as the pyramid_fullauth
+# project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2014.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyramid_fullauth 0.2.3\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2014-04-11 23:41+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 1.3\n"
+
+#: pyramid_fullauth/tools.py:47
+msgid "Please enter your password"
+msgstr ""
+
+#: pyramid_fullauth/tools.py:53
+msgid "Password is too short"
+msgstr ""
+
+#: pyramid_fullauth/tools.py:61
+#: pyramid_fullauth/views/basic/profile/password.py:124
+msgid "password-mismatch"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/403.mako:11
+msgid "Sorry, we couldn't serve you this, your clearance code is too low!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:11
+#: pyramid_fullauth/resources/templates/_form.register.mako:12
+msgid "E-mail"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:21
+#: pyramid_fullauth/resources/templates/_form.register.mako:21
+#: pyramid_fullauth/resources/templates/reset.proceed.mako:20
+msgid "Password"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:27
+msgid "Remember me"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:34
+msgid "Forgot your password, right?"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:35
+msgid "Want to join? Sign Up!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.login.mako:40
+msgid "Log in"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.register.mako:34
+#: pyramid_fullauth/resources/templates/reset.proceed.mako:27
+msgid "Confirm password"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_form.register.mako:44
+msgid "Sign up"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_social.login.mako:9
+msgid "Social login"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_social.login.mako:12
+msgid "Connect with facebook"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/_social.login.mako:15
+msgid "Connect with twitter"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/activate.mako:10
+msgid "Invalid activation code"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/activate.mako:12
+msgid "Thank you for activating your account!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/activate.mako:13
+msgid "And welcome to our site!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/email_change.mako:10
+msgid "Change your email"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/email_change.mako:15
+#: pyramid_fullauth/resources/templates/login.mako:11
+#: pyramid_fullauth/resources/templates/register.mako:13
+#: pyramid_fullauth/resources/templates/reset.mako:15
+#: pyramid_fullauth/resources/templates/reset.proceed.mako:14
+msgid "Error!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/email_change.mako:20
+#: pyramid_fullauth/resources/templates/reset.mako:20
+msgid "Your e-mail address"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/email_change.mako:27
+msgid "Change email"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/layout.mako:10
+msgid "Welcome, to pyramid_fullauth!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/login.mako:9
+msgid "Please, log in"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/register.mako:9
+msgid "Please, register"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/register.mako:18
+msgid "Success!"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/register.mako:18
+msgid "You have sucessfully registered"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/reset.mako:10
+msgid "Recover your password"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/reset.mako:27
+#: pyramid_fullauth/resources/templates/reset.proceed.mako:34
+msgid "Reset Password"
+msgstr ""
+
+#: pyramid_fullauth/resources/templates/reset.proceed.mako:10
+msgid "Recover your password - choose new password"
+msgstr ""
+
+#: pyramid_fullauth/views/social.py:134
+msgid "Your account is already connected to other ${provider} account."
+msgstr ""
+
+#: pyramid_fullauth/views/social.py:141
+msgid "Your account has been connected to ${provider} account."
+msgstr ""
+
+#: pyramid_fullauth/views/social.py:147
+msgid "This ${provider} account is already connected with other account."
+msgstr ""
+
+#: pyramid_fullauth/views/basic/forbidden.py:39
+msgid "forbidden-notallowed"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/forbidden.py:44
+msgid "forbidden-login"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/login.py:35
+msgid "Login error"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/login.py:51
+msgid "Already logged in!"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/login.py:95
+#: pyramid_fullauth/views/basic/login.py:133
+msgid "Wrong e-mail or password."
+msgstr ""
+
+#: pyramid_fullauth/views/basic/register.py:38
+msgid "You have an error in your registration form"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/register.py:51
+msgid "You have successfully registered"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/register.py:75
+msgid "User with given e-mail already exists!"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/profile/email.py:44
+msgid "User with this email exists"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/profile/email.py:60
+msgid "E-mail is empty"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/profile/email.py:66
+msgid "Incorrect e-mail format"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/profile/email.py:73
+msgid "We sent you email to activate your new email address"
+msgstr ""
+
+#: pyramid_fullauth/views/basic/profile/password.py:48
+msgid "user-not-exists"
+msgstr ""
+

pyramid_fullauth/resources/templates/403.mako

@@ -0,0 +1,11 @@
+## -*- coding: utf-8 -*-
+<%doc>
+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
+</%doc>
+<%inherit file="pyramid_fullauth:resources/templates/layout.mako" />
+
+<h1>HTTP://403</h1>
+<p>${_('Sorry, we couldn\'t serve you this, your clearance code is too low!', domain='pyramid_fullauth')}</p>

pyramid_fullauth/resources/templates/_form.login.mako

@@ -0,0 +1,44 @@
+## -*- coding: utf-8 -*-
+<%doc>
+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
+</%doc>
+<form id="login_form" name="login_form" method="POST" action="${request.route_path('login')}">
+    <fieldset>
+        <div class="control-group">
+            <label class="control-label">${_('E-mail', domain='pyramid_fullauth')}:</label>
+            <div class="controls">
+                <input type="email" placeholder="username@hostname.com" name="email"  class="input-xlarge"/>
+            % if after:
+                <input type="hidden" name="after" value="${after}" />
+            % endif
+                <input type="hidden" name="csrf_token" value="${csrf_token}" />
+            </div>
+        </div>
+        <div class="control-group">
+            <label class="control-label">${_('Password', domain='pyramid_fullauth')}:</label>
+            <div class="controls">
+                <input type="password" name="password" class="input-xlarge"/>
+            </div>
+        </div>
+        <div class="control-group">
+            <label class="control-label">${_('Remember me', domain='pyramid_fullauth')}:</label>
+            <div class="controls">
+                <input type="checkbox" name="remember" value="1" />
+            </div>
+        </div>
+        <div class="control-group">
+            <div class="controls options">
+                <a href="${request.route_path('password:reset')}">${_('Forgot your password, right?', domain='pyramid_fullauth')}</a><br/>
+                <a id="sign_up_login" href="${request.route_path('register')}">${_('Want to join? Sign Up!', domain='pyramid_fullauth')}</a><br/>
+            </div>
+        </div>
+        <div class="modal-footer center">
+            <div>
+                <button type="submit" class="btn btn-primary btn-large f18 w180"><strong>${_('Log in', domain='pyramid_fullauth')}</strong></button>
+            </div>
+        </div>
+    </fieldset>
+</form>

pyramid_fullauth/resources/templates/_form.register.mako

@@ -0,0 +1,47 @@
+## -*- coding: utf-8 -*-
+<%doc>
+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
+</%doc>
+<form class="registerForm" id="register_form" name="register_form" method="POST" action="${request.route_path('register')}">
+    <input type="hidden" name="csrf_token" value="${csrf_token}" />
+    <fieldset>
+        <div class="control-group ${'error' if 'email' in errors else ''}">
+            <label class="control-label">${_('E-mail', domain='pyramid_fullauth')}:</label>
+            <div class="controls">
+                <input id="email" placeholder="username@hostname.com" type="email" name="email" required="required" value="${request.params.get('email','')}" />
+                % if 'email' in errors:
+                    <span class="help-inline">${errors['email']}</span>
+                % endif
+            </div>
+        </div>
+        <div class="control-group ${'error' if 'password' in errors else ''}">
+            <label class="control-label">${_('Password', domain='pyramid_fullauth')}:</label>
+            <div class="controls">
+                <input type="password" id="password" name="password" required="required"/>
+                % if 'password' in errors:
+                    <span class="help-inline">${errors['password']}</span>
+                % endif
+            </div>
+        </div>
+        <%
+            password_options = request.registry['config'].fullauth.register.password
+        %>
+        % if password_options['confirm']:
+            <div class="control-group ${'error' if 'confirm_password' in errors else ''}">
+                <label class="control-label">${_('Confirm password', domain='pyramid_fullauth')}:</label>
+                <div class="controls">
+                    <input type="password" name="confirm_password" id="confirm_password" required="required"/>
+                    % if 'confirm_password' in errors:
+                        <span class="help-inline">${errors['confirm_password']}</span>
+                    % endif
+                </div>
+            </div>
+        % endif
+        <div>
+            <button id="submit_register" type="submit" class="btn btn-primary btn-large"><strong>${_('Sign up', domain='pyramid_fullauth')}</strong></button>
+        </div>
+    </fieldset>
+</form>