Changeset 220:c8a97efc6fa6

Timestamp:

Aug 30, 2016, 9:41:31 PM (4 years ago)

Author:

souliane <souliane@…>

Branch:

default

committer:

souliane <souliane@mailoo.org> 1472587320 -7200

hg-git-rename-source:

git

Message:

implement item retrieval by IDs

Location:

wokkel

Files:

• pubsub.py (modified) (3 diffs)
• test/test_pubsub.py (modified) (1 diff)

wokkel/pubsub.py

@@ -912 +912 @@
 
 
-    def items(self, service, nodeIdentifier, maxItems=None,
+    def items(self, service, nodeIdentifier, maxItems=None, itemIdentifiers=None,
               subscriptionIdentifier=None, sender=None):
         """
@@ -925 +925 @@
         @param maxItems: Optional limit on the number of retrieved items.
         @type maxItems: C{int}
+
+        @param itemIdentifiers: Identifiers of the items to be retrieved.
+        @type itemIdentifiers: C{set}
 
         @param subscriptionIdentifier: Optional subscription identifier. In
@@ -938 +941 @@
         request.subscriptionIdentifier = subscriptionIdentifier
         request.sender = sender
+        request.itemIdentifiers = itemIdentifiers
 
         def cb(iq):

wokkel/test/test_pubsub.py

@@ -802 +802 @@
 
 
+    def test_itemsWithItemIdentifiers(self):
+        """
+        Test sending items request with item identifiers.
+        """
+        def cb(items):
+            self.assertEquals(2, len(items))
+            self.assertEquals([item1, item2], items)
+
+        d = self.protocol.items(JID('pubsub.example.org'), 'test',
+                                itemIdentifiers=['item1', 'item2'])
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        self.assertEquals('pubsub.example.org', iq.getAttribute('to'))
+        self.assertEquals('get', iq.getAttribute('type'))
+        self.assertEquals('pubsub', iq.pubsub.name)
+        self.assertEquals(NS_PUBSUB, iq.pubsub.uri)
+        children = list(domish.generateElementsQNamed(iq.pubsub.children,
+                                                      'items', NS_PUBSUB))
+        self.assertEquals(1, len(children))
+        child = children[0]
+        self.assertEquals('test', child['node'])
+        itemIdentifiers = [item.getAttribute('id') for item in
+                           domish.generateElementsQNamed(child.children, 'item',
+                                                         NS_PUBSUB)]
+        self.assertEquals(['item1', 'item2'], itemIdentifiers)
+
+        response = toResponse(iq, 'result')
+        items = response.addElement((NS_PUBSUB, 'pubsub')).addElement('items')
+        items['node'] = 'test'
+        item1 = items.addElement('item')
+        item1['id'] = 'item1'
+        item2 = items.addElement('item')
+        item2['id'] = 'item2'
+
+        self.stub.send(response)
+
+        return d
+
+
     def test_itemsWithSubscriptionIdentifier(self):
         """