pupil 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +0 -1
- data/Rakefile +12 -12
- data/VERSION +1 -1
- data/doc/Pupil.html +3455 -0
- data/doc/Pupil/DirectMessage.html +848 -0
- data/doc/Pupil/Entities.html +416 -0
- data/doc/Pupil/Hashtag.html +416 -0
- data/doc/Pupil/Keygen.html +838 -0
- data/doc/Pupil/Keygen/MissingRequiredTokens.html +116 -0
- data/doc/Pupil/List.html +992 -0
- data/doc/Pupil/NetworkError.html +116 -0
- data/doc/Pupil/Status.html +1570 -0
- data/doc/Pupil/Stream.html +439 -0
- data/doc/Pupil/Stream/StreamError.html +116 -0
- data/doc/Pupil/Stream/StreamEvent.html +421 -0
- data/doc/Pupil/URL.html +488 -0
- data/doc/Pupil/UnsupportedParameter.html +116 -0
- data/doc/Pupil/User.html +3008 -0
- data/doc/_index.html +282 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.LICENSE.html +85 -0
- data/doc/file.README.html +113 -0
- data/doc/file_list.html +52 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +113 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +1182 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/pupil.rb +1 -9
- data/lib/pupil/base.rb +6 -0
- data/lib/pupil/blocks.rb +3 -4
- data/lib/pupil/keygen.rb +5 -0
- data/lib/pupil/keygen/{keygen.rb → base.rb} +0 -2
- data/lib/pupil/stream.rb +5 -93
- data/lib/pupil/stream/base.rb +94 -0
- data/samples/generate-key.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +53 -22
- data/pupil.gemspec +0 -81
@@ -0,0 +1,439 @@
|
|
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
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.3
|
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>
|
38
|
+
»
|
39
|
+
<span class="title">Stream</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
|
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</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>Defined Under Namespace</h2>
|
96
|
+
<p class="children">
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Stream/StreamError.html" title="Pupil::Stream::StreamError (class)">StreamError</a></span>, <span class='object_link'><a href="Stream/StreamEvent.html" title="Pupil::Stream::StreamEvent (class)">StreamEvent</a></span>
|
102
|
+
|
103
|
+
|
104
|
+
</p>
|
105
|
+
|
106
|
+
<h2>Constant Summary</h2>
|
107
|
+
|
108
|
+
<dl class="constants">
|
109
|
+
|
110
|
+
<dt id="STREAM_APIS-constant" class="">STREAM_APIS =
|
111
|
+
|
112
|
+
</dt>
|
113
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
114
|
+
<span class='symbol'>:userstream</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://userstream.twitter.com/2/user.json</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
115
|
+
<span class='symbol'>:filter</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://stream.twitter.com/1/statuses/filter.json%s</span><span class='tstring_end'>"</span></span>
|
116
|
+
<span class='rbrace'>}</span></pre></dd>
|
117
|
+
|
118
|
+
</dl>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
<h2>
|
127
|
+
Instance Method Summary
|
128
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
129
|
+
</h2>
|
130
|
+
|
131
|
+
<ul class="summary">
|
132
|
+
|
133
|
+
<li class="public ">
|
134
|
+
<span class="summary_signature">
|
135
|
+
|
136
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Stream) <strong>initialize</strong>(key) </a>
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
</span>
|
141
|
+
|
142
|
+
<span class="note title constructor">constructor</span>
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
<span class="summary_desc"><div class='inline'><p>
|
152
|
+
A new instance of Stream.
|
153
|
+
</p>
|
154
|
+
</div></span>
|
155
|
+
|
156
|
+
</li>
|
157
|
+
|
158
|
+
|
159
|
+
<li class="public ">
|
160
|
+
<span class="summary_signature">
|
161
|
+
|
162
|
+
<a href="#run_get_stream-instance_method" title="#run_get_stream (instance method)">- (Object) <strong>run_get_stream</strong>(type, param = nil, &block) </a>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
</span>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
176
|
+
|
177
|
+
</li>
|
178
|
+
|
179
|
+
|
180
|
+
<li class="public ">
|
181
|
+
<span class="summary_signature">
|
182
|
+
|
183
|
+
<a href="#start-instance_method" title="#start (instance method)">- (Object) <strong>start</strong>(type, param = nil, &block) </a>
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
</span>
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
197
|
+
|
198
|
+
</li>
|
199
|
+
|
200
|
+
|
201
|
+
</ul>
|
202
|
+
|
203
|
+
|
204
|
+
<div id="constructor_details" class="method_details_list">
|
205
|
+
<h2>Constructor Details</h2>
|
206
|
+
|
207
|
+
<div class="method_details first">
|
208
|
+
<p class="signature first" id="initialize-instance_method">
|
209
|
+
|
210
|
+
- (<tt><span class='object_link'><a href="" title="Pupil::Stream (class)">Stream</a></span></tt>) <strong>initialize</strong>(key)
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</p><div class="docstring">
|
215
|
+
<div class="discussion">
|
216
|
+
<p>
|
217
|
+
A new instance of Stream
|
218
|
+
</p>
|
219
|
+
|
220
|
+
|
221
|
+
</div>
|
222
|
+
</div>
|
223
|
+
<div class="tags">
|
224
|
+
|
225
|
+
|
226
|
+
</div><table class="source_code">
|
227
|
+
<tr>
|
228
|
+
<td>
|
229
|
+
<pre class="lines">
|
230
|
+
|
231
|
+
|
232
|
+
9
|
233
|
+
10
|
234
|
+
11
|
235
|
+
12
|
236
|
+
13
|
237
|
+
14
|
238
|
+
15
|
239
|
+
16
|
240
|
+
17
|
241
|
+
18
|
242
|
+
19
|
243
|
+
20
|
244
|
+
21
|
245
|
+
22
|
246
|
+
23
|
247
|
+
24</pre>
|
248
|
+
</td>
|
249
|
+
<td>
|
250
|
+
<pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 9</span>
|
251
|
+
|
252
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span> <span class='id key'>key</span>
|
253
|
+
<span class='ivar'>@screen_name</span> <span class='op'>=</span> <span class='id key'>key</span><span class='lbracket'>[</span><span class='symbol'>:screen_name</span><span class='rbracket'>]</span>
|
254
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
255
|
+
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
256
|
+
|
257
|
+
<span class='ivar'>@consumer</span> <span class='op'>=</span> <span class='const'>OAuth</span><span class='op'>::</span><span class='const'>Consumer</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span>
|
258
|
+
<span class='id key'>key</span><span class='lbracket'>[</span><span class='symbol'>:consumer_key</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
259
|
+
<span class='id key'>key</span><span class='lbracket'>[</span><span class='symbol'>:consumer_secret</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
260
|
+
<span class='symbol'>:site</span> <span class='op'>=></span> <span class='const'>TWITTER_API_URL</span>
|
261
|
+
<span class='rparen'>)</span>
|
262
|
+
<span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='const'>OAuth</span><span class='op'>::</span><span class='const'>AccessToken</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span>
|
263
|
+
<span class='ivar'>@consumer</span><span class='comma'>,</span>
|
264
|
+
<span class='id key'>key</span><span class='lbracket'>[</span><span class='symbol'>:access_token</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
265
|
+
<span class='id key'>key</span><span class='lbracket'>[</span><span class='symbol'>:access_token_secret</span><span class='rbracket'>]</span>
|
266
|
+
<span class='rparen'>)</span>
|
267
|
+
<span class='kw'>end</span></pre>
|
268
|
+
</td>
|
269
|
+
</tr>
|
270
|
+
</table>
|
271
|
+
</div>
|
272
|
+
|
273
|
+
</div>
|
274
|
+
|
275
|
+
|
276
|
+
<div id="instance_method_details" class="method_details_list">
|
277
|
+
<h2>Instance Method Details</h2>
|
278
|
+
|
279
|
+
|
280
|
+
<div class="method_details first">
|
281
|
+
<p class="signature first" id="run_get_stream-instance_method">
|
282
|
+
|
283
|
+
- (<tt>Object</tt>) <strong>run_get_stream</strong>(type, param = nil, &block)
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
</p><table class="source_code">
|
288
|
+
<tr>
|
289
|
+
<td>
|
290
|
+
<pre class="lines">
|
291
|
+
|
292
|
+
|
293
|
+
32
|
294
|
+
33
|
295
|
+
34
|
296
|
+
35
|
297
|
+
36
|
298
|
+
37
|
299
|
+
38
|
300
|
+
39
|
301
|
+
40
|
302
|
+
41
|
303
|
+
42
|
304
|
+
43
|
305
|
+
44
|
306
|
+
45
|
307
|
+
46
|
308
|
+
47
|
309
|
+
48
|
310
|
+
49
|
311
|
+
50
|
312
|
+
51
|
313
|
+
52
|
314
|
+
53
|
315
|
+
54
|
316
|
+
55
|
317
|
+
56
|
318
|
+
57
|
319
|
+
58
|
320
|
+
59
|
321
|
+
60
|
322
|
+
61
|
323
|
+
62
|
324
|
+
63
|
325
|
+
64
|
326
|
+
65
|
327
|
+
66
|
328
|
+
67</pre>
|
329
|
+
</td>
|
330
|
+
<td>
|
331
|
+
<pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 32</span>
|
332
|
+
|
333
|
+
<span class='kw'>def</span> <span class='id run_get_stream'>run_get_stream</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id param'>param</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span><span class='rparen'>)</span>
|
334
|
+
<span class='id uri'>uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id parse'>parse</span><span class='lparen'>(</span><span class='const'>STREAM_APIS</span><span class='lbracket'>[</span><span class='id type'>type</span><span class='rbracket'>]</span> <span class='op'>%</span> <span class='const'>Pupil</span><span class='period'>.</span><span class='id param_serializer'>param_serializer</span><span class='lparen'>(</span><span class='id param'>param</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
335
|
+
<span class='id https'>https</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id uri'>uri</span><span class='period'>.</span><span class='id host'>host</span><span class='comma'>,</span> <span class='id uri'>uri</span><span class='period'>.</span><span class='id port'>port</span><span class='rparen'>)</span>
|
336
|
+
<span class='id https'>https</span><span class='period'>.</span><span class='id use_ssl'>use_ssl</span> <span class='op'>=</span> <span class='kw'>true</span>
|
337
|
+
<span class='id https'>https</span><span class='period'>.</span><span class='id verify_mode'>verify_mode</span> <span class='op'>=</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>SSL</span><span class='op'>::</span><span class='const'>VERIFY_NONE</span>
|
338
|
+
<span class='id https'>https</span><span class='period'>.</span><span class='id verify_depth'>verify_depth</span> <span class='op'>=</span> <span class='int'>5</span>
|
339
|
+
|
340
|
+
<span class='kw'>while</span> <span class='kw'>true</span> <span class='kw'>do</span>
|
341
|
+
<span class='kw'>begin</span>
|
342
|
+
<span class='id https'>https</span><span class='period'>.</span><span class='id start'>start</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id https'>https</span><span class='op'>|</span>
|
343
|
+
<span class='id request'>request</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id uri'>uri</span><span class='period'>.</span><span class='id request_uri'>request_uri</span><span class='rparen'>)</span>
|
344
|
+
<span class='id request'>request</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Ruby/</span><span class='embexpr_beg'>#{</span><span class='const'>RUBY_VERSION</span><span class='rbrace'>}</span><span class='tstring_content'> Pupil::Stream</span><span class='tstring_end'>"</span></span>
|
345
|
+
<span class='id request'>request</span><span class='period'>.</span><span class='id oauth!'>oauth!</span><span class='lparen'>(</span><span class='id https'>https</span><span class='comma'>,</span> <span class='ivar'>@consumer</span><span class='comma'>,</span> <span class='ivar'>@access_token</span><span class='rparen'>)</span>
|
346
|
+
<span class='id buf'>buf</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
347
|
+
<span class='id https'>https</span><span class='period'>.</span><span class='id request'>request</span><span class='lparen'>(</span><span class='id request'>request</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id response'>response</span><span class='op'>|</span>
|
348
|
+
<span class='id response'>response</span><span class='period'>.</span><span class='id read_body'>read_body</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chunk'>chunk</span><span class='op'>|</span>
|
349
|
+
<span class='id buf'>buf</span> <span class='op'><<</span> <span class='id chunk'>chunk</span>
|
350
|
+
<span class='kw'>while</span> <span class='lparen'>(</span><span class='id line'>line</span> <span class='op'>=</span> <span class='id buf'>buf</span><span class='lbracket'>[</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>.+?(\r\n)+</span><span class='regexp_end'>/m</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>nil</span>
|
351
|
+
<span class='kw'>begin</span>
|
352
|
+
<span class='id buf'>buf</span><span class='period'>.</span><span class='id sub!'>sub!</span><span class='lparen'>(</span><span class='id line'>line</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
353
|
+
<span class='id line'>line</span><span class='period'>.</span><span class='id strip!'>strip!</span>
|
354
|
+
<span class='id status'>status</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id parse'>parse</span><span class='lparen'>(</span><span class='id line'>line</span><span class='rparen'>)</span>
|
355
|
+
<span class='kw'>rescue</span>
|
356
|
+
<span class='kw'>break</span>
|
357
|
+
<span class='kw'>end</span>
|
358
|
+
|
359
|
+
<span class='id block'>block</span><span class='period'>.</span><span class='id call'>call</span> <span class='const'>StreamEvent</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id status'>status</span><span class='rparen'>)</span>
|
360
|
+
<span class='kw'>end</span>
|
361
|
+
<span class='kw'>end</span>
|
362
|
+
<span class='kw'>end</span>
|
363
|
+
<span class='kw'>end</span>
|
364
|
+
<span class='kw'>rescue</span> <span class='op'>=></span> <span class='id vars'>vars</span>
|
365
|
+
<span class='id raise'>raise</span> <span class='const'>StreamError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>StreamError: </span><span class='embexpr_beg'>#{</span><span class='id vars'>vars</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
366
|
+
<span class='kw'>end</span>
|
367
|
+
<span class='kw'>end</span>
|
368
|
+
<span class='kw'>end</span></pre>
|
369
|
+
</td>
|
370
|
+
</tr>
|
371
|
+
</table>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
<div class="method_details ">
|
375
|
+
<p class="signature " id="start-instance_method">
|
376
|
+
|
377
|
+
- (<tt>Object</tt>) <strong>start</strong>(type, param = nil, &block)
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
</p><div class="docstring">
|
382
|
+
<div class="discussion">
|
383
|
+
|
384
|
+
|
385
|
+
</div>
|
386
|
+
</div>
|
387
|
+
<div class="tags">
|
388
|
+
|
389
|
+
<h3>Raises:</h3>
|
390
|
+
<ul class="raise">
|
391
|
+
|
392
|
+
<li>
|
393
|
+
|
394
|
+
|
395
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
</li>
|
400
|
+
|
401
|
+
</ul>
|
402
|
+
|
403
|
+
</div><table class="source_code">
|
404
|
+
<tr>
|
405
|
+
<td>
|
406
|
+
<pre class="lines">
|
407
|
+
|
408
|
+
|
409
|
+
26
|
410
|
+
27
|
411
|
+
28
|
412
|
+
29
|
413
|
+
30</pre>
|
414
|
+
</td>
|
415
|
+
<td>
|
416
|
+
<pre class="code"><span class="info file"># File 'lib/pupil/stream/base.rb', line 26</span>
|
417
|
+
|
418
|
+
<span class='kw'>def</span> <span class='id start'>start</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id param'>param</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span><span class='rparen'>)</span>
|
419
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='id block_given?'>block_given?</span>
|
420
|
+
|
421
|
+
<span class='id run_get_stream'>run_get_stream</span> <span class='id type'>type</span><span class='comma'>,</span> <span class='id param'>param</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span>
|
422
|
+
<span class='kw'>end</span></pre>
|
423
|
+
</td>
|
424
|
+
</tr>
|
425
|
+
</table>
|
426
|
+
</div>
|
427
|
+
|
428
|
+
</div>
|
429
|
+
|
430
|
+
</div>
|
431
|
+
|
432
|
+
<div id="footer">
|
433
|
+
Generated on Fri Dec 16 17:19:17 2011 by
|
434
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
435
|
+
0.7.3 (ruby-1.9.2).
|
436
|
+
</div>
|
437
|
+
|
438
|
+
</body>
|
439
|
+
</html>
|
@@ -0,0 +1,116 @@
|
|
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
|
+
Exception: Pupil::Stream::StreamError
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.3
|
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">StreamError</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>Exception: Pupil::Stream::StreamError
|
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">StandardError</span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next">StandardError</li>
|
75
|
+
|
76
|
+
<li class="next">Pupil::Stream::StreamError</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
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
</div>
|
108
|
+
|
109
|
+
<div id="footer">
|
110
|
+
Generated on Fri Dec 16 17:19:17 2011 by
|
111
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
112
|
+
0.7.3 (ruby-1.9.2).
|
113
|
+
</div>
|
114
|
+
|
115
|
+
</body>
|
116
|
+
</html>
|