Changeset 112:be0b126081f2

Timestamp:

Oct 6, 2008, 10:56:52 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@76

Message:

all tests pass, needs comments, also need to get the entire xep in the tests

Location:

wokkel

Files:

• muc.py (modified) (11 diffs)
• test/test_muc.py (modified) (4 diffs)

wokkel/muc.py

@@ -121 +121 @@
     Configure MUC room request.
 
-    @ivar namespace: Request namespace.
-    @type namespace: C{str}
     @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
     @type method: C{str}
@@ -144 +142 @@
     Register room request.
 
-    @ivar namespace: Request namespace.
-    @type namespace: C{str}
     @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
     @type method: C{str}
+
     """
 
@@ -162 +159 @@
                 # create a field
                 form.addField(f)
+
+
+class AffiliationRequest(xmlstream.IQ):
+    """
+    Register room request.
+
+    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
+    @type method: C{str}
+
+    @ivar affiliation: The affiliation type to send to room.
+    @type affiliation: C{str}
+
+    """
+
+    def __init__(self, xs, method='get', affiliation='none', a_jid=None, reason=None):
+        xmlstream.IQ.__init__(self, xs, method)
+        
+        q = self.addElement((NS_ADMIN, 'query'))
+        i = q.addElement('item')
+
+        i['affiliation'] = affiliation
+        if a_jid:
+            i['jid'] = a_jid.full()
+            
+        if reason:
+            i.addElement('reason', None, reason)
+
+            
+        
 
 class GroupChat(domish.Element):
@@ -178 +204 @@
         if subject:
             self.addElement('subject',None, subject)
-            
-
+
+
+class PrivateChat(domish.Element):
+    """
+    """
+    def __init__(self, to, body=None, frm=None):
+        """To needs to be a string
+        """
+        domish.Element.__init__(self, (None, 'message'))
+        self['type'] = 'chat'
+        self['to']   = to 
+        if frm:
+            self['from'] = frm
+        if body:
+            self.addElement('body',None, body)
+            
+class InviteMessage(PrivateChat):
+    def __init__(self, to, reason=None, full_jid=None, body=None, frm=None, password=None):
+        PrivateChat.__init__(self, to, body=body, frm=frm)
+        del self['type'] # remove type
+        x = self.addElement('x', NS_USER)
+        invite = x.addElement('invite')
+        if full_jid:
+            invite['to'] = full_jid
+        if reason:
+            invite.addElement('reason', None, reason)
+        if password:
+            invite.addElement('password', None, password)
+
+class HistoryMessage(GroupChat):
+    """
+    """
+    def __init__(self, to, stamp, body=None, subject=None, frm=None, h_frm=None):
+        GroupChat.__init__(self, to, body=body, subject=subject, frm=frm)
+        d = self.addElement('delay', NS_DELAY)
+        d['stamp'] = stamp
+        if h_frm:
+            d['from'] = h_frm
 
 class Room(object):
@@ -304 +366 @@
         """
         """
-        self.receivedGroupChat(msg)
-
+        delay = getattr(msg, 'delay', None)
+        if delay is None:
+            self.receivedGroupChat(msg)
+        else:
+            self.receivedHistory(msg)
 
 
@@ -372 +437 @@
         pass
 
+
+    def receivedHistory(self, msg):
+        """
+        """
+        pass
+
+
     def _cbDisco(self, iq):
         # grab query
@@ -425 +497 @@
         d = defer.Deferred()
 
-        self._getRoom(room_jid)
+        r = self._getRoom(room_jid)
  
         p = xmppim.UnavailablePresence(to=r.entity_id)
@@ -432 +504 @@
 
         # add observer for joining the room
-        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s' and type='unavailable']" % (r.entity_id.full()), 
+        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s' and @type='unavailable']" % (r.entity_id.full()), 
                                           self._leftRoom, 1, d)
 
@@ -440 +512 @@
     
 
-    def groupChat(self, to, message, children=None):
-        """Send a groupchat message
-        """
-        msg = GroupChat(to, body=message)
+    def _sendMessage(self, msg, children=None):
 
         if children:
@@ -451 +520 @@
         self.xmlstream.send(msg)
 
+    def groupChat(self, to, message, children=None):
+        """Send a groupchat message
+        """
+        msg = GroupChat(to, body=message)
+        
+        self._sendMessage(msg, children=children)
+
+    def chat(self, to, message, children=None):
+        msg = PrivateChat(to, body=message)
+
+        self._sendMessage(msg, children=children)
+        
+    def invite(self, to, reason=None, full_jid=None):
+        msg = InviteMessage(to, reason=reason, full_jid=full_jid)
+        self._sendMessage(msg)
+
+
+    def password(self, to, password):
+        p = PasswordPresence(to, password)
+
+        self.xmlstream.send(p)
     
     def register(self, to, fields=[]):
@@ -491 +581 @@
             self.xmlstream.send(m)
 
+    def ban(self, to, ban_jid, frm, reason=None):
+        
+        iq = AffiliationRequest(self.xmlstream,
+                                method='set',
+                                affiliation='outcast', 
+                                a_jid=ban_jid, 
+                                reason=reason)
+        iq['to'] = to.userhost() # this is a room jid, only send to room
+        iq['from'] = frm.full()
+        return iq.send()
+
+
+    def kick(self, to, kick_jid, frm, reason=None):
+        
+        iq = AffiliationRequest(self.xmlstream,
+                                method='set',
+                                a_jid=kick_jid, 
+                                reason=reason)
+        iq['to'] = to.userhost() # this is a room jid, only send to room
+        iq['from'] = frm.full()
+        return iq.send()

wokkel/test/test_muc.py

@@ -55 +55 @@
         self.room_jid = JID(self.test_room+'@'+self.test_srv+'/'+self.test_nick)
 
+        self.user_jid = JID('test@jabber.org/Testing')
+
     def test_interface(self):
         """
