box-api 0.2.0 → 0.2.1

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.
Files changed (41) hide show
  1. data/Gemfile.lock +1 -1
  2. data/README.md +2 -0
  3. data/box-api.gemspec +1 -1
  4. data/doc/Box.html +1 -1
  5. data/doc/Box/Account.html +225 -25
  6. data/doc/Box/Api.html +374 -8
  7. data/doc/Box/Api/AccountExceeded.html +1 -1
  8. data/doc/Box/Api/EmailInvalid.html +1 -1
  9. data/doc/Box/Api/EmailTaken.html +1 -1
  10. data/doc/Box/Api/ErrorStatus.html +1 -1
  11. data/doc/Box/Api/Exception.html +2 -2
  12. data/doc/Box/Api/Generic.html +1 -1
  13. data/doc/Box/Api/InvalidFolder.html +1 -1
  14. data/doc/Box/Api/InvalidInput.html +1 -1
  15. data/doc/Box/Api/InvalidName.html +1 -1
  16. data/doc/Box/Api/NameTaken.html +1 -1
  17. data/doc/Box/Api/NoAccess.html +1 -1
  18. data/doc/Box/Api/NoParent.html +1 -1
  19. data/doc/Box/Api/NotAuthorized.html +1 -1
  20. data/doc/Box/Api/NotShared.html +141 -0
  21. data/doc/Box/Api/Restricted.html +1 -1
  22. data/doc/Box/Api/SizeExceeded.html +1 -1
  23. data/doc/Box/Api/Unknown.html +1 -1
  24. data/doc/Box/Api/UnknownResponse.html +1 -1
  25. data/doc/Box/Api/UploadFailed.html +1 -1
  26. data/doc/Box/Comment.html +1 -1
  27. data/doc/Box/File.html +24 -6
  28. data/doc/Box/Folder.html +2 -2
  29. data/doc/Box/Item.html +275 -1
  30. data/doc/_index.html +8 -1
  31. data/doc/class_list.html +1 -1
  32. data/doc/file.README.html +1 -1
  33. data/doc/index.html +1 -1
  34. data/doc/method_list.html +116 -52
  35. data/doc/top-level-namespace.html +1 -1
  36. data/lib/box/account.rb +33 -1
  37. data/lib/box/api.rb +30 -0
  38. data/lib/box/api/exceptions.rb +12 -0
  39. data/lib/box/file.rb +7 -1
  40. data/lib/box/item.rb +30 -2
  41. metadata +13 -12
data/doc/_index.html CHANGED
@@ -277,6 +277,13 @@
277
277
 
278
278
  </li>
279
279
 
280
+ <li>
281
+ <span class='object_link'><a href="Box/Api/NotShared.html" title="Box::Api::NotShared (class)">NotShared</a></span>
282
+
283
+ <small>(Box::Api)</small>
284
+
285
+ </li>
286
+
280
287
  </ul>
281
288
  </ul>
282
289
 
@@ -348,7 +355,7 @@
348
355
  </div>
349
356
 
350
357
  <div id="footer">
351
- Generated on Tue Nov 8 15:32:23 2011 by
358
+ Generated on Wed Nov 9 12:40:36 2011 by
352
359
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353
360
  0.7.3 (ruby-1.9.3).
354
361
  </div>
data/doc/class_list.html CHANGED
@@ -39,7 +39,7 @@
39
39
 
40
40
  <ul id="full_list" class="class">
41
41
  <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
