box-api 0.1.9 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. data/Gemfile.lock +1 -1
  2. data/box-api.gemspec +1 -1
  3. data/doc/Box.html +5 -5
  4. data/doc/Box/Account.html +430 -188
  5. data/doc/Box/Api.html +731 -428
  6. data/doc/Box/Api/AccountExceeded.html +3 -3
  7. data/doc/Box/Api/EmailInvalid.html +6 -6
  8. data/doc/Box/Api/EmailTaken.html +3 -3
  9. data/doc/Box/Api/ErrorStatus.html +3 -3
  10. data/doc/Box/Api/Exception.html +3 -3
  11. data/doc/Box/Api/Generic.html +3 -3
  12. data/doc/Box/Api/InvalidFolder.html +6 -6
  13. data/doc/Box/Api/InvalidInput.html +3 -3
  14. data/doc/Box/Api/InvalidName.html +3 -3
  15. data/doc/Box/Api/NameTaken.html +3 -3
  16. data/doc/Box/Api/NoAccess.html +3 -3
  17. data/doc/Box/Api/NoParent.html +3 -3
  18. data/doc/Box/Api/NotAuthorized.html +3 -3
  19. data/doc/Box/Api/Restricted.html +6 -6
  20. data/doc/Box/Api/SizeExceeded.html +3 -3
  21. data/doc/Box/Api/Unknown.html +3 -3
  22. data/doc/Box/Api/UnknownResponse.html +6 -6
  23. data/doc/Box/Api/UploadFailed.html +6 -6
  24. data/doc/Box/Comment.html +560 -0
  25. data/doc/Box/File.html +318 -53
  26. data/doc/Box/Folder.html +298 -136
  27. data/doc/Box/Item.html +398 -348
  28. data/doc/_index.html +22 -7
  29. data/doc/class_list.html +1 -1
  30. data/doc/css/full_list.css +2 -0
  31. data/doc/css/style.css +2 -0
  32. data/doc/file.README.html +3 -3
  33. data/doc/frames.html +1 -1
  34. data/doc/index.html +3 -3
  35. data/doc/js/full_list.js +23 -6
  36. data/doc/method_list.html +233 -89
  37. data/doc/top-level-namespace.html +3 -3
  38. data/examples/files.rb +3 -5
  39. data/examples/login.rb +14 -18
  40. data/lib/box/account.rb +57 -16
  41. data/lib/box/api.rb +34 -1
  42. data/lib/box/api/exceptions.rb +3 -0
  43. data/lib/box/comment.rb +50 -0
  44. data/lib/box/file.rb +31 -0
  45. data/lib/box/folder.rb +57 -1
  46. data/lib/box/item.rb +20 -4
  47. data/spec/account_spec.rb +4 -0
  48. data/spec/file_spec.rb +37 -0
  49. data/spec/folder_spec.rb +78 -0
  50. data/spec/helper/account.rb +1 -1
  51. metadata +55 -61
