crapi 0.1.3 → 1.0.0

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.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +63 -0
  3. data/.rubocop.yml +53 -70
  4. data/.ruby-version +1 -1
  5. data/Gemfile.lock +66 -42
  6. data/README.md +29 -27
  7. data/crapi.gemspec +15 -15
  8. data/docs/{Crapi → CrAPI}/ArgumentError.html +15 -16
  9. data/docs/{Crapi → CrAPI}/BadHttpResponseError.html +15 -16
  10. data/docs/{Crapi → CrAPI}/Client.html +144 -174
  11. data/docs/{Crapi → CrAPI}/Error.html +14 -15
  12. data/docs/{Crapi → CrAPI}/Proxy.html +65 -89
  13. data/docs/CrAPI.html +157 -0
  14. data/docs/Net/HTTP.html +18 -23
  15. data/docs/_index.html +19 -19
  16. data/docs/class_list.html +3 -3
  17. data/docs/css/style.css +7 -9
  18. data/docs/file.README.html +68 -87
  19. data/docs/file_list.html +2 -2
  20. data/docs/frames.html +2 -2
  21. data/docs/index.html +68 -87
  22. data/docs/js/app.js +69 -3
  23. data/docs/method_list.html +34 -34
  24. data/docs/top-level-namespace.html +8 -8
  25. data/lib/crapi/client.rb +224 -228
  26. data/lib/crapi/errors.rb +7 -7
  27. data/lib/crapi/proxy.rb +82 -82
  28. data/lib/crapi/version.rb +10 -10
  29. data/lib/crapi.rb +3 -1
  30. data/spec/crapi_client_spec.rb +121 -0
  31. data/spec/crapi_errors_spec.rb +17 -0
  32. data/spec/crapi_proxy_spec.rb +121 -0
  33. data/spec/crapi_spec.rb +5 -0
  34. data/spec/spec_helper.rb +19 -0
  35. metadata +66 -52
  36. data/.travis.yml +0 -5
  37. data/docs/Crapi.html +0 -153
data/docs/{Crapi → CrAPI}/Error.html RENAMED
@@ -4,18 +4,18 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Exception: Crapi::Error
7
+ Exception: CrAPI::Error
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.28
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "Crapi::Error";
17
+ <script type="text/javascript">
18
+ pathId = "CrAPI::Error";
19
19
  relpath = '../';
20
20
  </script>
21
21
 
@@ -37,7 +37,7 @@
37
37
  <div id="menu">
38
38
 
39
39
  <a href="../_index.html">Index (E)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span>
40
+ <span class='title'><span class='object_link'><a href="../CrAPI.html" title="CrAPI (module)">CrAPI</a></span></span>
41
41
  &raquo;
42
42
  <span class="title">Error</span>
43
43
 
@@ -59,7 +59,7 @@
59
59
  <div class="clear"></div>
60
60
  </div>
61
61
 
62
- <div id="content"><h1>Exception: Crapi::Error
62
+ <div id="content"><h1>Exception: CrAPI::Error
63
63
 
64
64
 
65
65
 
@@ -76,7 +76,7 @@
76
76
 
77
77
  <li class="next">StandardError</li>
78
78
 
79
- <li class="next">Crapi::Error</li>
79
+ <li class="next">CrAPI::Error</li>
80
80
 
81
81
  </ul>
82
82
  <a href="#" class="inheritanceTree">show all</a>
@@ -103,8 +103,7 @@
103
103
 
104
104
  <h2>Overview</h2><div class="docstring">
105
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>
106
+ <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
107
 
109
108
 
110
109
  </div>
@@ -114,7 +113,7 @@
114
113
 
115
114
  </div><div id="subclasses">
116
115
  <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>
116
+ <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
117
  </div>
119
118
 
120
119
 
@@ -129,9 +128,9 @@
129
128
  </div>
130
129
 
131
130
  <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).
131
+ Generated on Mon Jan 2 15:16:45 2023 by
132
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
133
+ 0.9.28 (ruby-3.0.4).
135
134
  </div>
136
135
 
137
136
  </div>
