cancer 0.1.0.a1

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+  %w{.svn .hg .git vendor}.each {|exception| at.add_exception(exception)}
+end

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.yardoc
+coverage/
+doc/
+pkg/

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Simon Menke
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,46 @@
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = FileList['lib/**/*.rb'].to_a
+    t.options = ['-m', 'markdown', '--files', FileList['documentation/*.markdown'].to_a.join(',')]
+  end
+rescue LoadError
+  puts "YARD not available. Install it with: sudo gem install yard"
+end
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run all examples"
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('spec:rcov') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'examples', '--exclude', 'spec']
+  end
+rescue LoadError
+  puts "RSpec not available. Install it with: sudo gem install rspec"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "cancer"
+    gemspec.summary = "A Nokogiri based XMPP client library"
+    gemspec.description = "Building XMPP clients should be easy."
+    gemspec.email = "simon.menke@gmail.com"
+    gemspec.homepage = "http://github.com/simonmenke/cancer"
+    gemspec.authors = ["Simon Menke"]
+    gemspec.add_runtime_dependency 'nokogiri',         '>= 1.3.3'
+    gemspec.add_runtime_dependency 'astro-ruby-sasl',  '>= 0.0.3'
+    gemspec.add_runtime_dependency 'openssl-nonblock', '>= 0.2.0'
+    gemspec.add_runtime_dependency 'net-dns',          '>= 0.5.3'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0.a1

data/cancer.gemspec

