ngrok-api 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ci.yml +21 -0
  3. data/.gitignore +13 -0
  4. data/.rubocop.yml +28 -0
  5. data/.rubocop_airbnb.yml +2 -0
  6. data/.simplecov +1 -0
  7. data/Gemfile +33 -0
  8. data/Guardfile +16 -0
  9. data/README.md +61 -0
  10. data/Rakefile +7 -0
  11. data/doc/NgrokAPI/Client.html +542 -0
  12. data/doc/NgrokAPI/Error.html +305 -0
  13. data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
  14. data/doc/NgrokAPI/Errors.html +115 -0
  15. data/doc/NgrokAPI/HttpClient.html +1104 -0
  16. data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
  17. data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
  18. data/doc/NgrokAPI/Models/Listable.html +934 -0
  19. data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
  20. data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
  21. data/doc/NgrokAPI/Models.html +117 -0
  22. data/doc/NgrokAPI/PagedIterator.html +631 -0
  23. data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
  24. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
  25. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
  26. data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
  27. data/doc/NgrokAPI/Services.html +117 -0
  28. data/doc/NgrokAPI.html +157 -0
  29. data/doc/_index.html +309 -0
  30. data/doc/class_list.html +51 -0
  31. data/doc/css/common.css +1 -0
  32. data/doc/css/full_list.css +58 -0
  33. data/doc/css/style.css +497 -0
  34. data/doc/file.README.html +126 -0
  35. data/doc/file_list.html +56 -0
  36. data/doc/frames.html +17 -0
  37. data/doc/index.html +126 -0
  38. data/doc/js/app.js +314 -0
  39. data/doc/js/full_list.js +216 -0
  40. data/doc/js/jquery.js +4 -0
  41. data/doc/method_list.html +1227 -0
  42. data/doc/top-level-namespace.html +110 -0
  43. data/docs/NgrokAPI/Client.html +542 -0
  44. data/docs/NgrokAPI/Error.html +305 -0
  45. data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
  46. data/docs/NgrokAPI/Errors.html +115 -0
  47. data/docs/NgrokAPI/HttpClient.html +1104 -0
  48. data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
  49. data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
  50. data/docs/NgrokAPI/Models/Listable.html +934 -0
  51. data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
  52. data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
  53. data/docs/NgrokAPI/Models.html +117 -0
  54. data/docs/NgrokAPI/PagedIterator.html +631 -0
  55. data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
  56. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
  57. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
  58. data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
  59. data/docs/NgrokAPI/Services.html +117 -0
  60. data/docs/NgrokAPI.html +157 -0
  61. data/docs/_index.html +309 -0
  62. data/docs/class_list.html +51 -0
  63. data/docs/css/common.css +1 -0
  64. data/docs/css/full_list.css +58 -0
  65. data/docs/css/style.css +497 -0
  66. data/docs/file.README.html +126 -0
  67. data/docs/file_list.html +56 -0
  68. data/docs/frames.html +17 -0
  69. data/docs/index.html +126 -0
  70. data/docs/js/app.js +314 -0
  71. data/docs/js/full_list.js +216 -0
  72. data/docs/js/jquery.js +4 -0
  73. data/docs/method_list.html +1227 -0
  74. data/docs/top-level-namespace.html +110 -0
  75. data/lib/ngrokapi/client.rb +49 -0
  76. data/lib/ngrokapi/error.rb +14 -0
  77. data/lib/ngrokapi/errors/not_found_error.rb +16 -0
  78. data/lib/ngrokapi/http_client.rb +132 -0
  79. data/lib/ngrokapi/models/api_key.rb +64 -0
  80. data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
  81. data/lib/ngrokapi/models/listable.rb +42 -0
  82. data/lib/ngrokapi/models/reserved_domain.rb +211 -0
  83. data/lib/ngrokapi/models/tls_certificate.rb +62 -0
  84. data/lib/ngrokapi/paged_iterator.rb +40 -0
  85. data/lib/ngrokapi/services/api_keys_client.rb +144 -0
  86. data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
  87. data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
  88. data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
  89. data/lib/ngrokapi/version.rb +7 -0
  90. data/lib/ngrokapi.rb +13 -0
  91. data/ngrok-api.gemspec +27 -0
  92. data/spec/ngrokapi/client_spec.rb +33 -0
  93. data/spec/ngrokapi/http_client_spec.rb +75 -0
  94. data/spec/ngrokapi/models/api_key_spec.rb +43 -0
  95. data/spec/ngrokapi/models/listable_spec.rb +43 -0
  96. data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
  97. data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
  98. data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
  99. data/spec/spec_helper.rb +80 -0
  100. metadata +144 -0
