libastag 0.0.1 → 0.0.2

data/doc/classes/Request/SetEarsPosition.html

@@ -81,20 +81,37 @@
   <div id="contextContent">
     <div id="diagram">
       <map id="map" name="map">
-  <area shape="rect" coords="392,85,464,133"      href="Base/Event.html" alt="Event" />
-  <area shape="rect" coords="27,181,99,229"      href="Action.html" alt="Action" />
-  <area shape="rect" coords="123,181,211,229"      href="TtsMessage.html" alt="TtsMessage" />
-  <area shape="rect" coords="235,181,341,229"      href="SetEarsPosition.html" alt="SetEarsPosition" />
-  <area shape="rect" coords="365,181,469,229"      href="Base/EventCollection.html" alt="EventCollection" />
-  <area shape="rect" coords="647,85,724,133"      href="../Enumerable.html" alt="Enumerable" />
-  <area shape="rect" coords="135,85,207,133"      href="Query.html" alt="Query" />
-  <area shape="rect" coords="491,73,625,121"      href="GET_EARS_POSITION.html" alt="GET_EARS_POSITION" />
-  <area shape="rect" coords="355,51,480,240"      href="Base.html" alt="Base" />
-  <area shape="rect" coords="16,16,636,251"      href="../Request.html" alt="Request" />
+  <area shape="rect" coords="736,86,808,134"      href="Base/Event.html" alt="Event" />
+  <area shape="rect" coords="27,182,99,230"      href="Action.html" alt="Action" />
+  <area shape="rect" coords="123,182,216,230"      href="AudioStream.html" alt="AudioStream" />
+  <area shape="rect" coords="240,182,333,230"      href="Choregraphy.html" alt="Choregraphy" />
+  <area shape="rect" coords="357,182,448,230"      href="TtsMessage.html" alt="TtsMessage" />
+  <area shape="rect" coords="472,182,555,230"      href="IdMessage.html" alt="IdMessage" />
+  <area shape="rect" coords="579,182,685,230"      href="SetEarsPosition.html" alt="SetEarsPosition" />
+  <area shape="rect" coords="709,182,813,230"      href="Base/EventCollection.html" alt="EventCollection" />
+  <area shape="rect" coords="984,86,1061,134"      href="../Enumerable.html" alt="Enumerable" />
+  <area shape="rect" coords="307,86,379,134"      href="Query.html" alt="Query" />
+  <area shape="rect" coords="835,74,963,122"      href="GET_EARS_POSITION.html" alt="GET_EARS_POSITION" />
+  <area shape="rect" coords="699,51,824,240"      href="Base.html" alt="Base" />
+  <area shape="rect" coords="16,16,973,251"      href="../Request.html" alt="Request" />
 </map>
 <img src="../../dot/f_8.png" usemap="#map" border="0" alt="dot/f_8.png">
     </div>
 
+    <div id="description">
+      <p>
+<a href="SetEarsPosition.html">SetEarsPosition</a> events change your
+rabbit&#8216;s ears positions. you can set left ear position, or right ear
+position, or both.
+</p>
+<h1>Examples</h1>
+<pre>
+    SetEarsPosition.new :posleft =&gt; 12                 # =&gt; #&lt;Request::SetEarsPosition:0x2ad0b2c79680 @h={:posleft=&gt;12}&gt;
+    SetEarsPosition.new :posright =&gt; 1                 # =&gt; #&lt;Request::SetEarsPosition:0x2ad0b2c70260 @h={:posright=&gt;1}&gt;
+    SetEarsPosition.new :posright =&gt; 5, :posleft =&gt; 5  # =&gt; #&lt;Request::SetEarsPosition:0x2ad0b2c5e330 @h={:posleft=&gt;5, :posright=&gt;5}&gt;
+</pre>
+
+    </div>
 
 
    </div>
@@ -103,8 +120,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000029">new</a>&nbsp;&nbsp;
-      <a href="#M000030">to_url</a>&nbsp;&nbsp;
+      <a href="#M000042">new</a>&nbsp;&nbsp;
+      <a href="#M000043">to_url</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -144,27 +161,32 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000029" class="method-detail">
-        <a name="M000029"></a>
+      <div id="method-M000042" class="method-detail">
+        <a name="M000042"></a>
 
         <div class="method-heading">
