mushikago-sdk 0.1.6 → 0.1.7

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 (37) hide show
  1. data/README +125 -0
  2. data/autotest/discover.rb +7 -0
  3. data/doc/Mushikago.html +243 -0
  4. data/doc/Mushikago/Auth.html +120 -0
  5. data/doc/Mushikago/Auth/Signature.html +305 -0
  6. data/doc/Mushikago/Auth/Signer.html +452 -0
  7. data/doc/Mushikago/Config.html +272 -0
  8. data/doc/Mushikago/Http.html +118 -0
  9. data/doc/Mushikago/Http/Client.html +551 -0
  10. data/doc/Mushikago/Http/Request.html +1264 -0
  11. data/doc/Mushikago/Http/Response.html +706 -0
  12. data/doc/Mushikago/Tombo.html +118 -0
  13. data/doc/Mushikago/Tombo/CaptureRequest.html +446 -0
  14. data/doc/Mushikago/Tombo/CapturesRequest.html +389 -0
  15. data/doc/Mushikago/Tombo/Client.html +770 -0
  16. data/doc/Mushikago/Tombo/DeleteRequest.html +391 -0
  17. data/doc/Mushikago/Tombo/InfoRequest.html +325 -0
  18. data/doc/Mushikago/Tombo/Request.html +287 -0
  19. data/doc/_index.html +278 -0
  20. data/doc/class_list.html +47 -0
  21. data/doc/css/common.css +1 -0
  22. data/doc/css/full_list.css +53 -0
  23. data/doc/css/style.css +320 -0
  24. data/doc/file.README.html +201 -0
  25. data/doc/file_list.html +49 -0
  26. data/doc/frames.html +13 -0
  27. data/doc/index.html +201 -0
  28. data/doc/js/app.js +205 -0
  29. data/doc/js/full_list.js +150 -0
  30. data/doc/js/jquery.js +16 -0
  31. data/doc/method_list.html +398 -0
  32. data/doc/top-level-namespace.html +103 -0
  33. data/lib/mushikago/tombo/capture_request.rb +1 -1
  34. data/lib/mushikago/tombo/client.rb +1 -1
  35. data/lib/mushikago/version.rb +1 -1
  36. data/spec/mushikago/tombo/capture_request_spec.rb +3 -3
  37. metadata +34 -3
