xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/pubsub/iq/pubsub.rb

@@ -14,6 +14,6 @@ module Jabber
     class IqPubSubOwner < XMPPElement
       name_xmlns 'pubsub', NS_PUBSUB + '#owner'
       force_xmlns true
-    end 
+    end
   end
 end

data/lib/xmpp4r/rexmladdons.rb

@@ -10,32 +10,19 @@ require 'rexml/source'
 oldverbose = $VERBOSE
 $VERBOSE = false
 
-# REXML module. This file only adds the following methods to the REXML module, to
-# ease the coding:
-# * replace_element_text
-# * first_element
-# * first_element_text
-# * typed_add
-# * import
-# * self.import
-# * delete_elements
+# REXML : Adds custom helper methods to the REXML module.
 #
-# Further definitions are just copied from REXML out of Ruby-1.8.4 to solve issues
-# with REXML in Ruby-1.8.2.
-#
-# The redefinitions of Text::normalize and Attribute#initialize address an issue
-# where entities in element texts and attributes were not escaped. This modifies
-# the behavious of REXML a bit but Sean Russell intends a similar behaviour for
-# the future of REXML.
 module REXML
+
   # this class adds a few helper methods to REXML::Element
   class Element
+
     ##
-    # Replaces or add a child element of name <tt>e</tt> with text <tt>t</tt>.
+    # Replaces or adds a child element of name <tt>e</tt> with text <tt>t</tt>.
     def replace_element_text(e, t)
       el = first_element(e)
       if el.nil?
-        el = REXML::Element::new(e)
+        el = REXML::Element.new(e)
         add_element(el)
       end
       if t
@@ -82,7 +69,9 @@ module REXML
       xmlelement.each do |e|
         if e.kind_of? REXML::Element
           typed_add(e.deep_clone)
-        else # text element, probably.
+        elsif e.kind_of? REXML::Text
+          add_text(e.value)
+        else
           add(e.clone)
         end
       end
@@ -99,14 +88,52 @@ module REXML
     def delete_elements(element)
       while(delete_element(element)) do end
     end
-  end
-end
 
-# very dirty fix for the :progress problem in REXML from Ruby 1.8.3
-# http://www.germane-software.com/projects/rexml/ticket/34
-# the fix proposed in REXML changeset 1145 only fixes this for pipes, not for
-# TCP sockets, so we have to keep this.
-module REXML
+    ##
+    # Test for equality of two elements, useful for assert_equal in
+    # test cases. Tries to parse String o as XML.
+    #
+    # See Test::Unit::Assertions
+    def ==(o)
+      return false unless self.kind_of? REXML::Element
+      if o.kind_of? REXML::Element
+        # Ok
+      elsif o.kind_of? String
+        # Parse o
+        begin
+          o = REXML::Document.new(o).root
+        rescue REXML::ParseException
+          return false
+        end
+      else
+        # Cannot compare with anything other than Elements or Strings
+        return false
+      end
+
+      return false unless name == o.name
+
+      attributes.each_attribute do |attr|
+        return false unless attr.value == o.attributes[attr.name]
+      end
+
+      o.attributes.each_attribute do |attr|
+        return false unless attributes[attr.name] == attr.value
+      end
+
+      children.each_with_index do |child,i|
+        return false unless child == o.children[i]
+      end
+
+      return true
+    end
+
+  end # class Element
+
+  # FIXME : Is this still needed now that we're a bit past Ruby 1.8.3??
+  # Very dirty fix for the :progress problem in REXML from Ruby 1.8.3
+  # http://www.germane-software.com/projects/rexml/ticket/34
+  # the fix proposed in REXML changeset 1145 only fixes this for pipes, not for
+  # TCP sockets, so we have to keep this.
   class IOSource
     def position
       0
@@ -115,8 +142,9 @@ module REXML
     def current_line
       [0, 0, ""]
     end
-  end
-end
+  end # class IOSource
+
+end # module REXML
 
 # Restore the old $VERBOSE setting
 $VERBOSE = oldverbose

data/lib/xmpp4r/roster.rb

@@ -5,4 +5,3 @@
 require 'xmpp4r/roster/iq/roster.rb'
 require 'xmpp4r/roster/helper/roster.rb'
 require 'xmpp4r/roster/x/roster.rb'
-

data/lib/xmpp4r/roster/helper/roster.rb

@@ -31,12 +31,16 @@ module Jabber
       # (Remember to send initial presence afterwards!)
       #
       # The initialization will not wait for the roster being received,
