Changeset 117:2503218c0e95 for wokkel

Timestamp:

Oct 17, 2008, 10:47:01 PM (14 years ago)

Author:

Christopher Zorn <tofu@…>

Branch:

wokkel-muc-client-support-24

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/branches/wokkel-muc-client-support-24@111

Message:

we now have basic support with nick change, also added some doc strings, still need more re #24

Location:

wokkel

Files:

• muc.py (modified) (5 diffs)
• test/test_muc.py (modified) (19 diffs)

wokkel/muc.py

@@ -280 +280 @@
         self.status = 0
 
-        self.entity_id = jid.internJID(name+'@'+server+'/'+nick)
+        self.entity_id = self.entityId()
                
         self.roster = {}
 
-        
+    def entityId(self):
+        """
+        """
+        self.entity_id = jid.internJID(self.name+'@'+self.server+'/'+self.nick)
+
+        return self.entity_id 
 
     def addUser(self, user):
@@ -608 +613 @@
     def configure(self, room_jid, fields=[]):
         """Configure a room
+
+        @param room_jid: The room jabber/xmpp entity id for the requested configuration form.
+        @type  room_jid: L{jid.JID}
+
         """
         request = ConfigureRequest(self.xmlstream, method='set', fields=fields)
@@ -615 +624 @@
 
     def getConfigureForm(self, room_jid):
+        """Grab the configuration form from the room. This sends an iq request to the room.
+
+        @param room_jid: The room jabber/xmpp entity id for the requested configuration form.
+        @type  room_jid: L{jid.JID}
+
+        """
         request = ConfigureRequest(self.xmlstream)
         request['to'] = room_jid
@@ -621 +636 @@
 
     def join(self, server, room, nick):
-        """
+        """ Join a MUC room by sending presence to it. Returns a defered that is called when
+        the entity is in the room or an error has occurred. 
+        
+        @param server: The server where the room is located.
+        @type  server: L{unicode}
+
+        @param room: The room name the entity is joining.
+        @type  room: L{unicode}
+
+        @param nick: The nick name for the entitity joining the room.
+        @type  nick: L{unicode}
+        
         """
         d = defer.Deferred()
@@ -637 +663 @@
         return d
     
+    def _changedNick(self, d, room_jid, prs):
+        """Callback for changing the nick.
+        """
+
+        r = self._getRoom(room_jid)
+
+        d.callback(r)
+
+
+    def nick(self, room_jid, new_nick):
+        """ Change an entities nick name in a MUC room. 
+        
+        See: http://xmpp.org/extensions/xep-0045.html#changenick
+
+        @param room_jid: The room jabber/xmpp entity id for the requested configuration form.
+        @type  room_jid: L{jid.JID}
+
+        @param new_nick: The nick name for the entitity joining the room.
+        @type  new_nick: L{unicode}
+        
+        """
+
+        d = defer.Deferred()
+        r = self._getRoom(room_jid)
+        if r is None:
+            raise Exception, 'Room not found'
+        r.nick = new_nick # change the nick
+        # create presence 
+        # make sure we call the method to generate the new entity xmpp id
+        p = BasicPresence(to=r.entityId()) 
+        self.xmlstream.send(p)
+
+        # add observer for joining the room
+        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s']" % (r.entity_id.full()), 
+                                          self._changedNick, 1, d, room_jid)
+
+        return d
+        
 
     

wokkel/test/test_muc.py

@@ -58 +58 @@
 
     def _createRoom(self):
+        """A helper method to create a test room.
+        """
         # create a room
         self.current_room = muc.Room(self.test_room, self.test_srv, self.test_nick)
@@ -71 +73 @@
 
     def test_userJoinedRoom(self):
-        """Test receiving a user joined event.
+        """The client receives presence from an entity joining the room.
         """
         p = muc.UserPresence()
@@ -91 +93 @@
 
     def test_groupChat(self):
