stub_requests 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +5 -2
  3. data/.reek.yml +1 -0
  4. data/.rubocop.yml +33 -35
  5. data/.simplecov +14 -8
  6. data/.yardopts +1 -1
  7. data/CHANGELOG.md +4 -1
  8. data/README.md +19 -11
  9. data/Rakefile +1 -3
  10. data/bin/update_docs.sh +16 -0
  11. data/gemfiles/webmock_2.3.gemfile.lock +1 -1
  12. data/gemfiles/webmock_3.5.gemfile.lock +1 -1
  13. data/gemfiles/webmock_develop.gemfile.lock +1 -1
  14. data/lib/rspec/subject_as_lambda.rb +138 -0
  15. data/lib/stub_requests/api.rb +42 -8
  16. data/lib/stub_requests/argument_validation.rb +17 -6
  17. data/lib/stub_requests/configuration.rb +21 -0
  18. data/lib/stub_requests/core_ext/all.rb +4 -0
  19. data/lib/stub_requests/core_ext/array/extract_options.rb +32 -0
  20. data/lib/stub_requests/core_ext/class/attribute.rb +61 -0
  21. data/lib/stub_requests/core_ext/kernel/singleton_class.rb +12 -0
  22. data/lib/stub_requests/core_ext/module/redefine_method.rb +44 -0
  23. data/lib/stub_requests/core_ext/object/blank.rb +99 -155
  24. data/lib/stub_requests/endpoint.rb +28 -30
  25. data/lib/stub_requests/endpoint_registry.rb +18 -16
  26. data/lib/stub_requests/exceptions.rb +84 -0
  27. data/lib/stub_requests/hash_util.rb +2 -0
  28. data/lib/stub_requests/metrics/endpoint_stat.rb +97 -0
  29. data/lib/stub_requests/metrics/registry.rb +132 -0
  30. data/lib/stub_requests/metrics/stub_stat.rb +80 -0
  31. data/lib/stub_requests/metrics.rb +32 -0
  32. data/lib/stub_requests/property/validator.rb +136 -0
  33. data/lib/stub_requests/property.rb +99 -0
  34. data/lib/stub_requests/service.rb +12 -53
  35. data/lib/stub_requests/service_registry.rb +8 -9
  36. data/lib/stub_requests/stub_requests.rb +23 -51
  37. data/lib/stub_requests/uri/builder.rb +5 -1
  38. data/lib/stub_requests/uri/scheme.rb +3 -1
  39. data/lib/stub_requests/uri/suffix.rb +5 -0
  40. data/lib/stub_requests/uri/validator.rb +3 -1
  41. data/lib/stub_requests/uri.rb +34 -0
  42. data/lib/stub_requests/version.rb +1 -1
  43. data/lib/stub_requests/webmock/builder.rb +116 -0
  44. data/lib/stub_requests/webmock/stub_registry_extension.rb +46 -0
  45. data/lib/stub_requests.rb +21 -3
  46. metadata +19 -49
  47. data/docs/.gitkeep +0 -0
  48. data/docs/Array.html +0 -137
  49. data/docs/FalseClass.html +0 -232
  50. data/docs/Hash.html +0 -137
  51. data/docs/NilClass.html +0 -232
  52. data/docs/Numeric.html +0 -233
  53. data/docs/Object.html +0 -396
  54. data/docs/String.html +0 -298
  55. data/docs/StubRequests/API.html +0 -651
  56. data/docs/StubRequests/ArgumentValidation.html +0 -309
  57. data/docs/StubRequests/Endpoint.html +0 -1187
  58. data/docs/StubRequests/EndpointNotFound.html +0 -157
  59. data/docs/StubRequests/EndpointRegistry.html +0 -1527
  60. data/docs/StubRequests/Error.html +0 -153
  61. data/docs/StubRequests/HashUtil.html +0 -304
  62. data/docs/StubRequests/InvalidType.html +0 -252
  63. data/docs/StubRequests/InvalidUri.html +0 -252
  64. data/docs/StubRequests/Service.html +0 -1307
  65. data/docs/StubRequests/ServiceHaveEndpoints.html +0 -244
  66. data/docs/StubRequests/ServiceNotFound.html +0 -252
  67. data/docs/StubRequests/ServiceRegistry.html +0 -1031
  68. data/docs/StubRequests/URI/Builder.html +0 -1194
  69. data/docs/StubRequests/URI/Scheme.html +0 -315
  70. data/docs/StubRequests/URI/Suffix.html +0 -315
  71. data/docs/StubRequests/URI/Validator.html +0 -770
  72. data/docs/StubRequests/URI.html +0 -144
  73. data/docs/StubRequests/UriSegmentMismatch.html +0 -157
  74. data/docs/StubRequests/WebMockBuilder.html +0 -887
  75. data/docs/StubRequests.html +0 -452
  76. data/docs/Time.html +0 -232
  77. data/docs/TrueClass.html +0 -232
  78. data/docs/_config.yml +0 -1
  79. data/docs/_index.html +0 -391
  80. data/docs/class_list.html +0 -51
  81. data/docs/css/common.css +0 -1
  82. data/docs/css/full_list.css +0 -58
  83. data/docs/css/style.css +0 -496
  84. data/docs/file.README.html +0 -225
  85. data/docs/file_list.html +0 -56
  86. data/docs/frames.html +0 -17
  87. data/docs/index.html +0 -225
  88. data/docs/js/app.js +0 -292
  89. data/docs/js/full_list.js +0 -216
  90. data/docs/js/jquery.js +0 -4
  91. data/docs/method_list.html +0 -707
  92. data/docs/top-level-namespace.html +0 -112
  93. data/lib/stub_requests/webmock_builder.rb +0 -108