@@ -0,0 +1,156 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cancer}
+  s.version = "0.1.0.a1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simon Menke"]
+  s.date = %q{2009-10-28}
+  s.description = %q{Building XMPP clients should be easy.}
+  s.email = %q{simon.menke@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "LICENSE.txt",
+     "Rakefile",
+     "VERSION",
+     "cancer.gemspec",
+     "documentation/STREAM_INITIATION.markdown",
+     "examples/example.rb",
+     "examples/example_2.rb",
+     "examples/example_em.rb",
+     "examples/example_em_helper.rb",
+     "examples/example_im_roster.rb",
+     "examples/example_xep_0004.rb",
+     "examples/example_xep_0047.rb",
+     "examples/example_xep_0050.rb",
+     "examples/example_xep_0065.rb",
+     "examples/example_xep_0096.dup.rb",
+     "examples/example_xep_0096_xep_0047.rb",
+     "examples/example_xep_0096_xep_0065.rb",
+     "lib/cancer.rb",
+     "lib/cancer/adapter.rb",
+     "lib/cancer/adapters/em.rb",
+     "lib/cancer/adapters/socket.rb",
+     "lib/cancer/builder.rb",
+     "lib/cancer/controller.rb",
+     "lib/cancer/dependencies.rb",
+     "lib/cancer/events/abstract_event.rb",
+     "lib/cancer/events/base_matchers.rb",
+     "lib/cancer/events/binary_matchers.rb",
+     "lib/cancer/events/eventable.rb",
+     "lib/cancer/events/exception_events.rb",
+     "lib/cancer/events/handler.rb",
+     "lib/cancer/events/manager.rb",
+     "lib/cancer/events/named_events.rb",
+     "lib/cancer/events/proc_matcher.rb",
+     "lib/cancer/events/xml_events.rb",
+     "lib/cancer/exceptions.rb",
+     "lib/cancer/jid.rb",
+     "lib/cancer/lock.rb",
+     "lib/cancer/spec.rb",
+     "lib/cancer/spec/error.rb",
+     "lib/cancer/spec/extentions.rb",
+     "lib/cancer/spec/matcher.rb",
+     "lib/cancer/spec/mock_adapter.rb",
+     "lib/cancer/spec/mock_stream.rb",
+     "lib/cancer/spec/transcript.rb",
+     "lib/cancer/stream.rb",
+     "lib/cancer/stream/builder.rb",
+     "lib/cancer/stream/controller.rb",
+     "lib/cancer/stream/event_helper.rb",
+     "lib/cancer/stream/xep.rb",
+     "lib/cancer/stream_parser.rb",
+     "lib/cancer/support.rb",
+     "lib/cancer/support/hash.rb",
+     "lib/cancer/support/string.rb",
+     "lib/cancer/synchronized_stanza.rb",
+     "lib/cancer/thread_pool.rb",
+     "lib/cancer/xep.rb",
+     "lib/cancer/xeps/core.rb",
+     "lib/cancer/xeps/core/bind.rb",
+     "lib/cancer/xeps/core/sasl.rb",
+     "lib/cancer/xeps/core/session.rb",
+     "lib/cancer/xeps/core/stream.rb",
+     "lib/cancer/xeps/core/terminator.rb",
+     "lib/cancer/xeps/core/tls.rb",
+     "lib/cancer/xeps/im.rb",
+     "lib/cancer/xeps/xep_0004_x_data.rb",
+     "lib/cancer/xeps/xep_0020_feature_neg.rb",
+     "lib/cancer/xeps/xep_0030_disco.rb",
+     "lib/cancer/xeps/xep_0047_ibb.rb",
+     "lib/cancer/xeps/xep_0050_commands.rb",
+     "lib/cancer/xeps/xep_0065_bytestreams.rb",
+     "lib/cancer/xeps/xep_0066_oob.rb",
+     "lib/cancer/xeps/xep_0095_si.rb",
+     "lib/cancer/xeps/xep_0096_si_filetransfer.rb",
+     "lib/cancer/xeps/xep_0114_component.rb",
+     "lib/cancer/xeps/xep_0115_caps.rb",
+     "lib/cancer/xeps/xep_0138_compress.rb",
+     "lib/cancer/xeps/xep_0144_rosterx.rb",
+     "lib/cancer/xeps/xep_0184_receipts.rb",
+     "lib/cancer/xeps/xep_0199_ping.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/stream/stanza_errors_spec.rb",
+     "spec/stream/stream_errors_spec.rb",
+     "spec/stream/stream_initialization_spec.rb",
+     "spec/xep_0050/local_spec.rb",
+     "spec/xep_0050/remote_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/simonmenke/cancer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Nokogiri based XMPP client library}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/stream/stanza_errors_spec.rb",
+     "spec/stream/stream_errors_spec.rb",
+     "spec/stream/stream_initialization_spec.rb",
+     "spec/xep_0050/local_spec.rb",
+     "spec/xep_0050/remote_spec.rb",
+     "examples/example.rb",
+     "examples/example_2.rb",
+     "examples/example_em.rb",
+     "examples/example_em_helper.rb",
+     "examples/example_im_roster.rb",
+     "examples/example_xep_0004.rb",
+     "examples/example_xep_0047.rb",
+     "examples/example_xep_0050.rb",
+     "examples/example_xep_0065.rb",
+     "examples/example_xep_0096.dup.rb",
+     "examples/example_xep_0096_xep_0047.rb",
+     "examples/example_xep_0096_xep_0065.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.3.3"])
+      s.add_runtime_dependency(%q<astro-ruby-sasl>, [">= 0.0.3"])
+      s.add_runtime_dependency(%q<openssl-nonblock>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<net-dns>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+      s.add_dependency(%q<astro-ruby-sasl>, [">= 0.0.3"])
+      s.add_dependency(%q<openssl-nonblock>, [">= 0.2.0"])
+      s.add_dependency(%q<net-dns>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+    s.add_dependency(%q<astro-ruby-sasl>, [">= 0.0.3"])
+    s.add_dependency(%q<openssl-nonblock>, [">= 0.2.0"])
+    s.add_dependency(%q<net-dns>, [">= 0.5.3"])
+  end
+end
+

data/documentation/STREAM_INITIATION.markdown

@@ -0,0 +1,18 @@
+# The Stream Initiation Process
+
+The stream initiation process is consists of multiple phases which are are ordered by priority. Some phases are optional others are required. Many techniques to sort the phases into a good order have been tried but a simple priority system seems to work best.
+
+
+## Phases and there priority
+
+1. Stream header element
+  1. Stream Controller (priority 200; xmpp-core)
+2. Features element
+  1. TLS Controller (priority 100; xmpp-core)
+  2. SASL Controller (priority 200; xmpp-core)
+  3. Compression Controller (priority 250; xep-0138)
+  4. Bind Controller (priority 300; xmpp-core)
+  5. Session Controller (priority 400; xmpp-core)
+  6. Terminator Controller (priority 500; xmpp-core)
+
+Each extension to Cancer that wants to add new feature negotiation abilities must register its priority with me (simon.menke@gmail.com) in order to prevent any conflicts with other extensions.

data/examples/example.rb

@@ -0,0 +1,80 @@
+require '../lib/cancer'
+
+=begin
+options = { :jid => 'alice@xmpp.dev/ccc', :password => 'ihatethequeen', :xeps => %w( xep-0138 xep-0030 ) }
+Cancer::Stream.open(options) do |stream|
+  stream.send {|x| x.presence(:priority => 10) }
+  
+  p stream.disco_items_for('xmpp.dev')
+  p stream.disco_info_for('xmpp.dev')
+  
+  stream.send {|x| x.presence(:type => :unavailable) }
+end
+=end
+
+
+# a client
+Cancer::Stream.open(:jid => 'alice@xmpp.dev/bbb', :password => 'ihatethequeen', :xeps => %w( xep-0138 xep-0184 )) do |other|
+  other.controller do
+    
+    on { |e| e.xpath('/c:message/c:body', 'c' => Cancer::CLIENT_NS) }
+    def on_message_body(e)
+      # puts e.xml.first('/c:message/c:body').text
+    end
+    
+    on { |e| e.exception(Exception) }
+    def on_exception(event)
+      $stderr.puts "#{event.exception.class} -- #{event.exception.message}\n#{event.exception.backtrace.join("\n")}"
+      $stderr.flush
+    end
+    
+  end
+  other.send {|x| x.presence(:priority => 10) }
+  
+  Cancer::Stream.open(:jid => 'alice@xmpp.dev/aaa', :password => 'ihatethequeen', :xeps => %w( xep-0138 xep-0184 )) do |stream|
+    
+    $lock = Cancer::Lock.new
+    $count = $total = 0
+    
+    stream.controller do
+      
+      on { |e| e.xpath('/c:message', 'c' => Cancer::CLIENT_NS) }
+      def count_receipts(e)
+        $count += 1
+        if $count == $total
+          $lock.continue!
+        end
+      end
+      
+      on { |e| e.exception(Exception) }
+      def on_exception(event)
+        $stderr.puts "#{event.exception.class} -- #{event.exception.message}\n#{event.exception.backtrace.join("\n")}"
+        $stderr.flush
+      end
+      
+    end
+    
+    stream.send {|x| x.presence(:priority => 5) }
+    
+    1000.times do
+      $total += 1
+      stream.send_message('alice@xmpp.dev/bbb') do |x|
+        x.body "Hello there #{$total}"
+        x.request_receipt
+      end
+    end
+    
+    $lock.wait!
+    stream.send {|x| x.presence(:type => :unavailable) }
+    
+  end
+  
+  other.send {|x| x.presence(:type => :unavailable) }
+end
+
+# a component
+Cancer::Stream.open(:jid => 'taurus.xmpp.dev', :password => 'taurus', :server => 'xmpp.dev', :port => 5275, :xeps => %w( xep-0114 )) do |stream|
+  stream.send {|x| x.presence(:priority => 5) { x.show } }
+  sleep 5
+  stream.send {|x| x.presence(:priority => 5, :type => :unavailable) }
+end

data/examples/example_2.rb

@@ -0,0 +1,20 @@
+require '../lib/cancer'
+
+# Cancer.logger.level = Logger::WARN
+
+# a client
+Cancer::Stream.open(:jid => 'alice@xmpp.dev/bbb', :password => 'ihatethequeen', :xeps => %w(   xep-0096 xep-0065 xep-0115 xep-0047 ), :server => 'xmpp.dev') do |other|
+  other.controller do
+    
+    on { |e| e.si_file(:filename => /\.gem$/) }
+    def transfer_gem(e)
+      e.accept! :path => File.join(File.dirname(__FILE__), e.ft[:name])
+    end
+    
+  end
+  other.send {|x| x.presence(:priority => 10) }
+  
+  sleep 600
+  
+  other.send {|x| x.presence(:type => :unavailable) }
+end

data/examples/example_em.rb

@@ -0,0 +1,11 @@
+require '../lib/cancer'
+
+options = { :jid => 'alice@xmpp.dev/bbb', :password => 'ihatethequeen',
+  :adapter => Cancer::Adapters::EM, :xeps => %w( xep-0184 xep-0138 ) }
+  
+EM.run do
+  stream = Cancer::Stream.new(options)
+  stream.use lambda { |x| puts x.first('c:body').text rescue :next }
+  stream.use lambda { |x| :halt }
+  EM.defer { stream.open ; stream.send {|x| x.presence(:priority => 5) } }
+end

data/examples/example_em_helper.rb

@@ -0,0 +1,23 @@
+require '../lib/cancer'
+
+Cancer::Stream.open(:jid => 'alice@xmpp.dev/aaa', :password => 'ihatethequeen', :xeps => %w( xep-0138 xep-0184 )) do |stream|
+  lock = Cancer::Lock.new
+  count = total = 0
+  stream.use lambda { |x| x.first('/c:message') { |x| count += 1 ; lock.continue! if count == total } }
+  stream.use lambda { |x| :halt }
+
+  
+  stream.send {|x| x.presence(:priority => 10) }
+  
+  1000.times do
+    total += 1
+    stream.send_message('alice@xmpp.dev/bbb') do |x|
+      x.body "Hello there"
+      x.request_receipt
+    end
+  end
+  
+  lock.wait!
+  stream.send {|x| x.presence(:type => :unavailable) }
+  
+end

data/examples/example_im_roster.rb

@@ -0,0 +1,26 @@
+require '../lib/cancer'
+
+# Cancer.logger.level = Logger::WARN
+
+Cancer::Stream.open(:jid => 'alice@xmpp.dev/aaa', :password => 'ihatethequeen', :xeps => %w( im ), :server => 'xmpp.dev') do |stream|
+  
+  stream.controller do
+    
+    on { |e| e.subscription_request }
+    def accept_subscriptions(e)
+      roster.save(e.sender, :subscription => :subscribed)
+      roster.save(e.sender, :subscription => true)
+    end
+    
+  end
+  
+  stream.send {|x| x.presence(:priority => 5) }
+  
+  stream.roster.save('simon@xmpp.dev', :name => 'Simon Menke', :groups => %w( Mr.\ Henry Friends ))
+  # stream.roster.save('simon@xmpp.dev', :subscription => false)
+  stream.roster.each do |item|
+    p item
+  end
+  
+  stream.send {|x| x.presence(:type => :unavailable) }
+end

data/examples/example_xep_0004.rb

@@ -0,0 +1,124 @@
+require '../lib/cancer'
+NS = 'jabber:x:data'
+
+
+
+form = Nokogiri::XML.parse(%{
+<x xmlns='jabber:x:data' type='form'>
+  <title>Bot Configuration</title>
+  <instructions>Fill out this form to configure your new bot!</instructions>
+  <field type='hidden'
+         var='FORM_TYPE'>
+    <value>jabber:bot</value>
+  </field>
+  <field type='fixed'><value>Section 1: Bot Info</value></field>
+  <field type='text-single'
+         label='The name of your bot'
+         var='botname'/>
+  <field type='text-multi'
+         label='Helpful description of your bot'
+         var='description'/>
+  <field type='boolean'
+         label='Public bot?'
+         var='public'>
+    <required/>
+  </field>
+  <field type='text-private'
+         label='Password for special access'
+         var='password'/>
+  <field type='fixed'><value>Section 2: Features</value></field>
+  <field type='list-multi'
+         label='What features will the bot support?'
+         var='features'>
+    <option label='Contests'><value>contests</value></option>
+    <option label='News'><value>news</value></option>
+    <option label='Polls'><value>polls</value></option>
+    <option label='Reminders'><value>reminders</value></option>
+    <option label='Search'><value>search</value></option>
+    <value>news</value>
+    <value>search</value>
+  </field>
+  <field type='fixed'><value>Section 3: Subscriber List</value></field>
+  <field type='list-single'
+         label='Maximum number of subscribers'
+         var='maxsubs'>
+    <value>20</value>
+    <option label='10'><value>10</value></option>
+    <option label='20'><value>20</value></option>
+    <option label='30'><value>30</value></option>
+    <option label='50'><value>50</value></option>
+    <option label='100'><value>100</value></option>
+    <option label='None'><value>none</value></option>
+  </field>
+  <field type='fixed'><value>Section 4: Invitations</value></field>
+  <field type='jid-multi'
+         label='People to invite'
+         var='invitelist'>
+    <desc>Tell all your friends about your new bot!</desc>
+  </field>
+</x>}).root
+
+# form_def = FormDefinition.load(form)
+form = Cancer::XEP_0004::Form.load(form)
+puts form.to_xml(:verbose => true)
+p [:valid, form.valid?]
+form.each do |k, v|
+  p [k, v]
+end
+
+form = Nokogiri::XML.parse(%{
+<x xmlns='jabber:x:data' type='result'>
+  <title>Joogle Search: verona</title>
+  <reported>
+    <field var='name' label="Website" />
+    <field var='url' label="Location" />
+  </reported>
+  <item>
+    <field var='name'>
+      <value>Comune di Verona - Benvenuti nel sito ufficiale</value>
+    </field>
+    <field var='url'>
+      <value>http://www.comune.verona.it/</value>
+    </field>
+  </item>
+  <item>
+    <field var='name'>
+      <value>benvenuto!</value>
+    </field>
+    <field var='url'>
+      <value>http://www.hellasverona.it/</value>
+    </field>
+  </item>
+  <item>
+    <field var='name'>
+      <value>Universita degli Studi di Verona - Home Page</value>
+    </field>
+    <field var='url'>
+      <value>http://www.univr.it/</value>
+    </field>
+  </item>
+  <item>
+    <field var='name'>
+      <value>Aeroporti del Garda</value>
+    </field>
+    <field var='url'>
+      <value>http://www.aeroportoverona.it/</value>
+    </field>
+  </item>
+  <item>
+    <field var='name'>
+      <value>Veronafiere - fiera di Verona</value>
+    </field>
+    <field var='url'>
+      <value>http://www.veronafiere.it/</value>
+    </field>
+  </item>
+</x>}).root
+form = Cancer::XEP_0004::Form.load(form)
+puts form.to_xml(:verbose => true)
+p [:valid, form.valid?]
+form.items.each do |item|
+  item.each do |k, v|
+    p [k, v]
+  end
+end