shroud 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. data/.gitignore +3 -0
  2. data/CHANGELOG +1 -0
  3. data/Manifest +7 -0
  4. data/README.markdown +48 -0
  5. data/Rakefile +26 -0
  6. data/VERSION +1 -0
  7. data/bin/shroud +40 -0
  8. data/doc/Shroud.html +204 -0
  9. data/doc/Shroud/AuthorizationError.html +99 -0
  10. data/doc/Shroud/FileNotFound.html +99 -0
  11. data/doc/Shroud/ItemNotFound.html +99 -0
  12. data/doc/Shroud/Session.html +952 -0
  13. data/doc/_index.html +146 -0
  14. data/doc/class_list.html +36 -0
  15. data/doc/css/common.css +1 -0
  16. data/doc/css/full_list.css +50 -0
  17. data/doc/css/style.css +273 -0
  18. data/doc/file.README.html +95 -0
  19. data/doc/file_list.html +38 -0
  20. data/doc/frames.html +13 -0
  21. data/doc/index.html +95 -0
  22. data/doc/js/app.js +111 -0
  23. data/doc/js/full_list.js +117 -0
  24. data/doc/js/jquery.js +19 -0
  25. data/doc/method_list.html +91 -0
  26. data/doc/top-level-namespace.html +87 -0
  27. data/lib/shroud.rb +136 -0
  28. data/shroud.gemspec +69 -0
  29. metadata +89 -0
