cancer 0.1.0.a1

data/lib/cancer/xeps/xep_0184_receipts.rb

@@ -0,0 +1,40 @@
+
+module Cancer
+  # Message Receipts
+  module XEP_0184
+    include Cancer::XEP
+    
+    NS = 'urn:xmpp:receipts'
+    
+    dependency 'core'
+    
+    def self.enhance_stream(stream)
+      stream.extend_builder do
+        include Cancer::XEP_0184::Builder
+      end
+      stream.install_controller(Cancer::XEP_0184::Controller)
+    end
+    
+    module Builder
+      
+      def request_receipt
+        request :xmlns => NS
+      end
+      
+    end
+    
+    class Controller < Cancer::Controller
+      
+      priority 1000
+      
+      on { |e| e.xpath('/c:message/n:request', 'n' => NS, 'c' => CLIENT_NS) }
+      def respond_with_received(e)
+        send_message(e.sender, nil, e.id) do |x|
+          x.received :xmlns => NS
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/cancer/xeps/xep_0199_ping.rb

@@ -0,0 +1,41 @@
+
+module Cancer
+  # XMPP Ping
+  # http://xmpp.org/extensions/xep-0199.html
+  module XEP_0199
+    include Cancer::XEP
+    
+    NS = 'urn:xmpp:ping'
+    
+    dependency 'core'
+    dependency 'xep-0030'
+    
+    def self.enhance_stream(stream)
+      stream.extend_stream do
+        include Cancer::XEP_0199::StreamHelpers
+      end
+      stream.install_controller(Cancer::XEP_0199::Controller)
+      stream.disco.feature(NS)
+    end
+    
+    module StreamHelpers
+      
+      def ping(to)
+        send_iq(to) do |x|
+          x.ping(:xmlns => NS)
+        end
+      end
+      
+    end
+    
+    class Controller < Cancer::Controller
+      
+      on { |e| e.xpath('/c:iq/p:ping', 'p' => NS, 'c' => CLIENT_NS) }
+      def pong(e)
+        send_iq(e.sender, :result, e.id)
+      end
+      
+    end
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+-f specdoc
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/cancer')
+
+module Kernel
+  def hp(object)
+    puts "<pre>"+object.inspect.gsub('<', '&lt;')+"</pre>"
+  end
+end
+
+Cancer::Spec.debug  = false
+Cancer.logger.level = Logger::FATAL
+
+Spec::Runner.configure do |config|
+  config.include(Cancer::Spec)
+end

