ln-xmpp4r 0.5

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

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+
+# This bot will reply to every message it receives. To end the game, send 'exit'
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r/client'
+include Jabber
+
+# settings
+if ARGV.length != 2
+  puts "Run with ./echo_thread.rb user@server/resource password"
+  exit 1
+end
+myJID = JID.new(ARGV[0])
+myPassword = ARGV[1]
+cl = Client.new(myJID)
+cl.connect
+cl.auth(myPassword)
+cl.send(Presence.new)
+puts "Connected ! send messages to #{myJID.strip.to_s}."
+mainthread = Thread.current
+cl.add_message_callback do |m|
+  if m.type != :error
+    m2 = Message.new(m.from, "You sent: #{m.body}")
+    m2.type = m.type
+    cl.send(m2)
+    if m.body == 'exit'
+      m2 = Message.new(m.from, "Exiting ...")
+      m2.type = m.type
+      cl.send(m2)
+      mainthread.wakeup
+    end
+  end
+end
+Thread.stop
+cl.close

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

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+
+# This script will send a jabber message to the specified JID. The subject can be
+# specified using the '-s' option, and the message will be taken from stdin.
+
+$:.unshift '../../../../../lib'
+
+require 'optparse'
+require 'xmpp4r'
+include Jabber
+
+# settings
+myJID = JID.new('bot@localhost/Bot')
+myPassword = 'bot'
+
+to = nil
+subject = ''
+OptionParser.new do |opts|
+  opts.banner = 'Usage: jabbersend.rb -s \'subject\' -t dest@domain'
+  opts.separator ''
+  opts.on('-s', '--subject SUBJECT', 'sets the message\'s subject') { |s| subject = s }
+  opts.on('-t', '--to DESTJID', 'sets the receiver') { |t| to = JID.new(t) }
+  opts.on_tail('-h', '--help', 'Show this message') {
+    puts opts
+    exit
+  }
+  opts.parse!(ARGV)
+end
+
+if to.nil?
+  puts "No receiver specified. See jabbersend -h"
+end
+
+cl = Client.new(myJID)
+cl.connect
+cl.auth(myPassword)
+body = STDIN.readlines.join
+m = Message.new(to, body).set_type(:normal).set_id('1').set_subject(subject)
+puts m.to_s
+cl.send(m)
+cl.close

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

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+
+# This script will send a jabber message to a list of JID given on stdin.
+
+$:.unshift '../../../../../lib'
+
+require 'optparse'
+require 'xmpp4r'
+include Jabber
+#Jabber::debug = true
+
+# - message in file
+# - subject in command line
+# - JID list on stdin
+
+# settings
+jid = JID.new('bot@localhost/Bot')
+password = 'bot'
+filename = 'message.txt'
+
+subject = "Message de test"
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: mass_sender.rb -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('-f', '--filename MESSAGE', 'sets the filename containing the message') { |f| filename = f }
+  opts.on('-s', '--subject SUBJECT', 'sets the subject') { |s| subject = s }
+  opts.on_tail('-h', '--help', 'Show this message') {
+    puts opts
+    exit
+  }
+  opts.parse!(ARGV)
+end
+
+body = IO::read(filename).chomp
+
+cl = Client.new(jid)
+cl.connect
+cl.auth(password)
+exit = false
+sent = []
+cl.add_message_callback do |m|
+  if m.type != :error
+    if !sent.include?(m.from)
+      cl.send(Message.new(m.from, "Je suis un robot. Si tu souhaites contacter un administrateur du serveur, envoie un message à lucas@nussbaum.fr ou rejoins la salle jabberfr@chat.jabberfr.org."))
+      sent << m.from
+    end
+    if m.body == 'exitnowplease'
+      cl.send(Message.new(m.from, "Exiting ..."))
+      exit = true
+    end
+    cl.send(Message.new('lucas@nussbaum.fr', "From #{m.from}: #{m.body.to_s}"))
+  end
+end
+cl.send(Presence.new)
+m = Message.new(nil, body)
+m.subject = subject
+STDIN.each_line { |l|
+  l.chomp!
+  m.set_to(JID.new(l).to_s)
+  cl.send(m)
+}
+while not exit do
+  cl.process(1)
+end
+cl.close

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

@@ -0,0 +1,12 @@
+require 'xmpp4r'
+require 'xmpp4r/muc'
+
+client = Jabber::Client.new('admin@myserver.co.uk/ruby')
+muc = Jabber::MUC::MUCClient.new(client)
+client.connect
+client.auth('admin')
+muc.join('room@conference.myserver.co.uk/admin')
+muc.configure(
+      'muc#roomconfig_roomname' => 'roomname',
+      'muc#roomconfig_persistentroom' => 1
+)

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

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/muc/helper/mucbrowser'
+
+if ARGV.size != 3
+  puts "Usage: #{$0} <jid> <password> <muc-jid>"
+  exit
+end
+
+jid, password, muc_jid = Jabber::JID.new(ARGV.shift), ARGV.shift, Jabber::JID.new(ARGV.shift)
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(password)
+
+browser = Jabber::MUC::MUCBrowser.new(cl)
+
+print "Querying #{muc_jid} for identity..."; $stdout.flush
+name = browser.muc_name(muc_jid)
+
+if name.nil?
+  puts " Sorry, but the queried MUC component doesn't seem to support MUC or Groupchat."
+else
+  puts " #{name}"
+
+  print "Querying #{muc_jid} for its rooms..."; $stdout.flush
+  rooms = browser.muc_rooms(muc_jid)
+  puts " #{rooms.size} rooms found"
+
+  max_room_length = 0
+  rooms.each_key { |jid| max_room_length = jid.to_s.size if jid.to_s.size > max_room_length }
+
+  rooms.each { |jid,name|
+    puts "#{jid.to_s.ljust(max_room_length)} #{name}"
+  }
+end
+
+cl.close

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

@@ -0,0 +1,82 @@
+#!/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,42 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib'
+require 'xmpp4r'
+
+
+# Argument checking
+if ARGV.size < 2
+  puts("Usage: #{$0} <desired jid> <password> [field1=value1] [fieldN=valueN]")
+  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..."
+begin
+  fields = {}
+  ARGV[2..-1].each { |a|
+    k, v = a.split('=', 2)
+    fields[k] = v
+  }
+  cl.register(ARGV[1], fields)
+  puts "Successful"
+rescue Jabber::ServerError => e
+  puts "Error: #{e.error.text}"
+  if e.error.type == :modify
+    puts "Accepted registration information:"
+    instructions, fields = cl.register_info
+    fields.each { |info|
+      puts "* #{info}"
+    }
+    puts "(#{instructions})"
+  end
+end
+
+# 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,44 @@
+#!/usr/bin/ruby
+
+# This script can get all roster entries
+
+#$:.unshift '../../../../../lib'
+
+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)
+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