pupil 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG.md +12 -0
- data/README.md +113 -0
- data/Rakefile +1 -0
- data/VERSION +1 -1
- data/doc/Pupil.html +212 -216
- data/doc/Pupil/DirectMessage.html +22 -22
- data/doc/Pupil/Entities.html +10 -10
- data/doc/Pupil/Hashtag.html +9 -9
- data/doc/Pupil/Keygen.html +44 -44
- data/doc/Pupil/Keygen/MissingRequiredTokens.html +3 -3
- data/doc/Pupil/List.html +26 -26
- data/doc/Pupil/NetworkError.html +3 -3
- data/doc/Pupil/Status.html +46 -42
- data/doc/Pupil/Stream.html +227 -48
- data/doc/Pupil/Stream/Shash.html +390 -0
- data/doc/Pupil/Stream/Status.html +377 -0
- data/doc/Pupil/Stream/StreamError.html +3 -3
- data/doc/Pupil/URL.html +11 -11
- data/doc/Pupil/UnsupportedParameter.html +3 -3
- data/doc/Pupil/User.html +82 -82
- data/doc/_index.html +17 -10
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -10
- data/doc/file.LICENSE.html +4 -23
- data/doc/file.README.html +117 -46
- data/doc/frames.html +1 -1
- data/doc/index.html +117 -46
- data/doc/js/app.js +4 -4
- data/doc/method_list.html +178 -138
- data/doc/top-level-namespace.html +3 -3
- data/lib/pupil/base.rb +0 -2
- data/lib/pupil/stream/base.rb +47 -23
- data/pupil.gemspec +114 -0
- metadata +25 -27
- data/.document +0 -5
- data/.rspec +0 -1
- data/README.rdoc +0 -19
- data/doc/Pupil/Stream/StreamEvent.html +0 -421
| @@ -0,0 +1,390 @@ | |
| 1 | 
            +
            <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
         | 
| 2 | 
            +
              "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
         | 
| 3 | 
            +
            <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
         | 
| 4 | 
            +
              <head>
         | 
| 5 | 
            +
                <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         | 
| 6 | 
            +
            <title>
         | 
| 7 | 
            +
              Class: Pupil::Stream::Shash
         | 
| 8 | 
            +
              
         | 
| 9 | 
            +
                — Documentation by YARD 0.7.4
         | 
| 10 | 
            +
              
         | 
| 11 | 
            +
            </title>
         | 
| 12 | 
            +
             | 
| 13 | 
            +
              <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
         | 
| 14 | 
            +
             | 
| 15 | 
            +
              <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
         | 
| 16 | 
            +
             | 
| 17 | 
            +
            <script type="text/javascript" charset="utf-8">
         | 
| 18 | 
            +
              relpath = '../..';
         | 
| 19 | 
            +
              if (relpath != '') relpath += '/';
         | 
| 20 | 
            +
            </script>
         | 
| 21 | 
            +
             | 
| 22 | 
            +
              <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
         | 
| 23 | 
            +
             | 
| 24 | 
            +
              <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
         | 
| 25 | 
            +
             | 
| 26 | 
            +
             | 
| 27 | 
            +
              </head>
         | 
| 28 | 
            +
              <body>
         | 
| 29 | 
            +
                <script type="text/javascript" charset="utf-8">
         | 
| 30 | 
            +
                  if (window.top.frames.main) document.body.className = 'frames';
         | 
| 31 | 
            +
                </script>
         | 
| 32 | 
            +
                
         | 
| 33 | 
            +
                <div id="header">
         | 
| 34 | 
            +
                  <div id="menu">
         | 
| 35 | 
            +
              
         | 
| 36 | 
            +
                <a href="../../_index.html">Index (S)</a> » 
         | 
| 37 | 
            +
                <span class='title'><span class='object_link'><a href="../../Pupil.html" title="Pupil (class)">Pupil</a></span></span> » <span class='title'><span class='object_link'><a href="../Stream.html" title="Pupil::Stream (class)">Stream</a></span></span>
         | 
| 38 | 
            +
                 » 
         | 
| 39 | 
            +
                <span class="title">Shash</span>
         | 
| 40 | 
            +
              
         | 
| 41 | 
            +
              
         | 
| 42 | 
            +
              <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
         | 
| 43 | 
            +
            </div>
         | 
| 44 | 
            +
             | 
| 45 | 
            +
                  <div id="search">
         | 
| 46 | 
            +
              
         | 
| 47 | 
            +
                <a id="class_list_link" href="#">Class List</a>
         | 
| 48 | 
            +
              
         | 
| 49 | 
            +
                <a id="method_list_link" href="#">Method List</a>
         | 
| 50 | 
            +
              
         | 
| 51 | 
            +
                <a id="file_list_link" href="#">File List</a>
         | 
| 52 | 
            +
              
         | 
| 53 | 
            +
            </div>
         | 
| 54 | 
            +
                  <div class="clear"></div>
         | 
| 55 | 
            +
                </div>
         | 
| 56 | 
            +
                
         | 
| 57 | 
            +
                <iframe id="search_frame"></iframe>
         | 
| 58 | 
            +
                
         | 
| 59 | 
            +
                <div id="content"><h1>Class: Pupil::Stream::Shash
         | 
| 60 | 
            +
              
         | 
| 61 | 
            +
              
         | 
| 62 | 
            +
              
         | 
| 63 | 
            +
            </h1>
         | 
| 64 | 
            +
             | 
| 65 | 
            +
            <dl class="box">
         | 
| 66 | 
            +
              
         | 
| 67 | 
            +
                <dt class="r1">Inherits:</dt>
         | 
| 68 | 
            +
                <dd class="r1">
         | 
