pep/slixmpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated roster stanza with docs and PEP8 style.

Browse source
This commit is contained in:
Lance Stout 2010-08-11 23:32:14 -04:00
parent 7a5ef28492
commit b40a489796
2 changed files with 183 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
sleekxmpp/stanza/roster.py
View file

@ -5,17 +5,55 @@
See the file LICENSE for copying permission.
"""
from .. xmlstream.stanzabase import registerStanzaPlugin, ElementBase, ET, JID
import logging
from sleekxmpp.stanza import Iq
from sleekxmpp.xmlstream import JID
from sleekxmpp.xmlstream.stanzabase import registerStanzaPlugin
from sleekxmpp.xmlstream.stanzabase import ET, ElementBase
class Roster(ElementBase):
"""
Example roster stanzas:
<iq type="set">
<query xmlns="jabber:iq:roster">
<item jid="user@example.com" subscription="both" name="User">
<group>Friends</group>
</item>
</query>
</iq>
Stanza Inteface:
items -- A dictionary of roster entries contained
in the stanza.
Methods:
getItems -- Return a dictionary of roster entries.
setItems -- Add <item> elements.
delItems -- Remove all <item> elements.
"""
namespace = 'jabber:iq:roster'
name = 'query'
plugin_attrib = 'roster'
interfaces = set(('items',))
sub_interfaces = set()
def setItems(self, items):
"""
Set the roster entries in the <roster> stanza.
Uses a dictionary using JIDs as keys, where each entry is itself
a dictionary that contains:
name -- An alias or nickname for the JID.
subscription -- The subscription type. Can be one of 'to',
'from', 'both', 'none', or 'remove'.
groups -- A list of group names to which the JID
has been assigned.
Arguments:
items -- A dictionary of roster entries.
"""
self.delItems()
for jid in items:
ijid = str(jid)
@ -35,6 +73,16 @@ class Roster(ElementBase):
return self
def getItems(self):
"""
Return a dictionary of roster entries.
Each item is keyed using its JID, and contains:
name -- An assigned alias or nickname for the JID.
subscription -- The subscription type. Can be one of 'to',
'from', 'both', 'none', or 'remove'.
groups -- A list of group names to which the JID has
been assigned.
"""
items = {}
itemsxml = self.xml.findall('{jabber:iq:roster}item')
if itemsxml is not None:
@ -51,5 +99,11 @@ class Roster(ElementBase):
return items
def delItems(self):
"""
Remove all <item> elements from the roster stanza.
"""
for child in self.xml.getchildren():
self.xml.remove(child)
registerStanzaPlugin(Iq, Roster)

84
tests/test_roster.py Normal file
View file

@ -0,0 +1,84 @@
from . sleektest import *
from sleekxmpp.stanza.roster import Roster
class TestRosterStanzas(SleekTest):
def testAddItems(self):
"""Test adding items to a roster stanza."""
iq = self.Iq()
iq['roster'].setItems({
'user@example.com': {
'name': 'User',
'subscription': 'both',
'groups': ['Friends', 'Coworkers']},
'otheruser@example.com': {
'name': 'Other User',
'subscription': 'both',
'groups': []}})
self.checkIq(iq, """
<iq>
<query xmlns="jabber:iq:roster">
<item jid="user@example.com" name="User" subscription="both">
<group>Friends</group>
<group>Coworkers</group>
</item>
<item jid="otheruser@example.com" name="Other User"
subscription="both" />
</query>
</iq>
""")
def testGetItems(self):
"""Test retrieving items from a roster stanza."""
xml_string = """
<iq>
<query xmlns="jabber:iq:roster">
<item jid="user@example.com" name="User" subscription="both">
<group>Friends</group>
<group>Coworkers</group>
</item>
<item jid="otheruser@example.com" name="Other User"
subscription="both" />
</query>
</iq>
"""
iq = self.Iq(ET.fromstring(xml_string))
expected = {
'user@example.com': {
'name': 'User',
'subscription': 'both',
'groups': ['Friends', 'Coworkers']},
'otheruser@example.com': {
'name': 'Other User',
'subscription': 'both',
'groups': []}}
debug = "Roster items don't match after retrieval."
debug += "\nReturned: %s" % str(iq['roster']['items'])
debug += "\nExpected: %s" % str(expected)
self.failUnless(iq['roster']['items'] == expected, debug)
def testDelItems(self):
"""Test clearing items from a roster stanza."""
xml_string = """
<iq>
<query xmlns="jabber:iq:roster">
<item jid="user@example.com" name="User" subscription="both">
<group>Friends</group>
<group>Coworkers</group>
</item>
<item jid="otheruser@example.com" name="Other User"
subscription="both" />
</query>
</iq>
"""
iq = self.Iq(ET.fromstring(xml_string))
del iq['roster']['items']
self.checkIq(iq, """
<iq>
<query xmlns="jabber:iq:roster" />
</iq>
""")
suite = unittest.TestLoader().loadTestsFromTestCase(TestRosterStanzas)