xmpp4r 0.4 → 0.5

data/CHANGELOG

@@ -1,3 +1,11 @@
+XMPP4R 0.5 (15/06/2009)
+=======================
+* Many bugs fixed and tests cleanups (better Ruby 1.9 support, in
+  particular)
+* Support for reliable connections (that auto-reconnect when being
+  disconnected, without losing messages)
+* Better notification of server disconnects
+
 XMPP4R 0.4 (05/08/2008)
 =======================
 * Initial support for Ruby 1.9 (see README_ruby19.txt)

data/README.rdoc

@@ -25,6 +25,8 @@ which can be enabled in your code with:
   Lucas Nussbaum <lucas@lucas-nussbaum.net>
   Stephan Maka <stephan@spaceboyz.net>
   Kirill A. Shutemov <k.shutemov@gmail.com>
+  Glenn Rempe <glenn@rempe.us>
+  Jacob Burkhart <jacob@brontes3d.com>
   Yuki Mitsui
   Peter Schrammel
   Olli
@@ -33,10 +35,11 @@ which can be enabled in your code with:
   Chris Zelenak
   Matthew Wood
   Sam Ruby
-  Glenn Rempe <glenn@rempe.us>
   Tim Carey-Smith
   Scott Lillibridge
   Joshua Sierles
+  Ripta Pasay <github@r8y.org>
+  Seth Fitzsimmons
 
 
 == Source Code

data/Rakefile

@@ -32,10 +32,10 @@ RDOC_OPTIONS  = [
                 ]
 
 # Extra files outside of the lib dir that should be included with the rdocs.
-RDOC_FILES    = %w( README.rdoc README_ruby19.txt CHANGELOG LICENSE COPYING )
+RDOC_FILES    = (%w( README.rdoc README_ruby19.txt CHANGELOG LICENSE COPYING )).sort
 
 # The full file list used for rdocs, tarballs, gems, and for generating the xmpp4r.gemspec.
-PKG_FILES     = %w( Rakefile setup.rb xmpp4r.gemspec ) + RDOC_FILES + Dir["{lib,test,data,tools}/**/*"]
+PKG_FILES     = (%w( Rakefile setup.rb xmpp4r.gemspec ) + RDOC_FILES + Dir["{lib,test,data,tools}/**/*"]).sort
 
 ##############################################################################
 # DEFAULT TASK
@@ -98,7 +98,7 @@ begin
     t.test_files = ['test/ts_xmpp4r.rb']
     t.output_dir = "coverage"
   end
-rescue Object
+rescue LoadError
 end
 
 # DOT GRAPH
@@ -133,16 +133,9 @@ end
 # What files/dirs should 'rake clean' remove?
 CLEAN.include ["*.gem", "pkg", "rdoc", "coverage", "tools/*.png"]
 
-# Flag for RubyGems installation used to add rake package tasks conditionally.
-# Full gem + tarball on systems with RubyGems.  More limited on systems without.
-@rubygems = nil
-
 begin
   require 'rake/gempackagetask'
 
-  # RubyGems is installed, known since require 'rake/gempackagetask' succeeded.
-  @rubygems = true
-
   spec = Gem::Specification.new do |s|
     s.name = PKG_NAME
     s.version = PKG_VERSION
@@ -166,6 +159,7 @@ begin
   Rake::GemPackageTask.new(spec) do |pkg|
     pkg.gem_spec = spec
     pkg.need_tar = true
+    pkg.need_zip = true
   end
 
   namespace :gem do
@@ -189,12 +183,11 @@ begin
     desc "Update Github Gemspec"
     task :update_gemspec do
       skip_fields = %w(new_platform original_platform date)
-      integer_fields = %w(specification_version)
 
       result = "# WARNING : RAKE AUTO-GENERATED FILE.  DO NOT MANUALLY EDIT!\n"
       result << "# RUN : 'rake gem:update_gemspec'\n\n"
       result << "Gem::Specification.new do |s|\n"
-      spec.instance_variables.each do |ivar|
+      spec.instance_variables.sort.each do |ivar|
         value = spec.instance_variable_get(ivar)
         name  = ivar.split("@").last
         next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
@@ -207,8 +200,7 @@ begin
           case value
           when Array
             value =  name != "files" ? value.inspect : value.sort.uniq.inspect.split(",").join(",\n")
-          when String
-            value = value.to_i if integer_fields.include?(name)
+          when String, Fixnum, true, false
             value = value.inspect
           else
             value = value.to_s.inspect
@@ -227,8 +219,7 @@ begin
   task :gem => ['gem:update_gemspec']
 
 rescue LoadError
-  @rubygems = false
-  warning = <<EOF
+  puts <<EOF
 ###
   Packaging Warning : RubyGems is apparently not installed on this
   system and any file add/remove/rename will not
@@ -239,24 +230,23 @@ rescue LoadError
   gemspec will also stay in sync for others.
 ###
 EOF
-  puts warning
 end
 
 # we are apparently on a system that does not have RubyGems installed.
 # Lets try to provide only the basic tarball package tasks as a fallback.
