iro/controller/viewinterface.py
author Sandro Knauß <knauss@netzguerilla.net>
Wed, 25 Apr 2012 00:05:53 +0200
branchdevel
changeset 275 88d45c846f2b
parent 268 d0fcb1cde990
child 294 0e75bd39767d
permissions -rw-r--r--
docu fixes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
     2
from ..model.decorators import vUser, vRoute, dbdefer, vTyp
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     3
from ..model.message import SMS, Fax, Mail
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     4
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
     5
from ..validate import validate, vBool, vTel, vEmail, vInteger
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
     6
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     7
from .task import createJob
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     8
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
class Interface(object):
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    10
    '''Interface for views.'''
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
    
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    12
    @validate(kwd="detailed", func=vBool, need=False)
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    13
    @validate(kwd="id", func=vInteger, minv=0, need=False, none_allowed=True)
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    14
    @vUser
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    15
    @dbdefer
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    16
    def status(self, session, user, id=None, detailed=False):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    17
        '''Returns the status of one or more jobs.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    19
        :param string user: apikey of a user
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    20
        :param integer id: one job id
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    21
        :param `boolean` detailed: return more details about the status
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    22
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    23
        :return dict: 
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    24
           - `key` -- is the job id
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    25
           - [`key`][**'status'**] -- status of the job
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    27
        .. warning:: detailed is not used yet.
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    28
        
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    29
        >>> status(APIKEY)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    30
        {"1":  {"status":"sended"},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    31
         "2":  {"status":"error"},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    32
         "10": {"status":"sending"}}
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    34
        >>> status(APIKEY,10)
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    35
        {"10": {"status":"sending"}}
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
        '''
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    37
        user = session.merge(user)
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    38
        ret={}
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    39
        if not id:
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    40
            for job in  user.jobs:
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    41
                ret[str(job.id)]={"status":job.status}
114
1ed072cc6793 reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents: 109
diff changeset
    42
        else:
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    43
            ret[str(id)]={"status":user.job(id).status}
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    44
        
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    45
        return ret
200
01c34f22be42 deleting stop function from iro.controller.viewinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 199
diff changeset
    46
   
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    47
    @validate(kwd="recipients",func=vTel)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    48
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    49
    @validate(kwd="route", func=vRoute, typ="sms")
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    50
    def sms(self, user, message, recipients, route="default", info=""):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    51
        '''Send a sms.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    53
        :param string user: apikey of a user
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    54
        :param string message: message
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    55
        :param list recipients:  a list of telefon numbers (use ITU-T E.123)
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    56
        :param route: route to use to send, or a list of routes as fallback
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    57
        :type route: string|list
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    58
        :param string info: a name, to combine different jobs to one billing group
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    59
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    60
        :return integer: the job id
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
        '''
191
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    62
        d = createJob(user, recipients, SMS(message), route, info)
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    63
        def ret(job):
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    64
            return job.dbjob
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    65
        d.addCallback(ret)
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    66
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
   
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    68
    @validate(kwd="recipients",func=vTel)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    69
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    70
    @validate(kwd="route",func=vRoute, typ="fax")
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    71
    def fax(self, user, subject, fax, recipients, route="default", info=""):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    72
        '''Send a fax.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    73
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    74
        :param string user: apikey of a user
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    75
        :param string subject: subject
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    76
        :param string fax: content (base64 encoded)
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    77
        :param list recipients:  a list of telefon numbers (use ITU-T E.123)
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    78
        :param route: route to use to send, or a list of routes as fallback
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    79
        :type route: string|list
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    80
        :param string info: a name, to combine different jobs to one billing group
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    82
        :return integer: the job id
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
        '''
198
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    84
        d = createJob(user, recipients, Fax(subject, fax), route, info)
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    85
        def ret(job):
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    86
            return job.dbjob
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    87
        d.addCallback(ret)
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    88
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    89
199
1bcca1a40769 test for nor explicit frm mailaddress
Sandro Knauß <knauss@netzguerilla.net>
parents: 198
diff changeset
    90
    @validate(kwd="recipients",func=vEmail, allowString=False)
1bcca1a40769 test for nor explicit frm mailaddress
Sandro Knauß <knauss@netzguerilla.net>
parents: 198
diff changeset
    91
    @validate(kwd="frm",func=vEmail, need=False, allowList=False)
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    92
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    93
    @validate(kwd="route",func=vRoute, typ="mail")
192
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
    94
    def mail(self, user, subject, body, recipients, frm=None, route="default", info=""):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    95
        '''Send a mail.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    96
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    97
        :param string user: apikey of a user
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    98
        :param string subject: subject
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
    99
        :param string body: mail body
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   100
        :param list recipients:  a list of email addresses
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   101
        :param route: route to use to send, or a list of routes as fallback
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   102
        :type route: string|list
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   103
        :param string info: a name, to combine different jobs to one billing group
275
88d45c846f2b docu fixes
Sandro Knauß <knauss@netzguerilla.net>
parents: 268
diff changeset
   104
        :param string frm: sender mail address
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   105
        :return integer: the job id
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   106
        '''
