xmpp4r 0.3

data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+$:.unshift '../../../../../lib/'
+require 'xmpp4r'
+require 'xmpp4r/muc/helper/simplemucclient'
+
+
+if ARGV.size != 3
+  puts "Usage: #{$0} <jid> <password> <room@conference/nick>"
+  exit
+end
+
+# Print a line formatted depending on time.nil?
+def print_line(time, line)
+  if time.nil?
+    puts line
+  else
+    puts "#{time.strftime('%I:%M')} #{line}"
+  end
+end
+
+
+#Jabber::debug = true
+cl = Jabber::Client.new(Jabber::JID.new(ARGV[0]))
+cl.connect
+cl.auth(ARGV[1])
+
+# For waking up...
+mainthread = Thread.current
+
+# This is the SimpleMUCClient helper!
+m = Jabber::MUC::SimpleMUCClient.new(cl)
+
+# SimpleMUCClient callback-blocks
+
+m.on_join { |time,nick|
+  print_line time, "#{nick} has joined!"
+  puts "Users: " + m.roster.keys.join(', ')
+}
+m.on_leave { |time,nick|
+  print_line time, "#{nick} has left!"
+}
+
+m.on_message { |time,nick,text|
+  print_line time, "<#{nick}> #{text}"
+
+  # Avoid reacting on messaged delivered as room history
+  unless time
+    # Bot: invite astro@spaceboyz.net
+    if text.strip =~ /^(.+?): invite (.+)$/
+      jid = $2
+      if $1.downcase == m.jid.resource.downcase
+        m.invite(jid => "Inviting you on behalf of #{nick}")
+        m.say("Inviting #{jid}...")
+      end
+    # Bot: subject This is room is powered by XMPP4R
+    elsif text.strip =~ /^(.+?): subject (.+)$/
+      if $1.downcase == m.jid.resource.downcase
+        m.subject = $2
+      end
+    # Bot: exit please
+    elsif text.strip =~ /^(.+?): exit please$/
+      if $1.downcase == m.jid.resource.downcase
+        puts "exiting"
+        m.exit "Exiting on behalf of #{nick}"
+        mainthread.wakeup
+      end
+    end
+  end
+}
+m.on_room_message { |time,text|
+  print_line time, "- #{text}"
+}
+m.on_subject { |time,nick,subject|
+  print_line time, "*** (#{nick}) #{subject}"
+}
+
+m.join(ARGV[2])
+
+# Wait for being waken up by m.on_message
+Thread.stop
+
+cl.close
+

data/data/doc/xmpp4r/examples/basic/register.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib'
+require 'xmpp4r'
+
+
+# Argument checking
+if ARGV.size != 2
+  puts("Usage: #{$0} <desired jid> <password>")
+  exit
+end
+
+
+# The usual procedure
+cl = Jabber::Client.new(Jabber::JID.new(ARGV[0]))
+puts "Connecting"
+cl.connect
+
+# Registration of the new user account
+puts "Registering..."
+cl.register(ARGV[1])
+puts "Successful"
+
+# Shutdown
+cl.close

data/data/doc/xmpp4r/examples/basic/remove_registration.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+require 'xmpp4r'
+include Jabber
+
+if ARGV.size != 2
+  puts "Warning! This example UNREGISTERS user accounts!"
+  puts "Usage: #{$0} <jid> <password>"
+  exit
+end
+
+cl = Client.new(JID.new(ARGV[0]))
+cl.connect
+cl.auth(ARGV[1])
+cl.remove_registration
+
+cl.close

data/data/doc/xmpp4r/examples/basic/roster.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby
+
+# This script can get all roster entries
+
+require 'optparse'
+require 'xmpp4r'
+require 'xmpp4r/roster/iq/roster'
+include Jabber
+
+jid = JID::new('lucastest@linux.ensimag.fr/rosterget')
+password = 'lucastest'
+
+OptionParser::new do |opts|
+  opts.banner = 'Usage: roster.rb -t get -j jid -p password'
+  opts.separator ''
+  opts.on('-j', '--jid JID', 'sets the jid') { |j| jid = JID::new(j) }
+  opts.on('-p', '--password PASSWORD', 'sets the password') { |p| password = p }
+  opts.on_tail('-h', '--help', 'Show this message') {
+    puts opts
+    exit
+  }
+  opts.parse!(ARGV)
+end
+
+cl = Client::new(jid, false)
+cl.connect
+cl.auth(password)
+cl.send(Iq::new_rosterget)
+exit = false
+cl.add_iq_callback { |i|
+  if i.type == :result and i.query.kind_of?(Roster::IqQueryRoster)
+    i.query.each_element { |e|
+      e.text = ''
+      puts e.to_s
+    }
+    exit = true
+  end
+}
+while not exit
+  cl.process
+end
+cl.close