data/doc/Mushikago/Http/Response.html ADDED
@@ -0,0 +1,706 @@
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: Mushikago::Http::Response
8
+
9
+ &mdash; Documentation by YARD 0.7.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '../..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mushikago.html" title="Mushikago (module)">Mushikago</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Http.html" title="Mushikago::Http (module)">Http</a></span></span>
38
+ &raquo;
39
+ <span class="title">Response</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: Mushikago::Http::Response
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">Mushikago::Http::Response</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/mushikago/http/response.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+
98
+ <p>Mushikagoサービスのレスポンスを扱うクラス
99
+ Mushikagoサービスのレスポンスは以下のような構造になっている</p>
100
+
101
+ <pre class="code"><span class='lbrace token'>{</span>
102
+ <span class='meta identifier id'>meta</span> <span class='colon op'>:</span> <span class='lbrace token'>{</span>
103
+ <span class='status identifier id'>status</span> <span class='colon op'>:</span> <span class='integer val'>200</span><span class='comma token'>,</span>
104
+ <span class='message identifier id'>message</span> <span class='colon op'>:</span> <span class='string val'>'OK'</span>
105
+ <span class='rbrace token'>}</span><span class='comma token'>,</span>
106
+ <span class='response identifier id'>response</span> <span class='colon op'>:</span> <span class='lbrace token'>{</span>
107
+ <span class='regexp val'>//</span> </pre>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+ </div>
115
+
116
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#meta-instance_method" title="#meta (instance method)">- (Object) <strong>meta</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+ <span class="note title readonly">readonly</span>
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'>
139
+ <p>レスポンスのメタ情報.</p>
140
+ </div></span>
141
+
142
+ </li>
143
+
144
+
145
+ <li class="public ">
146
+ <span class="summary_signature">
147
+
148
+ <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
149
+
150
+
151
+
152
+ </span>
153
+
154
+
155
+ <span class="note title readonly">readonly</span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <span class="summary_desc"><div class='inline'>
165
+ <p>レスポンスの本体.</p>
166
+ </div></span>
167
+
168
+ </li>
169
+
170
+
171
+ </ul>
172
+
173
+
174
+
175
+
176
+
177
+ <h2>
178
+ Instance Method Summary
179
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
180
+ </h2>
181
+
182
+ <ul class="summary">
183
+
184
+ <li class="public ">
185
+ <span class="summary_signature">
186
+
187
+ <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(key) </a>
188
+
189
+
190
+
191
+ </span>
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>レスポンスの各要素にアクセスする.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong>(options = {}) </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+ <span class="note title constructor">constructor</span>
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>A new instance of Response.</p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#message-instance_method" title="#message (instance method)">- (String) <strong>message</strong> </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>メタ情報中のmessageを返す.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#status-instance_method" title="#status (instance method)">- (Integer) <strong>status</strong> </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <span class="summary_desc"><div class='inline'>
272
+ <p>メタ情報中のstatusを返す.</p>
273
+ </div></span>
274
+
275
+ </li>
276
+
277
+
278
+ </ul>
279
+
280
+
281
+ <div id="constructor_details" class="method_details_list">
282
+ <h2>Constructor Details</h2>
283
+
284
+ <div class="method_details first">
285
+ <p class="signature first" id="initialize-instance_method">
286
+
287
+ - (<tt><span class='object_link'><a href="" title="Mushikago::Http::Response (class)">Response</a></span></tt>) <strong>initialize</strong>(options = {})
288
+
289
+
290
+
291
+ </p><div class="docstring">
292
+ <div class="discussion">
293
+
294
+ <p>A new instance of Response</p>
295
+
296
+
297
+ </div>
298
+ </div>
299
+ <div class="tags">
300
+ <h3>Parameters:</h3>
301
+ <ul class="param">
302
+
303
+ <li>
304
+
305
+ <span class='name'>options</span>
306
+
307
+
308
+ <span class='type'>(<tt>Hash</tt>)</span>
309
+
310
+
311
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
312
+
313
+
314
+ &mdash;
315
+ <div class='inline'>
316
+ <p>オプション</p>
317
+ </div>
318
+
319
+ </li>
320
+
321
+ </ul>
322
+
323
+
324
+
325
+
326
+ <h3>Options Hash (<tt>options</tt>):</h3>
327
+ <ul class="option">
328
+
329
+ <li>
330
+ <span class="name">:meta</span>
331
+ <span class="type">(<tt>Object</tt>)</span>
332
+ <span class="default">
333
+
334
+ </span>
335
+ &mdash; <div class='inline'>
336
+ <p>レスポンスのメタ情報</p>
337
+ </div>
338
+ </tr>
339
+
340
+ <li>
341
+ <span class="name">:response</span>
342
+ <span class="type">(<tt>Object</tt>)</span>
343
+ <span class="default">
344
+
345
+ </span>
346
+ &mdash; <div class='inline'>
347
+ <p>レスポンスの本体</p>
348
+ </div>
349
+ </tr>
350
+
351
+ </ul>
352
+
353
+
354
+ </div><table class="source_code">
355
+ <tr>
356
+ <td>
357
+ <pre class="lines">
358
+
359
+
360
+ 24</pre>
361
+ </td>
362
+ <td>
363
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 24</span>
364
+
365
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span>
366
+ </pre>
367
+ </td>
368
+ </tr>
369
+ </table>
370
+ </div>
371
+
372
+ </div>
373
+
374
+ <div id="instance_attr_details" class="attr_details">
375
+ <h2>Instance Attribute Details</h2>
376
+
377
+
378
+ <span id=""></span>
379
+ <span id="meta-instance_method"></span>
380
+ <div class="method_details first">
381
+ <p class="signature first" id="meta-instance_method">
382
+
383
+ - (<tt>Object</tt>) <strong>meta</strong> <span class="extras">(readonly)</span>
384
+
385
+
386
+
387
+ </p><div class="docstring">
388
+ <div class="discussion">
389
+
390
+ <p>レスポンスのメタ情報</p>
391
+
392
+
393
+ </div>
394
+ </div>
395
+ <div class="tags">
396
+ <h3>Returns:</h3>
397
+ <ul class="return">
398
+
399
+ <li>
400
+
401
+
402
+ <span class='type'>(<tt>Object</tt>)</span>
403
+
404
+
405
+
406
+ &mdash;
407
+ <div class='inline'>
408
+ <p>レスポンスのメタ情報</p>
409
+ </div>
410
+
411
+ </li>
412
+
413
+ </ul>
414
+
415
+ </div><table class="source_code">
416
+ <tr>
417
+ <td>
418
+ <pre class="lines">
419
+
420
+
421
+ 17
422
+ 18
423
+ 19</pre>
424
+ </td>
425
+ <td>
426
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 17</span>
427
+
428
+ <span class='def def kw'>def</span> <span class='meta identifier id'>meta</span>
429
+ <span class='@meta ivar id'>@meta</span>
430
+ <span class='end end kw'>end</span>
431
+ </pre>
432
+ </td>
433
+ </tr>
434
+ </table>
435
+ </div>
436
+
437
+
438
+ <span id=""></span>
439
+ <span id="response-instance_method"></span>
440
+ <div class="method_details ">
441
+ <p class="signature " id="response-instance_method">
442
+
443
+ - (<tt>Object</tt>) <strong>response</strong> <span class="extras">(readonly)</span>
444
+
445
+
446
+
447
+ </p><div class="docstring">
448
+ <div class="discussion">
449
+
450
+ <p>レスポンスの本体</p>
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+ <h3>Returns:</h3>
457
+ <ul class="return">
458
+
459
+ <li>
460
+
461
+
462
+ <span class='type'>(<tt>Object</tt>)</span>
463
+
464
+
465
+
466
+ &mdash;
467
+ <div class='inline'>
468
+ <p>レスポンスの本体</p>
469
+ </div>
470
+
471
+ </li>
472
+
473
+ </ul>
474
+
475
+ </div><table class="source_code">
476
+ <tr>
477
+ <td>
478
+ <pre class="lines">
479
+
480
+
481
+ 19
482
+ 20
483
+ 21</pre>
484
+ </td>
485
+ <td>
486
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 19</span>
487
+
488
+ <span class='def def kw'>def</span> <span class='response identifier id'>response</span>
489
+ <span class='@response ivar id'>@response</span>
490
+ <span class='end end kw'>end</span>
491
+ </pre>
492
+ </td>
493
+ </tr>
494
+ </table>
495
+ </div>
496
+
497
+ </div>
498
+
499
+
500
+ <div id="instance_method_details" class="method_details_list">
501
+ <h2>Instance Method Details</h2>
502
+
503
+
504
+ <div class="method_details first">
505
+ <p class="signature first" id="[]-instance_method">
506
+
507
+ - (<tt>Object</tt>) <strong>[]</strong>(key)
508
+
509
+
510
+
511
+ </p><div class="docstring">
512
+ <div class="discussion">
513
+
514
+ <p>レスポンスの各要素にアクセスする</p>
515
+
516
+
517
+ </div>
518
+ </div>
519
+ <div class="tags">
520
+ <h3>Parameters:</h3>
521
+ <ul class="param">
522
+
523
+ <li>
524
+
525
+ <span class='name'>key</span>
526
+
527
+
528
+ <span class='type'>(<tt>Symbol</tt>)</span>
529
+
530
+
531
+
532
+ &mdash;
533
+ <div class='inline'>
534
+ <p>レスポンスの各要素へのキー</p>
535
+ </div>
536
+
537
+ </li>
538
+
539
+ </ul>
540
+ <h3>Returns:</h3>
541
+ <ul class="return">
542
+
543
+ <li>
544
+
545
+
546
+ <span class='type'>(<tt>Object</tt>)</span>
547
+
548
+
549
+
550
+ &mdash;
551
+ <div class='inline'>
552
+ <p>レスポンスの要素</p>
553
+ </div>
554
+
555
+ </li>
556
+
557
+ </ul>
558
+
559
+ </div><table class="source_code">
560
+ <tr>
561
+ <td>
562
+ <pre class="lines">
563
+
564
+
565
+ 44
566
+ 45
567
+ 46</pre>
568
+ </td>
569
+ <td>
570
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 44</span>
571
+
572
+ <span class='def def kw'>def</span> <span class='aref op'>[]</span> <span class='key identifier id'>key</span>
573
+ <span class='response identifier id'>response</span><span class='lbrack token'>[</span><span class='key identifier id'>key</span><span class='rbrack token'>]</span>
574
+ <span class='end end kw'>end</span>
575
+ </pre>
576
+ </td>
577
+ </tr>
578
+ </table>
579
+ </div>
580
+
581
+ <div class="method_details ">
582
+ <p class="signature " id="message-instance_method">
583
+
584
+ - (<tt>String</tt>) <strong>message</strong>
585
+
586
+
587
+
588
+ </p><div class="docstring">
589
+ <div class="discussion">
590
+
591
+ <p>メタ情報中のmessageを返す</p>
592
+
593
+
594
+ </div>
595
+ </div>
596
+ <div class="tags">
597
+ <h3>Returns:</h3>
598
+ <ul class="return">
599
+
600
+ <li>
601
+
602
+
603
+ <span class='type'>(<tt>String</tt>)</span>
604
+
605
+
606
+
607
+ &mdash;
608
+ <div class='inline'>
609
+ <p>メッセージ</p>
610
+ </div>
611
+
612
+ </li>
613
+
614
+ </ul>
615
+
616
+ </div><table class="source_code">
617
+ <tr>
618
+ <td>
619
+ <pre class="lines">
620
+
621
+
622
+ 37
623
+ 38
624
+ 39</pre>
625
+ </td>
626
+ <td>
627
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 37</span>
628
+
629
+ <span class='def def kw'>def</span> <span class='message identifier id'>message</span>
630
+ <span class='meta identifier id'>meta</span><span class='lbrack token'>[</span><span class='symbol val'>:message</span><span class='rbrack token'>]</span>
631
+ <span class='end end kw'>end</span>
632
+ </pre>
633
+ </td>
634
+ </tr>
635
+ </table>
636
+ </div>
637
+
638
+ <div class="method_details ">
639
+ <p class="signature " id="status-instance_method">
640
+
641
+ - (<tt>Integer</tt>) <strong>status</strong>
642
+
643
+
644
+
645
+ </p><div class="docstring">
646
+ <div class="discussion">
647
+
648
+ <p>メタ情報中のstatusを返す</p>
649
+
650
+
651
+ </div>
652
+ </div>
653
+ <div class="tags">
654
+ <h3>Returns:</h3>
655
+ <ul class="return">
656
+
657
+ <li>
658
+
659
+
660
+ <span class='type'>(<tt>Integer</tt>)</span>
661
+
662
+
663
+
664
+ &mdash;
665
+ <div class='inline'>
666
+ <p>ステータス</p>
667
+ </div>
668
+
669
+ </li>
670
+
671
+ </ul>
672
+
673
+ </div><table class="source_code">
674
+ <tr>
675
+ <td>
676
+ <pre class="lines">
677
+
678
+
679
+ 31
680
+ 32
681
+ 33</pre>
682
+ </td>
683
+ <td>
684
+ <pre class="code"><span class="info file"># File 'lib/mushikago/http/response.rb', line 31</span>
685
+
686
+ <span class='def def kw'>def</span> <span class='status identifier id'>status</span>
687
+ <span class='meta identifier id'>meta</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span>
688
+ <span class='end end kw'>end</span>
689
+ </pre>
690
+ </td>
691
+ </tr>
692
+ </table>
693
+ </div>
694
+
695
+ </div>
696
+
697
+ </div>
698
+
699
+ <div id="footer">
700
+ Generated on Tue Sep 6 18:23:00 2011 by
701
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
702
+ 0.7.2 (ruby-1.8.7).
703
+ </div>
704
+
705
+ </body>
706
+ </html>