data/spec/stream/stanza_errors_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cancer::StanzaError do
+  
+  it "should be raised when a stream error is received" do
+    dialog_with do |stream|
+      
+      lambda do
+        stream.send_iq('knave@wonderland.lit')
+      end.should raise_error(Cancer::StanzaModifyError)
+      
+    end.should_produce_transcript do |t|
+      t.out %{<iq type="get" to="knave@wonderland.lit" id="cancer-3"/>}
+      t.in  %{<iq type="error" to="alice@wonderland.lit" id="cancer-3"><error type="modify"><bad-request xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" /></error></iq>}
+    end
+  end
+  
+  it "should contain error conditions" do
+    dialog_with do |stream|
+      
+      lambda do
+        stream.send_iq('knave@wonderland.lit')
+      end.should raise_error(Cancer::StanzaModifyError) { |error|
+        error.conditions.should_not be_empty
+        error.conditions.first.name.should == 'bad-request'
+      }
+      
+    end.should_produce_transcript do |t|
+      t.out %{<iq type="get" to="knave@wonderland.lit" id="cancer-3"/>}
+      t.in  %{<iq type="error" to="alice@wonderland.lit" id="cancer-3"><error type="modify"><bad-request xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" /></error></iq>}
+    end
+  end
+  
+  it "should have message equal to error/text if present" do
+    dialog_with do |stream|
+      
+      lambda do
+        stream.send_iq('knave@wonderland.lit')
+      end.should raise_error(Cancer::StanzaModifyError, 'My error message')
+      
+    end.should_produce_transcript do |t|
+      t.out %{<iq type="get" to="knave@wonderland.lit" id="cancer-3"/>}
+      t.in  %{<iq type="error" to="alice@wonderland.lit" id="cancer-3"><error type="modify"><bad-request xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" /><text xmlns='urn:ietf:params:xml:ns:xmpp-streams'>My error message</text></error></iq>}
+    end
+  end
+  
+end

data/spec/stream/stream_errors_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cancer::StreamError do
+  
+  it "should be raised when a stream error is received" do
+    lambda do
+      dialog_with do |stream|
+        
+      end.should_produce_transcript do |t|
+        t.in  %{<stream:error><bad-format xmlns='urn:ietf:params:xml:ns:xmpp-streams'/></stream:error>}
+      end
+    end.should raise_error(Cancer::StreamError)
+  end
+  
+  it "should contain error conditions" do
+    lambda do
+      dialog_with do |stream|
+        
+      end.should_produce_transcript do |t|
+        t.in  %{<stream:error><bad-format xmlns='urn:ietf:params:xml:ns:xmpp-streams'/></stream:error>}
+      end
+    end.should raise_error(Cancer::StreamError) { |error|
+      error.conditions.should_not be_empty
+      error.conditions.first.name.should == 'bad-format'
+    }
+  end
+  
+  it "should have message equal to stream:error/text if present" do
+    lambda do
+      dialog_with do |stream|
+        
+      end.should_produce_transcript do |t|
+        t.in  %{<stream:error><bad-format xmlns='urn:ietf:params:xml:ns:xmpp-streams'/><text xmlns='urn:ietf:params:xml:ns:xmpp-streams'>My error message</text></stream:error>}
+      end
+    end.should raise_error(Cancer::StreamError, 'My error message')
+  end
+  
+end

data/spec/stream/stream_initialization_spec.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cancer::Stream do
+  
+  it "should initiate with tls sasl bind and session" do
+    dialog do |adapter|
+      Cancer::Stream.open(:adapter => adapter,
+        :jid => 'alice@wonderland.lit', :password => 'ihatethequeen') { }
+    end.should_produce_transcript do |t|
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+  <starttls xmlns="urn:ietf:params:xml:ns:xmpp-tls"> 
+    <optional/> 
+  </starttls> 
+  <mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl"> 
+    <mechanism>PLAIN</mechanism>
+    <required/> 
+  </mechanisms> 
+</stream:features>}
+
+      t.out %{<starttls xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>}
+      t.in  %{<proceed xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>}
+            
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+  <mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl"> 
+    <mechanism>PLAIN</mechanism>
+    <required/> 
+  </mechanisms> 
+</stream:features>}
+      
+      t.out %{<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="PLAIN">AGFsaWNlQHdvbmRlcmxhbmQubGl0AGloYXRldGhlcXVlZW4=</auth>}
+      t.in  %{<success xmlns="urn:ietf:params:xml:ns:xmpp-sasl" />}
+      
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+    <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"> 
+      <required/> 
+    </bind> 
+    <session xmlns="urn:ietf:params:xml:ns:xmpp-session"> 
+      <optional/> 
+    </session> 
+</stream:features>}
+
+      t.out %{<iq type="set" id="cancer-1"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/></iq>}
+      t.in  %{<iq type="result" id="cancer-1">
+        <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
+        <jid>alice@wonderland.lit/rabbithole</jid></bind></iq>}
+      
+      t.out %{<iq type="set" id="cancer-2"><session xmlns="urn:ietf:params:xml:ns:xmpp-session"/></iq>}
+      t.in  %{<iq type="result" id="cancer-2" />}
+      
+      t.close_stream
+
+    end
+  end
+  
+  it "should initiate with sasl bind and session" do
+    dialog do |adapter|
+      Cancer::Stream.open(:adapter => adapter,
+        :jid => 'alice@wonderland.lit', :password => 'ihatethequeen') { }
+    end.should_produce_transcript do |t|
+      
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+  <mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl"> 
+    <mechanism>PLAIN</mechanism>
+    <required/> 
+  </mechanisms> 
+</stream:features>}
+      
+      t.out %{<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="PLAIN">AGFsaWNlQHdvbmRlcmxhbmQubGl0AGloYXRldGhlcXVlZW4=</auth>}
+      t.in  %{<success xmlns="urn:ietf:params:xml:ns:xmpp-sasl" />}
+      
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+    <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"> 
+      <required/> 
+    </bind> 
+    <session xmlns="urn:ietf:params:xml:ns:xmpp-session"> 
+      <optional/> 
+    </session> 
+</stream:features>}
+
+      t.out %{<iq type="set" id="cancer-1"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/></iq>}
+      t.in  %{<iq type="result" id="cancer-1">
+        <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
+        <jid>alice@wonderland.lit/rabbithole</jid></bind></iq>}
+      
+      t.out %{<iq type="set" id="cancer-2"><session xmlns="urn:ietf:params:xml:ns:xmpp-session"/></iq>}
+      t.in  %{<iq type="result" id="cancer-2" />}
+      
+      t.close_stream
+
+    end
+  end
+  
+  it "should initiate with bind and session" do
+    dialog do |adapter|
+      Cancer::Stream.open(:adapter => adapter,
+        :jid => 'alice@wonderland.lit', :password => 'ihatethequeen') { }
+    end.should_produce_transcript do |t|
+      
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+    <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"> 
+      <required/> 
+    </bind> 
+    <session xmlns="urn:ietf:params:xml:ns:xmpp-session"> 
+      <optional/> 
+    </session> 
+</stream:features>}
+
+      t.out %{<iq type="set" id="cancer-1"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/></iq>}
+      t.in  %{<iq type="result" id="cancer-1">
+        <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
+        <jid>alice@wonderland.lit/rabbithole</jid></bind></iq>}
+      
+      t.out %{<iq type="set" id="cancer-2"><session xmlns="urn:ietf:params:xml:ns:xmpp-session"/></iq>}
+      t.in  %{<iq type="result" id="cancer-2" />}
+      
+      t.close_stream
+
+    end
+  end
+  
+  it "should initiate with bind" do
+    dialog do |adapter|
+      Cancer::Stream.open(:adapter => adapter,
+        :jid => 'alice@wonderland.lit', :password => 'ihatethequeen') { }
+    end.should_produce_transcript do |t|
+      
+      t.start_stream('alice@wonderland.lit')
+      t.in %{<stream:features> 
+    <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"> 
+      <required/> 
+    </bind>
+</stream:features>}
+
+      t.out %{<iq type="set" id="cancer-1"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/></iq>}
+      t.in  %{<iq type="result" id="cancer-1">
+        <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
+        <jid>alice@wonderland.lit/rabbithole</jid></bind></iq>}
+      
+      
+      t.close_stream
+
+      t.verify { |stream| stream.options[:jid].to_s.should == "alice@wonderland.lit/rabbithole" }
+    end
+  end
+  
+  it "should initiate " do
+    dialog_with() do |stream|
+      
+    end.should_produce_transcript do |t|
+      t.verify { |stream| stream.options[:jid].to_s.should == "alice@wonderland.lit/rabbithole" }
+    end
+  end
+  
+end

