Updated presence stanza to include a 'show' interface. Presence stanza tests updated accordingly.

This commit is contained in:
Lance Stout 2010-07-20 00:04:34 -04:00
parent 14f1c3ba51
commit bb927c7e6a
2 changed files with 49 additions and 31 deletions

View file

@ -5,36 +5,34 @@
See the file license.txt for copying permission. See the file license.txt for copying permission.
""" """
from .. xmlstream.stanzabase import StanzaBase
from xml.etree import cElementTree as ET
from . error import Error from . error import Error
from . rootstanza import RootStanza from . rootstanza import RootStanza
from .. xmlstream.stanzabase import StanzaBase, ET
class Presence(RootStanza): class Presence(RootStanza):
interfaces = set(('type', 'to', 'from', 'id', 'status', 'priority')) interfaces = set(('type', 'to', 'from', 'id', 'show', 'status', 'priority'))
types = set(('available', 'unavailable', 'error', 'probe', 'subscribe', 'subscribed', 'unsubscribe', 'unsubscribed')) types = set(('available', 'unavailable', 'error', 'probe', 'subscribe', 'subscribed', 'unsubscribe', 'unsubscribed'))
showtypes = set(('dnd', 'chat', 'xa', 'away')) showtypes = set(('dnd', 'chat', 'xa', 'away'))
sub_interfaces = set(('status', 'priority')) sub_interfaces = set(('show', 'status', 'priority'))
name = 'presence' name = 'presence'
plugin_attrib = name plugin_attrib = name
namespace = 'jabber:client' namespace = 'jabber:client'
def getShowElement(self): def setShow(self, show):
return self.xml.find("{%s}show" % self.namespace) if show in self.showtypes:
self._setSubText('show', text=show)
return self
def setType(self, value): def setType(self, value):
show = self.getShowElement()
if value in self.types: if value in self.types:
if show is not None: self['show'] = None
self.xml.remove(show)
if value == 'available': if value == 'available':
value = '' value = ''
self._setAttr('type', value) self._setAttr('type', value)
elif value in self.showtypes: elif value in self.showtypes:
if show is None: self['show'] = value
show = ET.Element("{%s}show" % self.namespace)
self.xml.append(show)
show.text = value
return self return self
def setPriority(self, value): def setPriority(self, value):
@ -48,9 +46,7 @@ class Presence(RootStanza):
def getType(self): def getType(self):
out = self._getAttr('type') out = self._getAttr('type')
if not out: if not out:
show = self.getShowElement() out = self['show']
if show is not None:
out = show.text
if not out or out is None: if not out or out is None:
out = 'available' out = 'available'
return out return out

View file

@ -1,31 +1,53 @@
import unittest import sleekxmpp
from sleektest import *
from sleekxmpp.stanza.presence import Presence
class testpresencestanzas(unittest.TestCase): class TestPresenceStanzas(SleekTest):
def setUp(self): def testPresenceShowRegression(self):
import sleekxmpp.stanza.presence as p """Regression check presence['type'] = 'dnd' show value working"""
self.p = p p = self.Presence()
def testPresenceShowRegression(self):
"Regression check presence['type'] = 'dnd' show value working"
p = self.p.Presence()
p['type'] = 'dnd' p['type'] = 'dnd'
self.failUnless(str(p) == "<presence><show>dnd</show></presence>") self.checkPresence(p, """
<presence><show>dnd</show></presence>
""")
def testPresenceType(self):
"""Test manipulating presence['type']"""
p = self.Presence()
p['type'] = 'available'
self.checkPresence(p, """
<presence />
""")
self.failUnless(p['type'] == 'available', "Incorrect presence['type'] for type 'available'")
for showtype in ['away', 'chat', 'dnd', 'xa']:
p['type'] = showtype
self.checkPresence(p, """
<presence><show>%s</show></presence>
""" % showtype)
self.failUnless(p['type'] == showtype, "Incorrect presence['type'] for type '%s'" % showtype)
p['type'] = None
self.checkPresence(p, """
<presence />
""")
def testPresenceUnsolicitedOffline(self): def testPresenceUnsolicitedOffline(self):
"Unsolicted offline presence does not spawn changed_status or update roster" """Unsolicted offline presence does not spawn changed_status or update roster"""
p = self.p.Presence() p = self.Presence()
p['type'] = 'unavailable' p['type'] = 'unavailable'
p['from'] = 'bill@chadmore.com/gmail15af' p['from'] = 'bill@chadmore.com/gmail15af'
import sleekxmpp
c = sleekxmpp.ClientXMPP('crap@wherever', 'password') c = sleekxmpp.ClientXMPP('crap@wherever', 'password')
happened = [] happened = []
def handlechangedpresence(event): def handlechangedpresence(event):
happened.append(True) happened.append(True)
c.add_event_handler("changed_status", handlechangedpresence) c.add_event_handler("changed_status", handlechangedpresence)
c._handlePresence(p) c._handlePresence(p)
self.failUnless(happened == [], "changed_status event triggered for superfulous unavailable presence") self.failUnless(happened == [], "changed_status event triggered for superfulous unavailable presence")
self.failUnless(c.roster == {}, "Roster updated for superfulous unavailable presence") self.failUnless(c.roster == {}, "Roster updated for superfulous unavailable presence")
suite = unittest.TestLoader().loadTestsFromTestCase(testpresencestanzas) suite = unittest.TestLoader().loadTestsFromTestCase(TestPresenceStanzas)