mushikago-sdk 0.1.6 → 0.1.7

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,287 @@
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::Tombo::Request
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="../Tombo.html" title="Mushikago::Tombo (module)">Tombo</a></span></span>
38
+ &raquo;
39
+ <span class="title">Request</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::Tombo::Request
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"><span class='object_link'><a href="../Http/Request.html" title="Mushikago::Http::Request (class)">Http::Request</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="../Http/Request.html" title="Mushikago::Http::Request (class)">Http::Request</a></span></li>
75
+
76
+ <li class="next">Mushikago::Tombo::Request</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+ <dt class="r2">Includes:</dt>
89
+ <dd class="r2"><span class='object_link'><a href="../Auth/Signature.html" title="Mushikago::Auth::Signature (module)">Auth::Signature</a></span></dd>
90
+
91
+
92
+
93
+
94
+
95
+ <dt class="r1 last">Defined in:</dt>
96
+ <dd class="r1 last">lib/mushikago/tombo/request.rb</dd>
97
+
98
+ </dl>
99
+ <div class="clear"></div>
100
+
101
+ <h2>Overview</h2><div class="docstring">
102
+ <div class="discussion">
103
+
104
+ <p>Tomboのリクエストを表す抽象クラス</p>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+ </div><div id="subclasses">
112
+ <h2>Direct Known Subclasses</h2>
113
+ <p class="children"><span class='object_link'><a href="CaptureRequest.html" title="Mushikago::Tombo::CaptureRequest (class)">CaptureRequest</a></span>, <span class='object_link'><a href="CapturesRequest.html" title="Mushikago::Tombo::CapturesRequest (class)">CapturesRequest</a></span>, <span class='object_link'><a href="DeleteRequest.html" title="Mushikago::Tombo::DeleteRequest (class)">DeleteRequest</a></span>, <span class='object_link'><a href="InfoRequest.html" title="Mushikago::Tombo::InfoRequest (class)">InfoRequest</a></span></p>
114
+ </div>
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <h2>Instance Attribute Summary</h2>
134
+
135
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Http/Request.html" title="Mushikago::Http::Request (class)">Http::Request</a></span></h3>
136
+ <p class="inherited"><span class='object_link'><a href="../Http/Request.html#headers-instance_method" title="Mushikago::Http::Request#headers (method)">headers</a></span>, <span class='object_link'><a href="../Http/Request.html#host-instance_method" title="Mushikago::Http::Request#host (method)">host</a></span>, <span class='object_link'><a href="../Http/Request.html#http_method-instance_method" title="Mushikago::Http::Request#http_method (method)">http_method</a></span>, <span class='object_link'><a href="../Http/Request.html#params-instance_method" title="Mushikago::Http::Request#params (method)">params</a></span>, <span class='object_link'><a href="../Http/Request.html#path-instance_method" title="Mushikago::Http::Request#path (method)">path</a></span>, <span class='object_link'><a href="../Http/Request.html#port-instance_method" title="Mushikago::Http::Request#port (method)">port</a></span></p>
137
+
138
+
139
+
140
+ <h2>
141
+ Instance Method Summary
142
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
143
+ </h2>
144
+
145
+ <ul class="summary">
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Request) <strong>initialize</strong>(options = {}) </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+ <span class="note title constructor">constructor</span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>A new instance of Request.</p>
167
+ </div></span>
168
+
169
+ </li>
170
+
171
+
172
+ </ul>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../Auth/Signature.html" title="Mushikago::Auth::Signature (module)">Auth::Signature</a></span></h3>
184
+ <p class="inherited"><span class='object_link'><a href="../Auth/Signature.html#add_signature%21-instance_method" title="Mushikago::Auth::Signature#add_signature! (method)">#add_signature!</a></span>, <span class='object_link'><a href="../Auth/Signature.html#string_to_sign-instance_method" title="Mushikago::Auth::Signature#string_to_sign (method)">#string_to_sign</a></span></p>
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Http/Request.html" title="Mushikago::Http::Request (class)">Http::Request</a></span></h3>
194
+ <p class="inherited"><span class='object_link'><a href="../Http/Request.html#add_param-class_method" title="Mushikago::Http::Request.add_param (method)">add_param</a></span>, <span class='object_link'><a href="../Http/Request.html#get_param-instance_method" title="Mushikago::Http::Request#get_param (method)">#get_param</a></span>, <span class='object_link'><a href="../Http/Request.html#set_param-instance_method" title="Mushikago::Http::Request#set_param (method)">#set_param</a></span>, <span class='object_link'><a href="../Http/Request.html#to_http_request-instance_method" title="Mushikago::Http::Request#to_http_request (method)">#to_http_request</a></span>, <span class='object_link'><a href="../Http/Request.html#url_encoded_params-instance_method" title="Mushikago::Http::Request#url_encoded_params (method)">#url_encoded_params</a></span></p>
195
+ <div id="constructor_details" class="method_details_list">
196
+ <h2>Constructor Details</h2>
197
+
198
+ <div class="method_details first">
199
+ <p class="signature first" id="initialize-instance_method">
200
+
201
+ - (<tt><span class='object_link'><a href="" title="Mushikago::Tombo::Request (class)">Request</a></span></tt>) <strong>initialize</strong>(options = {})
202
+
203
+
204
+
205
+ </p><div class="docstring">
206
+ <div class="discussion">
207
+
208
+ <p>A new instance of Request</p>
209
+
210
+
211
+ </div>
212
+ </div>
213
+ <div class="tags">
214
+ <h3>Parameters:</h3>
215
+ <ul class="param">
216
+
217
+ <li>
218
+
219
+ <span class='name'>options</span>
220
+
221
+
222
+ <span class='type'>(<tt>Hash</tt>)</span>
223
+
224
+
225
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
226
+
227
+
228
+ &mdash;
229
+ <div class='inline'>
230
+ <p>オプション</p>
231
+ </div>
232
+
233
+ </li>
234
+
235
+ </ul>
236
+
237
+
238
+
239
+
240
+ <h3>Options Hash (<tt>options</tt>):</h3>
241
+ <ul class="option">
242
+
243
+ <li>
244
+ <span class="name">:endpoint('tombo.mushikago.org')</span>
245
+ <span class="type">(<tt>String</tt>)</span>
246
+ <span class="default">
247
+
248
+ </span>
249
+ &mdash; <div class='inline'>
250
+ <p>Tomboのエンドポイント</p>
251
+ </div>
252
+ </tr>
253
+
254
+ </ul>
255
+
256
+
257
+ </div><table class="source_code">
258
+ <tr>
259
+ <td>
260
+ <pre class="lines">
261
+
262
+
263
+ 9</pre>
264
+ </td>
265
+ <td>
266
+ <pre class="code"><span class="info file"># File 'lib/mushikago/tombo/request.rb', line 9</span>
267
+
268
+ <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>
269
+ </pre>
270
+ </td>
271
+ </tr>
272
+ </table>
273
+ </div>
274
+
275
+ </div>
276
+
277
+
278
+ </div>
279
+
280
+ <div id="footer">
281
+ Generated on Tue Sep 6 18:23:01 2011 by
282
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
283
+ 0.7.2 (ruby-1.8.7).
284
+ </div>
285
+
286
+ </body>
287
+ </html>
data/doc/_index.html ADDED
@@ -0,0 +1,278 @@
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
+ Documentation by YARD 0.7.2
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ relpath = '';
17
+ if (relpath != '') relpath += '/';
18
+ </script>
19
+
20
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
23
+
24
+
25
+ </head>
26
+ <body>
27
+ <script type="text/javascript" charset="utf-8">
28
+ if (window.top.frames.main) document.body.className = 'frames';
29
+ </script>
30
+
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+
35
+ <span class="title"></span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a id="class_list_link" href="#">Class List</a>
44
+
45
+ <a id="method_list_link" href="#">Method List</a>
46
+
47
+ <a id="file_list_link" href="#">File List</a>
48
+
49
+ </div>
50
+ <div class="clear"></div>
51
+ </div>
52
+
53
+ <iframe id="search_frame"></iframe>
54
+
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.7.2</h1>
56
+ <div id="listing">
57
+ <h1 class="alphaindex">Alphabetic Index</h1>
58
+
59
+ <h2>File Listing</h2>
60
+ <ul id="files">
61
+
62
+
63
+ <li class="r1"><a href="index.html" title="README">README</a></li>
64
+
65
+
66
+ </ul>
67
+
68
+ <div class="clear"></div>
69
+ <h2>Namespace Listing A-Z</h2>
70
+
71
+
72
+
73
+
74
+ <table>
75
+ <tr>
76
+ <td valign='top' width="33%">
77
+
78
+
79
+ <ul id="alpha_A" class="alpha">
80
+ <li class="letter">A</li>
81
+ <ul>
82
+
83
+ <li>
84
+ <span class='object_link'><a href="Mushikago/Auth.html" title="Mushikago::Auth (module)">Auth</a></span>
85
+
86
+ <small>(Mushikago)</small>
87
+
88
+ </li>
89
+
90
+ </ul>
91
+ </ul>
92
+
93
+
94
+ <ul id="alpha_C" class="alpha">
95
+ <li class="letter">C</li>
96
+ <ul>
97
+
98
+ <li>
99
+ <span class='object_link'><a href="Mushikago/Tombo/CaptureRequest.html" title="Mushikago::Tombo::CaptureRequest (class)">CaptureRequest</a></span>
100
+
101
+ <small>(Mushikago::Tombo)</small>
102
+
103
+ </li>
104
+
105
+ <li>
106
+ <span class='object_link'><a href="Mushikago/Tombo/CapturesRequest.html" title="Mushikago::Tombo::CapturesRequest (class)">CapturesRequest</a></span>
107
+
108
+ <small>(Mushikago::Tombo)</small>
109
+
110
+ </li>
111
+
112
+ <li>
113
+ <span class='object_link'><a href="Mushikago/Http/Client.html" title="Mushikago::Http::Client (class)">Client</a></span>
114
+
115
+ <small>(Mushikago::Http)</small>
116
+
117
+ </li>
118
+
119
+ <li>
120
+ <span class='object_link'><a href="Mushikago/Tombo/Client.html" title="Mushikago::Tombo::Client (class)">Client</a></span>
121
+
122
+ <small>(Mushikago::Tombo)</small>
123
+
124
+ </li>
125
+
126
+ <li>
127
+ <span class='object_link'><a href="Mushikago/Config.html" title="Mushikago::Config (class)">Config</a></span>
128
+
129
+ <small>(Mushikago)</small>
130
+
131
+ </li>
132
+
133
+ </ul>
134
+ </ul>
135
+
136
+
137
+ <ul id="alpha_D" class="alpha">
138
+ <li class="letter">D</li>
139
+ <ul>
140
+
141
+ <li>
142
+ <span class='object_link'><a href="Mushikago/Tombo/DeleteRequest.html" title="Mushikago::Tombo::DeleteRequest (class)">DeleteRequest</a></span>
143
+
144
+ <small>(Mushikago::Tombo)</small>
145
+
146
+ </li>
147
+
148
+ </ul>
149
+ </ul>
150
+
151
+
152
+ <ul id="alpha_H" class="alpha">
153
+ <li class="letter">H</li>
154
+ <ul>
155
+
156
+ <li>
157
+ <span class='object_link'><a href="Mushikago/Http.html" title="Mushikago::Http (module)">Http</a></span>
158
+
159
+ <small>(Mushikago)</small>
160
+
161
+ </li>
162
+
163
+ </ul>
164
+ </ul>
165
+
166
+
167
+ <ul id="alpha_I" class="alpha">
168
+ <li class="letter">I</li>
169
+ <ul>
170
+
171
+ <li>
172
+ <span class='object_link'><a href="Mushikago/Tombo/InfoRequest.html" title="Mushikago::Tombo::InfoRequest (class)">InfoRequest</a></span>
173
+
174
+ <small>(Mushikago::Tombo)</small>
175
+
176
+ </li>
177
+
178
+ </ul>
179
+ </ul>
180
+
181
+
182
+ <ul id="alpha_M" class="alpha">
183
+ <li class="letter">M</li>
184
+ <ul>
185
+
186
+ <li>
187
+ <span class='object_link'><a href="Mushikago.html" title="Mushikago (module)">Mushikago</a></span>
188
+
189
+ </li>
190
+
191
+ </ul>
192
+ </ul>
193
+
194
+
195
+ <ul id="alpha_R" class="alpha">
196
+ <li class="letter">R</li>
197
+ <ul>
198
+
199
+ <li>
200
+ <span class='object_link'><a href="Mushikago/Http/Request.html" title="Mushikago::Http::Request (class)">Request</a></span>
201
+
202
+ <small>(Mushikago::Http)</small>
203
+
204
+ </li>
205
+
206
+ <li>
207
+ <span class='object_link'><a href="Mushikago/Tombo/Request.html" title="Mushikago::Tombo::Request (class)">Request</a></span>
208
+
209
+ <small>(Mushikago::Tombo)</small>
210
+
211
+ </li>
212
+
213
+ <li>
214
+ <span class='object_link'><a href="Mushikago/Http/Response.html" title="Mushikago::Http::Response (class)">Response</a></span>
215
+
216
+ <small>(Mushikago::Http)</small>
217
+
218
+ </li>
219
+
220
+ </ul>
221
+ </ul>
222
+
223
+
224
+ </td><td valign='top' width="33%">
225
+
226
+
227
+ <ul id="alpha_S" class="alpha">
228
+ <li class="letter">S</li>
229
+ <ul>
230
+
231
+ <li>
232
+ <span class='object_link'><a href="Mushikago/Auth/Signature.html" title="Mushikago::Auth::Signature (module)">Signature</a></span>
233
+
234
+ <small>(Mushikago::Auth)</small>
235
+
236
+ </li>
237
+
238
+ <li>
239
+ <span class='object_link'><a href="Mushikago/Auth/Signer.html" title="Mushikago::Auth::Signer (class)">Signer</a></span>
240
+
241
+ <small>(Mushikago::Auth)</small>
242
+
243
+ </li>
244
+
245
+ </ul>
246
+ </ul>
247
+
248
+
249
+ <ul id="alpha_T" class="alpha">
250
+ <li class="letter">T</li>
251
+ <ul>
252
+
253
+ <li>
254
+ <span class='object_link'><a href="Mushikago/Tombo.html" title="Mushikago::Tombo (module)">Tombo</a></span>
255
+
256
+ <small>(Mushikago)</small>
257
+
258
+ </li>
259
+
260
+ </ul>
261
+ </ul>
262
+
263
+ </td>
264
+ </tr>
265
+ </table>
266
+
267
+ </div>
268
+
269
+ </div>
270
+
271
+ <div id="footer">
272
+ Generated on Tue Sep 6 18:22:59 2011 by
273
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
274
+ 0.7.2 (ruby-1.8.7).
275
+ </div>
276
+
277
+ </body>
278
+ </html>