Changeset 174:c0f51d95bf0f for wokkel

Timestamp:

May 9, 2012, 2:24:28 PM (8 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Add support for adding and updating roster items.

Roster items can be added or updated by sending a roster set request using the
new wokkel.xmppim.RosterClientProtocol.setItem. It takes a RosterItem as
the only argument. Note that changes in presence subscriptions for the contact
need to be done using presence as provided by
wokkel.xmppim.PresenceProtocol.

Author: ralphm.
Fixes: #56.

Location:

wokkel

Files:

• test/test_xmppim.py (modified) (1 diff)
• xmppim.py (modified) (6 diffs)

wokkel/test/test_xmppim.py

@@ -966 +966 @@
 
 
+    def test_setItem(self):
+        """
+        Setting a roster item renders the item and sends it out.
+        """
+        item = xmppim.RosterItem(JID('test@example.org'),
+                                 name='Joe User',
+                                 groups=set(['Friends', 'Jabber']))
+        d = self.service.setItem(item)
+
+        # Inspect outgoing iq request
+
+        iq = self.stub.output[-1]
+        self.assertEqual('set', iq.getAttribute('type'))
+        self.assertNotIdentical(None, iq.query)
+        self.assertEqual(NS_ROSTER, iq.query.uri)
+
+        children = list(domish.generateElementsQNamed(iq.query.children,
+                                                      'item', NS_ROSTER))
+        self.assertEqual(1, len(children))
+        child = children[0]
+        self.assertEqual('test@example.org', child['jid'])
+        self.assertIdentical(None, child.getAttribute('subscription'))
+
+        # Fake successful response
+
+        response = toResponse(iq, 'result')
+        d.callback(response)
+        return d
+
+
+    def test_setItemIgnoreAttributes(self):
+        """
+        Certain attributes should be rendered for roster set.
+        """
+        item = xmppim.RosterItem(JID('test@example.org'),
+                                 subscriptionTo=True,
+                                 subscriptionFrom=False,
+                                 name='Joe User',
+                                 groups=set(['Friends', 'Jabber']))
+        item.pendingOut = True
+        item.approved = True
+        d = self.service.setItem(item)
+
+        # Inspect outgoing iq request
+
+        iq = self.stub.output[-1]
+        self.assertEqual('set', iq.getAttribute('type'))
+        self.assertNotIdentical(None, iq.query)
+        self.assertEqual(NS_ROSTER, iq.query.uri)
+
+        children = list(domish.generateElementsQNamed(iq.query.children,
+                                                      'item', NS_ROSTER))
+        self.assertEqual(1, len(children))
+        child = children[0]
+        self.assertIdentical(None, child.getAttribute('ask'))
+        self.assertIdentical(None, child.getAttribute('approved'))
+        self.assertIdentical(None, child.getAttribute('subscription'))
+
+        # Fake successful response
+
+        response = toResponse(iq, 'result')
+        d.callback(response)
+        return d
+
+
     def test_removeItem(self):
         """

wokkel/xmppim.py

@@ -694 +694 @@
 
 
-    def toElement(self):
+    def toElement(self, rosterSet=False):
+        """
+        Render to a DOM representation.
+
+        If C{rosterSet} is set, some attributes, that may not be sent
+        as a roster set, will not be rendered.
+
+        @type rosterSet: C{boolean}.
+        """
         element = domish.Element((NS_ROSTER, 'item'))
         element['jid'] = self.entity.full()
@@ -701 +709 @@
             subscription = 'remove'
         else:
-            subscription = self.__subscriptionStates[self.subscriptionTo,
-                                                     self.subscriptionFrom]
-
-            if self.pendingOut:
-                element['ask'] = u'subscribe'
-
             if self.name:
                 element['name'] = self.name
-
-            if self.approved:
-                element['approved'] = u'true'
 
             if self.groups:
                 for group in self.groups:
                     element.addElement('group', content=group)
+
+            if rosterSet:
+                subscription = None
+            else:
+                subscription = self.__subscriptionStates[self.subscriptionTo,
+                                                         self.subscriptionFrom]
+
+                if self.pendingOut:
+                    element['ask'] = u'subscribe'
+
+                if self.approved:
+                    element['approved'] = u'true'
 
         if subscription:
@@ -755 +766 @@
         versioning.
     @type version: C{unicode}
+
+    @ivar rosterSet: If set, this is a roster set request. This flag is used
+        to make sure some attributes of the roster item are not rendered by
+        L{toElement}.
+    @type roster: C{boolean}
     """
     item = None
     version = None
+    rosterSet = False
 
     def parseRequest(self, element):
@@ -773 +790 @@
             query['ver'] = self.version
         if self.item:
-            query.addChild(self.item.toElement())
+            query.addChild(self.item.toElement(rosterSet=self.rosterSet))
         return element
 
@@ -893 +910 @@
 
 
+    def setItem(self, item):
+        """
+        Add or modify a roster item.
+
+        Note that RFC 6121 doesn't allow all properties of a roster item to
+        be sent when setting a roster item. Only the C{name} and C{groups}
+        attributes from C{item} are sent to the server. Presence subscription
+        management must be done through L{PresenceProtocol}.
+
+        @param item: The roster item to be set.
+        @type item: L{RosterItem}.
+
+        @rtype: L{twisted.internet.defer.Deferred}
+        """
+        request = RosterRequest(stanzaType='set')
+        request.rosterSet = True
+        request.item = item
+        return self.request(request)
+
+
     def removeItem(self, entity):
         """
@@ -899 +936 @@
         @param entity: The contact to remove the roster item for.
         @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
+
         @rtype: L{twisted.internet.defer.Deferred}
         """
-        request = RosterRequest(stanzaType='set')
-        request.item = RosterItem(entity)
-        request.item.remove = True
-        return self.request(request)
+        item = RosterItem(entity)
+        item.remove = True
+        return self.setItem(item)