data/docs/{Crapi → CrAPI}/Proxy.html RENAMED
@@ -4,18 +4,18 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Class: Crapi::Proxy
7
+ Class: CrAPI::Proxy
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.28
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "Crapi::Proxy";
17
+ <script type="text/javascript">
18
+ pathId = "CrAPI::Proxy";
19
19
  relpath = '../';
20
20
  </script>
21
21
 
@@ -37,7 +37,7 @@
37
37
  <div id="menu">
38
38
 
39
39
  <a href="../_index.html">Index (P)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Crapi.html" title="Crapi (module)">Crapi</a></span></span>
40
+ <span class='title'><span class='object_link'><a href="../CrAPI.html" title="CrAPI (module)">CrAPI</a></span></span>
41
41
  &raquo;
42
42
  <span class="title">Proxy</span>
43
43
 
@@ -59,7 +59,7 @@
59
59
  <div class="clear"></div>
60
60
  </div>
61
61
 
62
- <div id="content"><h1>Class: Crapi::Proxy
62
+ <div id="content"><h1>Class: CrAPI::Proxy
63
63
 
64
64
 
65
65
 
@@ -74,7 +74,7 @@
74
74
  <ul class="fullTree">
75
75
  <li>Object</li>
76
76
 
77
- <li class="next">Crapi::Proxy</li>
77
+ <li class="next">CrAPI::Proxy</li>
78
78
 
79
79
  </ul>
80
80
  <a href="#" class="inheritanceTree">show all</a>
@@ -101,17 +101,16 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
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>
104
+ <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> / <span class='object_link'><a href="#put-instance_method" title="CrAPI::Proxy#put (method)">#put</a></span>) for a
105
+ <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
106
+ <span class='object_link'><a href="Client.html" title="CrAPI::Client (class)">CrAPI::Client</a></span>, it also provides a proxy generator.</p>
108
107
 
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&#39; <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&#39;s base
113
- path plus the proxy&#39;s segment) and more default headers, but without
114
- the need for a separate connection to the target system.</p>
108
+ <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 segment that is
109
+ prepended to its CRUD methods’ <em>path</em> before being passed to the parent
110
+ <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
111
+ equivalent to a new <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 path
112
+ plus the proxy’s segment) and more default headers, but without the need for a separate
113
+ connection to the target system.</p>
115
114
 
116
115
 
117
116
  </div>
@@ -146,9 +145,7 @@ the need for a separate connection to the target system.</p>
146
145
 
147
146
 
148
147
 
149
- <span class="summary_desc"><div class='inline'>
150
- <p>A Hash containing headers to send with every request (unless overriden
151
- elsewhere).</p>
148
+ <span class="summary_desc"><div class='inline'><p>A Hash containing headers to send with every request (unless overriden elsewhere).</p>
152
149
  </div></span>
153
150
 
154
151
  </li>
@@ -184,8 +181,7 @@ elsewhere).</p>
184
181
 
185
182
 
186
183
 
187
- <span class="summary_desc"><div class='inline'>
188
- <p>CRUD method: DELETE.</p>
184
+ <span class="summary_desc"><div class='inline'><p>CRUD method: DELETE.</p>
189
185
  </div></span>
190
186
 
191
187
  </li>
@@ -208,8 +204,7 @@ elsewhere).</p>
208
204
 
209
205
 
210
206
 
211
- <span class="summary_desc"><div class='inline'>
212
- <p>CRUD method: GET.</p>
207
+ <span class="summary_desc"><div class='inline'><p>CRUD method: GET.</p>
213
208
  </div></span>
214
209
 
215
210
  </li>
@@ -234,8 +229,7 @@ elsewhere).</p>
234
229
 
235
230
 
236
231
 
237
- <span class="summary_desc"><div class='inline'>
238
- <p>A new instance of Proxy.</p>
232
+ <span class="summary_desc"><div class='inline'><p>A new instance of Proxy.</p>
239
233
  </div></span>
240
234
 
241
235
  </li>
@@ -244,7 +238,7 @@ elsewhere).</p>
244
238
  <li class="public ">
245
239
  <span class="summary_signature">
246
240
 
