iro/controller/viewinterface.py
author Sandro Knauß <knauss@netzguerilla.net>
Sun, 25 Mar 2012 20:14:35 +0200
branchdevel
changeset 253 e8d56537c9cc
parent 250 91890ea7ed81
child 268 d0fcb1cde990
permissions -rw-r--r--
start documenting with reST syntax.

# -*- coding: utf-8 -*-
from ..model.decorators import vUser, vRoute, dbdefer, vTyp
from ..model.message import SMS, Fax, Mail

from ..validate import validate, vBool, vTel, vEmail, vInteger

from .task import createJob

class Interface(object):
    '''Interface for views.'''
    
    @validate(kwd="detailed", func=vBool, need=False)
    @validate(kwd="id", func=vInteger, minv=0, need=False, none_allowed=True)
    @vUser
    @dbdefer
    def status(self, session, user, id=None, detailed=False):
        '''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück.

        :param string apikey: der API Key
        :param hash id: Eine Auftragsnummer
        :param `boolean` detailed: Details ausgeben

        :return dict: 
           - `key` ist die Auftragsnummer
           - [`key`][**'status'**] -- Status des Auftrages

        .. warning:: detailed is not used yet.
        
        >>> status(APIKEY)
        {"1":  {"status":"sended"},
         "2":  {"status":"error"},
         "10": {"status":"sending"}}

        >>> status(APIKEY,"10")
        {"10": {"status":"sending"}}
        '''
        user = session.merge(user)
        ret={}
        if not id:
            for job in  user.jobs:
                ret[str(job.id)]={"status":job.status}
        else:
            ret[str(id)]={"status":user.job(id).status}
        
        return ret
   
    @validate(kwd="recipients",func=vTel)
    @vUser
    @validate(kwd="route", func=vRoute, typ="sms")
    def sms(self, user, message, recipients, route="default", info=""):
        '''Versendet eine SMS.

        :param string apikey: Der API Key
        :param string message: Nachricht
        :param list recipients: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
        :param route: Route über den geschickt werden soll, 
                            oder eine Liste von Routen, um Fallbacks anzugeben
        :type route: string|list
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.

        :return hash: Die ID des Auftrages

        '''
        d = createJob(user, recipients, SMS(message), route, info)
        def ret(job):
            return job.dbjob
        d.addCallback(ret)
        return d
   
    @validate(kwd="recipients",func=vTel)
    @vUser
    @validate(kwd="route",func=vRoute, typ="fax")
    def fax(self, user, subject, fax, recipients, route="default", info=""):
        '''Versendet ein FAX.

        :param string apikey: Der API Key
        :param string subject: Der Betreff
        :param string fax: Der base64 kodierte content
        :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
        :param route: Route über den geschickt werden soll, 
                            oder eine Liste von Routen, um Fallbacks anzugeben
        :type route: string|list
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.

        :return hash: Die ID des Auftrages
        '''
        d = createJob(user, recipients, Fax(subject, fax), route, info)
        def ret(job):
            return job.dbjob
        d.addCallback(ret)
        return d

    @validate(kwd="recipients",func=vEmail, allowString=False)
    @validate(kwd="frm",func=vEmail, need=False, allowList=False)
    @vUser
    @validate(kwd="route",func=vRoute, typ="mail")
    def mail(self, user, subject, body, recipients, frm=None, route="default", info=""):
        '''Versendet eine Email.

        :param string apikey: Der API Key
        :param string subject: Der Betreff
        :param string body: Der Email Body
        :param list recipients: Eine Liste von Emailadressen
        :param string frm: Die Absender Emailadresse
        :param route: Route über den geschickt werden soll, 
                            oder eine Liste von Routen, um Fallbacks anzugeben
        :type route: string|list
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.

        :return hash: Die ID des Auftrages
        '''

        d = createJob(user, recipients, Mail(subject, body, frm), route, info)
        def ret(job):
            return job.dbjob
        d.addCallback(ret)
        return d
       
    @validate(kwd="typ", func=vTyp)
    @vUser
    @dbdefer
    def routes(self, session, user, typ):
        '''Gibt eine Liste aller verfügbaren Provider zurück.

        :param string apikey: Der API Key
        :param string typ: Der Typ zu dem die Providerloste ausgeben werden soll
                     Einer der Liste ["sms","fax","mail"]

        :return list: Eine Liste aller möglichen Provider
        '''
        user = session.merge(user)
        offers = user.routes(typ)
        return [u[0] for u in offers]
        
    @validate(kwd="typ", func=vTyp)
    @vUser
    @dbdefer
    def defaultRoute(self, session, user, typ):
        '''Gibt den Standardprovider zurück.
 
        :param string apikey: Der API Key
        :param string typ: Der Typ zu dem die Providerliste ausgeben werden soll
                     Einer der Liste ["sms","fax","mail"]

        :return string: Der Standardprovider für den angeben Typ
        '''
        user = session.merge(user)
        offers = user.routes(typ, default=True)
        return [u[0] for u in offers]

    @vUser
    @dbdefer
    def bill(self, session, user):
        '''Gibt eine Rechnung zurück über die noch nicht abgerechneten Nachrichten und des Preises.

        :param string apikey: Der API Key

        :return dict:
            - `route` -- Entspricht einer Route; **"total"** für die Gesammtübersicht
            - [`route`][`info`][**anz**] -- Anzahl der verschickten Nachrichten pro "Infoklasse"
            - [`route`][`info`][**price**] -- Preis pro "Infoklasse"
            - [`route` | **total**][**anz**] -- Anzahl der verschickten Nachrichten pro Route 
            - [`route` | **total**][**price**] -- Preis für eine Route

        >>> bill(APIKEY)
        {"route1": {"info1":{"anz":1,"price":2.00},
                    "info2":{"anz":2,"price":5.00},
                    "anz":3,"price":7.00},
        "route2":  {"info1":{"anz":3, "price":1.00},
                    "info3":{"anz":4, "price":8.00},
                    "anz":7, "price":9.00},
        "total":   {"anz":10, "price":16.00}
        }

        '''
        ret={'total':{'price':0, 'anz':0}}
        user=session.merge(user)
        for route in user.rights:
            n=route.offer_name
            ret[n]={'price':0, 'anz':0, 'info':{}}
            for bill in route.bill:
                ret[n]['info'][bill.info]={'price':float(bill.price),'anz':bill.anz}
                ret[n]['price'] += bill.price
                ret[n]['anz'] += bill.anz
            ret['total']['price'] += ret[n]['price'] 
            ret['total']['anz'] += ret[n]['anz'] 
            ret[n]['price'] = float(ret[n]['price'])

        ret['total']['price'] = float(ret['total']['price'])
        return ret

    @validate(kwd="recipients",func=vTel)
    def telnumber(self,recipients):
        '''Gibt True zurück, falls alle übergebene Telefonnummern valide sind.
        
        :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)

        :return: True -- alle übergebene Nummern sind valide
        '''
        return True

    @validate(kwd="recipients",func=vEmail)
    def email(self,recipients):
        '''Gibt True zurück, falls alle übergebene Emailadressen valide sind.
        
        :param list recipients: Eine Liste von Emailadressen

        :return: True -- alle übergebene Nummern sind valide
        '''
        return True