mushikago-sdk 0.2.3 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. data/README.md +9 -6
  2. data/autotest/discover.rb +1 -0
  3. data/doc/Mushikago.html +37 -21
  4. data/doc/Mushikago/Auth.html +8 -4
  5. data/doc/Mushikago/Auth/Signature.html +59 -32
  6. data/doc/Mushikago/Auth/Signer.html +81 -44
  7. data/doc/Mushikago/Config.html +41 -18
  8. data/doc/Mushikago/Hotaru.html +120 -0
  9. data/doc/Mushikago/Hotaru/Client.html +818 -0
  10. data/doc/Mushikago/Hotaru/Request.html +303 -0
  11. data/doc/Mushikago/Http.html +10 -6
  12. data/doc/Mushikago/Http/Client.html +107 -58
  13. data/doc/Mushikago/Http/MultipartRequest.html +366 -0
  14. data/doc/Mushikago/Http/Request.html +289 -167
  15. data/doc/Mushikago/Http/Response.html +153 -70
  16. data/doc/Mushikago/Mitsubachi.html +108 -0
  17. data/doc/Mushikago/Mitsubachi/Client.html +2923 -0
  18. data/doc/Mushikago/Mitsubachi/HttpFetchRequest.html +363 -0
  19. data/doc/Mushikago/Mitsubachi/HttpPushRequest.html +365 -0
  20. data/doc/Mushikago/Mitsubachi/MultipartRequest.html +332 -0
  21. data/doc/Mushikago/Mitsubachi/ProjectCreateRequest.html +361 -0
  22. data/doc/Mushikago/Mitsubachi/ProjectDeleteRequest.html +351 -0
  23. data/doc/Mushikago/Mitsubachi/ProjectDiscontinueRequest.html +349 -0
  24. data/doc/Mushikago/Mitsubachi/ProjectInfoRequest.html +302 -0
  25. data/doc/Mushikago/Mitsubachi/ProjectListRequest.html +304 -0
  26. data/doc/Mushikago/Mitsubachi/ProjectQueuesRequest.html +300 -0
  27. data/doc/Mushikago/Mitsubachi/ProjectUpdateRequest.html +359 -0
  28. data/doc/Mushikago/Mitsubachi/Request.html +307 -0
  29. data/doc/Mushikago/Mitsubachi/ResourceDeleteRequest.html +351 -0
  30. data/doc/Mushikago/Mitsubachi/ResourceGetRequest.html +302 -0
  31. data/doc/Mushikago/Mitsubachi/ResourceListRequest.html +306 -0
  32. data/doc/Mushikago/Mitsubachi/ResourceStoreRequest.html +390 -0
  33. data/doc/Mushikago/Mitsubachi/ScriptDeleteRequest.html +351 -0
  34. data/doc/Mushikago/Mitsubachi/ScriptDeployRequest.html +386 -0
  35. data/doc/Mushikago/Mitsubachi/ScriptGetRequest.html +302 -0
  36. data/doc/Mushikago/Mitsubachi/ScriptListRequest.html +306 -0
  37. data/doc/Mushikago/Tombo.html +8 -4
  38. data/doc/Mushikago/Tombo/CaptureRequest.html +90 -34
  39. data/doc/Mushikago/Tombo/CapturesRequest.html +68 -27
  40. data/doc/Mushikago/Tombo/Client.html +181 -75
  41. data/doc/Mushikago/Tombo/DeleteRequest.html +44 -24
  42. data/doc/Mushikago/Tombo/InfoRequest.html +32 -16
  43. data/doc/Mushikago/Tombo/Request.html +45 -15
  44. data/doc/_index.html +192 -9
  45. data/doc/class_list.html +1 -1
  46. data/doc/css/full_list.css +2 -0
  47. data/doc/css/style.css +12 -10
  48. data/doc/file.README.html +66 -60
  49. data/doc/frames.html +1 -1
  50. data/doc/index.html +66 -60
  51. data/doc/js/app.js +4 -4
  52. data/doc/js/full_list.js +23 -6
  53. data/doc/method_list.html +622 -62
  54. data/doc/top-level-namespace.html +3 -3
  55. data/lib/mushikago-sdk.rb +1 -0
  56. data/lib/mushikago.rb +3 -0
  57. data/lib/mushikago/auth.rb +1 -0
  58. data/lib/mushikago/auth/signature.rb +1 -0
  59. data/lib/mushikago/auth/signer.rb +1 -0
  60. data/lib/mushikago/configuration.rb +3 -2
  61. data/lib/mushikago/hotaru.rb +22 -0
  62. data/lib/mushikago/hotaru/client.rb +76 -0
  63. data/lib/mushikago/hotaru/request.rb +32 -0
  64. data/lib/mushikago/http.rb +2 -0
  65. data/lib/mushikago/http/client.rb +2 -1
  66. data/lib/mushikago/http/multipart_request.rb +62 -0
  67. data/lib/mushikago/http/request.rb +5 -2
  68. data/lib/mushikago/http/response.rb +1 -0
  69. data/lib/mushikago/mitsubachi.rb +33 -0
  70. data/lib/mushikago/mitsubachi/client.rb +256 -0
  71. data/lib/mushikago/mitsubachi/http_fetch_request.rb +33 -0
  72. data/lib/mushikago/mitsubachi/http_push_request.rb +36 -0
  73. data/lib/mushikago/mitsubachi/multipart_request.rb +33 -0
  74. data/lib/mushikago/mitsubachi/project_create_request.rb +32 -0
  75. data/lib/mushikago/mitsubachi/project_delete_request.rb +23 -0
  76. data/lib/mushikago/mitsubachi/project_discontinue_request.rb +22 -0
  77. data/lib/mushikago/mitsubachi/project_info_request.rb +17 -0
  78. data/lib/mushikago/mitsubachi/project_list_request.rb +21 -0
  79. data/lib/mushikago/mitsubachi/project_queues_request.rb +16 -0
  80. data/lib/mushikago/mitsubachi/project_update_request.rb +31 -0
  81. data/lib/mushikago/mitsubachi/request.rb +32 -0
  82. data/lib/mushikago/mitsubachi/resource_delete_request.rb +24 -0
  83. data/lib/mushikago/mitsubachi/resource_get_request.rb +19 -0
  84. data/lib/mushikago/mitsubachi/resource_list_request.rb +22 -0
  85. data/lib/mushikago/mitsubachi/resource_store_request.rb +33 -0
  86. data/lib/mushikago/mitsubachi/script_delete_request.rb +23 -0
  87. data/lib/mushikago/mitsubachi/script_deploy_request.rb +28 -0
  88. data/lib/mushikago/mitsubachi/script_get_request.rb +18 -0
  89. data/lib/mushikago/mitsubachi/script_list_request.rb +21 -0
  90. data/lib/mushikago/tombo.rb +1 -0
  91. data/lib/mushikago/tombo/capture_request.rb +2 -1
  92. data/lib/mushikago/tombo/captures_request.rb +2 -1
  93. data/lib/mushikago/tombo/client.rb +1 -0
  94. data/lib/mushikago/tombo/delete_request.rb +2 -1
  95. data/lib/mushikago/tombo/info_request.rb +2 -1
  96. data/lib/mushikago/tombo/request.rb +3 -2
  97. data/lib/mushikago/version.rb +2 -1
  98. data/spec/mushikago/auth/signature_spec.rb +1 -0
  99. data/spec/mushikago/auth/signer_spec.rb +1 -0
  100. data/spec/mushikago/configuration_spec.rb +7 -6
  101. data/spec/mushikago/http/client_spec.rb +3 -2
  102. data/spec/mushikago/http/request_spec.rb +3 -1
  103. data/spec/mushikago/http/response_spec.rb +1 -0
  104. data/spec/mushikago/tombo/capture_request_spec.rb +3 -2
  105. data/spec/mushikago/tombo/captures_request_spec.rb +3 -2
  106. data/spec/mushikago/tombo/client_spec.rb +91 -32
  107. data/spec/mushikago/tombo/delete_request_spec.rb +3 -2
  108. data/spec/mushikago/tombo/info_request_spec.rb +3 -2
  109. data/spec/mushikago/tombo/request_spec.rb +2 -1
  110. data/spec/spec_helper.rb +1 -0
  111. metadata +136 -115
