ngrok-api 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +21 -0
- data/.gitignore +13 -0
- data/.rubocop.yml +28 -0
- data/.rubocop_airbnb.yml +2 -0
- data/.simplecov +1 -0
- data/Gemfile +33 -0
- data/Guardfile +16 -0
- data/README.md +61 -0
- data/Rakefile +7 -0
- data/doc/NgrokAPI/Client.html +542 -0
- data/doc/NgrokAPI/Error.html +305 -0
- data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
- data/doc/NgrokAPI/Errors.html +115 -0
- data/doc/NgrokAPI/HttpClient.html +1104 -0
- data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
- data/doc/NgrokAPI/Models/Listable.html +934 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
- data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
- data/doc/NgrokAPI/Models.html +117 -0
- data/doc/NgrokAPI/PagedIterator.html +631 -0
- data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
- data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
- data/doc/NgrokAPI/Services.html +117 -0
- data/doc/NgrokAPI.html +157 -0
- data/doc/_index.html +309 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +126 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +126 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1227 -0
- data/doc/top-level-namespace.html +110 -0
- data/docs/NgrokAPI/Client.html +542 -0
- data/docs/NgrokAPI/Error.html +305 -0
- data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
- data/docs/NgrokAPI/Errors.html +115 -0
- data/docs/NgrokAPI/HttpClient.html +1104 -0
- data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
- data/docs/NgrokAPI/Models/Listable.html +934 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
- data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
- data/docs/NgrokAPI/Models.html +117 -0
- data/docs/NgrokAPI/PagedIterator.html +631 -0
- data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
- data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
- data/docs/NgrokAPI/Services.html +117 -0
- data/docs/NgrokAPI.html +157 -0
- data/docs/_index.html +309 -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 +497 -0
- data/docs/file.README.html +126 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +126 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1227 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/ngrokapi/client.rb +49 -0
- data/lib/ngrokapi/error.rb +14 -0
- data/lib/ngrokapi/errors/not_found_error.rb +16 -0
- data/lib/ngrokapi/http_client.rb +132 -0
- data/lib/ngrokapi/models/api_key.rb +64 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
- data/lib/ngrokapi/models/listable.rb +42 -0
- data/lib/ngrokapi/models/reserved_domain.rb +211 -0
- data/lib/ngrokapi/models/tls_certificate.rb +62 -0
- data/lib/ngrokapi/paged_iterator.rb +40 -0
- data/lib/ngrokapi/services/api_keys_client.rb +144 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
- data/lib/ngrokapi/version.rb +7 -0
- data/lib/ngrokapi.rb +13 -0
- data/ngrok-api.gemspec +27 -0
- data/spec/ngrokapi/client_spec.rb +33 -0
- data/spec/ngrokapi/http_client_spec.rb +75 -0
- data/spec/ngrokapi/models/api_key_spec.rb +43 -0
- data/spec/ngrokapi/models/listable_spec.rb +43 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
- data/spec/spec_helper.rb +80 -0
- metadata +144 -0
|
@@ -0,0 +1,631 @@
|
|
|
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::PagedIterator
|
|
8
|
+
|
|
9
|
+
— 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::PagedIterator";
|
|
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 (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">PagedIterator</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::PagedIterator
|
|
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::PagedIterator</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/paged_iterator.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Low level class which allows the user to iterate through the results of a list API call</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="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ 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 client.</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#list_property-instance_method" title="#list_property (instance method)">#<strong>list_property</strong> ⇒ 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 list_property.</p>
|
|
173
|
+
</div></span>
|
|
174
|
+
|
|
175
|
+
</li>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#n-instance_method" title="#n (instance method)">#<strong>n</strong> ⇒ Object </a>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</span>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'>
|
|
199
|
+
<p>Returns the value of attribute n.</p>
|
|
200
|
+
</div></span>
|
|
201
|
+
|
|
202
|
+
</li>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#page-instance_method" title="#page (instance method)">#<strong>page</strong> ⇒ Object </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<span class="summary_desc"><div class='inline'>
|
|
226
|
+
<p>Returns the value of attribute page.</p>
|
|
227
|
+
</div></span>
|
|
228
|
+
|
|
229
|
+
</li>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</ul>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<h2>
|
|
239
|
+
Instance Method Summary
|
|
240
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
241
|
+
</h2>
|
|
242
|
+
|
|
243
|
+
<ul class="summary">
|
|
244
|
+
|
|
245
|
+
<li class="public ">
|
|
246
|
+
<span class="summary_signature">
|
|
247
|
+
|
|
248
|
+
<a href="#get_next-instance_method" title="#get_next (instance method)">#<strong>get_next</strong> ⇒ object </a>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</span>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<span class="summary_desc"><div class='inline'>
|
|
263
|
+
<p>Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.</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>(client:, page:, list_property:) ⇒ PagedIterator </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'>
|
|
289
|
+
<p>A new instance of PagedIterator.</p>
|
|
290
|
+
</div></span>
|
|
291
|
+
|
|
292
|
+
</li>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div id="constructor_details" class="method_details_list">
|
|
299
|
+
<h2>Constructor Details</h2>
|
|
300
|
+
|
|
301
|
+
<div class="method_details first">
|
|
302
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
303
|
+
|
|
304
|
+
#<strong>initialize</strong>(client:, page:, list_property:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</h3><div class="docstring">
|
|
311
|
+
<div class="discussion">
|
|
312
|
+
|
|
313
|
+
<p>Returns a new instance of PagedIterator.</p>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</div>
|
|
317
|
+
</div>
|
|
318
|
+
<div class="tags">
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
</div><table class="source_code">
|
|
322
|
+
<tr>
|
|
323
|
+
<td>
|
|
324
|
+
<pre class="lines">
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
10
|
|
328
|
+
11
|
|
329
|
+
12
|
|
330
|
+
13
|
|
331
|
+
14
|
|
332
|
+
15
|
|
333
|
+
16
|
|
334
|
+
17
|
|
335
|
+
18
|
|
336
|
+
19</pre>
|
|
337
|
+
</td>
|
|
338
|
+
<td>
|
|
339
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 10</span>
|
|
340
|
+
|
|
341
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
|
|
342
|
+
<span class='label'>client:</span><span class='comma'>,</span>
|
|
343
|
+
<span class='label'>page:</span><span class='comma'>,</span>
|
|
344
|
+
<span class='label'>list_property:</span>
|
|
345
|
+
<span class='rparen'>)</span>
|
|
346
|
+
<span class='ivar'>@n</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
347
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
348
|
+
<span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span>
|
|
349
|
+
<span class='ivar'>@page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span>
|
|
350
|
+
<span class='kw'>end</span></pre>
|
|
351
|
+
</td>
|
|
352
|
+
</tr>
|
|
353
|
+
</table>
|
|
354
|
+
</div>
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
|
|
358
|
+
<div id="instance_attr_details" class="attr_details">
|
|
359
|
+
<h2>Instance Attribute Details</h2>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<span id=""></span>
|
|
363
|
+
<div class="method_details first">
|
|
364
|
+
<h3 class="signature first" id="client-instance_method">
|
|
365
|
+
|
|
366
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</h3><div class="docstring">
|
|
373
|
+
<div class="discussion">
|
|
374
|
+
|
|
375
|
+
<p>Returns the value of attribute client.</p>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</div>
|
|
379
|
+
</div>
|
|
380
|
+
<div class="tags">
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</div><table class="source_code">
|
|
384
|
+
<tr>
|
|
385
|
+
<td>
|
|
386
|
+
<pre class="lines">
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
8
|
|
390
|
+
9
|
|
391
|
+
10</pre>
|
|
392
|
+
</td>
|
|
393
|
+
<td>
|
|
394
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 8</span>
|
|
395
|
+
|
|
396
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
397
|
+
<span class='ivar'>@client</span>
|
|
398
|
+
<span class='kw'>end</span></pre>
|
|
399
|
+
</td>
|
|
400
|
+
</tr>
|
|
401
|
+
</table>
|
|
402
|
+
</div>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
<span id=""></span>
|
|
406
|
+
<div class="method_details ">
|
|
407
|
+
<h3 class="signature " id="list_property-instance_method">
|
|
408
|
+
|
|
409
|
+
#<strong>list_property</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
</h3><div class="docstring">
|
|
416
|
+
<div class="discussion">
|
|
417
|
+
|
|
418
|
+
<p>Returns the value of attribute list_property.</p>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
</div>
|
|
422
|
+
</div>
|
|
423
|
+
<div class="tags">
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</div><table class="source_code">
|
|
427
|
+
<tr>
|
|
428
|
+
<td>
|
|
429
|
+
<pre class="lines">
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
8
|
|
433
|
+
9
|
|
434
|
+
10</pre>
|
|
435
|
+
</td>
|
|
436
|
+
<td>
|
|
437
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 8</span>
|
|
438
|
+
|
|
439
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_property'>list_property</span>
|
|
440
|
+
<span class='ivar'>@list_property</span>
|
|
441
|
+
<span class='kw'>end</span></pre>
|
|
442
|
+
</td>
|
|
443
|
+
</tr>
|
|
444
|
+
</table>
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span id="n=-instance_method"></span>
|
|
449
|
+
<div class="method_details ">
|
|
450
|
+
<h3 class="signature " id="n-instance_method">
|
|
451
|
+
|
|
452
|
+
#<strong>n</strong> ⇒ <tt>Object</tt>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</h3><div class="docstring">
|
|
459
|
+
<div class="discussion">
|
|
460
|
+
|
|
461
|
+
<p>Returns the value of attribute n.</p>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</div>
|
|
465
|
+
</div>
|
|
466
|
+
<div class="tags">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div><table class="source_code">
|
|
470
|
+
<tr>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="lines">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
7
|
|
476
|
+
8
|
|
477
|
+
9</pre>
|
|
478
|
+
</td>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 7</span>
|
|
481
|
+
|
|
482
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_n'>n</span>
|
|
483
|
+
<span class='ivar'>@n</span>
|
|
484
|
+
<span class='kw'>end</span></pre>
|
|
485
|
+
</td>
|
|
486
|
+
</tr>
|
|
487
|
+
</table>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<span id="page=-instance_method"></span>
|
|
492
|
+
<div class="method_details ">
|
|
493
|
+
<h3 class="signature " id="page-instance_method">
|
|
494
|
+
|
|
495
|
+
#<strong>page</strong> ⇒ <tt>Object</tt>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
</h3><div class="docstring">
|
|
502
|
+
<div class="discussion">
|
|
503
|
+
|
|
504
|
+
<p>Returns the value of attribute page.</p>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</div>
|
|
508
|
+
</div>
|
|
509
|
+
<div class="tags">
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</div><table class="source_code">
|
|
513
|
+
<tr>
|
|
514
|
+
<td>
|
|
515
|
+
<pre class="lines">
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
7
|
|
519
|
+
8
|
|
520
|
+
9</pre>
|
|
521
|
+
</td>
|
|
522
|
+
<td>
|
|
523
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 7</span>
|
|
524
|
+
|
|
525
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span>
|
|
526
|
+
<span class='ivar'>@page</span>
|
|
527
|
+
<span class='kw'>end</span></pre>
|
|
528
|
+
</td>
|
|
529
|
+
</tr>
|
|
530
|
+
</table>
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<div id="instance_method_details" class="method_details_list">
|
|
537
|
+
<h2>Instance Method Details</h2>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<div class="method_details first">
|
|
541
|
+
<h3 class="signature first" id="get_next-instance_method">
|
|
542
|
+
|
|
543
|
+
#<strong>get_next</strong> ⇒ <tt>object</tt>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</h3><div class="docstring">
|
|
550
|
+
<div class="discussion">
|
|
551
|
+
|
|
552
|
+
<p>Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.</p>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
</div>
|
|
556
|
+
</div>
|
|
557
|
+
<div class="tags">
|
|
558
|
+
|
|
559
|
+
<p class="tag_title">Returns:</p>
|
|
560
|
+
<ul class="return">
|
|
561
|
+
|
|
562
|
+
<li>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
<span class='type'>(<tt>object</tt>)</span>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
—
|
|
570
|
+
<div class='inline'>
|
|
571
|
+
<p>Returns an instance of a class.</p>
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
</li>
|
|
575
|
+
|
|
576
|
+
</ul>
|
|
577
|
+
|
|
578
|
+
</div><table class="source_code">
|
|
579
|
+
<tr>
|
|
580
|
+
<td>
|
|
581
|
+
<pre class="lines">
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
26
|
|
585
|
+
27
|
|
586
|
+
28
|
|
587
|
+
29
|
|
588
|
+
30
|
|
589
|
+
31
|
|
590
|
+
32
|
|
591
|
+
33
|
|
592
|
+
34
|
|
593
|
+
35
|
|
594
|
+
36
|
|
595
|
+
37
|
|
596
|
+
38</pre>
|
|
597
|
+
</td>
|
|
598
|
+
<td>
|
|
599
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 26</span>
|
|
600
|
+
|
|
601
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_next'>get_next</span>
|
|
602
|
+
<span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='ivar'>@list_property</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='ivar'>@n</span><span class='rbracket'>]</span>
|
|
603
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>None</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
604
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>+=</span> <span class='int'>1</span>
|
|
605
|
+
<span class='id identifier rubyid_item'>item</span>
|
|
606
|
+
<span class='kw'>rescue</span>
|
|
607
|
+
<span class='kw'>if</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span>
|
|
608
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span>
|
|
609
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
610
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span>
|
|
611
|
+
<span class='id identifier rubyid_get_next'>get_next</span>
|
|
612
|
+
<span class='kw'>end</span>
|
|
613
|
+
<span class='kw'>end</span></pre>
|
|
614
|
+
</td>
|
|
615
|
+
</tr>
|
|
616
|
+
</table>
|
|
617
|
+
</div>
|
|
618
|
+
|
|
619
|
+
</div>
|
|
620
|
+
|
|
621
|
+
</div>
|
|
622
|
+
|
|
623
|
+
<div id="footer">
|
|
624
|
+
Generated on Fri Sep 24 19:20:29 2021 by
|
|
625
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
626
|
+
0.9.26 (ruby-3.0.1).
|
|
627
|
+
</div>
|
|
628
|
+
|
|
629
|
+
</div>
|
|
630
|
+
</body>
|
|
631
|
+
</html>
|