-          <a href="#M000029" class="method-signature">
+          <a href="#M000042" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(h)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+take an hash in parameter, with <tt>:posright</tt> and/or <tt>:posleft</tt>
+keys. values should be between SetEarsPosition::MIN_POS and
+SetEarsPosition::MAX_POS.
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000029-source">
+            onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000042-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 114</span>
-114:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">h</span>
-115:       <span class="ruby-ivar">@h</span> = <span class="ruby-identifier">h</span>.<span class="ruby-identifier">dup</span>
-116:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'at least :posright or :posleft must be set'</span>)             <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>]
-117:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;:posright must be between #{MIN_POS} and #{MAX_POS}&quot;</span>)    <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>] <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-constant">MIN_POS</span>,<span class="ruby-constant">MAX_POS</span>)
-118:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;:posleft  must be between #{MIN_POS} and #{MAX_POS}&quot;</span>)    <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span> ] <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span> ].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-constant">MIN_POS</span>,<span class="ruby-constant">MAX_POS</span>)
-119:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 152</span>
+152:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">h</span>
+153:       <span class="ruby-ivar">@h</span> = <span class="ruby-identifier">h</span>.<span class="ruby-identifier">dup</span>
+154:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'at least :posright or :posleft must be set'</span>)             <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>]
+155:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;:posright must be between #{MIN_POS} and #{MAX_POS}&quot;</span>)    <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>] <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-constant">MIN_POS</span>,<span class="ruby-constant">MAX_POS</span>)
+156:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;:posleft  must be between #{MIN_POS} and #{MAX_POS}&quot;</span>)    <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span> ] <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span> ].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-constant">MIN_POS</span>,<span class="ruby-constant">MAX_POS</span>)
+157:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -172,27 +194,27 @@
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000030" class="method-detail">
-        <a name="M000030"></a>
+      <div id="method-M000043" class="method-detail">
+        <a name="M000043"></a>
 
         <div class="method-heading">
-          <a href="#M000030" class="method-signature">
+          <a href="#M000043" class="method-signature">
           <span class="method-name">to_url</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000030-source">
+            onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000043-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 122</span>
-122:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_url</span>
-123:       <span class="ruby-identifier">url</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
-124:       <span class="ruby-identifier">url</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;posleft=#{h[:posleft].to_i}&quot;</span>   <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">:posleft</span>]
-125:       <span class="ruby-identifier">url</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;posright=#{h[:posright].to_i}&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">:posright</span>]
-126:       <span class="ruby-identifier">url</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'&amp;'</span>)
-127:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 159</span>
+159:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_url</span>
+160:       <span class="ruby-identifier">url</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
+161:       <span class="ruby-identifier">url</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;posleft=#{@h[:posleft].to_i}&quot;</span>   <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posleft</span>]
+162:       <span class="ruby-identifier">url</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;posright=#{@h[:posright].to_i}&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:posright</span>]
+163:       <span class="ruby-identifier">url</span>.<span class="ruby-identifier">sort</span>
+164:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Request/TtsMessage.html

@@ -81,20 +81,36 @@
   <div id="contextContent">
     <div id="diagram">
       <map id="map" name="map">