@@ -1,1527 +0,0 @@
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: StubRequests::EndpointRegistry
8
-
9
- &mdash; Documentation by YARD 0.9.18
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 = "StubRequests::EndpointRegistry";
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> &raquo;
40
- <span class='title'><span class='object_link'><a href="../StubRequests.html" title="StubRequests (module)">StubRequests</a></span></span>
41
- &raquo;
42
- <span class="title">EndpointRegistry</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: StubRequests::EndpointRegistry
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName"><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></span>
73
-
74
- <ul class="fullTree">
75
- <li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li>
76
-
77
- <li class="next">StubRequests::EndpointRegistry</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
- <dl>
91
- <dt>Includes:</dt>
92
- <dd>Enumerable</dd>
93
- </dl>
94
-
95
-
96
-
97
-
98
-
99
-
100
- <dl>
101
- <dt>Defined in:</dt>
102
- <dd>lib/stub_requests/endpoint_registry.rb</dd>
103
- </dl>
104
-
105
- </div>
106
-
107
- <h2>Overview</h2><div class="docstring">
108
- <div class="discussion">
109
- <p>Class EndpointRegistry holds a collection of <span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></p>
110
-
111
-
112
- </div>
113
- </div>
114
- <div class="tags">
115
-
116
- <p class="tag_title">Since:</p>
117
- <ul class="since">
118
-
119
- <li>
120
-
121
-
122
-
123
-
124
-
125
- <div class='inline'><p>0.1.0</p>
126
- </div>
127
-
128
- </li>
129
-
130
- </ul>
131
-
132
- </div>
133
-
134
-
135
-
136
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
137
- <ul class="summary">
138
-
139
- <li class="public ">
140
- <span class="summary_signature">
141
-
142
- <a href="#endpoints-instance_method" title="#endpoints (instance method)">#<strong>endpoints</strong> &#x21d2; Object </a>
143
-
144
-
145
-
146
- </span>
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
- <span class="summary_desc"><div class='inline'></div></span>
160
-
161
- </li>
162
-
163
-
164
- </ul>
165
-
166
-
167
-
168
-
169
-
170
- <h2>
171
- Instance Method Summary
172
- <small><a href="#" class="summary_toggle">collapse</a></small>
173
- </h2>
174
-
175
- <ul class="summary">
176
-
177
- <li class="public ">
178
- <span class="summary_signature">
179
-
180
- <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong> { ... } &#x21d2; Concurrent::Map&lt;Symbol, Service&gt; </a>
181
-
182
-
183
-
184
- </span>
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
- <span class="summary_desc"><div class='inline'><p>Required by Enumerable.</p>
195
- </div></span>
196
-
197
- </li>
198
-
199
-
200
- <li class="public ">
201
- <span class="summary_signature">
202
-
203
- <a href="#endpoints_string-instance_method" title="#endpoints_string (instance method)">#<strong>endpoints_string</strong> &#x21d2; &lt;type&gt; </a>
204
-
205
-
206
-
207
- </span>
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
- <span class="summary_desc"><div class='inline'><p>Returns a nicely formatted string with an array of endpoints.</p>
218
- </div></span>
219
-
220
- </li>
221
-
222
-
223
- <li class="public ">
224
- <span class="summary_signature">
225
-
226
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(endpoint_id) &#x21d2; Endpoint </a>
227
-
228
-
229
-
230
- </span>
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
- <span class="summary_desc"><div class='inline'><p>Fetches an endpoint from the collection.</p>
241
- </div></span>
242
-
243
- </li>
244
-
245
-
246
- <li class="public ">
247
- <span class="summary_signature">
248
-
249
- <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(endpoint_id) &#x21d2; Endpoint<sup>?</sup> </a>
250
-
251
-
252
-
253
- </span>
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
- <span class="summary_desc"><div class='inline'><p>Fetches an endpoint from the collection or raises an error.</p>
264
- </div></span>
265
-
266
- </li>
267
-
268
-
269
- <li class="public ">
270
- <span class="summary_signature">
271
-
272
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; EndpointRegistry </a>
273
-
274
-
275
-
276
- </span>
277
-
278
-
279
- <span class="note title constructor">constructor</span>
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
- <span class="summary_desc"><div class='inline'><p>A new instance of EndpointRegistry.</p>
289
- </div></span>
290
-
291
- </li>
292
-
293
-
294
- <li class="public ">
295
- <span class="summary_signature">
296
-
297
- <a href="#register-instance_method" title="#register (instance method)">#<strong>register</strong>(endpoint_id, verb, uri_template, default_options = {}) &#x21d2; Endpoint </a>
298
-
299
-
300
-
301
- </span>
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
- <span class="summary_desc"><div class='inline'><p>Registers an endpoint in the collection.</p>
312
- </div></span>
313
-
314
- </li>
315
-
316
-
317
- <li class="public ">
318
- <span class="summary_signature">
319
-
320
- <a href="#registered%3F-instance_method" title="#registered? (instance method)">#<strong>registered?</strong>(endpoint_id) &#x21d2; true, false </a>
321
-
322
-
323
-
324
- </span>
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
- <span class="summary_desc"><div class='inline'><p>Check if an endpoint is registered.</p>
335
- </div></span>
336
-
337
- </li>
338
-
339
-
340
- <li class="public ">
341
- <span class="summary_signature">
342
-
343
- <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(endpoint_id) &#x21d2; Endpoint </a>
344
-
345
-
346
-
347
- </span>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
- <span class="summary_desc"><div class='inline'><p>Removes an endpoint from the collection.</p>
358
- </div></span>
359
-
360
- </li>
361
-
362
-
363
- <li class="public ">
364
- <span class="summary_signature">
365
-
366
- <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a>
367
-
368
-
369
-
370
- </span>
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
- <span class="summary_desc"><div class='inline'><p>Returns a descriptive string with all endpoints in the collection.</p>
381
- </div></span>
382
-
383
- </li>
384
-
385
-
386
- <li class="public ">
387
- <span class="summary_signature">
388
-
389
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(endpoint_id, verb, uri_template, default_options) &#x21d2; Endpoint </a>
390
-
391
-
392
-
393
- </span>
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
- <span class="summary_desc"><div class='inline'><p>Updates an endpoint.</p>
404
- </div></span>
405
-
406
- </li>
407
-
408
-
409
- </ul>
410
-
411
-
412
-
413
- <div id="constructor_details" class="method_details_list">
414
- <h2>Constructor Details</h2>
415
-
416
- <div class="method_details first">
417
- <h3 class="signature first" id="initialize-instance_method">
418
-
419
- #<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="StubRequests::EndpointRegistry (class)">EndpointRegistry</a></span></tt>
420
-
421
-
422
-
423
-
424
-
425
- </h3><div class="docstring">
426
- <div class="discussion">
427
- <p>Returns a new instance of EndpointRegistry</p>
428
-
429
-
430
- </div>
431
- </div>
432
- <div class="tags">
433
-
434
- <p class="tag_title">Since:</p>
435
- <ul class="since">
436
-
437
- <li>
438
-
439
-
440
-
441
-
442
-
443
- <div class='inline'><p>0.1.0</p>
444
- </div>
445
-
446
- </li>
447
-
448
- </ul>
449
-
450
- </div><table class="source_code">
451
- <tr>
452
- <td>
453
- <pre class="lines">
454
-
455
-
456
- 21
457
- 22
458
- 23</pre>
459
- </td>
460
- <td>
461
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 21</span>
462
-
463
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
464
- <span class='ivar'>@endpoints</span> <span class='op'>=</span> <span class='const'>Concurrent</span><span class='op'>::</span><span class='const'>Map</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
465
- <span class='kw'>end</span></pre>
466
- </td>
467
- </tr>
468
- </table>
469
- </div>
470
-
471
- </div>
472
-
473
- <div id="instance_attr_details" class="attr_details">
474
- <h2>Instance Attribute Details</h2>
475
-
476
-
477
- <span id="endpoints=-instance_method"></span>
478
- <div class="method_details first">
479
- <h3 class="signature first" id="endpoints-instance_method">
480
-
481
- #<strong>endpoints</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
482
-
483
-
484
-
485
-
486
-
487
- </h3><div class="docstring">
488
- <div class="discussion">
489
-
490
-
491
- </div>
492
- </div>
493
- <div class="tags">
494
-
495
- <p class="tag_title">Since:</p>
496
- <ul class="since">
497
-
498
- <li>
499
-
500
-
501
-
502
-
503
-
504
- <div class='inline'><p>0.1.0</p>
505
- </div>
506
-
507
- </li>
508
-
509
- </ul>
510
-
511
- </div><table class="source_code">
512
- <tr>
513
- <td>
514
- <pre class="lines">
515
-
516
-
517
- 19
518
- 20
519
- 21</pre>
520
- </td>
521
- <td>
522
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 19</span>
523
-
524
- <span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
525
- <span class='ivar'>@endpoints</span>
526
- <span class='kw'>end</span></pre>
527
- </td>
528
- </tr>
529
- </table>
530
- </div>
531
-
532
- </div>
533
-
534
-
535
- <div id="instance_method_details" class="method_details_list">
536
- <h2>Instance Method Details</h2>
537
-
538
-
539
- <div class="method_details first">
540
- <h3 class="signature first" id="each-instance_method">
541
-
542
- #<strong>each</strong> { ... } &#x21d2; <tt>Concurrent::Map&lt;Symbol, <span class='object_link'><a href="Service.html" title="StubRequests::Service (class)">Service</a></span>&gt;</tt>
543
-
544
-
545
-
546
-
547
-
548
- </h3><div class="docstring">
549
- <div class="discussion">
550
- <p>Required by Enumerable</p>
551
-
552
-
553
- </div>
554
- </div>
555
- <div class="tags">
556
-
557
- <p class="tag_title">Yields:</p>
558
- <ul class="yield">
559
-
560
- <li>
561
-
562
-
563
- <span class='type'></span>
564
-
565
-
566
-
567
-
568
- <div class='inline'><p>used by Enumerable</p>
569
- </div>
570
-
571
- </li>
572
-
573
- </ul>
574
- <p class="tag_title">Returns:</p>
575
- <ul class="return">
576
-
577
- <li>
578
-
579
-
580
- <span class='type'>(<tt>Concurrent::Map&lt;Symbol, <span class='object_link'><a href="Service.html" title="StubRequests::Service (class)">Service</a></span>&gt;</tt>)</span>
581
-
582
-
583
-
584
- &mdash;
585
- <div class='inline'><p>a map with endpoints</p>
586
- </div>
587
-
588
- </li>
589
-
590
- </ul>
591
- <p class="tag_title">Since:</p>
592
- <ul class="since">
593
-
594
- <li>
595
-
596
-
597
-
598
-
599
-
600
- <div class='inline'><p>0.1.0</p>
601
- </div>
602
-
603
- </li>
604
-
605
- </ul>
606
-
607
- </div><table class="source_code">
608
- <tr>
609
- <td>
610
- <pre class="lines">
611
-
612
-
613
- 32
614
- 33
615
- 34</pre>
616
- </td>
617
- <td>
618
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 32</span>
619
-
620
- <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
621
- <span class='id identifier rubyid_endpoints'>endpoints</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
622
- <span class='kw'>end</span></pre>
623
- </td>
624
- </tr>
625
- </table>
626
- </div>
627
-
628
- <div class="method_details ">
629
- <h3 class="signature " id="endpoints_string-instance_method">
630
-
631
- #<strong>endpoints_string</strong> &#x21d2; <tt>&lt;type&gt;</tt>
632
-
633
-
634
-
635
-
636
-
637
- </h3><div class="docstring">
638
- <div class="discussion">
639
- <p>Returns a nicely formatted string with an array of endpoints</p>
640
-
641
-
642
- </div>
643
- </div>
644
- <div class="tags">
645
-
646
- <p class="tag_title">Returns:</p>
647
- <ul class="return">
648
-
649
- <li>
650
-
651
-
652
- <span class='type'>(<tt>&lt;type&gt;</tt>)</span>
653
-
654
-
655
-
656
- &mdash;
657
- <div class='inline'><p><description></p>
658
- </div>
659
-
660
- </li>
661
-
662
- </ul>
663
- <p class="tag_title">Since:</p>
664
- <ul class="since">
665
-
666
- <li>
667
-
668
-
669
-
670
-
671
-
672
- <div class='inline'><p>0.1.0</p>
673
- </div>
674
-
675
- </li>
676
-
677
- </ul>
678
-
679
- </div><table class="source_code">
680
- <tr>
681
- <td>
682
- <pre class="lines">
683
-
684
-
685
- 147
686
- 148
687
- 149</pre>
688
- </td>
689
- <td>
690
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 147</span>
691
-
692
- <span class='kw'>def</span> <span class='id identifier rubyid_endpoints_string'>endpoints_string</span>
693
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoints_as_string'>endpoints_as_string</span><span class='embexpr_end'>}</span><span class='tstring_content'>]</span><span class='tstring_end'>&quot;</span></span>
694
- <span class='kw'>end</span></pre>
695
- </td>
696
- </tr>
697
- </table>
698
- </div>
699
-
700
- <div class="method_details ">
701
- <h3 class="signature " id="get-instance_method">
702
-
703
- #<strong>get</strong>(endpoint_id) &#x21d2; <tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>
704
-
705
-
706
-
707
-
708
-
709
- </h3><div class="docstring">
710
- <div class="discussion">
711
- <p>Fetches an endpoint from the collection</p>
712
-
713
-
714
- </div>
715
- </div>
716
- <div class="tags">
717
- <p class="tag_title">Parameters:</p>
718
- <ul class="param">
719
-
720
- <li>
721
-
722
- <span class='name'>endpoint_id</span>
723
-
724
-
725
- <span class='type'>(<tt>&lt;type&gt;</tt>)</span>
726
-
727
-
728
-
729
- &mdash;
730
- <div class='inline'><p><description></p>
731
- </div>
732
-
733
- </li>
734
-
735
- </ul>
736
-
737
- <p class="tag_title">Returns:</p>
738
- <ul class="return">
739
-
740
- <li>
741
-
742
-
743
- <span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>)</span>
744
-
745
-
746
-
747
- </li>
748
-
749
- </ul>
750
- <p class="tag_title">Since:</p>
751
- <ul class="since">
752
-
753
- <li>
754
-
755
-
756
-
757
-
758
-
759
- <div class='inline'><p>0.1.0</p>
760
- </div>
761
-
762
- </li>
763
-
764
- </ul>
765
-
766
- </div><table class="source_code">
767
- <tr>
768
- <td>
769
- <pre class="lines">
770
-
771
-
772
- 111
773
- 112
774
- 113</pre>
775
- </td>
776
- <td>
777
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 111</span>
778
-
779
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
780
- <span class='id identifier rubyid_endpoints'>endpoints</span><span class='lbracket'>[</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rbracket'>]</span>
781
- <span class='kw'>end</span></pre>
782
- </td>
783
- </tr>
784
- </table>
785
- </div>
786
-
787
- <div class="method_details ">
788
- <h3 class="signature " id="get!-instance_method">
789
-
790
- #<strong>get!</strong>(endpoint_id) &#x21d2; <tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt><sup>?</sup>
791
-
792
-
793
-
794
-
795
-
796
- </h3><div class="docstring">
797
- <div class="discussion">
798
- <p>Fetches an endpoint from the collection or raises an error</p>
799
-
800
-
801
- </div>
802
- </div>
803
- <div class="tags">
804
- <p class="tag_title">Parameters:</p>
805
- <ul class="param">
806
-
807
- <li>
808
-
809
- <span class='name'>endpoint_id</span>
810
-
811
-
812
- <span class='type'>(<tt>Symbol</tt>)</span>
813
-
814
-
815
-
816
- &mdash;
817
- <div class='inline'><p>the id of the endpoint</p>
818
- </div>
819
-
820
- </li>
821
-
822
- </ul>
823
-
824
- <p class="tag_title">Returns:</p>
825
- <ul class="return">
826
-
827
- <li>
828
-
829
-
830
- <span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>, <tt>nil</tt>)</span>
831
-
832
-
833
-
834
- </li>
835
-
836
- </ul>
837
- <p class="tag_title">Raises:</p>
838
- <ul class="raise">
839
-
840
- <li>
841
-
842
-
843
- <span class='type'>(<tt><span class='object_link'><a href="EndpointNotFound.html" title="StubRequests::EndpointNotFound (class)">EndpointNotFound</a></span></tt>)</span>
844
-
845
-
846
-
847
- &mdash;
848
- <div class='inline'><p>when an endpoint couldn&#39;t be found</p>
849
- </div>
850
-
851
- </li>
852
-
853
- </ul>
854
- <p class="tag_title">Since:</p>
855
- <ul class="since">
856
-
857
- <li>
858
-
859
-
860
-
861
-
862
-
863
- <div class='inline'><p>0.1.0</p>
864
- </div>
865
-
866
- </li>
867
-
868
- </ul>
869
-
870
- </div><table class="source_code">
871
- <tr>
872
- <td>
873
- <pre class="lines">
874
-
875
-
876
- 124
877
- 125
878
- 126</pre>
879
- </td>
880
- <td>
881
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 124</span>
882
-
883
- <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
884
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="EndpointNotFound.html" title="StubRequests::EndpointNotFound (class)">EndpointNotFound</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Couldn&#39;t find an endpoint with id=:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
885
- <span class='kw'>end</span></pre>
886
- </td>
887
- </tr>
888
- </table>
889
- </div>
890
-
891
- <div class="method_details ">
892
- <h3 class="signature " id="register-instance_method">
893
-
894
- #<strong>register</strong>(endpoint_id, verb, uri_template, default_options = {}) &#x21d2; <tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>
895
-
896
-
897
-
898
-
899
-
900
- </h3><div class="docstring">
901
- <div class="discussion">
902
- <p>Registers an endpoint in the collection</p>
903
-
904
- <p>:reek:LongParameterList { max_params: 4 }</p>
905
-
906
-
907
- </div>
908
- </div>
909
- <div class="tags">
910
- <p class="tag_title">Parameters:</p>
911
- <ul class="param">
912
-
913
- <li>
914
-
915
- <span class='name'>endpoint_id</span>
916
-
917
-
918
- <span class='type'>(<tt>Symbol</tt>)</span>
919
-
920
-
921
-
922
- &mdash;
923
- <div class='inline'><p>the id of this Endpoint</p>
924
- </div>
925
-
926
- </li>
927
-
928
- <li>
929
-
930
- <span class='name'>verb</span>
931
-
932
-
933
- <span class='type'>(<tt>Symbol</tt>)</span>
934
-
935
-
936
-
937
- &mdash;
938
- <div class='inline'><p>a HTTP verb</p>
939
- </div>
940
-
941
- </li>
942
-
943
- <li>
944
-
945
- <span class='name'>uri_template</span>
946
-
947
-
948
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
949
-
950
-
951
-
952
- &mdash;
953
- <div class='inline'><p>the URI to reach the endpoint</p>
954
- </div>
955
-
956
- </li>
957
-
958
- <li>
959
-
960
- <span class='name'>default_options</span>
961
-
962
-
963
- <span class='type'>(<tt>optional</tt>, <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol&gt;</tt>)</span>
964
-
965
-
966
- <em class="default">(defaults to: <tt>{}</tt>)</em>
967
-
968
-
969
- &mdash;
970
- <div class='inline'><p>default options</p>
971
- </div>
972
-
973
- </li>
974
-
975
- </ul>
976
-
977
- <p class="tag_title">Returns:</p>
978
- <ul class="return">
979
-
980
- <li>
981
-
982
-
983
- <span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>)</span>
984
-
985
-
986
-
987
- </li>
988
-
989
- </ul>
990
- <p class="tag_title">Since:</p>
991
- <ul class="since">
992
-
993
- <li>
994
-
995
-
996
-
997
-
998
-
999
- <div class='inline'><p>0.1.0</p>
1000
- </div>
1001
-
1002
- </li>
1003
-
1004
- </ul>
1005
-
1006
- </div><table class="source_code">
1007
- <tr>
1008
- <td>
1009
- <pre class="lines">
1010
-
1011
-
1012
- 47
1013
- 48
1014
- 49
1015
- 50
1016
- 51
1017
- 52
1018
- 53
1019
- 54
1020
- 55
1021
- 56
1022
- 57
1023
- 58</pre>
1024
- </td>
1025
- <td>
1026
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 47</span>
1027
-
1028
- <span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='comma'>,</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='id identifier rubyid_uri_template'>uri_template</span><span class='comma'>,</span> <span class='id identifier rubyid_default_options'>default_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1029
- <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span>
1030
- <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span><span class='rparen'>)</span>
1031
- <span class='const'><span class='object_link'><a href="../StubRequests.html" title="StubRequests (module)">StubRequests</a></span></span><span class='period'>.</span><span class='id identifier rubyid_logger'><span class='object_link'><a href="../StubRequests.html#logger-instance_method" title="StubRequests#logger (method)">logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Endpoint already registered: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1032
- <span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='id identifier rubyid_uri_template'>uri_template</span><span class='comma'>,</span> <span class='id identifier rubyid_default_options'>default_options</span><span class='rparen'>)</span>
1033
- <span class='kw'>else</span>
1034
- <span class='const'><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Endpoint.html#initialize-instance_method" title="StubRequests::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='comma'>,</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='id identifier rubyid_uri_template'>uri_template</span><span class='comma'>,</span> <span class='id identifier rubyid_default_options'>default_options</span><span class='rparen'>)</span>
1035
- <span class='kw'>end</span>
1036
-
1037
- <span class='id identifier rubyid_endpoints'>endpoints</span><span class='lbracket'>[</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
1038
- <span class='id identifier rubyid_endpoint'>endpoint</span>
1039
- <span class='kw'>end</span></pre>
1040
- </td>
1041
- </tr>
1042
- </table>
1043
- </div>
1044
-
1045
- <div class="method_details ">
1046
- <h3 class="signature " id="registered?-instance_method">
1047
-
1048
- #<strong>registered?</strong>(endpoint_id) &#x21d2; <tt>true</tt>, <tt>false</tt>
1049
-
1050
-
1051
-
1052
-
1053
-
1054
- </h3><div class="docstring">
1055
- <div class="discussion">
1056
- <p>Check if an endpoint is registered</p>
1057
-
1058
-
1059
- </div>
1060
- </div>
1061
- <div class="tags">
1062
- <p class="tag_title">Parameters:</p>
1063
- <ul class="param">
1064
-
1065
- <li>
1066
-
1067
- <span class='name'>endpoint_id</span>
1068
-
1069
-
1070
- <span class='type'>(<tt>Symbol</tt>)</span>
1071
-
1072
-
1073
-
1074
- &mdash;
1075
- <div class='inline'><p>the id of the endpoint</p>
1076
- </div>
1077
-
1078
- </li>
1079
-
1080
- </ul>
1081
-
1082
- <p class="tag_title">Returns:</p>
1083
- <ul class="return">
1084
-
1085
- <li>
1086
-
1087
-
1088
- <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
1089
-
1090
-
1091
-
1092
- </li>
1093
-
1094
- </ul>
1095
- <p class="tag_title">Since:</p>
1096
- <ul class="since">
1097
-
1098
- <li>
1099
-
1100
-
1101
-
1102
-
1103
-
1104
- <div class='inline'><p>0.1.0</p>
1105
- </div>
1106
-
1107
- </li>
1108
-
1109
- </ul>
1110
-
1111
- </div><table class="source_code">
1112
- <tr>
1113
- <td>
1114
- <pre class="lines">
1115
-
1116
-
1117
- 67
1118
- 68
1119
- 69</pre>
1120
- </td>
1121
- <td>
1122
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 67</span>
1123
-
1124
- <span class='kw'>def</span> <span class='id identifier rubyid_registered?'>registered?</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
1125
- <span class='id identifier rubyid_endpoints'>endpoints</span><span class='lbracket'>[</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
1126
- <span class='kw'>end</span></pre>
1127
- </td>
1128
- </tr>
1129
- </table>
1130
- </div>
1131
-
1132
- <div class="method_details ">
1133
- <h3 class="signature " id="remove-instance_method">
1134
-
1135
- #<strong>remove</strong>(endpoint_id) &#x21d2; <tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>
1136
-
1137
-
1138
-
1139
-
1140
-
1141
- </h3><div class="docstring">
1142
- <div class="discussion">
1143
- <p>Removes an endpoint from the collection</p>
1144
-
1145
-
1146
- </div>
1147
- </div>
1148
- <div class="tags">
1149
- <p class="tag_title">Parameters:</p>
1150
- <ul class="param">
1151
-
1152
- <li>
1153
-
1154
- <span class='name'>endpoint_id</span>
1155
-
1156
-
1157
- <span class='type'>(<tt>Symbol</tt>)</span>
1158
-
1159
-
1160
-
1161
- &mdash;
1162
- <div class='inline'><p>the id of the endpoint, <code>:file_service</code></p>
1163
- </div>
1164
-
1165
- </li>
1166
-
1167
- </ul>
1168
-
1169
- <p class="tag_title">Returns:</p>
1170
- <ul class="return">
1171
-
1172
- <li>
1173
-
1174
-
1175
- <span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>)</span>
1176
-
1177
-
1178
-
1179
- &mdash;
1180
- <div class='inline'><p>the endpoint that was removed</p>
1181
- </div>
1182
-
1183
- </li>
1184
-
1185
- </ul>
1186
- <p class="tag_title">Since:</p>
1187
- <ul class="since">
1188
-
1189
- <li>
1190
-
1191
-
1192
-
1193
-
1194
-
1195
- <div class='inline'><p>0.1.0</p>
1196
- </div>
1197
-
1198
- </li>
1199
-
1200
- </ul>
1201
-
1202
- </div><table class="source_code">
1203
- <tr>
1204
- <td>
1205
- <pre class="lines">
1206
-
1207
-
1208
- 100
1209
- 101
1210
- 102</pre>
1211
- </td>
1212
- <td>
1213
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 100</span>
1214
-
1215
- <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
1216
- <span class='id identifier rubyid_endpoints'>endpoints</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
1217
- <span class='kw'>end</span></pre>
1218
- </td>
1219
- </tr>
1220
- </table>
1221
- </div>
1222
-
1223
- <div class="method_details ">
1224
- <h3 class="signature " id="to_s-instance_method">
1225
-
1226
- #<strong>to_s</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
1227
-
1228
-
1229
-
1230
-
1231
-
1232
- </h3><div class="docstring">
1233
- <div class="discussion">
1234
- <p>Returns a descriptive string with all endpoints in the collection</p>
1235
-
1236
-
1237
- </div>
1238
- </div>
1239
- <div class="tags">
1240
-
1241
- <p class="tag_title">Returns:</p>
1242
- <ul class="return">
1243
-
1244
- <li>
1245
-
1246
-
1247
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1248
-
1249
-
1250
-
1251
- </li>
1252
-
1253
- </ul>
1254
- <p class="tag_title">Since:</p>
1255
- <ul class="since">
1256
-
1257
- <li>
1258
-
1259
-
1260
-
1261
-
1262
-
1263
- <div class='inline'><p>0.1.0</p>
1264
- </div>
1265
-
1266
- </li>
1267
-
1268
- </ul>
1269
-
1270
- </div><table class="source_code">
1271
- <tr>
1272
- <td>
1273
- <pre class="lines">
1274
-
1275
-
1276
- 133
1277
- 134
1278
- 135
1279
- 136
1280
- 137
1281
- 138
1282
- 139</pre>
1283
- </td>
1284
- <td>
1285
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 133</span>
1286
-
1287
- <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
1288
- <span class='lbracket'>[</span>
1289
- <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#&lt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> endpoints=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
1290
- <span class='op'>+</span><span class='id identifier rubyid_endpoints_string'>endpoints_string</span><span class='comma'>,</span>
1291
- <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
1292
- <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1293
- <span class='kw'>end</span></pre>
1294
- </td>
1295
- </tr>
1296
- </table>
1297
- </div>
1298
-
1299
- <div class="method_details ">
1300
- <h3 class="signature " id="update-instance_method">
1301
-
1302
- #<strong>update</strong>(endpoint_id, verb, uri_template, default_options) &#x21d2; <tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>
1303
-
1304
-
1305
-
1306
-
1307
-
1308
- </h3><div class="docstring">
1309
- <div class="discussion">
1310
- <p>Updates an endpoint</p>
1311
-
1312
- <p>:reek:LongParameterList { max_params: 4 }</p>
1313
-
1314
-
1315
- </div>
1316
- </div>
1317
- <div class="tags">
1318
- <p class="tag_title">Parameters:</p>
1319
- <ul class="param">
1320
-
1321
- <li>
1322
-
1323
- <span class='name'>endpoint_id</span>
1324
-
1325
-
1326
- <span class='type'>(<tt>Symbol</tt>)</span>
1327
-
1328
-
1329
-
1330
- &mdash;
1331
- <div class='inline'><p>the id of the endpoint</p>
1332
- </div>
1333
-
1334
- </li>
1335
-
1336
- <li>
1337
-
1338
- <span class='name'>verb</span>
1339
-
1340
-
1341
- <span class='type'>(<tt>Symbol</tt>)</span>
1342
-
1343
-
1344
-
1345
- &mdash;
1346
- <div class='inline'><p>a HTTP verb</p>
1347
- </div>
1348
-
1349
- </li>
1350
-
1351
- <li>
1352
-
1353
- <span class='name'>uri_template</span>
1354
-
1355
-
1356
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1357
-
1358
-
1359
-
1360
- &mdash;
1361
- <div class='inline'><p>how to reach the endpoint</p>
1362
- </div>
1363
-
1364
- </li>
1365
-
1366
- <li>
1367
-
1368
- <span class='name'>default_options</span>
1369
-
1370
-
1371
- <span class='type'>(<tt>optional</tt>, <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol&gt;</tt>)</span>
1372
-
1373
-
1374
-
1375
- </li>
1376
-
1377
- </ul>
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
-
1386
-
1387
-
1388
- <p class="tag_title">Options Hash (<tt>default_options</tt>):</p>
1389
- <ul class="option">
1390
-
1391
- <li>
1392
- <span class="name">:request</span>
1393
- <span class="type">(<tt>optional</tt>, <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol&gt;</tt>)</span>
1394
- <span class="default">
1395
-
1396
- </span>
1397
-
1398
- &mdash; <div class='inline'><p>request options</p>
1399
- </div>
1400
-
1401
- </li>
1402
-
1403
- <li>
1404
- <span class="name">:response</span>
1405
- <span class="type">(<tt>optional</tt>, <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol&gt;</tt>)</span>
1406
- <span class="default">
1407
-
1408
- </span>
1409
-
1410
- &mdash; <div class='inline'><p>options</p>
1411
- </div>
1412
-
1413
- </li>
1414
-
1415
- <li>
1416
- <span class="name">:error</span>
1417
- <span class="type">(<tt>optional</tt>, <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>, <tt>Exception</tt>, <tt>StandardError</tt>, <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1418
- <span class="default">
1419
-
1420
- </span>
1421
-
1422
- &mdash; <div class='inline'><p>to raise</p>
1423
- </div>
1424
-
1425
- </li>
1426
-
1427
- <li>
1428
- <span class="name">:timeout</span>
1429
- <span class="type">(<tt>optional</tt>, <tt><span class='object_link'><a href="../TrueClass.html" title="TrueClass (class)">TrueClass</a></span></tt>)</span>
1430
- <span class="default">
1431
-
1432
- </span>
1433
-
1434
- &mdash; <div class='inline'><p>raise a timeout error?</p>
1435
- </div>
1436
-
1437
- </li>
1438
-
1439
- </ul>
1440
-
1441
-
1442
- <p class="tag_title">Returns:</p>
1443
- <ul class="return">
1444
-
1445
- <li>
1446
-
1447
-
1448
- <span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="StubRequests::Endpoint (class)">Endpoint</a></span></tt>)</span>
1449
-
1450
-
1451
-
1452
- &mdash;
1453
- <div class='inline'><p>returns the updated endpoint</p>
1454
- </div>
1455
-
1456
- </li>
1457
-
1458
- </ul>
1459
- <p class="tag_title">Raises:</p>
1460
- <ul class="raise">
1461
-
1462
- <li>
1463
-
1464
-
1465
- <span class='type'>(<tt><span class='object_link'><a href="EndpointNotFound.html" title="StubRequests::EndpointNotFound (class)">EndpointNotFound</a></span></tt>)</span>
1466
-
1467
-
1468
-
1469
- &mdash;
1470
- <div class='inline'><p>when the endpoint couldn&#39;t be found</p>
1471
- </div>
1472
-
1473
- </li>
1474
-
1475
- </ul>
1476
- <p class="tag_title">Since:</p>
1477
- <ul class="since">
1478
-
1479
- <li>
1480
-
1481
-
1482
-
1483
-
1484
-
1485
- <div class='inline'><p>0.1.0</p>
1486
- </div>
1487
-
1488
- </li>
1489
-
1490
- </ul>
1491
-
1492
- </div><table class="source_code">
1493
- <tr>
1494
- <td>
1495
- <pre class="lines">
1496
-
1497
-
1498
- 88
1499
- 89
1500
- 90
1501
- 91</pre>
1502
- </td>
1503
- <td>
1504
- <pre class="code"><span class="info file"># File 'lib/stub_requests/endpoint_registry.rb', line 88</span>
1505
-
1506
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='comma'>,</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='id identifier rubyid_uri_template'>uri_template</span><span class='comma'>,</span> <span class='id identifier rubyid_default_options'>default_options</span><span class='rparen'>)</span>
1507
- <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_id'>endpoint_id</span><span class='rparen'>)</span>
1508
- <span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='id identifier rubyid_uri_template'>uri_template</span><span class='comma'>,</span> <span class='id identifier rubyid_default_options'>default_options</span><span class='rparen'>)</span>
1509
- <span class='kw'>end</span></pre>
1510
- </td>
1511
- </tr>
1512
- </table>
1513
- </div>
1514
-
1515
- </div>
1516
-
1517
- </div>
1518
-
1519
- <div id="footer">
1520
- Generated on Fri Feb 1 19:57:30 2019 by
1521
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1522
- 0.9.18 (ruby-2.5.3).
1523
- </div>
1524
-
1525
- </div>
1526
- </body>
1527
- </html>