| 69 | 
            +
                  <span class="inheritName">Object</span>
         | 
| 70 | 
            +
                  
         | 
| 71 | 
            +
                    <ul class="fullTree">
         | 
| 72 | 
            +
                      <li>Object</li>
         | 
| 73 | 
            +
                      
         | 
| 74 | 
            +
                        <li class="next">Pupil::Stream::Shash</li>
         | 
| 75 | 
            +
                      
         | 
| 76 | 
            +
                    </ul>
         | 
| 77 | 
            +
                    <a href="#" class="inheritanceTree">show all</a>
         | 
| 78 | 
            +
                  
         | 
| 79 | 
            +
                  </dd>
         | 
| 80 | 
            +
                
         | 
| 81 | 
            +
              
         | 
| 82 | 
            +
              
         | 
| 83 | 
            +
                
         | 
| 84 | 
            +
              
         | 
| 85 | 
            +
                
         | 
| 86 | 
            +
              
         | 
| 87 | 
            +
              
         | 
| 88 | 
            +
              
         | 
| 89 | 
            +
                <dt class="r2 last">Defined in:</dt>
         | 
| 90 | 
            +
                <dd class="r2 last">lib/pupil/stream/base.rb</dd>
         | 
| 91 | 
            +
              
         | 
| 92 | 
            +
            </dl>
         | 
| 93 | 
            +
            <div class="clear"></div>
         | 
| 94 | 
            +
             | 
| 95 | 
            +
            <h2>Overview</h2><div class="docstring">
         | 
| 96 | 
            +
              <div class="discussion">
         | 
| 97 | 
            +
                <p>
         | 
| 98 | 
            +
            Stream Hash
         | 
| 99 | 
            +
            </p>
         | 
| 100 | 
            +
             | 
| 101 | 
            +
             | 
| 102 | 
            +
              </div>
         | 
| 103 | 
            +
            </div>
         | 
| 104 | 
            +
            <div class="tags">
         | 
| 105 | 
            +
              
         | 
| 106 | 
            +
             | 
| 107 | 
            +
            </div>
         | 
| 108 | 
            +
             | 
| 109 | 
            +
              <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
         | 
| 110 | 
            +
              <ul class="summary">
         | 
| 111 | 
            +
                
         | 
| 112 | 
            +
                  <li class="public ">
         | 
| 113 | 
            +
              <span class="summary_signature">
         | 
| 114 | 
            +
                
         | 
| 115 | 
            +
                  <a href="#event-instance_method" title="#event (instance method)">- (Object) <strong>event</strong> </a>
         | 
| 116 | 
            +
                
         | 
| 117 | 
            +
             | 
| 118 | 
            +
                
         | 
| 119 | 
            +
              </span>
         | 
| 120 | 
            +
              
         | 
| 121 | 
            +
              
         | 
| 122 | 
            +
                <span class="note title readonly">readonly</span>
         | 
| 123 | 
            +
                
         | 
| 124 | 
            +
              
         | 
| 125 | 
            +
              
         | 
| 126 | 
            +
              
         | 
| 127 | 
            +
              
         | 
| 128 | 
            +
              
         | 
| 129 | 
            +
             | 
| 130 | 
            +
              
         | 
| 131 | 
            +
                <span class="summary_desc"><div class='inline'><p>
         | 
| 132 | 
            +
            Returns the value of attribute event.
         | 
| 133 | 
            +
            </p>
         | 
| 134 | 
            +
            </div></span>
         | 
| 135 | 
            +
              
         | 
| 136 | 
            +
            </li>
         | 
| 137 | 
            +
             | 
| 138 | 
            +
                
         | 
| 139 | 
            +
              </ul>
         | 
| 140 | 
            +
             | 
| 141 | 
            +
             | 
| 142 | 
            +
             | 
| 143 | 
            +
             | 
| 144 | 
            +
              
         | 
| 145 | 
            +
                <h2>
         | 
| 146 | 
            +
                  Instance Method Summary
         | 
| 147 | 
            +
                  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
         | 
| 148 | 
            +
                </h2>
         | 
| 149 | 
            +
             | 
| 150 | 
            +
                <ul class="summary">
         | 
| 151 | 
            +
                  
         | 
| 152 | 
            +
                    <li class="public ">
         | 
| 153 | 
            +
              <span class="summary_signature">
         | 
| 154 | 
            +
                
         | 
| 155 | 
            +
                  <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(param) </a>
         | 
| 156 | 
            +
                
         | 
| 157 | 
            +
             | 
| 158 | 
            +
                
         | 
| 159 | 
            +
              </span>
         | 
| 160 | 
            +
              
         | 
| 161 | 
            +
              
         | 
| 162 | 
            +
              
         | 
| 163 | 
            +
              
         | 
| 164 | 
            +
              
         | 
| 165 | 
            +
              
         | 
| 166 | 
            +
             | 
| 167 | 
            +
              
         | 
| 168 | 
            +
                <span class="summary_desc"><div class='inline'></div></span>
         | 
| 169 | 
            +
              
         | 
| 170 | 
            +
            </li>
         | 
| 171 | 
            +
             | 
| 172 | 
            +
                  
         | 
| 173 | 
            +
                    <li class="public ">
         | 
| 174 | 
            +
              <span class="summary_signature">
         | 
| 175 | 
            +
                
         | 
| 176 | 
            +
                  <a href="#initialize-instance_method" title="#initialize (instance method)">- (Shash) <strong>initialize</strong>(event, status) </a>
         | 
| 177 | 
            +
                
         | 
| 178 | 
            +
             | 
| 179 | 
            +
                
         | 