-  <area shape="rect" coords="392,85,464,133"      href="Base/Event.html" alt="Event" />
-  <area shape="rect" coords="27,181,99,229"      href="Action.html" alt="Action" />
-  <area shape="rect" coords="123,181,211,229"      href="TtsMessage.html" alt="TtsMessage" />
-  <area shape="rect" coords="235,181,341,229"      href="SetEarsPosition.html" alt="SetEarsPosition" />
-  <area shape="rect" coords="365,181,469,229"      href="Base/EventCollection.html" alt="EventCollection" />
-  <area shape="rect" coords="647,85,724,133"      href="../Enumerable.html" alt="Enumerable" />
-  <area shape="rect" coords="135,85,207,133"      href="Query.html" alt="Query" />
-  <area shape="rect" coords="491,73,625,121"      href="GET_EARS_POSITION.html" alt="GET_EARS_POSITION" />
-  <area shape="rect" coords="355,51,480,240"      href="Base.html" alt="Base" />
-  <area shape="rect" coords="16,16,636,251"      href="../Request.html" alt="Request" />
+  <area shape="rect" coords="736,86,808,134"      href="Base/Event.html" alt="Event" />
+  <area shape="rect" coords="27,182,99,230"      href="Action.html" alt="Action" />
+  <area shape="rect" coords="123,182,216,230"      href="AudioStream.html" alt="AudioStream" />
+  <area shape="rect" coords="240,182,333,230"      href="Choregraphy.html" alt="Choregraphy" />
+  <area shape="rect" coords="357,182,448,230"      href="TtsMessage.html" alt="TtsMessage" />
+  <area shape="rect" coords="472,182,555,230"      href="IdMessage.html" alt="IdMessage" />
+  <area shape="rect" coords="579,182,685,230"      href="SetEarsPosition.html" alt="SetEarsPosition" />
+  <area shape="rect" coords="709,182,813,230"      href="Base/EventCollection.html" alt="EventCollection" />
+  <area shape="rect" coords="984,86,1061,134"      href="../Enumerable.html" alt="Enumerable" />
+  <area shape="rect" coords="307,86,379,134"      href="Query.html" alt="Query" />
+  <area shape="rect" coords="835,74,963,122"      href="GET_EARS_POSITION.html" alt="GET_EARS_POSITION" />
+  <area shape="rect" coords="699,51,824,240"      href="Base.html" alt="Base" />
+  <area shape="rect" coords="16,16,973,251"      href="../Request.html" alt="Request" />
 </map>
 <img src="../../dot/f_8.png" usemap="#map" border="0" alt="dot/f_8.png">
     </div>
 
+    <div id="description">
+      <p>
+<a href="TtsMessage.html">TtsMessage</a> events are used to Text-To-Speach
+messages.
+</p>
+<h1>Examples</h1>
+<pre>
+    TtsMessage.new :tts =&gt; &quot;oups!&quot;                                                  # =&gt; #&lt;Request::TtsMessage:0x2ab1ba3cd8e0 @h={:tts=&gt;&quot;oups!&quot;}&gt;
+    TtsMessage.new :tts =&gt; &quot;allez hop !&quot;, :speed =&gt; 200, :voice =&gt; &quot;caroline22k&quot;    # =&gt; #&lt;Request::TtsMessage:0x2ab1ba3b8e40 @h={:tts=&gt;&quot;allez%20hop%20!&quot;, :speed=&gt;200, :voice=&gt;&quot;caroline22k&quot;}&gt;
+    TtsMessage.new :tts =&gt; &quot;GNU is Not Unix&quot;, :speed =&gt; 200, :pitch =&gt; 400          # =&gt; #&lt;Request::TtsMessage:0x2ab1ba3a9580 @h={:tts=&gt;&quot;GNU%20is%20Not%20Unix&quot;, :speed=&gt;200, :pitch=&gt;400}&gt;
+</pre>
+
+    </div>
 
 
    </div>
@@ -103,8 +119,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000027">new</a>&nbsp;&nbsp;
-      <a href="#M000028">to_url</a>&nbsp;&nbsp;
+      <a href="#M000038">new</a>&nbsp;&nbsp;
+      <a href="#M000039">to_url</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -129,7 +145,7 @@
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">MAX_SPEED</td>
           <td>=</td>
-          <td class="context-item-value">32000</td>
+          <td class="context-item-value">32_000</td>
         </tr>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">MIN_PITCH</td>
@@ -139,7 +155,7 @@
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">MAX_PITCH</td>
           <td>=</td>
-          <td class="context-item-value">32000</td>
+          <td class="context-item-value">32_000</td>
         </tr>
         </table>
       </div>
@@ -154,38 +170,47 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000027" class="method-detail">
-        <a name="M000027"></a>
+      <div id="method-M000038" class="method-detail">
+        <a name="M000038"></a>
 
         <div class="method-heading">
