source: ralphm-patches/pubsub-item.patch @ 83:255aae0cf8c5

wokkel/generic.py

@@ -34 +34 @@
     @return: The DOM structure, or C{None} on empty or incomplete input.
     @rtype: L{domish.Element}
     """
-    roots = []
     results = []
     elementStream = domish.elementStream()
-    elementStream.DocumentStartEvent = roots.append
-    elementStream.ElementEvent = lambda elem: roots[0].addChild(elem)
-    elementStream.DocumentEndEvent = lambda: results.append(roots[0])
-    elementStream.parse(string)
+    elementStream.DocumentStartEvent = lambda _: None
+    elementStream.ElementEvent = lambda elem: results.append(elem)
+    elementStream.DocumentEndEvent = lambda: None
+    elementStream.parse('<dummy>%s</dummy>' % string)
     return results and results[0] or None
 
 

wokkel/pubsub.py

@@ -157 +157 @@
 
 
 
-class Item(domish.Element):
+class Item(object):
     """
     Publish subscribe item.
 
-    This behaves like an object providing L{domish.IElement}.
-
-    Item payload can be added using C{addChild} or C{addRawXml}, or using the
-    C{payload} keyword argument to C{__init__}.
+    @ivar itemIdentifier: Optional item identifier.
+    @type itemIdentifier: L{unicode}
+    @ivar payload: Optional item payload. Either as a L{domish.Element}, or as
+        serialized XML.
+    @type payload: Object providing L{domish.IElement} or L{unicode}.
+    @ivar timestamp: Optional timestamp when the item was published as 8601
+    string. Timestamps that include a time component must have a time zone
+    indicated.
+    @type timestamp: C{unicode}
+    @ivar publisher: Optional entity that published this item.
+    @type publisher: L{JID}
     """
 
-    def __init__(self, id=None, payload=None):
+    def __init__(self, itemIdentifier=None, payload=None,
+                       timestamp=None, publisher=None):
+        self.itemIdentifier = itemIdentifier
+        self.payload = payload
+        self.timestamp = timestamp
+        self.publisher = publisher
+
+
+    def toElement(self, namespace=NS_PUBSUB):
         """
-        @param id: optional item identifier
-        @type id: C{unicode}
-        @param payload: optional item payload. Either as a domish element, or
-                        as serialized XML.
-        @type payload: object providing L{domish.IElement} or C{unicode}.
+        Render to a DOM representation.
+
+        Usually called by when rendering requests or responses. The optional
+        C{namespace} argument is for rendering the item in that namespace, so
+        L{Item} is usable in all contexts involving items.
+
+        @param namespace: The namespace of the item. Usually L{NS_PUBSUB} or
+            L{NS_PUBSUB_EVENT}.
+        @type: C{unicode}
+        @rtype: L{domish.Element}
         """
+        element = domish.Element((namespace, 'item'))
 
-        domish.Element.__init__(self, (None, 'item'))
-        if id is not None:
-            self['id'] = id
-        if payload is not None:
-            if isinstance(payload, basestring):
-                self.addRawXml(payload)
+        if self.itemIdentifier is not None:
+            element['id'] = self.itemIdentifier
+
+        if self.payload is not None:
+            if isinstance(self.payload, basestring):
+                element.addRawXml(self.payload)
             else:
-                self.addChild(payload)
+                element.addChild(self.payload)
+
+        return element
 
 
 
@@ -362 +385 @@
         self.items = []
         for element in verbElement.elements():
             if element.uri == NS_PUBSUB and element.name == 'item':
-                self.items.append(element)
+                item = Item()
+                item.itemIdentifier = element.getAttribute('id')
+                try:
+                    item.payload = element.elements().next()
+                except StopIteration:
+                    pass
+                self.items.append(item)
 
 
     def _render_items(self, verbElement):
@@ -371 +400 @@
         """
         if self.items:
             for item in self.items:
-                item.uri = NS_PUBSUB
-                verbElement.addChild(item)
+                verbElement.addChild(item.toElement())
 
 
     def _parse_jid(self, verbElement):
@@ -1319 +1347 @@
         items["node"] = request.nodeIdentifier
 
         for item in result:
-            item.uri = NS_PUBSUB
-            items.addChild(item)
+            items.addChild(item.toElement())
 
         return response
 
@@ -1371 +1398 @@
                                                nodeIdentifier, subscriber,
                                                subscriptions)
             for item in items:
-                item.uri = NS_PUBSUB_EVENT
-                message.event.items.addChild(item)
+                message.event.items.addChild(item.toElement(NS_PUBSUB_EVENT))
             self.send(message)
 
 

wokkel/test/test_pubsub.py

@@ -115 +115 @@
 
 
 
+class ItemTest(unittest.TestCase):
+
+    def test_toElement(self):
+        item = pubsub.Item(itemIdentifier='test')
+        element = item.toElement()
+        self.assertEquals('test', element.getAttribute('id'))
+
+
+    def test_toElementPayload(self):
+        payload = domish.Element(('testns', 'test'))
+        item = pubsub.Item(itemIdentifier='test', payload=payload)
+        element = item.toElement()
+        self.assertNotIdentical(None, element.test)
+        self.assertEquals('testns', element.test.uri)
+
+
+    def test_toElementPayloadRawXML(self):
+        payload = u"<test xmlns='testns'/>"
+        item = pubsub.Item(itemIdentifier='test', payload=payload)
+        element = item.toElement()
+        self.assertEquals(1, len(element.children))
+        self.assertEquals(payload, element.children[0])
+
+
 class PubSubClientTest(unittest.TestCase):
     timeout = 2
 
@@ -465 +489 @@
         items = list(domish.generateElementsQNamed(child.children,
                                                    'item', NS_PUBSUB))
         self.assertEquals(1, len(items))
-        self.assertIdentical(item, items[0])
 
         response = toResponse(iq, 'result')
         self.stub.send(response)
@@ -1048 +1071 @@
 
         request = pubsub.PubSubRequest.fromElement(parseXml(xml))
         self.assertEqual(2, len(request.items))
-        self.assertEqual(u'item1', request.items[0]["id"])
-        self.assertEqual(u'item2', request.items[1]["id"])
+        self.assertEqual(u'item1', request.items[0].itemIdentifier)
+        self.assertEqual(u'item2', request.items[1].itemIdentifier)
 
 
     def test_fromElementPublishItemsOptions(self):
@@ -1075 +1098 @@
 
         request = pubsub.PubSubRequest.fromElement(parseXml(xml))
         self.assertEqual(2, len(request.items))
-        self.assertEqual(u'item1', request.items[0]["id"])
-        self.assertEqual(u'item2', request.items[1]["id"])
+        self.assertEqual(u'item1', request.items[0].itemIdentifier)
+        self.assertEqual(u'item2', request.items[1].itemIdentifier)
+
 
     def test_fromElementPublishNoNode(self):
         """