mir 0.1.4 → 0.1.5

Sign up to get free protection for your applications and to get access to all the features.
@@ -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: Mir::Disk::IncompleteTransmission
8
+
9
+ &mdash; Documentation by YARD 0.7.2
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 (I)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mir.html" title="Mir (module)">Mir</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Disk.html" title="Mir::Disk (module)">Disk</a></span></span>
38
+ &raquo;
39
+ <span class="title">IncompleteTransmission</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: Mir::Disk::IncompleteTransmission
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">Mir::Disk::IncompleteTransmission</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/mir/disk.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 Sep 23 18:24:38 2011 by
111
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.7.2 (ruby-1.9.2).
113
+ </div>
114
+
115
+ </body>
116
+ </html>
@@ -0,0 +1,586 @@
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: Mir::Disk::MultiPartFile
8
+
9
+ &mdash; Documentation by YARD 0.7.2
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 (M)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mir.html" title="Mir (module)">Mir</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Disk.html" title="Mir::Disk (module)">Disk</a></span></span>
38
+ &raquo;
39
+ <span class="title">MultiPartFile</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: Mir::Disk::MultiPartFile
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">Mir::Disk::MultiPartFile</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/mir/disk/amazon.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
+ Used to hide the inner details of multipart file uploads and downloads. It
99
+ is important that this class does not throw any exceptions as these
100
+ exceptions may be swallowed further up the stack by worker threads
101
+ </p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+ </div>
109
+
110
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
111
+ <ul class="summary">
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature">
115
+
116
+ <a href="#disk-instance_method" title="#disk (instance method)">- (Object) <strong>disk</strong> </a>
117
+
118
+
119
+
120
+ </span>
121
+
122
+
123
+ <span class="note title readonly">readonly</span>
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+ <span class="summary_desc"><div class='inline'><p>
133
+ Returns the value of attribute disk.
134
+ </p>
135
+ </div></span>
136
+
137
+ </li>
138
+
139
+
140
+ <li class="public ">
141
+ <span class="summary_signature">
142
+
143
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
144
+
145
+
146
+
147
+ </span>
148
+
149
+
150
+ <span class="note title readonly">readonly</span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'><p>
160
+ Returns the value of attribute name.
161
+ </p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ </ul>
168
+
169
+
170
+
171
+
172
+
173
+ <h2>
174
+ Instance Method Summary
175
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
176
+ </h2>
177
+
178
+ <ul class="summary">
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#get-instance_method" title="#get (instance method)">- (Object) <strong>get</strong>(dest) </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <span class="summary_desc"><div class='inline'><p>
197
+ Downloads the resource to the destination.
198
+ </p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (MultiPartFile) <strong>initialize</strong>(disk, name) </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+ <span class="note title constructor">constructor</span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <span class="summary_desc"><div class='inline'><p>
223
+ A new instance of MultiPartFile.
224
+ </p>
225
+ </div></span>
226
+
227
+ </li>
228
+
229
+
230
+ <li class="public ">
231
+ <span class="summary_signature">
232
+
233
+ <a href="#multipart%3F-instance_method" title="#multipart? (instance method)">- (Boolean) <strong>multipart?</strong> </a>
234
+
235
+
236
+
237
+ </span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'><p>
247
+ Whether the resource is broken into chunks on the remote store.
248
+ </p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ </ul>
255
+
256
+
257
+ <div id="constructor_details" class="method_details_list">
258
+ <h2>Constructor Details</h2>
259
+
260
+ <div class="method_details first">
261
+ <p class="signature first" id="initialize-instance_method">
262
+
263
+ - (<tt><span class='object_link'><a href="" title="Mir::Disk::MultiPartFile (class)">MultiPartFile</a></span></tt>) <strong>initialize</strong>(disk, name)
264
+
265
+
266
+
267
+ </p><div class="docstring">
268
+ <div class="discussion">
269
+ <p>
270
+ A new instance of MultiPartFile
271
+ </p>
272
+
273
+
274
+ </div>
275
+ </div>
276
+ <div class="tags">
277
+ <h3>Parameters:</h3>
278
+ <ul class="param">
279
+
280
+ <li>
281
+
282
+ <span class='name'>the</span>
283
+
284
+
285
+ <span class='type'>(<tt><span class='object_link'><a href="../Disk.html" title="Mir::Disk (module)">Disk</a></span></tt>)</span>
286
+
287
+
288
+
289
+ &mdash;
290
+ <div class='inline'><p>
291
+ remote disk
292
+ </p>
293
+ </div>
294
+
295
+ </li>
296
+
297
+ <li>
298
+
299
+ <span class='name'>the</span>
300
+
301
+
302
+ <span class='type'>(<tt>String</tt>)</span>
303
+
304
+
305
+
306
+ &mdash;
307
+ <div class='inline'><p>
308
+ name of the resource
309
+ </p>
310
+ </div>
311
+
312
+ </li>
313
+
314
+ </ul>
315
+
316
+ </div><table class="source_code">
317
+ <tr>
318
+ <td>
319
+ <pre class="lines">
320
+
321
+
322
+ 238
323
+ 239
324
+ 240
325
+ 241
326
+ 242
327
+ 243
328
+ 244
329
+ 245
330
+ 246
331
+ 247
332
+ 248
333
+ 249</pre>
334
+ </td>
335
+ <td>
336
+ <pre class="code"><span class="info file"># File 'lib/mir/disk/amazon.rb', line 238</span>
337
+
338
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id disk'>disk</span><span class='comma'>,</span> <span class='id name'>name</span><span class='rparen'>)</span>
339
+ <span class='ivar'>@disk</span><span class='comma'>,</span> <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id disk'>disk</span><span class='comma'>,</span> <span class='id name'>name</span>
340
+ <span class='id multiname'>multiname</span> <span class='op'>=</span> <span class='const'>Utils</span><span class='period'>.</span><span class='id filename_with_sequence'>filename_with_sequence</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span>
341
+
342
+ <span class='kw'>if</span> <span class='id disk'>disk</span><span class='period'>.</span><span class='id key_exists?'>key_exists?</span><span class='lparen'>(</span><span class='id name'>name</span><span class='rparen'>)</span>
343
+ <span class='ivar'>@multipart</span> <span class='op'>=</span> <span class='kw'>false</span>
344
+ <span class='kw'>elsif</span> <span class='id disk'>disk</span><span class='period'>.</span><span class='id key_exists?'>key_exists?</span><span class='lparen'>(</span><span class='id multiname'>multiname</span><span class='rparen'>)</span>
345
+ <span class='ivar'>@multipart</span> <span class='op'>=</span> <span class='kw'>true</span>
346
+ <span class='kw'>else</span>
347
+ <span class='id raise'>raise</span> <span class='const'>Disk</span><span class='op'>::</span><span class='const'>RemoteFileNotFound</span>
348
+ <span class='kw'>end</span>
349
+ <span class='kw'>end</span></pre>
350
+ </td>
351
+ </tr>
352
+ </table>
353
+ </div>
354
+
355
+ </div>
356
+
357
+ <div id="instance_attr_details" class="attr_details">
358
+ <h2>Instance Attribute Details</h2>
359
+
360
+
361
+ <span id=""></span>
362
+ <span id="disk-instance_method"></span>
363
+ <div class="method_details first">
364
+ <p class="signature first" id="disk-instance_method">
365
+
366
+ - (<tt>Object</tt>) <strong>disk</strong> <span class="extras">(readonly)</span>
367
+
368
+
369
+
370
+ </p><div class="docstring">
371
+ <div class="discussion">
372
+ <p>
373
+ Returns the value of attribute disk
374
+ </p>
375
+
376
+
377
+ </div>
378
+ </div>
379
+ <div class="tags">
380
+
381
+ </div><table class="source_code">
382
+ <tr>
383
+ <td>
384
+ <pre class="lines">
385
+
386
+
387
+ 251
388
+ 252
389
+ 253</pre>
390
+ </td>
391
+ <td>
392
+ <pre class="code"><span class="info file"># File 'lib/mir/disk/amazon.rb', line 251</span>
393
+
394
+ <span class='kw'>def</span> <span class='id disk'>disk</span>
395
+ <span class='ivar'>@disk</span>
396
+ <span class='kw'>end</span></pre>
397
+ </td>
398
+ </tr>
399
+ </table>
400
+ </div>
401
+
402
+
403
+ <span id=""></span>
404
+ <span id="name-instance_method"></span>
405
+ <div class="method_details ">
406
+ <p class="signature " id="name-instance_method">
407
+
408
+ - (<tt>Object</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
409
+
410
+
411
+
412
+ </p><div class="docstring">
413
+ <div class="discussion">
414
+ <p>
415
+ Returns the value of attribute name
416
+ </p>
417
+
418
+
419
+ </div>
420
+ </div>
421
+ <div class="tags">
422
+
423
+ </div><table class="source_code">
424
+ <tr>
425
+ <td>
426
+ <pre class="lines">
427
+
428
+
429
+ 251
430
+ 252
431
+ 253</pre>
432
+ </td>
433
+ <td>
434
+ <pre class="code"><span class="info file"># File 'lib/mir/disk/amazon.rb', line 251</span>
435
+
436
+ <span class='kw'>def</span> <span class='id name'>name</span>
437
+ <span class='ivar'>@name</span>
438
+ <span class='kw'>end</span></pre>
439
+ </td>
440
+ </tr>
441
+ </table>
442
+ </div>
443
+
444
+ </div>
445
+
446
+
447
+ <div id="instance_method_details" class="method_details_list">
448
+ <h2>Instance Method Details</h2>
449
+
450
+
451
+ <div class="method_details first">
452
+ <p class="signature first" id="get-instance_method">
453
+
454
+ - (<tt>Object</tt>) <strong>get</strong>(dest)
455
+
456
+
457
+
458
+ </p><div class="docstring">
459
+ <div class="discussion">
460
+ <p>
461
+ Downloads the resource to the destination. If the file is stored in parts
462
+ it is download sequentially in pieces
463
+ </p>
464
+
465
+
466
+ </div>
467
+ </div>
468
+ <div class="tags">
469
+
470
+ </div><table class="source_code">
471
+ <tr>
472
+ <td>
473
+ <pre class="lines">
474
+
475
+
476
+ 260
477
+ 261
478
+ 262
479
+ 263
480
+ 264
481
+ 265
482
+ 266
483
+ 267
484
+ 268
485
+ 269
486
+ 270
487
+ 271
488
+ 272
489
+ 273
490
+ 274
491
+ 275
492
+ 276
493
+ 277
494
+ 278</pre>
495
+ </td>
496
+ <td>
497
+ <pre class="code"><span class="info file"># File 'lib/mir/disk/amazon.rb', line 260</span>
498
+
499
+ <span class='kw'>def</span> <span class='id get'>get</span><span class='lparen'>(</span><span class='id dest'>dest</span><span class='rparen'>)</span>
500
+ <span class='id output'>output</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id dest'>dest</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
501
+ <span class='kw'>begin</span>
502
+ <span class='kw'>if</span> <span class='id multipart?'>multipart?</span>
503
+ <span class='id seq'>seq</span> <span class='op'>=</span> <span class='int'>1</span>
504
+ <span class='kw'>while</span> <span class='id part'>part</span> <span class='op'>=</span> <span class='const'>Utils</span><span class='period'>.</span><span class='id filename_with_sequence'>filename_with_sequence</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id seq'>seq</span><span class='rparen'>)</span> <span class='kw'>do</span>
505
+ <span class='kw'>break</span> <span class='kw'>unless</span> <span class='id disk'>disk</span><span class='period'>.</span><span class='id key_exists?'>key_exists?</span> <span class='id part'>part</span>
506
+ <span class='id output'>output</span><span class='period'>.</span><span class='id write'>write</span> <span class='id disk'>disk</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id part'>part</span><span class='rparen'>)</span>
507
+ <span class='id seq'>seq</span> <span class='op'>+=</span> <span class='int'>1</span>
508
+ <span class='kw'>end</span>
509
+ <span class='kw'>else</span>
510
+ <span class='id output'>output</span><span class='period'>.</span><span class='id write'>write</span> <span class='id disk'>disk</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id name'>name</span><span class='rparen'>)</span>
511
+ <span class='kw'>end</span>
512
+ <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id e'>e</span>
513
+ <span class='const'>Mir</span><span class='period'>.</span><span class='id logger'>logger</span><span class='period'>.</span><span class='id error'>error</span> <span class='id e'>e</span>
514
+ <span class='kw'>ensure</span>
515
+ <span class='id output'>output</span><span class='period'>.</span><span class='id close'>close</span>
516
+ <span class='kw'>end</span>
517
+ <span class='kw'>end</span></pre>
518
+ </td>
519
+ </tr>
520
+ </table>
521
+ </div>
522
+
523
+ <div class="method_details ">
524
+ <p class="signature " id="multipart?-instance_method">
525
+
526
+ - (<tt>Boolean</tt>) <strong>multipart?</strong>
527
+
528
+
529
+
530
+ </p><div class="docstring">
531
+ <div class="discussion">
532
+ <p>
533
+ Whether the resource is broken into chunks on the remote store
534
+ </p>
535
+
536
+
537
+ </div>
538
+ </div>
539
+ <div class="tags">
540
+ <h3>Returns:</h3>
541
+ <ul class="return">
542
+
543
+ <li>
544
+
545
+
546
+ <span class='type'>(<tt>Boolean</tt>)</span>
547
+
548
+
549
+
550
+ </li>
551
+
552
+ </ul>
553
+
554
+ </div><table class="source_code">
555
+ <tr>
556
+ <td>
557
+ <pre class="lines">
558
+
559
+
560
+ 254
561
+ 255
562
+ 256</pre>
563
+ </td>
564
+ <td>
565
+ <pre class="code"><span class="info file"># File 'lib/mir/disk/amazon.rb', line 254</span>
566
+
567
+ <span class='kw'>def</span> <span class='id multipart?'>multipart?</span>
568
+ <span class='ivar'>@multipart</span>
569
+ <span class='kw'>end</span></pre>
570
+ </td>
571
+ </tr>
572
+ </table>
573
+ </div>
574
+
575
+ </div>
576
+
577
+ </div>
578
+
579
+ <div id="footer">
580
+ Generated on Fri Sep 23 18:24:38 2011 by
581
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
582
+ 0.7.2 (ruby-1.9.2).
583
+ </div>
584
+
585
+ </body>
586
+ </html>