diff --git a/setup.py b/setup.py
index 1443e90..1904792 100644
--- a/setup.py
+++ b/setup.py
@@ -12,6 +12,8 @@
from distutils.core import setup
import sys
+import sleekxmpp
+
# if 'cygwin' in sys.platform.lower():
# min_version = '0.6c6'
# else:
@@ -25,7 +27,7 @@ import sys
#
# from setuptools import setup, find_packages, Extension, Feature
-VERSION = '1.0.0.0'
+VERSION = sleekxmpp.__version__
DESCRIPTION = 'SleekXMPP is an elegant Python library for XMPP (aka Jabber, Google Talk, etc).'
LONG_DESCRIPTION = """
SleekXMPP is an elegant Python library for XMPP (aka Jabber, Google Talk, etc).
diff --git a/sleekxmpp/__init__.py b/sleekxmpp/__init__.py
index 20f4367..5ad1174 100644
--- a/sleekxmpp/__init__.py
+++ b/sleekxmpp/__init__.py
@@ -14,3 +14,6 @@ from sleekxmpp.xmlstream.handler import *
from sleekxmpp.xmlstream import XMLStream, RestartStream
from sleekxmpp.xmlstream.matcher import *
from sleekxmpp.xmlstream.stanzabase import StanzaBase, ET
+
+__version__ = '1.0beta5'
+__version_info__ = (1, 0, 0, 'beta5', 0)
diff --git a/sleekxmpp/clientxmpp.py b/sleekxmpp/clientxmpp.py
index d5e985d..dc08522 100644
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -246,7 +246,8 @@ class ClientXMPP(BaseXMPP):
p = self._sasl_mechanism_priorities
self._sasl_mechanism_priorities = [i for i in p if i[1] != name]
- def update_roster(self, jid, name=None, subscription=None, groups=[]):
+ def update_roster(self, jid, name=None, subscription=None, groups=[],
+ block=True, timeout=None, callback=None):
"""
Add or change a roster item.
@@ -257,13 +258,24 @@ class ClientXMPP(BaseXMPP):
'to', 'from', 'both', or 'none'. If set
to 'remove', the entry will be deleted.
groups -- The roster groups that contain this item.
+ block -- Specify if the roster request will block
+ until a response is received, or a timeout
+ occurs. Defaults to True.
+ timeout -- The length of time (in seconds) to wait
+ for a response before continuing if blocking
+ is used. Defaults to self.response_timeout.
+ callback -- Optional reference to a stream handler function.
+ Will be executed when the roster is received.
+ Implies block=False.
"""
iq = self.Iq()
iq['type'] = 'set'
iq['roster']['items'] = {jid: {'name': name,
'subscription': subscription,
'groups': groups}}
- response = iq.send()
+ response = iq.send(block, timeout, callback)
+ if response in [False, None]:
+ return response
return response['type'] == 'result'
def del_roster_item(self, jid):
@@ -276,13 +288,33 @@ class ClientXMPP(BaseXMPP):
"""
return self.update_roster(jid, subscription='remove')
- def get_roster(self):
- """Request the roster from the server."""
+ def get_roster(self, block=True, timeout=None, callback=None):
+ """
+ Request the roster from the server.
+
+ Arguments:
+ block -- Specify if the roster request will block until a
+ response is received, or a timeout occurs.
+ Defaults to True.
+ timeout -- The length of time (in seconds) to wait for a response
+ before continuing if blocking is used.
+ Defaults to self.response_timeout.
+ callback -- Optional reference to a stream handler function. Will
+ be executed when the roster is received.
+ Implies block=False.
+ """
iq = self.Iq()
iq['type'] = 'get'
iq.enable('roster')
- response = iq.send()
- self._handle_roster(response, request=True)
+ response = iq.send(block, timeout, callback)
+
+ if response == False:
+ self.event('roster_timeout')
+
+ if response in [False, None] or not isinstance(response, Iq):
+ return response
+ else:
+ return self._handle_roster(response, request=True)
def _handle_connected(self, event=None):
#TODO: Use stream state here
@@ -495,12 +527,14 @@ class ClientXMPP(BaseXMPP):
'presence': {},
'in_roster': True}
self.roster[jid].update(iq['roster']['items'][jid])
+ self.event('roster_received', iq)
self.event("roster_update", iq)
if iq['type'] == 'set':
iq.reply()
iq.enable('roster')
iq.send()
+ return True
# To comply with PEP8, method names now use underscores.
diff --git a/sleekxmpp/plugins/stanza_pubsub.py b/sleekxmpp/plugins/stanza_pubsub.py
index 2d809a3..b596453 100644
--- a/sleekxmpp/plugins/stanza_pubsub.py
+++ b/sleekxmpp/plugins/stanza_pubsub.py
@@ -237,6 +237,8 @@ class Unsubscribe(ElementBase):
def getJid(self):
return JID(self._getAttr('jid'))
+registerStanzaPlugin(Pubsub, Unsubscribe)
+
class Subscribe(ElementBase):
namespace = 'http://jabber.org/protocol/pubsub'
name = 'subscribe'
diff --git a/sleekxmpp/stanza/iq.py b/sleekxmpp/stanza/iq.py
index 2bfbc7b..82ab13e 100644
--- a/sleekxmpp/stanza/iq.py
+++ b/sleekxmpp/stanza/iq.py
@@ -77,7 +77,7 @@ class Iq(RootStanza):
StanzaBase.__init__(self, *args, **kwargs)
if self['id'] == '':
if self.stream is not None:
- self['id'] = self.stream.getNewId()
+ self['id'] = self.stream.new_id()
else:
self['id'] = '0'
diff --git a/sleekxmpp/test/sleektest.py b/sleekxmpp/test/sleektest.py
index c5f4889..fd47a87 100644
--- a/sleekxmpp/test/sleektest.py
+++ b/sleekxmpp/test/sleektest.py
@@ -600,8 +600,13 @@ class SleekTest(unittest.TestCase):
Defaults to the value of self.match_method.
"""
sent = self.xmpp.socket.next_sent(timeout)
+ if data is None and sent is None:
+ return
+ if data is None and sent is not None:
+ self.fail("Stanza data was sent: %s" % sent)
if sent is None:
self.fail("No stanza was sent.")
+
xml = self.parse_xml(sent)
self.fix_namespaces(xml, 'jabber:client')
sent = self.xmpp._build_stanza(xml, 'jabber:client')
diff --git a/sleekxmpp/xmlstream/scheduler.py b/sleekxmpp/xmlstream/scheduler.py
index 0e711b4..12deedd 100644
--- a/sleekxmpp/xmlstream/scheduler.py
+++ b/sleekxmpp/xmlstream/scheduler.py
@@ -132,6 +132,7 @@ class Scheduler(object):
if threaded:
self.thread = threading.Thread(name='sheduler_process',
target=self._process)
+ self.thread.daemon = True
self.thread.start()
else:
self._process()
diff --git a/tests/test_stanza_error.py b/tests/test_stanza_error.py
index e1c7d5a..a41bf4b 100644
--- a/tests/test_stanza_error.py
+++ b/tests/test_stanza_error.py
@@ -3,13 +3,18 @@ from sleekxmpp.test import *
class TestErrorStanzas(SleekTest):
+ def setUp(self):
+ # Ensure that the XEP-0086 plugin has been loaded.
+ self.stream_start()
+ self.stream_close()
+
def testSetup(self):
"""Test setting initial values in error stanza."""
msg = self.Message()
msg.enable('error')
self.check(msg, """
-
+
@@ -22,7 +27,7 @@ class TestErrorStanzas(SleekTest):
self.check(msg, """
-
+
@@ -34,7 +39,7 @@ class TestErrorStanzas(SleekTest):
self.check(msg, """
-
+
@@ -50,7 +55,7 @@ class TestErrorStanzas(SleekTest):
self.check(msg, """
-
+
Error!
@@ -66,7 +71,7 @@ class TestErrorStanzas(SleekTest):
self.check(msg, """
-
+
diff --git a/tests/test_stream_roster.py b/tests/test_stream_roster.py
index 165a8bc..731d114 100644
--- a/tests/test_stream_roster.py
+++ b/tests/test_stream_roster.py
@@ -16,6 +16,13 @@ class TestStreamRoster(SleekTest):
self.stream_start(mode='client')
self.failUnless(self.xmpp.roster == {}, "Initial roster not empty.")
+ events = []
+
+ def roster_received(iq):
+ events.append('roster_received')
+
+ self.xmpp.add_event_handler('roster_received', roster_received)
+
# Since get_roster blocks, we need to run it in a thread.
t = threading.Thread(name='get_roster', target=self.xmpp.get_roster)
t.start()
@@ -41,6 +48,9 @@ class TestStreamRoster(SleekTest):
# Wait for get_roster to return.
t.join()
+ # Give the event queue time to process.
+ time.sleep(.1)
+
roster = {'user@localhost': {'name': 'User',
'subscription': 'both',
'groups': ['Friends', 'Examples'],
@@ -48,11 +58,20 @@ class TestStreamRoster(SleekTest):
'in_roster': True}}
self.failUnless(self.xmpp.roster == roster,
"Unexpected roster values: %s" % self.xmpp.roster)
+ self.failUnless('roster_received' in events,
+ "Roster received event not triggered: %s" % events)
def testRosterSet(self):
"""Test handling pushed roster updates."""
self.stream_start(mode='client')
self.failUnless(self.xmpp.roster == {}, "Initial roster not empty.")
+ events = []
+
+ def roster_update(e):
+ events.append('roster_update')
+
+ self.xmpp.add_event_handler('roster_update', roster_update)
+
self.recv("""
@@ -72,6 +91,9 @@ class TestStreamRoster(SleekTest):
""")
+ # Give the event queue time to process.
+ time.sleep(.1)
+
roster = {'user@localhost': {'name': 'User',
'subscription': 'both',
'groups': ['Friends', 'Examples'],
@@ -79,7 +101,66 @@ class TestStreamRoster(SleekTest):
'in_roster': True}}
self.failUnless(self.xmpp.roster == roster,
"Unexpected roster values: %s" % self.xmpp.roster)
+ self.failUnless('roster_update' in events,
+ "Roster updated event not triggered: %s" % events)
+ def testRosterTimeout(self):
+ """Test handling a timed out roster request."""
+ self.stream_start()
+ events = []
+
+ def roster_timeout(event):
+ events.append('roster_timeout')
+
+ self.xmpp.add_event_handler('roster_timeout', roster_timeout)
+ self.xmpp.get_roster(timeout=0)
+
+ # Give the event queue time to process.
+ time.sleep(.1)
+
+ self.failUnless(events == ['roster_timeout'],
+ "Roster timeout event not triggered: %s." % events)
+
+ def testRosterCallback(self):
+ """Test handling a roster request callback."""
+ self.stream_start()
+ events = []
+
+ def roster_callback(iq):
+ events.append('roster_callback')
+
+ # Since get_roster blocks, we need to run it in a thread.
+ t = threading.Thread(name='get_roster',
+ target=self.xmpp.get_roster,
+ kwargs={'callback': roster_callback})
+ t.start()
+
+ self.send("""
+
+
+
+ """)
+ self.recv("""
+
+
+ -
+ Friends
+ Examples
+
+
+
+ """)
+
+ # Wait for get_roster to return.
+ t.join()
+
+ # Give the event queue time to process.
+ time.sleep(.1)
+
+ self.failUnless(events == ['roster_callback'],
+ "Roster timeout event not triggered: %s." % events)