safubot 0.0.2 → 0.0.3

data/.yardoc/checksums

@@ -1,9 +1,9 @@
 lib/safubot.rb da2c6f1fa7e7a17064469e0a5409f5dc2a6ec7ab
-lib/safubot/bot.rb a191fb9b972ebf19e4badc110658b64bb02f92ff
-lib/safubot/log.rb 132a7d9090c8c405b409fa12868244eb8de7b15a
-lib/safubot/xmpp.rb 50b683fbfcaef60d07102dd893df0a277c110f89
-lib/safubot/evented.rb 87b6fba0d6e65e5abf09e7606e1fd502713da2e7
+lib/safubot/bot.rb 91a9512ec77a70a4a3bf3d1235d81f546cae7765
+lib/safubot/log.rb c341c5e6a54a908ee8431b5aac2aa7c3472eaeed
+lib/safubot/xmpp.rb 253c1ef4b93f85f4cfd55d8fb561984eb1bcf151
+lib/safubot/evented.rb 8e90ab5b812eb12113095a8bdde7a96ba0e62d1f
 lib/safubot/version.rb 67c555f319499e0bcc596a73152df9f0797da190
-lib/safubot/twitter.rb 4574d47793303bc087f14b7c4bc7b5f0e7c938c7
-lib/safubot/known_user.rb 06960025ae9bf08570ab743f64a7b22ac1687542
-lib/safubot/test_helper.rb 870fe48e4efd009690b8cd8f29203491610ca8bb
+lib/safubot/twitter.rb 414b3cabef1611923f18d779d279ce0b6f3128b8
+lib/safubot/known_user.rb 8e2ce383a220c28d8729540be7fc0dfeca3f48fc
+lib/safubot/test_helper.rb 892633f1707378964059f7209da7771669fdb993

data/README.md

@@ -1,4 +1,4 @@
-# safubot - an evented chatbot framework for Ruby
+# safubot - an event-driven chatbot framework for Ruby
 
 ## <a name="overview">Overview</a>
 Safubot is a chatbot framework for Twitter and XMPP which aims to abstract away the idiosyncracies of the underlying APIs, allowing you to focus on writing request-processing logic. Of course, if you want to use  service-specific features (such as responding to timeline tweets) it lets you do that too!
@@ -62,10 +62,15 @@ Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to instal
 	  end
 	end
 
-	# You can run this from inside another EventMachine loop if
-	# you don't want it to block indefinitely.
+	# This will fork the Twitter/XMPP streaming processes as needed
+	# and then wait for them. You can call run_nowait if you want
+	# a non-blocking form.
 	NiftyBot.new.run
 
+## <a name="logging">Logging</a>
+Safubot::Log behaves as a Logger instance and will write to stdout by default. You can also tell it to write to a file:
+	Safubot::Log.path = "/some/cool/logfile"
+
 ## <a name="example">Specific Examples</a>
 
 ### Find the last processed request from a user
@@ -86,7 +91,7 @@ Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to instal
 	  end
 	end
 
-### Start an unprompted conversation with an XMPP user.
+### Start an unprompted conversation with an XMPP user
 
 	@xmpp.on(:ready) do
 	  @xmpp.tell('^_^@jabber.org', "You'd best be maintaining safubot!")

data/doc/Safubot.html

@@ -140,6 +140,41 @@ Returns the value of attribute mode.
 
 
 
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#error_report-instance_method" title="#error_report (instance method)">- (Object) <strong>error_report</strong>(e) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+Pretty-printing of Exceptions and their backtraces.
+</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
 
   <div id="class_attr_details" class="attr_details">
     <h2>Class Attribute Details</h2>
@@ -190,10 +225,77 @@ Returns the value of attribute mode
   </div>
 
 
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="error_report-instance_method">
+  
+    - (<tt>Object</tt>) <strong>error_report</strong>(e) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Pretty-printing of Exceptions and their backtraces.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>e</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+An Exception to print.
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 7</span>
+
+<span class='kw'>def</span> <span class='id error_report'>error_report</span><span class='lparen'>(</span><span class='id e'>e</span><span class='rparen'>)</span>
+	<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='period'>.</span><span class='id backtrace'>backtrace</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n\t</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
 </div>
     
     <div id="footer">