-if @rubygems == false
+unless defined? Gem
   begin
     require 'rake/packagetask'
     Rake::PackageTask.new(PKG_NAME, PKG_VERSION) do |p|
       p.package_files = PKG_FILES
       p.need_tar = true
+      p.need_zip = true
     end
   rescue LoadError
-    warning = <<EOF
+    puts <<EOF
 ###
   Warning : Unable to require the 'rake/packagetask'. Is Rake installed?
 ###
 EOF
-    puts warning
   end
 end

data/data/doc/xmpp4r/examples/advanced/versionpoll.rb

@@ -7,7 +7,8 @@ $:.unshift '../../../../../lib'
 
 require 'optparse'
 require 'xmpp4r/client'
-require 'xmpp4r/version/iq/version'
+require 'xmpp4r/version'
+require 'xmpp4r/discovery'
 include Jabber
 #Jabber::debug = true
 
@@ -15,6 +16,7 @@ include Jabber
 jid = JID.new('bot@localhost/Bot')
 password = 'bot'
 domains = []
+domains_ejabberd = []
 OptionParser.new do |opts|
   opts.banner = 'Usage: versionpoll.rb -j jid -p password -d DOMAINS'
   opts.separator ''
@@ -48,6 +50,18 @@ cl.add_iq_callback do |i|
         cl.send(Iq.new_browseget.set_to(j))
       end
     end
+  elsif i.type == :result and i.query.kind_of? Discovery::IqQueryDiscoItems
+    i.query.items.each do |e|
+      j = e.jid
+      if not queried.include?(j)
+        activity = true
+        queried << j
+        iq = Iq.new(:get)
+        iq.query = Version::IqQueryVersion.new
+        iq.set_to(j)
+        cl.send(iq)
+      end
+    end
   end
 end
 
@@ -80,6 +94,11 @@ cl.send(Presence.new)
 for d in domains do
   cl.send(Iq.new_browseget.set_to("#{d}/admin"))
 end
+for d in domains_ejabberd do
+  iq = Iq.new(:get, d)
+  iq.add(Discovery::IqQueryDiscoItems.new).node = 'online users'
+  cl.send(iq)
+end
 
 activity = true
 while activity

data/lib/xmpp4r/bytestreams/helper/ibb/target.rb

@@ -13,6 +13,11 @@ module Jabber
       def initialize(stream, session_id, initiator_jid, target_jid)
         # Target and Initiator are swapped here, because we're the target
         super(stream, session_id, target_jid, initiator_jid)
+        @accept_ready = Semaphore::new
+      end
+
+      def accept_wait
+        @accept_ready.wait
       end
 
       ##
@@ -39,6 +44,8 @@ module Jabber
           end
         }
 
+        @accept_ready.run
+
         connect_sem.wait
         true
       end

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb

@@ -11,8 +11,14 @@ module Jabber
       # See SOCKS5Bytestreams#initialize
       def initialize(stream, session_id, initiator_jid, target_jid)
         @connect_timeout = 60
+        @accept_ready = Semaphore::new
         super
       end
+
+      def accept_wait
+        @accept_ready.wait
+      end
+
       ##
       # Wait until the stream has been established
       #
@@ -58,7 +64,7 @@ module Jabber
             false
           end
         }
-
+        @accept_ready.run
         begin
           Timeout::timeout(@connect_timeout) { connect_sem.wait }
         rescue Timeout::Error

data/lib/xmpp4r/callbacks.rb

@@ -39,6 +39,7 @@ module Jabber
   # < 100::   all those numbers are normally available for your application.
   #           That's enough, don't you think ?
   class CallbackList
+    include Enumerable
 
     # Create a new list of callbacks
     def initialize
@@ -70,6 +71,10 @@ module Jabber
       self
     end
 
+    def each(&block)
+      @list.each(&block)
+    end
+
     ##
     # Number of elements in the list
     # return:: [Integer] The number of elements
@@ -120,5 +125,9 @@ module Jabber
       @ref = ref
       @block = block
     end
+
+    def to_s
+      "#<#{[self.class, priority, ref].compact * " "}>"
+    end
   end
 end

data/lib/xmpp4r/caps/c.rb

@@ -48,6 +48,20 @@ module Jabber
       def hash
         attributes['hash']
       end
+
+      ##
+      # Get the value of this element's 'ext' attribute,
+      # the list of extensions for legacy clients.
+      def ext
+        attributes['ext']
+      end
+
+      ##
+      # Is this a legacy caps response, as defined by version 1.3 of
+      # the XEP-0115 specification?
+      def legacy?
+        hash.nil? || hash.empty?
+      end
     end
   end
 end

data/lib/xmpp4r/caps/helper/helper.rb

@@ -40,10 +40,7 @@ module Jabber
 
         @stream.add_iq_callback(250) do |iq|
           if iq.type == :get and iq.query.kind_of? Jabber::Discovery::IqQueryDiscoInfo
-            Thread.new do
-              Thread.abort_on_exception = true
-              handle_discoinfo_query(iq)
-            end
+            handle_discoinfo_query(iq)
             true
           else
             false

