Changeset 132:1b19c49d30c2

Timestamp:

Aug 21, 2009, 2:46:18 PM (12 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

More renames.

Location:

wokkel

Files:

• muc.py (modified) (53 diffs)
• test/test_muc.py (modified) (7 diffs)

wokkel/muc.py

@@ -352 +352 @@
 
         @param to: The xmpp entity you are sending this chat to.
-        @type to: L{unicode} or L{jid.JID}
+        @type to: C{unicode} or L{jid.JID}
 
         @param body: The message you are sending.
-        @type body: L{unicode}
+        @type body: C{unicode}
 
         @param frm: The entity that is sending the message.
-        @param frm: L{unicode}
+        @param frm: C{unicode}
         """
         domish.Element.__init__(self, (None, 'message'))
@@ -374 +374 @@
 
 class InviteMessage(domish.Element):
-    def __init__(self, bareRoomJID, invitee, reason=None):
+    def __init__(self, roomJID, invitee, reason=None):
         domish.Element.__init__(self, (None, 'message'))
-        self['to'] = unicode(bareRoomJID)
+        self['to'] = unicode(roomJID)
         x = self.addElement('x', NS_MUC_USER)
         invite = x.addElement('invite')
@@ -468 +468 @@
 
         @ivar roomIdentifier: The Room ID of the MUC room.
-        @type roomIdentifier: L{unicode}
+        @type roomIdentifier: C{unicode}
 
         @ivar service: The server where the MUC room is located.
-        @type service: L{unicode}
+        @type service: C{unicode}
 
         @ivar nick: The nick name for the client in this room.
-        @type nick: L{unicode}
+        @type nick: C{unicode}
 
         @ivar state: The status code of the room.
         @type state: L{int}
 
-        @ivar roomJID: The JID of the occupant in the room. Generated from roomIdentifier, service, and nick.
-        @type roomJID: L{jid.JID}
+        @ivar occupantJID: The JID of the occupant in the room. Generated from roomIdentifier, service, and nick.
+        @type occupantJID: L{jid.JID}
         """
         self.state = state
@@ -488 +488 @@
         self.status = 0
 
-        self.roomJID = self.refreshRoomJID()
+        self.occupantJID = self.refreshOccupantJID()
 
         self.roster = {}
 
 
-    def refreshRoomJID(self):
+    def refreshOccupantJID(self):
         """
         Refreshes the Room JID.
@@ -500 +500 @@
         change.
         """
-        self.roomJID = jid.internJID(u"%s@%s/%s" % (self.roomIdentifier,
+        self.occupantJID = jid.internJID(u"%s@%s/%s" % (self.roomIdentifier,
                                                     self.service,
                                                     self.nick))
-        return self.roomJID
+        return self.occupantJID
 
 
@@ -532 +532 @@
 
         @param nick: The nick for the user in the MUC room.
-        @type nick: L{unicode}
+        @type nick: C{unicode}
         """
         return self.roster.get(nick.lower())
@@ -689 +689 @@
         @note: An entity can only join a particular room once.
         """
-        bareRoomJID = room.roomJID.userhostJID()
-        self._rooms[bareRoomJID] = room
-
-
-    def _getRoom(self, roomJID):
+        roomJID = room.occupantJID.userhostJID()
+        self._rooms[roomJID] = room
+
+
+    def _getRoom(self, occupantJID):
         """
         Grab a room from the room collection.
@@ -700 +700 @@
         the L{Room} instance associated with it.
         """
-        bareRoomJID = roomJID.userhostJID()
-        return self._rooms.get(bareRoomJID)
-
-
-    def _removeRoom(self, roomJID):
+        roomJID = occupantJID.userhostJID()
+        return self._rooms.get(roomJID)
+
+
+    def _removeRoom(self, occupantJID):
         """
         Delete a room from the room collection.
         """
-        bareRoomJID = roomJID.userhostJID()
-        if bareRoomJID in self._rooms:
-            del self._rooms[bareRoomJID]
+        roomJID = occupantJID.userhostJID()
+        if roomJID in self._rooms:
+            del self._rooms[roomJID]
 
 
@@ -722 +722 @@
         if not prs.hasAttribute('from'):
             return
-        roomJID = jid.internJID(prs.getAttribute('from', ''))
-        self._userLeavesRoom(roomJID)
+        occupantJID = jid.internJID(prs.getAttribute('from', ''))
+        self._userLeavesRoom(occupantJID)
 
 
@@ -733 +733 @@
         if not prs.hasAttribute('from'):
             return
-        roomJID = jid.internJID(prs.getAttribute('from', ''))
+        occupantJID = jid.internJID(prs.getAttribute('from', ''))
         # add an error hook here?
-        self._userLeavesRoom(roomJID)
+        self._userLeavesRoom(occupantJID)
 
 
@@ -750 +750 @@
 
 
-    def _userLeavesRoom(self, roomJID):
+    def _userLeavesRoom(self, occupantJID):
         # when a user leaves a room we need to update it
-        room = self._getRoom(roomJID)
+        room = self._getRoom(occupantJID)
         if room is None:
             # not in the room yet
             return
         # check if user is in roster
-        user = room.getUser(roomJID.resource)
+        user = room.getUser(occupantJID.resource)
         if user is None:
             return
@@ -771 +771 @@
         if not prs.hasAttribute('from'):
             return
-        roomJID = jid.internJID(prs.getAttribute('from', ''))
+        occupantJID = jid.internJID(prs.getAttribute('from', ''))
 
         status = getattr(prs, 'status', None)
@@ -777 +777 @@
 
         # grab room
-        room = self._getRoom(roomJID)
+        room = self._getRoom(occupantJID)
         if room is None:
             # not in the room yet
             return
-        user = self._changeUserStatus(room, roomJID, status, show)
+        user = self._changeUserStatus(room, occupantJID, status, show)
 
         if room.inRoster(user):
@@ -804 +804 @@
             # need to return an error here
             return
-        roomJID = jid.internJID(msg.getAttribute('from', ''))
-
-        room = self._getRoom(roomJID)
+        occupantJID = jid.internJID(msg.getAttribute('from', ''))
+
+        room = self._getRoom(occupantJID)
         if room is None:
             # not in the room yet
             return
-        user = room.getUser(roomJID.resource)
+        user = room.getUser(occupantJID.resource)
         delay = None
         # need to check for delay and x stanzas for delay namespace for backwards compatability
@@ -830 +830 @@
         if not msg.hasAttribute('from'):
             return
-        roomJID = jid.internJID(msg['from'])
+        occupantJID = jid.internJID(msg['from'])
 
         # grab room
-        room = self._getRoom(roomJID)
+        room = self._getRoom(occupantJID)
         if room is None:
             # not in the room yet
             return
 
-        self.receivedSubject(roomJID, unicode(msg.subject))
+        self.receivedSubject(occupantJID, unicode(msg.subject))
 
 
@@ -853 +853 @@
         We have presence that says we joined a room.
         """
-        roomJID = jid.internJID(prs['from'])
+        occupantJID = jid.internJID(prs['from'])
 
         # check for errors
@@ -860 +860 @@
         else:
             # change the state of the room
-            room = self._getRoom(roomJID)
+            room = self._getRoom(occupantJID)
             if room is None:
                 raise NotFound
@@ -877 +877 @@
         We have presence that says we left a room.
         """
-        roomJID = jid.internJID(prs['from'])
+        occupantJID = jid.internJID(prs['from'])
 
         # check for errors
@@ -884 +884 @@
         else:
             # change the state of the room
-            room = self._getRoom(roomJID)
+            room = self._getRoom(occupantJID)
             if room is None:
                 raise NotFound
-            self._removeRoom(roomJID)
+            self._removeRoom(occupantJID)
 
             d.callback(True)
@@ -968 +968 @@
 
         @param obj: The object to send over the wire.
-        @type obj: L{domish.Element} or L{unicode}
+        @type obj: L{domish.Element} or C{unicode}
 
         @param timeout: The number of seconds to wait before the deferred is timed out.
@@ -1001 +1001 @@
 
 
-    def configure(self, bareRoomJID, fields=[]):
+    def configure(self, roomJID, fields=[]):
         """
         Configure a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param fields: The fields we want to modify.
@@ -1012 +1012 @@
         """
         request = ConfigureRequest(self.xmlstream, method='set', fields=fields)
-        request['to'] = bareRoomJID
+        request['to'] = roomJID
 
         return request.send()
 
 
-    def getConfigureForm(self, bareRoomJID):
+    def getConfigureForm(self, roomJID):
         """
         Grab the configuration form from the room. This sends an iq request to the room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
         """
         request = ConfigureRequest(self.xmlstream)
-        request['to'] = bareRoomJID
+        request['to'] = roomJID
         return request.send()
 
@@ -1034 +1034 @@
 
         @param server: The server where the room is located.
-        @type server: L{unicode}
+        @type server: C{unicode}
 
         @param room: The room name the entity is joining.
-        @type room: L{unicode}
+        @type room: C{unicode}
 
         @param nick: The nick name for the entitity joining the room.
-        @type nick: L{unicode}
+        @type nick: C{unicode}
 
         @param history: The maximum number of history stanzas you would like.
@@ -1050 +1050 @@
         self._addRoom(room)
 
-        p = BasicPresence(to=room.roomJID)
+        p = BasicPresence(to=room.occupantJID)
         if history is not None:
             p.x.addChild(history.toElement())
@@ -1057 +1057 @@
 
         # add observer for joining the room
-        query = PRESENCE + u"[@from='%s']" % room.roomJID
+        query = PRESENCE + u"[@from='%s']" % room.occupantJID
         self.xmlstream.addOnetimeObserver(query, self._joinedRoom, 1, d)
 
@@ -1063 +1063 @@
 
 
-    def _changeUserStatus(self, room, roomJID, status, show):
+    def _changeUserStatus(self, room, occupantJID, status, show):
         """
         Change the user status in a room.
@@ -1069 +1069 @@
 
         # check if user is in roster
-        user = room.getUser(roomJID.resource)
+        user = room.getUser(occupantJID.resource)
         if user is None: # create a user that does not exist
-            user = User(roomJID.resource)
+            user = User(occupantJID.resource)
 
         if status is not None:
@@ -1081 +1081 @@
 
 
-    def _changed(self, d, roomJID, prs):
+    def _changed(self, d, occupantJID, prs):
         """
         Callback for changing the nick and status.
@@ -1089 +1089 @@
         show = getattr(prs, 'show', None)
 
-        room = self._getRoom(roomJID)
-
-        user = self._changeUserStatus(room, roomJID, status, show)
+        room = self._getRoom(occupantJID)
+
+        user = self._changeUserStatus(room, occupantJID, status, show)
 
         d.callback(room)
 
 
-    def nick(self, bareRoomJID, new_nick):
+    def nick(self, roomJID, new_nick):
         """
         Change an entities nick name in a MUC room.
@@ -1102 +1102 @@
         See: http://xmpp.org/extensions/xep-0045.html#changenick
 
-        @param bareRoomJID: The JID of the room, i.e. without a resource.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The JID of the room, i.e. without a resource.
+        @type roomJID: L{jid.JID}
 
         @param new_nick: The nick name for the entitity joining the room.
-        @type new_nick: L{unicode}
-        """
-
-
-        room = self._getRoom(bareRoomJID)
-        if room is None:
-            raise NotFound
-
-        # Change the nickname
-        room.nick = new_nick
-        room.refreshRoomJID()
-
-        # Create presence
-        p = BasicPresence(to=room.roomJID)
-        d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
-
-        # Add observer for joining the room
-        query = PRESENCE+"[@from='%s']" % (room.roomJID.full())
-        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, bareRoomJID)
-
-        return d
-
-
-    def leave(self, roomJID):
-        """
-        Leave a MUC room.
-
-        See: http://xmpp.org/extensions/xep-0045.html#exit
-
-        @param roomJID: The Room JID of the room to leave.
-        @type roomJID: L{jid.JID}
-        """
-        room = self._getRoom(roomJID)
-
-        p = xmppim.UnavailablePresence(to=room.roomJID)
-
-        d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
-        # add observer for joining the room
-        query = PRESENCE + u"[@from='%s' and @type='unavailable']" % (room.roomJID)
-        self.xmlstream.addOnetimeObserver(query, self._leftRoom, 1, d)
-
-        return d
-
-
-    def status(self, roomJID, show=None, status=None):
-        """
-        Change user status.
-
-        See: http://xmpp.org/extensions/xep-0045.html#changepres
-
-        @param roomJID: The room jabber/xmpp entity id for the requested configuration form.
-        @type roomJID: L{jid.JID}
-
-        @param show: The availability of the entity. Common values are xa, available, etc
-        @type show: L{unicode}
-
-        @param show: The current status of the entity.
-        @type show: L{unicode}
-        """
+        @type new_nick: C{unicode}
+        """
+
+
         room = self._getRoom(roomJID)
         if room is None:
             raise NotFound
 
-        p = BasicPresence(to=room.roomJID)
+        # Change the nickname
+        room.nick = new_nick
+        room.refreshOccupantJID()
+
+        # Create presence
+        p = BasicPresence(to=room.occupantJID)
+        d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
+
+        # Add observer for joining the room
+        query = PRESENCE+"[@from='%s']" % (room.occupantJID.full())
+        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, roomJID)
+
+        return d
+
+
+    def leave(self, occupantJID):
+        """
+        Leave a MUC room.
+
+        See: http://xmpp.org/extensions/xep-0045.html#exit
+
+        @param occupantJID: The Room JID of the room to leave.
+        @type occupantJID: L{jid.JID}
+        """
+        room = self._getRoom(occupantJID)
+
+        p = xmppim.UnavailablePresence(to=room.occupantJID)
+
+        d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
+        # add observer for joining the room
+        query = PRESENCE + u"[@from='%s' and @type='unavailable']" % (room.occupantJID)
+        self.xmlstream.addOnetimeObserver(query, self._leftRoom, 1, d)
+
+        return d
+
+
+    def status(self, occupantJID, show=None, status=None):
+        """
+        Change user status.
+
+        See: http://xmpp.org/extensions/xep-0045.html#changepres
+
+        @param occupantJID: The room jabber/xmpp entity id for the requested configuration form.
+        @type occupantJID: L{jid.JID}
+
+        @param show: The availability of the entity. Common values are xa, available, etc
+        @type show: C{unicode}
+
+        @param show: The current status of the entity.
+        @type show: C{unicode}
+        """
+        room = self._getRoom(occupantJID)
+        if room is None:
+            raise NotFound
+
+        p = BasicPresence(to=room.occupantJID)
         if status is not None:
             p.addElement('status', None, status)
@@ -1179 +1179 @@
 
         # add observer for joining the room
-        query = PRESENCE + u"[@from='%s']" % room.roomJID
-        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, roomJID)
+        query = PRESENCE + u"[@from='%s']" % room.occupantJID
+        self.xmlstream.addOnetimeObserver(query, self._changed, 1, d, occupantJID)
 
         return d
@@ -1205 +1205 @@
 
 
-    def chat(self, roomJID, message, children=None):
+    def chat(self, occupantJID, message, children=None):
         """
         Send a private chat message to a user in a MUC room.
@@ -1211 +1211 @@
         See: http://xmpp.org/extensions/xep-0045.html#privatemessage
 
-        @param roomJID: The Room JID of the other user.
-        @type roomJID: L{jid.JID}
-        """
-
-        msg = PrivateChat(roomJID, body=message)
+        @param occupantJID: The Room JID of the other user.
+        @type occupantJID: L{jid.JID}
+        """
+
+        msg = PrivateChat(occupantJID, body=message)
 
         self._sendMessage(msg, children=children)
 
 
-    def invite(self, bareRoomJID, reason=None, invitee=None):
+    def invite(self, roomJID, reason=None, invitee=None):
         """
         Invite a xmpp entity to a MUC room.
@@ -1226 +1226 @@
         See: http://xmpp.org/extensions/xep-0045.html#invite
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param reason: The reason for the invite.
-        @type reason: L{unicode}
+        @type reason: C{unicode}
 
         @param invitee: The entity that is being invited.
         @type invitee: L{jid.JID}
         """
-        msg = InviteMessage(bareRoomJID, reason=reason, invitee=invitee)
+        msg = InviteMessage(roomJID, reason=reason, invitee=invitee)
         self._sendMessage(msg)
 
 
-    def password(self, bareRoomJID, password):
+    def password(self, roomJID, password):
         """
         Send a password to a room so the entity can join.
@@ -1245 +1245 @@
         See: http://xmpp.org/extensions/xep-0045.html#enter-pw
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param password: The MUC room password.
-        @type password: L{unicode}
-        """
-        p = PasswordPresence(bareRoomJID, password)
+        @type password: C{unicode}
+        """
+        p = PasswordPresence(roomJID, password)
 
         self.xmlstream.send(p)
 
 
-    def register(self, bareRoomJID, fields=[]):
+    def register(self, roomJID, fields=[]):
         """
         Send a request to register for a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param fields: The fields you need to register.
@@ -1267 +1267 @@
         """
         iq = RegisterRequest(self.xmlstream, method='set', fields=fields)
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         return iq.send()
 
 
-    def _getAffiliationList(self, bareRoomJID, affiliation):
+    def _getAffiliationList(self, roomJID, affiliation):
         """
         Send a request for an affiliation list in a room.
@@ -1279 +1279 @@
                                 affiliation=affiliation,
                                 )
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         return iq.send()
 
 
-    def _getRoleList(self, bareRoomJID, role):
+    def _getRoleList(self, roomJID, role):
         """
         Send a role request.
@@ -1291 +1291 @@
                          role=role,
                          )
-        iq['to'] = bareRoomJID.full()
+        iq['to'] = roomJID.full()
         return iq.send()
 
 
-    def _setAffiliationList(self, iq, affiliation, roomJID):
+    def _setAffiliationList(self, iq, affiliation, occupantJID):
         # set a rooms affiliation list
-        room = self._getRoom(roomJID)
+        room = self._getRoom(occupantJID)
         if room is not None:
             affiliation_list = []
@@ -1323 +1323 @@
 
 
-    def getMemberList(self, bareRoomJID):
+    def getMemberList(self, roomJID):
         """
         Get the member list of a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
-        """
-        d = self._getAffiliationList(bareRoomJID, 'member')
-        d.addCallback(self._setAffiliationList, 'members', bareRoomJID)
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+        """
+        d = self._getAffiliationList(roomJID, 'member')
+        d.addCallback(self._setAffiliationList, 'members', roomJID)
         return d
 
 
-    def getAdminList(self, bareRoomJID):
+    def getAdminList(self, roomJID):
         """
         Get the admin list of a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
-        """
-        d = self._getAffiliationList(bareRoomJID, 'admin')
-        d.addCallback(self._setAffiliationList, 'admin', bareRoomJID)
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+        """
+        d = self._getAffiliationList(roomJID, 'admin')
+        d.addCallback(self._setAffiliationList, 'admin', roomJID)
         return d
 
 
-    def getBanList(self, bareRoomJID):
+    def getBanList(self, roomJID):
         """
         Get an outcast list from a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
-        """
-        d = self._getAffiliationList(bareRoomJID, 'outcast')
-        d.addCallback(self._setAffiliationList, 'outcast', bareRoomJID)
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+        """
+        d = self._getAffiliationList(roomJID, 'outcast')
+        d.addCallback(self._setAffiliationList, 'outcast', roomJID)
         return d
 
 
-    def getOwnerList(self, bareRoomJID):
+    def getOwnerList(self, roomJID):
         """
         Get an owner list from a room.
 
-        @param bareRoomJID: The room jabber/xmpp entity id for the requested member list.
-        @type bareRoomJID: L{jid.JID}
-        """
-        d = self._getAffiliationList(bareRoomJID, 'owner')
-        d.addCallback(self._setAffiliationList, 'owner', bareRoomJID)
+        @param roomJID: The room jabber/xmpp entity id for the requested member list.
+        @type roomJID: L{jid.JID}
+        """
+        d = self._getAffiliationList(roomJID, 'owner')
+        d.addCallback(self._setAffiliationList, 'owner', roomJID)
         return d
 
@@ -1383 +1383 @@
 
 
-    def destroy(self, bareRoomJID, reason=None, alternate=None):
+    def destroy(self, roomJID, reason=None, alternate=None):
         """
         Destroy a room.
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param reason: The reason we are destroying the room.
-        @type reason: L{unicode}
+        @type reason: C{unicode}
 
         @param alternate: The bare JID of the room suggested as an alternate
@@ -1399 +1399 @@
         """
         def destroyed(iq):
-            self._removeRoom(bareRoomJID)
+            self._removeRoom(roomJID)
             return True
 
         iq = OwnerRequest(self.xmlstream, method='set')
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         d = iq.query.addElement('destroy')
 
@@ -1414 +1414 @@
 
 
-    def subject(self, bareRoomJID, subject):
+    def subject(self, roomJID, subject):
         """
         Change the subject of a MUC room.
@@ -1420 +1420 @@
         See: http://xmpp.org/extensions/xep-0045.html#subject-mod
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
 
         @param subject: The subject you want to set.
-        @type subject: L{unicode}
-        """
-        msg = GroupChat(bareRoomJID.userhostJID(), subject=subject)
+        @type subject: C{unicode}
+        """
+        msg = GroupChat(roomJID.userhostJID(), subject=subject)
         self.xmlstream.send(msg)
 
 
-    def voice(self, bareRoomJID):
+    def voice(self, roomJID):
         """
         Request voice for a moderated room.
 
-        @param bareRoomJID: The room jabber/xmpp entity id.
-        @type bareRoomJID: L{jid.JID}
-        """
-        msg = MessageVoice(to=bareRoomJID.userhostJID())
+        @param roomJID: The room jabber/xmpp entity id.
+        @type roomJID: L{jid.JID}
+        """
+        msg = MessageVoice(to=roomJID.userhostJID())
         self.xmlstream.send(msg)
 
 
-    def history(self, bareRoomJID, messages):
+    def history(self, roomJID, messages):
         """
         Send history to create a MUC based on a one on one chat.
@@ -1447 +1447 @@
         See: http://xmpp.org/extensions/xep-0045.html#continue
 
-        @param bareRoomJID: The room jabber/xmpp entity id.
-        @type bareRoomJID: L{jid.JID}
+        @param roomJID: The room jabber/xmpp entity id.
+        @type roomJID: L{jid.JID}
 
         @param messages: The history to send to the room as an ordered list of
@@ -1469 +1469 @@
                 delay['from'] = sender
 
-            stanza['to'] = bareRoomJID.userhost()
+            stanza['to'] = roomJID.userhost()
             if stanza.hasAttribute('from'):
                 del stanza['from']
@@ -1476 +1476 @@
 
 
-    def _setAffiliation(self, bareRoomJID, entityOrNick, affiliation,
+    def _setAffiliation(self, roomJID, entityOrNick, affiliation,
                               reason=None, sender=None):
         """
@@ -1486 +1486 @@
                                 affiliation=affiliation,
                                 reason=reason)
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         if sender is not None:
             iq['from'] = unicode(sender)
@@ -1493 +1493 @@
 
 
-    def _setRole(self, bareRoomJID, entityOrNick, role,
+    def _setRole(self, roomJID, entityOrNick, role,
                        reason=None, sender=None):
         # send a role request
@@ -1502 +1502 @@
                          reason=reason)
 
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         if sender is not None:
             iq['from'] = unicode(sender)
@@ -1508 +1508 @@
 
 
-    def modifyAffiliationList(self, frm, bareRoomJID, jid_list, affiliation):
+    def modifyAffiliationList(self, frm, roomJID, jid_list, affiliation):
         """
         Modify an affiliation list.
@@ -1515 +1515 @@
         @type frm: L{jid.JID}
 
-        @param bareRoomJID: The bare JID of the room.
-        @type bareRoomJID: L{jid.JID}
-
-        @param entities: The list of entities to change in a room. This can be a nick or a full jid.
-        @type jid_list: L{list} of L{unicode} for nicks. L{list} of L{jid.JID} for jids.
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param entities: The list of entities to change in a room. This can be
+            a nick or a full jid.
+        @type jid_list: L{list} of C{unicode} for nicks. L{list} of L{jid.JID}
+            for jids.
 
         @param affiliation: The affilation to change.
-        @type affiliation: L{unicode}
+        @type affiliation: C{unicode}
 
         """
@@ -1530 +1532 @@
                                 )
         iq.items(jid_list)
-        iq['to'] = bareRoomJID.userhost()
+        iq['to'] = roomJID.userhost()
         iq['from'] = frm.full()
         return iq.send()
 
 
-    def grantVoice(self, bareRoomJID, nick, reason=None, sender=None):
+    def grantVoice(self, roomJID, nick, reason=None, sender=None):
         """
         Grant voice to an entity.
 
-        @param frm: The entity sending the request.
-        @type frm: L{jid.JID}
-
-        @param room_jid: The room jabber/xmpp entity id.
-        @type room_jid: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param nick: The nick name for the user in this room.
+        @type nick: C{unicode}
 
         @param reason: The reason for granting voice to the entity.
-        @type reason: L{unicode}
-
-        @param nick: The nick name for the client in this room.
-        @type nick: L{unicode}
-        """
-        return self._setRole(bareRoomJID, entityOrNick=nick,
+        @type reason: C{unicode}
+
+        @param sender: The entity sending the request.
+        @type sender: L{jid.JID}
+        """
+        return self._setRole(roomJID, entityOrNick=nick,
                              role='participant',
                              reason=reason, sender=sender)
 
 
-    def revokeVoice(self, bareRoomJID, nick, reason=None, sender=None):
+    def revokeVoice(self, roomJID, nick, reason=None, sender=None):
         """
         Revoke voice from a participant.
@@ -1562 +1564 @@
         This will disallow the entity to send messages to a moderated room.
 
-        @param frm: The entity sending the request.
-        @type frm: L{jid.JID}
-
-        @param room_jid: The room jabber/xmpp entity id.
-        @type room_jid: L{jid.JID}
-
-        @param reason: The reason for granting voice to the entity.
-        @type reason: L{unicode}
-
-        @param nick: The nick name for the client in this room.
-        @type nick: L{unicode}
-        """
-        return self._setRole(bareRoomJID, entityOrNick=nick, role='visitor',
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param nick: The nick name for the user in this room.
+        @type nick: C{unicode}
+
+        @param reason: The reason for revoking voice from the entity.
+        @type reason: C{unicode}
+
+        @param sender: The entity sending the request.
+        @type sender: L{jid.JID}
+        """
+        return self._setRole(roomJID, entityOrNick=nick, role='visitor',
                              reason=reason, sender=sender)
 
 
-    def grantModerator(self, frm, room_jid, reason=None, nick=None):
+    def grantModerator(self, roomJID, nick, reason=None, sender=None):
         """
         Grant moderator priviledges to a MUC room.
 
-        @param frm: The entity sending the request.
-        @type frm: L{jid.JID}
-
-        @param room_jid: The room jabber/xmpp entity id.
-        @type room_jid: L{jid.JID}
-        """
-        return self._setRole(frm, room_jid, role='moderator', reason=reason, nick=nick)
-
-
-    def ban(self, bareRoomJID, entity, reason=None, sender=None):
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param nick: The nick name for the user in this room.
+        @type nick: C{unicode}
+
+        @param reason: The reason for granting moderation to the entity.
+        @type reason: C{unicode}
+
+        @param sender: The entity sending the request.
+        @type sender: L{jid.JID}
+        """
+        return self._setRole(roomJID, entityOrNick=nick, role='moderator',
+                             reason=reason, sender=sender)
+
+
+    def ban(self, roomJID, entity, reason=None, sender=None):
         """
         Ban a user from a MUC room.
 
-        @param room_jid: The room jabber/xmpp entity id.
-        @type room_jid: L{jid.JID}
-
-        @param ban_jid: The room jabber/xmpp entity id.
-        @type ban_jid: L{jid.JID}
-
-        @param frm: The entity sending the request.
-        @type frm: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param entity: The room jabber/xmpp entity id.
+        @type entity: L{jid.JID}
 
         @param reason: The reason for banning the entity.
-        @type reason: L{unicode}
-
-        @param nick: The nick name for the client in this room.
-        @type nick: L{unicode}
-        """
-        return self._setAffiliation(bareRoomJID, entity, 'outcast',
+        @type reason: C{unicode}
+
+        @param sender: The entity sending the request.
+        @type sender: L{jid.JID}
+        """
+        return self._setAffiliation(roomJID, entity, 'outcast',
                                     reason=reason, sender=sender)
 
 
-    def kick(self, bareRoomJID, entityOrNick, reason=None, sender=None):
+    def kick(self, roomJID, entityOrNick, reason=None, sender=None):
         """
         Kick a user from a MUC room.
 
-        @param room_jid: The room jabber/xmpp entity id.
-        @type room_jid: L{jid.JID}
-
-        @param kick_jid: The room jabber/xmpp entity id.
-        @type kick_jid: L{jid.JID}
-
-        @param frm: The entity sending the request.
-        @type frm: L{jid.JID}
+        @param roomJID: The bare JID of the room.
+        @type roomJID: L{jid.JID}
+
+        @param entityOrNick: The occupant to be banned.
+        @type entityOrNick: L{jid.JID} or C{unicode}
 
         @param reason: The reason given for the kick.
-        @type reason: L{unicode}
-
-        @param nick: The nick for the user in the MUC room.
-        @type nick: L{unicode}
-        """
-        return self._setAffiliation(bareRoomJID, entityOrNick, 'none', reason=reason, sender=sender)
+        @type reason: C{unicode}
+
+        @param sender: The entity sending the request.
+        @type sender: L{jid.JID}
+        """
+        return self._setAffiliation(roomJID, entityOrNick, 'none',
+                                    reason=reason, sender=sender)

wokkel/test/test_muc.py

@@ -88 +88 @@
 
         def userPresence(room, user):
-            self.failUnless(room.roomIdentifier==self.test_room, 'Wrong room name')
-            self.failUnless(room.inRoster(user), 'User not in roster')
+            self.assertEqual(self.test_room, room.roomIdentifier,
+                             'Wrong room name')
+            self.assertTrue(room.inRoster(user), 'User not in roster')
 
 
@@ -122 +123 @@
 
         def cb(room):
-            self.assertEquals(self.test_room, room.roomIdentifier)
+            self.assertEqual(self.test_room, room.roomIdentifier)
 
         d = self.protocol.join(self.test_srv, self.test_room, self.test_nick)
@@ -468 +469 @@
 
         def cb(room):
-            self.assertEquals(self.test_room, room.roomIdentifier)
-            self.assertEquals(test_nick, room.nick)
+            self.assertEqual(self.test_room, room.roomIdentifier)
+            self.assertEqual(test_nick, room.nick)
 
         d = self.protocol.nick(self.room_jid, test_nick)
@@ -519 +520 @@
 
         def cb(room):
-            self.assertEquals(self.test_room, room.roomIdentifier)
+            self.assertEqual(self.test_room, room.roomIdentifier)
             user = room.getUser(self.room_jid.resource)
-            self.failUnless(user is not None, 'User not found')
-            self.failUnless(user.status == 'testing MUC', 'Wrong status')
-            self.failUnless(user.show == 'xa', 'Wrong show')
+            self.assertNotIdentical(None, user, 'User not found')
+            self.assertEqual('testing MUC', user.status, 'Wrong status')
+            self.assertEqual('xa', user.show, 'Wrong show')
 
         d = self.protocol.status(self.room_jid, 'xa', 'testing MUC')
@@ -530 +531 @@
         prs = self.stub.output[-1]
 
-        self.failUnless(prs.name=='presence', "Need to be presence")
-        self.failUnless(getattr(prs, 'x', None), 'No muc x element')
+        self.assertEqual('presence', prs.name, "Need to be presence")
+        self.assertTrue(getattr(prs, 'x', None), 'No muc x element')
 
         # send back user presence, they joined
@@ -546 +547 @@
             self.assertEqual(1, len(members))
             user = members[0]
-            self.assertEquals(JID(u'hag66@shakespeare.lit'), user.entity)
-            self.assertEquals(u'thirdwitch', user.nick)
-            self.assertEquals(u'participant', user.role)
+            self.assertEqual(JID(u'hag66@shakespeare.lit'), user.entity)
+            self.assertEqual(u'thirdwitch', user.nick)
+            self.assertEqual(u'participant', user.role)
 
         self._createRoom()
@@ -558 +559 @@
         query = iq.query
         self.assertNotIdentical(None, query)
-        self.assertEquals(NS_MUC_ADMIN, query.uri)
+        self.assertEqual(NS_MUC_ADMIN, query.uri)
 
         response = toResponse(iq, 'result')