-  Generated on Mon Nov 28 20:20:03 2011 by 
+  Generated on Tue Nov 29 11:44:04 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.9.2).
 </div>

data/doc/Safubot/Bot.html

@@ -98,7 +98,20 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+The main event-processing class. You are encouraged to inherit from this
+class when building your own bot, but delegation is also entirely feasible.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
   
   
@@ -245,7 +258,7 @@ A generic &#8220;respond immediately&#8221; interface.
 
   
     <span class="summary_desc"><div class='inline'><p>
-Wraps EM::defer with error handling and response pushing for the given
+Wraps Thread.new with error handling and response pushing for the given
 request.
 </p>
 </div></span>
@@ -256,7 +269,7 @@ request.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#cycle-instance_method" title="#cycle (instance method)">- (Object) <strong>cycle</strong> </a>
+      <a href="#dispatch-instance_method" title="#dispatch (instance method)">- (Object) <strong>dispatch</strong>(resp) </a>
     
 
     
@@ -269,7 +282,10 @@ request.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Performs appropriate dispatch operation for response type.
+</p>
+</div></span>
   
 </li>
 
@@ -277,7 +293,7 @@ request.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#dispatch-instance_method" title="#dispatch (instance method)">- (Object) <strong>dispatch</strong>(resp) </a>
+      <a href="#enable_twitter-instance_method" title="#enable_twitter (instance method)">- (Object) <strong>enable_twitter</strong>(opts = {}) </a>
     
 
     
@@ -290,7 +306,10 @@ request.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Initialises Twitter-related functionality.
+</p>
+</div></span>
   
 </li>
 
@@ -298,7 +317,7 @@ request.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#enable_twitter-instance_method" title="#enable_twitter (instance method)">- (Object) <strong>enable_twitter</strong>(opts = {}) </a>
+      <a href="#enable_xmpp-instance_method" title="#enable_xmpp (instance method)">- (Object) <strong>enable_xmpp</strong>(options = {}) </a>
     
 
     
@@ -311,7 +330,10 @@ request.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Initialises XMPP-related functionality.
+</p>
+</div></span>
   
 </li>
 
@@ -319,12 +341,14 @@ request.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#enable_xmpp-instance_method" title="#enable_xmpp (instance method)">- (Object) <strong>enable_xmpp</strong>(options = {}) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Bot) <strong>initialize</strong>(options = {}) </a>
     
 
     
   </span>
   
+    <span class="note title constructor">constructor</span>
+  
   
   
   
@@ -332,7 +356,10 @@ request.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+A new instance of Bot.
+</p>
+</div></span>
   
 </li>
 
@@ -340,14 +367,12 @@ request.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Bot) <strong>initialize</strong>(options = {}) </a>
+      <a href="#process-instance_method" title="#process (instance method)">- (Object) <strong>process</strong> </a>
     
 
     
   </span>
   
-    <span class="note title constructor">constructor</span>
-  
   
   
   
@@ -356,7 +381,7 @@ request.
 
   
     <span class="summary_desc"><div class='inline'><p>
-A new instance of Bot.
+Goes through each unprocessed Request and submits it for processing.
 </p>
 </div></span>
   
@@ -366,7 +391,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#process-instance_method" title="#process (instance method)">- (Object) <strong>process</strong> </a>
+      <a href="#process_request-instance_method" title="#process_request (instance method)">- (Object) <strong>process_request</strong>(req) </a>
     
 
     
@@ -379,7 +404,10 @@ A new instance of Bot.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Processes an individual request (synchronously).
+</p>
+</div></span>
   
 </li>
 
@@ -387,7 +415,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#process_request-instance_method" title="#process_request (instance method)">- (Object) <strong>process_request</strong>(req) </a>
+      <a href="#pull-instance_method" title="#pull (instance method)">- (Object) <strong>pull</strong> </a>
     
 
     
@@ -400,7 +428,11 @@ A new instance of Bot.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+This pulls requests from passive non-streaming sources (currently, the
+Twitter AJAX API).
+</p>
+</div></span>
   
 </li>
 
@@ -408,7 +440,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#pull-instance_method" title="#pull (instance method)">- (Object) <strong>pull</strong> </a>
+      <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong> </a>
     
 
     
@@ -421,7 +453,10 @@ A new instance of Bot.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Dispatches all undispatched Responses.
+</p>
+</div></span>
   
 </li>
 
