Changeset 50:b69ca8f7174e in ralphm-patches for roster_item.patch

Timestamp:

Jun 1, 2011, 9:29:29 AM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Cleanup JIDs a bit more and adjust affected patches.

File:

• roster_item.patch (modified) (15 diffs)

roster_item.patch

@@ -1 @@
-diff -r c91f18811c37 wokkel/im.py
---- a/wokkel/im.py      Mon May 23 18:19:44 2011 +0200
-+++ b/wokkel/im.py      Wed May 25 09:24:29 2011 +0200
-@@ -7,21 +7,27 @@
+diff -r c103529d9f46 wokkel/im.py
+--- a/wokkel/im.py      Wed May 25 20:24:36 2011 +0200
++++ b/wokkel/im.py      Wed May 25 20:26:47 2011 +0200
+@@ -7,21 +7,25 @@
  XMPP IM protocol support.
  
@@ -12 +12 @@
  """
  
-+import warnings
-+
 +from twisted.internet import defer
- from twisted.words.protocols.jabber.jid import JID, internJID
+ from twisted.words.protocols.jabber import jid
 +from twisted.words.protocols.jabber import error
  from twisted.words.xish import domish
@@ -34 +32 @@
      """
      Stanza of kind presence.
-@@ -349,8 +355,8 @@
+@@ -349,8 +353,8 @@
  
      This represents one contact from an XMPP contact list known as roster.
  
 -    @ivar jid: The JID of the contact.
--    @type jid: L{JID}
+-    @type jid: L{jid.JID}
 +    @ivar entity: The JID of the contact.
-+    @type entity: L{JID}
++    @type entity: L{jid.JID}
      @ivar name: The optional associated nickname for this contact.
      @type name: C{unicode}
      @ivar subscriptionTo: Subscription state to contact's presence. If C{True},
-@@ -360,47 +366,126 @@
+@@ -360,47 +364,99 @@
      @ivar subscriptionFrom: Contact's subscription state. If C{True}, the
                              contact is subscribed to the presence information
@@ -87 +85 @@
 -class RosterClientProtocol(XMPPHandler):
 +
-+    def __getJID(self):
-+        warnings.warn("Use RosterItem.entity instead.", DeprecationWarning)
-+        return self.entity
-+
-+
-+    def __setJID(self, value):
-+        warnings.warn("Use RosterItem.entity instead.", DeprecationWarning)
-+        self.entity = value
-+
-+
-+    jid = property(__getJID, __setJID, doc="""
-+            JID of the contact. Deprecated in favour of C{entity}.""")
-+
-+
-+    def __getAsk(self):
-+        warnings.warn("Use RosterItem.pendingOut instead.", DeprecationWarning)
-+        return self.pendingOut
-+
-+
-+    def __setAsk(self, value):
-+        warnings.warn("Use RosterItem.pendingOut instead.", DeprecationWarning)
-+        self.pendingOut = value
-+
-+
-+    ask = property(__getAsk, __setAsk, doc="""
-+            Pending out subscription. Deprecated in favour of C{pendingOut}.""")
-+
-+
 +    def toElement(self):
 +        element = domish.Element((NS_ROSTER, 'item'))
@@ -146 +116 @@
 +    @classmethod
 +    def fromElement(Class, element):
-+        entity = internJID(element['jid'])
++        entity = jid.internJID(element['jid'])
 +        item = Class(entity)
 +        subscription = element.getAttribute('subscription')
@@ -178 +148 @@
 +    iqHandlers = {XPATH_ROSTER_SET: "_onRosterSet"}
 +
++
      def connectionInitialized(self):
 -        ROSTER_SET = "/iq[@type='set']/query[@xmlns='%s']" % NS_ROSTER
@@ -184 +155 @@
 -
 -    def _parseRosterItem(self, element):
--        jid = internJID(element['jid'])
--        item = RosterItem(jid)
+-        entity = jid.internJID(element['jid'])
+-        item = RosterItem(entity)
 -        item.name = element.getAttribute('name')
 -        subscription = element.getAttribute('subscription')
@@ -200 +171 @@
  
      def getRoster(self):