42
- <li><a class='toggle'></a> <span class='object_link'><a href="Box.html" title="Box (module)">Box</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Box/Account.html" title="Box::Account (class)">Account</a></span> &lt; Object<small class='search_info'>Box</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Box/Api.html" title="Box::Api (class)">Api</a></span> &lt; Object<small class='search_info'>Box</small></li><ul><li><span class='object_link'><a href="Box/Api/AccountExceeded.html" title="Box::Api::AccountExceeded (class)">AccountExceeded</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/EmailInvalid.html" title="Box::Api::EmailInvalid (class)">EmailInvalid</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/EmailTaken.html" title="Box::Api::EmailTaken (class)">EmailTaken</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/ErrorStatus.html" title="Box::Api::ErrorStatus (class)">ErrorStatus</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Exception.html" title="Box::Api::Exception (class)">Exception</a></span> &lt; StandardError<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Generic.html" title="Box::Api::Generic (class)">Generic</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidFolder.html" title="Box::Api::InvalidFolder (class)">InvalidFolder</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidInput.html" title="Box::Api::InvalidInput (class)">InvalidInput</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidName.html" title="Box::Api::InvalidName (class)">InvalidName</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NameTaken.html" title="Box::Api::NameTaken (class)">NameTaken</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NoAccess.html" title="Box::Api::NoAccess (class)">NoAccess</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NoParent.html" title="Box::Api::NoParent (class)">NoParent</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NotAuthorized.html" title="Box::Api::NotAuthorized (class)">NotAuthorized</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Restricted.html" title="Box::Api::Restricted (class)">Restricted</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/SizeExceeded.html" title="Box::Api::SizeExceeded (class)">SizeExceeded</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Unknown.html" title="Box::Api::Unknown (class)">Unknown</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/UnknownResponse.html" title="Box::Api::UnknownResponse (class)">UnknownResponse</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/UploadFailed.html" title="Box::Api::UploadFailed (class)">UploadFailed</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li></ul><li><span class='object_link'><a href="Box/Comment.html" title="Box::Comment (class)">Comment</a></span> &lt; Object<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/File.html" title="Box::File (class)">File</a></span> &lt; Item<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/Folder.html" title="Box::Folder (class)">Folder</a></span> &lt; Item<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/Item.html" title="Box::Item (class)">Item</a></span> &lt; Object<small class='search_info'>Box</small></li></ul>
42
+ <li><a class='toggle'></a> <span class='object_link'><a href="Box.html" title="Box (module)">Box</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Box/Account.html" title="Box::Account (class)">Account</a></span> &lt; Object<small class='search_info'>Box</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Box/Api.html" title="Box::Api (class)">Api</a></span> &lt; Object<small class='search_info'>Box</small></li><ul><li><span class='object_link'><a href="Box/Api/AccountExceeded.html" title="Box::Api::AccountExceeded (class)">AccountExceeded</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/EmailInvalid.html" title="Box::Api::EmailInvalid (class)">EmailInvalid</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/EmailTaken.html" title="Box::Api::EmailTaken (class)">EmailTaken</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/ErrorStatus.html" title="Box::Api::ErrorStatus (class)">ErrorStatus</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Exception.html" title="Box::Api::Exception (class)">Exception</a></span> &lt; StandardError<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Generic.html" title="Box::Api::Generic (class)">Generic</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidFolder.html" title="Box::Api::InvalidFolder (class)">InvalidFolder</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidInput.html" title="Box::Api::InvalidInput (class)">InvalidInput</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/InvalidName.html" title="Box::Api::InvalidName (class)">InvalidName</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NameTaken.html" title="Box::Api::NameTaken (class)">NameTaken</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NoAccess.html" title="Box::Api::NoAccess (class)">NoAccess</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NoParent.html" title="Box::Api::NoParent (class)">NoParent</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NotAuthorized.html" title="Box::Api::NotAuthorized (class)">NotAuthorized</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/NotShared.html" title="Box::Api::NotShared (class)">NotShared</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Restricted.html" title="Box::Api::Restricted (class)">Restricted</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/SizeExceeded.html" title="Box::Api::SizeExceeded (class)">SizeExceeded</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/Unknown.html" title="Box::Api::Unknown (class)">Unknown</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/UnknownResponse.html" title="Box::Api::UnknownResponse (class)">UnknownResponse</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li><li><span class='object_link'><a href="Box/Api/UploadFailed.html" title="Box::Api::UploadFailed (class)">UploadFailed</a></span> &lt; Exception<small class='search_info'>Box::Api</small></li></ul><li><span class='object_link'><a href="Box/Comment.html" title="Box::Comment (class)">Comment</a></span> &lt; Object<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/File.html" title="Box::File (class)">File</a></span> &lt; Item<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/Folder.html" title="Box::Folder (class)">Folder</a></span> &lt; Item<small class='search_info'>Box</small></li><li><span class='object_link'><a href="Box/Item.html" title="Box::Item (class)">Item</a></span> &lt; Object<small class='search_info'>Box</small></li></ul>
43
43
 