247
- <a href="#new_proxy-instance_method" title="#new_proxy (instance method)">#<strong>new_proxy</strong>(segment = &#39;/&#39;, headers: nil) &#x21d2; Crapi::Proxy </a>
241
+ <a href="#new_proxy-instance_method" title="#new_proxy (instance method)">#<strong>new_proxy</strong>(segment = &#39;/&#39;, headers: nil) &#x21d2; CrAPI::Proxy </a>
248
242
 
249
243
 
250
244
 
@@ -258,8 +252,7 @@ elsewhere).</p>
258
252
 
259
253
 
260
254
 
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>
255
+ <span class="summary_desc"><div class='inline'><p>Returns a new <span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span> for this proxy.</p>
263
256
  </div></span>
264
257
 
265
258
  </li>
@@ -282,8 +275,7 @@ elsewhere).</p>
282
275
 
283
276
 
284
277
 
285
- <span class="summary_desc"><div class='inline'>
286
- <p>CRUD method: PATCH.</p>
278
+ <span class="summary_desc"><div class='inline'><p>CRUD method: PATCH.</p>
287
279
  </div></span>
288
280
 
289
281
  </li>
@@ -306,8 +298,7 @@ elsewhere).</p>
306
298
 
307
299
 
308
300
 
309
- <span class="summary_desc"><div class='inline'>
310
- <p>CRUD method: POST.</p>
301
+ <span class="summary_desc"><div class='inline'><p>CRUD method: POST.</p>
311
302
  </div></span>
312
303
 
313
304
  </li>
@@ -330,8 +321,7 @@ elsewhere).</p>
330
321
 
331
322
 
332
323
 
333
- <span class="summary_desc"><div class='inline'>
334
- <p>CRUD method: PUT.</p>
324
+ <span class="summary_desc"><div class='inline'><p>CRUD method: PUT.</p>
335
325
  </div></span>
336
326
 
337
327
  </li>
@@ -346,7 +336,7 @@ elsewhere).</p>
346
336
  <div class="method_details first">
347
337
  <h3 class="signature first" id="initialize-instance_method">
348
338
 
349
- #<strong>initialize</strong>(add:, to:, headers: nil) &#x21d2; <tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Proxy</a></span></tt>
339
+ #<strong>initialize</strong>(add:, to:, headers: nil) &#x21d2; <tt><span class='object_link'><a href="" title="CrAPI::Proxy (class)">Proxy</a></span></tt>
350
340
 
351
341
 
352
342
 
@@ -354,8 +344,7 @@ elsewhere).</p>
354
344
 
355
345
  </h3><div class="docstring">
356
346
  <div class="discussion">
357
-
358
- <p>Returns a new instance of Proxy</p>
347
+ <p>Returns a new instance of Proxy.</p>
359
348
 
360
349
 
361
350
  </div>
@@ -374,10 +363,8 @@ elsewhere).</p>
374
363
 
375
364
 
376
365
  &mdash;
377
- <div class='inline'>
378
- <p>The new base path. This path (added to the parent&#39;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>&#39;s CRUD
380
- methods.</p>
366
+ <div class='inline'><p>The new base path. This path (added to the parent’s base path) will be used as the base
367
+ path for the <span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span>’s CRUD methods.</p>
381
368
  </div>
382
369
 
383
370
  </li>
@@ -387,15 +374,13 @@ methods.</p>
387
374
  <span class='name'>to</span>
388
375
 
389
376
 
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>
377
+ <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
378
 
392
379
 
393
380
 
394
381
  &mdash;
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&#39;ll be delegating CRUD calls to after proprocessing of headers
398
- and paths.</p>
382
+ <div class='inline'><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> that we’ll be
383
+ delegating CRUD calls to after proprocessing of headers and paths.</p>
399
384
  </div>
400
385
 
401
386
  </li>
@@ -408,11 +393,11 @@ and paths.</p>
408
393
  <span class='type'>(<tt>Hash</tt>)</span>
409
394
 
410
395
 
396
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
397
+
411
398
 
412
399
  &mdash;
413
- <div class='inline'>
414
- <p>The default headers to send with every request (unless overriden
415
- elsewhere).</p>
400
+ <div class='inline'><p>The default headers to send with every request (unless overriden elsewhere).</p>
416
401
  </div>
417
402
 
418
403
  </li>
@@ -463,13 +448,10 @@ elsewhere).</p>
463
448
 