@@ -429,7 +464,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong> </a>
+      <a href="#request_error-instance_method" title="#request_error (instance method)">- (Object) <strong>request_error</strong>(req, e) </a>
     
 
     
@@ -442,7 +477,10 @@ A new instance of Bot.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Records an error and emits a corresponding :request_error event.
+</p>
+</div></span>
   
 </li>
 
@@ -450,7 +488,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#request_error-instance_method" title="#request_error (instance method)">- (Object) <strong>request_error</strong>(req, e) </a>
+      <a href="#respond-instance_method" title="#respond (instance method)">- (Object) <strong>respond</strong>(req, text) </a>
     
 
     
@@ -463,7 +501,10 @@ A new instance of Bot.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Adds a response to the queue.
+</p>
+</div></span>
   
 </li>
 
@@ -471,7 +512,7 @@ A new instance of Bot.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#respond-instance_method" title="#respond (instance method)">- (Object) <strong>respond</strong>(req, text) </a>
+      <a href="#respond_now-instance_method" title="#respond_now (instance method)">- (Object) <strong>respond_now</strong>(req, text) </a>
     
 
     
@@ -485,7 +526,7 @@ A new instance of Bot.
 
   
     <span class="summary_desc"><div class='inline'><p>
-Adds a response to the queue.
+Respond + push.
 </p>
 </div></span>
   
@@ -495,7 +536,7 @@ Adds a response to the queue.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#respond_now-instance_method" title="#respond_now (instance method)">- (Object) <strong>respond_now</strong>(req, text) </a>
+      <a href="#run-instance_method" title="#run (instance method)">- (Object) <strong>run</strong> </a>
     
 
     
@@ -509,7 +550,7 @@ Adds a response to the queue.
 
   
     <span class="summary_desc"><div class='inline'><p>
-Respond + push.
+Calls run_nowait and then waits for all child processes.
 </p>
 </div></span>
   
@@ -519,7 +560,7 @@ Respond + push.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#run-instance_method" title="#run (instance method)">- (Object) <strong>run</strong> </a>
+      <a href="#run_nowait-instance_method" title="#run_nowait (instance method)">- (Object) <strong>run_nowait</strong> </a>
     
 
     
@@ -532,7 +573,11 @@ Respond + push.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Runs an initial request-processing loop and then forks the streaming
+processes.
+</p>
+</div></span>
   
 </li>
 
@@ -553,7 +598,10 @@ Respond + push.
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>
+Shuts down the streaming processes.
+</p>
+</div></span>
   
 </li>
 
@@ -599,16 +647,16 @@ A new instance of Bot
       <pre class="lines">
 
 
-169
-170
-171
-172
-173
-174
-175</pre>
+190
+191
+192
+193
+194
+195
+196</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 169</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 190</span>
 
 <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id defaults'>defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:database</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>safubot</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
@@ -655,12 +703,12 @@ Returns the value of attribute opts
       <pre class="lines">
 
 
-38
-39
-40</pre>
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id opts'>opts</span>
   <span class='ivar'>@opts</span>
@@ -698,12 +746,12 @@ Returns the value of attribute twitter
       <pre class="lines">
 
 
-38
-39
-40</pre>
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id twitter'>twitter</span>
   <span class='ivar'>@twitter</span>
@@ -741,12 +789,12 @@ Returns the value of attribute xmpp
       <pre class="lines">
 
 
-38
-39
-40</pre>
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id xmpp'>xmpp</span>
   <span class='ivar'>@xmpp</span>
@@ -780,7 +828,48 @@ A generic &#8220;respond immediately&#8221; interface.
   </div>
 </div>
 <div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>text</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The body of a Request to process.