@@ -0,0 +1,1104 @@
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: NgrokAPI::HttpClient
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NgrokAPI::HttpClient";
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 (H)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
41
+ &raquo;
42
+ <span class="title">HttpClient</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: NgrokAPI::HttpClient
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NgrokAPI::HttpClient</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/ngrokapi/http_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Low-level api client for communicating with Ngrok&#39;s HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute api_key.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#base_url-instance_method" title="#base_url (instance method)">#<strong>base_url</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns the value of attribute base_url.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ </ul>
179
+
180
+
181
+
182
+
183
+
184
+ <h2>
185
+ Instance Method Summary
186
+ <small><a href="#" class="summary_toggle">collapse</a></small>
187
+ </h2>
188
+
189
+ <ul class="summary">
190
+
191
+ <li class="public ">
192
+ <span class="summary_signature">
193
+
194
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, danger: false) &#x21d2; nil </a>
195
+
196
+
197
+
198
+ </span>
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <span class="summary_desc"><div class='inline'>
209
+ <p>Make a DELETE request to a given URI.</p>
210
+ </div></span>
211
+
212
+ </li>
213
+
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(path, danger: false, data: {}) &#x21d2; json </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <span class="summary_desc"><div class='inline'>
233
+ <p>Make a GET request to a given URI with optional data.</p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;) &#x21d2; HttpClient </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+ <span class="note title constructor">constructor</span>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>A new instance of HttpClient.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, path: nil, url: nil) &#x21d2; json </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <span class="summary_desc"><div class='inline'>
283
+ <p>Make a GET request.</p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ <li class="public ">
290
+ <span class="summary_signature">
291
+
292
+ <a href="#patch-instance_method" title="#patch (instance method)">#<strong>patch</strong>(path, danger: false, data: {}) &#x21d2; json </a>
293
+
294
+
295
+
296
+ </span>
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ <span class="summary_desc"><div class='inline'>
307
+ <p>Make a PATCH request to a given URI with optional data.</p>
308
+ </div></span>
309
+
310
+ </li>
311
+
312
+
313
+ <li class="public ">
314
+ <span class="summary_signature">
315
+
316
+ <a href="#post-instance_method" title="#post (instance method)">#<strong>post</strong>(path, danger: false, data: {}) &#x21d2; json </a>
317
+
318
+
319
+
320
+ </span>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ <span class="summary_desc"><div class='inline'>
331
+ <p>Make a POST request to a given URI with optional data.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ </ul>
338
+
339
+
340
+ <div id="constructor_details" class="method_details_list">
341
+ <h2>Constructor Details</h2>
342
+
343
+ <div class="method_details first">
344
+ <h3 class="signature first" id="initialize-instance_method">
345
+
346
+ #<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></tt>
347
+
348
+
349
+
350
+
351
+
352
+ </h3><div class="docstring">
353
+ <div class="discussion">
354
+
355
+ <p>Returns a new instance of HttpClient.</p>
356
+
357
+
358
+ </div>
359
+ </div>
360
+ <div class="tags">
361
+
362
+
363
+ </div><table class="source_code">
364
+ <tr>
365
+ <td>
366
+ <pre class="lines">
367
+
368
+
369
+ 11
370
+ 12
371
+ 13
372
+ 14
373
+ 15
374
+ 16
375
+ 17</pre>
376
+ </td>
377
+ <td>
378
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 11</span>
379
+
380
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
381
+ <span class='label'>api_key:</span><span class='comma'>,</span>
382
+ <span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>&#39;</span></span>
383
+ <span class='rparen'>)</span>
384
+ <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
385
+ <span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_base_url'>base_url</span>
386
+ <span class='kw'>end</span></pre>
387
+ </td>
388
+ </tr>
389
+ </table>
390
+ </div>
391
+
392
+ </div>
393
+
394
+ <div id="instance_attr_details" class="attr_details">
395
+ <h2>Instance Attribute Details</h2>
396
+
397
+
398
+ <span id=""></span>
399
+ <div class="method_details first">
400
+ <h3 class="signature first" id="api_key-instance_method">
401
+
402
+ #<strong>api_key</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
403
+
404
+
405
+
406
+
407
+
408
+ </h3><div class="docstring">
409
+ <div class="discussion">
410
+
411
+ <p>Returns the value of attribute api_key.</p>
412
+
413
+
414
+ </div>
415
+ </div>
416
+ <div class="tags">
417
+
418
+
419
+ </div><table class="source_code">
420
+ <tr>
421
+ <td>
422
+ <pre class="lines">
423
+
424
+
425
+ 8
426
+ 9
427
+ 10</pre>
428
+ </td>
429
+ <td>
430
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 8</span>
431
+
432
+ <span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
433
+ <span class='ivar'>@api_key</span>
434
+ <span class='kw'>end</span></pre>
435
+ </td>
436
+ </tr>
437
+ </table>
438
+ </div>
439
+
440
+
441
+ <span id=""></span>
442
+ <div class="method_details ">
443
+ <h3 class="signature " id="base_url-instance_method">
444
+
445
+ #<strong>base_url</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
446
+
447
+
448
+
449
+
450
+
451
+ </h3><div class="docstring">
452
+ <div class="discussion">
453
+
454
+ <p>Returns the value of attribute base_url.</p>
455
+
456
+
457
+ </div>
458
+ </div>
459
+ <div class="tags">
460
+
461
+
462
+ </div><table class="source_code">
463
+ <tr>
464
+ <td>
465
+ <pre class="lines">
466
+
467
+
468
+ 8
469
+ 9
470
+ 10</pre>
471
+ </td>
472
+ <td>
473
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 8</span>
474
+
475
+ <span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
476
+ <span class='ivar'>@base_url</span>
477
+ <span class='kw'>end</span></pre>
478
+ </td>
479
+ </tr>
480
+ </table>
481
+ </div>
482
+
483
+ </div>
484
+
485
+
486
+ <div id="instance_method_details" class="method_details_list">
487
+ <h2>Instance Method Details</h2>
488
+
489
+
490
+ <div class="method_details first">
491
+ <h3 class="signature first" id="delete-instance_method">
492
+
493
+ #<strong>delete</strong>(path, danger: false) &#x21d2; <tt>nil</tt>
494
+
495
+
496
+
497
+
498
+
499
+ </h3><div class="docstring">
500
+ <div class="discussion">
501
+
502
+ <p>Make a DELETE request to a given URI</p>
503
+
504
+
505
+ </div>
506
+ </div>
507
+ <div class="tags">
508
+ <p class="tag_title">Parameters:</p>
509
+ <ul class="param">
510
+
511
+ <li>
512
+
513
+ <span class='name'>path</span>
514
+
515
+
516
+ <span class='type'>(<tt>string</tt>)</span>
517
+
518
+
519
+
520
+ &mdash;
521
+ <div class='inline'>
522
+ <p>URL resource path.</p>
523
+ </div>
524
+
525
+ </li>
526
+
527
+ <li>
528
+
529
+ <span class='name'>danger</span>
530
+
531
+
532
+ <span class='type'>(<tt>boolean</tt>)</span>
533
+
534
+
535
+ <em class="default">(defaults to: <tt>false</tt>)</em>
536
+
537
+
538
+ &mdash;
539
+ <div class='inline'>
540
+ <p>determine if we should throw an exception on 404 or not</p>
541
+ </div>
542
+
543
+ </li>
544
+
545
+ </ul>
546
+
547
+ <p class="tag_title">Returns:</p>
548
+ <ul class="return">
549
+
550
+ <li>
551
+
552
+
553
+ <span class='type'>(<tt>nil</tt>)</span>
554
+
555
+
556
+
557
+ </li>
558
+
559
+ </ul>
560
+
561
+ </div><table class="source_code">
562
+ <tr>
563
+ <td>
564
+ <pre class="lines">
565
+
566
+
567
+ 25
568
+ 26
569
+ 27
570
+ 28
571
+ 29</pre>
572
+ </td>
573
+ <td>
574
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 25</span>
575
+
576
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='rparen'>)</span>
577
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
578
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Delete</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
579
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
580
+ <span class='kw'>end</span></pre>
581
+ </td>
582
+ </tr>
583
+ </table>
584
+ </div>
585
+
586
+ <div class="method_details ">
587
+ <h3 class="signature " id="get-instance_method">
588
+
589
+ #<strong>get</strong>(path, danger: false, data: {}) &#x21d2; <tt>json</tt>
590
+
591
+
592
+
593
+
594
+
595
+ </h3><div class="docstring">
596
+ <div class="discussion">
597
+
598
+ <p>Make a GET request to a given URI with optional data</p>
599
+
600
+
601
+ </div>
602
+ </div>
603
+ <div class="tags">
604
+ <p class="tag_title">Parameters:</p>
605
+ <ul class="param">
606
+
607
+ <li>
608
+
609
+ <span class='name'>path</span>
610
+
611
+
612
+ <span class='type'>(<tt>string</tt>)</span>
613
+
614
+
615
+
616
+ &mdash;
617
+ <div class='inline'>
618
+ <p>URL resource path</p>
619
+ </div>
620
+
621
+ </li>
622
+
623
+ <li>
624
+
625
+ <span class='name'>danger</span>
626
+
627
+
628
+ <span class='type'>(<tt>boolean</tt>)</span>
629
+
630
+
631
+ <em class="default">(defaults to: <tt>false</tt>)</em>
632
+
633
+
634
+ &mdash;
635
+ <div class='inline'>
636
+ <p>determine if we should throw an exception on 404 or not</p>
637
+ </div>
638
+
639
+ </li>
640
+
641
+ <li>
642
+
643
+ <span class='name'>data</span>
644
+
645
+
646
+ <span class='type'>(<tt>hash</tt>)</span>
647
+
648
+
649
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
650
+
651
+
652
+ &mdash;
653
+ <div class='inline'>
654
+ <p>hash which will be converted to query parameters or form data</p>
655
+ </div>
656
+
657
+ </li>
658
+
659
+ </ul>
660
+
661
+ <p class="tag_title">Returns:</p>
662
+ <ul class="return">
663
+
664
+ <li>
665
+
666
+
667
+ <span class='type'>(<tt>json</tt>)</span>
668
+
669
+
670
+
671
+ &mdash;
672
+ <div class='inline'>
673
+ <p>response body</p>
674
+ </div>
675
+
676
+ </li>
677
+
678
+ </ul>
679
+
680
+ </div><table class="source_code">
681
+ <tr>
682
+ <td>
683
+ <pre class="lines">
684
+
685
+
686
+ 38
687
+ 39
688
+ 40
689
+ 41
690
+ 42</pre>
691
+ </td>
692
+ <td>
693
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 38</span>
694
+
695
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
696
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
697
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
698
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
699
+ <span class='kw'>end</span></pre>
700
+ </td>
701
+ </tr>
702
+ </table>
703
+ </div>
704
+
705
+ <div class="method_details ">
706
+ <h3 class="signature " id="list-instance_method">
707
+
708
+ #<strong>list</strong>(before_id: nil, limit: nil, path: nil, url: nil) &#x21d2; <tt>json</tt>
709
+
710
+
711
+
712
+
713
+
714
+ </h3><div class="docstring">
715
+ <div class="discussion">
716
+
717
+ <p>Make a GET request</p>
718
+
719
+
720
+ </div>
721
+ </div>
722
+ <div class="tags">
723
+ <p class="tag_title">Parameters:</p>
724
+ <ul class="param">
725
+
726
+ <li>
727
+
728
+ <span class='name'>before_id</span>
729
+
730
+
731
+ <span class='type'>(<tt>string</tt>)</span>
732
+
733
+
734
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
735
+
736
+
737
+ &mdash;
738
+ <div class='inline'>
739
+ <p>URL resource path</p>
740
+ </div>
741
+
742
+ </li>
743
+
744
+ <li>
745
+
746
+ <span class='name'>limit</span>
747
+
748
+
749
+ <span class='type'>(<tt>integer</tt>)</span>
750
+
751
+
752
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
753
+
754
+
755
+ &mdash;
756
+ <div class='inline'>
757
+ <p>URL resource path</p>
758
+ </div>
759
+
760
+ </li>
761
+
762
+ <li>
763
+
764
+ <span class='name'>path</span>
765
+
766
+
767
+ <span class='type'>(<tt>string</tt>)</span>
768
+
769
+
770
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
771
+
772
+
773
+ &mdash;
774
+ <div class='inline'>
775
+ <p>resource path, mutually exclusive with url</p>
776
+ </div>
777
+
778
+ </li>
779
+
780
+ <li>
781
+
782
+ <span class='name'>url</span>
783
+
784
+
785
+ <span class='type'>(<tt>string</tt>)</span>
786
+
787
+
788
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
789
+
790
+
791
+ &mdash;
792
+ <div class='inline'>
793
+ <p>Full URL of the resource, mutually exclusive with path</p>
794
+ </div>
795
+
796
+ </li>
797
+
798
+ </ul>
799
+
800
+ <p class="tag_title">Returns:</p>
801
+ <ul class="return">
802
+
803
+ <li>
804
+
805
+
806
+ <span class='type'>(<tt>json</tt>)</span>
807
+
808
+
809
+
810
+ &mdash;
811
+ <div class='inline'>
812
+ <p>response body</p>
813
+ </div>
814
+
815
+ </li>
816
+
817
+ </ul>
818
+
819
+ </div><table class="source_code">
820
+ <tr>
821
+ <td>
822
+ <pre class="lines">
823
+
824
+
825
+ 52
826
+ 53
827
+ 54
828
+ 55
829
+ 56
830
+ 57
831
+ 58
832
+ 59
833
+ 60
834
+ 61</pre>
835
+ </td>
836
+ <td>
837
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 52</span>
838
+
839
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
840
+ <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
841
+ <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
842
+ <span class='kw'>else</span>
843
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
844
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:before_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_before_id'>before_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_before_id'>before_id</span>
845
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_limit'>limit</span> <span class='kw'>if</span> <span class='id identifier rubyid_limit'>limit</span>
846
+ <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
847
+ <span class='kw'>end</span>
848
+ <span class='kw'>end</span></pre>
849
+ </td>
850
+ </tr>
851
+ </table>
852
+ </div>
853
+
854
+ <div class="method_details ">
855
+ <h3 class="signature " id="patch-instance_method">
856
+
857
+ #<strong>patch</strong>(path, danger: false, data: {}) &#x21d2; <tt>json</tt>
858
+
859
+
860
+
861
+
862
+
863
+ </h3><div class="docstring">
864
+ <div class="discussion">
865
+
866
+ <p>Make a PATCH request to a given URI with optional data</p>
867
+
868
+
869
+ </div>
870
+ </div>
871
+ <div class="tags">
872
+ <p class="tag_title">Parameters:</p>
873
+ <ul class="param">
874
+
875
+ <li>
876
+
877
+ <span class='name'>path</span>
878
+
879
+
880
+ <span class='type'>(<tt>string</tt>)</span>
881
+
882
+
883
+
884
+ &mdash;
885
+ <div class='inline'>
886
+ <p>URL resource path</p>
887
+ </div>
888
+
889
+ </li>
890
+
891
+ <li>
892
+
893
+ <span class='name'>danger</span>
894
+
895
+
896
+ <span class='type'>(<tt>boolean</tt>)</span>
897
+
898
+
899
+ <em class="default">(defaults to: <tt>false</tt>)</em>
900
+
901
+
902
+ &mdash;
903
+ <div class='inline'>
904
+ <p>determine if we should throw an exception on 404 or not</p>
905
+ </div>
906
+
907
+ </li>
908
+
909
+ <li>
910
+
911
+ <span class='name'>data</span>
912
+
913
+
914
+ <span class='type'>(<tt>hash</tt>)</span>
915
+
916
+
917
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
918
+
919
+
920
+ &mdash;
921
+ <div class='inline'>
922
+ <p>hash which will be converted to query parameters or form data</p>
923
+ </div>
924
+
925
+ </li>
926
+
927
+ </ul>
928
+
929
+ <p class="tag_title">Returns:</p>
930
+ <ul class="return">
931
+
932
+ <li>
933
+
934
+
935
+ <span class='type'>(<tt>json</tt>)</span>
936
+
937
+
938
+
939
+ &mdash;
940
+ <div class='inline'>
941
+ <p>response body</p>
942
+ </div>
943
+
944
+ </li>
945
+
946
+ </ul>
947
+
948
+ </div><table class="source_code">
949
+ <tr>
950
+ <td>
951
+ <pre class="lines">
952
+
953
+
954
+ 70
955
+ 71
956
+ 72
957
+ 73
958
+ 74</pre>
959
+ </td>
960
+ <td>
961
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 70</span>
962
+
963
+ <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'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
964
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
965
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Patch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
966
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
967
+ <span class='kw'>end</span></pre>
968
+ </td>
969
+ </tr>
970
+ </table>
971
+ </div>
972
+
973
+ <div class="method_details ">
974
+ <h3 class="signature " id="post-instance_method">
975
+
976
+ #<strong>post</strong>(path, danger: false, data: {}) &#x21d2; <tt>json</tt>
977
+
978
+
979
+
980
+
981
+
982
+ </h3><div class="docstring">
983
+ <div class="discussion">
984
+
985
+ <p>Make a POST request to a given URI with optional data</p>
986
+
987
+
988
+ </div>
989
+ </div>
990
+ <div class="tags">
991
+ <p class="tag_title">Parameters:</p>
992
+ <ul class="param">
993
+
994
+ <li>
995
+
996
+ <span class='name'>path</span>
997
+
998
+
999
+ <span class='type'>(<tt>string</tt>)</span>
1000
+
1001
+
1002
+
1003
+ &mdash;
1004
+ <div class='inline'>
1005
+ <p>URL resource path</p>
1006
+ </div>
1007
+
1008
+ </li>
1009
+
1010
+ <li>
1011
+
1012
+ <span class='name'>danger</span>
1013
+
1014
+
1015
+ <span class='type'>(<tt>boolean</tt>)</span>
1016
+
1017
+
1018
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1019
+
1020
+
1021
+ &mdash;
1022
+ <div class='inline'>
1023
+ <p>determine if we should throw an exception on 404 or not</p>
1024
+ </div>
1025
+
1026
+ </li>
1027
+
1028
+ <li>
1029
+
1030
+ <span class='name'>data</span>
1031
+
1032
+
1033
+ <span class='type'>(<tt>hash</tt>)</span>
1034
+
1035
+
1036
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1037
+
1038
+
1039
+ &mdash;
1040
+ <div class='inline'>
1041
+ <p>hash which will be converted to query parameters or form data</p>
1042
+ </div>
1043
+
1044
+ </li>
1045
+
1046
+ </ul>
1047
+
1048
+ <p class="tag_title">Returns:</p>
1049
+ <ul class="return">
1050
+
1051
+ <li>
1052
+
1053
+
1054
+ <span class='type'>(<tt>json</tt>)</span>
1055
+
1056
+
1057
+
1058
+ &mdash;
1059
+ <div class='inline'>
1060
+ <p>response body</p>
1061
+ </div>
1062
+
1063
+ </li>
1064
+
1065
+ </ul>
1066
+
1067
+ </div><table class="source_code">
1068
+ <tr>
1069
+ <td>
1070
+ <pre class="lines">
1071
+
1072
+
1073
+ 83
1074
+ 84
1075
+ 85
1076
+ 86
1077
+ 87</pre>
1078
+ </td>
1079
+ <td>
1080
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 83</span>
1081
+
1082
+ <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1083
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1084
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
1085
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
1086
+ <span class='kw'>end</span></pre>
1087
+ </td>
1088
+ </tr>
1089
+ </table>
1090
+ </div>
1091
+
1092
+ </div>
1093
+
1094
+ </div>
1095
+
1096
+ <div id="footer">
1097
+ Generated on Fri Sep 24 19:20:29 2021 by
1098
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1099
+ 0.9.26 (ruby-3.0.1).
1100
+ </div>
1101
+
1102
+ </div>
1103
+ </body>
1104
+ </html>