safubot 0.0.5 → 0.0.6

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 .*.swp
+zinzin.log

data/.yardoc/checksums

@@ -1,9 +1,9 @@
 lib/safubot.rb da2c6f1fa7e7a17064469e0a5409f5dc2a6ec7ab
-lib/safubot/bot.rb fe107278c4696a5ec095063612638b484b104deb
 lib/safubot/log.rb c341c5e6a54a908ee8431b5aac2aa7c3472eaeed
-lib/safubot/xmpp.rb d09fd09c28f48282d5f09228659d58b20f69c734
+lib/safubot/bot.rb 89769ea4bce287e2e0e7abc425c4fa8bd2e38d83
+lib/safubot/xmpp.rb 518cfc7f093b9788fff7a1bd66cec97161e6bcba
+lib/safubot/twitter.rb a6ad8085f76fa1f8eef65fd79845e49b1d3b46f7
 lib/safubot/evented.rb 8e90ab5b812eb12113095a8bdde7a96ba0e62d1f
-lib/safubot/version.rb f313c43342f6e25736022460f1db64f16e2562f6
-lib/safubot/twitter.rb 883a32a176acdf1233e29f122d10a0cce0719664
+lib/safubot/version.rb 80bfde42f84547cd10526deb7b57a543206584a0
 lib/safubot/known_user.rb 8e2ce383a220c28d8729540be7fc0dfeca3f48fc
 lib/safubot/test_helper.rb a4ea2e3641880c51d3cdd689e47b09cffe6d0bc6

data/README.md

@@ -57,9 +57,9 @@ Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to instal
 	  end
 	end
 
-	# 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.
+	# This will run the Twitter/XMPP streaming processes.
+	# If both are needed, the first-enabled one will be forked
+	# into its own process.
 	NiftyBot.new.run
 
 ## <a name="logging">Logging</a>
@@ -96,4 +96,4 @@ Safubot::Log behaves as a Logger instance and will write to stdout by default. Y
 
 ## <a name="caveats">Caveats</a>
 
-I've yet to determine how to make multiple libraries with their own EventMachine loops play nice together, so the TweetStream and Blather clients are currently run in their own processes. Keep in mind the effect this will have on the execution context of your event handlers. MongoDB is your friend!
+I've yet to determine how to make multiple libraries with their own EventMachine loops play nice together, so the TweetStream and Blather clients are currently run in separate processes. Keep in mind the effect this will have on the execution context of your event handlers. MongoDB is your friend!

data/doc/Safubot/Bot.html

@@ -144,6 +144,33 @@ Returns the value of attribute opts.
 </p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#subbots-instance_method" title="#subbots (instance method)">- (Object) <strong>subbots</strong> </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title readonly">readonly</span>
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute subbots.
+</p>
+</div></span>
+  
 </li>
 
     
@@ -551,35 +578,7 @@ Adds a response to the queue and dispatches it.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Calls run_nowait and then waits for all child processes.
-</p>
-</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#run_nowait-instance_method" title="#run_nowait (instance method)">- (Object) <strong>run_nowait</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'><p>
-Runs an initial request-processing loop and then forks the streaming
-processes.
-</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -649,23 +648,27 @@ A new instance of Bot
       <pre class="lines">
 
 
+260
+261
+262
+263
 264
 265
 266
 267
-268
-269
-270</pre>
+268</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 264</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 260</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>
   <span class='ivar'>@opts</span> <span class='op'>=</span> <span class='id defaults'>defaults</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span>
   <span class='const'>MongoMapper</span><span class='period'>.</span><span class='id database'>database</span> <span class='op'>=</span> <span class='ivar'>@opts</span><span class='lbracket'>[</span><span class='symbol'>:database</span><span class='rbracket'>]</span>
   <span class='const'>MongoMapper</span><span class='period'>.</span><span class='id connection'>connection</span> <span class='op'>=</span> <span class='const'>Mongo</span><span class='op'>::</span><span class='const'>Connection</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>localhost</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>27017</span><span class='comma'>,</span> <span class='symbol'>:pool_size</span> <span class='op'>=&gt;</span> <span class='int'>5</span><span class='rparen'>)</span>
+  <span class='const'>MongoMapper</span><span class='op'>::</span><span class='const'>Document</span><span class='period'>.</span><span class='id plugin'>plugin</span><span class='lparen'>(</span><span class='const'>MongoMapper</span><span class='op'>::</span><span class='const'>Plugins</span><span class='op'>::</span><span class='const'>IdentityMap</span><span class='rparen'>)</span>
   <span class='ivar'>@handlers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@subbots</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -721,6 +724,49 @@ Returns the value of attribute opts
 </div>
     
       
