flickr.rb 1.2.0 → 1.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 (73) hide show
  1. checksums.yaml +4 -4
  2. data/Changelog.txt +7 -4
  3. data/Gemfile.lock +3 -3
  4. data/README.md +5 -1
  5. data/Rakefile +6 -7
  6. data/doc/Flickr.html +1813 -0
  7. data/doc/Flickr/Config.html +468 -0
  8. data/doc/Flickr/Group.html +974 -0
  9. data/doc/Flickr/Photo.html +2467 -0
  10. data/doc/Flickr/PhotoCollection.html +529 -0
  11. data/doc/Flickr/Photoset.html +942 -0
  12. data/doc/Flickr/User.html +1672 -0
  13. data/doc/_index.html +190 -0
  14. data/doc/class_list.html +54 -0
  15. data/doc/css/common.css +1 -0
  16. data/doc/css/full_list.css +57 -0
  17. data/doc/css/style.css +339 -0
  18. data/doc/file.Changelog.html +73 -0
  19. data/doc/file.LICENSE.html +94 -0
  20. data/{rdoc/README_md.html → doc/file.README.html} +85 -121
  21. data/doc/file_list.html +62 -0
  22. data/doc/frames.html +26 -0
  23. data/doc/index.html +216 -0
  24. data/doc/js/app.js +219 -0
  25. data/doc/js/full_list.js +178 -0
  26. data/doc/js/jquery.js +4 -0
  27. data/doc/method_list.html +725 -0
  28. data/doc/top-level-namespace.html +112 -0
  29. data/flickr.gemspec +3 -3
  30. data/lib/flickr.rb +1 -1
  31. metadata +27 -46
  32. data/rdoc/Flickr.html +0 -1044
  33. data/rdoc/Flickr/Config.html +0 -300
  34. data/rdoc/Flickr/Group.html +0 -373
  35. data/rdoc/Flickr/Photo.html +0 -1427
  36. data/rdoc/Flickr/PhotoCollection.html +0 -261
  37. data/rdoc/Flickr/Photoset.html +0 -389
  38. data/rdoc/Flickr/User.html +0 -775
  39. data/rdoc/created.rid +0 -3
  40. data/rdoc/images/add.png +0 -0
  41. data/rdoc/images/arrow_up.png +0 -0
  42. data/rdoc/images/brick.png +0 -0
  43. data/rdoc/images/brick_link.png +0 -0
  44. data/rdoc/images/bug.png +0 -0
  45. data/rdoc/images/bullet_black.png +0 -0
  46. data/rdoc/images/bullet_toggle_minus.png +0 -0
  47. data/rdoc/images/bullet_toggle_plus.png +0 -0
  48. data/rdoc/images/date.png +0 -0
  49. data/rdoc/images/delete.png +0 -0
  50. data/rdoc/images/find.png +0 -0
  51. data/rdoc/images/loadingAnimation.gif +0 -0
  52. data/rdoc/images/macFFBgHack.png +0 -0
  53. data/rdoc/images/package.png +0 -0
  54. data/rdoc/images/page_green.png +0 -0
  55. data/rdoc/images/page_white_text.png +0 -0
  56. data/rdoc/images/page_white_width.png +0 -0
  57. data/rdoc/images/plugin.png +0 -0
  58. data/rdoc/images/ruby.png +0 -0
  59. data/rdoc/images/tag_blue.png +0 -0
  60. data/rdoc/images/tag_green.png +0 -0
  61. data/rdoc/images/transparent.png +0 -0
  62. data/rdoc/images/wrench.png +0 -0
  63. data/rdoc/images/wrench_orange.png +0 -0
  64. data/rdoc/images/zoom.png +0 -0
  65. data/rdoc/index.html +0 -92
  66. data/rdoc/js/darkfish.js +0 -155
  67. data/rdoc/js/jquery.js +0 -18
  68. data/rdoc/js/navigation.js +0 -142
  69. data/rdoc/js/search.js +0 -94
  70. data/rdoc/js/search_index.js +0 -1
  71. data/rdoc/js/searcher.js +0 -228
  72. data/rdoc/rdoc.css +0 -595
  73. data/rdoc/table_of_contents.html +0 -241