464
449
  </h3><div class="docstring">
465
450
  <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&#39; <em>headers</em> still override any conflicting default
472
- header.</p>
451
+ <p>A Hash containing headers to send with every request (unless overriden elsewhere). In case of
452
+ conflicts, headers set as default for a <span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span> override those set by the
453
+ parent. As in a <span class='object_link'><a href="Client.html" title="CrAPI::Client (class)">CrAPI::Client</a></span>, headers set by the user via the CRUD methods’
454
+ <em>headers</em> still override any conflicting default header.</p>
473
455
 
474
456
 
475
457
  </div>
@@ -480,7 +462,7 @@ header.</p>
480
462
  <p class="tag_title">See Also:</p>
481
463
  <ul class="see">
482
464
 
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>
465
+ <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
466
 
485
467
  </ul>
486
468
 
@@ -523,8 +505,7 @@ header.</p>
523
505
 
524
506
  </h3><div class="docstring">
525
507
  <div class="discussion">
526
-
527
- <p>CRUD method: DELETE</p>
508
+ <p>CRUD method: DELETE</p>
528
509
 
529
510
 
530
511
  </div>
@@ -548,7 +529,7 @@ header.</p>
548
529
  <p class="tag_title">See Also:</p>
549
530
  <ul class="see">
550
531
 
551
- <li><span class='object_link'><a href="Client.html#delete-instance_method" title="Crapi::Client#delete (method)">Crapi::Client#delete</a></span></li>
532
+ <li><span class='object_link'><a href="Client.html#delete-instance_method" title="CrAPI::Client#delete (method)">CrAPI::Client#delete</a></span></li>
552
533
 
553
534
  </ul>
554
535
 
@@ -586,8 +567,7 @@ header.</p>
586
567
 
587
568
  </h3><div class="docstring">
588
569
  <div class="discussion">
589
-
590
- <p>CRUD method: GET</p>
570
+ <p>CRUD method: GET</p>
591
571
 
592
572
 
593
573
  </div>
@@ -611,7 +591,7 @@ header.</p>
611
591
  <p class="tag_title">See Also:</p>
612
592
  <ul class="see">
613
593
 
614
- <li><span class='object_link'><a href="Client.html#get-instance_method" title="Crapi::Client#get (method)">Crapi::Client#get</a></span></li>
594
+ <li><span class='object_link'><a href="Client.html#get-instance_method" title="CrAPI::Client#get (method)">CrAPI::Client#get</a></span></li>
615
595
 
616
596
  </ul>
617
597
 
@@ -641,7 +621,7 @@ header.</p>
641
621
  <div class="method_details ">
642
622
  <h3 class="signature " id="new_proxy-instance_method">
643
623
 
644
- #<strong>new_proxy</strong>(segment = &#39;/&#39;, headers: nil) &#x21d2; <tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span></tt>
624
+ #<strong>new_proxy</strong>(segment = &#39;/&#39;, headers: nil) &#x21d2; <tt><span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span></tt>
645
625
 
646
626
 
647
627
 
@@ -649,8 +629,7 @@ header.</p>
649
629
 
650
630
  </h3><div class="docstring">
651
631
  <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>
632
+ <p>Returns a new <span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span> for this proxy.</p>
654
633
 
655
634
 
656
635
  </div>
@@ -671,8 +650,7 @@ header.</p>
671
650
 
672
651
 
673
652
  &mdash;
674
- <div class='inline'>
675
- <p>The segment to add to this proxy&#39;s path.</p>
653
+ <div class='inline'><p>The segment to add to this proxy’s path.</p>
676
654
  </div>
677
655
 
678
656
  </li>
@@ -685,10 +663,11 @@ header.</p>
685
663
  <span class='type'>(<tt>Hash</tt>)</span>
686
664
 
687
665
 
666
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
667
+
688
668
 
689
669
  &mdash;
690
- <div class='inline'>
691
- <p>The default headers for the new proxy.</p>
670
+ <div class='inline'><p>The default headers for the new proxy.</p>
692
671
  </div>
693
672
 
694
673
  </li>