-@@ -415,8 +500,8 @@
+@@ -415,8 +471,8 @@
              roster = {}
              for element in domish.generateElementsQNamed(result.query.children,
@@ -211 +182 @@
              return roster
  
-@@ -437,32 +522,37 @@
+@@ -437,32 +493,36 @@
          """
          iq = IQ(self.xmlstream, 'set')
@@ -228 +199 @@
 -           iq.hasAttribute('from') and iq['from'] != self.xmlstream:
 -            return
--
--        iq.handled = True
 +        def eb(failure):
 +            failure.trap(RosterPushIgnored)
 +            raise error.StanzaError('service-unavailable')
  
-         itemElement = iq.query.item
+-        iq.handled = True
 +        item = RosterItem.fromElement(iq.query.item)
  
--        if unicode(itemElement['subscription']) == 'remove':
--            self.onRosterRemove(internJID(itemElement['jid']))
+-        itemElement = iq.query.item
 +        if item.remove:
 +            d = defer.maybeDeferred(self.onRosterRemove, item.entity)
-         else:
++        else:
++            d = defer.maybeDeferred(self.onRosterSet, item)
+ 
+-        if unicode(itemElement['subscription']) == 'remove':
+-            self.onRosterRemove(jid.internJID(itemElement['jid']))
+-        else:
 -            item = self._parseRosterItem(iq.query.item)
 -            self.onRosterSet(item)
-+            d = defer.maybeDeferred(self.onRosterSet, item)
-+
 +        d.addErrback(eb)
 +        return d
@@ -261 +232 @@
          @type item: L{RosterItem}
          """
-@@ -472,6 +562,10 @@
+@@ -472,6 +532,10 @@
          """
          Called when a roster push for the removal of an item was received.
@@ -270 +241 @@
 +
          @param entity: The entity for which the roster item has been removed.
-         @type entity: L{JID}
+         @type entity: L{jid.JID}
          """
-diff -r c91f18811c37 wokkel/test/test_im.py
---- a/wokkel/test/test_im.py    Mon May 23 18:19:44 2011 +0200
-+++ b/wokkel/test/test_im.py    Wed May 25 09:24:29 2011 +0200
+diff -r c103529d9f46 wokkel/test/test_im.py
+--- a/wokkel/test/test_im.py    Wed May 25 20:24:36 2011 +0200
++++ b/wokkel/test/test_im.py    Wed May 25 20:26:47 2011 +0200
 @@ -7,13 +7,14 @@
  
@@ -291 +262 @@
  NS_XML = 'http://www.w3.org/XML/1998/namespace'
  NS_ROSTER = 'jabber:iq:roster'
-@@ -389,23 +390,356 @@
+@@ -389,23 +390,305 @@
  
  
@@ -300 +271 @@
 +    Tests for L{im.RosterItem}.
 +    """
-+
-+    def test_jidDeprecationGet(self):
-+        """
-+        Getting the jid attribute works as entity and warns deprecation.
-+        """
-+        item = im.RosterItem(JID('user@example.org'))
-+        entity = self.assertWarns(DeprecationWarning,
-+                                  "Use RosterItem.entity instead.",
-+                                  im.__file__,
-+                                  getattr, item, 'jid')
-+        self.assertIdentical(entity, item.entity)
-+
-+
-+    def test_jidDeprecationSet(self):
-+        """
-+        Setting the jid attribute works as entity and warns deprecation.
-+        """
-+        item = im.RosterItem(JID('user@example.org'))
-+        entity = self.assertWarns(DeprecationWarning,
-+                                  "Use RosterItem.entity instead.",
-+                                  im.__file__,
-+                                  setattr, item, 'jid',
-+                                  JID('other@example.org'))
-+        self.assertEquals(JID('other@example.org'), item.entity)
-+
-+
-+    def test_askDeprecationGet(self):
-+        """
-+        Getting the ask attribute works as entity and warns deprecation.
-+        """
-+        item = im.RosterItem(JID('user@example.org'))
-+        item.pendingOut = True
-+        ask = self.assertWarns(DeprecationWarning,
-+                               "Use RosterItem.pendingOut instead.",
-+                               im.__file__,
-+                               getattr, item, 'ask')
-+        self.assertTrue(ask)
-+
-+
-+    def test_askDeprecationSet(self):
-+        """
-+        Setting the ask attribute works as entity and warns deprecation.
-+        """
-+        item = im.RosterItem(JID('user@example.org'))
-+        entity = self.assertWarns(DeprecationWarning,
-+                                  "Use RosterItem.pendingOut instead.",
-+                                  im.__file__,
-+                                  setattr, item, 'ask',
-+                                  True)
-+        self.assertTrue(item.pendingOut)
-+
 +
 +    def test_toElement(self):
@@ -653 +573 @@
          # Inspect outgoing iq request
  
-@@ -419,10 +753,117 @@
+@@ -419,10 +702,117 @@
          self.assertEquals(1, len(children))
          child = children[0]