@@ -0,0 +1,529 @@
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: Flickr::PhotoCollection
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Flickr/PhotoCollection.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (P)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Flickr.html" title="Flickr (class)">Flickr</a></span></span>
36
+ &raquo;
37
+ <span class="title">PhotoCollection</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Flickr::PhotoCollection
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Array</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Array</li>
82
+
83
+ <li class="next">Flickr::PhotoCollection</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/flickr.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>A collection of photos is returned as a PhotoCollection, a subclass of
108
+ Array. This allows us to retain the pagination info returned by Flickr and
109
+ make it accessible in a friendly way</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#page-instance_method" title="#page (instance method)">- (Object) <strong>page</strong> </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+ <span class="note title readonly">readonly</span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'>
147
+ <p>Returns the value of attribute page.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#pages-instance_method" title="#pages (instance method)">- (Object) <strong>pages</strong> </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+ <span class="note title readonly">readonly</span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'>
176
+ <p>Returns the value of attribute pages.</p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ <li class="public ">
183
+ <span class="summary_signature">
184
+
185
+ <a href="#perpage-instance_method" title="#perpage (instance method)">- (Object) <strong>perpage</strong> </a>
186
+
187
+
188
+
189
+ </span>
190
+
191
+
192
+
193
+
194
+ <span class="note title readonly">readonly</span>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <span class="summary_desc"><div class='inline'>
205
+ <p>Returns the value of attribute perpage.</p>
206
+ </div></span>
207
+
208
+ </li>
209
+
210
+
211
+ <li class="public ">
212
+ <span class="summary_signature">
213
+
214
+ <a href="#total-instance_method" title="#total (instance method)">- (Object) <strong>total</strong> </a>
215
+
216
+
217
+
218
+ </span>
219
+
220
+
221
+
222
+
223
+ <span class="note title readonly">readonly</span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'>
234
+ <p>Returns the value of attribute total.</p>
235
+ </div></span>
236
+
237
+ </li>
238
+
239
+
240
+ </ul>
241
+
242
+
243
+
244
+
245
+
246
+ <h2>
247
+ Instance Method Summary
248
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
249
+ </h2>
250
+
251
+ <ul class="summary">
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (PhotoCollection) <strong>initialize</strong>(photos_api_response = {}, api_key = {}, list_node = &quot;photos&quot;) </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+ <span class="note title constructor">constructor</span>
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>builds a PhotoCollection from given params, such as those returned from
274
+ photos.search API call.</p>
275
+ </div></span>
276
+
277
+ </li>
278
+
279
+
280
+ </ul>
281
+
282
+
283
+
284
+ <div id="constructor_details" class="method_details_list">
285
+ <h2>Constructor Details</h2>
286
+
287
+ <div class="method_details first">
288
+ <h3 class="signature first" id="initialize-instance_method">
289
+
290
+ - (<tt><span class='object_link'><a href="" title="Flickr::PhotoCollection (class)">PhotoCollection</a></span></tt>) <strong>initialize</strong>(photos_api_response = {}, api_key = {}, list_node = &quot;photos&quot;)
291
+
292
+
293
+
294
+
295
+
296
+ </h3><div class="docstring">
297
+ <div class="discussion">
298
+
299
+ <p>builds a PhotoCollection from given params, such as those returned from
300
+ photos.search API call. Note all the info is contained in the value of the
301
+ first (and only) key-value pair of the response. The key will vary
302
+ depending on the original object the photos are related to (e.g
303
+ &#39;photos&#39;, &#39;photoset&#39;, etc)</p>
304
+
305
+
306
+ </div>
307
+ </div>
308
+ <div class="tags">
309
+
310
+
311
+ </div><table class="source_code">
312
+ <tr>
313
+ <td>
314
+ <pre class="lines">
315
+
316
+
317
+ 238
318
+ 239
319
+ 240
320
+ 241
321
+ 242
322
+ 243
323
+ 244</pre>
324
+ </td>
325
+ <td>
326
+ <pre class="code"><span class="info file"># File 'lib/flickr.rb', line 238</span>
327
+
328
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_photos_api_response'>photos_api_response</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_list_node'>list_node</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>photos</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
329
+ <span class='id identifier rubyid_photos'>photos</span> <span class='op'>=</span> <span class='id identifier rubyid_photos_api_response'>photos_api_response</span><span class='lbracket'>[</span><span class='id identifier rubyid_list_node'>list_node</span><span class='rbracket'>]</span>
330
+ <span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pages</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>perpage</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>total</span><span class='tstring_end'>&quot;</span></span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_i'>i</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_photos'>photos</span><span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rbrace'>}</span>
331
+ <span class='id identifier rubyid_collection'>collection</span> <span class='op'>=</span> <span class='id identifier rubyid_photos'>photos</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>photo</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
332
+ <span class='id identifier rubyid_collection'>collection</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_collection'>collection</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
333
+ <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_photo'>photo</span><span class='op'>|</span> <span class='kw'>self</span> <span class='op'>&lt;&lt;</span> <span class='const'>Photo</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_photo'>photo</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_photo'>photo</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
334
+ <span class='kw'>end</span></pre>
335
+ </td>
336
+ </tr>
337
+ </table>
338
+ </div>
339
+
340
+ </div>
341
+
342
+ <div id="instance_attr_details" class="attr_details">
343
+ <h2>Instance Attribute Details</h2>
344
+
345
+
346
+ <span id=""></span>
347
+ <div class="method_details first">
348
+ <h3 class="signature first" id="page-instance_method">
349
+
350
+ - (<tt>Object</tt>) <strong>page</strong> <span class="extras">(readonly)</span>
351
+
352
+
353
+
354
+
355
+
356
+ </h3><div class="docstring">
357
+ <div class="discussion">
358
+
359
+ <p>Returns the value of attribute page</p>
360
+
361
+
362
+ </div>
363
+ </div>
364
+ <div class="tags">
365
+
366
+
367
+ </div><table class="source_code">
368
+ <tr>
369
+ <td>
370
+ <pre class="lines">
371
+
372
+
373
+ 231
374
+ 232
375
+ 233</pre>
376
+ </td>
377
+ <td>
378
+ <pre class="code"><span class="info file"># File 'lib/flickr.rb', line 231</span>
379
+
380
+ <span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span>
381
+ <span class='ivar'>@page</span>
382
+ <span class='kw'>end</span></pre>
383
+ </td>
384
+ </tr>
385
+ </table>
386
+ </div>
387
+
388
+
389
+ <span id=""></span>
390
+ <div class="method_details ">
391
+ <h3 class="signature " id="pages-instance_method">
392
+
393
+ - (<tt>Object</tt>) <strong>pages</strong> <span class="extras">(readonly)</span>
394
+
395
+
396
+
397
+
398
+
399
+ </h3><div class="docstring">
400
+ <div class="discussion">
401
+
402
+ <p>Returns the value of attribute pages</p>
403
+
404
+
405
+ </div>
406
+ </div>
407
+ <div class="tags">
408
+
409
+
410
+ </div><table class="source_code">
411
+ <tr>
412
+ <td>
413
+ <pre class="lines">
414
+
415
+
416
+ 231
417
+ 232
418
+ 233</pre>
419
+ </td>
420
+ <td>
421
+ <pre class="code"><span class="info file"># File 'lib/flickr.rb', line 231</span>
422
+
423
+ <span class='kw'>def</span> <span class='id identifier rubyid_pages'>pages</span>
424
+ <span class='ivar'>@pages</span>
425
+ <span class='kw'>end</span></pre>
426
+ </td>
427
+ </tr>
428
+ </table>
429
+ </div>
430
+
431
+
432
+ <span id=""></span>
433
+ <div class="method_details ">
434
+ <h3 class="signature " id="perpage-instance_method">
435
+
436
+ - (<tt>Object</tt>) <strong>perpage</strong> <span class="extras">(readonly)</span>
437
+
438
+
439
+
440
+
441
+
442
+ </h3><div class="docstring">
443
+ <div class="discussion">
444
+
445
+ <p>Returns the value of attribute perpage</p>
446
+
447
+
448
+ </div>
449
+ </div>
450
+ <div class="tags">
451
+
452
+
453
+ </div><table class="source_code">
454
+ <tr>
455
+ <td>
456
+ <pre class="lines">
457
+
458
+
459
+ 231
460
+ 232
461
+ 233</pre>
462
+ </td>
463
+ <td>
464
+ <pre class="code"><span class="info file"># File 'lib/flickr.rb', line 231</span>
465
+
466
+ <span class='kw'>def</span> <span class='id identifier rubyid_perpage'>perpage</span>
467
+ <span class='ivar'>@perpage</span>
468
+ <span class='kw'>end</span></pre>
469
+ </td>
470
+ </tr>
471
+ </table>
472
+ </div>
473
+
474
+
475
+ <span id=""></span>
476
+ <div class="method_details ">
477
+ <h3 class="signature " id="total-instance_method">
478
+
479
+ - (<tt>Object</tt>) <strong>total</strong> <span class="extras">(readonly)</span>
480
+
481
+
482
+
483
+
484
+
485
+ </h3><div class="docstring">
486
+ <div class="discussion">
487
+
488
+ <p>Returns the value of attribute total</p>
489
+
490
+
491
+ </div>
492
+ </div>
493
+ <div class="tags">
494
+
495
+
496
+ </div><table class="source_code">
497
+ <tr>
498
+ <td>
499
+ <pre class="lines">
500
+
501
+
502
+ 231
503
+ 232
504
+ 233</pre>
505
+ </td>
506
+ <td>
507
+ <pre class="code"><span class="info file"># File 'lib/flickr.rb', line 231</span>
508
+
509
+ <span class='kw'>def</span> <span class='id identifier rubyid_total'>total</span>
510
+ <span class='ivar'>@total</span>
511
+ <span class='kw'>end</span></pre>
512
+ </td>
513
+ </tr>
514
+ </table>
515
+ </div>
516
+
517
+ </div>
518
+
519
+
520
+ </div>
521
+
522
+ <div id="footer">
523
+ Generated on Tue May 13 13:49:25 2014 by
524
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
525
+ 0.8.7.4 (ruby-2.0.0).
526
+ </div>
527
+
528
+ </body>
529
+ </html>