data/doc/Box/Comment.html ADDED
@@ -0,0 +1,560 @@
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: Box::Comment
8
+
9
+ &mdash; 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 (C)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Box.html" title="Box (module)">Box</a></span></span>
38
+ &raquo;
39
+ <span class="title">Comment</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: Box::Comment
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">Box::Comment</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/box/comment.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+ <h2>
102
+ Class Method Summary
103
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
104
+ </h2>
105
+
106
+ <ul class="summary">
107
+
108
+ <li class="public ">
109
+ <span class="summary_signature">
110
+
111
+ <a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(api, comments) </a>
112
+
113
+
114
+
115
+ </span>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+ <span class="summary_desc"><div class='inline'></div></span>
125
+
126
+ </li>
127
+
128
+
129
+ </ul>
130
+
131
+ <h2>
132
+ Instance Method Summary
133
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
134
+ </h2>
135
+
136
+ <ul class="summary">
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#delete-instance_method" title="#delete (instance method)">- (Object) <strong>delete</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+ <span class="summary_desc"><div class='inline'></div></span>
155
+
156
+ </li>
157
+
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </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="#initialize-instance_method" title="#initialize (instance method)">- (Comment) <strong>initialize</strong>(api, data) </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+ <span class="note title constructor">constructor</span>
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'>
199
+ <p>Create a new comment object for a file.</p>
200
+ </div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(sym, *args, &amp;block) </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'></div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#respond_to%3F-instance_method" title="#respond_to? (instance method)">- (Boolean) <strong>respond_to?</strong>(sym) </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'></div></span>
243
+
244
+ </li>
245
+
246
+
247
+ </ul>
248
+
249
+
250
+ <div id="constructor_details" class="method_details_list">
251
+ <h2>Constructor Details</h2>
252
+
253
+ <div class="method_details first">
254
+ <p class="signature first" id="initialize-instance_method">
255
+
256
+ - (<tt><span class='object_link'><a href="" title="Box::Comment (class)">Comment</a></span></tt>) <strong>initialize</strong>(api, data)
257
+
258
+
259
+
260
+ </p><div class="docstring">
261
+ <div class="discussion">
262
+
263
+ <p>Create a new comment object for a file.</p>
264
+
265
+
266
+ </div>
267
+ </div>
268
+ <div class="tags">
269
+ <h3>Parameters:</h3>
270
+ <ul class="param">
271
+
272
+ <li>
273
+
274
+ <span class='name'>api</span>
275
+
276
+
277
+ <span class='type'>(<tt><span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span></tt>)</span>
278
+
279
+
280
+
281
+ &mdash;
282
+ <div class='inline'>
283
+ <p>The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> instance used to generate requests.</p>
284
+ </div>
285
+
286
+ </li>
287
+
288
+ <li>
289
+
290
+ <span class='name'>data</span>
291
+
292
+
293
+ <span class='type'>(<tt>Hash</tt>)</span>
294
+
295
+
296
+
297
+ &mdash;
298
+ <div class='inline'>
299
+ <p>The hash of initial info for this item, like 'id' and 'message'.</p>
300
+ </div>
301
+
302
+ </li>
303
+
304
+ </ul>
305
+
306
+
307
+ </div><table class="source_code">
308
+ <tr>
309
+ <td>
310
+ <pre class="lines">
311
+
312
+
313
+ 24
314
+ 25
315
+ 26
316
+ 27</pre>
317
+ </td>
318
+ <td>
319
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 24</span>
320
+
321
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id api'>api</span><span class='comma'>,</span> <span class='id data'>data</span><span class='rparen'>)</span>
322
+ <span class='ivar'>@api</span> <span class='op'>=</span> <span class='id api'>api</span>
323
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id data'>data</span>
324
+ <span class='kw'>end</span></pre>
325
+ </td>
326
+ </tr>
327
+ </table>
328
+ </div>
329
+
330
+ </div>
331
+ <div id="method_missing_details" class="method_details_list">
332
+ <h2>Dynamic Method Handling</h2>
333
+ <p class="notice this">
334
+ This class handles dynamic methods through the <tt>method_missing</tt> method
335
+
336
+ </p>
337
+
338
+ <div class="method_details first">
339
+ <p class="signature first" id="method_missing-instance_method">
340
+
341
+ - (<tt>Object</tt>) <strong>method_missing</strong>(sym, *args, &amp;block)
342
+
343
+
344
+
345
+ </p><table class="source_code">
346
+ <tr>
347
+ <td>
348
+ <pre class="lines">
349
+
350
+
351
+ 31
352
+ 32
353
+ 33
354
+ 34
355
+ 35
356
+ 36
357
+ 37
358
+ 38</pre>
359
+ </td>
360
+ <td>
361
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 31</span>
362
+
363
+ <span class='kw'>def</span> <span class='id method_missing'>method_missing</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id block'>block</span><span class='rparen'>)</span>
364
+ <span class='comment'># TODO: Use symbols instead of strings for keys.
365
+ </span> <span class='id sym'>sym</span> <span class='op'>=</span> <span class='id sym'>sym</span><span class='period'>.</span><span class='id to_s'>to_s</span>
366
+
367
+ <span class='kw'>return</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='id sym'>sym</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='rparen'>)</span>
368
+
369
+ <span class='kw'>super</span>
370
+ <span class='kw'>end</span></pre>
371
+ </td>
372
+ </tr>
373
+ </table>
374
+ </div>
375
+
376
+ </div>
377
+
378
+
379
+ <div id="class_method_details" class="method_details_list">
380
+ <h2>Class Method Details</h2>
381
+
382
+
383
+ <div class="method_details first">
384
+ <p class="signature first" id="create-class_method">
385
+
386
+ + (<tt>Object</tt>) <strong>create</strong>(api, comments)
387
+
388
+
389
+
390
+ </p><table class="source_code">
391
+ <tr>
392
+ <td>
393
+ <pre class="lines">
394
+
395
+
396
+ 3
397
+ 4
398
+ 5
399
+ 6
400
+ 7
401
+ 8
402
+ 9
403
+ 10
404
+ 11
405
+ 12
406
+ 13
407
+ 14
408
+ 15
409
+ 16
410
+ 17
411
+ 18</pre>
412
+ </td>
413
+ <td>
414
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 3</span>
415
+
416
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id create'>create</span><span class='lparen'>(</span><span class='id api'>api</span><span class='comma'>,</span> <span class='id comments'>comments</span><span class='rparen'>)</span>
417
+ <span class='kw'>if</span> <span class='id comments'>comments</span>
418
+ <span class='id comments'>comments</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id comments'>comments</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id comments'>comments</span><span class='period'>.</span><span class='id class'>class</span> <span class='op'>==</span> <span class='const'>Hash</span>
419
+
420
+ <span class='id comments'>comments</span><span class='period'>.</span><span class='id collect'>collect</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id comment'>comment</span><span class='op'>|</span>
421
+ <span class='id sub_comments'>sub_comments</span> <span class='op'>=</span> <span class='id comment'>comment</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>reply_comments</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
422
+
423
+ <span class='id comment'>comment</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id comment'>comment</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>comment_id</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
424
+ <span class='id comment'>comment</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>comments</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id create'>create</span><span class='lparen'>(</span><span class='id api'>api</span><span class='comma'>,</span> <span class='id sub_comments'>sub_comments</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>item</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id sub_comments'>sub_comments</span>
425
+
426
+ <span class='const'>Comment</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id api'>api</span><span class='comma'>,</span> <span class='id comment'>comment</span><span class='rparen'>)</span>
427
+ <span class='kw'>end</span>
428
+ <span class='kw'>else</span>
429
+ <span class='const'>Array</span><span class='period'>.</span><span class='id new'>new</span>
430
+ <span class='kw'>end</span>
431
+ <span class='kw'>end</span></pre>
432
+ </td>
433
+ </tr>
434
+ </table>
435
+ </div>
436
+
437
+ </div>
438
+
439
+ <div id="instance_method_details" class="method_details_list">
440
+ <h2>Instance Method Details</h2>
441
+
442
+
443
+ <div class="method_details first">
444
+ <p class="signature first" id="delete-instance_method">
445
+
446
+ - (<tt>Object</tt>) <strong>delete</strong>
447
+
448
+
449
+
450
+ </p><table class="source_code">
451
+ <tr>
452
+ <td>
453
+ <pre class="lines">
454
+
455
+
456
+ 44
457
+ 45
458
+ 46
459
+ 47
460
+ 48</pre>
461
+ </td>
462
+ <td>
463
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 44</span>
464
+
465
+ <span class='kw'>def</span> <span class='id delete'>delete</span>
466
+ <span class='ivar'>@api</span><span class='period'>.</span><span class='id delete_comment'>delete_comment</span><span class='lparen'>(</span><span class='id id'>id</span><span class='rparen'>)</span>
467
+
468
+ <span class='kw'>true</span>
469
+ <span class='kw'>end</span></pre>
470
+ </td>
471
+ </tr>
472
+ </table>
473
+ </div>
474
+
475
+ <div class="method_details ">
476
+ <p class="signature " id="id-instance_method">
477
+
478
+ - (<tt>Object</tt>) <strong>id</strong>
479
+
480
+
481
+
482
+ </p><table class="source_code">
483
+ <tr>
484
+ <td>
485
+ <pre class="lines">
486
+
487
+
488
+ 29</pre>
489
+ </td>
490
+ <td>
491
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 29</span>
492
+
493
+ <span class='kw'>def</span> <span class='id id'>id</span><span class='semicolon'>;</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
494
+ </td>
495
+ </tr>
496
+ </table>
497
+ </div>
498
+
499
+ <div class="method_details ">
500
+ <p class="signature " id="respond_to?-instance_method">
501
+
502
+ - (<tt>Boolean</tt>) <strong>respond_to?</strong>(sym)
503
+
504
+
505
+
506
+ </p><div class="docstring">
507
+ <div class="discussion">
508
+
509
+
510
+ </div>
511
+ </div>
512
+ <div class="tags">
513
+
514
+ <h3>Returns:</h3>
515
+ <ul class="return">
516
+
517
+ <li>
518
+
519
+
520
+ <span class='type'>(<tt>Boolean</tt>)</span>
521
+
522
+
523
+
524
+ </li>
525
+
526
+ </ul>
527
+
528
+ </div><table class="source_code">
529
+ <tr>
530
+ <td>
531
+ <pre class="lines">
532
+
533
+
534
+ 40
535
+ 41
536
+ 42</pre>
537
+ </td>
538
+ <td>
539
+ <pre class="code"><span class="info file"># File 'lib/box/comment.rb', line 40</span>
540
+
541
+ <span class='kw'>def</span> <span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='rparen'>)</span>
542
+ <span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='kw'>super</span>
543
+ <span class='kw'>end</span></pre>
544
+ </td>
545
+ </tr>
546
+ </table>
547
+ </div>
548
+
549
+ </div>
550
+
551
+ </div>
552
+
553
+ <div id="footer">
554
+ Generated on Tue Nov 8 15:32:23 2011 by
555
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556
+ 0.7.3 (ruby-1.9.3).
557
+ </div>
558
+
559
+ </body>
560
+ </html>