data/data/doc/xmpp4r/examples/basic/rosterprint.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib/'
+
+require 'xmpp4r'
+require 'xmpp4r/roster/helper/roster'
+
+# Command line argument checking
+
+if ARGV.size != 2
+  puts("Usage: ./rosterprint.rb <jid> <password>")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(ARGV[1])
+
+# The roster instance
+roster = Jabber::Roster::Helper.new(cl)
+
+mainthread = Thread.current
+
+roster.add_query_callback { |iq|
+  mainthread.wakeup
+}
+
+Thread.stop
+
+roster.groups.each { |group|
+  if group.nil?
+    puts "*** Ungrouped ***"
+  else
+    puts "*** #{group} ***"
+  end
+
+  roster.find_by_group(group).each { |item|
+    puts "- #{item.iname} (#{item.jid})"
+  }
+
+  print "\n"
+}
+
+cl.close

data/data/doc/xmpp4r/examples/basic/rosterrename.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/roster/iq/roster'
+
+# Command line argument checking
+
+if ARGV.size < 4
+  puts("Usage: ./rosterrename.rb <your jid> <password> <jid to rename> <new name> [<group1> ... <groupn>]")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid, false)
+cl.connect
+cl.auth(ARGV[1])
+
+# The iq stanza
+iq = Jabber::Iq::new(:set)
+# The new roster instance and item element
+iq.add(Jabber::Roster::IqQueryRoster.new).add(Jabber::Roster::RosterItem.new(ARGV[2], ARGV[3])).groups = ARGV[4..ARGV.size]
+
+# Sending the stanza
+cl.send(iq)
+
+# Don't look at the results:
+cl.close

data/data/doc/xmpp4r/examples/basic/rosterwatch.rb