44
44
  </ul>
45
45
  </div>
data/doc/file.README.html CHANGED
@@ -89,7 +89,7 @@
89
89
  </div></div>
90
90
 
91
91
  <div id="footer">
92
- Generated on Tue Nov 8 15:32:23 2011 by
92
+ Generated on Wed Nov 9 12:40:36 2011 by
93
93
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
94
94
  0.7.3 (ruby-1.9.3).
95
95
  </div>
data/doc/index.html CHANGED
@@ -89,7 +89,7 @@
89
89
  </div></div>
90
90
 
91
91
  <div id="footer">
92
- Generated on Tue Nov 8 15:32:23 2011 by
92
+ Generated on Wed Nov 9 12:40:36 2011 by
93
93
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
94
94
  0.7.3 (ruby-1.9.3).
95
95
  </div>
data/doc/method_list.html CHANGED
@@ -105,17 +105,17 @@
105
105
 
106
106
 
107
107
  <li class="r1 ">
108
- <span class='object_link'><a href="Box/Api.html#copy-instance_method" title="Box::Api#copy (method)">#copy</a></span>
108
+ <span class='object_link'><a href="Box/Item.html#copy-instance_method" title="Box::Item#copy (method)">#copy</a></span>
109
109
 
110
- <small>Box::Api</small>
110
+ <small>Box::Item</small>
111
111
 
112
112
  </li>
113
113
 
114
114
 
115
115
  <li class="r2 ">
116
- <span class='object_link'><a href="Box/Item.html#copy-instance_method" title="Box::Item#copy (method)">#copy</a></span>
116
+ <span class='object_link'><a href="Box/Api.html#copy-instance_method" title="Box::Api#copy (method)">#copy</a></span>
117
117
 
118
- <small>Box::Item</small>
118
+ <small>Box::Api</small>
119
119
 
120
120
  </li>
121
121
 
@@ -153,25 +153,25 @@
153
153
 
154
154
 
155
155
  <li class="r1 ">
156
- <span class='object_link'><a href="Box/Comment.html#delete-instance_method" title="Box::Comment#delete (method)">#delete</a></span>
156
+ <span class='object_link'><a href="Box/Api.html#delete-instance_method" title="Box::Api#delete (method)">#delete</a></span>
157
157
 
158
- <small>Box::Comment</small>
158
+ <small>Box::Api</small>
159
159
 
160
160
  </li>
161
161
 
162
162
 
163
163
  <li class="r2 ">
164
- <span class='object_link'><a href="Box/Item.html#delete-instance_method" title="Box::Item#delete (method)">#delete</a></span>
164
+ <span class='object_link'><a href="Box/Comment.html#delete-instance_method" title="Box::Comment#delete (method)">#delete</a></span>
165
165
 
166
- <small>Box::Item</small>
166
+ <small>Box::Comment</small>
167
167
 
168
168
  </li>
169
169
 
170
170
 
171
171
  <li class="r1 ">
172
- <span class='object_link'><a href="Box/Api.html#delete-instance_method" title="Box::Api#delete (method)">#delete</a></span>
172
+ <span class='object_link'><a href="Box/Item.html#delete-instance_method" title="Box::Item#delete (method)">#delete</a></span>
173
173
 
174
- <small>Box::Api</small>
174
+ <small>Box::Item</small>
175
175
 
176
176
  </li>
177
177
 
@@ -209,6 +209,14 @@
209
209
 
210
210
 
211
211
  <li class="r2 ">
212
+ <span class='object_link'><a href="Box/Account.html#file-instance_method" title="Box::Account#file (method)">#file</a></span>
213
+
214
+ <small>Box::Account</small>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="r1 ">
212
220
  <span class='object_link'><a href="Box/Api.html#file_embed-instance_method" title="Box::Api#file_embed (method)">#file_embed</a></span>
