mojodna-xmpp4r 0.4.0.2

data/Rakefile

@@ -0,0 +1,252 @@
+require 'rake'
+require "rake/clean"
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+$:.unshift 'lib'
+require "xmpp4r"
+
+##############################################################################
+# OPTIONS
+##############################################################################
+
+PKG_NAME      = 'xmpp4r'
+PKG_VERSION   = Jabber::XMPP4R_VERSION
+AUTHORS       = ['Lucas Nussbaum', 'Stephan Maka', 'Glenn Rempe']
+EMAIL         = "xmpp4r-devel@gna.org"
+HOMEPAGE      = "http://home.gna.org/xmpp4r/"
+SUMMARY       = "XMPP4R is an XMPP/Jabber library for Ruby."
+
+# These are the common rdoc options that are shared between generation of
+# rdoc files using BOTH 'rake rdoc' and the installation by users of a
+# RubyGem version which builds rdoc's along with its installation.  Any
+# rdoc options that are ONLY for developers running 'rake rdoc' should be
+# added in the 'Rake::RDocTask' block below.
+RDOC_OPTIONS  = [
+                "--quiet",
+                "--title", SUMMARY,
+                "--opname", "index.html",
+                "--main", "lib/xmpp4r.rb",
+                "--line-numbers",
+                "--inline-source"
+                ]
+
+# 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 )
+
+# 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}/**/*"]
+
+##############################################################################
+# DEFAULT TASK
+##############################################################################
+
+# The task that will run when a simple 'rake' command is issued.
+# Default to running the test suite as that's a nice safe command
+# we should run frequently.
+task :default => [:test]
+
+##############################################################################
+# TESTING TASKS
+##############################################################################
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = ['test/ts_xmpp4r.rb']
+end
+
+##############################################################################
+# DOCUMENTATION TASKS
+##############################################################################
+
+# RDOC
+#######
+Rake::RDocTask.new do |rd|
+
+  # which dir should rdoc files be installed in?
+  rd.rdoc_dir = 'rdoc'
+
+  # the full list of files to be included
+  rd.rdoc_files.include(RDOC_FILES, "lib/**/*.rb")
+
+  # the full list of options that are common between gem build
+  # and 'rake rdoc' build of docs.
+  rd.options = RDOC_OPTIONS
+
+  # Devs Only : Uncomment to also document private methods in the rdocs
+  # Please don't check this change in to the source repo.
+  #rd.options << '--all'
+
+  # Devs Only : Uncomment to generate dot (graphviz) diagrams along with rdocs.
+  # This requires that graphiz (dot) be installed as a local binary and on your path.
+  # See : http://www.graphviz.org/
+  # Please don't check this change in to the source repo as it introduces a binary dependency.
+  #rd.options << '--diagram'
+  #rd.options << '--fileboxes'
+
+end
+
+
+# RCOV
+#######
+
+# Conditional require rcov/rcovtask if present
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |t|
+    t.test_files = ['test/ts_xmpp4r.rb']
+    t.output_dir = "coverage"
+  end
+rescue LoadError
+end
+
+# DOT GRAPH
+############
+desc "Generate requires graph"
+task :gen_requires_graph do
+  sh %{cd tools; ./gen_requires.bash}
+end
+
+# UPDATE WEBSITE (for Lucas only)
+#################################
+desc "Update website (for Lucas only)"
+task :update_website do
+  sh %{cp website/* ~/dev/xmpp4r/website/ && cd ~/dev/xmpp4r/website/ && svn commit -m "website update"}
+end
+
+
+##############################################################################
+# SYNTAX CHECKING
+##############################################################################
+
+desc "Check syntax of all Ruby files."
+task :check_syntax do
+  `find . -name "*.rb" |xargs -n1 ruby -c |grep -v "Syntax OK"`
+  puts "* Done"
+end
+
+##############################################################################
+# PACKAGING & INSTALLATION
+##############################################################################
+
+# What files/dirs should 'rake clean' remove?
+CLEAN.include ["*.gem", "pkg", "rdoc", "coverage", "tools/*.png"]
+
+begin
+  require 'rake/gempackagetask'
+
+  spec = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.authors = AUTHORS
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.rubyforge_project = PKG_NAME
+    s.summary = SUMMARY
+    s.description = s.summary
+    s.platform = Gem::Platform::RUBY
+    s.require_path = 'lib'
+    s.executables = []
+    s.files = PKG_FILES
+    s.test_files = []
+    s.has_rdoc = true
+    s.extra_rdoc_files = RDOC_FILES
+    s.rdoc_options = RDOC_OPTIONS
+    s.required_ruby_version = ">= 1.8.4"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.gem_spec = spec
+    pkg.need_tar = true
+    pkg.need_zip = true
+  end
+
+  namespace :gem do
+
+    desc "Run :package and install the .gem locally"
+    task :install => [:update_gemspec, :package] do
+      sh %{sudo gem install --local pkg/#{PKG_NAME}-#{PKG_VERSION}.gem}
+    end
+
+    desc "Like gem:install but without ri or rdocs"
+    task :install_fast => [:update_gemspec, :package] do
+      sh %{sudo gem install --local pkg/#{PKG_NAME}-#{PKG_VERSION}.gem --no-rdoc --no-ri}
+    end
+
+    desc "Run :clean and uninstall the .gem"
+    task :uninstall => :clean do
+      sh %{sudo gem uninstall #{PKG_NAME}}
+    end
+
+    # Thanks to the Merb project for this code.
+    desc "Update Github Gemspec"
+    task :update_gemspec do
+      skip_fields = %w(new_platform original_platform date)
+
+      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.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?)
+        if name == "dependencies"
+          value.each do |d|
+            dep, *ver = d.to_s.split(" ")
+            result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "")}\n"
+          end
+        else
+          case value
+          when Array
+            value =  name != "files" ? value.inspect : value.sort.uniq.inspect.split(",").join(",\n")
+          when String, Fixnum, true, false
+            value = value.inspect
+          else
+            value = value.to_s.inspect
+          end
+          result << "  s.#{name} = #{value}\n"
+        end
+      end
+      result << "end"
+      File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+    end
+
+  end # namespace :gem
+
+  # also keep the gemspec up to date each time we package a tarball or gem
+  task :package => ['gem:update_gemspec']
+  task :gem => ['gem:update_gemspec']
+
+rescue LoadError
+  puts <<EOF
+###
+  Packaging Warning : RubyGems is apparently not installed on this
+  system and any file add/remove/rename will not
+  be auto-updated in the 'xmpp4r.gemspec' when you run any
+  package tasks.  All such file changes are recommended
+  to be packaged on a system with RubyGems installed
+  if you intend to push commits to the Git repo so the
+  gemspec will also stay in sync for others.
+###
+EOF
+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.
+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
+    puts <<EOF
+###
+  Warning : Unable to require the 'rake/packagetask'. Is Rake installed?
+###
+EOF
+  end
+end

data/data/doc/xmpp4r/examples/advanced/adventure/README

@@ -0,0 +1,56 @@
+What is this?
+
+This is an example of what you can do with XMPP4R. It is a conferencing
+component in which you can walk around, travel to various places, look
+at things and talk to other visitors on the same places. If you like
+Multi-User Dungeons (MUDs) this is for you!
+
+---
+
+How does it work?
+
+The component loads a few worlds from a few XML files. Each world is a
+component. Once joined the chat will tell you what you can do. Remember
+that you can get a command listing anytime by saying '?'.
+
+Reading 'You can go north, west' you may say 'go north' to go in the
+northern direction and 'go west' to go in the western direction. You'll
+then find yourself at some other place but still in the same MUC
+conference. Your groupchat roster will change as you'll notice different
+people and things that are just in the same place, not other places.
+
+Before starting to hack the scripts you may want to take a look at
+tower.xml. Note that users are <thing/>s, too and the whole world could
+be serialized back to XML by just issuing "world.to_s".
+
+Please note that the code, especially the error handling, is of extreme
+poor quality and was mostly written in one afternoon. If I'm going to
+develop this further everything should be rewritten...
+
+---
+
+How to try?
+
+Because this is a component you are going to need your own Jabber
+Daemon - which you'll need anyways if you're going to experiment with
+XMPP4R. ;-)
+
+Syntax:
+./adventure.rb <JID> <Password> <Host>
+
+Example:
+./adventure.rb mud.example.com geheimnis localhost
+
+---
+
+Messages seem to have random order?
+
+I don't know any solution for this. One may add short delays between
+messages, but that would only be a very dirty hack.
+
+RFC3920:
+
+"10.  Server Rules for Handling XML Stanzas
+
+Compliant server implementations MUST ensure in-order processing of
+XML stanzas between any two entities."

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

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/discovery'
+require 'xmpp4r/muc/x/muc'
+
+require 'adventuremuc'
+
+
+#Jabber::debug = true
+
+if ARGV.size != 3
+  puts "Syntax: ./adventure.rb <JID> <Password> <Host>"
+  puts "See README for further help"
+  exit
+end
+
+muc = AdventureMUC.new(Jabber::JID.new(ARGV[0]), ARGV[1], ARGV[2])
+muc.add_world('tower.xml')
+muc.add_world('cube.xml')
+Thread.stop

data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb

@@ -0,0 +1,136 @@
+require 'world'
+
+class AdventureMUC
+  def initialize(jid, secret, addr, port=5347)
+    @worlds = {}
+
+    @component = Jabber::Component.new(jid)
+    @component.connect(addr, port)
+    @component.auth(secret)
+    @component.on_exception { |e,|
+      puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+    }
+
+    @component.add_iq_callback { |iq|
+      handle_iq(iq)
+    }
+    @component.add_presence_callback { |pres|
+      handle_presence(pres)
+    }
+    @component.add_message_callback { |msg|
+      handle_message(msg)
+    }
+
+    puts "Adventure component up and running"
+  end
+
+  def add_world(file)
+    print "Adding world from #{file}..."
+    begin
+      world = World.new_from_file(self, file)
+    rescue Exception => e
+      puts " #{e.to_s}"
+      exit
+    end
+    @worlds[world.node] = world
+    puts " #{world.iname}"
+  end
+
+  def send(worldnode, worldresource, stanza)
+    stanza.from = Jabber::JID.new(worldnode, @component.jid.domain, worldresource)
+    @component.send(stanza)
+  end
+
+  def handle_iq(iq)
+    puts "iq: from #{iq.from} type #{iq.type} to #{iq.to}: #{iq.queryns}"
+
+    if iq.query.kind_of?(Jabber::Discovery::IqQueryDiscoInfo)
+      handle_disco_info(iq)
+      true
+    elsif iq.query.kind_of?(Jabber::Discovery::IqQueryDiscoItems)
+      handle_disco_items(iq)
+      true
+    else
+      false
+    end
+  end
+
+  def handle_disco_info(iq)
+    if iq.type != :get
+      answer = iq.answer
+      answer.type = :error
+      answer.add(Jabber::ErrorResponse.new('bad-request'))
+      @component.send(answer) if iq.type != :error
+      return
+    end
+    answer = iq.answer
+    answer.type = :result
+    if iq.to.node == nil
+      answer.query.add(Jabber::Discovery::Identity.new('conference', 'Adventure component', 'text'))
+      answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoInfo.new.namespace))
+      answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoItems.new.namespace))
+    else
+      world = @worlds[iq.to.node]
+      if world.nil?
+        answer.type = :error
+        answer.query.add(Jabber::ErrorResponse.new('item-not-found', 'The world you are trying to reach is currently unavailable.'))
+      else
+        answer.query.add(Jabber::Discovery::Identity.new('conference', world.iname, 'text'))
+        answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoInfo.new.namespace))
+        answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoItems.new.namespace))
+        answer.query.add(Jabber::Discovery::Feature.new(Jabber::MUC::XMUC.new.namespace))
+        answer.query.add(Jabber::Discovery::Feature.new(Jabber::MUC::XMUCUser.new.namespace))
+      end
+    end
+    @component.send(answer)
+  end
+
+  def handle_disco_items(iq)
+    if iq.type != :get
+      answer = iq.answer
+      answer.add(Jabber::ErrorResponse.new('bad-request'))
+      @component.send(answer)
+      return
+    end
+    answer = iq.answer
+    answer.type = :result
+    if iq.to.node == nil
+      @worlds.each { |node,world|
+        answer.query.add(Jabber::Discovery::Item.new(Jabber::JID.new(node, @component.jid.domain), world.iname))
+      }
+    end
+    @component.send(answer)
+  end
+
+  def handle_presence(pres)
+    puts "presence: from #{pres.from} type #{pres.type} to #{pres.to}"
+
+    world = @worlds[pres.to.node]
+    if world.nil?
+      answer = pres.answer
+      answer.type = :error
+      answer.add(Jabber::ErrorResponse.new('item-not-found', 'The world you are trying to reach is currently unavailable.'))
+      @component.send(answer)
+    else
+      world.handle_presence(pres)
+    end
+
+    true
+  end
+
+  def handle_message(msg)
+    puts "message: from #{msg.from} type #{msg.type} to #{msg.to}: #{msg.body.inspect}"
+
+    world = @worlds[msg.to.node]
+    if world.nil?
+      answer = msg.answer
+      answer.type = :error
+      answer.add(Jabber::ErrorResponse.new('item-not-found', 'The world you are trying to reach is currently unavailable.'))
+      @component.send(answer)
+    else
+      world.handle_message(msg)
+    end
+
+    true
+  end
+end

data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml

@@ -0,0 +1,15 @@
+<world node='cube' name='Cube - the movie' start='Room'>
+
+  <place name='Room'>
+    This is a big white room.
+    There are doors up, down, left, right, in the back and in front of you.
+    There's nothing else.
+    <go spec='up' place='Room'/>
+    <go spec='down' place='Room'/>
+    <go spec='left' place='Room'/>
+    <go spec='right' place='Room'/>
+    <go spec='back' place='Room'/>
+    <go spec='forward' place='Room'/>
+  </place>
+
+</world>

data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml

@@ -0,0 +1,69 @@
+<world node='tower' name='The mysterious tower' start='the garden'>
+
+  <place name='the garden'>
+    You are in a beautiful garden.
+    There's an impressive tower beneath. Its door is open.
+    <go spec='door' place='lower room'/>
+    <go spec='east' place='the well'/>
+  </place>
+
+  <place name='lower room'>
+    Welcome to the tower's lower room.
+    There's a ladder to upstairs.
+    <go spec='door' place='the garden'/>
+    <go spec='ladder' place='upper room'/>
+  </place>
+
+  <place name='upper room'>
+    This is the upper room.
+    There's only a bed here. A wizard is currently sleeping in it.
+    <go spec='ladder' place='lower room'/>
+  </place>
+
+  <place name='the well'>
+    There's a very beautiful well in the middle of this place.
+    A frog sits on the well's edge. It looks frightening happy.
+    <go spec='west' place='the garden'/>
+  </place>
+
+
+  <thing name='Frog' place='the well'>
+    <on-enter>
+      <say>Hello great hero!</say>
+      <say>Welcome to %place%</say>
+    </on-enter>
+    <on-leave>
+      <tell>The %self% waves towards %actor%</tell>
+    </on-leave>
+    <on-command command='talk'>
+      <say>I would love to come with you, great hero. But I'm immobile due to the simple nature of this game. Would *YOU* like to /code/ me movable? So we could enjoy great adventures together...</say>
+    </on-command>
+    <on-command command='touch'>
+      <tell to='all'>%actor% touches the %self%</tell>
+      <say to='all'>Quaaack! That feels good.</say>
+    </on-command>
+    <presence>
+      <show>chat</show>
+      <status>Happy</status>
+    </presence>
+  </thing>
+
+  <thing name='Sleeping Wizard' place='upper room'>
+    <on-enter>
+      <say>*snork*</say>
+    </on-enter>
+    <presence>
+      <show>dnd</show>
+      <status>Sleeping... go bother my assistant, the frog.</status>
+    </presence>
+  </thing>
+
+  <thing name='Tower window' command-name='window' place='upper room'>
+    <on-command command='look'>
+      <say>You see a beautiful garden. There's a well behind the garden. But a huge green monster is sitting on it's edge.</say>
+    </on-command>
+    <presence>
+      <status>There's a great view from up here</status>
+    </presence>
+  </thing>
+</world>