data/spec/xep_0050/local_spec.rb

@@ -0,0 +1,165 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Cancer::XEP_0050, '#local' do
+  
+  it "handles command events" do
+    dialog_with(:xeps => %w( xep-0050 )) do |stream|
+      
+      stream.controller do
+        
+        on { |e| e.command(:config) }
+        def config(e)
+          e.session.instance_variable_set :@id, 'config-1' # mock the session id
+          
+          e.session.complete! do |x|
+            x.note(:type => 'info') do
+              x.text "Service 'httpd' has been configured."
+            end
+          end
+          
+        ensure
+          $waiting_thread.wakeup
+        end
+        
+      end
+      
+      $waiting_thread = Thread.current and Thread.stop
+      
+    end.should_produce_transcript do |t|
+      t.in  %{<iq type="set" from="knave@wonderland.lit" id="cancer-3"><command xmlns='http://jabber.org/protocol/commands' node='config' action='execute'/></iq>}
+      t.out %{<iq type='result' to='knave@wonderland.lit' id='cancer-3'><command xmlns='http://jabber.org/protocol/commands' sessionid='config-1' node='config' status='completed'><note type='info'>Service 'httpd' has been configured.</note></command></iq>}
+    end
+  end
+  
+  it "handles multistage commands" do
+    dialog_with(:xeps => %w( xep-0050 )) do |stream|
+      
+      stream.controller do
+        
+        define_form 'config.form' do |form|
+          form.title = "Setup your profile"
+          form.instructions << "Enter your profile in the fields below."
+          
+          form.define :name do |f|
+            f.type     = :'text-single'
+            f.required = true
+            f.label    = "Name"
+          end
+          
+          form.define :sex do |f|
+            f.type     = :'list-single'
+            f.add_option 'm', 'Man'
+            f.add_option 'w', 'Woman'
+            f.add_option 'o', 'Other'
+            f.label    = "Sex"
+          end
+          
+          form.define :jid do |f|
+            f.type     = :'jid-single'
+            f.required = true
+            f.add_option 'alice@wonderland.lit'
+            f.add_option 'knave@wonderland.lit'
+            f.label    = "JID"
+            f.description = 'Choose your preferred jabber address.'
+          end
+        end
+        
+        on { |e| e.command(:config) }
+        def config(e)
+          
+          e.session.next! :run, 'config.form', :values => { :name => 'Simon Menke'}
+          
+          throw :halt
+        rescue Exception => e
+          $action_exception = e
+        ensure
+          $waiting_thread.wakeup
+        end
+        
+        on { |e| e.command(:config, :stage => :run) }
+        def config_run(e)
+          
+          e.session.complete! do |x|
+            x.note(:type => 'info') do
+              x.text "Your profile has been updated."
+            end
+          end
+          
+        rescue Exception => e
+          $action_exception = e
+        ensure
+          $waiting_thread.wakeup
+        end
+        
+      end
+      
+      $waiting_thread = Thread.current and Thread.stop
+      raise $action_exception if $action_exception
+      
+      $waiting_thread = Thread.current and Thread.stop
+      raise $action_exception if $action_exception
+      
+    end.should_produce_transcript do |t|
+      t.in  %{
+<iq type="set" from="knave@wonderland.lit" id="cancer-3">
+  <command xmlns="http://jabber.org/protocol/commands" node="config" action="execute" sessionid="config-1"/>
+</iq>}
+
+      t.out %{
+<iq type="result" to="knave@wonderland.lit" id="cancer-3">
+  <command xmlns="http://jabber.org/protocol/commands" status="executing" node="config" sessionid="config-1">
+    <actions/>
+    <x xmlns="jabber:x:data" type="form">
+      <title>Setup your profile</title>
+      <instructions>Enter your profile in the fields below.</instructions>
+      <field label="Name" var="name">
+        <required/>
+        <value>Simon Menke</value>
+      </field>
+      <field type="list-single" label="Sex" var="sex">
+        <option label="Woman">
+          <value>w</value>
+        </option>
+        <option label="Man">
+          <value>m</value>
+        </option>
+        <option label="Other">
+          <value>o</value>
+        </option>
+      </field>
+      <field type="jid-single" label="JID" var="jid">
+        <required/>
+        <desc>Choose your preferred jabber address.</desc>
+        <option>
+          <value>knave@wonderland.lit</value>
+        </option>
+        <option>
+          <value>alice@wonderland.lit</value>
+        </option>
+      </field>
+    </x>
+  </command>
+</iq>}
+
+      t.in %{
+<iq type="set" from="knave@wonderland.lit" id="cancer-4">
+  <command xmlns="http://jabber.org/protocol/commands" action="execute" node="config" sessionid="config-1">
+    <x xmlns="jabber:x:data" type="submit">
+      <field var="name">
+        <value>Hans Spooren</value>
+      </field>
+      <field type="list-single" var="sex">
+        <value>m</value>
+      </field>
+      <field type="jid-single" var="jid">
+        <value>knave@wonderland.lit</value>
+      </field>
+    </x>
+  </command>
+</iq>}
+
+      t.out %{<iq type='result' to='knave@wonderland.lit' id='cancer-4'><command xmlns='http://jabber.org/protocol/commands' sessionid='config-1' node='config' status='completed'><note type='info'>Your profile has been updated.</note></command></iq>}
+    end
+  end
+  
+end