213
221
 
214
222
  <small>Box::Api</small>
@@ -216,7 +224,7 @@
216
224
  </li>
217
225
 
218
226
 
219
- <li class="r1 ">
227
+ <li class="r2 ">
220
228
  <span class='object_link'><a href="Box/Folder.html#find-instance_method" title="Box::Folder#find (method)">#find</a></span>
221
229
 
222
230
  <small>Box::Folder</small>
@@ -224,6 +232,14 @@
224
232
  </li>
225
233
 
226
234
 
235
+ <li class="r1 ">
236
+ <span class='object_link'><a href="Box/Account.html#folder-instance_method" title="Box::Account#folder (method)">#folder</a></span>
237
+
238
+ <small>Box::Account</small>
239
+
240
+ </li>
241
+
242
+
227
243
  <li class="r2 ">
228
244
  <span class='object_link'><a href="Box/Item.html#force_cached_info-instance_method" title="Box::Item#force_cached_info (method)">#force_cached_info</a></span>
229
245
 
@@ -273,17 +289,17 @@
273
289
 
274
290
 
275
291
  <li class="r2 ">
276
- <span class='object_link'><a href="Box/Api.html#get_comments-instance_method" title="Box::Api#get_comments (method)">#get_comments</a></span>
292
+ <span class='object_link'><a href="Box/File.html#get_comments-instance_method" title="Box::File#get_comments (method)">#get_comments</a></span>
277
293
 
278
- <small>Box::Api</small>
294
+ <small>Box::File</small>
279
295
 
280
296
  </li>
281
297
 
282
298
 
283
299
  <li class="r1 ">
284
- <span class='object_link'><a href="Box/File.html#get_comments-instance_method" title="Box::File#get_comments (method)">#get_comments</a></span>
300
+ <span class='object_link'><a href="Box/Api.html#get_comments-instance_method" title="Box::Api#get_comments (method)">#get_comments</a></span>
285
301
 
286
- <small>Box::File</small>
302
+ <small>Box::Api</small>
287
303
 
288
304
  </li>
289
305
 
@@ -321,17 +337,17 @@
321
337
 
322
338
 
323
339
  <li class="r2 ">
324
- <span class='object_link'><a href="Box/Comment.html#id-instance_method" title="Box::Comment#id (method)">#id</a></span>
340
+ <span class='object_link'><a href="Box/Item.html#id-instance_method" title="Box::Item#id (method)">#id</a></span>
325
341
 
326
- <small>Box::Comment</small>
342
+ <small>Box::Item</small>
327
343
 
328
344
  </li>
329
345
 
330
346
 
331
347
  <li class="r1 ">
332
- <span class='object_link'><a href="Box/Item.html#id-instance_method" title="Box::Item#id (method)">#id</a></span>
348
+ <span class='object_link'><a href="Box/Comment.html#id-instance_method" title="Box::Comment#id (method)">#id</a></span>
333
349
 
334
- <small>Box::Item</small>
350
+ <small>Box::Comment</small>
335
351
 
336
352
  </li>
337
353
 
@@ -361,17 +377,17 @@
361
377
 
362
378
 
363
379
  <li class="r1 ">
364
- <span class='object_link'><a href="Box/Account.html#initialize-instance_method" title="Box::Account#initialize (method)">#initialize</a></span>
380
+ <span class='object_link'><a href="Box/Item.html#initialize-instance_method" title="Box::Item#initialize (method)">#initialize</a></span>
365
381
 
366
- <small>Box::Account</small>
382
+ <small>Box::Item</small>
367
383
 
368
384
  </li>
369
385
 
370
386
 
371
387
  <li class="r2 ">
372
- <span class='object_link'><a href="Box/Item.html#initialize-instance_method" title="Box::Item#initialize (method)">#initialize</a></span>
388
+ <span class='object_link'><a href="Box/Account.html#initialize-instance_method" title="Box::Account#initialize (method)">#initialize</a></span>
373
389
 