data/lib/xmpp4r/client.rb

@@ -75,7 +75,9 @@ module Jabber
     # Close the connection,
     # sends <tt></stream:stream></tt> tag first
     def close
-      send("</stream:stream>")
+      if @status == CONNECTED
+        send("</stream:stream>")
+      end
       super
     end
 
@@ -117,6 +119,44 @@ module Jabber
       end
     end
 
+    ##
+    # Resource binding (RFC3920bis-06 - section 8.)
+    #
+    # XMPP allows to bind to multiple resources
+    def bind(desired_resource=nil)
+      iq = Iq.new(:set)
+      bind = iq.add REXML::Element.new('bind')
+      bind.add_namespace @stream_features['bind']
+      if desired_resource
+        resource = bind.add REXML::Element.new('resource')
+        resource.text = desired_resource
+      end
+
+      jid = nil
+      send_with_id(iq) do |reply|
+        reply_bind = reply.first_element('bind')
+        if reply_bind
+          reported_jid = reply_bind.first_element('jid')
+          if reported_jid and reported_jid.text
+            jid = JID.new(reported_jid.text)
+          end
+        end
+      end
+      jid
+    end
+
+    ##
+    # Resource unbinding (RFC3920bis-06 - section 8.6.3.)
+    def unbind(desired_resource)
+      iq = Iq.new(:set)
+      unbind = iq.add REXML::Element.new('unbind')
+      unbind.add_namespace @stream_features['unbind']
+      resource = unbind.add REXML::Element.new('resource')
+      resource.text = desired_resource
+
+      send_with_id(iq)
+    end
+
     ##
     # Use a SASL authentication mechanism and bind to a resource
     #
@@ -138,20 +178,7 @@ module Jabber
 
       # Resource binding (RFC3920 - 7)
       if @stream_features.has_key? 'bind'
-        iq = Iq.new(:set)
-        bind = iq.add REXML::Element.new('bind')
-        bind.add_namespace @stream_features['bind']
-        if jid.resource
-          resource = bind.add REXML::Element.new('resource')
-          resource.text = jid.resource
-        end
-
-        send_with_id(iq) do |reply|
-          reported_jid = reply.first_element('jid')
-          if reported_jid and reported_jid.text
-            @jid = JID.new(reported_jid.text)
-          end
-        end
+        @jid = bind(@jid.resource)
       end
 
       # Session starting

data/lib/xmpp4r/connection.rb

@@ -86,10 +86,11 @@ module Jabber
 
     ##
     # Closing connection:
-    # first kill keepaliveThread, then call Stream#close!
+    # first kill keepaliveThread (but only if it's not me), then call Stream#close!
     def close!
-      @keepaliveThread.kill if @keepaliveThread and @keepaliveThread.alive?
+      @keepaliveThread.kill if @keepaliveThread and @keepaliveThread.alive? and @keepaliveThread != Thread.current
       super
+      @keepaliveThread.kill if @keepaliveThread and @keepaliveThread.alive?
     end
 
     def accept_features
@@ -131,7 +132,7 @@ module Jabber
         true
       }
       if reply.name != 'proceed'
-        raise ServerError(reply.first_element('error'))
+        raise ServerError.new(reply.first_element('error'))
       end
       # Don't be interrupted
       stop
@@ -204,6 +205,9 @@ module Jabber
     # seconds.
     def keepalive_loop
       loop do
+        unless is_connected?
+          Thread.current.kill
+        end
         difference = @last_send + @keepalive_interval - Time.now
         if difference <= 0
           send(' ')

data/lib/xmpp4r/debuglog.rb

@@ -8,7 +8,8 @@ module Jabber
   def Jabber::logger
     @@logger ||= Logger.new($stderr)
   end
-
+  
+  # Set the logger to use for debug and warn (if enabled)
   def Jabber::logger=(logger)
     @@logger = logger
   end
@@ -16,6 +17,9 @@ module Jabber
   # Is debugging mode enabled ?
   @@debug = false
 
+  # Is warnings mode enabled ?
+  @@warnings = false
+
   # Enable/disable debugging mode. When debug mode is enabled, information
   # can be logged using Jabber::debuglog. When debug mode is disabled, calls
   # to Jabber::debuglog are just ignored.
@@ -23,6 +27,16 @@ module Jabber
     @@debug = debug
     if @@debug
       debuglog('Debugging mode enabled.')
+      #if debug is enabled, we should automatically enable warnings too
+      Jabber::warnings = true
+    end
+  end
+
+  # Enable/disable warnings mode.
+  def Jabber::warnings=(warnings)
+    @@warnings = warnings
+    if @@warnings
+      warnlog('Warnings mode enabled.')
     end
   end
 
@@ -39,4 +53,11 @@ module Jabber
     return if not @@debug
     logger.debug string.chomp.gsub("\n", "\n    ")
   end
+  
+  # Outputs a string only if warnings mode is enabled.
+  def Jabber::warnlog(string)
+    return if not @@warnings
+    logger.warn string.chomp.gsub("\n", "\n    ")
+  end
+  
 end