crapi 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,292 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Net::HTTP
8
+
9
+ &mdash; Documentation by YARD 0.9.12
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Net::HTTP";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (H)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span> &raquo; <span class='title'>Net</span>
41
+ &raquo;
42
+ <span class="title">HTTP</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Net::HTTP
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Net::HTTP</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/crapi/client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Net::HTTP needs a shortcut instance method for PUT calls like it does for
106
+ GET/DELETE/PATCH/POST.</p>
107
+
108
+
109
+ </div>
110
+ </div>
111
+ <div class="tags">
112
+
113
+
114
+ </div>
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ <h2>
123
+ Instance Method Summary
124
+ <small><a href="#" class="summary_toggle">collapse</a></small>
125
+ </h2>
126
+
127
+ <ul class="summary">
128
+
129
+ <li class="public ">
130
+ <span class="summary_signature">
131
+
132
+ <a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, data, initheader = nil, dest = nil, &amp;block) &#x21d2; Net::HTTPResponse </a>
133
+
134
+
135
+
136
+ </span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'>
147
+ <p>Convenience PUT method monkey-patched into Net::HTTP.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ </ul>
154
+
155
+
156
+
157
+
158
+ <div id="instance_method_details" class="method_details_list">
159
+ <h2>Instance Method Details</h2>
160
+
161
+
162
+ <div class="method_details first">
163
+ <h3 class="signature first" id="put-instance_method">
164
+
165
+ #<strong>put</strong>(path, data, initheader = nil, dest = nil, &amp;block) &#x21d2; <tt>Net::HTTPResponse</tt>
166
+
167
+
168
+
169
+
170
+
171
+ </h3><div class="docstring">
172
+ <div class="discussion">
173
+
174
+ <p>Convenience PUT method monkey-patched into Net::HTTP.</p>
175
+
176
+ <p>Net::HTTP provides handy methods for DELETE, GET, HEAD, OPTIONS, PATCH, and
177
+ POST, <strong>but not PUT</strong>, so we have to monkey-patch one in. The
178
+ parameters listed below were chosen to match those in use for the other
179
+ Net::HTTP request methods in both name and meaning.</p>
180
+
181
+
182
+ </div>
183
+ </div>
184
+ <div class="tags">
185
+ <p class="tag_title">Parameters:</p>
186
+ <ul class="param">
187
+
188
+ <li>
189
+
190
+ <span class='name'>path</span>
191
+
192
+
193
+ <span class='type'>(<tt>String</tt>)</span>
194
+
195
+
196
+
197
+ </li>
198
+
199
+ <li>
200
+
201
+ <span class='name'>data</span>
202
+
203
+
204
+ <span class='type'>(<tt>String</tt>)</span>
205
+
206
+
207
+
208
+ </li>
209
+
210
+ <li>
211
+
212
+ <span class='name'>initheader</span>
213
+
214
+
215
+ <span class='type'>(<tt>Hash</tt>)</span>
216
+
217
+
218
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
219
+
220
+
221
+ </li>
222
+
223
+ <li>
224
+
225
+ <span class='name'>dest</span>
226
+
227
+
228
+ <span class='type'>(<tt>nil</tt>)</span>
229
+
230
+
231
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
232
+
233
+
234
+ </li>
235
+
236
+ </ul>
237
+
238
+ <p class="tag_title">Returns:</p>
239
+ <ul class="return">
240
+
241
+ <li>
242
+
243
+
244
+ <span class='type'>(<tt>Net::HTTPResponse</tt>)</span>
245
+
246
+
247
+
248
+ </li>
249
+
250
+ </ul>
251
+
252
+ <p class="tag_title">See Also:</p>
253
+ <ul class="see">
254
+
255
+ <li><a href="https://docs.ruby-lang.org/en/trunk/Net/HTTP.html" target="_parent" title="https://docs.ruby-lang.org/en/trunk/Net/HTTP.html">https://docs.ruby-lang.org/en/trunk/Net/HTTP.html</a></li>
256
+
257
+ </ul>
258
+
259
+ </div><table class="source_code">
260
+ <tr>
261
+ <td>
262
+ <pre class="lines">
263
+
264
+
265
+ 357
266
+ 358
267
+ 359</pre>
268
+ </td>
269
+ <td>
270
+ <pre class="code"><span class="info file"># File 'lib/crapi/client.rb', line 357</span>
271
+
272
+ <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_initheader'>initheader</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_dest'>dest</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
273
+ <span class='id identifier rubyid_send_entity'>send_entity</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_initheader'>initheader</span><span class='comma'>,</span> <span class='id identifier rubyid_dest'>dest</span><span class='comma'>,</span> <span class='const'>Put</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
274
+ <span class='kw'>end</span></pre>
275
+ </td>
276
+ </tr>
277
+ </table>
278
+ </div>
279
+
280
+ </div>
281
+
282
+ </div>
283
+
284
+ <div id="footer">
285
+ Generated on Wed May 30 11:27:03 2018 by
286
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
287
+ 0.9.12 (ruby-2.5.1).
288
+ </div>
289
+
290
+ </div>
291
+ </body>
292
+ </html>
@@ -0,0 +1,189 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Documentation by YARD 0.9.12
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ pathId = null;
17
+ relpath = '';
18
+ </script>
19
+
20
+
21
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
24
+
25
+
26
+ </head>
27
+ <body>
28
+ <div class="nav_wrap">
29
+ <iframe id="nav" src="class_list.html?1"></iframe>
30
+ <div id="resizer"></div>
31
+ </div>
32
+
33
+ <div id="main" tabindex="-1">
34
+ <div id="header">
35
+ <div id="menu">
36
+
37
+ </div>
38
+
39
+ <div id="search">
40
+
41
+ <a class="full_list_link" id="class_list_link"
42
+ href="class_list.html">
43
+
44
+ <svg width="24" height="24">
45
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
46
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
47
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
48
+ </svg>
49
+ </a>
50
+
51
+ </div>
52
+ <div class="clear"></div>
53
+ </div>
54
+
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.12</h1>
56
+ <div id="listing">
57
+ <h1 class="alphaindex">Alphabetic Index</h1>
58
+
59
+ <h2>File Listing</h2>
60
+ <ul id="files" class="index_inline_list">
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="Crapi/ArgumentError.html" title="Crapi::ArgumentError (class)">ArgumentError</a></span>
85
+
86
+ <small>(Crapi)</small>
87
+
88
+ </li>
89
+
90
+ </ul>
91
+ </ul>
92
+
93
+
94
+ <ul id="alpha_B" class="alpha">
95
+ <li class="letter">B</li>
96
+ <ul>
97
+
98
+ <li>
99
+ <span class='object_link'><a href="Crapi/BadHttpResponseError.html" title="Crapi::BadHttpResponseError (class)">BadHttpResponseError</a></span>
100
+
101
+ <small>(Crapi)</small>
102
+
103
+ </li>
104
+
105
+ </ul>
106
+ </ul>
107
+
108
+
109
+ <ul id="alpha_C" class="alpha">
110
+ <li class="letter">C</li>
111
+ <ul>
112
+
113
+ <li>
114
+ <span class='object_link'><a href="Crapi/Client.html" title="Crapi::Client (class)">Client</a></span>
115
+
116
+ <small>(Crapi)</small>
117
+
118
+ </li>
119
+
120
+ <li>
121
+ <span class='object_link'><a href="Crapi.html" title="Crapi (module)">Crapi</a></span>
122
+
123
+ </li>
124
+
125
+ </ul>
126
+ </ul>
127
+
128
+
129
+ <ul id="alpha_E" class="alpha">
130
+ <li class="letter">E</li>
131
+ <ul>
132
+
133
+ <li>
134
+ <span class='object_link'><a href="Crapi/Error.html" title="Crapi::Error (class)">Error</a></span>
135
+
136
+ <small>(Crapi)</small>
137
+
138
+ </li>
139
+
140
+ </ul>
141
+ </ul>
142
+
143
+
144
+ <ul id="alpha_H" class="alpha">
145
+ <li class="letter">H</li>
146
+ <ul>
147
+
148
+ <li>
149
+ <span class='object_link'><a href="Net/HTTP.html" title="Net::HTTP (class)">HTTP</a></span>
150
+
151
+ <small>(Net)</small>
152
+
153
+ </li>
154
+
155
+ </ul>
156
+ </ul>
157
+
158
+
159
+ <ul id="alpha_P" class="alpha">
160
+ <li class="letter">P</li>
161
+ <ul>
162
+
163
+ <li>
164
+ <span class='object_link'><a href="Crapi/Proxy.html" title="Crapi::Proxy (class)">Proxy</a></span>
165
+
166
+ <small>(Crapi)</small>
167
+
168
+ </li>
169
+
170
+ </ul>
171
+ </ul>
172
+
173
+ </td>
174
+ </tr>
175
+ </table>
176
+
177
+ </div>
178
+
179
+ </div>
180
+
181
+ <div id="footer">
182
+ Generated on Wed May 30 11:27:01 2018 by
183
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
184
+ 0.9.12 (ruby-2.5.1).
185
+ </div>
186
+
187
+ </div>
188
+ </body>
189
+ </html>