-          <a href="#M000027" class="method-signature">
+          <a href="#M000038" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(h)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+take an hash in parameter, with at least <tt>:tts</tt> key. the
+<tt>:tts</tt> key must be a string encoded in UTF-8. Optionals parameters
+are <tt>:speed</tt> and <tt>:pitch</tt>, they must be between MIN_SPEED and
+MAX_SPEED (MIN_PITCH and MAX_PITCH respectively). Default values for
+speed/pitch is 100.
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000027-source">
+            onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000038-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 140</span>
-140:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">h</span>
-141:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'no text given'</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">:tts</span>]
-142:       <span class="ruby-ivar">@h</span> = <span class="ruby-identifier">h</span>.<span class="ruby-identifier">dup</span>
-143: 
-144:       [<span class="ruby-identifier">:speed</span>,<span class="ruby-identifier">:pitch</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
-145:         <span class="ruby-identifier">min</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span>(<span class="ruby-node">&quot;#{self.class}::MIN_#{p.to_s.upcase}&quot;</span>)
-146:         <span class="ruby-identifier">max</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span>(<span class="ruby-node">&quot;#{self.class}::MAX_#{p.to_s.upcase}&quot;</span>)
-147: 
-148:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">p</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-identifier">min</span>,<span class="ruby-identifier">max</span>)
-149:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;#{p} values must be between #{min} and #{max}&quot;</span>)
-150:         <span class="ruby-keyword kw">else</span>
-151:           <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">p</span>] = <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">p</span>].<span class="ruby-identifier">to_i</span>
-152:         <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">p</span>]
-153:       <span class="ruby-keyword kw">end</span>
-154: 
-155:       <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:tts</span>] = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escape</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:tts</span>]
-156:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 184</span>
+184:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">h</span>
+185:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'no :tts given'</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">:tts</span>]
+186:       <span class="ruby-ivar">@h</span> = <span class="ruby-identifier">h</span>.<span class="ruby-identifier">dup</span>
+187: 
+188:       [<span class="ruby-identifier">:speed</span>,<span class="ruby-identifier">:pitch</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
+189:         <span class="ruby-identifier">min</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span>(<span class="ruby-node">&quot;#{self.class}::MIN_#{k.to_s.upcase}&quot;</span>)
+190:         <span class="ruby-identifier">max</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span>(<span class="ruby-node">&quot;#{self.class}::MAX_#{k.to_s.upcase}&quot;</span>)
+191: 
+192:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">between?</span>(<span class="ruby-identifier">min</span>,<span class="ruby-identifier">max</span>)
+193:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;#{k} values must be between #{min} and #{max}&quot;</span>)
+194:         <span class="ruby-keyword kw">else</span>
+195:           <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">to_i</span>
+196:         <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">k</span>]
+197:       <span class="ruby-keyword kw">end</span>
+198: 
+199:       <span class="ruby-comment cmt"># to have a well formatted url</span>
+200:       <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:tts</span>]          = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:tts</span>]
+201:       <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:nabcasttitle</span>] = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:nabcasttitle</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">:nabcasttitle</span>]
+202:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -193,28 +218,27 @@
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000028" class="method-detail">
-        <a name="M000028"></a>
+      <div id="method-M000039" class="method-detail">
+        <a name="M000039"></a>
 
         <div class="method-heading">
-          <a href="#M000028" class="method-signature">
+          <a href="#M000039" class="method-signature">
           <span class="method-name">to_url</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000028-source">