| 180 | 
            +
              </span>
         | 
| 181 | 
            +
              
         | 
| 182 | 
            +
                <span class="note title constructor">constructor</span>
         | 
| 183 | 
            +
              
         | 
| 184 | 
            +
              
         | 
| 185 | 
            +
              
         | 
| 186 | 
            +
              
         | 
| 187 | 
            +
              
         | 
| 188 | 
            +
              
         | 
| 189 | 
            +
             | 
| 190 | 
            +
              
         | 
| 191 | 
            +
                <span class="summary_desc"><div class='inline'><p>
         | 
| 192 | 
            +
            A new instance of Shash.
         | 
| 193 | 
            +
            </p>
         | 
| 194 | 
            +
            </div></span>
         | 
| 195 | 
            +
              
         | 
| 196 | 
            +
            </li>
         | 
| 197 | 
            +
             | 
| 198 | 
            +
                  
         | 
| 199 | 
            +
                    <li class="public ">
         | 
| 200 | 
            +
              <span class="summary_signature">
         | 
| 201 | 
            +
                
         | 
| 202 | 
            +
                  <a href="#size-instance_method" title="#size (instance method)">- (Object) <strong>size</strong> </a>
         | 
| 203 | 
            +
                
         | 
| 204 | 
            +
             | 
| 205 | 
            +
                
         | 
| 206 | 
            +
              </span>
         | 
| 207 | 
            +
              
         | 
| 208 | 
            +
              
         | 
| 209 | 
            +
              
         | 
| 210 | 
            +
              
         | 
| 211 | 
            +
              
         | 
| 212 | 
            +
              
         | 
| 213 | 
            +
             | 
| 214 | 
            +
              
         | 
| 215 | 
            +
                <span class="summary_desc"><div class='inline'></div></span>
         | 
| 216 | 
            +
              
         | 
| 217 | 
            +
            </li>
         | 
| 218 | 
            +
             | 
| 219 | 
            +
                  
         | 
| 220 | 
            +
                </ul>
         | 
| 221 | 
            +
              
         | 
| 222 | 
            +
             | 
| 223 | 
            +
            <div id="constructor_details" class="method_details_list">
         | 
| 224 | 
            +
              <h2>Constructor Details</h2>
         | 
| 225 | 
            +
              
         | 
| 226 | 
            +
                <div class="method_details first">
         | 
| 227 | 
            +
              <p class="signature first" id="initialize-instance_method">
         | 
| 228 | 
            +
              
         | 
| 229 | 
            +
                - (<tt><span class='object_link'><a href="" title="Pupil::Stream::Shash (class)">Shash</a></span></tt>) <strong>initialize</strong>(event, status) 
         | 
| 230 | 
            +
              
         | 
| 231 | 
            +
             | 
| 232 | 
            +
              
         | 
| 233 | 
            +
            </p><div class="docstring">
         | 
| 234 | 
            +
              <div class="discussion">
         | 
| 235 | 
            +
                <p>
         | 
| 236 | 
            +
            A new instance of Shash
         | 
| 237 | 
            +
            </p>
         | 
| 238 | 
            +
             | 
| 239 | 
            +
             | 
| 240 | 
            +
              </div>
         | 
| 241 | 
            +
            </div>
         | 
| 242 | 
            +
            <div class="tags">
         | 
| 243 | 
            +
              
         | 
| 244 | 
            +
             | 
| 245 | 
            +
            </div><table class="source_code">
         | 
| 246 | 
            +
              <tr>
         | 
| 247 | 
            +
                <td>
         | 
| 248 | 
            +
                  <pre class="lines">
         | 
| 249 | 
            +
             | 
| 250 | 
            +
             | 
| 251 | 
            +
            102
         | 
| 252 | 
            +
            103
         | 
| 253 | 
            +
            104
         | 
| 254 | 
            +
            105</pre>
         | 
| 255 | 
            +
                </td>
         | 
| 256 | 
            +
                <td>
         | 
| 257 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 102</span>
         | 
| 258 | 
            +
             | 
| 259 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_event'>event</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span>
         | 
| 260 | 
            +
              <span class='ivar'>@hash</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
         | 
| 261 | 
            +
              <span class='ivar'>@event</span> <span class='op'>=</span> <span class='id identifier rubyid_event'>event</span>
         | 
| 262 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 263 | 
            +
                </td>
         | 
| 264 | 
            +
              </tr>
         | 
| 265 | 
            +
            </table>
         | 
| 266 | 
            +
            </div>
         | 
| 267 | 
            +
              
         | 
| 268 | 
            +
            </div>
         | 
| 269 | 
            +
             | 
| 270 | 
            +
              <div id="instance_attr_details" class="attr_details">
         | 
| 271 | 
            +
                <h2>Instance Attribute Details</h2>
         | 
| 272 | 
            +
                
         | 
| 273 | 
            +
                  
         | 
| 274 | 
            +
                  <span id=""></span>
         | 
| 275 | 
            +
                  <span id="event-instance_method"></span>
         | 
| 276 | 
            +
                  <div class="method_details first">
         | 
| 277 | 
            +
              <p class="signature first" id="event-instance_method">
         | 
| 278 | 
            +
              
         | 
| 279 | 
            +
                - (<tt>Object</tt>) <strong>event</strong>  <span class="extras">(readonly)</span>
         | 
| 280 | 
            +
              
         | 
| 281 | 
            +
             | 
| 282 | 
            +
              
         | 
| 283 | 
            +
            </p><div class="docstring">
         | 
| 284 | 
            +
              <div class="discussion">
         | 
| 285 | 
            +
                <p>
         | 
| 286 | 
            +
            Returns the value of attribute event
         | 