@@ -167 +169 @@
 
     def test_partRoom(self):
-        self.fail('Not Implemented')
+        
+        def cb(left):
+            self.failUnless(left, 'did not leave room')
+
+
+        d = self.protocol.leave(self.room_jid)
+        d.addCallback(cb)
+
+        prs = self.stub.output[-1]
+        
+        self.failUnless(prs['type']=='unavailable', 'Unavailable is not being sent')
+        
+        response = prs
+        response['from'] = response['to']
+        response['to'] = 'test@jabber.org'
+
+        self.stub.send(response)
+        return d
         
 
     def test_ban(self):
         
-        self.fail('Not Implemented')
+        banned = JID('ban@jabber.org/TroubleMakger')
+        def cb(banned):
+            self.failUnless(banned, 'Did not ban user')
+
+            
+        d = self.protocol.ban(self.room_jid, banned, self.user_jid, reason='Spam')
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        
+        self.failUnless(xpath.matches("/iq[@type='set' and @to='%s']/query/item[@affiliation='outcast']" % (self.room_jid.userhost(),), iq), 'Wrong ban stanza')
+
+        response = toResponse(iq, 'result')
+
+        self.stub.send(response)
+
+        return d
+
 
     def test_kick(self):
+
+        kicked = JID('kick@jabber.org/TroubleMakger')
+        def cb(kicked):
+            self.failUnless(kicked, 'Did not kick user')
+
+            
+        d = self.protocol.kick(self.room_jid, kicked, self.user_jid, reason='Spam')
+        d.addCallback(cb)
+
+        iq = self.stub.output[-1]
+        
+        self.failUnless(xpath.matches("/iq[@type='set' and @to='%s']/query/item[@affiliation='none']" % (self.room_jid.userhost(),), iq), 'Wrong kick stanza')
+
+        response = toResponse(iq, 'result')
+
+        self.stub.send(response)
+
+        return d
+
         self.fail('Not Implemented')
         
@@ -182 +237 @@
         """
         
-        
-        self.fail('Not Implemented')
+        self.protocol.password(self.room_jid, 'secret')
+        
+        prs = self.stub.output[-1]
+        
+        self.failUnless(xpath.matches("/presence[@to='%s']/x/password[text()='secret']" % (self.room_jid.full(),), prs), 'Wrong presence stanza')
+
 
     def test_history(self):
-        
-        self.fail('Not Implemented')
+        """Test receiving history on room join.
+        """
+        m = muc.HistoryMessage(self.room_jid.userhost(), self.protocol._makeTimeStamp(), body='test')
+        
+        def roomHistory(h):
+            self.failUnless(getattr(h,'delay',None), 'No delay element')
+                   
+
+        d, self.protocol.receivedHistory = calledAsync(roomHistory)
+        self.stub.send(m)
+        return d
 
 
@@ -223 +291 @@
 
     def test_invite(self):
-        self.fail('Not Implemented')
+        other_jid = 'test@jabber.org'
+
+        self.protocol.invite(other_jid, 'This is a test')
+
+        msg = self.stub.output[-1]
+
+        self.failUnless(xpath.matches("/message[@to='%s']/x/invite/reason" % (other_jid,), msg), 'Wrong message type')
+
 
         
     def test_privateMessage(self):
-        
-        self.fail('Not Implemented')
+        """Test sending private messages to muc entities.
+        """
+        other_nick = self.room_jid.userhost()+'/OtherNick'
+
+        self.protocol.chat(other_nick, 'This is a test')
+
+        msg = self.stub.output[-1]
+
+        self.failUnless(xpath.matches("/message[@type='chat' and @to='%s']/body" % (other_nick,), msg), 'Wrong message type')
+
 
     def test_register(self):