Changeset 102:039149921acf

Timestamp:

Aug 3, 2011, 9:49:22 AM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Add base class for IQ get/set request stanzas: Request.

Location:

wokkel

Files:

• generic.py (modified) (1 diff)
• test/test_generic.py (modified) (2 diffs)

wokkel/generic.py

@@ -237 +237 @@
 
 
+class Request(Stanza):
+    """
+    IQ request stanza.
+
+    This is a base class for IQ get or set stanzas, to be used with
+    L{wokkel.subprotocols.StreamManager.request}.
+    """
+
+    stanzaKind = 'iq'
+    stanzaType = 'get'
+    timeout = None
+
+    def __init__(self, recipient=None, sender=None, stanzaType='get'):
+        Stanza.__init__(self, recipient=recipient, sender=sender)
+        self.stanzaType = stanzaType
+
+
+    def toElement(self):
+        element = Stanza.toElement(self)
+
+        if not self.stanzaID:
+            element.addUniqueId()
+            self.stanzaID = element['id']
+
+        return element
+
+
+
 class DeferredXmlStreamFactory(BootstrapMixin, protocol.ClientFactory):
     protocol = xmlstream.XmlStream

wokkel/test/test_generic.py

@@ -8 +8 @@
 from twisted.trial import unittest
 from twisted.words.xish import domish
+from twisted.words.protocols.jabber.jid import JID
 
 from wokkel import generic
@@ -87 +88 @@
         self.pipe.sink.send(element)
         self.assertEquals([element], called)
+
+
+
+class RequestTest(unittest.TestCase):
+    """
+    Tests for L{generic.Request}.
+    """
+
+    def setUp(self):
+        self.request = generic.Request()
+
+
+    def test_toElementStanzaKind(self):
+        """
+        A request is an iq stanza.
+        """
+        element = self.request.toElement()
+        self.assertIdentical(None, element.uri)
+        self.assertEquals('iq', element.name)
+
+
+    def test_toElementStanzaType(self):
+        """
+        The request has type 'get'.
+        """
+        self.assertEquals('get', self.request.stanzaType)
+        element = self.request.toElement()
+        self.assertEquals('get', element.getAttribute('type'))
+
+
+    def test_toElementStanzaTypeSet(self):
+        """
+        The request has type 'set'.
+        """
+        self.request.stanzaType = 'set'
+        element = self.request.toElement()
+        self.assertEquals('set', element.getAttribute('type'))
+
+
+    def test_toElementStanzaID(self):
+        """
+        A request, when rendered, has an identifier.
+        """
+        element = self.request.toElement()
+        self.assertNotIdentical(None, self.request.stanzaID)
+        self.assertEquals(self.request.stanzaID, element.getAttribute('id'))
+
+
+    def test_toElementRecipient(self):
+        """
+        A request without recipient, has no 'to' attribute.
+        """
+        self.request = generic.Request(recipient=JID('other@example.org'))
+        self.assertEquals(JID('other@example.org'), self.request.recipient)
+        element = self.request.toElement()
+        self.assertEquals(u'other@example.org', element.getAttribute('to'))
+
+
+    def test_toElementRecipientNone(self):
+        """
+        A request without recipient, has no 'to' attribute.
+        """
+        element = self.request.toElement()
+        self.assertFalse(element.hasAttribute('to'))
+
+
+    def test_toElementSender(self):
+        """
+        A request with sender, has a 'from' attribute.
+        """
+        self.request = generic.Request(sender=JID('user@example.org'))
+        self.assertEquals(JID('user@example.org'), self.request.sender)
+        element = self.request.toElement()
+        self.assertEquals(u'user@example.org', element.getAttribute('from'))
+
+
+    def test_toElementSenderNone(self):
+        """
+        A request without sender, has no 'from' attribute.
+        """
+        element = self.request.toElement()
+        self.assertFalse(element.hasAttribute('from'))
+
+
+    def test_timeoutDefault(self):
+        """
+        The default is no timeout.
+        """
+        self.assertIdentical(None, self.request.timeout)