| 287 | 
            +
            </p>
         | 
| 288 | 
            +
             | 
| 289 | 
            +
             | 
| 290 | 
            +
              </div>
         | 
| 291 | 
            +
            </div>
         | 
| 292 | 
            +
            <div class="tags">
         | 
| 293 | 
            +
              
         | 
| 294 | 
            +
             | 
| 295 | 
            +
            </div><table class="source_code">
         | 
| 296 | 
            +
              <tr>
         | 
| 297 | 
            +
                <td>
         | 
| 298 | 
            +
                  <pre class="lines">
         | 
| 299 | 
            +
             | 
| 300 | 
            +
             | 
| 301 | 
            +
            100
         | 
| 302 | 
            +
            101
         | 
| 303 | 
            +
            102</pre>
         | 
| 304 | 
            +
                </td>
         | 
| 305 | 
            +
                <td>
         | 
| 306 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 100</span>
         | 
| 307 | 
            +
             | 
| 308 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_event'>event</span>
         | 
| 309 | 
            +
              <span class='ivar'>@event</span>
         | 
| 310 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 311 | 
            +
                </td>
         | 
| 312 | 
            +
              </tr>
         | 
| 313 | 
            +
            </table>
         | 
| 314 | 
            +
            </div>
         | 
| 315 | 
            +
                
         | 
| 316 | 
            +
              </div>
         | 
| 317 | 
            +
             | 
| 318 | 
            +
             | 
| 319 | 
            +
              <div id="instance_method_details" class="method_details_list">
         | 
| 320 | 
            +
                <h2>Instance Method Details</h2>
         | 
| 321 | 
            +
                
         | 
| 322 | 
            +
                
         | 
| 323 | 
            +
                  <div class="method_details first">
         | 
| 324 | 
            +
              <p class="signature first" id="[]-instance_method">
         | 
| 325 | 
            +
              
         | 
| 326 | 
            +
                - (<tt>Object</tt>) <strong>[]</strong>(param) 
         | 
| 327 | 
            +
              
         | 
| 328 | 
            +
             | 
| 329 | 
            +
              
         | 
| 330 | 
            +
            </p><table class="source_code">
         | 
| 331 | 
            +
              <tr>
         | 
| 332 | 
            +
                <td>
         | 
| 333 | 
            +
                  <pre class="lines">
         | 
| 334 | 
            +
             | 
| 335 | 
            +
             | 
| 336 | 
            +
            107
         | 
| 337 | 
            +
            108
         | 
| 338 | 
            +
            109</pre>
         | 
| 339 | 
            +
                </td>
         | 
| 340 | 
            +
                <td>
         | 
| 341 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 107</span>
         | 
| 342 | 
            +
             | 
| 343 | 
            +
            <span class='kw'>def</span> <span class='op'>[]</span> <span class='id identifier rubyid_param'>param</span>
         | 
| 344 | 
            +
              <span class='ivar'>@hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_param'>param</span><span class='rbracket'>]</span>
         | 
| 345 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 346 | 
            +
                </td>
         | 
| 347 | 
            +
              </tr>
         | 
| 348 | 
            +
            </table>
         | 
| 349 | 
            +
            </div>
         | 
| 350 | 
            +
                
         | 
| 351 | 
            +
                  <div class="method_details ">
         | 
| 352 | 
            +
              <p class="signature " id="size-instance_method">
         | 
| 353 | 
            +
              
         | 
| 354 | 
            +
                - (<tt>Object</tt>) <strong>size</strong> 
         | 
| 355 | 
            +
              
         | 
| 356 | 
            +
             | 
| 357 | 
            +
              
         | 
| 358 | 
            +
            </p><table class="source_code">
         | 
| 359 | 
            +
              <tr>
         | 
| 360 | 
            +
                <td>
         | 
| 361 | 
            +
                  <pre class="lines">
         | 
| 362 | 
            +
             | 
| 363 | 
            +
             | 
| 364 | 
            +
            111
         | 
| 365 | 
            +
            112
         | 
| 366 | 
            +
            113</pre>
         | 
| 367 | 
            +
                </td>
         | 
| 368 | 
            +
                <td>
         | 
| 369 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 111</span>
         | 
| 370 | 
            +
             | 
| 371 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
         | 
| 372 | 
            +
              <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
         | 
| 373 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 374 | 
            +
                </td>
         | 
| 375 | 
            +
              </tr>
         | 
| 376 | 
            +
            </table>
         | 
| 377 | 
            +
            </div>
         | 
| 378 | 
            +
                
         | 
| 379 | 
            +
              </div>
         | 
| 380 | 
            +
             | 
| 381 | 
            +
            </div>
         | 
| 382 | 
            +
                
         | 
| 383 | 
            +
                <div id="footer">
         | 
| 384 | 
            +
              Generated on Sat Dec 17 20:58:33 2011 by 
         | 
| 385 | 
            +
              <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
         | 
| 386 | 
            +
              0.7.4 (ruby-1.9.2).
         | 
| 387 | 
            +
            </div>
         | 
| 388 | 
            +
             | 
| 389 | 
            +
              </body>
         | 
| 390 | 
            +
            </html>
         | 
| @@ -0,0 +1,377 @@ | |
| 1 | 
            +
            <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
         | 
| 2 | 
            +
              "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
         | 
| 3 | 
            +
            <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
         | 
| 4 | 
            +
              <head>
         | 
| 5 | 
            +
                <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         | 
| 6 | 
            +
            <title>
         | 
| 7 | 
            +
              Class: Pupil::Stream::Status
         | 
| 8 | 
            +
              
         | 
| 9 | 
            +
                — Documentation by YARD 0.7.4
         | 