-      # use add_query_callback to get notifyed when Roster::Helper#items
-      # has been filled.
+      # use wait_for_roster.
+      #
+      # <b>Attention:</b> If you send presence and receive presences
+      # before the roster has arrived, the Roster helper will let them
+      # pass through and does *not* keep them!
       def initialize(stream)
         @stream = stream
         @items = {}
         @items_lock = Mutex.new
+        @roster_wait = Semaphore.new
         @query_cbs = CallbackList.new
         @update_cbs = CallbackList.new
         @presence_cbs = CallbackList.new
@@ -68,6 +72,13 @@ module Jabber
         stream.send(rosterget)
       end
 
+      ##
+      # Wait for first roster query result to arrive
+      def wait_for_roster
+        @roster_wait.wait
+        @roster_wait.run
+      end
+
       ##
       # Add a callback to be called when a query has been processed
       #
@@ -167,10 +178,11 @@ module Jabber
           }
           @update_cbs.process(olditem, newitem)
         end
-          
+
+        @roster_wait.run
         @query_cbs.process(iq)
       end
-      
+
       ##
       # Handle received <tt><presence/></tt> stanzas,
       # used internally
@@ -245,7 +257,7 @@ module Jabber
 
       ##
       # Returns the list of RosterItems which, stripped, are equal to the
-      # one you are looking for. 
+      # one you are looking for.
       def find(jid)
         jid = JID.new(jid) unless jid.kind_of? JID
 
@@ -297,7 +309,7 @@ module Jabber
       # Add a user to your roster
       #
       # Threading is encouraged as the function waits for
-      # a result. ErrorException is thrown upon error.
+      # a result. ServerError is thrown upon error.
       #
       # See Jabber::Roster::Helper::RosterItem#subscribe for details
       # about subscribing. (This method isn't used here but the
@@ -314,7 +326,7 @@ module Jabber
         else
           request = Iq.new_rosterset
           request.query.add(Jabber::Roster::RosterItem.new(jid, iname))
-          @stream.send_with_id(request) { true }
+          @stream.send_with_id(request)
           # Adding to list is handled by handle_iq_query_roster
         end
 
@@ -339,7 +351,7 @@ module Jabber
         unless self[jid.strip]
           request = Iq.new_rosterset
           request.query.add(Jabber::Roster::RosterItem.new(jid.strip, iname))
-          @stream.send_with_id(request) { true }
+          @stream.send_with_id(request)
         end
       end
 
@@ -376,7 +388,7 @@ module Jabber
           request.query.add(self)
           @stream.send(request)
         end
-        
+
         ##
         # Remove item
         #
@@ -384,11 +396,11 @@ module Jabber
         # and from you *to* the contact.
         #
         # The methods waits for a roster push from the server (success)
-        # or throws ErrorException upon failure.
+        # or throws ServerError upon failure.
         def remove
           request = Iq.new_rosterset
           request.query.add(Jabber::Roster::RosterItem.new(jid, nil, :remove))
-          @stream.send_with_id(request) { true }
+          @stream.send_with_id(request)
           # Removing from list is handled by Roster#handle_iq_query_roster
         end
 
@@ -404,7 +416,7 @@ module Jabber
             }.size > 0
           }
         end
-        
+
         ##
         # Iterate through all received <tt><presence/></tt> stanzas
         def each_presence(&block)
@@ -413,7 +425,7 @@ module Jabber
             yield(pres)
           }
         end
-        
+
         ##
         # Get specific presence
         # jid:: [JID] Full JID
@@ -475,7 +487,7 @@ module Jabber
         # Unsubscribe from a contact's presence
         #
         # This method waits for a presence with type='unsubscribed'
-        # from the contact. It may throw ErrorException upon failure.
+        # from the contact. It may throw ServerError upon failure.
         #
         # subscription attribute of the item is *from* or *none*
         # afterwards. As long as you don't remove that item and
@@ -505,4 +517,3 @@ module Jabber
     end #Class Roster
   end #Module Roster
 end #Module Jabber
-

data/lib/xmpp4r/roster/iq/roster.rb

@@ -20,7 +20,7 @@ module Jabber
     # This <query/> contains multiple <item/> children. See RosterItem.
     class IqQueryRoster < IqQuery
       name_xmlns 'query', 'jabber:iq:roster'
-      
+
       ##
       # Iterate through all items
       # &block:: Yield for every [RosterItem]
@@ -30,7 +30,7 @@ module Jabber
           yield(item) if item.kind_of?(RosterItem)
         }
       end
-      
+
       ##
       # Get roster item by JID
       # jid:: [JID] or [Nil]
@@ -41,7 +41,7 @@ module Jabber
         }
         nil
       end