374
- <small>Box::Item</small>
390
+ <small>Box::Account</small>
375
391
 
376
392
  </li>
377
393
 
@@ -393,33 +409,33 @@
393
409
 
394
410
 
395
411
  <li class="r1 ">
396
- <span class='object_link'><a href="Box/Account.html#logout-instance_method" title="Box::Account#logout (method)">#logout</a></span>
412
+ <span class='object_link'><a href="Box/Api.html#logout-instance_method" title="Box::Api#logout (method)">#logout</a></span>
397
413
 
398
- <small>Box::Account</small>
414
+ <small>Box::Api</small>
399
415
 
400
416
  </li>
401
417
 
402
418
 
403
419
  <li class="r2 ">
404
- <span class='object_link'><a href="Box/Api.html#logout-instance_method" title="Box::Api#logout (method)">#logout</a></span>
420
+ <span class='object_link'><a href="Box/Account.html#logout-instance_method" title="Box::Account#logout (method)">#logout</a></span>
405
421
 
406
- <small>Box::Api</small>
422
+ <small>Box::Account</small>
407
423
 
408
424
  </li>
409
425
 
410
426
 
411
427
  <li class="r1 ">
412
- <span class='object_link'><a href="Box/Item.html#method_missing-instance_method" title="Box::Item#method_missing (method)">#method_missing</a></span>
428
+ <span class='object_link'><a href="Box/Account.html#method_missing-instance_method" title="Box::Account#method_missing (method)">#method_missing</a></span>
413
429
 
414
- <small>Box::Item</small>
430
+ <small>Box::Account</small>
415
431
 
416
432
  </li>
417
433
 
418
434
 
419
435
  <li class="r2 ">
420
- <span class='object_link'><a href="Box/Account.html#method_missing-instance_method" title="Box::Account#method_missing (method)">#method_missing</a></span>
436
+ <span class='object_link'><a href="Box/Item.html#method_missing-instance_method" title="Box::Item#method_missing (method)">#method_missing</a></span>
421
437
 
422
- <small>Box::Account</small>
438
+ <small>Box::Item</small>
423
439
 
424
440
  </li>
425
441
 
@@ -433,17 +449,17 @@
433
449
 
434
450
 
435
451
  <li class="r2 ">
436
- <span class='object_link'><a href="Box/Api.html#move-instance_method" title="Box::Api#move (method)">#move</a></span>
452
+ <span class='object_link'><a href="Box/Item.html#move-instance_method" title="Box::Item#move (method)">#move</a></span>
437
453
 
438
- <small>Box::Api</small>
454
+ <small>Box::Item</small>
439
455
 
440
456
  </li>
441
457
 
442
458
 
443
459
  <li class="r1 ">
444
- <span class='object_link'><a href="Box/Item.html#move-instance_method" title="Box::Item#move (method)">#move</a></span>
460
+ <span class='object_link'><a href="Box/Api.html#move-instance_method" title="Box::Api#move (method)">#move</a></span>
445
461
 
446
- <small>Box::Item</small>
462
+ <small>Box::Api</small>
447
463
 
448
464
  </li>
449
465
 
@@ -529,17 +545,17 @@
529
545
 
530
546
 
531
547
  <li class="r2 ">
532
- <span class='object_link'><a href="Box/Api.html#rename-instance_method" title="Box::Api#rename (method)">#rename</a></span>
548
+ <span class='object_link'><a href="Box/Item.html#rename-instance_method" title="Box::Item#rename (method)">#rename</a></span>
533
549
 
534
- <small>Box::Api</small>
550
+ <small>Box::Item</small>
535
551
 
536
552
  </li>
537
553
 
538
554
 
539
555
  <li class="r1 ">
540
- <span class='object_link'><a href="Box/Item.html#rename-instance_method" title="Box::Item#rename (method)">#rename</a></span>
556
+ <span class='object_link'><a href="Box/Api.html#rename-instance_method" title="Box::Api#rename (method)">#rename</a></span>
541
557
 