| 10 | 
            +
              
         | 
| 11 | 
            +
            </title>
         | 
| 12 | 
            +
             | 
| 13 | 
            +
              <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
         | 
| 14 | 
            +
             | 
| 15 | 
            +
              <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
         | 
| 16 | 
            +
             | 
| 17 | 
            +
            <script type="text/javascript" charset="utf-8">
         | 
| 18 | 
            +
              relpath = '../..';
         | 
| 19 | 
            +
              if (relpath != '') relpath += '/';
         | 
| 20 | 
            +
            </script>
         | 
| 21 | 
            +
             | 
| 22 | 
            +
              <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
         | 
| 23 | 
            +
             | 
| 24 | 
            +
              <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
         | 
| 25 | 
            +
             | 
| 26 | 
            +
             | 
| 27 | 
            +
              </head>
         | 
| 28 | 
            +
              <body>
         | 
| 29 | 
            +
                <script type="text/javascript" charset="utf-8">
         | 
| 30 | 
            +
                  if (window.top.frames.main) document.body.className = 'frames';
         | 
| 31 | 
            +
                </script>
         | 
| 32 | 
            +
                
         | 
| 33 | 
            +
                <div id="header">
         | 
| 34 | 
            +
                  <div id="menu">
         | 
| 35 | 
            +
              
         | 
| 36 | 
            +
                <a href="../../_index.html">Index (S)</a> » 
         | 
| 37 | 
            +
                <span class='title'><span class='object_link'><a href="../../Pupil.html" title="Pupil (class)">Pupil</a></span></span> » <span class='title'><span class='object_link'><a href="../Stream.html" title="Pupil::Stream (class)">Stream</a></span></span>
         | 
| 38 | 
            +
                 » 
         | 
| 39 | 
            +
                <span class="title">Status</span>
         | 
| 40 | 
            +
              
         | 
| 41 | 
            +
              
         | 
| 42 | 
            +
              <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
         | 
| 43 | 
            +
            </div>
         | 
| 44 | 
            +
             | 
| 45 | 
            +
                  <div id="search">
         | 
| 46 | 
            +
              
         | 
| 47 | 
            +
                <a id="class_list_link" href="#">Class List</a>
         | 
| 48 | 
            +
              
         | 
| 49 | 
            +
                <a id="method_list_link" href="#">Method List</a>
         | 
| 50 | 
            +
              
         | 
| 51 | 
            +
                <a id="file_list_link" href="#">File List</a>
         | 
| 52 | 
            +
              
         | 
| 53 | 
            +
            </div>
         | 
| 54 | 
            +
                  <div class="clear"></div>
         | 
| 55 | 
            +
                </div>
         | 
| 56 | 
            +
                
         | 
| 57 | 
            +
                <iframe id="search_frame"></iframe>
         | 
| 58 | 
            +
                
         | 
| 59 | 
            +
                <div id="content"><h1>Class: Pupil::Stream::Status
         | 
| 60 | 
            +
              
         | 
| 61 | 
            +
              
         | 
| 62 | 
            +
              
         | 
| 63 | 
            +
            </h1>
         | 
| 64 | 
            +
             | 
| 65 | 
            +
            <dl class="box">
         | 
| 66 | 
            +
              
         | 
| 67 | 
            +
                <dt class="r1">Inherits:</dt>
         | 
| 68 | 
            +
                <dd class="r1">
         | 
| 69 | 
            +
                  <span class="inheritName"><span class='object_link'><a href="../Status.html" title="Pupil::Status (class)">Pupil::Status</a></span></span>
         | 
| 70 | 
            +
                  
         | 
| 71 | 
            +
                    <ul class="fullTree">
         | 
| 72 | 
            +
                      <li>Object</li>
         | 
| 73 | 
            +
                      
         | 
| 74 | 
            +
                        <li class="next"><span class='object_link'><a href="../Status.html" title="Pupil::Status (class)">Pupil::Status</a></span></li>
         | 
| 75 | 
            +
                      
         | 
| 76 | 
            +
                        <li class="next">Pupil::Stream::Status</li>
         | 
| 77 | 
            +
                      
         | 
| 78 | 
            +
                    </ul>
         | 
| 79 | 
            +
                    <a href="#" class="inheritanceTree">show all</a>
         | 
| 80 | 
            +
                  
         | 
| 81 | 
            +
                  </dd>
         | 
| 82 | 
            +
                
         | 
| 83 | 
            +
              
         | 
| 84 | 
            +
              
         | 
| 85 | 
            +
                
         | 
| 86 | 
            +
              
         | 
| 87 | 
            +
                
         | 
| 88 | 
            +
              
         | 
| 89 | 
            +
              
         | 
| 90 | 
            +
              
         | 
| 91 | 
            +
                <dt class="r2 last">Defined in:</dt>
         | 
| 92 | 
            +
                <dd class="r2 last">lib/pupil/stream/base.rb</dd>
         | 
| 93 | 
            +
              
         | 
| 94 | 
            +
            </dl>
         | 
| 95 | 
            +
            <div class="clear"></div>
         | 
| 96 | 
            +
             | 
| 97 | 
            +
            <h2>Overview</h2><div class="docstring">
         | 
| 98 | 
            +
              <div class="discussion">
         | 
| 99 | 
            +
                <p>
         | 
| 100 | 
            +
            Stream Status
         | 
| 101 | 
            +
            </p>
         | 
| 102 | 
            +
             | 
| 103 | 
            +
             | 
| 104 | 
            +
              </div>
         | 
| 105 | 
            +
            </div>
         | 
| 106 | 
            +
            <div class="tags">
         | 