data/doc/Shroud/ItemNotFound.html ADDED
@@ -0,0 +1,99 @@
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 name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Exception: Shroud::ItemNotFound</title>
7
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../_index.html">Index (I)</a> &raquo;
27
+ <span class='title'><a href="../Shroud.html" title="Shroud (module)">Shroud</a></span>
28
+ &raquo;
29
+ <span class="title">ItemNotFound</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Exception: Shroud::ItemNotFound
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+ <dt class="r1">Inherits:</dt>
54
+ <dd class="r1">
55
+ <span class="inheritName">StandardError</span>
56
+
57
+ <ul class="fullTree">
58
+ <li>Object</li>
59
+
60
+ <li class="next">StandardError</li>
61
+
62
+ <li class="next">Shroud::ItemNotFound</li>
63
+
64
+ </ul>
65
+ <a href="#" class="inheritanceTree">show all</a>
66
+
67
+ </dd>
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2 last">Defined in:</dt>
78
+ <dd class="r2 last">lib/shroud.rb</dd>
79
+
80
+ </dl>
81
+ <div class="clear"></div>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+ </div>
91
+
92
+ <div id="footer">
93
+ Generated on Thu May 13 18:53:17 2010 by
94
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
95
+ 0.5.4 (ruby-1.9.1).
96
+ </div>
97
+
98
+ </body>
99
+ </html>
data/doc/Shroud/Session.html ADDED
@@ -0,0 +1,952 @@
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 name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Class: Shroud::Session</title>
7
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../_index.html">Index (S)</a> &raquo;
27
+ <span class='title'><a href="../Shroud.html" title="Shroud (module)">Shroud</a></span>
28
+ &raquo;
29
+ <span class="title">Session</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Class: Shroud::Session
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+ <dt class="r1">Inherits:</dt>
54
+ <dd class="r1">
55
+ <span class="inheritName">Object</span>
56
+
57
+ <ul class="fullTree">
58
+ <li>Object</li>
59
+
60
+ <li class="next">Shroud::Session</li>
61
+
62
+ </ul>
63
+ <a href="#" class="inheritanceTree">show all</a>
64
+
65
+ </dd>
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+ <dt class="r2 last">Defined in:</dt>
76
+ <dd class="r2 last">lib/shroud.rb</dd>
77
+
78
+ </dl>
79
+ <div class="clear"></div>
80
+
81
+
82
+
83
+
84
+
85
+ <h2>Instance Method Summary</h2>
86
+
87
+ <ul class="summary">
88
+
89
+ <li class="public ">
90
+ <span class="summary_signature">
91
+
92
+ <a href="#create_bookmark-instance_method" title="#create_bookmark (instance method)">- (Hash) <strong>create_bookmark</strong>(url, name = '') </a>
93
+
94
+
95
+
96
+ </span>
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <span class="summary_desc"><div class='inline'><p>
105
+ Creates a bookmark.
106
+ </p>
107
+ </div></span>
108
+
109
+ </li>
110
+
111
+
112
+ <li class="public ">
113
+ <span class="summary_signature">
114
+
115
+ <a href="#delete_item-instance_method" title="#delete_item (instance method)">- (Hash) <strong>delete_item</strong>(item) </a>
116
+
117
+
118
+
119
+ </span>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <span class="summary_desc"><div class='inline'><p>
128
+ Deletes an item.
129
+ </p>
130
+ </div></span>
131
+
132
+ </li>
133
+
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#get_item-instance_method" title="#get_item (instance method)">- (Hash) <strong>get_item</strong>(item) </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'><p>
151
+ Gets an items information.
152
+ </p>
153
+ </div></span>
154
+
155
+ </li>
156
+
157
+
158
+ <li class="public ">
159
+ <span class="summary_signature">
160
+
161
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Session) <strong>initialize</strong>(username, password) </a>
162
+
163
+
164
+
165
+ </span>
166
+
167
+ <span class="note title constructor">constructor</span>
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'><p>
176
+ A new instance of Session.
177
+ </p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#list_items-instance_method" title="#list_items (instance method)">- (Array&lt;Hash&gt;) <strong>list_items</strong>(args = {}) </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'><p>
199
+ Gets a list of items.
200
+ </p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#upload_file-instance_method" title="#upload_file (instance method)">- (Object) <strong>upload_file</strong>(file) </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'><p>
222
+ Uploads an item.
223
+ </p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ </ul>
230
+
231
+
232
+ <div id="constructor_details" class="method_details_list">
233
+ <h2>Constructor Details</h2>
234
+
235
+ <div class="method_details first">
236
+ <p class="signature first" id="initialize-instance_method">
237
+
238
+ - (<tt><a href="" title="Shroud::Session (class)">Session</a></tt>) <strong>initialize</strong>(username, password)
239
+
240
+
241
+
242
+ </p><div class="docstring">
243
+ <div class="discussion">
244
+ <p>
245
+ A new instance of Session
246
+ </p>
247
+
248
+
249
+ </div>
250
+ </div>
251
+ <div class="tags">
252
+ <h3>Parameters:</h3>
253
+ <ul class="param">
254
+
255
+ <li>
256
+
257
+ <span class='type'>(<tt>Username</tt>, <tt>Password</tt>)</span>
258
+
259
+
260
+ <span class='name'></span>
261
+
262
+
263
+
264
+ </li>
265
+
266
+ </ul>
267
+
268
+ </div><table class="source_code">
269
+ <tr>
270
+ <td>
271
+ <pre class="lines">
272
+
273
+
274
+ 22
275
+ 23
276
+ 24
277
+ 25
278
+ 26
279
+ 27
280
+ 28
281
+ 29
282
+ 30
283
+ 31
284
+ 32
285
+ 33</pre>
286
+ </td>
287
+ <td>
288
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 22</span>
289
+
290
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span> <span class='id username'>username</span><span class='comma'>,</span> <span class='id password'>password</span> <span class='rparen'>)</span>
291
+ <span class='ivar'>@session</span> <span class='op'>=</span> <span class='const'>Patron</span><span class='op'>::</span><span class='const'>Session</span><span class='period'>.</span><span class='id new'>new</span>
292
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>&quot;</span></span>
293
+
294
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id headers'>headers</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 CloudAPI</span><span class='tstring_end'>'</span></span>
295
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</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'>application/json</span><span class='tstring_end'>'</span></span>
296
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Accept</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'>application/json</span><span class='tstring_end'>'</span></span>
297
+
298
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id username'>username</span> <span class='op'>=</span> <span class='id username'>username</span>
299
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id password'>password</span> <span class='op'>=</span> <span class='id password'>password</span>
300
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id auth_type'>auth_type</span> <span class='op'>=</span> <span class='symbol'>:digest</span>
301
+ <span class='kw'>end</span></pre>
302
+ </td>
303
+ </tr>
304
+ </table>
305
+ </div>
306
+
307
+ </div>
308
+
309
+
310
+ <div id="instance_method_details" class="method_details_list">
311
+ <h2>Instance Method Details</h2>
312
+
313
+
314
+ <div class="method_details first">
315
+ <p class="signature first" id="create_bookmark-instance_method">
316
+
317
+ - (<tt>Hash</tt>) <strong>create_bookmark</strong>(url, name = '')
318
+
319
+
320
+
321
+ </p><div class="docstring">
322
+ <div class="discussion">
323
+ <p>
324
+ Creates a bookmark
325
+ </p>
326
+
327
+
328
+ </div>
329
+ </div>
330
+ <div class="tags">
331
+ <h3>Parameters:</h3>
332
+ <ul class="param">
333
+
334
+ <li>
335
+
336
+ <span class='type'>(<tt>String</tt>, <tt>Name</tt>)</span>
337
+
338
+
339
+ <span class='name'>URL,</span>
340
+
341
+
342
+
343
+ &mdash;
344
+ <div class='inline'><p>
345
+ name of bookmark
346
+ </p>
347
+ </div>
348
+
349
+ </li>
350
+
351
+ </ul>
352
+ <h3>Returns:</h3>
353
+ <ul class="return">
354
+
355
+ <li>
356
+
357
+ <span class='type'>(<tt>Hash</tt>)</span>
358
+
359
+
360
+
361
+
362
+ &mdash;
363
+ <div class='inline'><p>
364
+ New bookmark information
365
+ </p>
366
+ </div>
367
+
368
+ </li>
369
+
370
+ </ul>
371
+ <h3>Raises:</h3>
372
+ <ul class="raise">
373
+
374
+ <li>
375
+
376
+ <span class='type'>(<tt><a href="ItemNotFound.html" title="Shroud::ItemNotFound (class)">ItemNotFound</a></tt>)</span>
377
+
378
+
379
+
380
+
381
+ </li>
382
+
383
+ </ul>
384
+
385
+ </div><table class="source_code">
386
+ <tr>
387
+ <td>
388
+ <pre class="lines">
389
+
390
+
391
+ 78
392
+ 79
393
+ 80
394
+ 81
395
+ 82
396
+ 83
397
+ 84
398
+ 85
399
+ 86
400
+ 87</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 78</span>
404
+
405
+ <span class='kw'>def</span> <span class='id create_bookmark'>create_bookmark</span><span class='lparen'>(</span> <span class='id url'>url</span><span class='comma'>,</span> <span class='id name'>name</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='rparen'>)</span>
406
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>&quot;</span></span>
407
+ <span class='id bookmark'>bookmark</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:item</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:redirect_url</span> <span class='op'>=&gt;</span> <span class='id url'>url</span><span class='rbrace'>}</span> <span class='rbrace'>}</span>
408
+
409
+ <span class='id resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/items</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id bookmark'>bookmark</span><span class='period'>.</span><span class='id to_json'>to_json</span><span class='rparen'>)</span>
410
+
411
+ <span class='id raise'>raise</span> <span class='const'>ItemNotFound</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>404</span>
412
+ <span class='id raise'>raise</span> <span class='const'>AuthorizationError</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>401</span>
413
+ <span class='const'>Crack</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 resp'>resp</span><span class='period'>.</span><span class='id body'>body</span><span class='rparen'>)</span>
414
+ <span class='kw'>end</span></pre>
415
+ </td>
416
+ </tr>
417
+ </table>
418
+ </div>
419
+
420
+ <div class="method_details ">
421
+ <p class="signature " id="delete_item-instance_method">
422
+
423
+ - (<tt>Hash</tt>) <strong>delete_item</strong>(item)
424
+
425
+
426
+
427
+ </p><div class="docstring">
428
+ <div class="discussion">
429
+ <p>
430
+ Deletes an item
431
+ </p>
432
+
433
+
434
+ </div>
435
+ </div>
436
+ <div class="tags">
437
+ <h3>Parameters:</h3>
438
+ <ul class="param">
439
+
440
+ <li>
441
+
442
+ <span class='type'>(<tt>String</tt>)</span>
443
+
444
+
445
+ <span class='name'>slug</span>
446
+
447
+
448
+
449
+ &mdash;
450
+ <div class='inline'><p>
451
+ item to delete
452
+ </p>
453
+ </div>
454
+
455
+ </li>
456
+
457
+ </ul>
458
+ <h3>Returns:</h3>
459
+ <ul class="return">
460
+
461
+ <li>
462
+
463
+ <span class='type'>(<tt>Hash</tt>)</span>
464
+
465
+
466
+
467
+
468
+ &mdash;
469
+ <div class='inline'><p>
470
+ response body
471
+ </p>
472
+ </div>
473
+
474
+ </li>
475
+
476
+ </ul>
477
+ <h3>Raises:</h3>
478
+ <ul class="raise">
479
+
480
+ <li>
481
+
482
+ <span class='type'>(<tt><a href="ItemNotFound.html" title="Shroud::ItemNotFound (class)">ItemNotFound</a></tt>)</span>
483
+
484
+
485
+
486
+
487
+ </li>
488
+
489
+ </ul>
490
+
491
+ </div><table class="source_code">
492
+ <tr>
493
+ <td>
494
+ <pre class="lines">
495
+
496
+
497
+ 125
498
+ 126
499
+ 127
500
+ 128
501
+ 129
502
+ 130
503
+ 131
504
+ 132
505
+ 133</pre>
506
+ </td>
507
+ <td>
508
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 125</span>
509
+
510
+ <span class='kw'>def</span> <span class='id delete_item'>delete_item</span><span class='lparen'>(</span> <span class='id item'>item</span> <span class='rparen'>)</span>
511
+ <span class='id to_delete'>to_delete</span> <span class='op'>=</span> <span class='id get_item'>get_item</span><span class='lparen'>(</span> <span class='id item'>item</span> <span class='rparen'>)</span>
512
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>&quot;</span></span>
513
+ <span class='id resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span> <span class='id to_delete'>to_delete</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>href</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id gsub!'>gsub!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='rparen'>)</span>
514
+
515
+ <span class='id raise'>raise</span> <span class='const'>ItemNotFound</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>404</span>
516
+ <span class='id raise'>raise</span> <span class='const'>AuthorizationError</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>401</span>
517
+ <span class='kw'>true</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>200</span>
518
+ <span class='kw'>end</span></pre>
519
+ </td>
520
+ </tr>
521
+ </table>
522
+ </div>
523
+
524
+ <div class="method_details ">
525
+ <p class="signature " id="get_item-instance_method">
526
+
527
+ - (<tt>Hash</tt>) <strong>get_item</strong>(item)
528
+
529
+
530
+
531
+ </p><div class="docstring">
532
+ <div class="discussion">
533
+ <p>
534
+ Gets an items information
535
+ </p>
536
+
537
+
538
+ </div>
539
+ </div>
540
+ <div class="tags">
541
+ <h3>Parameters:</h3>
542
+ <ul class="param">
543
+
544
+ <li>
545
+
546
+ <span class='type'>(<tt>String</tt>)</span>
547
+
548
+
549
+ <span class='name'>slug</span>
550
+
551
+
552
+
553
+ &mdash;
554
+ <div class='inline'><p>
555
+ item to get
556
+ </p>
557
+ </div>
558
+
559
+ </li>
560
+
561
+ </ul>
562
+ <h3>Returns:</h3>
563
+ <ul class="return">
564
+
565
+ <li>
566
+
567
+ <span class='type'>(<tt>Hash</tt>)</span>
568
+
569
+
570
+
571
+
572
+ &mdash;
573
+ <div class='inline'><p>
574
+ response body
575
+ </p>
576
+ </div>
577
+
578
+ </li>
579
+
580
+ </ul>
581
+ <h3>Raises:</h3>
582
+ <ul class="raise">
583
+
584
+ <li>
585
+
586
+ <span class='type'>(<tt><a href="ItemNotFound.html" title="Shroud::ItemNotFound (class)">ItemNotFound</a></tt>)</span>
587
+
588
+
589
+
590
+
591
+ </li>
592
+
593
+ </ul>
594
+
595
+ </div><table class="source_code">
596
+ <tr>
597
+ <td>
598
+ <pre class="lines">
599
+
600
+
601
+ 39
602
+ 40
603
+ 41
604
+ 42
605
+ 43
606
+ 44
607
+ 45</pre>
608
+ </td>
609
+ <td>
610
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 39</span>
611
+
612
+ <span class='kw'>def</span> <span class='id get_item'>get_item</span><span class='lparen'>(</span> <span class='id item'>item</span> <span class='rparen'>)</span>
613
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://cl.ly</span><span class='tstring_end'>&quot;</span></span>
614
+ <span class='id resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id get'>get</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span> <span class='id item'>item</span> <span class='rparen'>)</span>
615
+
616
+ <span class='id raise'>raise</span> <span class='const'>ItemNotFound</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>404</span>
617
+ <span class='const'>Crack</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 resp'>resp</span><span class='period'>.</span><span class='id body'>body</span><span class='rparen'>)</span>
618
+ <span class='kw'>end</span></pre>
619
+ </td>
620
+ </tr>
621
+ </table>
622
+ </div>
623
+
624
+ <div class="method_details ">
625
+ <p class="signature " id="list_items-instance_method">
626
+
627
+ - (<tt>Array&lt;Hash&gt;</tt>) <strong>list_items</strong>(args = {})
628
+
629
+
630
+
631
+ </p><div class="docstring">
632
+ <div class="discussion">
633
+ <p>
634
+ Gets a list of items
635
+ </p>
636
+
637
+
638
+ </div>
639
+ </div>
640
+ <div class="tags">
641
+ <h3>Parameters:</h3>
642
+ <ul class="param">
643
+
644
+ <li>
645
+
646
+ <span class='type'>(<tt>Hash</tt>)</span>
647
+
648
+
649
+ <span class='name'>args</span>
650
+
651
+
652
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
653
+
654
+
655
+ &mdash;
656
+ <div class='inline'><p>
657
+ The options to list items
658
+ </p>
659
+ </div>
660
+
661
+ </li>
662
+
663
+ </ul>
664
+
665
+
666
+
667
+
668
+ <h3>Options Hash (<tt>args</tt>):</h3>
669
+ <ul class="option">
670
+
671
+ <li>
672
+ <span class="type">(<tt>Integer</tt>)</span>
673
+ <span class="name">:page</span>
674
+ <span class="default">
675
+
676
+ <span class="na">N/A</span>
677
+
678
+ </span>
679
+ &mdash;<div class='inline'><p>
680
+ Page to start at
681
+ </p>
682
+ </div>
683
+ </tr>
684
+
685
+ <li>
686
+ <span class="type">(<tt>Integer</tt>)</span>
687
+ <span class="name">:per_page</span>
688
+ <span class="default">
689
+
690
+ <span class="na">N/A</span>
691
+
692
+ </span>
693
+ &mdash;<div class='inline'><p>
694
+ Number of items per page
695
+ </p>
696
+ </div>
697
+ </tr>
698
+
699
+ <li>
700
+ <span class="type">(<tt>String</tt>)</span>
701
+ <span class="name">:type</span>
702
+ <span class="default">
703
+
704
+ <span class="na">N/A</span>
705
+
706
+ </span>
707
+ &mdash;<div class='inline'><p>
708
+ Type of item to return
709
+ </p>
710
+ </div>
711
+ </tr>
712
+
713
+ <li>
714
+ <span class="type">(<tt>Boolean</tt>)</span>
715
+ <span class="name">:deleted</span>
716
+ <span class="default">
717
+
718
+ <span class="na">N/A</span>
719
+
720
+ </span>
721
+ &mdash;<div class='inline'><p>
722
+ Show deleted items
723
+ </p>
724
+ </div>
725
+ </tr>
726
+
727
+ </ul>
728
+
729
+ <h3>Returns:</h3>
730
+ <ul class="return">
731
+
732
+ <li>
733
+
734
+ <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
735
+
736
+
737
+
738
+
739
+ &mdash;
740
+ <div class='inline'><p>
741
+ list of item hashes
742
+ </p>
743
+ </div>
744
+
745
+ </li>
746
+
747
+ </ul>
748
+ <h3>Raises:</h3>
749
+ <ul class="raise">
750
+
751
+ <li>
752
+
753
+ <span class='type'>(<tt><a href="AuthorizationError.html" title="Shroud::AuthorizationError (class)">AuthorizationError</a></tt>)</span>
754
+
755
+
756
+
757
+
758
+ </li>
759
+
760
+ </ul>
761
+
762
+ </div><table class="source_code">
763
+ <tr>
764
+ <td>
765
+ <pre class="lines">
766
+
767
+
768
+ 56
769
+ 57
770
+ 58
771
+ 59
772
+ 60
773
+ 61
774
+ 62
775
+ 63
776
+ 64
777
+ 65
778
+ 66
779
+ 67
780
+ 68
781
+ 69
782
+ 70
783
+ 71
784
+ 72</pre>
785
+ </td>
786
+ <td>
787
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 56</span>
788
+
789
+ <span class='kw'>def</span> <span class='id list_items'>list_items</span><span class='lparen'>(</span> <span class='id args'>args</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
790
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>&quot;</span></span>
791
+
792
+ <span class='id url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/items</span><span class='tstring_end'>&quot;</span></span>
793
+ <span class='id args'>args</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span>
794
+ <span class='comment'># probably a nicer way to do this
795
+ </span> <span class='kw'>if</span> <span class='id url'>url</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/items</span><span class='tstring_end'>&quot;</span></span>
796
+ <span class='id url'>url</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id v'>v</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
797
+ <span class='kw'>else</span>
798
+ <span class='id url'>url</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&amp;</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id v'>v</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
799
+ <span class='kw'>end</span>
800
+ <span class='kw'>end</span>
801
+ <span class='id resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id get'>get</span><span class='lparen'>(</span> <span class='id url'>url</span> <span class='rparen'>)</span>
802
+
803
+ <span class='id raise'>raise</span> <span class='const'>AuthorizationError</span> <span class='kw'>if</span> <span class='id resp'>resp</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>401</span>
804
+ <span class='const'>Crack</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 resp'>resp</span><span class='period'>.</span><span class='id body'>body</span><span class='rparen'>)</span>
805
+ <span class='kw'>end</span></pre>
806
+ </td>
807
+ </tr>
808
+ </table>
809
+ </div>
810
+
811
+ <div class="method_details ">
812
+ <p class="signature " id="upload_file-instance_method">
813
+
814
+ - (<tt>Object</tt>) <strong>upload_file</strong>(file)
815
+
816
+
817
+
818
+ </p><div class="docstring">
819
+ <div class="discussion">
820
+
821
+ <p class="note todo">
822
+ <strong>TODO:</strong>
823
+ <div class='inline'><p>
824
+ Get this to work!!!
825
+ </p>
826
+ </div>
827
+ </p>
828
+
829
+ <p>
830
+ Uploads an item
831
+ </p>
832
+
833
+
834
+ </div>
835
+ </div>
836
+ <div class="tags">
837
+ <h3>Parameters:</h3>
838
+ <ul class="param">
839
+
840
+ <li>
841
+
842
+ <span class='type'>(<tt>String</tt>)</span>
843
+
844
+
845
+ <span class='name'>file</span>
846
+
847
+
848
+
849
+ &mdash;
850
+ <div class='inline'><p>
851
+ Relative or absolute path to item to upload
852
+ </p>
853
+ </div>
854
+
855
+ </li>
856
+
857
+ </ul>
858
+ <h3>Raises:</h3>
859
+ <ul class="raise">
860
+
861
+ <li>
862
+
863
+ <span class='type'>(<tt><a href="FileNotFound.html" title="Shroud::FileNotFound (class)">FileNotFound</a></tt>)</span>
864
+
865
+
866
+
867
+
868
+ </li>
869
+
870
+ </ul>
871
+
872
+ </div><table class="source_code">
873
+ <tr>
874
+ <td>
875
+ <pre class="lines">
876
+
877
+
878
+ 93
879
+ 94
880
+ 95
881
+ 96
882
+ 97
883
+ 98
884
+ 99
885
+ 100
886
+ 101
887
+ 102
888
+ 103
889
+ 104
890
+ 105
891
+ 106
892
+ 107
893
+ 108
894
+ 109
895
+ 110
896
+ 111
897
+ 112
898
+ 113
899
+ 114
900
+ 115
901
+ 116
902
+ 117
903
+ 118
904
+ 119</pre>
905
+ </td>
906
+ <td>
907
+ <pre class="code"><span class="info file"># File 'lib/shroud.rb', line 93</span>
908
+
909
+ <span class='kw'>def</span> <span class='id upload_file'>upload_file</span><span class='lparen'>(</span> <span class='id file'>file</span> <span class='rparen'>)</span>
910
+ <span class='id raise'>raise</span> <span class='const'>FileNotFound</span> <span class='kw'>unless</span> <span class='const'>File</span><span class='period'>.</span><span class='id exists?'>exists?</span><span class='lparen'>(</span><span class='id file'>file</span><span class='rparen'>)</span>
911
+
912
+ <span class='comment'># get data to build POST
913
+ </span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://my.cl.ly</span><span class='tstring_end'>&quot;</span></span>
914
+ <span class='id post_data'>post_data</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/items/new</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
915
+
916
+ <span class='id raise'>raise</span> <span class='const'>AuthorizationError</span> <span class='kw'>if</span> <span class='id post_data'>post_data</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>==</span> <span class='int'>401</span>
917
+
918
+ <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Crack</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 post_data'>post_data</span><span class='period'>.</span><span class='id body'>body</span><span class='rparen'>)</span>
919
+ <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</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'>1ST RESPONSE</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id r'>r</span><span class='period'>.</span><span class='id to_yaml'>to_yaml</span>
920
+
921
+ <span class='id params'>params</span> <span class='op'>=</span> <span class='id r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>params</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
922
+ <span class='id params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>file</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='id file'>file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>r</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
923
+
924
+ <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PARAMS</span><span class='tstring_end'>'</span></span>
925
+ <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span>
926
+ <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='rbrace'>}</span><span class='tstring_content'>: '</span><span class='embexpr_beg'>#{</span><span class='id v'>v</span><span class='rbrace'>}</span><span class='tstring_content'>'</span><span class='tstring_end'>&quot;</span></span>
927
+ <span class='kw'>end</span>
928
+ <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
929
+
930
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id base_url'>base_url</span> <span class='op'>=</span> <span class='id r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>url</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
931
+ <span class='ivar'>@session</span><span class='period'>.</span><span class='id headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</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'>multipart/form-data</span><span class='tstring_end'>'</span></span>
932
+
933
+ <span class='id resp'>resp</span> <span class='op'>=</span> <span class='ivar'>@session</span><span class='period'>.</span><span class='id post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id params'>params</span><span class='period'>.</span><span class='id to_json'>to_json</span><span class='rparen'>)</span>
934
+ <span class='id resp'>resp</span><span class='period'>.</span><span class='id body'>body</span>
935
+ <span class='kw'>end</span></pre>
936
+ </td>
937
+ </tr>
938
+ </table>
939
+ </div>
940
+
941
+ </div>
942
+
943
+ </div>
944
+
945
+ <div id="footer">
946
+ Generated on Thu May 13 18:53:17 2010 by
947
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
948
+ 0.5.4 (ruby-1.9.1).
949
+ </div>
950
+
951
+ </body>
952
+ </html>