iro/model/user.py
author Sandro Knauß <knauss@netzguerilla.net>
Thu, 29 Mar 2012 18:27:15 +0200
branchdevel
changeset 263 52284710c0b4
parent 125 19b3f383c9ce
child 282 50cc13814bfb
permissions -rw-r--r--
iro.model: adding docstrings
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
118
e16c0250c974 validate decorator can handle deferd validators
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
     1
from twisted.internet import defer
106
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
from inspect import getcallargs
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
     3
from decorator import decorator
106
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
from .schema import User
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
     6
from .dbdefer import dbdefer
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
     7
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
     8
from ..validate import validate, vHash
106
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
from ..error import UserNotFound, InterfaceException
114
1ed072cc6793 reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents: 111
diff changeset
    10
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    11
118
e16c0250c974 validate decorator can handle deferd validators
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    12
@validate(kwd="apikey", func=vHash, minlength=15, maxlength=15)
108
cadc01b2bdc0 model.user uses now the decorator DBDefer
Sandro Knauß <knauss@netzguerilla.net>
parents: 106
diff changeset
    13
@dbdefer
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 118
diff changeset
    14
def getuser(session, apikey):
263
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    15
    """Returns a valid user object.
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    16
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    17
    :param session: a valid session object (is created by decorator :func:`iro.model.dbdefer.dbdefer`)
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    18
    :param string apikey: a vaild apikey (only [0-9a-f] is allowed)
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    19
    :return: a :class:`iro.model.schema.User` object
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    20
    :raises: :exc:`iro.error.UserNotFound`
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    21
    """
111
8b493ab9c74f userhash -> apikey fpr better Exception description
Sandro Knauß <knauss@netzguerilla.net>
parents: 108
diff changeset
    22
    user = session.query(User).filter_by(apikey=apikey).first()
106
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
    if user is None:
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
        raise UserNotFound()
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
    else:
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
        return user
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    28
@decorator
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    29
def vUser(f,*args,**kargs):
263
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    30
    """A Decorator to verify the apikey and execute the function with a valid :class:`iro.model.schema.User` instead of the apikey.
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    31
    
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    32
    The decorator expect the apikey in the **user** parameter.
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    33
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    34
    :return: a defer
52284710c0b4 iro.model: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
    35
    """ 
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    36
    kp=getcallargs(f,*args,**kargs)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    37
    try:
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    38
        apikey = kp["user"]
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    39
    except KeyError:
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    40
        raise InterfaceException() 
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    41
    
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    42
    def _gotResult(_user):
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    43
        kp["user"]=_user
118
e16c0250c974 validate decorator can handle deferd validators
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    44
        e =  defer.maybeDeferred(f,**kp)
e16c0250c974 validate decorator can handle deferd validators
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    45
        return e
e16c0250c974 validate decorator can handle deferd validators
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    46
    d = defer.maybeDeferred(getuser, apikey=apikey)
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    47
    return d.addCallback(_gotResult)
106
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
d2992f011930 controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49