-        """Test receiving room presence
+        """The client receives a groupchat message from an entity in the room.
         """
         m = muc.GroupChat('test@test.com',body='test')
@@ -109 +111 @@
 
     def test_discoServerSupport(self):
-        """Test for disco support from a server.
+        """Disco support from client to server.
         """
         test_srv = 'shakespeare.lit'
@@ -138 +140 @@
         
     def test_joinRoom(self):
-        """Test joining a room
-        """
-        
-
+        """Joining a room
+        """
+        
         def cb(room):
             self.assertEquals(self.test_room, room.name)
@@ -159 +160 @@
 
     def test_joinRoomForbidden(self):
-        """Test joining a room and getting an error
+        """Client joining a room and getting a forbidden error.
         """
 
@@ -183 +184 @@
 
     def test_partRoom(self):
-        
+        """Client leaves a room
+        """
         def cb(left):
             self.failUnless(left, 'did not leave room')
@@ -204 +206 @@
 
     def test_ban(self):
-        
+        """Ban an entity in a room.
+        """
         banned = JID('ban@jabber.org/TroubleMakger')
         def cb(banned):
@@ -225 +228 @@
 
     def test_kick(self):
-
+        """Kick an entity from a room.
+        """
         kicked = JID('kick@jabber.org/TroubleMakger')
         def cb(kicked):
@@ -247 +251 @@
 
     def test_password(self):
-        """Test sending a password via presence to a password protected room.
+        """Sending a password via presence to a password protected room.
         """
         
@@ -258 +262 @@
 
     def test_history(self):
-        """Test receiving history on room join.
+        """Receiving history on room join.
         """
         m = muc.HistoryMessage(self.room_jid.userhost(), self.protocol._makeTimeStamp(), body='test')
@@ -276 +280 @@
 
     def test_oneToOneChat(self):
-        """Test converting a one to one chat
+        """Converting a one to one chat to a multi-user chat.
         """
         archive = []
@@ -308 +312 @@
 
     def test_invite(self):
+        """Invite a user to a room
+        """
         other_jid = 'test@jabber.org'
 
@@ -319 +325 @@
         
     def test_privateMessage(self):
-        """Test sending private messages to muc entities.
+        """Send private messages to muc entities.
         """
         other_nick = self.room_jid.userhost()+'/OtherNick'
@@ -331 +337 @@
 
     def test_register(self):
-        """Test client registering with a room. http://xmpp.org/extensions/xep-0045.html#register
+        """Client registering with a room. http://xmpp.org/extensions/xep-0045.html#register
 
         """
@@ -343 +349 @@
 
         iq = self.stub.output[-1]
-        print iq.toXml()
         self.failUnless(xpath.matches("/iq/query[@xmlns='%s']" % (muc.NS_REQUEST), iq), 'Invalid iq register request')
         
@@ -352 +357 @@
 
     def test_voice(self):
-        """
+        """ Client requesting voice for a room.
         """
         self.protocol.voice(self.room_jid.userhost())
@@ -362 +367 @@
 
     def test_roomConfigure(self):
-        """
+        """ Default configure and changing the room name.
         """
 
@@ -386 +391 @@
 
 
+    def test_nickChange(self):
+        """Send a nick change to the server.
+        """
+        test_nick = 'newNick'
+        
+        self._createRoom()
+
+        def cb(room):
+            self.assertEquals(self.test_room, room.name)
+            self.assertEquals(test_nick, room.nick)
+
+        d = self.protocol.nick(self.room_jid, test_nick)
+        d.addCallback(cb)
+
+        prs = self.stub.output[-1]
+        self.failUnless(prs.name=='presence', "Need to be presence")
+        self.failUnless(getattr(prs, 'x', None), 'No muc x element')
+
+        # send back user presence, they joined        
+        response = muc.UserPresence(frm=self.test_room+'@'+self.test_srv+'/'+test_nick)
+        
+        self.stub.send(response)
+        return d
+
+