| 107 | 
            +
              
         | 
| 108 | 
            +
             | 
| 109 | 
            +
            </div>
         | 
| 110 | 
            +
             | 
| 111 | 
            +
              
         | 
| 112 | 
            +
              
         | 
| 113 | 
            +
              
         | 
| 114 | 
            +
              
         | 
| 115 | 
            +
              <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
         | 
| 116 | 
            +
              <ul class="summary">
         | 
| 117 | 
            +
                
         | 
| 118 | 
            +
                  <li class="public ">
         | 
| 119 | 
            +
              <span class="summary_signature">
         | 
| 120 | 
            +
                
         | 
| 121 | 
            +
                  <a href="#event-instance_method" title="#event (instance method)">- (Object) <strong>event</strong> </a>
         | 
| 122 | 
            +
                
         | 
| 123 | 
            +
             | 
| 124 | 
            +
                
         | 
| 125 | 
            +
              </span>
         | 
| 126 | 
            +
              
         | 
| 127 | 
            +
              
         | 
| 128 | 
            +
                <span class="note title readonly">readonly</span>
         | 
| 129 | 
            +
                
         | 
| 130 | 
            +
              
         | 
| 131 | 
            +
              
         | 
| 132 | 
            +
              
         | 
| 133 | 
            +
              
         | 
| 134 | 
            +
              
         | 
| 135 | 
            +
             | 
| 136 | 
            +
              
         | 
| 137 | 
            +
                <span class="summary_desc"><div class='inline'><p>
         | 
| 138 | 
            +
            Returns the value of attribute event.
         | 
| 139 | 
            +
            </p>
         | 
| 140 | 
            +
            </div></span>
         | 
| 141 | 
            +
              
         | 
| 142 | 
            +
            </li>
         | 
| 143 | 
            +
             | 
| 144 | 
            +
                
         | 
| 145 | 
            +
                  <li class="public ">
         | 
| 146 | 
            +
              <span class="summary_signature">
         | 
| 147 | 
            +
                
         | 
| 148 | 
            +
                  <a href="#retweeted_status-instance_method" title="#retweeted_status (instance method)">- (Object) <strong>retweeted_status</strong> </a>
         | 
| 149 | 
            +
                
         | 
| 150 | 
            +
             | 
| 151 | 
            +
                
         | 
| 152 | 
            +
              </span>
         | 
| 153 | 
            +
              
         | 
| 154 | 
            +
              
         | 
| 155 | 
            +
                <span class="note title readonly">readonly</span>
         | 
| 156 | 
            +
                
         | 
| 157 | 
            +
              
         | 
| 158 | 
            +
              
         | 
| 159 | 
            +
              
         | 
| 160 | 
            +
              
         | 
| 161 | 
            +
              
         | 
| 162 | 
            +
             | 
| 163 | 
            +
              
         | 
| 164 | 
            +
                <span class="summary_desc"><div class='inline'><p>
         | 
| 165 | 
            +
            Returns the value of attribute retweeted_status.
         | 
| 166 | 
            +
            </p>
         | 
| 167 | 
            +
            </div></span>
         | 
| 168 | 
            +
              
         | 
| 169 | 
            +
            </li>
         | 
| 170 | 
            +
             | 
| 171 | 
            +
                
         | 
| 172 | 
            +
              </ul>
         | 
| 173 | 
            +
             | 
| 174 | 
            +
             | 
| 175 | 
            +
             | 
| 176 | 
            +
              
         | 
| 177 | 
            +
              
         | 
| 178 | 
            +
              
         | 
| 179 | 
            +
              
         | 
| 180 | 
            +
              
         | 
| 181 | 
            +
              <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Status.html" title="Pupil::Status (class)">Pupil::Status</a></span></h3>
         | 
| 182 | 
            +
              <p class="inherited"><span class='object_link'><a href="../Status.html#contributors-instance_method" title="Pupil::Status#contributors (method)">contributors</a></span>, <span class='object_link'><a href="../Status.html#coordinates-instance_method" title="Pupil::Status#coordinates (method)">coordinates</a></span>, <span class='object_link'><a href="../Status.html#created_at-instance_method" title="Pupil::Status#created_at (method)">created_at</a></span>, <span class='object_link'><a href="../Status.html#favorited-instance_method" title="Pupil::Status#favorited (method)">favorited</a></span>, <span class='object_link'><a href="../Status.html#geo-instance_method" title="Pupil::Status#geo (method)">geo</a></span>, <span class='object_link'><a href="../Status.html#id-instance_method" title="Pupil::Status#id (method)">id</a></span>, <span class='object_link'><a href="../Status.html#id_str-instance_method" title="Pupil::Status#id_str (method)">id_str</a></span>, <span class='object_link'><a href="../Status.html#in_reply_to_screen_name-instance_method" title="Pupil::Status#in_reply_to_screen_name (method)">in_reply_to_screen_name</a></span>, <span class='object_link'><a href="../Status.html#in_reply_to_status_id-instance_method" title="Pupil::Status#in_reply_to_status_id (method)">in_reply_to_status_id</a></span>, <span class='object_link'><a href="../Status.html#in_reply_to_status_id_str-instance_method" title="Pupil::Status#in_reply_to_status_id_str (method)">in_reply_to_status_id_str</a></span>, <span class='object_link'><a href="../Status.html#in_reply_to_user_id-instance_method" title="Pupil::Status#in_reply_to_user_id (method)">in_reply_to_user_id</a></span>, <span class='object_link'><a href="../Status.html#in_reply_to_user_id_str-instance_method" title="Pupil::Status#in_reply_to_user_id_str (method)">in_reply_to_user_id_str</a></span>, <span class='object_link'><a href="../Status.html#place-instance_method" title="Pupil::Status#place (method)">place</a></span>, <span class='object_link'><a href="../Status.html#retweet_count-instance_method" title="Pupil::Status#retweet_count (method)">retweet_count</a></span>, <span class='object_link'><a href="../Status.html#retweeted-instance_method" title="Pupil::Status#retweeted (method)">retweeted</a></span>, <span class='object_link'><a href="../Status.html#source-instance_method" title="Pupil::Status#source (method)">source</a></span>, <span class='object_link'><a href="../Status.html#text-instance_method" title="Pupil::Status#text (method)">text</a></span>, <span class='object_link'><a href="../Status.html#truncated-instance_method" title="Pupil::Status#truncated (method)">truncated</a></span>, <span class='object_link'><a href="../Status.html#user-instance_method" title="Pupil::Status#user (method)">user</a></span></p>
         | 