542
- <small>Box::Item</small>
558
+ <small>Box::Api</small>
543
559
 
544
560
  </li>
545
561
 
@@ -553,17 +569,17 @@
553
569
 
554
570
 
555
571
  <li class="r1 ">
556
- <span class='object_link'><a href="Box/Account.html#respond_to%3F-instance_method" title="Box::Account#respond_to? (method)">#respond_to?</a></span>
572
+ <span class='object_link'><a href="Box/Comment.html#respond_to%3F-instance_method" title="Box::Comment#respond_to? (method)">#respond_to?</a></span>
557
573
 
558
- <small>Box::Account</small>
574
+ <small>Box::Comment</small>
559
575
 
560
576
  </li>
561
577
 
562
578
 
563
579
  <li class="r2 ">
564
- <span class='object_link'><a href="Box/Comment.html#respond_to%3F-instance_method" title="Box::Comment#respond_to? (method)">#respond_to?</a></span>
580
+ <span class='object_link'><a href="Box/Account.html#respond_to%3F-instance_method" title="Box::Account#respond_to? (method)">#respond_to?</a></span>
565
581
 
566
- <small>Box::Comment</small>
582
+ <small>Box::Account</small>
567
583
 
568
584
  </li>
569
585
 
@@ -600,6 +616,38 @@
600
616
  </li>
601
617
 
602
618
 
619
+ <li class="r1 ">
620
+ <span class='object_link'><a href="Box/Item.html#share_private-instance_method" title="Box::Item#share_private (method)">#share_private</a></span>
621
+
622
+ <small>Box::Item</small>
623
+
624
+ </li>
625
+
626
+
627
+ <li class="r2 ">
628
+ <span class='object_link'><a href="Box/Api.html#share_private-instance_method" title="Box::Api#share_private (method)">#share_private</a></span>
629
+
630
+ <small>Box::Api</small>
631
+
632
+ </li>
633
+
634
+
635
+ <li class="r1 ">
636
+ <span class='object_link'><a href="Box/Item.html#share_public-instance_method" title="Box::Item#share_public (method)">#share_public</a></span>
637
+
638
+ <small>Box::Item</small>
639
+
640
+ </li>
641
+
642
+
643
+ <li class="r2 ">
644
+ <span class='object_link'><a href="Box/Api.html#share_public-instance_method" title="Box::Api#share_public (method)">#share_public</a></span>
645
+
646
+ <small>Box::Api</small>
647
+
648
+ </li>
649
+
650
+
603
651
  <li class="r1 ">
604
652
  <span class='object_link'><a href="Box/Account.html#ticket-instance_method" title="Box::Account#ticket (method)">#ticket</a></span>
605
653
 
@@ -617,15 +665,15 @@
617
665
 
618
666
 
619
667
  <li class="r1 ">
620
- <span class='object_link'><a href="Box/Folder.html#type-class_method" title="Box::Folder.type (method)">type</a></span>
668
+ <span class='object_link'><a href="Box/Item.html#type-instance_method" title="Box::Item#type (method)">#type</a></span>
621
669
 
622
- <small>Box::Folder</small>
670
+ <small>Box::Item</small>
623
671
 
624
672
  </li>
625
673
 
626
674
 
627
675
  <li class="r2 ">
628
- <span class='object_link'><a href="Box/Item.html#type-instance_method" title="Box::Item#type (method)">#type</a></span>
676
+ <span class='object_link'><a href="Box/Item.html#type-class_method" title="Box::Item.type (method)">type</a></span>
629
677
 
630
678
  <small>Box::Item</small>
631
679
 
@@ -633,17 +681,17 @@
633
681
 
634
682
 
635
683
  <li class="r1 ">
636
- <span class='object_link'><a href="Box/Item.html#type-class_method" title="Box::Item.type (method)">type</a></span>
684
+ <span class='object_link'><a href="Box/File.html#type-class_method" title="Box::File.type (method)">type</a></span>
637
685
 
638
- <small>Box::Item</small>
686
+ <small>Box::File</small>
639
687
 
640
688
  </li>