+            onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000039-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 158</span>
-158:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_url</span>
-159:       <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">p</span> <span class="ruby-keyword kw">in</span> [<span class="ruby-identifier">:tts</span>,<span class="ruby-identifier">:voice</span>,<span class="ruby-identifier">:speed</span>,<span class="ruby-identifier">:pitch</span>] <span class="ruby-keyword kw">do</span>
-160:         (<span class="ruby-identifier">url</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{p}=#{@h[p]}&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@h</span>[<span class="ruby-identifier">p</span>]
-161:       <span class="ruby-keyword kw">end</span>
-162: 
-163:       <span class="ruby-identifier">url</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'&amp;'</span>)
-164:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/violet/request.rb, line 204</span>
+204:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_url</span>
+205:       <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">key</span>,<span class="ruby-identifier">val</span> <span class="ruby-keyword kw">in</span> <span class="ruby-ivar">@h</span>
+206:         (<span class="ruby-identifier">url</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{key}=#{val}&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>
+207:       <span class="ruby-keyword kw">end</span>
+208:       <span class="ruby-identifier">url</span>.<span class="ruby-identifier">sort</span>
+209:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Response.html

@@ -73,116 +73,47 @@
   <div id="contextContent">
     <div id="diagram">
       <map id="map" name="map">
-  <area shape="rect" coords="1625,229,1732,277"      href="Response/Base/GoodServerRsp.html" alt="GoodServerRsp" />
+  <area shape="rect" coords="1621,229,1731,277"      href="Response/Base/GoodServerRsp.html" alt="GoodServerRsp" />
   <area shape="rect" coords="27,325,136,373"      href="Response/EarPositionSend.html" alt="EarPositionSend" />
   <area shape="rect" coords="160,325,256,373"      href="Response/NabCastSend.html" alt="NabCastSend" />
-  <area shape="rect" coords="280,325,384,373"      href="Response/CommandSend.html" alt="CommandSend" />
-  <area shape="rect" coords="408,325,485,373"      href="Response/Signature.html" alt="Signature" />
-  <area shape="rect" coords="509,325,595,373"      href="Response/PositionEar.html" alt="PositionEar" />
-  <area shape="rect" coords="619,325,707,373"      href="Response/VoiceListTts.html" alt="VoiceListTts" />
-  <area shape="rect" coords="731,325,819,373"      href="Response/LinkPreview.html" alt="LinkPreview" />
+  <area shape="rect" coords="280,325,381,373"      href="Response/CommandSend.html" alt="CommandSend" />
+  <area shape="rect" coords="405,325,483,373"      href="Response/Signature.html" alt="Signature" />
+  <area shape="rect" coords="507,325,589,373"      href="Response/PositionEar.html" alt="PositionEar" />
+  <area shape="rect" coords="613,325,704,373"      href="Response/VoiceListTts.html" alt="VoiceListTts" />
+  <area shape="rect" coords="728,325,819,373"      href="Response/LinkPreview.html" alt="LinkPreview" />
   <area shape="rect" coords="843,325,941,373"      href="Response/MessageSend.html" alt="MessageSend" />
   <area shape="rect" coords="965,325,1059,373"      href="Response/LangListUser.html" alt="LangListUser" />
-  <area shape="rect" coords="1083,325,1173,373"      href="Response/RabbitName.html" alt="RabbitName" />
-  <area shape="rect" coords="1197,325,1269,373"      href="Response/TtsSend.html" alt="TtsSend" />
-  <area shape="rect" coords="1293,325,1405,373"      href="Response/ListReceivedMsg.html" alt="ListReceivedMsg" />
-  <area shape="rect" coords="1429,325,1507,373"      href="Response/ListFriend.html" alt="ListFriend" />
-  <area shape="rect" coords="1531,325,1619,373"      href="Response/RabbitSleep.html" alt="RabbitSleep" />
-  <area shape="rect" coords="1643,325,1715,373"      href="Response/Blacklist.html" alt="Blacklist" />
-  <area shape="rect" coords="1739,325,1816,373"      href="Response/Timezone.html" alt="Timezone" />
-  <area shape="rect" coords="1840,325,1939,373"      href="Response/RabbitVersion.html" alt="RabbitVersion" />
-  <area shape="rect" coords="1963,325,2067,373"      href="Response/WebRadioSend.html" alt="WebRadioSend" />
-  <area shape="rect" coords="2091,325,2168,373"      href="Response/ChorSend.html" alt="ChorSend" />
-  <area shape="rect" coords="1756,229,1855,277"      href="Response/Base/BadServerRsp.html" alt="BadServerRsp" />
-  <area shape="rect" coords="2192,325,2331,373"      href="Response/NoGoodTokenOrSerial.html" alt="NoGoodTokenOrSerial" />
-  <area shape="rect" coords="2355,325,2451,373"      href="Response/ChorNotSend.html" alt="ChorNotSend" />
-  <area shape="rect" coords="2475,325,2589,373"      href="Response/NabCastNotSend.html" alt="NabCastNotSend" />
-  <area shape="rect" coords="2613,325,2728,373"      href="Response/MessageNotSend.html" alt="MessageNotSend" />
-  <area shape="rect" coords="2752,325,2851,373"      href="Response/AbuseSending.html" alt="AbuseSending" />
-  <area shape="rect" coords="2875,325,3008,373"      href="Response/NoCorrectParameters.html" alt="NoCorrectParameters" />
-  <area shape="rect" coords="3032,325,3120,373"      href="Response/TtsNotSend.html" alt="TtsNotSend" />
-  <area shape="rect" coords="3144,325,3235,373"      href="Response/NotV2Rabbit.html" alt="NotV2Rabbit" />
-  <area shape="rect" coords="3259,325,3381,373"      href="Response/WebRadioNotSend.html" alt="WebRadioNotSend" />
-  <area shape="rect" coords="3405,325,3531,373"      href="Response/EarPositionNotSend.html" alt="EarPositionNotSend" />
-  <area shape="rect" coords="1149,5,1227,53"      href="Exception.html" alt="Exception" />
-  <area shape="rect" coords="1131,133,1245,181"      href="Response/ProtocolExcepion.html" alt="ProtocolExcepion" />
-  <area shape="rect" coords="1765,133,1845,181"      href="Response/Base/ServerRsp.html" alt="ServerRsp" />
-  <area shape="rect" coords="1879,229,1991,277"      href="Response/EmptyServerRsp.html" alt="EmptyServerRsp" />
-  <area shape="rect" coords="1615,99,1865,288"      href="Response/Base.html" alt="Base" />
-  <area shape="rect" coords="16,64,3541,384"      href="Response.html" alt="Response" />
+  <area shape="rect" coords="1083,325,1171,373"      href="Response/RabbitName.html" alt="RabbitName" />
+  <area shape="rect" coords="1195,325,1267,373"      href="Response/TtsSend.html" alt="TtsSend" />
+  <area shape="rect" coords="1291,325,1403,373"      href="Response/ListReceivedMsg.html" alt="ListReceivedMsg" />
+  <area shape="rect" coords="1427,325,1504,373"      href="Response/ListFriend.html" alt="ListFriend" />
+  <area shape="rect" coords="1528,325,1616,373"      href="Response/RabbitSleep.html" alt="RabbitSleep" />
+  <area shape="rect" coords="1640,325,1712,373"      href="Response/Blacklist.html" alt="Blacklist" />
+  <area shape="rect" coords="1736,325,1813,373"      href="Response/Timezone.html" alt="Timezone" />
+  <area shape="rect" coords="1837,325,1936,373"      href="Response/RabbitVersion.html" alt="RabbitVersion" />
+  <area shape="rect" coords="1960,325,2064,373"      href="Response/WebRadioSend.html" alt="WebRadioSend" />
+  <area shape="rect" coords="2088,325,2165,373"      href="Response/ChorSend.html" alt="ChorSend" />
+  <area shape="rect" coords="1755,229,1856,277"      href="Response/Base/BadServerRsp.html" alt="BadServerRsp" />
+  <area shape="rect" coords="2189,325,2325,373"      href="Response/NoGoodTokenOrSerial.html" alt="NoGoodTokenOrSerial" />
+  <area shape="rect" coords="2349,325,2443,373"      href="Response/ChorNotSend.html" alt="ChorNotSend" />
+  <area shape="rect" coords="2467,325,2579,373"      href="Response/NabCastNotSend.html" alt="NabCastNotSend" />
+  <area shape="rect" coords="2603,325,2717,373"      href="Response/MessageNotSend.html" alt="MessageNotSend" />
+  <area shape="rect" coords="2741,325,2843,373"      href="Response/AbuseSending.html" alt="AbuseSending" />
+  <area shape="rect" coords="2867,325,3000,373"      href="Response/NoCorrectParameters.html" alt="NoCorrectParameters" />
+  <area shape="rect" coords="3024,325,3109,373"      href="Response/TtsNotSend.html" alt="TtsNotSend" />
+  <area shape="rect" coords="3133,325,3224,373"      href="Response/NotV2Rabbit.html" alt="NotV2Rabbit" />
+  <area shape="rect" coords="3248,325,3368,373"      href="Response/WebRadioNotSend.html" alt="WebRadioNotSend" />
+  <area shape="rect" coords="3392,325,3517,373"      href="Response/EarPositionNotSend.html" alt="EarPositionNotSend" />
+  <area shape="rect" coords="1136,5,1235,53"      href="StandardError.html" alt="StandardError" />
+  <area shape="rect" coords="1128,133,1243,181"      href="Response/ProtocolExcepion.html" alt="ProtocolExcepion" />
+  <area shape="rect" coords="1764,133,1847,181"      href="Response/Base/ServerRsp.html" alt="ServerRsp" />
+  <area shape="rect" coords="1880,229,1992,277"      href="Response/EmptyServerRsp.html" alt="EmptyServerRsp" />
+  <area shape="rect" coords="1611,99,1867,288"      href="Response/Base.html" alt="Base" />
+  <area shape="rect" coords="16,64,3528,384"      href="Response.html" alt="Response" />
 </map>
-<img src="../dot/f_5.png" usemap="#map" border="0" alt="dot/f_5.png">
+<img src="../dot/f_6.png" usemap="#map" border="0" alt="dot/f_6.png">
     </div>
 
-    <div id="description">
-      <h1>violet/response.rb</h1>
-<h2>Summary</h2>
-<p>
-this module handle servers messages. Main method/class are <a
-href="Response.html#M000003">Response.parse</a> and <a
-href="Response/Base/ServerRsp.html">Response::Base::ServerRsp</a> (well
-documented).
-</p>
-<p>
-you should only use <a href="Response.html#M000003">Response.parse</a> with
-the server&#8216;s message (xml) as argument, it returns a ServerRsp
-instance from the corresponding class (see all the ServerRsp subclass).
-with a ServerRsp instance you can use :
-</p>
-<dl>
-<dt> r.has_x? </dt><dd>return <tt>true</tt> if r has at least one element of name &quot;x&quot;,
-return <tt>false</tt> otherwhise.
-
-</dd>
-<dt> r.has_many_xs? </dt><dd>return <tt>true</tt> if r has more than one element of name &quot;x&quot;,
-return <tt>false</tt> otherwhise.
-
-</dd>
-<dt> r.x </dt><dd>find the first xml element of name x and return it&#8216;s text if any, or
-a hash of it&#8216;s options
-
-</dd>
-<dt> r.x </dt><dd>find all xml element of name x and return an Array of their text if any, or
-their options.
-
-</dd>
-<dt> r.good? </dt><dd>return <tt>true</tt> if the response is not an error, <tt>false</tt>
-otherwhise.
-
-</dd>
-<dt> r.bad? </dt><dd>return <tt>true</tt> if the response is an error, <tt>false</tt>
-otherwhise.
-
-</dd>
-</dl>
-<h2>Examples :</h2>
-<pre>
-    &gt;&gt; rsp = Response.parse('&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&lt;rsp&gt;&lt;blacklist nb=&quot;2&quot;/&gt;&lt;pseudo name=&quot;toto&quot;/&gt;&lt;pseudo name=&quot;titi&quot;/&gt;&lt;/rsp&gt;')
-    =&gt; #&lt;Response::Blacklist:0x2acd8c08f2f8 @xml=&lt;UNDEFINED&gt; ... &lt;/&gt;&gt;
-    &gt;&gt; rsp.good?
-    =&gt; true
-    &gt;&gt; rsp.has_message?
-    =&gt; false
-    &gt;&gt; rsp.message
-    NameError: undefined local variable or method message for #&lt;Response::Blacklist:0x2b1f056afdc0 @xml=&lt;UNDEFINED&gt; ... &lt;/&gt;&gt;
-    &gt;&gt; rsp.has_blacklist?
-    =&gt; true
-    &gt;&gt; rsp.blacklist
-    =&gt; {:nb=&gt;&quot;2&quot;}
-    &gt;&gt; rsp.pseudo
-    =&gt; {:name=&gt;&quot;toto&quot;}
-    &gt;&gt; rsp.has_many_pseudos?
-    =&gt; true
-    &gt;&gt; rsp.pseudos
-    =&gt; [{:name=&gt;&quot;toto&quot;}, {:name=&gt;&quot;titi&quot;}]
-</pre>
-<h2>Low Level</h2>
-<p>
-if you want to access to the REXML::Document object of a ServerRsp you can
-either use rsp.xml or use ServerRsp#get_all method.
-</p>
-
-    </div>
 
 
    </div>
@@ -296,27 +227,27 @@ fail to detect the kind of the server&#8216;s response.
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/violet/response.rb, line 390</span>
-390:   <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Response</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">raw</span>
-391:     <span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Base</span><span class="ruby-operator">::</span><span class="ruby-constant">ServerRsp</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">raw</span> <span class="ruby-comment cmt"># we shouldn't create ServerRsp instances, but act as if you didn't see ;)</span>
-392:     <span class="ruby-identifier">klassname</span> = <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">raw</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">%r|&lt;rsp&gt;\s*&lt;/rsp&gt;|i</span>
-393:                   <span class="ruby-value str">'EmptyServerRsp'</span>
-394:                 <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">has_message?</span>
-395:                   <span class="ruby-node">/^#{tmp.message}$/i</span>
-396:                 <span class="ruby-keyword kw">else</span>
-397:                   <span class="ruby-node">/^#{tmp.xml.root.elements[1].name}$/i</span> <span class="ruby-comment cmt"># REXML::Elements#[] has index 1-based and not 0-based, so we really fetch the first element's name</span>
-398:                 <span class="ruby-keyword kw">end</span>
-399: 
-400:     <span class="ruby-identifier">klass</span> = <span class="ruby-keyword kw">nil</span>
-401:     <span class="ruby-keyword kw">begin</span>
-402:       <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span> <span class="ruby-node">&quot;#{self}::#{Response.constants.grep(klassname).first}&quot;</span>
-403:       <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">nil?</span>
-404:     <span class="ruby-keyword kw">rescue</span>
-405:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ProtocolExcepion</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;unknown server's response : #{raw}&quot;</span>)
-406:     <span class="ruby-keyword kw">end</span>
-407: 
-408:     <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">raw</span>
-409:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/violet/response.rb, line 393</span>
+393:   <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Response</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">raw</span>
+394:     <span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Base</span><span class="ruby-operator">::</span><span class="ruby-constant">ServerRsp</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">raw</span> <span class="ruby-comment cmt"># we shouldn't create ServerRsp instances, but act as if you didn't see ;)</span>
+395:     <span class="ruby-identifier">klassname</span> = <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">raw</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">%r|&lt;rsp&gt;\s*&lt;/rsp&gt;|i</span>
+396:                   <span class="ruby-value str">'EmptyServerRsp'</span>
+397:                 <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">has_message?</span>
+398:                   <span class="ruby-node">/^#{tmp.message}$/i</span>
+399:                 <span class="ruby-keyword kw">else</span>
+400:                   <span class="ruby-node">/^#{tmp.xml.root.elements[1].name}$/i</span> <span class="ruby-comment cmt"># REXML::Elements#[] has index 1-based and not 0-based, so we really fetch the first element's name</span>
+401:                 <span class="ruby-keyword kw">end</span>
+402: 
+403:     <span class="ruby-identifier">klass</span> = <span class="ruby-keyword kw">nil</span>
+404:     <span class="ruby-keyword kw">begin</span>
+405:       <span class="ruby-identifier">klass</span> = <span class="ruby-constant">Helpers</span>.<span class="ruby-identifier">constantize</span> <span class="ruby-node">&quot;#{self}::#{Response.constants.grep(klassname).first}&quot;</span>
+406:       <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">nil?</span>
+407:     <span class="ruby-keyword kw">rescue</span>
+408:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ProtocolExcepion</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;unknown server's response : #{raw}&quot;</span>)
+409:     <span class="ruby-keyword kw">end</span>
+410: 
+411:     <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">raw</span>
+412:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>