data/README.md CHANGED
@@ -5,23 +5,25 @@ Mushikago SDK for Ruby.
5
5
  - **Author**: Toru Matsuoka
6
6
  - **Copyright**: 2011
7
7
  - **License**: Apache License, Version 2.0
8
- - **Latest Version**: 0.2.3
8
+ - **Latest Version**: 0.3.0
9
9
  - **Release Date**: September 13th 2011
10
10
 
11
11
 
12
12
  概要
13
13
  ----
14
14
 
15
- [株式会社マイニングブラウニー](http://www.miningbrownie.co.jp/)が提供するMushikago Webサービスを、Rubyから扱うためのライブラリです。
15
+ [株式会社マイニングブラウニー](http://www.miningbrownie.co.jp/)が提供する[mushikago Webサービス](http://www.mushikago.org/)を、Rubyから扱うためのライブラリです。
16
16
 
17
17
 
18
18
  機能一覧
19
19
  --------
20
20
 
21
- **1.Tomboを利用する**: [Tombo](http://www.tombo.ne.jp/)は、APIを通してWebサイトのキャプチャ画像を取得するサービスです。
21
+ **1.tomboを利用する**: [tombo](http://www.tombo.ne.jp/)は、APIを通してWebサイトのキャプチャ画像を取得するサービスです。
22
22
  キャプチャ画像にはタグをつけて管理することができます。
23
23
  キャプチャ画像は非同期で取得され、サーバの混雑具合によってリクエストから取得まで最大1時間の時間差があります。
24
24
 
25
+ **2.mitsubachiを利用する**: [mitsubachi](http://www.mushikago.org/mitsubachi/)はウェブサイトをクローリングするためのクラウドプラットフォームサービスです。
26
+ 環境構築などの準備を一切必要とせず、ユーザーは簡易なスクリプトをmitsubachiサーバにアップロード するだけで、ウェブ上の欲しい情報を高速に収集し保存します。ユーザーは、少しの技術力とアイデアを持っていれば、新たなクローラビジネスを始める事ができます。
25
27
 
26
28
 
27
29
  インストール方法
@@ -37,9 +39,9 @@ Mushikago SDK for Rubyはgemを使ってインストールします。
37
39
  使い方
38
40
  ------
39
41
 
40
- ### Tomboを利用する
42
+ ### tomboを利用する
41
43
 
42
- 以下のコードで[Tombo](http://www.tombo.ne.jp/)を利用することができます。
44
+ 以下のコードで[tombo](http://www.tombo.ne.jp/)を利用することができます。
43
45
 
44
46
  require 'rubygems'
45
47
  require 'mushikago'
@@ -118,6 +120,8 @@ $ export MUSHIKAGO_SECRET_KEY=<シークレットキー>
118
120
  変更履歴
119
121
  --------
120
122
 
123
+ - **Jan.26.12**: 0.3.0 release
124
+ - mitsubachiに対応
121
125
  - **Sep.13.11**: 0.2.3 release
122
126
  - captureメソッドのuseragentに対応
123
127
  - **Sep.8.11**: 0.2.1 release
@@ -126,4 +130,3 @@ $ export MUSHIKAGO_SECRET_KEY=<シークレットキー>
126
130
  - Mushikago SDK for Ruby新規作成
127
131
  - Tombo サポート
128
132
 
129
-
data/autotest/discover.rb CHANGED
@@ -1,3 +1,4 @@
1
+ # -*- coding: utf-8 -*-
1
2
  $:.unshift File.expand_path('../lib', __FILE__)
2
3
  require 'rubygems'
3
4
  require 'bundler'
data/doc/Mushikago.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Module: Mushikago
8
8
 
9
- &mdash; Documentation by YARD 0.7.2
9
+ &mdash; Documentation by YARD 0.7.4
10
10
 
11
11
  </title>
12
12
 
@@ -73,7 +73,7 @@
73
73
 
74
74
  <dt class="r1 last">Defined in:</dt>
75
75
  <dd class="r1 last">lib/mushikago.rb<span class="defines">,<br />
76
- lib/mushikago/auth.rb,<br /> lib/mushikago/http.rb,<br /> lib/mushikago/tombo.rb,<br /> lib/mushikago/version.rb,<br /> lib/mushikago/auth/signer.rb,<br /> lib/mushikago/http/client.rb,<br /> lib/mushikago/tombo/client.rb,<br /> lib/mushikago/http/request.rb,<br /> lib/mushikago/http/response.rb,<br /> lib/mushikago/tombo/request.rb,<br /> lib/mushikago/configuration.rb,<br /> lib/mushikago/auth/signature.rb,<br /> lib/mushikago/tombo/info_request.rb,<br /> lib/mushikago/tombo/delete_request.rb,<br /> lib/mushikago/tombo/capture_request.rb,<br /> lib/mushikago/tombo/captures_request.rb</span>
76
+ lib/mushikago/http.rb,<br /> lib/mushikago/auth.rb,<br /> lib/mushikago/tombo.rb,<br /> lib/mushikago/hotaru.rb,<br /> lib/mushikago/version.rb,<br /> lib/mushikago/mitsubachi.rb,<br /> lib/mushikago/auth/signer.rb,<br /> lib/mushikago/http/client.rb,<br /> lib/mushikago/http/request.rb,<br /> lib/mushikago/tombo/client.rb,<br /> lib/mushikago/http/response.rb,<br /> lib/mushikago/hotaru/client.rb,<br /> lib/mushikago/tombo/request.rb,<br /> lib/mushikago/configuration.rb,<br /> lib/mushikago/auth/signature.rb,<br /> lib/mushikago/hotaru/request.rb,<br /> lib/mushikago/mitsubachi/client.rb,<br /> lib/mushikago/mitsubachi/request.rb,<br /> lib/mushikago/tombo/info_request.rb,<br /> lib/mushikago/tombo/delete_request.rb,<br /> lib/mushikago/tombo/capture_request.rb,<br /> lib/mushikago/tombo/captures_request.rb,<br /> lib/mushikago/http/multipart_request.rb,<br /> lib/mushikago/mitsubachi/http_push_request.rb,<br /> lib/mushikago/mitsubachi/multipart_request.rb,<br /> lib/mushikago/mitsubachi/http_fetch_request.rb,<br /> lib/mushikago/mitsubachi/script_get_request.rb,<br /> lib/mushikago/mitsubachi/script_list_request.rb,<br /> lib/mushikago/mitsubachi/resource_get_request.rb,<br /> lib/mushikago/mitsubachi/project_list_request.rb,<br /> lib/mushikago/mitsubachi/project_info_request.rb,<br /> lib/mushikago/mitsubachi/script_deploy_request.rb,<br /> lib/mushikago/mitsubachi/script_delete_request.rb,<br /> lib/mushikago/mitsubachi/resource_list_request.rb,<br /> lib/mushikago/mitsubachi/project_update_request.rb,<br /> lib/mushikago/mitsubachi/project_delete_request.rb,<br /> lib/mushikago/mitsubachi/project_queues_request.rb,<br /> lib/mushikago/mitsubachi/project_create_request.rb,<br /> lib/mushikago/mitsubachi/resource_store_request.rb,<br /> lib/mushikago/mitsubachi/resource_delete_request.rb,<br /> lib/mushikago/mitsubachi/project_discontinue_request.rb</span>
77
77
  </dd>
78
78
 
79
79
  </dl>
@@ -81,17 +81,21 @@
81
81
 
82
82
  <h2>Overview</h2><div class="docstring">
83
83
  <div class="discussion">
84
- <p>Mushikagoサービスを提供するモジュール</p>
84
+ <p>
85
+ Mushikagoサービスを提供するモジュール
86
+ </p>
87
+
85
88
 
86
89
  </div>
87
90
  </div>
88
91
  <div class="tags">
89
92
 
93
+
90
94
  </div><h2>Defined Under Namespace</h2>
91
95
  <p class="children">
92
96
 
93
97
 
94
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mushikago/Auth.html" title="Mushikago::Auth (module)">Auth</a></span>, <span class='object_link'><a href="Mushikago/Http.html" title="Mushikago::Http (module)">Http</a></span>, <span class='object_link'><a href="Mushikago/Tombo.html" title="Mushikago::Tombo (module)">Tombo</a></span>
98
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mushikago/Auth.html" title="Mushikago::Auth (module)">Auth</a></span>, <span class='object_link'><a href="Mushikago/Hotaru.html" title="Mushikago::Hotaru (module)">Hotaru</a></span>, <span class='object_link'><a href="Mushikago/Http.html" title="Mushikago::Http (module)">Http</a></span>, <span class='object_link'><a href="Mushikago/Mitsubachi.html" title="Mushikago::Mitsubachi (module)">Mitsubachi</a></span>, <span class='object_link'><a href="Mushikago/Tombo.html" title="Mushikago::Tombo (module)">Tombo</a></span>
95
99
 
96
100
 
97
101
 
@@ -107,16 +111,19 @@
107
111
  <dt id="VERSION-constant" class="">VERSION =
108
112
  <div class="docstring">
109
113
  <div class="discussion">
110
- <p>Mushikago SDK for Ruby のバージョン</p>
114
+ <p>
115
+ Mushikago SDK for Ruby のバージョン
116
+ </p>
117
+
111
118
 
112
119
  </div>
113
120
  </div>
114
121
  <div class="tags">
115
122
 
123
+
116
124
  </div>
117
125
  </dt>
118
- <dd><pre class="code"><span class='string val'>'0.2.1'</span>
119
- </pre></dd>
126
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.3.1</span><span class='tstring_end'>'</span></span></pre></dd>
120
127
 
121
128
  </dl>
122
129
 
@@ -149,7 +156,10 @@
149
156
 
150
157
 
151
158
 
152
- <span class="summary_desc"><div class='inline'><p>Config コンフィグのインスタンスへのアクセスを提供する.</p></div></span>
159
+ <span class="summary_desc"><div class='inline'><p>
160
+ Config コンフィグのインスタンスへのアクセスを提供する.
161
+ </p>
162
+ </div></span>
153
163
 
154
164
  </li>
155
165
 
@@ -172,12 +182,16 @@
172
182
 
173
183
  </p><div class="docstring">
174
184
  <div class="discussion">
175
- <p>Config コンフィグのインスタンスへのアクセスを提供する</p>
185
+ <p>
186
+ Config コンフィグのインスタンスへのアクセスを提供する
187
+ </p>
188
+
176
189
 
177
190
  </div>
178
191
  </div>
179
192
  <div class="tags">
180
- <h3>Returns:</h3>
193
+
194
+ <h3>Returns:</h3>
181
195
  <ul class="return">
182
196
 
183
197
  <li>
@@ -188,7 +202,10 @@
188
202
 
189
203
 
190
204
  &mdash;
191
- <div class='inline'><p>config コンフィグのインスタンスへのアクセスを提供する</p></div>
205
+ <div class='inline'><p>
206
+ config コンフィグのインスタンスへのアクセスを提供する
207
+ </p>
208
+ </div>
192
209
 
193
210
  </li>
194
211
 
@@ -200,17 +217,16 @@
200
217
  <pre class="lines">
201
218
 
202
219
 
203
- 12
204
- 13
205
- 14</pre>
220
+ 15
221
+ 16
222
+ 17</pre>
206
223
  </td>
207
224
  <td>
208
- <pre class="code"><span class="info file"># File 'lib/mushikago.rb', line 12</span>
225
+ <pre class="code"><span class="info file"># File 'lib/mushikago.rb', line 15</span>
209
226
 
210
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='config identifier id'>config</span>
211
- <span class='Config constant id'>Config</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span>
212
- <span class='end end kw'>end</span>
213
- </pre>
227
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span>
228
+ <span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
229
+ <span class='kw'>end</span></pre>
214
230
  </td>
215
231
  </tr>
216
232
  </table>
@@ -221,9 +237,9 @@
221
237
  </div>
222
238
 
223
239
  <div id="footer">
224
- Generated on Thu Sep 8 10:06:59 2011 by
240
+ Generated on Thu Jan 26 17:19:02 2012 by
225
241
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
226
- 0.7.2 (ruby-1.8.7).
242
+ 0.7.4 (ruby-1.9.2).
227
243
  </div>
228
244
 
229
245
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Module: Mushikago::Auth
8
8
 
9
- &mdash; Documentation by YARD 0.7.2
9
+ &mdash; Documentation by YARD 0.7.4
10
10
 
11
11
  </title>
12
12
 
@@ -81,12 +81,16 @@
81
81
 
82
82
  <h2>Overview</h2><div class="docstring">
83
83
  <div class="discussion">
84
- <p>Mushikagoサービスの認証を扱うモジュール</p>
84
+ <p>
85
+ Mushikagoサービスの認証を扱うモジュール
86
+ </p>
87
+
85
88
 
86
89
  </div>
87
90
  </div>
88
91
  <div class="tags">
89
92
 
93
+
90
94
  </div><h2>Defined Under Namespace</h2>
91
95
  <p class="children">
92
96
 
@@ -109,9 +113,9 @@
109
113
  </div>
110
114
 
111
115
  <div id="footer">
112
- Generated on Thu Sep 8 10:07:00 2011 by
116
+ Generated on Thu Jan 26 17:19:02 2012 by
113
117
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
114
- 0.7.2 (ruby-1.8.7).
118
+ 0.7.4 (ruby-1.9.2).
115
119
  </div>
116
120
 
117
121
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Module: Mushikago::Auth::Signature
8
8
 
9
- &mdash; Documentation by YARD 0.7.2
9
+ &mdash; Documentation by YARD 0.7.4
10
10
 
11
11
  </title>
12
12
 
@@ -71,7 +71,7 @@
71
71
 
72
72
 
73
73
  <dt class="r1">Included in:</dt>
74
- <dd class="r1"><span class='object_link'><a href="../Tombo/Request.html" title="Mushikago::Tombo::Request (class)">Tombo::Request</a></span></dd>
74
+ <dd class="r1"><span class='object_link'><a href="../Hotaru/Request.html" title="Mushikago::Hotaru::Request (class)">Hotaru::Request</a></span>, <span class='object_link'><a href="../Mitsubachi/MultipartRequest.html" title="Mushikago::Mitsubachi::MultipartRequest (class)">Mitsubachi::MultipartRequest</a></span>, <span class='object_link'><a href="../Mitsubachi/Request.html" title="Mushikago::Mitsubachi::Request (class)">Mitsubachi::Request</a></span>, <span class='object_link'><a href="../Tombo/Request.html" title="Mushikago::Tombo::Request (class)">Tombo::Request</a></span></dd>
75
75
 
76
76
 
77
77
 
@@ -83,12 +83,16 @@
83
83
 
84
84
  <h2>Overview</h2><div class="docstring">
85
85
  <div class="discussion">
86
- <p>MushikagoのリクエストにMix-inして利用する</p>
86
+ <p>
87
+ MushikagoのリクエストにMix-inして利用する
88
+ </p>
89
+
87
90
 
88
91
  </div>
89
92
  </div>
90
93
  <div class="tags">
91
94
 
95
+
92
96
  </div>
93
97
 
94
98
 
@@ -118,7 +122,10 @@
118
122
 
119
123
 
120
124
 
121
- <span class="summary_desc"><div class='inline'><p>リクエストに署名を追加する.</p></div></span>
125
+ <span class="summary_desc"><div class='inline'><p>
126
+ リクエストに署名を追加する.
127
+ </p>
128
+ </div></span>
122
129
 
123
130
  </li>
124
131
 
@@ -139,7 +146,10 @@
139
146
 
140
147
 
141
148
 
142
- <span class="summary_desc"><div class='inline'><p>リクエストの情報から以下のような署名用文字列を作成する.</p></div></span>
149
+ <span class="summary_desc"><div class='inline'><p>
150
+ リクエストの情報から以下のような署名用文字列を作成する.
151
+ </p>
152
+ </div></span>
143
153
 
144
154
  </li>
145
155
 
@@ -162,7 +172,10 @@
162
172
 
163
173
  </p><div class="docstring">
164
174
  <div class="discussion">
165
- <p>リクエストに署名を追加する</p>
175
+ <p>
176
+ リクエストに署名を追加する
177
+ </p>
178
+
166
179
 
167
180
  </div>
168
181
  </div>
@@ -180,29 +193,32 @@
180
193
 
181
194
 
182
195
  &mdash;
183
- <div class='inline'><p>署名を作成するオブジェクト</p></div>
196
+ <div class='inline'><p>
197
+ 署名を作成するオブジェクト
198
+ </p>
199
+ </div>
184
200
 
185
201
  </li>
186
202
 
187
203
  </ul>
188
204
 
205
+
189
206
  </div><table class="source_code">
190
207
  <tr>
191
208
  <td>
192
209
  <pre class="lines">
193
210
 
194
211
 
195
- 22
196
212
  23
197
- 24</pre>
213
+ 24
214
+ 25</pre>
198
215
  </td>
199
216
  <td>
200
- <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signature.rb', line 22</span>
217
+ <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signature.rb', line 23</span>
201
218
 
202
- <span class='def def kw'>def</span> <span class='add_signature! fid id'>add_signature!</span> <span class='signer identifier id'>signer</span>
203
- <span class='set_param identifier id'>set_param</span><span class='lparen token'>(</span><span class='string val'>'signature'</span><span class='comma token'>,</span> <span class='signer identifier id'>signer</span><span class='dot token'>.</span><span class='sign identifier id'>sign</span><span class='lparen token'>(</span><span class='string_to_sign identifier id'>string_to_sign</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
204
- <span class='end end kw'>end</span>
205
- </pre>
219
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_signature!'>add_signature!</span> <span class='id identifier rubyid_signer'>signer</span>
220
+ <span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>signature</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_signer'>signer</span><span class='period'>.</span><span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='id identifier rubyid_string_to_sign'>string_to_sign</span><span class='rparen'>)</span>
221
+ <span class='kw'>end</span></pre>
206
222
  </td>
207
223
  </tr>
208
224
  </table>
@@ -217,12 +233,21 @@
217
233
 
218
234
  </p><div class="docstring">
219
235
  <div class="discussion">
220
- <p>リクエストの情報から以下のような署名用文字列を作成する GET localhost /1/info.json api_key=api_key&amp;timestamp=2011-09-01T00%3A00%3A00Z</p>
236
+ <p>
237
+ リクエストの情報から以下のような署名用文字列を作成する
238
+ </p>
239
+ <pre class="code">
240
+ GET
241
+ localhost
242
+ /1/info.json
243
+ api_key=api_key&amp;timestamp=2011-09-01T00%3A00%3A00Z</pre>
244
+
221
245
 
222
246
  </div>
223
247
  </div>
224
248
  <div class="tags">
225
- <h3>Returns:</h3>
249
+
250
+ <h3>Returns:</h3>
226
251
  <ul class="return">
227
252
 
228
253
  <li>
@@ -233,7 +258,10 @@
233
258
 
234
259
 
235
260
  &mdash;
236
- <div class='inline'><p>署名用の文字列</p></div>
261
+ <div class='inline'><p>
262
+ 署名用の文字列
263
+ </p>
264
+ </div>
237
265
 
238
266
  </li>
239
267
 
@@ -245,27 +273,26 @@
245
273
  <pre class="lines">
246
274
 
247
275
 
248
- 11
249
276
  12
250
277
  13
251
278
  14
252
279
  15
253
280
  16
254
281
  17
255
- 18</pre>
282
+ 18
283
+ 19</pre>
256
284
  </td>
257
285
  <td>
258
- <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signature.rb', line 11</span>
259
-
260
- <span class='def def kw'>def</span> <span class='string_to_sign identifier id'>string_to_sign</span>
261
- <span class='lbrack token'>[</span>
262
- <span class='http_method identifier id'>http_method</span><span class='comma token'>,</span>
263
- <span class='host identifier id'>host</span><span class='comma token'>,</span>
264
- <span class='path identifier id'>path</span><span class='comma token'>,</span>
265
- <span class='url_encoded_params identifier id'>url_encoded_params</span><span class='comma token'>,</span>
266
- <span class='rbrack token'>]</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>&quot;\n&quot;</span><span class='rparen token'>)</span>
267
- <span class='end end kw'>end</span>
268
- </pre>
286
+ <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signature.rb', line 12</span>
287
+
288
+ <span class='kw'>def</span> <span class='id identifier rubyid_string_to_sign'>string_to_sign</span>
289
+ <span class='lbracket'>[</span>
290
+ <span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span>
291
+ <span class='id identifier rubyid_host'>host</span><span class='comma'>,</span>
292
+ <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
293
+ <span class='id identifier rubyid_url_encoded_params'>url_encoded_params</span><span class='comma'>,</span>
294
+ <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
295
+ <span class='kw'>end</span></pre>
269
296
  </td>
270
297
  </tr>
271
298
  </table>
@@ -276,9 +303,9 @@
276
303
  </div>
277
304
 
278
305
  <div id="footer">
279
- Generated on Thu Sep 8 10:06:59 2011 by
306
+ Generated on Thu Jan 26 17:19:02 2012 by
280
307
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
281
- 0.7.2 (ruby-1.8.7).
308
+ 0.7.4 (ruby-1.9.2).
282
309
  </div>
283
310
 
284
311
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Mushikago::Auth::Signer
8
8
 
9
- &mdash; Documentation by YARD 0.7.2
9
+ &mdash; Documentation by YARD 0.7.4
10
10
 
11
11
  </title>
12
12
 
@@ -94,12 +94,16 @@
94
94
 
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
- <p>署名を作成するクラス</p>
97
+ <p>
98
+ 署名を作成するクラス
99
+ </p>
100
+
98
101
 
99
102
  </div>
100
103
  </div>
101
104
  <div class="tags">
102
105
 
106
+
103
107
  </div>
104
108
 
105
109
  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
@@ -124,7 +128,10 @@
124
128
 
125
129
 
126
130
 
127
- <span class="summary_desc"><div class='inline'><p>シークレットキー.</p></div></span>
131
+ <span class="summary_desc"><div class='inline'><p>
132
+ シークレットキー.
133
+ </p>
134
+ </div></span>
128
135
 
129
136
  </li>
130
137
 
@@ -160,7 +167,10 @@
160
167
 
161
168
 
162
169
 
163
- <span class="summary_desc"><div class='inline'><p>A new instance of Signer.</p></div></span>
170
+ <span class="summary_desc"><div class='inline'><p>
171
+ A new instance of Signer.
172
+ </p>
173
+ </div></span>
164
174
 
165
175
  </li>
166
176
 
@@ -181,7 +191,10 @@
181
191
 
182
192
 
183
193
 
184
- <span class="summary_desc"><div class='inline'><p>署名.</p></div></span>
194
+ <span class="summary_desc"><div class='inline'><p>
195
+ 署名.
196
+ </p>
197
+ </div></span>
185
198
 
186
199
  </li>
187
200
 
@@ -201,7 +214,10 @@
201
214
 
202
215
  </p><div class="docstring">
203
216
  <div class="discussion">
204
- <p>A new instance of Signer</p>
217
+ <p>
218
+ A new instance of Signer
219
+ </p>
220
+
205
221
 
206
222
  </div>
207
223
  </div>
@@ -219,29 +235,32 @@
219
235
 
220
236
 
221
237
  &mdash;
222
- <div class='inline'><p>シークレットキー</p></div>
238
+ <div class='inline'><p>
239
+ シークレットキー
240
+ </p>
241
+ </div>
223
242
 
224
243
  </li>
225
244
 
226
245
  </ul>
227
246
 
247
+
228
248
  </div><table class="source_code">
229
249
  <tr>
230
250
  <td>
231
251
  <pre class="lines">
232
252
 
233
253
 
234
- 12
235
254
  13
236
- 14</pre>
255
+ 14
256
+ 15</pre>
237
257
  </td>
238
258
  <td>
239
- <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 12</span>
259
+ <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 13</span>
240
260
 
241
- <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> <span class='secret_key identifier id'>secret_key</span>
242
- <span class='@secret_key ivar id'>@secret_key</span> <span class='assign token'>=</span> <span class='secret_key identifier id'>secret_key</span>
243
- <span class='end end kw'>end</span>
244
- </pre>
261
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_secret_key'>secret_key</span>
262
+ <span class='ivar'>@secret_key</span> <span class='op'>=</span> <span class='id identifier rubyid_secret_key'>secret_key</span>
263
+ <span class='kw'>end</span></pre>
245
264
  </td>
246
265
  </tr>
247
266
  </table>
@@ -264,12 +283,16 @@
264
283
 
265
284
  </p><div class="docstring">
266
285
  <div class="discussion">
267
- <p>シークレットキー</p>
286
+ <p>
287
+ シークレットキー
288
+ </p>
289
+
268
290
 
269
291
  </div>
270
292
  </div>
271
293
  <div class="tags">
272
- <h3>Returns:</h3>
294
+
295
+ <h3>Returns:</h3>
273
296
  <ul class="return">
274
297
 
275
298
  <li>
@@ -280,7 +303,10 @@
280
303
 
281
304
 
282
305
  &mdash;
283
- <div class='inline'><p>シークレットキー</p></div>
306
+ <div class='inline'><p>
307
+ シークレットキー
308
+ </p>
309
+ </div>
284
310
 
285
311
  </li>
286
312
 
@@ -292,17 +318,16 @@
292
318
  <pre class="lines">
293
319
 
294
320
 
295
- 9
296
321
  10
297
- 11</pre>
322
+ 11
323
+ 12</pre>
298
324
  </td>
299
325
  <td>
300
- <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 9</span>
326
+ <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 10</span>
301
327
 
302
- <span class='def def kw'>def</span> <span class='secret_key identifier id'>secret_key</span>
303
- <span class='@secret_key ivar id'>@secret_key</span>
304
- <span class='end end kw'>end</span>
305
- </pre>
328
+ <span class='kw'>def</span> <span class='id identifier rubyid_secret_key'>secret_key</span>
329
+ <span class='ivar'>@secret_key</span>
330
+ <span class='kw'>end</span></pre>
306
331
  </td>
307
332
  </tr>
308
333
  </table>
@@ -324,7 +349,10 @@
324
349
 
325
350
  </p><div class="docstring">
326
351
  <div class="discussion">
327
- <p>署名</p>
352
+ <p>
353
+ 署名
354
+ </p>
355
+
328
356
 
329
357
  </div>
330
358
  </div>
@@ -342,7 +370,10 @@
342
370
 
343
371
 
344
372
  &mdash;
345
- <div class='inline'><p>署名の元になる文字列</p></div>
373
+ <div class='inline'><p>
374
+ 署名の元になる文字列
375
+ </p>
376
+ </div>
346
377
 
347
378
  </li>
348
379
 
@@ -358,11 +389,15 @@
358
389
 
359
390
 
360
391
  &mdash;
361
- <div class='inline'><p>署名作成のアルゴリズム</p></div>
392
+ <div class='inline'><p>
393
+ 署名作成のアルゴリズム
394
+ </p>
395
+ </div>
362
396
 
363
397
  </li>
364
398
 
365
399
  </ul>
400
+
366
401
  <h3>Returns:</h3>
367
402
  <ul class="return">
368
403
 
@@ -374,7 +409,10 @@
374
409
 
375
410
 
376
411
  &mdash;
377
- <div class='inline'><p>署名</p></div>
412
+ <div class='inline'><p>
413
+ 署名
414
+ </p>
415
+ </div>
378
416
 
379
417
  </li>
380
418
 
@@ -386,7 +424,6 @@
386
424
  <pre class="lines">
387
425
 
388
426
 
389
- 19
390
427
  20
391
428
  21
392
429
  22
@@ -394,21 +431,21 @@
394
431
  24
395
432
  25
396
433
  26
397
- 27</pre>
434
+ 27
435
+ 28</pre>
398
436
  </td>
399
437
  <td>
400
- <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 19</span>
401
-
402
- <span class='def def kw'>def</span> <span class='sign identifier id'>sign</span><span class='lparen token'>(</span><span class='string_to_sign identifier id'>string_to_sign</span><span class='comma token'>,</span> <span class='digest_method identifier id'>digest_method</span><span class='assign token'>=</span><span class='string val'>'sha256'</span><span class='rparen token'>)</span>
403
- <span class='Base64 constant id'>Base64</span><span class='dot token'>.</span><span class='encode64 identifier id'>encode64</span><span class='lparen token'>(</span>
404
- <span class='OpenSSL constant id'>OpenSSL</span><span class='colon2 op'>::</span><span class='HMAC constant id'>HMAC</span><span class='dot token'>.</span><span class='digest identifier id'>digest</span><span class='lparen token'>(</span>
405
- <span class='OpenSSL constant id'>OpenSSL</span><span class='colon2 op'>::</span><span class='Digest constant id'>Digest</span><span class='colon2 op'>::</span><span class='Digest constant id'>Digest</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='digest_method identifier id'>digest_method</span><span class='rparen token'>)</span><span class='comma token'>,</span>
406
- <span class='secret_key identifier id'>secret_key</span><span class='comma token'>,</span>
407
- <span class='string_to_sign identifier id'>string_to_sign</span>
408
- <span class='rparen token'>)</span>
409
- <span class='rparen token'>)</span><span class='dot token'>.</span><span class='strip identifier id'>strip</span>
410
- <span class='end end kw'>end</span>
411
- </pre>
438
+ <pre class="code"><span class="info file"># File 'lib/mushikago/auth/signer.rb', line 20</span>
439
+
440
+ <span class='kw'>def</span> <span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='id identifier rubyid_string_to_sign'>string_to_sign</span><span class='comma'>,</span> <span class='id identifier rubyid_digest_method'>digest_method</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sha256</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
441
+ <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span>
442
+ <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_digest'>digest</span><span class='lparen'>(</span>
443
+ <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>Digest</span><span class='op'>::</span><span class='const'>Digest</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_digest_method'>digest_method</span><span class='rparen'>)</span><span class='comma'>,</span>
444
+ <span class='id identifier rubyid_secret_key'>secret_key</span><span class='comma'>,</span>
445
+ <span class='id identifier rubyid_string_to_sign'>string_to_sign</span>
446
+ <span class='rparen'>)</span>
447
+ <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
448
+ <span class='kw'>end</span></pre>
412
449
  </td>
413
450
  </tr>
414
451
  </table>
@@ -419,9 +456,9 @@
419
456
  </div>
420
457
 
421
458
  <div id="footer">
422
- Generated on Thu Sep 8 10:07:02 2011 by
459
+ Generated on Thu Jan 26 17:19:02 2012 by
423
460
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
424
- 0.7.2 (ruby-1.8.7).
461
+ 0.7.4 (ruby-1.9.2).
425
462
  </div>
426
463
 
427
464
  </body>