641
689
 
642
690
 
643
691
  <li class="r2 ">
644
- <span class='object_link'><a href="Box/File.html#type-class_method" title="Box::File.type (method)">type</a></span>
692
+ <span class='object_link'><a href="Box/Folder.html#type-class_method" title="Box::Folder.type (method)">type</a></span>
645
693
 
646
- <small>Box::File</small>
694
+ <small>Box::Folder</small>
647
695
 
648
696
  </li>
649
697
 
@@ -665,14 +713,22 @@
665
713
 
666
714
 
667
715
  <li class="r1 ">
668
- <span class='object_link'><a href="Box/Api.html#upload-instance_method" title="Box::Api#upload (method)">#upload</a></span>
716
+ <span class='object_link'><a href="Box/Item.html#unshare-instance_method" title="Box::Item#unshare (method)">#unshare</a></span>
669
717
 
670
- <small>Box::Api</small>
718
+ <small>Box::Item</small>
671
719
 
672
720
  </li>
673
721
 
674
722
 
675
723
  <li class="r2 ">
724
+ <span class='object_link'><a href="Box/Api.html#unshare_public-instance_method" title="Box::Api#unshare_public (method)">#unshare_public</a></span>
725
+
726
+ <small>Box::Api</small>
727
+
728
+ </li>
729
+
730
+
731
+ <li class="r1 ">
676
732
  <span class='object_link'><a href="Box/Folder.html#upload-instance_method" title="Box::Folder#upload (method)">#upload</a></span>
677
733
 
678
734
  <small>Box::Folder</small>
@@ -680,6 +736,14 @@
680
736
  </li>
681
737
 
682
738
 
739
+ <li class="r2 ">
740
+ <span class='object_link'><a href="Box/Api.html#upload-instance_method" title="Box::Api#upload (method)">#upload</a></span>
741
+
742
+ <small>Box::Api</small>
743
+
744
+ </li>
745
+
746
+
683
747
  <li class="r1 ">
684
748
  <span class='object_link'><a href="Box/File.html#upload_copy-instance_method" title="Box::File#upload_copy (method)">#upload_copy</a></span>
685
749
 
data/doc/top-level-namespace.html CHANGED
@@ -94,7 +94,7 @@
94
94
  </div>
95
95
 
96
96
  <div id="footer">
97
- Generated on Tue Nov 8 15:32:24 2011 by
97
+ Generated on Wed Nov 9 12:40:37 2011 by
98
98
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
99
99
  0.7.3 (ruby-1.9.3).
100
100
  </div>
data/lib/box/account.rb CHANGED
@@ -163,7 +163,39 @@ module Box
163
163
  #
164
164
  def root
165
165
  return @root if @root
166
- @root = Box::Folder.new(@api, nil, :id => 0)
166
+ @root = folder(0)
167
+ end
168
+
169
+ # Gets a folder object by id.
170
+ #
171
+ # @param [String] id The id of the folder to fetch.
172
+ #
173
+ # @note This folder will not know its parent because of API
174
+ # short-comings. If you need the tree above this folder, use
175
+ # root.find(:type => 'folder', :id => id).first instead.
176
+ #
177
+ # @note This function will return a folder regardless of whether it
178
+ # actually exists. You will get exceptions if you try to access
179
+ # any info.
180
+ #
181
+ def folder(id)
182
+ Box::Folder.new(@api, nil, :id => id)
183
+ end
184
+
185
+ # Gets a file object by id.
186
+ #
187
+ # @param [String] id The id of the folder to fetch.
188
+ #
189
+ # @note This file will not know its parent because of API
190
+ # short-comings. If you need the tree above this file, use
191
+ # root.find(:type => 'file', :id => id).first instead.
192
+ #
193
+ # @note This function will return a file regardless of whether it
194
+ # actually exists. You will get exceptions if you try to access
195
+ # any info.
196
+ #
197
+ def file(id)
198
+ Box::File.new(@api, nil, :id => id)
167
199
  end
168
200
 
169
201
  # @return [Boolean] Is the account authorized?