stub_requests 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.codeclimate.yml +7 -0
- data/.reek.yml +1 -0
- data/.rubocop.yml +2 -0
- data/.travis.yml +15 -0
- data/.yardopts +1 -1
- data/Appraisals +11 -0
- data/CHANGELOG.md +17 -0
- data/README.md +15 -2
- data/Rakefile +16 -1
- data/docs/.gitkeep +0 -0
- data/docs/Array.html +137 -0
- data/docs/FalseClass.html +232 -0
- data/docs/Hash.html +137 -0
- data/docs/NilClass.html +232 -0
- data/docs/Numeric.html +233 -0
- data/docs/Object.html +396 -0
- data/docs/String.html +298 -0
- data/docs/StubRequests/API.html +651 -0
- data/docs/StubRequests/ArgumentValidation.html +309 -0
- data/docs/StubRequests/Endpoint.html +1187 -0
- data/docs/StubRequests/EndpointNotFound.html +157 -0
- data/docs/StubRequests/EndpointRegistry.html +1527 -0
- data/docs/StubRequests/Error.html +153 -0
- data/docs/StubRequests/HashUtil.html +304 -0
- data/docs/StubRequests/InvalidType.html +252 -0
- data/docs/StubRequests/InvalidUri.html +252 -0
- data/docs/StubRequests/Service.html +1307 -0
- data/docs/StubRequests/ServiceHaveEndpoints.html +244 -0
- data/docs/StubRequests/ServiceNotFound.html +252 -0
- data/docs/StubRequests/ServiceRegistry.html +1031 -0
- data/docs/StubRequests/URI/Builder.html +1194 -0
- data/docs/StubRequests/URI/Scheme.html +315 -0
- data/docs/StubRequests/URI/Suffix.html +315 -0
- data/docs/StubRequests/URI/Validator.html +770 -0
- data/docs/StubRequests/URI.html +144 -0
- data/docs/StubRequests/UriSegmentMismatch.html +157 -0
- data/docs/StubRequests/WebMockBuilder.html +887 -0
- data/docs/StubRequests.html +452 -0
- data/docs/Time.html +232 -0
- data/docs/TrueClass.html +232 -0
- data/docs/_config.yml +1 -0
- data/docs/_index.html +391 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +225 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +225 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +707 -0
- data/docs/top-level-namespace.html +112 -0
- data/gemfiles/.bundle/config +2 -0
- data/gemfiles/webmock_2.3.gemfile +8 -0
- data/gemfiles/webmock_2.3.gemfile.lock +206 -0
- data/gemfiles/webmock_3.5.gemfile +8 -0
- data/gemfiles/webmock_3.5.gemfile.lock +206 -0
- data/gemfiles/webmock_develop.gemfile +8 -0
- data/gemfiles/webmock_develop.gemfile.lock +211 -0
- data/lib/stub_requests/version.rb +1 -1
- data/lib/tasks/changelog.rake +18 -0
- data/lib/tasks/gem.rake +15 -0
- data/lib/tasks/git.rake +40 -0
- data/stub_requests.gemspec +23 -12
- metadata +138 -25
@@ -0,0 +1,1194 @@
|
|
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::URI::Builder
|
8
|
+
|
9
|
+
— 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::URI::Builder";
|
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="../../StubRequests.html" title="StubRequests (module)">StubRequests</a></span></span> » <span class='title'><span class='object_link'><a href="../URI.html" title="StubRequests::URI (module)">URI</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Builder</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::URI::Builder
|
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::URI::Builder</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/stub_requests/uri/builder.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
<p>Builder constructs and validates URIs</p>
|
105
|
+
|
106
|
+
<p>:reek:TooManyInstanceVariables { max_instance_variables: 6 }</p>
|
107
|
+
|
108
|
+
|
109
|
+
</div>
|
110
|
+
</div>
|
111
|
+
<div class="tags">
|
112
|
+
|
113
|
+
<p class="tag_title">Since:</p>
|
114
|
+
<ul class="since">
|
115
|
+
|
116
|
+
<li>
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
<div class='inline'><p>0.1.0</p>
|
123
|
+
</div>
|
124
|
+
|
125
|
+
</li>
|
126
|
+
|
127
|
+
</ul>
|
128
|
+
|
129
|
+
</div>
|
130
|
+
|
131
|
+
<h2>
|
132
|
+
Constant Summary
|
133
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
134
|
+
</h2>
|
135
|
+
|
136
|
+
<dl class="constants">
|
137
|
+
|
138
|
+
<dt id="URL_SEGMENT_REGEX-constant" class="">URL_SEGMENT_REGEX =
|
139
|
+
<div class="docstring">
|
140
|
+
<div class="discussion">
|
141
|
+
<p>Returns A pattern for matching url segment keys</p>
|
142
|
+
|
143
|
+
|
144
|
+
</div>
|
145
|
+
</div>
|
146
|
+
<div class="tags">
|
147
|
+
|
148
|
+
<p class="tag_title">Returns:</p>
|
149
|
+
<ul class="return">
|
150
|
+
|
151
|
+
<li>
|
152
|
+
|
153
|
+
|
154
|
+
<span class='type'>(<tt>Regexp</tt>)</span>
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
—
|
159
|
+
<div class='inline'><p>A pattern for matching url segment keys</p>
|
160
|
+
</div>
|
161
|
+
|
162
|
+
</li>
|
163
|
+
|
164
|
+
</ul>
|
165
|
+
<p class="tag_title">Since:</p>
|
166
|
+
<ul class="since">
|
167
|
+
|
168
|
+
<li>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
<div class='inline'><p>0.1.0</p>
|
175
|
+
</div>
|
176
|
+
|
177
|
+
</li>
|
178
|
+
|
179
|
+
</ul>
|
180
|
+
|
181
|
+
</div>
|
182
|
+
</dt>
|
183
|
+
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(:\w+)</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
184
|
+
|
185
|
+
</dl>
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
192
|
+
<ul class="summary">
|
193
|
+
|
194
|
+
<li class="public ">
|
195
|
+
<span class="summary_signature">
|
196
|
+
|
197
|
+
<a href="#host-instance_method" title="#host (instance method)">#<strong>host</strong> ⇒ Object </a>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
</span>
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
<span class="note title readonly">readonly</span>
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
217
|
+
|
218
|
+
</li>
|
219
|
+
|
220
|
+
|
221
|
+
<li class="public ">
|
222
|
+
<span class="summary_signature">
|
223
|
+
|
224
|
+
<a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong> ⇒ Object </a>
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
</span>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
<span class="note title readonly">readonly</span>
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
244
|
+
|
245
|
+
</li>
|
246
|
+
|
247
|
+
|
248
|
+
<li class="public ">
|
249
|
+
<span class="summary_signature">
|
250
|
+
|
251
|
+
<a href="#replacements-instance_method" title="#replacements (instance method)">#<strong>replacements</strong> ⇒ Object </a>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
</span>
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
<span class="note title readonly">readonly</span>
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
271
|
+
|
272
|
+
</li>
|
273
|
+
|
274
|
+
|
275
|
+
<li class="public ">
|
276
|
+
<span class="summary_signature">
|
277
|
+
|
278
|
+
<a href="#template-instance_method" title="#template (instance method)">#<strong>template</strong> ⇒ Object </a>
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
</span>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
<span class="note title readonly">readonly</span>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
298
|
+
|
299
|
+
</li>
|
300
|
+
|
301
|
+
|
302
|
+
<li class="public ">
|
303
|
+
<span class="summary_signature">
|
304
|
+
|
305
|
+
<a href="#unreplaced-instance_method" title="#unreplaced (instance method)">#<strong>unreplaced</strong> ⇒ Object </a>
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
</span>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
<span class="note title readonly">readonly</span>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
325
|
+
|
326
|
+
</li>
|
327
|
+
|
328
|
+
|
329
|
+
<li class="public ">
|
330
|
+
<span class="summary_signature">
|
331
|
+
|
332
|
+
<a href="#unused-instance_method" title="#unused (instance method)">#<strong>unused</strong> ⇒ Object </a>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
</span>
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
<span class="note title readonly">readonly</span>
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
352
|
+
|
353
|
+
</li>
|
354
|
+
|
355
|
+
|
356
|
+
</ul>
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
<h2>
|
363
|
+
Class Method Summary
|
364
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
365
|
+
</h2>
|
366
|
+
|
367
|
+
<ul class="summary">
|
368
|
+
|
369
|
+
<li class="public ">
|
370
|
+
<span class="summary_signature">
|
371
|
+
|
372
|
+
<a href="#build-class_method" title="build (class method)">.<strong>build</strong>(host, template, replacements = {}) ⇒ String </a>
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
</span>
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
<span class="summary_desc"><div class='inline'><p>Convenience method to avoid .new.build.</p>
|
387
|
+
</div></span>
|
388
|
+
|
389
|
+
</li>
|
390
|
+
|
391
|
+
|
392
|
+
</ul>
|
393
|
+
|
394
|
+
<h2>
|
395
|
+
Instance Method Summary
|
396
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
397
|
+
</h2>
|
398
|
+
|
399
|
+
<ul class="summary">
|
400
|
+
|
401
|
+
<li class="public ">
|
402
|
+
<span class="summary_signature">
|
403
|
+
|
404
|
+
<a href="#build-instance_method" title="#build (instance method)">#<strong>build</strong> ⇒ String </a>
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
</span>
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
<span class="summary_desc"><div class='inline'><p>Builds a URI string.</p>
|
419
|
+
</div></span>
|
420
|
+
|
421
|
+
</li>
|
422
|
+
|
423
|
+
|
424
|
+
<li class="public ">
|
425
|
+
<span class="summary_signature">
|
426
|
+
|
427
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(host, template, replacements = {}) ⇒ Builder </a>
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
</span>
|
432
|
+
|
433
|
+
|
434
|
+
<span class="note title constructor">constructor</span>
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
<span class="summary_desc"><div class='inline'><p>Initializes a new Builder.</p>
|
444
|
+
</div></span>
|
445
|
+
|
446
|
+
</li>
|
447
|
+
|
448
|
+
|
449
|
+
</ul>
|
450
|
+
|
451
|
+
|
452
|
+
<div id="constructor_details" class="method_details_list">
|
453
|
+
<h2>Constructor Details</h2>
|
454
|
+
|
455
|
+
<div class="method_details first">
|
456
|
+
<h3 class="signature first" id="initialize-instance_method">
|
457
|
+
|
458
|
+
#<strong>initialize</strong>(host, template, replacements = {}) ⇒ <tt><span class='object_link'><a href="" title="StubRequests::URI::Builder (class)">Builder</a></span></tt>
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
</h3><div class="docstring">
|
465
|
+
<div class="discussion">
|
466
|
+
<p>Initializes a new Builder</p>
|
467
|
+
|
468
|
+
|
469
|
+
</div>
|
470
|
+
</div>
|
471
|
+
<div class="tags">
|
472
|
+
<p class="tag_title">Parameters:</p>
|
473
|
+
<ul class="param">
|
474
|
+
|
475
|
+
<li>
|
476
|
+
|
477
|
+
<span class='name'>host</span>
|
478
|
+
|
479
|
+
|
480
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
—
|
485
|
+
<div class='inline'><p>the URI used to reach the service</p>
|
486
|
+
</div>
|
487
|
+
|
488
|
+
</li>
|
489
|
+
|
490
|
+
<li>
|
491
|
+
|
492
|
+
<span class='name'>template</span>
|
493
|
+
|
494
|
+
|
495
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
—
|
500
|
+
<div class='inline'><p>the endpoint template</p>
|
501
|
+
</div>
|
502
|
+
|
503
|
+
</li>
|
504
|
+
|
505
|
+
<li>
|
506
|
+
|
507
|
+
<span class='name'>replacements</span>
|
508
|
+
|
509
|
+
|
510
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span><Symbol></tt>)</span>
|
511
|
+
|
512
|
+
|
513
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
514
|
+
|
515
|
+
|
516
|
+
—
|
517
|
+
<div class='inline'><p>a list of uri_replacement keys</p>
|
518
|
+
</div>
|
519
|
+
|
520
|
+
</li>
|
521
|
+
|
522
|
+
</ul>
|
523
|
+
|
524
|
+
<p class="tag_title">Since:</p>
|
525
|
+
<ul class="since">
|
526
|
+
|
527
|
+
<li>
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
|
533
|
+
<div class='inline'><p>0.1.0</p>
|
534
|
+
</div>
|
535
|
+
|
536
|
+
</li>
|
537
|
+
|
538
|
+
</ul>
|
539
|
+
|
540
|
+
</div><table class="source_code">
|
541
|
+
<tr>
|
542
|
+
<td>
|
543
|
+
<pre class="lines">
|
544
|
+
|
545
|
+
|
546
|
+
73
|
547
|
+
74
|
548
|
+
75
|
549
|
+
76
|
550
|
+
77
|
551
|
+
78</pre>
|
552
|
+
</td>
|
553
|
+
<td>
|
554
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 73</span>
|
555
|
+
|
556
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span> <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
557
|
+
<span class='ivar'>@host</span> <span class='op'>=</span> <span class='op'>+</span><span class='id identifier rubyid_host'>host</span>
|
558
|
+
<span class='ivar'>@template</span> <span class='op'>=</span> <span class='op'>+</span><span class='id identifier rubyid_template'>template</span>
|
559
|
+
<span class='ivar'>@path</span> <span class='op'>=</span> <span class='op'>+</span><span class='ivar'>@template</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
560
|
+
<span class='ivar'>@replacements</span> <span class='op'>=</span> <span class='id identifier rubyid_replacements'>replacements</span>
|
561
|
+
<span class='kw'>end</span></pre>
|
562
|
+
</td>
|
563
|
+
</tr>
|
564
|
+
</table>
|
565
|
+
</div>
|
566
|
+
|
567
|
+
</div>
|
568
|
+
|
569
|
+
<div id="instance_attr_details" class="attr_details">
|
570
|
+
<h2>Instance Attribute Details</h2>
|
571
|
+
|
572
|
+
|
573
|
+
<span id=""></span>
|
574
|
+
<div class="method_details first">
|
575
|
+
<h3 class="signature first" id="host-instance_method">
|
576
|
+
|
577
|
+
#<strong>host</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
578
|
+
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
|
583
|
+
</h3><div class="docstring">
|
584
|
+
<div class="discussion">
|
585
|
+
|
586
|
+
|
587
|
+
</div>
|
588
|
+
</div>
|
589
|
+
<div class="tags">
|
590
|
+
|
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
|
+
43
|
614
|
+
44
|
615
|
+
45</pre>
|
616
|
+
</td>
|
617
|
+
<td>
|
618
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 43</span>
|
619
|
+
|
620
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_host'>host</span>
|
621
|
+
<span class='ivar'>@host</span>
|
622
|
+
<span class='kw'>end</span></pre>
|
623
|
+
</td>
|
624
|
+
</tr>
|
625
|
+
</table>
|
626
|
+
</div>
|
627
|
+
|
628
|
+
|
629
|
+
<span id=""></span>
|
630
|
+
<div class="method_details ">
|
631
|
+
<h3 class="signature " id="path-instance_method">
|
632
|
+
|
633
|
+
#<strong>path</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
</h3><div class="docstring">
|
640
|
+
<div class="discussion">
|
641
|
+
|
642
|
+
|
643
|
+
</div>
|
644
|
+
</div>
|
645
|
+
<div class="tags">
|
646
|
+
|
647
|
+
<p class="tag_title">Since:</p>
|
648
|
+
<ul class="since">
|
649
|
+
|
650
|
+
<li>
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
<div class='inline'><p>0.1.0</p>
|
657
|
+
</div>
|
658
|
+
|
659
|
+
</li>
|
660
|
+
|
661
|
+
</ul>
|
662
|
+
|
663
|
+
</div><table class="source_code">
|
664
|
+
<tr>
|
665
|
+
<td>
|
666
|
+
<pre class="lines">
|
667
|
+
|
668
|
+
|
669
|
+
51
|
670
|
+
52
|
671
|
+
53</pre>
|
672
|
+
</td>
|
673
|
+
<td>
|
674
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 51</span>
|
675
|
+
|
676
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
|
677
|
+
<span class='ivar'>@path</span>
|
678
|
+
<span class='kw'>end</span></pre>
|
679
|
+
</td>
|
680
|
+
</tr>
|
681
|
+
</table>
|
682
|
+
</div>
|
683
|
+
|
684
|
+
|
685
|
+
<span id=""></span>
|
686
|
+
<div class="method_details ">
|
687
|
+
<h3 class="signature " id="replacements-instance_method">
|
688
|
+
|
689
|
+
#<strong>replacements</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
</h3><div class="docstring">
|
696
|
+
<div class="discussion">
|
697
|
+
|
698
|
+
|
699
|
+
</div>
|
700
|
+
</div>
|
701
|
+
<div class="tags">
|
702
|
+
|
703
|
+
<p class="tag_title">Since:</p>
|
704
|
+
<ul class="since">
|
705
|
+
|
706
|
+
<li>
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
<div class='inline'><p>0.1.0</p>
|
713
|
+
</div>
|
714
|
+
|
715
|
+
</li>
|
716
|
+
|
717
|
+
</ul>
|
718
|
+
|
719
|
+
</div><table class="source_code">
|
720
|
+
<tr>
|
721
|
+
<td>
|
722
|
+
<pre class="lines">
|
723
|
+
|
724
|
+
|
725
|
+
55
|
726
|
+
56
|
727
|
+
57</pre>
|
728
|
+
</td>
|
729
|
+
<td>
|
730
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 55</span>
|
731
|
+
|
732
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_replacements'>replacements</span>
|
733
|
+
<span class='ivar'>@replacements</span>
|
734
|
+
<span class='kw'>end</span></pre>
|
735
|
+
</td>
|
736
|
+
</tr>
|
737
|
+
</table>
|
738
|
+
</div>
|
739
|
+
|
740
|
+
|
741
|
+
<span id=""></span>
|
742
|
+
<div class="method_details ">
|
743
|
+
<h3 class="signature " id="template-instance_method">
|
744
|
+
|
745
|
+
#<strong>template</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
746
|
+
|
747
|
+
|
748
|
+
|
749
|
+
|
750
|
+
|
751
|
+
</h3><div class="docstring">
|
752
|
+
<div class="discussion">
|
753
|
+
|
754
|
+
|
755
|
+
</div>
|
756
|
+
</div>
|
757
|
+
<div class="tags">
|
758
|
+
|
759
|
+
<p class="tag_title">Since:</p>
|
760
|
+
<ul class="since">
|
761
|
+
|
762
|
+
<li>
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
<div class='inline'><p>0.1.0</p>
|
769
|
+
</div>
|
770
|
+
|
771
|
+
</li>
|
772
|
+
|
773
|
+
</ul>
|
774
|
+
|
775
|
+
</div><table class="source_code">
|
776
|
+
<tr>
|
777
|
+
<td>
|
778
|
+
<pre class="lines">
|
779
|
+
|
780
|
+
|
781
|
+
47
|
782
|
+
48
|
783
|
+
49</pre>
|
784
|
+
</td>
|
785
|
+
<td>
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 47</span>
|
787
|
+
|
788
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_template'>template</span>
|
789
|
+
<span class='ivar'>@template</span>
|
790
|
+
<span class='kw'>end</span></pre>
|
791
|
+
</td>
|
792
|
+
</tr>
|
793
|
+
</table>
|
794
|
+
</div>
|
795
|
+
|
796
|
+
|
797
|
+
<span id=""></span>
|
798
|
+
<div class="method_details ">
|
799
|
+
<h3 class="signature " id="unreplaced-instance_method">
|
800
|
+
|
801
|
+
#<strong>unreplaced</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
</h3><div class="docstring">
|
808
|
+
<div class="discussion">
|
809
|
+
|
810
|
+
|
811
|
+
</div>
|
812
|
+
</div>
|
813
|
+
<div class="tags">
|
814
|
+
|
815
|
+
<p class="tag_title">Since:</p>
|
816
|
+
<ul class="since">
|
817
|
+
|
818
|
+
<li>
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
|
824
|
+
<div class='inline'><p>0.1.0</p>
|
825
|
+
</div>
|
826
|
+
|
827
|
+
</li>
|
828
|
+
|
829
|
+
</ul>
|
830
|
+
|
831
|
+
</div><table class="source_code">
|
832
|
+
<tr>
|
833
|
+
<td>
|
834
|
+
<pre class="lines">
|
835
|
+
|
836
|
+
|
837
|
+
63
|
838
|
+
64
|
839
|
+
65</pre>
|
840
|
+
</td>
|
841
|
+
<td>
|
842
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 63</span>
|
843
|
+
|
844
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_unreplaced'>unreplaced</span>
|
845
|
+
<span class='ivar'>@unreplaced</span>
|
846
|
+
<span class='kw'>end</span></pre>
|
847
|
+
</td>
|
848
|
+
</tr>
|
849
|
+
</table>
|
850
|
+
</div>
|
851
|
+
|
852
|
+
|
853
|
+
<span id=""></span>
|
854
|
+
<div class="method_details ">
|
855
|
+
<h3 class="signature " id="unused-instance_method">
|
856
|
+
|
857
|
+
#<strong>unused</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
|
858
|
+
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
</h3><div class="docstring">
|
864
|
+
<div class="discussion">
|
865
|
+
|
866
|
+
|
867
|
+
</div>
|
868
|
+
</div>
|
869
|
+
<div class="tags">
|
870
|
+
|
871
|
+
<p class="tag_title">Since:</p>
|
872
|
+
<ul class="since">
|
873
|
+
|
874
|
+
<li>
|
875
|
+
|
876
|
+
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
<div class='inline'><p>0.1.0</p>
|
881
|
+
</div>
|
882
|
+
|
883
|
+
</li>
|
884
|
+
|
885
|
+
</ul>
|
886
|
+
|
887
|
+
</div><table class="source_code">
|
888
|
+
<tr>
|
889
|
+
<td>
|
890
|
+
<pre class="lines">
|
891
|
+
|
892
|
+
|
893
|
+
59
|
894
|
+
60
|
895
|
+
61</pre>
|
896
|
+
</td>
|
897
|
+
<td>
|
898
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 59</span>
|
899
|
+
|
900
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_unused'>unused</span>
|
901
|
+
<span class='ivar'>@unused</span>
|
902
|
+
<span class='kw'>end</span></pre>
|
903
|
+
</td>
|
904
|
+
</tr>
|
905
|
+
</table>
|
906
|
+
</div>
|
907
|
+
|
908
|
+
</div>
|
909
|
+
|
910
|
+
|
911
|
+
<div id="class_method_details" class="method_details_list">
|
912
|
+
<h2>Class Method Details</h2>
|
913
|
+
|
914
|
+
|
915
|
+
<div class="method_details first">
|
916
|
+
<h3 class="signature first" id="build-class_method">
|
917
|
+
|
918
|
+
.<strong>build</strong>(host, template, replacements = {}) ⇒ <tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>
|
919
|
+
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
|
924
|
+
</h3><div class="docstring">
|
925
|
+
<div class="discussion">
|
926
|
+
<p>Convenience method to avoid .new.build</p>
|
927
|
+
|
928
|
+
|
929
|
+
</div>
|
930
|
+
</div>
|
931
|
+
<div class="tags">
|
932
|
+
<p class="tag_title">Parameters:</p>
|
933
|
+
<ul class="param">
|
934
|
+
|
935
|
+
<li>
|
936
|
+
|
937
|
+
<span class='name'>host</span>
|
938
|
+
|
939
|
+
|
940
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
941
|
+
|
942
|
+
|
943
|
+
|
944
|
+
—
|
945
|
+
<div class='inline'><p>the URI used to reach the service</p>
|
946
|
+
</div>
|
947
|
+
|
948
|
+
</li>
|
949
|
+
|
950
|
+
<li>
|
951
|
+
|
952
|
+
<span class='name'>template</span>
|
953
|
+
|
954
|
+
|
955
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
956
|
+
|
957
|
+
|
958
|
+
|
959
|
+
—
|
960
|
+
<div class='inline'><p>the endpoint template</p>
|
961
|
+
</div>
|
962
|
+
|
963
|
+
</li>
|
964
|
+
|
965
|
+
<li>
|
966
|
+
|
967
|
+
<span class='name'>replacements</span>
|
968
|
+
|
969
|
+
|
970
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span><Symbol></tt>)</span>
|
971
|
+
|
972
|
+
|
973
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
974
|
+
|
975
|
+
|
976
|
+
—
|
977
|
+
<div class='inline'><p>a list of uri_replacement keys</p>
|
978
|
+
</div>
|
979
|
+
|
980
|
+
</li>
|
981
|
+
|
982
|
+
</ul>
|
983
|
+
|
984
|
+
<p class="tag_title">Returns:</p>
|
985
|
+
<ul class="return">
|
986
|
+
|
987
|
+
<li>
|
988
|
+
|
989
|
+
|
990
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
991
|
+
|
992
|
+
|
993
|
+
|
994
|
+
—
|
995
|
+
<div class='inline'><p>a validated URI string</p>
|
996
|
+
</div>
|
997
|
+
|
998
|
+
</li>
|
999
|
+
|
1000
|
+
</ul>
|
1001
|
+
<p class="tag_title">Raises:</p>
|
1002
|
+
<ul class="raise">
|
1003
|
+
|
1004
|
+
<li>
|
1005
|
+
|
1006
|
+
|
1007
|
+
<span class='type'>(<tt><span class='object_link'><a href="../UriSegmentMismatch.html" title="StubRequests::UriSegmentMismatch (class)">UriSegmentMismatch</a></span></tt>)</span>
|
1008
|
+
|
1009
|
+
|
1010
|
+
|
1011
|
+
—
|
1012
|
+
<div class='inline'><p>when there are unused URI segments</p>
|
1013
|
+
</div>
|
1014
|
+
|
1015
|
+
</li>
|
1016
|
+
|
1017
|
+
<li>
|
1018
|
+
|
1019
|
+
|
1020
|
+
<span class='type'>(<tt><span class='object_link'><a href="../UriSegmentMismatch.html" title="StubRequests::UriSegmentMismatch (class)">UriSegmentMismatch</a></span></tt>)</span>
|
1021
|
+
|
1022
|
+
|
1023
|
+
|
1024
|
+
—
|
1025
|
+
<div class='inline'><p>when the template have unplaced URI segments</p>
|
1026
|
+
</div>
|
1027
|
+
|
1028
|
+
</li>
|
1029
|
+
|
1030
|
+
</ul>
|
1031
|
+
<p class="tag_title">Since:</p>
|
1032
|
+
<ul class="since">
|
1033
|
+
|
1034
|
+
<li>
|
1035
|
+
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
<div class='inline'><p>0.1.0</p>
|
1041
|
+
</div>
|
1042
|
+
|
1043
|
+
</li>
|
1044
|
+
|
1045
|
+
</ul>
|
1046
|
+
|
1047
|
+
</div><table class="source_code">
|
1048
|
+
<tr>
|
1049
|
+
<td>
|
1050
|
+
<pre class="lines">
|
1051
|
+
|
1052
|
+
|
1053
|
+
36
|
1054
|
+
37
|
1055
|
+
38</pre>
|
1056
|
+
</td>
|
1057
|
+
<td>
|
1058
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 36</span>
|
1059
|
+
|
1060
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span> <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1061
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span>
|
1062
|
+
<span class='kw'>end</span></pre>
|
1063
|
+
</td>
|
1064
|
+
</tr>
|
1065
|
+
</table>
|
1066
|
+
</div>
|
1067
|
+
|
1068
|
+
</div>
|
1069
|
+
|
1070
|
+
<div id="instance_method_details" class="method_details_list">
|
1071
|
+
<h2>Instance Method Details</h2>
|
1072
|
+
|
1073
|
+
|
1074
|
+
<div class="method_details first">
|
1075
|
+
<h3 class="signature first" id="build-instance_method">
|
1076
|
+
|
1077
|
+
#<strong>build</strong> ⇒ <tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
</h3><div class="docstring">
|
1084
|
+
<div class="discussion">
|
1085
|
+
<p>Builds a URI string</p>
|
1086
|
+
|
1087
|
+
|
1088
|
+
</div>
|
1089
|
+
</div>
|
1090
|
+
<div class="tags">
|
1091
|
+
|
1092
|
+
<p class="tag_title">Returns:</p>
|
1093
|
+
<ul class="return">
|
1094
|
+
|
1095
|
+
<li>
|
1096
|
+
|
1097
|
+
|
1098
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>
|
1099
|
+
|
1100
|
+
|
1101
|
+
|
1102
|
+
—
|
1103
|
+
<div class='inline'><p>a validated URI string</p>
|
1104
|
+
</div>
|
1105
|
+
|
1106
|
+
</li>
|
1107
|
+
|
1108
|
+
</ul>
|
1109
|
+
<p class="tag_title">Raises:</p>
|
1110
|
+
<ul class="raise">
|
1111
|
+
|
1112
|
+
<li>
|
1113
|
+
|
1114
|
+
|
1115
|
+
<span class='type'>(<tt><span class='object_link'><a href="../UriSegmentMismatch.html" title="StubRequests::UriSegmentMismatch (class)">UriSegmentMismatch</a></span></tt>)</span>
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
—
|
1120
|
+
<div class='inline'><p>when there are unused URI segments</p>
|
1121
|
+
</div>
|
1122
|
+
|
1123
|
+
</li>
|
1124
|
+
|
1125
|
+
<li>
|
1126
|
+
|
1127
|
+
|
1128
|
+
<span class='type'>(<tt><span class='object_link'><a href="../UriSegmentMismatch.html" title="StubRequests::UriSegmentMismatch (class)">UriSegmentMismatch</a></span></tt>)</span>
|
1129
|
+
|
1130
|
+
|
1131
|
+
|
1132
|
+
—
|
1133
|
+
<div class='inline'><p>when the template have unplaced URI segments</p>
|
1134
|
+
</div>
|
1135
|
+
|
1136
|
+
</li>
|
1137
|
+
|
1138
|
+
</ul>
|
1139
|
+
<p class="tag_title">Since:</p>
|
1140
|
+
<ul class="since">
|
1141
|
+
|
1142
|
+
<li>
|
1143
|
+
|
1144
|
+
|
1145
|
+
|
1146
|
+
|
1147
|
+
|
1148
|
+
<div class='inline'><p>0.1.0</p>
|
1149
|
+
</div>
|
1150
|
+
|
1151
|
+
</li>
|
1152
|
+
|
1153
|
+
</ul>
|
1154
|
+
|
1155
|
+
</div><table class="source_code">
|
1156
|
+
<tr>
|
1157
|
+
<td>
|
1158
|
+
<pre class="lines">
|
1159
|
+
|
1160
|
+
|
1161
|
+
89
|
1162
|
+
90
|
1163
|
+
91
|
1164
|
+
92
|
1165
|
+
93
|
1166
|
+
94</pre>
|
1167
|
+
</td>
|
1168
|
+
<td>
|
1169
|
+
<pre class="code"><span class="info file"># File 'lib/stub_requests/uri/builder.rb', line 89</span>
|
1170
|
+
|
1171
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build'>build</span>
|
1172
|
+
<span class='id identifier rubyid_build_uri'>build_uri</span>
|
1173
|
+
<span class='id identifier rubyid_run_validations'>run_validations</span>
|
1174
|
+
|
1175
|
+
<span class='id identifier rubyid_uri'>uri</span>
|
1176
|
+
<span class='kw'>end</span></pre>
|
1177
|
+
</td>
|
1178
|
+
</tr>
|
1179
|
+
</table>
|
1180
|
+
</div>
|
1181
|
+
|
1182
|
+
</div>
|
1183
|
+
|
1184
|
+
</div>
|
1185
|
+
|
1186
|
+
<div id="footer">
|
1187
|
+
Generated on Fri Feb 1 19:57:30 2019 by
|
1188
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1189
|
+
0.9.18 (ruby-2.5.3).
|
1190
|
+
</div>
|
1191
|
+
|
1192
|
+
</div>
|
1193
|
+
</body>
|
1194
|
+
</html>
|