| 183 | 
            +
             | 
| 184 | 
            +
             | 
| 185 | 
            +
              
         | 
| 186 | 
            +
                <h2>
         | 
| 187 | 
            +
                  Instance Method Summary
         | 
| 188 | 
            +
                  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
         | 
| 189 | 
            +
                </h2>
         | 
| 190 | 
            +
             | 
| 191 | 
            +
                <ul class="summary">
         | 
| 192 | 
            +
                  
         | 
| 193 | 
            +
                    <li class="public ">
         | 
| 194 | 
            +
              <span class="summary_signature">
         | 
| 195 | 
            +
                
         | 
| 196 | 
            +
                  <a href="#initialize-instance_method" title="#initialize (instance method)">- (Status) <strong>initialize</strong>(status, event = nil) </a>
         | 
| 197 | 
            +
                
         | 
| 198 | 
            +
             | 
| 199 | 
            +
                
         | 
| 200 | 
            +
              </span>
         | 
| 201 | 
            +
              
         | 
| 202 | 
            +
                <span class="note title constructor">constructor</span>
         | 
| 203 | 
            +
              
         | 
| 204 | 
            +
              
         | 
| 205 | 
            +
              
         | 
| 206 | 
            +
              
         | 
| 207 | 
            +
              
         | 
| 208 | 
            +
              
         | 
| 209 | 
            +
             | 
| 210 | 
            +
              
         | 
| 211 | 
            +
                <span class="summary_desc"><div class='inline'><p>
         | 
| 212 | 
            +
            A new instance of Status.
         | 
| 213 | 
            +
            </p>
         | 
| 214 | 
            +
            </div></span>
         | 
| 215 | 
            +
              
         | 
| 216 | 
            +
            </li>
         | 
| 217 | 
            +
             | 
| 218 | 
            +
                  
         | 
| 219 | 
            +
                </ul>
         | 
| 220 | 
            +
              
         | 
| 221 | 
            +
             | 
| 222 | 
            +
             | 
| 223 | 
            +
              
         | 
| 224 | 
            +
              
         | 
| 225 | 
            +
              
         | 
| 226 | 
            +
              
         | 
| 227 | 
            +
              <div id="constructor_details" class="method_details_list">
         | 
| 228 | 
            +
              <h2>Constructor Details</h2>
         | 
| 229 | 
            +
              
         | 
| 230 | 
            +
                <div class="method_details first">
         | 
| 231 | 
            +
              <p class="signature first" id="initialize-instance_method">
         | 
| 232 | 
            +
              
         | 
| 233 | 
            +
                - (<tt><span class='object_link'><a href="" title="Pupil::Stream::Status (class)">Status</a></span></tt>) <strong>initialize</strong>(status, event = nil) 
         | 
| 234 | 
            +
              
         | 
| 235 | 
            +
             | 
| 236 | 
            +
              
         | 
| 237 | 
            +
            </p><div class="docstring">
         | 
| 238 | 
            +
              <div class="discussion">
         | 
| 239 | 
            +
                <p>
         | 
| 240 | 
            +
            A new instance of Status
         | 
| 241 | 
            +
            </p>
         | 
| 242 | 
            +
             | 
| 243 | 
            +
             | 
| 244 | 
            +
              </div>
         | 
| 245 | 
            +
            </div>
         | 
| 246 | 
            +
            <div class="tags">
         | 
| 247 | 
            +
              
         | 
| 248 | 
            +
             | 
| 249 | 
            +
            </div><table class="source_code">
         | 
| 250 | 
            +
              <tr>
         | 
| 251 | 
            +
                <td>
         | 
| 252 | 
            +
                  <pre class="lines">
         | 
| 253 | 
            +
             | 
| 254 | 
            +
             | 
| 255 | 
            +
            91
         | 
| 256 | 
            +
            92
         | 
| 257 | 
            +
            93
         | 
| 258 | 
            +
            94
         | 
| 259 | 
            +
            95</pre>
         | 
| 260 | 
            +
                </td>
         | 
| 261 | 
            +
                <td>
         | 
| 262 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 91</span>
         | 
| 263 | 
            +
             | 
| 264 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_event'>event</span><span class='op'>=</span><span class='kw'>nil</span>
         | 
| 265 | 
            +
              <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
         | 
| 266 | 
            +
              <span class='ivar'>@event</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_event'>event</span><span class='rparen'>)</span><span class='op'>?</span> <span class='id identifier rubyid_event'>event</span> <span class='op'>:</span> <span class='symbol'>:status</span>
         | 
| 267 | 
            +
              <span class='ivar'>@retweeted_status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>retweeted_status</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
         | 
| 268 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 269 | 
            +
                </td>
         | 
| 270 | 
            +
              </tr>
         | 
| 271 | 
            +
            </table>
         | 