+</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>user</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The user sending the request. Defaults to
+KnownUser.by_name(&#8216;testing&#8217;)
+</p>
+</div>
+      
+    </li>
   
+</ul>
+
 
 </div><table class="source_code">
   <tr>
@@ -788,16 +877,16 @@ A generic &#8220;respond immediately&#8221; interface.
       <pre class="lines">
 
 
-54
-55
-56
-57
-58
-59
-60</pre>
+61
+62
+63
+64
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/test_helper.rb', line 54</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/test_helper.rb', line 61</span>
 
 <span class='kw'>def</span> <span class='id answer'>answer</span><span class='lparen'>(</span><span class='id text'>text</span><span class='comma'>,</span> <span class='id user'>user</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id user'>user</span> <span class='op'>||=</span> <span class='const'>KnownUser</span><span class='period'>.</span><span class='id by_name'>by_name</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>testing</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
@@ -821,7 +910,7 @@ A generic &#8220;respond immediately&#8221; interface.
 </p><div class="docstring">
   <div class="discussion">
     <p>
-Wraps EM::defer with error handling and response pushing for the given
+Wraps Thread.new with error handling and response pushing for the given
 request.
 </p>
 
@@ -875,23 +964,23 @@ The operation to be performed in a separate thread.
       <pre class="lines">
 
 
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129</pre>
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 119</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 138</span>
 
 <span class='kw'>def</span> <span class='id concurrently'>concurrently</span><span class='lparen'>(</span><span class='id req'>req</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
-  <span class='const'>EventMachine</span><span class='op'>::</span><span class='id defer'>defer</span> <span class='kw'>do</span>
+  <span class='const'>Thread</span><span class='period'>.</span><span class='id new'>new</span> <span class='kw'>do</span>
 	<span class='kw'>begin</span>
 	  <span class='id blk'>blk</span><span class='period'>.</span><span class='id call'>call</span>
 	<span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id e'>e</span>
@@ -907,78 +996,81 @@ The operation to be performed in a separate thread.
 </div>
     
       <div class="method_details ">
-  <p class="signature " id="cycle-instance_method">
+  <p class="signature " id="dispatch-instance_method">
   
-    - (<tt>Object</tt>) <strong>cycle</strong> 
+    - (<tt>Object</tt>) <strong>dispatch</strong>(resp) 
   
 
   
-</p><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Performs appropriate dispatch operation for response type.
+</p>
 
-112
-113
-114</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 112</span>
 
-<span class='kw'>def</span> <span class='id cycle'>cycle</span>
-  <span class='id pull'>pull</span><span class='semicolon'>;</span> <span class='id process'>process</span><span class='semicolon'>;</span> <span class='id push'>push</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
+  </div>
 </div>
-    
-      <div class="method_details ">
-  <p class="signature " id="dispatch-instance_method">
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
   
-    - (<tt>Object</tt>) <strong>dispatch</strong>(resp) 
+    <li>
+      
+        <span class='name'>resp</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+An undispatched Response.
+</p>
+</div>
+      
+    </li>
   
+</ul>
 
-  
-</p><table class="source_code">
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
-74
-75
-76
 77
 78
 79
 80
 81
-82</pre>
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 58</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 77</span>
 
 <span class='kw'>def</span> <span class='id dispatch'>dispatch</span><span class='lparen'>(</span><span class='id resp'>resp</span><span class='rparen'>)</span>
-  <span class='comment'># Performs appropriate dispatch operation for response type.
-</span>  <span class='kw'>begin</span>
+  <span class='kw'>begin</span>
 	<span class='id source'>source</span> <span class='op'>=</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id request'>request</span><span class='period'>.</span><span class='id source'>source</span>
 	<span class='kw'>if</span> <span class='const'>Safubot</span><span class='op'>::</span><span class='id mode'>mode</span> <span class='op'>!=</span> <span class='symbol'>:production</span>
 	  <span class='const'>Log</span><span class='period'>.</span><span class='id info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id source'>source</span><span class='period'>.</span><span class='id class'>class</span><span class='rbrace'>}</span><span class='tstring_content'> Response to </span><span class='embexpr_beg'>#{</span><span class='id source'>source</span><span class='period'>.</span><span class='id username'>username</span><span class='rbrace'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id resp'>resp</span><span class='period'>.</span><span class='id text'>text</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -1013,21 +1105,33 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Initialises Twitter-related functionality.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-154
-155
-156
-157
-158
-159</pre>
+174
+175
+176
+177
+178
+179</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 154</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 174</span>
 
 <span class='kw'>def</span> <span class='id enable_twitter'>enable_twitter</span><span class='lparen'>(</span><span class='id opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='ivar'>@twitter</span> <span class='op'>=</span> <span class='const'>Twitter</span><span class='op'>::</span><span class='const'>Bot</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id opts'>opts</span><span class='rparen'>)</span>
@@ -1047,22 +1151,34 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Initialises XMPP-related functionality.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-161
-162
-163
-164
-165
-166
-167</pre>
+182
+183
+184
+185
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 161</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 182</span>
 
 <span class='kw'>def</span> <span class='id enable_xmpp'>enable_xmpp</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id defaults'>defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:jid</span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='symbol'>:password</span> <span class='op'>=&gt;</span> <span class='kw'>nil</span> <span class='rbrace'>}</span>
@@ -1083,20 +1199,32 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Goes through each unprocessed Request and submits it for processing.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-88
-89
-90
-91
-92</pre>
+108
+109
+110
+111
+112</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 88</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 108</span>
 
 <span class='kw'>def</span> <span class='id process'>process</span>
   <span class='const'>Request</span><span class='period'>.</span><span class='id where'>where</span><span class='lparen'>(</span><span class='symbol'>:processed</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id req'>req</span><span class='op'>|</span>
@@ -1115,25 +1243,58 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Processes an individual request (synchronously).
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>req</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+An unprocessed Request.
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56</pre>
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 47</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 63</span>
 
 <span class='kw'>def</span> <span class='id process_request'>process_request</span><span class='lparen'>(</span><span class='id req'>req</span><span class='rparen'>)</span>
   <span class='kw'>begin</span>
@@ -1157,18 +1318,31 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+This pulls requests from passive non-streaming sources (currently, the
+Twitter AJAX API).
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-84
-85
-86</pre>
+103
+104
+105</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 84</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 103</span>
 
 <span class='kw'>def</span> <span class='id pull'>pull</span>
   <span class='ivar'>@twitter</span><span class='period'>.</span><span class='id pull'>pull</span>
@@ -1185,18 +1359,30 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Dispatches all undispatched Responses.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-108
-109
-110</pre>
+130
+131
+132</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 108</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 130</span>
 
 <span class='kw'>def</span> <span class='id push'>push</span>
   <span class='const'>Response</span><span class='period'>.</span><span class='id where'>where</span><span class='lparen'>(</span><span class='symbol'>:dispatched</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='period'>.</span><span class='id each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id method'>method</span><span class='lparen'>(</span><span class='symbol'>:dispatch</span><span class='rparen'>)</span><span class='rparen'>)</span>
@@ -1213,21 +1399,71 @@ The operation to be performed in a separate thread.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Records an error and emits a corresponding :request_error event.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>req</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The Request for which the error was encountered.
+</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>e</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+The caught Exception.
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-40
-41
-42
-43
-44
-45</pre>
+53
+54
+55
+56
+57
+58</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 40</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 53</span>
 
 <span class='kw'>def</span> <span class='id request_error'>request_error</span><span class='lparen'>(</span><span class='id req'>req</span><span class='comma'>,</span> <span class='id e'>e</span><span class='rparen'>)</span>
   <span class='const'>Log</span><span class='period'>.</span><span class='id error'>error</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error processing </span><span class='embexpr_beg'>#{</span><span class='id req'>req</span><span class='period'>.</span><span class='id source'>source</span><span class='period'>.</span><span class='id class'>class</span><span class='rbrace'>}</span><span class='tstring_content'> '</span><span class='embexpr_beg'>#{</span><span class='id req'>req</span><span class='period'>.</span><span class='id text'>text</span><span class='rbrace'>}</span><span class='tstring_content'>': </span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='rbrace'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='period'>.</span><span class='id backtrace'>backtrace</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n\t</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -1303,13 +1539,13 @@ Contents of the response.
       <pre class="lines">
 
 
-97
-98
-99
-100</pre>
+118
+119
+120
+121</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 97</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 118</span>
 
 <span class='kw'>def</span> <span class='id respond'>respond</span><span class='lparen'>(</span><span class='id req'>req</span><span class='comma'>,</span> <span class='id text'>text</span><span class='rparen'>)</span>
   <span class='const'>Log</span><span class='period'>.</span><span class='id info'>info</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id req'>req</span><span class='period'>.</span><span class='id user'>user</span><span class='period'>.</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id req'>req</span><span class='period'>.</span><span class='id text'>text</span><span class='rbrace'>}</span><span class='tstring_content'>\nsafubot: </span><span class='embexpr_beg'>#{</span><span class='id text'>text</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -1345,13 +1581,13 @@ Respond + push
       <pre class="lines">
 
 
-103
-104
-105
-106</pre>
+124
+125
+126
+127</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 103</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 124</span>
 
 <span class='kw'>def</span> <span class='id respond_now'>respond_now</span><span class='lparen'>(</span><span class='id req'>req</span><span class='comma'>,</span> <span class='id text'>text</span><span class='rparen'>)</span>
   <span class='id respond'>respond</span><span class='lparen'>(</span><span class='id req'>req</span><span class='comma'>,</span> <span class='id text'>text</span><span class='rparen'>)</span>
@@ -1369,51 +1605,92 @@ Respond + push
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Calls run_nowait and then waits for all child processes.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-131
-132
-133
-134
-135
-136
-137
-138
-139
-140
-141
-142
-143
-144
-145
-146</pre>
+158
+159
+160
+161
+162
+163
+164
+165</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 131</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 158</span>
 
 <span class='kw'>def</span> <span class='id run'>run</span>
-  <span class='const'>EventMachine</span><span class='op'>::</span><span class='id run'>run</span> <span class='kw'>do</span>
-	<span class='const'>EM</span><span class='op'>::</span><span class='id error_handler'>error_handler</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id e'>e</span><span class='op'>|</span>
-	  <span class='kw'>if</span> <span class='id e'>e</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Interrupt</span>
-		<span class='const'>Log</span><span class='period'>.</span><span class='id error'>error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Received interrupt, shutting down.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-		<span class='id stop'>stop</span>
-	  <span class='kw'>else</span>
-		<span class='const'>Log</span><span class='period'>.</span><span class='id error'>error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unhandled exception: </span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='rbrace'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='period'>.</span><span class='id backtrace'>backtrace</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-	  <span class='kw'>end</span>
-	<span class='kw'>end</span>
-
-	<span class='id cycle'>cycle</span>
-	<span class='ivar'>@twitter</span><span class='period'>.</span><span class='id run'>run</span> <span class='kw'>if</span> <span class='ivar'>@twitter</span>
-	<span class='ivar'>@xmpp</span><span class='period'>.</span><span class='id run'>run</span> <span class='kw'>if</span> <span class='ivar'>@xmpp</span>
+  <span class='id run_nowait'>run_nowait</span>
+  <span class='kw'>begin</span>
+	<span class='const'>Process</span><span class='period'>.</span><span class='id waitall'>waitall</span>
+  <span class='kw'>rescue</span> <span class='const'>Interrupt</span>
+	<span class='id stop'>stop</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="run_nowait-instance_method">
+  
+    - (<tt>Object</tt>) <strong>run_nowait</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Runs an initial request-processing loop and then forks the streaming
+processes.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+151
+152
+153
+154
+155</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 151</span>
+
+<span class='kw'>def</span> <span class='id run_nowait'>run_nowait</span>
+  <span class='id pull'>pull</span><span class='semicolon'>;</span> <span class='id process'>process</span><span class='semicolon'>;</span> <span class='id push'>push</span>
+  <span class='ivar'>@twitter</span><span class='period'>.</span><span class='id run'>run</span> <span class='kw'>if</span> <span class='ivar'>@twitter</span>
+  <span class='ivar'>@xmpp</span><span class='period'>.</span><span class='id run'>run</span> <span class='kw'>if</span> <span class='ivar'>@xmpp</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1423,25 +1700,35 @@ Respond + push
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Shuts down the streaming processes.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-148
-149
-150
-151
-152</pre>
+168
+169
+170
+171</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 148</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 168</span>
 
 <span class='kw'>def</span> <span class='id stop'>stop</span>
   <span class='ivar'>@twitter</span><span class='period'>.</span><span class='id stop'>stop</span> <span class='kw'>if</span> <span class='ivar'>@twitter</span>
   <span class='ivar'>@xmpp</span><span class='period'>.</span><span class='id stop'>stop</span> <span class='kw'>if</span> <span class='ivar'>@xmpp</span>
-  <span class='const'>EM</span><span class='op'>::</span><span class='id stop_event_loop'>stop_event_loop</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1453,7 +1740,7 @@ Respond + push
 </div>
     
     <div id="footer">
-  Generated on Mon Nov 28 20:20:03 2011 by 
+  Generated on Tue Nov 29 11:44:04 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.9.2).
 </div>