source: ralphm-patches/request-stanza.patch @ 47:f6d222b68f1c

# HG changeset patch
# Parent cddd993198e15f928c472d299e3351b8802e3608
Add base class for IQ get/set request stanzas: Request.

diff -r cddd993198e1 wokkel/generic.py
--- a/wokkel/generic.py Fri Mar 04 09:48:19 2011 +0100
+++ b/wokkel/generic.py Fri Mar 04 09:49:28 2011 +0100
@@ -236,6 +236,27 @@
         self.exception = error.exceptionFromStanza(element)
 
 
+class Request(Stanza):
+    stanzaKind = 'iq'
+    stanzaType = 'get'
+    timeout = None
+
+    def __init__(self, stanzaType='get', recipient=None, sender=None):
+        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
 
diff -r cddd993198e1 wokkel/test/test_generic.py
--- a/wokkel/test/test_generic.py       Fri Mar 04 09:48:19 2011 +0100
+++ b/wokkel/test/test_generic.py       Fri Mar 04 09:49:28 2011 +0100
@@ -7,6 +7,7 @@
 
 from twisted.trial import unittest
 from twisted.words.xish import domish
+from twisted.words.protocols.jabber.jid import JID
 
 from wokkel import generic
 from wokkel.test.helpers import XmlStreamStub
@@ -86,3 +87,92 @@
         element = domish.Element(('testns', 'test'))
         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)