@@ -701,7 +680,7 @@ header.</p>
701
680
  <li>
702
681
 
703
682
 
704
- <span class='type'>(<tt><span class='object_link'><a href="" title="Crapi::Proxy (class)">Crapi::Proxy</a></span></tt>)</span>
683
+ <span class='type'>(<tt><span class='object_link'><a href="" title="CrAPI::Proxy (class)">CrAPI::Proxy</a></span></tt>)</span>
705
684
 
706
685
 
707
686
 
@@ -712,7 +691,7 @@ header.</p>
712
691
  <p class="tag_title">See Also:</p>
713
692
  <ul class="see">
714
693
 
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>
694
+ <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
695
 
717
696
  </ul>
718
697
 
@@ -730,7 +709,7 @@ header.</p>
730
709
  <pre class="code"><span class="info file"># File 'lib/crapi/proxy.rb', line 57</span>
731
710
 
732
711
  <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'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</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>
712
+ <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
713
  <span class='kw'>end</span></pre>
735
714
  </td>
736
715
  </tr>
@@ -748,8 +727,7 @@ header.</p>
748
727
 
749
728
  </h3><div class="docstring">
750
729
  <div class="discussion">
751
-
752
- <p>CRUD method: PATCH</p>
730
+ <p>CRUD method: PATCH</p>
753
731
 
754
732
 
755
733
  </div>
@@ -773,7 +751,7 @@ header.</p>
773
751
  <p class="tag_title">See Also:</p>
774
752
  <ul class="see">
775
753
 
776
- <li><span class='object_link'><a href="Client.html#patch-instance_method" title="Crapi::Client#patch (method)">Crapi::Client#patch</a></span></li>
754
+ <li><span class='object_link'><a href="Client.html#patch-instance_method" title="CrAPI::Client#patch (method)">CrAPI::Client#patch</a></span></li>
777
755
 
778
756
  </ul>
779
757
 
@@ -793,7 +771,7 @@ header.</p>
793
771
 
794
772
  <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
773
  <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'>&quot;</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'>&quot;</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'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</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>
774
+ <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>
797
775
  <span class='kw'>end</span></pre>
798
776
  </td>
799
777
  </tr>
@@ -811,8 +789,7 @@ header.</p>
811
789
 
812
790
  </h3><div class="docstring">
813
791
  <div class="discussion">
814
-
815
- <p>CRUD method: POST</p>
792
+ <p>CRUD method: POST</p>
816
793
 
817
794
 
818
795
  </div>
@@ -836,7 +813,7 @@ header.</p>
836
813
  <p class="tag_title">See Also:</p>
837
814
  <ul class="see">
838
815
 
839
- <li><span class='object_link'><a href="Client.html#post-instance_method" title="Crapi::Client#post (method)">Crapi::Client#post</a></span></li>
816
+ <li><span class='object_link'><a href="Client.html#post-instance_method" title="CrAPI::Client#post (method)">CrAPI::Client#post</a></span></li>
840
817
 
841
818
  </ul>
842
819
 
@@ -874,8 +851,7 @@ header.</p>
874
851
 
875
852
  </h3><div class="docstring">
876
853
  <div class="discussion">
877
-
878
- <p>CRUD method: PUT</p>
854
+ <p>CRUD method: PUT</p>
879
855
 
880
856
 
881
857
  </div>
@@ -899,7 +875,7 @@ header.</p>
899
875
  <p class="tag_title">See Also:</p>
900
876
  <ul class="see">
901
877
 
902
- <li><span class='object_link'><a href="Client.html#put-instance_method" title="Crapi::Client#put (method)">Crapi::Client#put</a></span></li>
878
+ <li><span class='object_link'><a href="Client.html#put-instance_method" title="CrAPI::Client#put (method)">CrAPI::Client#put</a></span></li>
903
879
 
904
880
  </ul>
905
881
 
@@ -931,9 +907,9 @@ header.</p>
931
907
  </div>
932
908
 
933
909
  <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).
910
+ Generated on Mon Jan 2 15:16:45 2023 by
911
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
912
+ 0.9.28 (ruby-3.0.4).
937
913
  </div>
938
914
 
939
915
  </div>