-      
+
       ##
       # Get all items
       # result:: [Array] of [RosterItem]
@@ -52,7 +52,7 @@ module Jabber
         }
         a
       end
-      
+
       ##
       # Update roster by <iq/> stanza
       # (to be fed by an iq_callback)
@@ -62,10 +62,10 @@ module Jabber
         if filter && (((iq.type != :set) && (iq.type != :result)) || (iq.queryns != 'jabber:iq:roster'))
           return
         end
-        
+
         import(iq.query)
       end
-      
+
       ##
       # Output for "p"
       #
@@ -76,7 +76,7 @@ module Jabber
         jids.join(', ')
       end
     end
-    
+
     ##
     # Class containing the <item/> elements of the roster
     #
@@ -99,7 +99,7 @@ module Jabber
         self.subscription = subscription
         self.ask = ask
       end
-    
+
       ##
       # Get name of roster item
       #
@@ -108,29 +108,29 @@ module Jabber
       def iname
         attributes['name']
       end
-      
+
       ##
       # Set name of roster item
       # val:: [String] Name for this item
       def iname=(val)
         attributes['name'] = val
       end
-      
+
       ##
       # Get JID of roster item
       # Resource of the JID will _not_ be stripped
       # return:: [JID]
       def jid
-        (a = attributes['jid']) ? JID::new(a) : nil
+        (a = attributes['jid']) ? JID.new(a) : nil
       end
-      
+
       ##
       # Set JID of roster item
       # val:: [JID] or nil
       def jid=(val)
         attributes['jid'] = val.nil? ? nil : val.to_s
       end
-      
+
       ##
       # Get subscription type of roster item
       # result:: [Symbol] or [Nil] The following values are valid according to RFC3921:
@@ -149,7 +149,7 @@ module Jabber
           else nil
         end
       end
-      
+
       ##
       # Set subscription type of roster item
       # val:: [Symbol] or [Nil] See subscription for possible Symbols
@@ -163,7 +163,7 @@ module Jabber
           else attributes['subscription'] = nil
         end
       end
-      
+
       ##
       # Get if asking for subscription
       # result:: [Symbol] nil or :subscribe
@@ -173,7 +173,7 @@ module Jabber
           else nil
         end
       end
-      
+
       ##
       # Set if asking for subscription
       # val:: [Symbol] nil or :subscribe
@@ -183,7 +183,7 @@ module Jabber
           else attributes['ask'] = nil
         end
       end
-      
+
       ##
       # Get groups the item belongs to
       # result:: [Array] of [String] The groups
@@ -194,7 +194,7 @@ module Jabber
         }
         result.uniq
       end
-      
+
       ##
       # Set groups the item belongs to,
       # deletes old groups first.
@@ -204,7 +204,7 @@ module Jabber
       def groups=(ary)
         # Delete old group elements
         delete_elements('group')
-        
+
         # Add new group elements
         ary.uniq.each { |group|
           add_element('group').text = group

data/lib/xmpp4r/roster/x/roster.rb

@@ -23,7 +23,7 @@ module Jabber
     class RosterX < XRoster
       name_xmlns 'x', 'http://jabber.org/protocol/rosterx'
     end
-    
+
     ##
     # Class containing an <item/> element
     #
@@ -46,7 +46,7 @@ module Jabber
         self.jid = jid
         self.iname = iname
       end
-      
+
       ##
       # Get name of roster item
       #
@@ -55,29 +55,29 @@ module Jabber
       def iname
         attributes['name']
       end
-      
+
       ##
       # Set name of roster item
       # val:: [String] Name for this item
       def iname=(val)
         attributes['name'] = val
       end
-      
+
       ##
       # Get JID of roster item
       # Resource of the JID will _not_ be stripped
       # return:: [JID]
       def jid
-        JID::new(attributes['jid'])
+        JID.new(attributes['jid'])
       end
-      
+
       ##
       # Set JID of roster item
       # val:: [JID] or nil
       def jid=(val)
         attributes['jid'] = val.nil? ? nil : val.to_s
       end
-      
+
       ##
       # Get action for this roster item
       # * :add
@@ -91,7 +91,7 @@ module Jabber
           else :add
         end
       end
-      
+
       ##
       # Set action for this roster item
       # (see action)
@@ -113,7 +113,7 @@ module Jabber
         }
         result
       end
-      
+
       ##
       # Set groups the item belongs to,
       # deletes old groups first.
@@ -123,7 +123,7 @@ module Jabber
       def groups=(ary)
         # Delete old group elements
         delete_elements('group')
-        
+
         # Add new group elements
         ary.uniq.each { |group|
           add_element('group').text = group