Changeset 10:a5e3c32d23ca for wokkel

Timestamp:

Jan 3, 2008, 10:58:54 AM (15 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@34

Message:

Add unsubscribe method to PubSubClient?.

Author: ralphm
Fixes #4.

Location:

wokkel

Files:

• iwokkel.py (modified) (2 diffs)
• pubsub.py (modified) (10 diffs)
• test/helpers.py (added)
• test/test_pubsub.py (modified) (6 diffs)

wokkel/iwokkel.py

@@ -1 @@
-# Copyright (c) 2003-2007 Ralph Meijer
+# Copyright (c) 2003-2008 Ralph Meijer
 # See LICENSE for details.
 
@@ -191 +191 @@
         """
 
+    def unsubscribe(service, nodeIdentifier, subscriber):
+        """
+        Unsubscribe from a node with a given JID.
+
+        @param service: The publish-subscribe service entity.
+        @type service: L{jid.JID}
+        @param nodeIdentifier: Identifier of the node to unsubscribe from.
+        @type nodeIdentifier: L{unicode}
+        @param subscriber: JID to unsubscribe from the node.
+        @type subscriber: L{jid.JID}
+        @rtype: L{defer.Deferred}
+        """
+
     def publish(service, nodeIdentifier, items=[]):
         """

wokkel/pubsub.py

@@ -1 +1 @@
 # -*- test-case-name: wokkel.test.test_pubsub -*-
 #
-# Copyright (c) 2003-2007 Ralph Meijer
+# Copyright (c) 2003-2008 Ralph Meijer
 # See LICENSE for details.
 
@@ -78 +78 @@
 
 
-
 class SubscriptionPending(Exception):
     """
@@ -146 +145 @@
                 self.addChild(payload)
 
+
 class PubSubRequest(xmlstream.IQ):
     """
@@ -168 +168 @@
 
     def send(self, to):
-        destination = unicode(to)
+        """
+        Send out request.
+
+        Extends L{xmlstream.IQ.send} by requiring the C{to} parameter to be
+        a L{JID} instance.
+
+        @param to: Entity to send the request to.
+        @type to: L{JID}
+        """
+        destination = to.full()
         return xmlstream.IQ.send(self, destination)
+
 
 class CreateNode(PubSubRequest):
@@ -178 +188 @@
         if node:
             self.command["node"] = node
+
 
 class DeleteNode(PubSubRequest):
@@ -185 +196 @@
         self.command["node"] = node
 
+
 class Subscribe(PubSubRequest):
     verb = 'subscribe'
@@ -193 +205 @@
         self.command["jid"] = subscriber.full()
 
+
+class Unsubscribe(PubSubRequest):
+    verb = 'unsubscribe'
+
+    def __init__(self, xs, node, subscriber):
+        PubSubRequest.__init__(self, xs)
+        self.command["node"] = node
+        self.command["jid"] = subscriber.full()
+
+
 class Publish(PubSubRequest):
     verb = 'publish'
@@ -208 +230 @@
 
         return item
+
 
 class PubSubClient(XMPPHandler):
@@ -270 +293 @@
         return request.send(service).addCallback(cb)
 
+    def unsubscribe(self, service, nodeIdentifier, subscriber):
+        request = Unsubscribe(self.xmlstream, nodeIdentifier, subscriber)
+        return request.send(service)
+
     def publish(self, service, nodeIdentifier, items=[]):
         request = Publish(self.xmlstream, nodeIdentifier)
@@ -276 +303 @@
 
         return request.send(service)
+
 
 class PubSubService(XMPPHandler, IQHandlerMixin):

wokkel/test/test_pubsub.py

@@ -1 @@
-# Copyright (c) 2003-2007 Ralph Meijer
+# Copyright (c) 2003-2008 Ralph Meijer
 # See LICENSE for details.
 
@@ -12 +12 @@
 
 from wokkel import pubsub
+from wokkel.test.helpers import XmlStreamStub
+
+try:
+    from twisted.words.protocols.jabber.xmlstream import toResponse
+except ImportError:
+    from wokkel.compat import toResponse
+
+NS_PUBSUB = 'http://jabber.org/protocol/pubsub'
+NS_PUBSUB_ERRORS = 'http://jabber.org/protocol/pubsub#errors'
+
+class PubSubClientTest(unittest.TestCase):
+
+    def setUp(self):
+        self.stub = XmlStreamStub()
+        self.protocol = pubsub.PubSubClient()
+        self.protocol.xmlstream = self.stub.xmlstream
+
+    def test_unsubscribe(self):
+        """
+        Test sending unsubscription request.
+        """
+        d = self.protocol.unsubscribe(JID('pubsub.example.org'), 'test',
+                                      JID('user@example.org'))
+
+        iq = self.stub.output[-1]
+        self.assertEquals('pubsub.example.org', iq.getAttribute('to'))
+        self.assertEquals('set', iq.getAttribute('type'))
+        self.assertEquals('pubsub', iq.pubsub.name)
+        self.assertEquals(NS_PUBSUB, iq.pubsub.uri)
+        children = list(domish.generateElementsQNamed(iq.pubsub.children,
+                                                      'unsubscribe', NS_PUBSUB))
+        self.assertEquals(1, len(children))
+        child = children[0]
+        self.assertEquals('test', child['node'])
+        self.assertEquals('user@example.org', child['jid'])
+
+        self.stub.send(toResponse(iq, 'result'))
+        return d
+
 
 class PubSubServiceTest(unittest.TestCase):
@@ -28 +67 @@
         iq['to'] = 'pubsub.example.org'
         iq['type'] = 'set'
-        iq.addElement(('http://jabber.org/protocol/pubsub', 'pubsub'))
+        iq.addElement((NS_PUBSUB, 'pubsub'))
         iq.pubsub.addElement('publish')
         handler.handleRequest(iq)
@@ -47 +86 @@
         iq['from'] = 'user@example.org'
         iq['to'] = 'pubsub.example.org'
-        iq.addElement(('http://jabber.org/protocol/pubsub', 'pubsub'))
+        iq.addElement((NS_PUBSUB, 'pubsub'))
         iq.pubsub.addElement('publish')
         iq.pubsub.publish['node'] = 'test'
@@ -62 +101 @@
         iq['to'] = 'pubsub.example.org'
         iq['type'] = 'get'
-        iq.addElement(('http://jabber.org/protocol/pubsub', 'pubsub'))
+        iq.addElement((NS_PUBSUB, 'pubsub'))
         iq.pubsub.addElement('options')
         handler.handleRequest(iq)
@@ -69 +108 @@
         self.assertEquals('feature-not-implemented', e.condition)
         self.assertEquals('unsupported', e.appCondition.name)
-        self.assertEquals('http://jabber.org/protocol/pubsub#errors',
-                          e.appCondition.uri)
+        self.assertEquals(NS_PUBSUB_ERRORS, e.appCondition.uri)