service_client 0.1.3 → 0.1.5
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/doc/ServiceClient/Base.html +781 -0
- data/doc/ServiceClient/Errors/BadGatewayError.html +159 -0
- data/doc/ServiceClient/Errors/BadRequestError.html +159 -0
- data/doc/ServiceClient/Errors/BaseError.html +359 -0
- data/doc/ServiceClient/Errors/BlockedByWindowsParentalControlsError.html +159 -0
- data/doc/ServiceClient/Errors/ClientClosedRequestError.html +159 -0
- data/doc/ServiceClient/Errors/ConflictError.html +159 -0
- data/doc/ServiceClient/Errors/EnhanceYourCalmError.html +159 -0
- data/doc/ServiceClient/Errors/ExpectationFailedError.html +159 -0
- data/doc/ServiceClient/Errors/FailedDependencyError.html +159 -0
- data/doc/ServiceClient/Errors/ForbiddenError.html +159 -0
- data/doc/ServiceClient/Errors/GatewayTimeoutError.html +159 -0
- data/doc/ServiceClient/Errors/GoneError.html +159 -0
- data/doc/ServiceClient/Errors/HTTPVersionNotSupportedError.html +159 -0
- data/doc/ServiceClient/Errors/InsufficientStorageError.html +159 -0
- data/doc/ServiceClient/Errors/InternalServerError.html +159 -0
- data/doc/ServiceClient/Errors/LengthRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/LockedError.html +159 -0
- data/doc/ServiceClient/Errors/LoopDetectedError.html +159 -0
- data/doc/ServiceClient/Errors/MethodNotAllowedError.html +159 -0
- data/doc/ServiceClient/Errors/NetworkAuthenticationRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/NetworkConnectTimeoutError.html +159 -0
- data/doc/ServiceClient/Errors/NetworkReadTimeoutError.html +159 -0
- data/doc/ServiceClient/Errors/NoResponseError.html +159 -0
- data/doc/ServiceClient/Errors/NotAcceptableError.html +159 -0
- data/doc/ServiceClient/Errors/NotExtendedError.html +159 -0
- data/doc/ServiceClient/Errors/NotFoundError.html +159 -0
- data/doc/ServiceClient/Errors/NotImplementedError.html +159 -0
- data/doc/ServiceClient/Errors/PaymentRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/PreconditionFailedError.html +159 -0
- data/doc/ServiceClient/Errors/PreconditionRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/ProxyAuthenticationRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/RequestEntityTooLargeError.html +159 -0
- data/doc/ServiceClient/Errors/RequestHeaderFieldsTooLargeError.html +159 -0
- data/doc/ServiceClient/Errors/RequestTimeoutError.html +159 -0
- data/doc/ServiceClient/Errors/RequestURITooLongError.html +159 -0
- data/doc/ServiceClient/Errors/RequestedRangeNotSatisfiableError.html +159 -0
- data/doc/ServiceClient/Errors/RetryWithError.html +159 -0
- data/doc/ServiceClient/Errors/ServiceUnavailableError.html +159 -0
- data/doc/ServiceClient/Errors/TooManyRequestsError.html +159 -0
- data/doc/ServiceClient/Errors/UnauthorizedError.html +159 -0
- data/doc/ServiceClient/Errors/UnavailableForLegalReasonsError.html +159 -0
- data/doc/ServiceClient/Errors/UnprocessableEntityError.html +159 -0
- data/doc/ServiceClient/Errors/UnsupportedMediaTypeError.html +159 -0
- data/doc/ServiceClient/Errors/UpgradeRequiredError.html +159 -0
- data/doc/ServiceClient/Errors/VariantAlsoNegotiatesError.html +159 -0
- data/doc/ServiceClient/Errors.html +325 -0
- data/doc/ServiceClient/ParamsRequired.html +135 -0
- data/doc/ServiceClient/Response.html +793 -0
- data/doc/ServiceClient.html +146 -0
- data/doc/_index.html +569 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +243 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +249 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +171 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/service_client/base.rb +79 -24
- data/lib/service_client/errors.rb +18 -6
- data/lib/service_client/response.rb +24 -7
- data/lib/service_client/version.rb +1 -1
- metadata +69 -4
|
@@ -0,0 +1,781 @@
|
|
|
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: ServiceClient::Base
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.28
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ServiceClient::Base";
|
|
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 (B)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../ServiceClient.html" title="ServiceClient (module)">ServiceClient</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Base</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: ServiceClient::Base
|
|
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">ServiceClient::Base</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/service_client/base.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>This class provides a lightweight and flexible way to make HTTP requests in Ruby projects.</p>
|
|
106
|
+
|
|
107
|
+
<p>This class can be used to make GET, POST, PUT, and DELETE requests to RESTful APIs. It simplifies the HTTP request process with a simple and intuitive API, configurable base URL, and default headers. It also provides a consistent and structured way to receive responses.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<h2>
|
|
124
|
+
Class Method Summary
|
|
125
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
126
|
+
</h2>
|
|
127
|
+
|
|
128
|
+
<ul class="summary">
|
|
129
|
+
|
|
130
|
+
<li class="public ">
|
|
131
|
+
<span class="summary_signature">
|
|
132
|
+
|
|
133
|
+
<a href="#base_url-class_method" title="base_url (class method)">.<strong>base_url</strong>(url = nil) ⇒ Object </a>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'>
|
|
148
|
+
<p>Sets the base URL to be used for all requests.</p>
|
|
149
|
+
</div></span>
|
|
150
|
+
|
|
151
|
+
</li>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<li class="public ">
|
|
155
|
+
<span class="summary_signature">
|
|
156
|
+
|
|
157
|
+
<a href="#default_headers-class_method" title="default_headers (class method)">.<strong>default_headers</strong>(headers = nil) ⇒ Object </a>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</span>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<span class="summary_desc"><div class='inline'>
|
|
172
|
+
<p>Sets the default headers to be sent with all requests.</p>
|
|
173
|
+
</div></span>
|
|
174
|
+
|
|
175
|
+
</li>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#delete-class_method" title="delete (class method)">.<strong>delete</strong>(url = nil, headers: nil) ⇒ Object </a>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</span>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<span class="summary_desc"><div class='inline'>
|
|
196
|
+
<p>Makes a DELETE request to the specified URL.</p>
|
|
197
|
+
</div></span>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#get-class_method" title="get (class method)">.<strong>get</strong>(url = nil, headers: nil) ⇒ Object </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
<p>Makes a GET request to the specified URL.</p>
|
|
221
|
+
</div></span>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<li class="public ">
|
|
227
|
+
<span class="summary_signature">
|
|
228
|
+
|
|
229
|
+
<a href="#post-class_method" title="post (class method)">.<strong>post</strong>(url = nil, headers: nil, body: nil) ⇒ Object </a>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
</span>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<span class="summary_desc"><div class='inline'>
|
|
244
|
+
<p>Makes a POST request to the specified URL.</p>
|
|
245
|
+
</div></span>
|
|
246
|
+
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<li class="public ">
|
|
251
|
+
<span class="summary_signature">
|
|
252
|
+
|
|
253
|
+
<a href="#put-class_method" title="put (class method)">.<strong>put</strong>(url = nil, headers: nil, body: nil) ⇒ Object </a>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class="summary_desc"><div class='inline'>
|
|
268
|
+
<p>Makes a PUT request to the specified URL.</p>
|
|
269
|
+
</div></span>
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</ul>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<div id="class_method_details" class="method_details_list">
|
|
280
|
+
<h2>Class Method Details</h2>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<div class="method_details first">
|
|
284
|
+
<h3 class="signature first" id="base_url-class_method">
|
|
285
|
+
|
|
286
|
+
.<strong>base_url</strong>(url = nil) ⇒ <tt>Object</tt>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</h3><div class="docstring">
|
|
293
|
+
<div class="discussion">
|
|
294
|
+
|
|
295
|
+
<p>Sets the base URL to be used for all requests.</p>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</div>
|
|
299
|
+
</div>
|
|
300
|
+
<div class="tags">
|
|
301
|
+
<p class="tag_title">Parameters:</p>
|
|
302
|
+
<ul class="param">
|
|
303
|
+
|
|
304
|
+
<li>
|
|
305
|
+
|
|
306
|
+
<span class='name'>url</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
—
|
|
316
|
+
<div class='inline'>
|
|
317
|
+
<p>the base URL to be used</p>
|
|
318
|
+
</div>
|
|
319
|
+
|
|
320
|
+
</li>
|
|
321
|
+
|
|
322
|
+
</ul>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</div><table class="source_code">
|
|
326
|
+
<tr>
|
|
327
|
+
<td>
|
|
328
|
+
<pre class="lines">
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
19
|
|
332
|
+
20
|
|
333
|
+
21</pre>
|
|
334
|
+
</td>
|
|
335
|
+
<td>
|
|
336
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 19</span>
|
|
337
|
+
|
|
338
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
339
|
+
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
|
|
340
|
+
<span class='kw'>end</span></pre>
|
|
341
|
+
</td>
|
|
342
|
+
</tr>
|
|
343
|
+
</table>
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
<div class="method_details ">
|
|
347
|
+
<h3 class="signature " id="default_headers-class_method">
|
|
348
|
+
|
|
349
|
+
.<strong>default_headers</strong>(headers = nil) ⇒ <tt>Object</tt>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</h3><div class="docstring">
|
|
356
|
+
<div class="discussion">
|
|
357
|
+
|
|
358
|
+
<p>Sets the default headers to be sent with all requests.</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'>headers</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
—
|
|
379
|
+
<div class='inline'>
|
|
380
|
+
<p>the default headers to be sent</p>
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
</li>
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
</div><table class="source_code">
|
|
389
|
+
<tr>
|
|
390
|
+
<td>
|
|
391
|
+
<pre class="lines">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
26
|
|
395
|
+
27
|
|
396
|
+
28</pre>
|
|
397
|
+
</td>
|
|
398
|
+
<td>
|
|
399
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 26</span>
|
|
400
|
+
|
|
401
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_default_headers'>default_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
402
|
+
<span class='ivar'>@default_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_headers'>headers</span>
|
|
403
|
+
<span class='kw'>end</span></pre>
|
|
404
|
+
</td>
|
|
405
|
+
</tr>
|
|
406
|
+
</table>
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
<div class="method_details ">
|
|
410
|
+
<h3 class="signature " id="delete-class_method">
|
|
411
|
+
|
|
412
|
+
.<strong>delete</strong>(url = nil, headers: nil) ⇒ <tt>Object</tt>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</h3><div class="docstring">
|
|
419
|
+
<div class="discussion">
|
|
420
|
+
|
|
421
|
+
<p>Makes a DELETE request to the specified URL.</p>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</div>
|
|
425
|
+
</div>
|
|
426
|
+
<div class="tags">
|
|
427
|
+
<p class="tag_title">Parameters:</p>
|
|
428
|
+
<ul class="param">
|
|
429
|
+
|
|
430
|
+
<li>
|
|
431
|
+
|
|
432
|
+
<span class='name'>url</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
—
|
|
442
|
+
<div class='inline'>
|
|
443
|
+
<p>the URL to make the request to</p>
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
<li>
|
|
449
|
+
|
|
450
|
+
<span class='name'>headers</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
—
|
|
460
|
+
<div class='inline'>
|
|
461
|
+
<p>additional headers to send with the request</p>
|
|
462
|
+
</div>
|
|
463
|
+
|
|
464
|
+
</li>
|
|
465
|
+
|
|
466
|
+
</ul>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div><table class="source_code">
|
|
470
|
+
<tr>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="lines">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
60
|
|
476
|
+
61
|
|
477
|
+
62</pre>
|
|
478
|
+
</td>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 60</span>
|
|
481
|
+
|
|
482
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
483
|
+
<span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
484
|
+
<span class='kw'>end</span></pre>
|
|
485
|
+
</td>
|
|
486
|
+
</tr>
|
|
487
|
+
</table>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
<div class="method_details ">
|
|
491
|
+
<h3 class="signature " id="get-class_method">
|
|
492
|
+
|
|
493
|
+
.<strong>get</strong>(url = nil, headers: nil) ⇒ <tt>Object</tt>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</h3><div class="docstring">
|
|
500
|
+
<div class="discussion">
|
|
501
|
+
|
|
502
|
+
<p>Makes a GET request to the specified URL.</p>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
</div>
|
|
506
|
+
</div>
|
|
507
|
+
<div class="tags">
|
|
508
|
+
<p class="tag_title">Parameters:</p>
|
|
509
|
+
<ul class="param">
|
|
510
|
+
|
|
511
|
+
<li>
|
|
512
|
+
|
|
513
|
+
<span class='name'>url</span>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
—
|
|
523
|
+
<div class='inline'>
|
|
524
|
+
<p>the URL to make the request to</p>
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
</li>
|
|
528
|
+
|
|
529
|
+
<li>
|
|
530
|
+
|
|
531
|
+
<span class='name'>headers</span>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
—
|
|
541
|
+
<div class='inline'>
|
|
542
|
+
<p>additional headers to send with the request</p>
|
|
543
|
+
</div>
|
|
544
|
+
|
|
545
|
+
</li>
|
|
546
|
+
|
|
547
|
+
</ul>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div><table class="source_code">
|
|
551
|
+
<tr>
|
|
552
|
+
<td>
|
|
553
|
+
<pre class="lines">
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
43
|
|
557
|
+
44
|
|
558
|
+
45</pre>
|
|
559
|
+
</td>
|
|
560
|
+
<td>
|
|
561
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 43</span>
|
|
562
|
+
|
|
563
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
564
|
+
<span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
565
|
+
<span class='kw'>end</span></pre>
|
|
566
|
+
</td>
|
|
567
|
+
</tr>
|
|
568
|
+
</table>
|
|
569
|
+
</div>
|
|
570
|
+
|
|
571
|
+
<div class="method_details ">
|
|
572
|
+
<h3 class="signature " id="post-class_method">
|
|
573
|
+
|
|
574
|
+
.<strong>post</strong>(url = nil, headers: nil, body: nil) ⇒ <tt>Object</tt>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
</h3><div class="docstring">
|
|
581
|
+
<div class="discussion">
|
|
582
|
+
|
|
583
|
+
<p>Makes a POST request to the specified URL.</p>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
</div>
|
|
587
|
+
</div>
|
|
588
|
+
<div class="tags">
|
|
589
|
+
<p class="tag_title">Parameters:</p>
|
|
590
|
+
<ul class="param">
|
|
591
|
+
|
|
592
|
+
<li>
|
|
593
|
+
|
|
594
|
+
<span class='name'>url</span>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
—
|
|
604
|
+
<div class='inline'>
|
|
605
|
+
<p>the URL to make the request to</p>
|
|
606
|
+
</div>
|
|
607
|
+
|
|
608
|
+
</li>
|
|
609
|
+
|
|
610
|
+
<li>
|
|
611
|
+
|
|
612
|
+
<span class='name'>headers</span>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
—
|
|
622
|
+
<div class='inline'>
|
|
623
|
+
<p>additional headers to send with the request</p>
|
|
624
|
+
</div>
|
|
625
|
+
|
|
626
|
+
</li>
|
|
627
|
+
|
|
628
|
+
<li>
|
|
629
|
+
|
|
630
|
+
<span class='name'>body</span>
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
—
|
|
640
|
+
<div class='inline'>
|
|
641
|
+
<p>the request body to send with the request</p>
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
</li>
|
|
645
|
+
|
|
646
|
+
</ul>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</div><table class="source_code">
|
|
650
|
+
<tr>
|
|
651
|
+
<td>
|
|
652
|
+
<pre class="lines">
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
35
|
|
656
|
+
36
|
|
657
|
+
37</pre>
|
|
658
|
+
</td>
|
|
659
|
+
<td>
|
|
660
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 35</span>
|
|
661
|
+
|
|
662
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
663
|
+
<span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
664
|
+
<span class='kw'>end</span></pre>
|
|
665
|
+
</td>
|
|
666
|
+
</tr>
|
|
667
|
+
</table>
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
<div class="method_details ">
|
|
671
|
+
<h3 class="signature " id="put-class_method">
|
|
672
|
+
|
|
673
|
+
.<strong>put</strong>(url = nil, headers: nil, body: nil) ⇒ <tt>Object</tt>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</h3><div class="docstring">
|
|
680
|
+
<div class="discussion">
|
|
681
|
+
|
|
682
|
+
<p>Makes a PUT request to the specified URL.</p>
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
</div>
|
|
686
|
+
</div>
|
|
687
|
+
<div class="tags">
|
|
688
|
+
<p class="tag_title">Parameters:</p>
|
|
689
|
+
<ul class="param">
|
|
690
|
+
|
|
691
|
+
<li>
|
|
692
|
+
|
|
693
|
+
<span class='name'>url</span>
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
—
|
|
703
|
+
<div class='inline'>
|
|
704
|
+
<p>the URL to make the request to</p>
|
|
705
|
+
</div>
|
|
706
|
+
|
|
707
|
+
</li>
|
|
708
|
+
|
|
709
|
+
<li>
|
|
710
|
+
|
|
711
|
+
<span class='name'>headers</span>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
—
|
|
721
|
+
<div class='inline'>
|
|
722
|
+
<p>additional headers to send with the request</p>
|
|
723
|
+
</div>
|
|
724
|
+
|
|
725
|
+
</li>
|
|
726
|
+
|
|
727
|
+
<li>
|
|
728
|
+
|
|
729
|
+
<span class='name'>body</span>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
—
|
|
739
|
+
<div class='inline'>
|
|
740
|
+
<p>the request body to send with the request</p>
|
|
741
|
+
</div>
|
|
742
|
+
|
|
743
|
+
</li>
|
|
744
|
+
|
|
745
|
+
</ul>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
</div><table class="source_code">
|
|
749
|
+
<tr>
|
|
750
|
+
<td>
|
|
751
|
+
<pre class="lines">
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
52
|
|
755
|
+
53
|
|
756
|
+
54</pre>
|
|
757
|
+
</td>
|
|
758
|
+
<td>
|
|
759
|
+
<pre class="code"><span class="info file"># File 'lib/service_client/base.rb', line 52</span>
|
|
760
|
+
|
|
761
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
762
|
+
<span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
763
|
+
<span class='kw'>end</span></pre>
|
|
764
|
+
</td>
|
|
765
|
+
</tr>
|
|
766
|
+
</table>
|
|
767
|
+
</div>
|
|
768
|
+
|
|
769
|
+
</div>
|
|
770
|
+
|
|
771
|
+
</div>
|
|
772
|
+
|
|
773
|
+
<div id="footer">
|
|
774
|
+
Generated on Thu Feb 23 08:25:38 2023 by
|
|
775
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
776
|
+
0.9.28 (ruby-2.7.1).
|
|
777
|
+
</div>
|
|
778
|
+
|
|
779
|
+
</div>
|
|
780
|
+
</body>
|
|
781
|
+
</html>
|