@@ -0,0 +1,172 @@
+#!/usr/bin/ruby
+#
+# XMPP4R - XMPP Library for Ruby
+# Copyright (C) 2005 Stephan Maka <stephan@spaceboyz.net>
+# Released under Ruby's license (see the LICENSE file) or GPL, at your option
+#
+#
+# Roster-Watch example
+#
+#
+# Learn how a roster looks like
+#       how presences are received
+#       about subscription requests and answers
+#       what vCards contain
+#
+# It's recommended to insert 'p' commands in this script. :-)
+#
+# This script does:
+#
+# * Listing roster changes
+#
+# * Subscribe to roster items which have a subscription of "none" or "from"
+#   WARNING: Chances are that you don't want that :-)
+#
+# * Requesting vCards for unnamed items in your roster and renaming them
+#   to the <NICKNAME/> or <FN/> field in the vCard
+#
+# * Listing presence changes
+#
+# * Listing subscription and unsubscription requests and answers
+
+$:.unshift '../../../../../lib/'
+
+require 'xmpp4r'
+require 'xmpp4r/roster/helper/roster'
+require 'xmpp4r/vcard/helper/vcard'
+
+# Command line argument checking
+
+if ARGV.size != 2
+  puts("Usage: ./rosterwatch.rb <jid> <password>")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(ARGV[1])
+
+# The roster instance
+roster = Jabber::Roster::Helper.new(cl)
+
+# Callback to handle updated roster items
+roster.add_update_callback { |olditem,item|
+  if [:from, :none].include?(item.subscription) && item.ask != :subscribe
+    puts("Subscribing to #{item.jid}")
+    item.subscribe
+  end
+  
+  # Print the item
+  if olditem.nil?                                                    
+    # We didn't knew before:                                       
+    puts("#{item.iname} (#{item.jid}, #{item.subscription}) #{item.groups.join(', ')}")
+  else                                                             
+    # Showing whats different:                                     
+    puts("#{olditem.iname} (#{olditem.jid}, #{olditem.subscription}) #{olditem.groups.join(', ')} -> #{item.iname} (#{item.jid}, #{item.subscription}) #{item.groups.join(', ')}")
+  end
+
+  # If the item has no name associated...
+  unless item.iname
+    Thread.new do
+      puts("#{item.jid} has no nickname... getting vCard")
+      begin
+        # ...get a vCard
+        vcard = Jabber::Vcard::Helper.new(cl).get(item.jid.strip)
+
+        unless vcard.nil?
+          # Rename him to vCard's <NICKNAME/> field
+          if vcard['NICKNAME']
+            item.iname = vcard['NICKNAME']
+            puts("Renaming #{item.jid} to #{vcard['NICKNAME']}")
+            item.send
+          # Rename him to vCard's <FN/> field
+          elsif vcard['FN']
+            item.iname = vcard['FN']
+            puts("Renaming #{item.jid} to #{vcard['FN']}")
+            item.send
+          # We've got a lazy one
+          else
+            puts("#{item.jid} provided no details in vCard")
+          end
+        end
+
+      rescue Exception => e
+        # This will be (mostly) thrown by Jabber::Vcard::Helper#get
+        puts("Error getting vCard for #{item.jid}: #{e.to_s}")
+      end
+    end
+  end
+}
+
+# Presence updates:
+roster.add_presence_callback { |item,oldpres,pres|
+  # Can't look for something that just does not exist...
+  if pres.nil?
+    # ...so create it:
+    pres = Jabber::Presence.new
+  end
+  if oldpres.nil?
+    # ...so create it:
+    oldpres = Jabber::Presence.new
+  end
+  
+  # Print name and jid:
+  name = "#{pres.from}"
+  if item.iname
+    name = "#{item.iname} (#{pres.from})"
+  end
+  puts(name)
+
+  # Print type changes:
+  unless oldpres.type.nil? && pres.type.nil?
+    puts("  Type: #{oldpres.type.inspect} -> #{pres.type.inspect}")
+  end
+  # Print show changes:
+  unless oldpres.show.nil? && pres.show.nil?
+    puts("  Show:     #{oldpres.show.to_s.inspect} -> #{pres.show.to_s.inspect}")
+  end
+  # Print status changes:
+  unless oldpres.status.nil? && pres.status.nil?
+    puts("  Status:   #{oldpres.status.to_s.inspect} -> #{pres.status.to_s.inspect}")
+  end
+  # Print priority changes:
+  unless oldpres.priority.nil? && pres.priority.nil?
+    puts("  Priority: #{oldpres.priority.inspect} -> #{pres.priority.inspect}")
+  end
+
+  # Note: presences with type='error' will reflect our own show/status/priority
+  # as it is mostly just a reply from a server. This is *not* a bug.
+}
+
+# Subscription requests and responses:
+subscription_callback = lambda { |item,pres|
+  name = pres.from
+  if item != nil && item.iname != nil
+    name = "#{item.iname} (#{pres.from})"
+  end
+  case pres.type
+    when :subscribe then puts("Subscription request from #{name}")
+    when :subscribed then puts("Subscribed to #{name}")
+    when :unsubscribe then puts("Unsubscription request from #{name}")
+    when :unsubscribed then puts("Unsubscribed from #{name}")
+    else raise "The Roster Helper is buggy!!! subscription callback with type=#{pres.type}"
+  end
+}
+roster.add_subscription_callback(0, nil, &subscription_callback)
+roster.add_subscription_request_callback(0, nil, &subscription_callback)
+
+# Send initial presence
+# this is important for receiving presence of subscribed users
+cl.send(Jabber::Presence.new.set_show(:dnd).set_status('Watching my roster change...'))
+
+# Main loop:
+Thread.stop
+
+cl.close
+

