crapi 0.1.2 → 0.1.3
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +78 -10
- data/docs/Crapi.html +153 -0
- data/docs/Crapi/ArgumentError.html +143 -0
- data/docs/Crapi/BadHttpResponseError.html +143 -0
- data/docs/Crapi/Client.html +1401 -0
- data/docs/Crapi/Error.html +139 -0
- data/docs/Crapi/Proxy.html +941 -0
- data/docs/Net/HTTP.html +292 -0
- data/docs/_index.html +189 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +499 -0
- data/docs/file.README.html +191 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +191 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +187 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/crapi/client.rb +222 -3
- data/lib/crapi/errors.rb +6 -0
- data/lib/crapi/proxy.rb +79 -0
- data/lib/crapi/version.rb +9 -1
- metadata +23 -2
|
@@ -0,0 +1,139 @@
|
|
|
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
|
+
Exception: Crapi::Error
|
|
8
|
+
|
|
9
|
+
— 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 = "Crapi::Error";
|
|
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 (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Error</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>Exception: Crapi::Error
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">StandardError</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">StandardError</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Crapi::Error</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/crapi/errors.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>The base Error class for all <span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span>-related issues.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div><div id="subclasses">
|
|
116
|
+
<h2>Direct Known Subclasses</h2>
|
|
117
|
+
<p class="children"><span class='object_link'><a href="ArgumentError.html" title="Crapi::ArgumentError (class)">ArgumentError</a></span>, <span class='object_link'><a href="BadHttpResponseError.html" title="Crapi::BadHttpResponseError (class)">BadHttpResponseError</a></span></p>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
<div id="footer">
|
|
132
|
+
Generated on Wed May 30 11:27:03 2018 by
|
|
133
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
134
|
+
0.9.12 (ruby-2.5.1).
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
</body>
|
|
139
|
+
</html>
|
|
@@ -0,0 +1,941 @@
|
|
|
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: Crapi::Proxy
|
|
8
|
+
|
|
9
|
+
— 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 = "Crapi::Proxy";
|
|
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 (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Proxy</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: Crapi::Proxy
|
|
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">Crapi::Proxy</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/proxy.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Proxies simple CRUD methods (<span class='object_link'><a href="#delete-instance_method" title="Crapi::Proxy#delete (method)">#delete</a></span> / <span class='object_link'><a href="#get-instance_method" title="Crapi::Proxy#get (method)">#get</a></span> / <span class='object_link'><a href="#patch-instance_method" title="Crapi::Proxy#patch (method)">#patch</a></span> / <span class='object_link'><a href="#post-instance_method" title="Crapi::Proxy#post (method)">#post</a></span> /
|
|
106
|
+
<span class='object_link'><a href="#put-instance_method" title="Crapi::Proxy#put (method)">#put</a></span>) for a <span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span> or another <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span>. Like <span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span>, it also provides a proxy
|
|
107
|
+
generator.</p>
|
|
108
|
+
|
|
109
|
+
<p>A <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span> has its own set of default headers and has a
|
|
110
|
+
segment that is prepended to its CRUD methods' <em>path</em> before
|
|
111
|
+
being passed to the parent <span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span>/<span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span>. This makes the proxxy functionally equivalent to a new
|
|
112
|
+
<span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span> with a new base path (the parent's base
|
|
113
|
+
path plus the proxy's segment) and more default headers, but without
|
|
114
|
+
the need for a separate connection to the target system.</p>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
<div class="tags">
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
127
|
+
<ul class="summary">
|
|
128
|
+
|
|
129
|
+
<li class="public ">
|
|
130
|
+
<span class="summary_signature">
|
|
131
|
+
|
|
132
|
+
<a href="#default_headers-instance_method" title="#default_headers (instance method)">#<strong>default_headers</strong> ⇒ Object </a>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</span>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
|
150
|
+
<p>A Hash containing headers to send with every request (unless overriden
|
|
151
|
+
elsewhere).</p>
|
|
152
|
+
</div></span>
|
|
153
|
+
|
|
154
|
+
</li>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</ul>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<h2>
|
|
164
|
+
Instance Method Summary
|
|
165
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
166
|
+
</h2>
|
|
167
|
+
|
|
168
|
+
<ul class="summary">
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, headers: {}, query: {}) ⇒ Object </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>CRUD method: DELETE.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<li class="public ">
|
|
195
|
+
<span class="summary_signature">
|
|
196
|
+
|
|
197
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(path, headers: {}, query: {}) ⇒ Object </a>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<span class="summary_desc"><div class='inline'>
|
|
212
|
+
<p>CRUD method: GET.</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(add:, to:, headers: nil) ⇒ Proxy </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class="note title constructor">constructor</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<span class="summary_desc"><div class='inline'>
|
|
238
|
+
<p>A new instance of Proxy.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#new_proxy-instance_method" title="#new_proxy (instance method)">#<strong>new_proxy</strong>(segment = '/', headers: nil) ⇒ Crapi::Proxy </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="summary_desc"><div class='inline'>
|
|
262
|
+
<p>Returns a new <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span> for this proxy.</p>
|
|
263
|
+
</div></span>
|
|
264
|
+
|
|
265
|
+
</li>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<li class="public ">
|
|
269
|
+
<span class="summary_signature">
|
|
270
|
+
|
|
271
|
+
<a href="#patch-instance_method" title="#patch (instance method)">#<strong>patch</strong>(path, headers: {}, query: {}, payload: {}) ⇒ Object </a>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<span class="summary_desc"><div class='inline'>
|
|
286
|
+
<p>CRUD method: PATCH.</p>
|
|
287
|
+
</div></span>
|
|
288
|
+
|
|
289
|
+
</li>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<li class="public ">
|
|
293
|
+
<span class="summary_signature">
|
|
294
|
+
|
|
295
|
+
<a href="#post-instance_method" title="#post (instance method)">#<strong>post</strong>(path, headers: {}, query: {}, payload: {}) ⇒ Object </a>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
</span>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<span class="summary_desc"><div class='inline'>
|
|
310
|
+
<p>CRUD method: POST.</p>
|
|
311
|
+
</div></span>
|
|
312
|
+
|
|
313
|
+
</li>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<li class="public ">
|
|
317
|
+
<span class="summary_signature">
|
|
318
|
+
|
|
319
|
+
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, headers: {}, query: {}, payload: {}) ⇒ Object </a>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
</span>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<span class="summary_desc"><div class='inline'>
|
|
334
|
+
<p>CRUD method: PUT.</p>
|
|
335
|
+
</div></span>
|
|
336
|
+
|
|
337
|
+
</li>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</ul>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<div id="constructor_details" class="method_details_list">
|
|
344
|
+
<h2>Constructor Details</h2>
|
|
345
|
+
|
|
346
|
+
<div class="method_details first">
|
|
347
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
348
|
+
|
|
349
|
+
#<strong>initialize</strong>(add:, to:, headers: nil) ⇒ <tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Proxy</a></span></tt>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</h3><div class="docstring">
|
|
356
|
+
<div class="discussion">
|
|
357
|
+
|
|
358
|
+
<p>Returns a new instance of Proxy</p>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</div>
|
|
362
|
+
</div>
|
|
363
|
+
<div class="tags">
|
|
364
|
+
<p class="tag_title">Parameters:</p>
|
|
365
|
+
<ul class="param">
|
|
366
|
+
|
|
367
|
+
<li>
|
|
368
|
+
|
|
369
|
+
<span class='name'>add</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
—
|
|
377
|
+
<div class='inline'>
|
|
378
|
+
<p>The new base path. This path (added to the parent's base path) will be
|
|
379
|
+
used as the base path for the <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span>'s CRUD
|
|
380
|
+
methods.</p>
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
</li>
|
|
384
|
+
|
|
385
|
+
<li>
|
|
386
|
+
|
|
387
|
+
<span class='name'>to</span>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span></tt>, <tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span></tt>)</span>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
—
|
|
395
|
+
<div class='inline'>
|
|
396
|
+
<p>The parent <span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span> or <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span>
|
|
397
|
+
that we'll be delegating CRUD calls to after proprocessing of headers
|
|
398
|
+
and paths.</p>
|
|
399
|
+
</div>
|
|
400
|
+
|
|
401
|
+
</li>
|
|
402
|
+
|
|
403
|
+
<li>
|
|
404
|
+
|
|
405
|
+
<span class='name'>headers</span>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
—
|
|
413
|
+
<div class='inline'>
|
|
414
|
+
<p>The default headers to send with every request (unless overriden
|
|
415
|
+
elsewhere).</p>
|
|
416
|
+
</div>
|
|
417
|
+
|
|
418
|
+
</li>
|
|
419
|
+
|
|
420
|
+
</ul>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</div><table class="source_code">
|
|
424
|
+
<tr>
|
|
425
|
+
<td>
|
|
426
|
+
<pre class="lines">
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
37
|
|
430
|
+
38
|
|
431
|
+
39
|
|
432
|
+
40
|
|
433
|
+
41</pre>
|
|
434
|
+
</td>
|
|
435
|
+
<td>
|
|
436
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 37</span>
|
|
437
|
+
|
|
438
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>add:</span><span class='comma'>,</span> <span class='label'>to:</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
439
|
+
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_to'>to</span>
|
|
440
|
+
<span class='ivar'>@segment</span> <span class='op'>=</span> <span class='id identifier rubyid_add'>add</span>
|
|
441
|
+
<span class='ivar'>@default_headers</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with_indifferent_access'>with_indifferent_access</span>
|
|
442
|
+
<span class='kw'>end</span></pre>
|
|
443
|
+
</td>
|
|
444
|
+
</tr>
|
|
445
|
+
</table>
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
</div>
|
|
449
|
+
|
|
450
|
+
<div id="instance_attr_details" class="attr_details">
|
|
451
|
+
<h2>Instance Attribute Details</h2>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<span id="default_headers=-instance_method"></span>
|
|
455
|
+
<div class="method_details first">
|
|
456
|
+
<h3 class="signature first" id="default_headers-instance_method">
|
|
457
|
+
|
|
458
|
+
#<strong>default_headers</strong> ⇒ <tt>Object</tt>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</h3><div class="docstring">
|
|
465
|
+
<div class="discussion">
|
|
466
|
+
|
|
467
|
+
<p>A Hash containing headers to send with every request (unless overriden
|
|
468
|
+
elsewhere). In case of conflicts, headers set as default for a
|
|
469
|
+
<span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span> override those set by the parent. As in a
|
|
470
|
+
<span class='object_link'><a href="Client.html" title="Crapi::Client (class)">Crapi::Client</a></span>, headers set by the user via the CRUD
|
|
471
|
+
methods' <em>headers</em> still override any conflicting default
|
|
472
|
+
header.</p>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</div>
|
|
476
|
+
</div>
|
|
477
|
+
<div class="tags">
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<p class="tag_title">See Also:</p>
|
|
481
|
+
<ul class="see">
|
|
482
|
+
|
|
483
|
+
<li><span class='object_link'><a href="Client.html#default_headers-instance_method" title="Crapi::Client#default_headers (method)">Crapi::Client#default_headers</a></span></li>
|
|
484
|
+
|
|
485
|
+
</ul>
|
|
486
|
+
|
|
487
|
+
</div><table class="source_code">
|
|
488
|
+
<tr>
|
|
489
|
+
<td>
|
|
490
|
+
<pre class="lines">
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
24
|
|
494
|
+
25
|
|
495
|
+
26</pre>
|
|
496
|
+
</td>
|
|
497
|
+
<td>
|
|
498
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 24</span>
|
|
499
|
+
|
|
500
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_default_headers'>default_headers</span>
|
|
501
|
+
<span class='ivar'>@default_headers</span>
|
|
502
|
+
<span class='kw'>end</span></pre>
|
|
503
|
+
</td>
|
|
504
|
+
</tr>
|
|
505
|
+
</table>
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
</div>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
<div id="instance_method_details" class="method_details_list">
|
|
512
|
+
<h2>Instance Method Details</h2>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
<div class="method_details first">
|
|
516
|
+
<h3 class="signature first" id="delete-instance_method">
|
|
517
|
+
|
|
518
|
+
#<strong>delete</strong>(path, headers: {}, query: {}) ⇒ <tt>Object</tt>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
</h3><div class="docstring">
|
|
525
|
+
<div class="discussion">
|
|
526
|
+
|
|
527
|
+
<p>CRUD method: DELETE</p>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</div>
|
|
531
|
+
</div>
|
|
532
|
+
<div class="tags">
|
|
533
|
+
|
|
534
|
+
<p class="tag_title">Returns:</p>
|
|
535
|
+
<ul class="return">
|
|
536
|
+
|
|
537
|
+
<li>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
</li>
|
|
545
|
+
|
|
546
|
+
</ul>
|
|
547
|
+
|
|
548
|
+
<p class="tag_title">See Also:</p>
|
|
549
|
+
<ul class="see">
|
|
550
|
+
|
|
551
|
+
<li><span class='object_link'><a href="Client.html#delete-instance_method" title="Crapi::Client#delete (method)">Crapi::Client#delete</a></span></li>
|
|
552
|
+
|
|
553
|
+
</ul>
|
|
554
|
+
|
|
555
|
+
</div><table class="source_code">
|
|
556
|
+
<tr>
|
|
557
|
+
<td>
|
|
558
|
+
<pre class="lines">
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
70
|
|
562
|
+
71
|
|
563
|
+
72
|
|
564
|
+
73</pre>
|
|
565
|
+
</td>
|
|
566
|
+
<td>
|
|
567
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 70</span>
|
|
568
|
+
|
|
569
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
570
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@segment</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>/+</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
571
|
+
<span class='label'>headers:</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
|
572
|
+
<span class='kw'>end</span></pre>
|
|
573
|
+
</td>
|
|
574
|
+
</tr>
|
|
575
|
+
</table>
|
|
576
|
+
</div>
|
|
577
|
+
|
|
578
|
+
<div class="method_details ">
|
|
579
|
+
<h3 class="signature " id="get-instance_method">
|
|
580
|
+
|
|
581
|
+
#<strong>get</strong>(path, headers: {}, query: {}) ⇒ <tt>Object</tt>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
</h3><div class="docstring">
|
|
588
|
+
<div class="discussion">
|
|
589
|
+
|
|
590
|
+
<p>CRUD method: GET</p>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
</div>
|
|
594
|
+
</div>
|
|
595
|
+
<div class="tags">
|
|
596
|
+
|
|
597
|
+
<p class="tag_title">Returns:</p>
|
|
598
|
+
<ul class="return">
|
|
599
|
+
|
|
600
|
+
<li>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</li>
|
|
608
|
+
|
|
609
|
+
</ul>
|
|
610
|
+
|
|
611
|
+
<p class="tag_title">See Also:</p>
|
|
612
|
+
<ul class="see">
|
|
613
|
+
|
|
614
|
+
<li><span class='object_link'><a href="Client.html#get-instance_method" title="Crapi::Client#get (method)">Crapi::Client#get</a></span></li>
|
|
615
|
+
|
|
616
|
+
</ul>
|
|
617
|
+
|
|
618
|
+
</div><table class="source_code">
|
|
619
|
+
<tr>
|
|
620
|
+
<td>
|
|
621
|
+
<pre class="lines">
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
82
|
|
625
|
+
83
|
|
626
|
+
84
|
|
627
|
+
85</pre>
|
|
628
|
+
</td>
|
|
629
|
+
<td>
|
|
630
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 82</span>
|
|
631
|
+
|
|
632
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
633
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@segment</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>/+</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
634
|
+
<span class='label'>headers:</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
|
635
|
+
<span class='kw'>end</span></pre>
|
|
636
|
+
</td>
|
|
637
|
+
</tr>
|
|
638
|
+
</table>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
<div class="method_details ">
|
|
642
|
+
<h3 class="signature " id="new_proxy-instance_method">
|
|
643
|
+
|
|
644
|
+
#<strong>new_proxy</strong>(segment = '/', headers: nil) ⇒ <tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span></tt>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
</h3><div class="docstring">
|
|
651
|
+
<div class="discussion">
|
|
652
|
+
|
|
653
|
+
<p>Returns a new <span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span> for this proxy.</p>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</div>
|
|
657
|
+
</div>
|
|
658
|
+
<div class="tags">
|
|
659
|
+
<p class="tag_title">Parameters:</p>
|
|
660
|
+
<ul class="param">
|
|
661
|
+
|
|
662
|
+
<li>
|
|
663
|
+
|
|
664
|
+
<span class='name'>segment</span>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
<em class="default">(defaults to: <tt>'/'</tt>)</em>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
—
|
|
674
|
+
<div class='inline'>
|
|
675
|
+
<p>The segment to add to this proxy's path.</p>
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
</li>
|
|
679
|
+
|
|
680
|
+
<li>
|
|
681
|
+
|
|
682
|
+
<span class='name'>headers</span>
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
—
|
|
690
|
+
<div class='inline'>
|
|
691
|
+
<p>The default headers for the new proxy.</p>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
</ul>
|
|
697
|
+
|
|
698
|
+
<p class="tag_title">Returns:</p>
|
|
699
|
+
<ul class="return">
|
|
700
|
+
|
|
701
|
+
<li>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span></tt>)</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
</li>
|
|
709
|
+
|
|
710
|
+
</ul>
|
|
711
|
+
|
|
712
|
+
<p class="tag_title">See Also:</p>
|
|
713
|
+
<ul class="see">
|
|
714
|
+
|
|
715
|
+
<li><span class='object_link'><a href="Client.html#new_proxy-instance_method" title="Crapi::Client#new_proxy (method)">Crapi::Client#new_proxy</a></span></li>
|
|
716
|
+
|
|
717
|
+
</ul>
|
|
718
|
+
|
|
719
|
+
</div><table class="source_code">
|
|
720
|
+
<tr>
|
|
721
|
+
<td>
|
|
722
|
+
<pre class="lines">
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
57
|
|
726
|
+
58
|
|
727
|
+
59</pre>
|
|
728
|
+
</td>
|
|
729
|
+
<td>
|
|
730
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 57</span>
|
|
731
|
+
|
|
732
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new_proxy'>new_proxy</span><span class='lparen'>(</span><span class='id identifier rubyid_segment'>segment</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
733
|
+
<span class='const'><span class='object_link'><a href="" title="Crapi::Proxy (class)">Proxy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Crapi::Proxy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>add:</span> <span class='id identifier rubyid_segment'>segment</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
734
|
+
<span class='kw'>end</span></pre>
|
|
735
|
+
</td>
|
|
736
|
+
</tr>
|
|
737
|
+
</table>
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
<div class="method_details ">
|
|
741
|
+
<h3 class="signature " id="patch-instance_method">
|
|
742
|
+
|
|
743
|
+
#<strong>patch</strong>(path, headers: {}, query: {}, payload: {}) ⇒ <tt>Object</tt>
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
</h3><div class="docstring">
|
|
750
|
+
<div class="discussion">
|
|
751
|
+
|
|
752
|
+
<p>CRUD method: PATCH</p>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
</div>
|
|
756
|
+
</div>
|
|
757
|
+
<div class="tags">
|
|
758
|
+
|
|
759
|
+
<p class="tag_title">Returns:</p>
|
|
760
|
+
<ul class="return">
|
|
761
|
+
|
|
762
|
+
<li>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
</li>
|
|
770
|
+
|
|
771
|
+
</ul>
|
|
772
|
+
|
|
773
|
+
<p class="tag_title">See Also:</p>
|
|
774
|
+
<ul class="see">
|
|
775
|
+
|
|
776
|
+
<li><span class='object_link'><a href="Client.html#patch-instance_method" title="Crapi::Client#patch (method)">Crapi::Client#patch</a></span></li>
|
|
777
|
+
|
|
778
|
+
</ul>
|
|
779
|
+
|
|
780
|
+
</div><table class="source_code">
|
|
781
|
+
<tr>
|
|
782
|
+
<td>
|
|
783
|
+
<pre class="lines">
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
94
|
|
787
|
+
95
|
|
788
|
+
96
|
|
789
|
+
97</pre>
|
|
790
|
+
</td>
|
|
791
|
+
<td>
|
|
792
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 94</span>
|
|
793
|
+
|
|
794
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
795
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@segment</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>/+</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
796
|
+
<span class='label'>heades:</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
|
797
|
+
<span class='kw'>end</span></pre>
|
|
798
|
+
</td>
|
|
799
|
+
</tr>
|
|
800
|
+
</table>
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
<div class="method_details ">
|
|
804
|
+
<h3 class="signature " id="post-instance_method">
|
|
805
|
+
|
|
806
|
+
#<strong>post</strong>(path, headers: {}, query: {}, payload: {}) ⇒ <tt>Object</tt>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</h3><div class="docstring">
|
|
813
|
+
<div class="discussion">
|
|
814
|
+
|
|
815
|
+
<p>CRUD method: POST</p>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</div>
|
|
819
|
+
</div>
|
|
820
|
+
<div class="tags">
|
|
821
|
+
|
|
822
|
+
<p class="tag_title">Returns:</p>
|
|
823
|
+
<ul class="return">
|
|
824
|
+
|
|
825
|
+
<li>
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
</li>
|
|
833
|
+
|
|
834
|
+
</ul>
|
|
835
|
+
|
|
836
|
+
<p class="tag_title">See Also:</p>
|
|
837
|
+
<ul class="see">
|
|
838
|
+
|
|
839
|
+
<li><span class='object_link'><a href="Client.html#post-instance_method" title="Crapi::Client#post (method)">Crapi::Client#post</a></span></li>
|
|
840
|
+
|
|
841
|
+
</ul>
|
|
842
|
+
|
|
843
|
+
</div><table class="source_code">
|
|
844
|
+
<tr>
|
|
845
|
+
<td>
|
|
846
|
+
<pre class="lines">
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
106
|
|
850
|
+
107
|
|
851
|
+
108
|
|
852
|
+
109</pre>
|
|
853
|
+
</td>
|
|
854
|
+
<td>
|
|
855
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 106</span>
|
|
856
|
+
|
|
857
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
858
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@segment</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>/+</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
859
|
+
<span class='label'>headers:</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
|
860
|
+
<span class='kw'>end</span></pre>
|
|
861
|
+
</td>
|
|
862
|
+
</tr>
|
|
863
|
+
</table>
|
|
864
|
+
</div>
|
|
865
|
+
|
|
866
|
+
<div class="method_details ">
|
|
867
|
+
<h3 class="signature " id="put-instance_method">
|
|
868
|
+
|
|
869
|
+
#<strong>put</strong>(path, headers: {}, query: {}, payload: {}) ⇒ <tt>Object</tt>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
</h3><div class="docstring">
|
|
876
|
+
<div class="discussion">
|
|
877
|
+
|
|
878
|
+
<p>CRUD method: PUT</p>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</div>
|
|
882
|
+
</div>
|
|
883
|
+
<div class="tags">
|
|
884
|
+
|
|
885
|
+
<p class="tag_title">Returns:</p>
|
|
886
|
+
<ul class="return">
|
|
887
|
+
|
|
888
|
+
<li>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
</li>
|
|
896
|
+
|
|
897
|
+
</ul>
|
|
898
|
+
|
|
899
|
+
<p class="tag_title">See Also:</p>
|
|
900
|
+
<ul class="see">
|
|
901
|
+
|
|
902
|
+
<li><span class='object_link'><a href="Client.html#put-instance_method" title="Crapi::Client#put (method)">Crapi::Client#put</a></span></li>
|
|
903
|
+
|
|
904
|
+
</ul>
|
|
905
|
+
|
|
906
|
+
</div><table class="source_code">
|
|
907
|
+
<tr>
|
|
908
|
+
<td>
|
|
909
|
+
<pre class="lines">
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
118
|
|
913
|
+
119
|
|
914
|
+
120
|
|
915
|
+
121</pre>
|
|
916
|
+
</td>
|
|
917
|
+
<td>
|
|
918
|
+
<pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 118</span>
|
|
919
|
+
|
|
920
|
+
<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='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
921
|
+
<span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@segment</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>/+</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
922
|
+
<span class='label'>headers:</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
|
923
|
+
<span class='kw'>end</span></pre>
|
|
924
|
+
</td>
|
|
925
|
+
</tr>
|
|
926
|
+
</table>
|
|
927
|
+
</div>
|
|
928
|
+
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
</div>
|
|
932
|
+
|
|
933
|
+
<div id="footer">
|
|
934
|
+
Generated on Wed May 30 11:27:02 2018 by
|
|
935
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
936
|
+
0.9.12 (ruby-2.5.1).
|
|
937
|
+
</div>
|
|
938
|
+
|
|
939
|
+
</div>
|
|
940
|
+
</body>
|
|
941
|
+
</html>
|