gmcmillan-xmpp4r 0.5

data/README.rdoc

@@ -0,0 +1,122 @@
+= XMPP4R
+
+== whitehat101 notes
+
+lib/xmpp4r/stream.rb:82 -- IO::WaitReadable is not in ruby 1.8.7
+
+WIP dependencys
+ * rake
+ * nokogiri
+ * rdoc
+
+== Project Home
+
+You can find info about the xmpp4r project and how to contribute
+at the project home page:
+
+http://home.gna.org/xmpp4r/
+
+If you need to ask questions, or want feedback on proposed changes
+please feel free to ask them on the 'xmpp4r-devel@gna.org' mailing
+list.  You can join or view archives of the mailing list at:
+
+https://gna.org/mail/?group=xmpp4r
+
+If you are having a problem and would like to report it
+to the mailing list please include a protocol dump
+which can be enabled in your code with:
+
+  Jabber::debug = true
+
+
+== Contributors
+
+  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
+  Vojtech Vobr
+  Andreas Wiese
+  Chris Zelenak
+  Matthew Wood
+  Sam Ruby
+  Tim Carey-Smith
+  Scott Lillibridge
+  Joshua Sierles
+  Ripta Pasay <github@r8y.org>
+  Seth Fitzsimmons
+
+
+== Source Code
+
+The source for xmpp4r is managed using the Git SCM and can be
+found in our GitHub.com project page:
+
+http://github.com/ln/xmpp4r/tree/master
+
+
+== Installation
+
+There are a number of ways that you can install xmpp4r depending
+on your needs and the methods you prefer.
+
+=== Install over the network using RubyGems
+
+You can install the current release of the xmpp4r library from a stable
+release gem on RubyForge using RubyGems:
+
+  sudo gem install xmpp4r
+
+=== Install over the network using a Debian package
+
+You can install the current release of the xmpp4r library from a stable release copy
+on your .deb friendly linux system (e.g. Debian or Ubuntu) using apt:
+
+  sudo apt-get install libxmpp4r-ruby
+
+=== Install from local source code (Developers Only)
+
+If you have a local Git clone of the source repository or a tarball
+you can install xmpp4r using several methods.  First you'll
+need to get a local copy.
+
+Clone the Git repository (recommended):
+
+  git clone git://github.com/ln/xmpp4r.git
+
+OR download a stable release tarball from:
+
+  http://download.gna.org/xmpp4r/xmpp4r-0.3.2.tgz
+
+OR download a snapshot of the latest source in .tar.gz format from:
+
+  http://github.com/ln/xmpp4r/tarball/master
+
+==== Install : Using Rake
+
+  # Show all available rake tasks
+  cd xmpp4r/
+  rake -T
+
+  # Package up the gem file and install it
+  rake gem:install
+
+==== Install : Using setup.rb
+
+This will install a copy of the library in your Ruby path and does not
+require RubyGems to be installed.
+
+  cd xmpp4r/
+  ./setup.rb
+
+
+== License
+
+XMPP4R is released under the Ruby license (see the LICENSE file), which is
+compatible with the GNU GPL (see the COPYING file) via an explicit
+dual-licensing clause.
+

data/README_ruby19.txt

@@ -0,0 +1,43 @@
+Ruby 1.9 is a development release in anticipation of Ruby 2.0, which has
+overall better performance, real threading, and character encoding support.
+Note: Ruby 1.9 is a development release, meaning that everything is
+subject to change without prior notice.  Among other things, this means
+that xmpp4r could stop working on Ruby 1.9 at any time.
+
+This version of xmpp4r has made a number of internal changes (nothing visible
+at the API) to remove depency on deprecated Ruby Kernel APIs, support the new
+encoding APIs, etc.
+
+At the present time, all tests pass except tc_helper.rb and tc_stream.rb.
+These tests themselves make assumptions about timinings of events,
+assumptions that are not guaranteed with true multi-tasking.  Initial
+analysis indicates that xmpp4r is operating correctly, it is the tests
+themselves that need to be corrected, but this could turn out to be
+incorrect.
+
+The executing of these two tests are disabled by a check in ts_xmpp4r.rb,
+which is marked as a TODO.
+
+A specific example: test_bidi in test/tc_stream.rb defines two threads,
+one pumps out requests, the other echoes them.  The receiver then verifies
+that it gets back what it sent.  With Ruby 1.8, these threads tend to
+alternate in lock step, and the test usually passes.  What happens in Ruby 1.9
+is that the first thread waits for a message, and the second one creates a
+callback block, generates a message, and then proceeds on to create a second
+callback block -- even before the first message has been responded to.
+The way xmpp4r works is that callbacks are saved on a pushdown stack.
+
+The net result is that the first response typically is processed first by 
+the second callback, which decides that the ids don't match, and the test fails.
+
+The way it is supposed to work is that the reply callback is supposed to
+only process requests destined for it (and return true) and ignore
+everything else (returning false).
+
+This is but one test.  Many of the tests in these two files are of this
+nature.
+
+The current status of the tests that are expected to pass on Ruby 1.9
+can generally be found here:
+
+http://intertwingly.net/projects/ruby19/logs/xmpp4r.html

data/Rakefile

@@ -0,0 +1,258 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+
+$:.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 )).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}/**/*"]).sort
+
+##############################################################################
+# 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 'rubygems/package_task'
+
+  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"
+
+    s.add_dependency 'nokogiri'
+    s.add_dependency 'rdoc', '>2.4.2'
+    s.add_dependency 'rake'
+  end
+
+  Gem::PackageTask.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
+  raise
+  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."