| author | Sandro Knauß <knauss@netzguerilla.net> |
| Fri, 27 Jan 2012 17:49:57 +0100 | |
| branch | devel |
| changeset 115 | 323d06431100 |
| parent 114 | 1ed072cc6793 |
| child 117 | 351a02310dd8 |
| permissions | -rw-r--r-- |
| 92 | 1 |
# -*- coding: utf-8 -*- |
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
2 |
from ..model.decorators import vUser, vRoute |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
3 |
from ..model.utils import vTyp |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
4 |
from ..validate import validate, vBool, vHash, vTel, vEmail |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
5 |
|
| 92 | 6 |
class Interface(object): |
7 |
'''class for a xmlrpc user |
|
8 |
''' |
|
9 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
10 |
@validate(kwd="detailed", func=vBool, need=False) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
11 |
@validate(kwd="id", func=vHash, need=False, maxlength=40) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
12 |
@vUser |
| 92 | 13 |
def status(self, user, id=None, detailed=False): |
14 |
'''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück. |
|
15 |
||
16 |
Keywords: |
|
17 |
apikey[string]: Der API Key |
|
18 |
id[hash]: Eine Auftragsnummer |
|
19 |
detailed[boolean]: Details ausgeben |
|
20 |
||
21 |
Return: |
|
22 |
jobs[list]: Eine Liste der Aufträge. |
|
23 |
job.name[string]: Angebener Name |
|
24 |
job.status[string]: Status des Auftrages |
|
25 |
||
26 |
||
27 |
''' |
|
|
114
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
28 |
if id or detailed: |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
29 |
return str(user),id,detailed |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
30 |
else: |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
31 |
return str(user) |
| 92 | 32 |
#return user.status(id,detailed) |
33 |
return "" |
|
34 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
35 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
36 |
@validate(kwd="id", func=vHash,maxlength=40) |
| 92 | 37 |
def stop(self, user, id): |
38 |
'''Stoppt den angegeben Auftrag. |
|
39 |
||
40 |
Keywords: |
|
41 |
apikey[string]: Der API Key |
|
42 |
id[hash]: Eine Auftragsnummer |
|
43 |
||
44 |
Return: |
|
45 |
||
46 |
''' |
|
47 |
return "" |
|
48 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
49 |
@validate(kwd="recipients",func=vTel) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
50 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
51 |
@vRoute(typ="sms") |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
52 |
def sms(self, user, message, recipients, route="default", info=""): |
| 92 | 53 |
'''Versendet eine SMS. |
54 |
||
55 |
Keywords: |
|
56 |
apikey[string]: Der API Key |
|
57 |
message[string]: Nachricht |
|
58 |
recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
59 |
route[string|list]: Route über den geschickt werden soll, |
|
60 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
61 |
||
62 |
Return: |
|
63 |
id[hash]: Die ID des Auftrages |
|
64 |
||
65 |
''' |
|
66 |
return "" |
|
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 |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
70 |
@vRoute(typ="fax") |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
71 |
def fax(self, user, subject, fax, recipients, route="default", info=""): |
| 92 | 72 |
'''Versendet ein FAX. |
73 |
||
74 |
Keywords: |
|
75 |
apikey[string]: Der API Key |
|
76 |
subject[string]: Der Betreff |
|
77 |
fax[string]: Das PDF base64 kodiert |
|
78 |
recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
79 |
route[string|list]: Route über den geschickt werden soll, |
|
80 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
81 |
||
82 |
Return: |
|
83 |
id[hash]: Die ID des Auftrages |
|
84 |
||
85 |
''' |
|
86 |
return "" |
|
87 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
88 |
@validate(kwd="recipients",func=vEmail) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
89 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
90 |
@vRoute(typ="mail") |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
91 |
def mail(self, user, subject, body, recipients, frm, route="default", info=""): |
| 92 | 92 |
'''Versendet eine Email. |
93 |
||
94 |
Keywords: |
|
95 |
apikey[string]: Der API Key |
|
96 |
subject[string]: Der Betreff |
|
97 |
body[string]: Der Email Body |
|
98 |
recipients[list]: Eine Liste von Emailadressen |
|
99 |
frm[string]: Die Absender Emailadresse |
|
100 |
route[string|list]: Route über den geschickt werden soll, |
|
101 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
102 |
||
103 |
Return: |
|
104 |
id[hash]: Die ID des Auftrages |
|
105 |
||
106 |
''' |
|
107 |
return "" |
|
108 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
109 |
@validate(kwd="typ", func=vTyp) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
110 |
@vUser |
| 92 | 111 |
def routes(self, user, typ): |
112 |
'''Gibt eine Liste aller verfügbaren Provider zurück. |
|
113 |
||
114 |
Keywords: |
|
115 |
apikey[string]: Der API Key |
|
116 |
typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
|
117 |
Einer der Liste ["sms","fax","mail"] |
|
118 |
||
119 |
Return: |
|
120 |
providerlist[list]: Eine Liste aller möglichen Provider |
|
121 |
||
122 |
''' |
|
123 |
return "" |
|
124 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
125 |
@validate(kwd="typ", func=vTyp) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
126 |
@vUser |
| 92 | 127 |
def defaultRoute(self, user, typ): |
128 |
'''Gibt den Standardprovider zurück. |
|
129 |
|
|
130 |
Keywords: |
|
131 |
apikey[string]: Der API Key |
|
| 109 | 132 |
typ[string]: Der Typ zu dem die Providerliste ausgeben werden soll |
| 92 | 133 |
Einer der Liste ["sms","fax","mail"] |
134 |
||
135 |
Return: |
|
136 |
provider[string]: Der Standardprovider für den angeben Typ |
|
137 |
||
138 |
||
139 |
''' |
|
140 |
return "" |
|
141 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
142 |
@vUser |
| 92 | 143 |
def statistic(self, user): |
144 |
'''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises. |
|
145 |
||
146 |
Keywords: |
|
147 |
apikey[string]: Der API Key |
|
148 |
||
149 |
Return: |
|
150 |
statistic[list]: Eine Liste nach Nachrichtentypen |
|
151 |
''' |
|
152 |
return "" |
|
153 |
||
154 |