192
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   107
        d = createJob(user, recipients, Mail(subject, body, frm), route, info)
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   108
        def ret(job):
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   109
            return job.dbjob
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   110
        d.addCallback(ret)
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   111
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   112
       
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   113
    @validate(kwd="typ", func=vTyp)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   114
    @vUser
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
   115
    @dbdefer
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
   116
    def routes(self, session, user, typ):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   117
        '''Returns a list of all possible offernames.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   118
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   119
        :param string user: apikey of a user
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   120
        :param string typ: a typ of message -- one of in this list ["sms","fax","mail"]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   121
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   122
        :return list: a list of all possible offer names for a typ
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   123
        '''
121
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   124
        user = session.merge(user)
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   125
        offers = user.routes(typ)
119
3462c2c90f95 function routes complemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
   126
        return [u[0] for u in offers]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   127
        
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   128
    @validate(kwd="typ", func=vTyp)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   129
    @vUser
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
   130
    @dbdefer
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
   131
    def defaultRoute(self, session, user, typ):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   132
        '''Returns all default offernames.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   133
 
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   134
        :param string user: apikey of a user
275
88d45c846f2b docu fixes
Sandro Knauß <knauss@netzguerilla.net>
parents: 268
diff changeset
   135
        :param string typ: a typ of message -- one of in this list ["sms","fax","mail"]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   136
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   137
        :return list: a list of all possible offer names for a typ
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   138
        '''
121
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   139
        user = session.merge(user)
201
843a7bcecbc8 renameing Userright.isDefault(bool) -> default(int)
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
   140
        offers = user.routes(typ, default=True)
120
7bde35ad89e0 function defaultRoute complemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 119
diff changeset
   141
        return [u[0] for u in offers]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   142
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   143
    @vUser
127
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   144
    @dbdefer
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   145
    def bill(self, session, user):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   146
        '''Returns the bill, of not paid messages.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   147
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   148
        :param string user: apikey of a user
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   149
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   150
        :return dict:
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   151
            - `route` -- one offer name ; **"total"** complete sum
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   152
            - [`route`][`info`][**anz**] -- Number of sended messages in one billing group
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   153
            - [`route`][`info`][**price**] -- Price for one billing group
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   154
            - [`route` | **total**][**anz**] -- Number of sended messages for one offer
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   155
            - [`route` | **total**][**price**] -- Price for one offer
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   156
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   157
        >>> bill(APIKEY)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   158
        {"route1": {"info1":{"anz":1,"price":2.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   159
                    "info2":{"anz":2,"price":5.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   160
                    "anz":3,"price":7.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   161
        "route2":  {"info1":{"anz":3, "price":1.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   162
                    "info3":{"anz":4, "price":8.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   163
                    "anz":7, "price":9.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   164
        "total":   {"anz":10, "price":16.00}
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   165
        }
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   166
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   167
        '''
127
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   168
        ret={'total':{'price':0, 'anz':0}}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   169
        user=session.merge(user)
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   170
        for route in user.rights:
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   171
            n=route.offer_name
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   172
            ret[n]={'price':0, 'anz':0, 'info':{}}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   173
            for bill in route.bill:
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   174
                ret[n]['info'][bill.info]={'price':float(bill.price),'anz':bill.anz}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   175
                ret[n]['price'] += bill.price
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   176
                ret[n]['anz'] += bill.anz
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   177
            ret['total']['price'] += ret[n]['price'] 
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   178
            ret['total']['anz'] += ret[n]['anz'] 
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   179
            ret[n]['price'] = float(ret[n]['price'])
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   180
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   181
        ret['total']['price'] = float(ret['total']['price'])
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   182
        return ret
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   183
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   184
    @validate(kwd="recipients",func=vTel)
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   185
    def telnumber(self,recipients):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   186
        '''Return True, if all telnumbers a vaild.
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   187
        
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   188
        :param list recipients:  a list of telnumbers (use ITU-T E.123)
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   189
275
88d45c846f2b docu fixes
Sandro Knauß <knauss@netzguerilla.net>
parents: 268
diff changeset
   190
        :return boolean: True -- all numbers are valid
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   191
        '''
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   192
        return True
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   193
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   194
    @validate(kwd="recipients",func=vEmail)
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   195
    def email(self,recipients):
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   196
        '''Return True, if all mailadresses a valid.
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   197
        
268
d0fcb1cde990 iro.controller.viewinterface: translating
Sandro Knauß <knauss@netzguerilla.net>
parents: 253
diff changeset
   198
        :param list recipients:  a list of mailadresses
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   199
275
88d45c846f2b docu fixes
Sandro Knauß <knauss@netzguerilla.net>
parents: 268
diff changeset
   200
        :return boolean: True -- all addresses are valid
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   201
        '''
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   202
        return True