| 272 | 
            +
            </div>
         | 
| 273 | 
            +
              
         | 
| 274 | 
            +
            </div>
         | 
| 275 | 
            +
             | 
| 276 | 
            +
              <div id="instance_attr_details" class="attr_details">
         | 
| 277 | 
            +
                <h2>Instance Attribute Details</h2>
         | 
| 278 | 
            +
                
         | 
| 279 | 
            +
                  
         | 
| 280 | 
            +
                  <span id=""></span>
         | 
| 281 | 
            +
                  <span id="event-instance_method"></span>
         | 
| 282 | 
            +
                  <div class="method_details first">
         | 
| 283 | 
            +
              <p class="signature first" id="event-instance_method">
         | 
| 284 | 
            +
              
         | 
| 285 | 
            +
                - (<tt>Object</tt>) <strong>event</strong>  <span class="extras">(readonly)</span>
         | 
| 286 | 
            +
              
         | 
| 287 | 
            +
             | 
| 288 | 
            +
              
         | 
| 289 | 
            +
            </p><div class="docstring">
         | 
| 290 | 
            +
              <div class="discussion">
         | 
| 291 | 
            +
                <p>
         | 
| 292 | 
            +
            Returns the value of attribute event
         | 
| 293 | 
            +
            </p>
         | 
| 294 | 
            +
             | 
| 295 | 
            +
             | 
| 296 | 
            +
              </div>
         | 
| 297 | 
            +
            </div>
         | 
| 298 | 
            +
            <div class="tags">
         | 
| 299 | 
            +
              
         | 
| 300 | 
            +
             | 
| 301 | 
            +
            </div><table class="source_code">
         | 
| 302 | 
            +
              <tr>
         | 
| 303 | 
            +
                <td>
         | 
| 304 | 
            +
                  <pre class="lines">
         | 
| 305 | 
            +
             | 
| 306 | 
            +
             | 
| 307 | 
            +
            88
         | 
| 308 | 
            +
            89
         | 
| 309 | 
            +
            90</pre>
         | 
| 310 | 
            +
                </td>
         | 
| 311 | 
            +
                <td>
         | 
| 312 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 88</span>
         | 
| 313 | 
            +
             | 
| 314 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_event'>event</span>
         | 
| 315 | 
            +
              <span class='ivar'>@event</span>
         | 
| 316 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 317 | 
            +
                </td>
         | 
| 318 | 
            +
              </tr>
         | 
| 319 | 
            +
            </table>
         | 
| 320 | 
            +
            </div>
         | 
| 321 | 
            +
                
         | 
| 322 | 
            +
                  
         | 
| 323 | 
            +
                  <span id=""></span>
         | 
| 324 | 
            +
                  <span id="retweeted_status-instance_method"></span>
         | 
| 325 | 
            +
                  <div class="method_details ">
         | 
| 326 | 
            +
              <p class="signature " id="retweeted_status-instance_method">
         | 
| 327 | 
            +
              
         | 
| 328 | 
            +
                - (<tt>Object</tt>) <strong>retweeted_status</strong>  <span class="extras">(readonly)</span>
         | 
| 329 | 
            +
              
         | 
| 330 | 
            +
             | 
| 331 | 
            +
              
         | 
| 332 | 
            +
            </p><div class="docstring">
         | 
| 333 | 
            +
              <div class="discussion">
         | 
| 334 | 
            +
                <p>
         | 
| 335 | 
            +
            Returns the value of attribute retweeted_status
         | 
| 336 | 
            +
            </p>
         | 
| 337 | 
            +
             | 
| 338 | 
            +
             | 
| 339 | 
            +
              </div>
         | 
| 340 | 
            +
            </div>
         | 
| 341 | 
            +
            <div class="tags">
         | 
| 342 | 
            +
              
         | 
| 343 | 
            +
             | 
| 344 | 
            +
            </div><table class="source_code">
         | 
| 345 | 
            +
              <tr>
         | 
| 346 | 
            +
                <td>
         | 
| 347 | 
            +
                  <pre class="lines">
         | 
| 348 | 
            +
             | 
| 349 | 
            +
             | 
| 350 | 
            +
            89
         | 
| 351 | 
            +
            90
         | 
| 352 | 
            +
            91</pre>
         | 
| 353 | 
            +
                </td>
         | 
| 354 | 
            +
                <td>
         | 
| 355 | 
            +
                  <pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 89</span>
         | 
| 356 | 
            +
             | 
| 357 | 
            +
            <span class='kw'>def</span> <span class='id identifier rubyid_retweeted_status'>retweeted_status</span>
         | 
| 358 | 
            +
              <span class='ivar'>@retweeted_status</span>
         | 
| 359 | 
            +
            <span class='kw'>end</span></pre>
         | 
| 360 | 
            +
                </td>
         | 
| 361 | 
            +
              </tr>
         | 
| 362 | 
            +
            </table>
         | 
| 363 | 
            +
            </div>
         | 
| 364 | 
            +
                
         | 
| 365 | 
            +
              </div>
         | 
| 366 | 
            +
             | 
| 367 | 
            +
             | 
| 368 | 
            +
            </div>
         | 
| 369 | 
            +
                
         | 
| 370 | 
            +
                <div id="footer">
         | 
| 371 | 
            +
              Generated on Sat Dec 17 20:58:33 2011 by 
         | 
| 372 | 
            +
              <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
         | 
| 373 | 
            +
              0.7.4 (ruby-1.9.2).
         | 
| 374 | 
            +
            </div>
         | 
| 375 | 
            +
             | 
| 376 | 
            +
              </body>
         | 
| 377 | 
            +
            </html>
         |