+      <span id=""></span>
+      <span id="subbots-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="subbots-instance_method">
+  
+    - (<tt>Object</tt>) <strong>subbots</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute subbots
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+81
+82
+83</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 81</span>
+
+<span class='kw'>def</span> <span class='id subbots'>subbots</span>
+  <span class='ivar'>@subbots</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
       <span id=""></span>
       <span id="twitter-instance_method"></span>
       <div class="method_details ">
@@ -1244,23 +1290,25 @@ Initialises Twitter-related functionality.
       <pre class="lines">
 
 
+240
+241
+242
+243
+244
+245
 246
-247
-248
-249
-250
-251
-252</pre>
+247</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 246</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 240</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>
   <span class='ivar'>@twitter</span><span class='period'>.</span><span class='id on'>on</span><span class='lparen'>(</span><span class='symbol'>:request</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id req'>req</span><span class='op'>|</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='id req'>req</span><span class='period'>.</span><span class='id responses'>responses</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 map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:dispatch</span><span class='rparen'>)</span>
+	<span class='id req'>req</span><span class='period'>.</span><span class='id responses'>responses</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 map'>map</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>
   <span class='kw'>end</span>
+  <span class='ivar'>@subbots</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='ivar'>@twitter</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1292,25 +1340,27 @@ Initialises XMPP-related functionality.
       <pre class="lines">
 
 
+250
+251
+252
+253
+254
 255
 256
 257
-258
-259
-260
-261
-262</pre>
+258</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 255</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 250</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>
   <span class='ivar'>@xmpp</span> <span class='op'>=</span> <span class='const'>XMPP</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 defaults'>defaults</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
   <span class='ivar'>@xmpp</span><span class='period'>.</span><span class='id on'>on</span><span class='lparen'>(</span><span class='symbol'>:request</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id req'>req</span><span class='op'>|</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='id req'>req</span><span class='period'>.</span><span class='id responses'>responses</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 map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:dispatch</span><span class='rparen'>)</span>
+	<span class='id req'>req</span><span class='period'>.</span><span class='id responses'>responses</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 map'>map</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>
   <span class='kw'>end</span>
+  <span class='ivar'>@subbots</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='ivar'>@xmpp</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1502,7 +1552,7 @@ Twitter AJAX API).
       <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 182</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>
+  <span class='ivar'>@twitter</span><span class='period'>.</span><span class='id pull'>pull</span> <span class='kw'>if</span> <span class='ivar'>@twitter</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1721,88 +1771,37 @@ Contents of the response.
   
 
   
-</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">
-
-
-230
-231
-232
-233
-234
-235
-236
-237</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 230</span>
-
-<span class='kw'>def</span> <span class='id run'>run</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">
+</p><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
+222
 223
 224
 225
 226
-227</pre>
+227
+228
+229
+230
+231
+232</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 223</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 222</span>
 
-<span class='kw'>def</span> <span class='id run_nowait'>run_nowait</span>
+<span class='kw'>def</span> <span class='id run'>run</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='ivar'>@subbots</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id subbot'>subbot</span><span class='op'>|</span>
+	<span class='id subbot'>subbot</span><span class='period'>.</span><span class='id fork'>fork</span>
+  <span class='kw'>end</span>
+
+  <span class='comment'># Run the final subbot in this process to avoid unnecessary forking
+</span>  <span class='comment'># and thus memory consumption.
+</span>  <span class='ivar'>@subbots</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id run'>run</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1834,17 +1833,15 @@ Shuts down the streaming processes.
       <pre class="lines">
 
 
-240
-241
-242
-243</pre>
+235
+236
+237</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 240</span>
+      <pre class="code"><span class="info file"># File 'lib/safubot/bot.rb', line 235</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='ivar'>@subbots</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id subbot'>subbot</span><span class='op'>|</span> <span class='id subbot'>subbot</span><span class='period'>.</span><span class='id stop'>stop</span> <span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1856,7 +1853,7 @@ Shuts down the streaming processes.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Evented.html

@@ -469,7 +469,7 @@ Unbinds the given handler.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:27 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/KnownUser.html

@@ -557,7 +557,7 @@ Plucky query with Tweets scoped to this user’s twitter id.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Log.html

@@ -264,7 +264,7 @@ Dispatch method calls to Logger objects.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Problem.html

@@ -121,7 +121,7 @@ An EmbeddedDocument for storing processing/dispatch errors.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Problematic.html

@@ -273,7 +273,7 @@ Fetches the most recent Problem.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Query.html

@@ -251,7 +251,7 @@ Find or create a Request sourced from this Query.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:27 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/Request.html

@@ -141,7 +141,7 @@ be extended by service-specific modules.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Response.html

@@ -139,7 +139,7 @@ be extended by service-specific modules.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:26 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/Test.html

@@ -277,7 +277,7 @@ The body of the Request.
 </div>
     
     <div id="footer">
-  Generated on Thu Dec  1 18:19:17 2011 by 
+  Generated on Thu Dec  1 11:12:27 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>