data/data/doc/xmpp4r/examples/basic/send_vcard.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+
+# Demonstration of the Vcard helper class
+#
+# * Retrieves your own vCard
+# * Modify fields given on the command line
+# * Dumps the vCard
+# * Send your vCard to the server
+
+$:.unshift('../../../../../lib')
+
+require 'xmpp4r'
+require 'xmpp4r/vcard/helper/vcard'
+include Jabber
+
+
+# settings
+if ARGV.length < 2
+  puts "Usage:\t./send_vcard.rb <jid> <password> [<field1>=<value1> [... <fieldN>=<valueN>] ]"
+  puts "Example:\t./send_vcard.rb user@server/resource password NICKNAME=User \"FN=A user\""
+  exit 1
+end
+
+# Do the client stuff...
+myJID = JID::new(ARGV.shift)
+myPassword = ARGV.shift
+cl = Client::new(myJID)
+cl.connect
+cl.auth(myPassword)
+
+# The Vcard helper
+vcard_helper = Vcard::Helper.new(cl)
+
+begin
+  puts "Retrieving vCard information for #{cl.jid.strip}"
+  vcard = vcard_helper.get
+
+  
+  # Inspect the command line for vCard fields to be changed
+  ARGV.each { |arg|
+    arg.scan(/^(.+?)=(.*)$/) { |field,text|
+      puts "field #{field}: #{vcard[field].inspect} => #{text.inspect}"
+      vcard[field] = text
+    }
+  }
+
+  # Dump the vCard
+  vcard.fields.each { |field|
+    if field.split(/\//).pop == 'BINVAL'
+      puts "#{field}:\tBINVAL"
+    else
+      puts "#{field}:\t#{vcard[field].inspect}"
+    end
+  }
+
+  begin
+    puts "Sending vCard information for #{cl.jid.strip}"
+    vcard_helper.set(vcard)
+  rescue Exception => e
+    puts "Sorry, we stumbled upon the following when sending the vCard of #{cl.jid.strip}: #{e.to_s.inspect}"
+  end
+
+rescue Exception => e
+  puts "Sorry, we stumbled upon the following when requesting the vCard of #{cl.jid.strip}: #{e.to_s.inspect}"
+end
+
+cl.close
+

data/data/doc/xmpp4r/examples/basic/versionbot.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/version/iq/version'
+require 'xmpp4r/version/helper/simpleresponder'
+
+
+# A Hash containing all Version Query answers with their JIDs as keys:
+versions = {}
+
+# Command line argument checking
+
+if ARGV.size != 2
+  puts("Usage: ./versionbot.rb <jid> <password>")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid, false)
+cl.connect
+cl.auth(ARGV[1])
+
+cl.on_exception { |*a|
+  p a[0].backtrace
+  exit!
+}
+
+# I'm not sure about the portability of 'uname -sr' here ;-)
+# but that's all needed to answer version queries:
+Jabber::Version::SimpleResponder.new(cl, 'xmpp4r Versionbot example', Jabber::XMPP4R_VERSION, IO.popen('uname -sr').readlines.to_s.strip)
+
+
+cl.add_iq_callback { |iq|
+  # Filter for version query results
+  if (iq.type == :result) && iq.query.kind_of?(Jabber::Version::IqQueryVersion)
+    puts "Version query result from #{iq.from}"
+    # Keep track of results per JID
+    versions[iq.from] = iq.query
+    # Print details
+    puts "  Name: #{iq.query.iname.inspect}"
+    puts "  Version: #{iq.query.version.inspect}"
+    puts "  OS: #{iq.query.os.inspect}"
+  end
+}
+
+cl.add_presence_callback { |pres|
+  # Already fingerprinted or offline?
+  unless versions.has_key?(pres.from) || (pres.type == :unavailable) || (pres.type == :error)
+    # Construct a new query
+    iq = Jabber::Iq.new(:get, pres.from)
+    # and ask for the version
+    iq.query = Jabber::Version::IqQueryVersion.new
+    puts "Asking #{iq.to} for his/her/its version"
+    versions[pres.from] = :asking
+    cl.send(iq)
+  end
+}
+
+# Send initial presence
+cl.send(Jabber::Presence.new.set_show(:xa).set_status('I am the evil fingerprinting robot'))
+
+# Main loop:
+loop do
+  cl.process
+  sleep(1)
+end
+
+cl.close

data/data/doc/xmpp4r/examples/buggy/jabber2jabber/jabber2jabber.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby
+
+$:.unshift '../lib'
+
+require 'xmpp4r'
+include Jabber
+
+c = Component::new('example.blop.info', 'linux.ensimag.fr', 2609)
+c.connect
+c.auth('BenEuh')
+c.add_iq_callback { |i|
+puts i.to_s
+}
+
+c.add_message_callback { |m|
+  puts m.to_s
+}
+Thread.stop