Changeset 147:aa2cfee614e7

Timestamp:

Aug 12, 2011, 2:11:43 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Use generic.Request for room destruction request, add TestableStreamManager?.

Location:

wokkel

Files:

• muc.py (modified) (3 diffs)
• test/helpers.py (modified) (2 diffs)
• test/test_muc.py (modified) (3 diffs)

wokkel/muc.py

@@ -105 +105 @@
 
 
-class OwnerRequest(xmlstream.IQ):
-    """
-    A basic owner iq request.
-
-    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
-    @type method: C{str}
-    """
-
-    def __init__(self, xs, method='get'):
-        xmlstream.IQ.__init__(self, xs, method)
-        q = self.addElement((NS_MUC_OWNER, 'query'))
+class DestructionRequest(generic.Request):
+    """
+    Room destruction request.
+
+    @param reason: Optional reason for the destruction of this room.
+    @type reason: C{unicode}.
+
+    @param alternate: Optional room JID of an alternate venue.
+    @type alternate: L{jid.JID}
+
+    @param password: Optional password for entering the alternate venue.
+    @type password: C{unicode}
+    """
+
+    stanzaType = 'set'
+
+    def __init__(self, recipient, sender=None, reason=None, alternate=None,
+                       password=None):
+        generic.Request.__init__(self, recipient, sender)
+        self.reason = reason
+        self.alternate = alternate
+        self.password = password
+
+
+    def toElement(self):
+        element = generic.Request.toElement(self)
+        element.addElement((NS_MUC_OWNER, 'query'))
+        element.query.addElement('destroy')
+
+        if self.alternate:
+            element.query.destroy['jid'] = self.alternate.full()
+
+            if self.password:
+                element.query.destroy.addElement('password',
+                                                 content=self.password)
+
+        if self.reason:
+            element.query.destroy.addElement('reason', content=self.reason)
+
+        return element
 
 
@@ -1155 +1184 @@
 
 
-    def destroy(self, roomJID, reason=None, alternate=None):
+    def destroy(self, roomJID, reason=None, alternate=None, password=None):
         """
         Destroy a room.
 
-        @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
-
-        @param reason: The reason we are destroying the room.
+        @param roomJID: The JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param reason: The reason for the destruction of the room.
         @type reason: C{unicode}
 
-        @param alternate: The bare JID of the room suggested as an alternate
-                          venue.
+        @param alternate: The JID of the room suggested as an alternate venue.
         @type alternate: L{jid.JID}
 
@@ -1172 +1200 @@
         def destroyed(iq):
             self._removeRoom(roomJID)
-            return True
-
-        iq = OwnerRequest(self.xmlstream, method='set')
-        iq['to'] = roomJID.userhost()
-        d = iq.query.addElement('destroy')
-
-        if alternate is not None:
-            d['jid'] = alternate.userhost()
-        if reason is not None:
-            d.addElement('reason', None, reason)
-
-        return iq.send().addCallback(destroyed)
+
+        request = DestructionRequest(recipient=roomJID, reason=reason,
+                                     alternate=alternate, password=password)
+
+        d = self.request(request)
+        d.addCallback(destroyed)
+        return d
 
 

wokkel/test/helpers.py

@@ -6 +6 @@
 """
 
-from twisted.internet import defer
+from twisted.internet import defer, task
 from twisted.words.xish import xpath
 from twisted.words.xish.utility import EventDispatcher
 
 from wokkel.generic import parseXml
+from wokkel.subprotocols import StreamManager
 
 class XmlStreamStub(object):
@@ -93 +94 @@
 
         return d
+
+
+class TestableStreamManager(StreamManager):
+    """
+    Stream manager for testing subprotocol handlers.
+    """
+
+    def __init__(self, reactor=None):
+        class DummyFactory(object):
+            def addBootstrap(self, event, fn):
+                pass
+
+        factory = DummyFactory()
+        StreamManager.__init__(self, factory, reactor)
+        self.stub = XmlStreamStub()
+        self._connected(self.stub.xmlstream)
+        self._authd(self.stub.xmlstream)

wokkel/test/test_muc.py

@@ -20 +20 @@
 from wokkel import data_form, iwokkel, muc
 from wokkel.generic import parseXml
-from wokkel.test.helpers import XmlStreamStub
+from wokkel.test.helpers import XmlStreamStub, TestableStreamManager
 
 
@@ -47 +47 @@
 
     def setUp(self):
-        self.stub = XmlStreamStub()
         self.clock = task.Clock()
+        self.sessionManager = TestableStreamManager(reactor=self.clock)
+        self.stub = self.sessionManager.stub
         self.protocol = muc.MUCClient(reactor=self.clock)
-        self.protocol.xmlstream = self.stub.xmlstream
-        self.protocol.connectionInitialized()
+        self.protocol.setHandlerParent(self.sessionManager)
+
         self.roomIdentifier = 'test'
         self.service  = 'conference.example.org'
@@ -620 +621 @@
         Destroy a room.
         """
-
-        def cb(destroyed):
-            self.assertTrue(destroyed, 'Room not destroyed.')
-
-        d = self.protocol.destroy(self.occupantJID)
-        d.addCallback(cb)
+        d = self.protocol.destroy(self.occupantJID, reason='Time to leave',
+                                  alternate=JID('other@%s' % self.service),
+                                  password='secret')
 
         iq = self.stub.output[-1]
-        query = "/iq/query[@xmlns='%s']/destroy"% muc.NS_MUC_OWNER
-        self.assertTrue(xpath.matches(query, iq), 'Bad configure request')
+
+        query = ("/iq/query[@xmlns='%s']/destroy[@xmlns='%s']" %
+                 (muc.NS_MUC_OWNER, muc.NS_MUC_OWNER))
+
+        nodes = xpath.queryForNodes(query, iq)
+        self.assertNotIdentical(None, nodes, 'Bad configure request')
+        destroy = nodes[0]
+        self.assertEquals('Time to leave', unicode(destroy.reason))
 
         response = toResponse(iq, 'result')