nse_data 0.1.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/.rubocop.yml +7 -0
- data/CHANGELOG.md +22 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Gemfile +24 -0
- data/LICENSE.txt +21 -0
- data/README.md +179 -0
- data/Rakefile +72 -0
- data/doc/NseData/API/Base.html +350 -0
- data/doc/NseData/API/SpecialPreopen.html +220 -0
- data/doc/NseData/API.html +117 -0
- data/doc/NseData/APIManager.html +644 -0
- data/doc/NseData/Cache/CachePolicy.html +907 -0
- data/doc/NseData/Cache/CacheStore.html +674 -0
- data/doc/NseData/Cache.html +117 -0
- data/doc/NseData/Client.html +385 -0
- data/doc/NseData/Config/Base.html +552 -0
- data/doc/NseData/Config/Logger.html +430 -0
- data/doc/NseData/Config.html +117 -0
- data/doc/NseData/Error.html +124 -0
- data/doc/NseData/HttpClient/BaseClient.html +349 -0
- data/doc/NseData/HttpClient/FaradayClient.html +301 -0
- data/doc/NseData/HttpClient.html +117 -0
- data/doc/NseData.html +524 -0
- data/doc/_index.html +243 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.README.html +304 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +304 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +294 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/nse_data/api_manager.rb +83 -0
- data/lib/nse_data/cache/README.md +77 -0
- data/lib/nse_data/cache/cache_policy.rb +118 -0
- data/lib/nse_data/cache/cache_store.rb +84 -0
- data/lib/nse_data/cache/redis_cache_store.rb +3 -0
- data/lib/nse_data/config/api_endpoints.yml +56 -0
- data/lib/nse_data/config/base.rb +38 -0
- data/lib/nse_data/config/logger.rb +39 -0
- data/lib/nse_data/http_client/base_client.rb +26 -0
- data/lib/nse_data/http_client/faraday_client.rb +68 -0
- data/lib/nse_data/version.rb +5 -0
- data/lib/nse_data.rb +65 -0
- data/nse_data.gemspec +34 -0
- metadata +131 -0
@@ -0,0 +1,552 @@
|
|
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: NseData::Config::Base
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.37
|
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 = "NseData::Config::Base";
|
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="../../NseData.html" title="NseData (module)">NseData</a></span></span> » <span class='title'><span class='object_link'><a href="../Config.html" title="NseData::Config (module)">Config</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Base</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: NseData::Config::Base
|
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">NseData::Config::Base</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/nse_data/config/base.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Base serves as the base class for configuration settings.</p>
|
106
|
+
|
107
|
+
<p>It allows for storing and accessing various configuration settings through a hash-like interface.</p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div><div id="subclasses">
|
116
|
+
<h2>Direct Known Subclasses</h2>
|
117
|
+
<p class="children"><span class='object_link'><a href="Logger.html" title="NseData::Config::Logger (class)">Logger</a></span></p>
|
118
|
+
</div>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
124
|
+
<ul class="summary">
|
125
|
+
|
126
|
+
<li class="public ">
|
127
|
+
<span class="summary_signature">
|
128
|
+
|
129
|
+
<a href="#settings-instance_method" title="#settings (instance method)">#<strong>settings</strong> ⇒ Hash </a>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
</span>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
<span class="note title readonly">readonly</span>
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
<span class="summary_desc"><div class='inline'>
|
149
|
+
<p>The hash storing configuration settings.</p>
|
150
|
+
</div></span>
|
151
|
+
|
152
|
+
</li>
|
153
|
+
|
154
|
+
|
155
|
+
</ul>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
<h2>
|
162
|
+
Instance Method Summary
|
163
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
164
|
+
</h2>
|
165
|
+
|
166
|
+
<ul class="summary">
|
167
|
+
|
168
|
+
<li class="public ">
|
169
|
+
<span class="summary_signature">
|
170
|
+
|
171
|
+
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) ⇒ Object </a>
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
</span>
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
186
|
+
<p>Retrieves a configuration setting by key.</p>
|
187
|
+
</div></span>
|
188
|
+
|
189
|
+
</li>
|
190
|
+
|
191
|
+
|
192
|
+
<li class="public ">
|
193
|
+
<span class="summary_signature">
|
194
|
+
|
195
|
+
<a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(key, value) ⇒ Object </a>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
</span>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
<span class="summary_desc"><div class='inline'>
|
210
|
+
<p>Sets a configuration setting by key.</p>
|
211
|
+
</div></span>
|
212
|
+
|
213
|
+
</li>
|
214
|
+
|
215
|
+
|
216
|
+
<li class="public ">
|
217
|
+
<span class="summary_signature">
|
218
|
+
|
219
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(initial_settings = {}) ⇒ Base </a>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
</span>
|
224
|
+
|
225
|
+
|
226
|
+
<span class="note title constructor">constructor</span>
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
<span class="summary_desc"><div class='inline'>
|
236
|
+
<p>Initializes the Base with optional initial settings.</p>
|
237
|
+
</div></span>
|
238
|
+
|
239
|
+
</li>
|
240
|
+
|
241
|
+
|
242
|
+
</ul>
|
243
|
+
|
244
|
+
|
245
|
+
<div id="constructor_details" class="method_details_list">
|
246
|
+
<h2>Constructor Details</h2>
|
247
|
+
|
248
|
+
<div class="method_details first">
|
249
|
+
<h3 class="signature first" id="initialize-instance_method">
|
250
|
+
|
251
|
+
#<strong>initialize</strong>(initial_settings = {}) ⇒ <tt><span class='object_link'><a href="" title="NseData::Config::Base (class)">Base</a></span></tt>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
</h3><div class="docstring">
|
258
|
+
<div class="discussion">
|
259
|
+
|
260
|
+
<p>Initializes the Base with optional initial settings.</p>
|
261
|
+
|
262
|
+
|
263
|
+
</div>
|
264
|
+
</div>
|
265
|
+
<div class="tags">
|
266
|
+
<p class="tag_title">Parameters:</p>
|
267
|
+
<ul class="param">
|
268
|
+
|
269
|
+
<li>
|
270
|
+
|
271
|
+
<span class='name'>initial_settings</span>
|
272
|
+
|
273
|
+
|
274
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
275
|
+
|
276
|
+
|
277
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
278
|
+
|
279
|
+
|
280
|
+
—
|
281
|
+
<div class='inline'>
|
282
|
+
<p>Optional hash of initial settings.</p>
|
283
|
+
</div>
|
284
|
+
|
285
|
+
</li>
|
286
|
+
|
287
|
+
</ul>
|
288
|
+
|
289
|
+
|
290
|
+
</div><table class="source_code">
|
291
|
+
<tr>
|
292
|
+
<td>
|
293
|
+
<pre class="lines">
|
294
|
+
|
295
|
+
|
296
|
+
17
|
297
|
+
18
|
298
|
+
19</pre>
|
299
|
+
</td>
|
300
|
+
<td>
|
301
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/config/base.rb', line 17</span>
|
302
|
+
|
303
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_initial_settings'>initial_settings</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
304
|
+
<span class='ivar'>@settings</span> <span class='op'>=</span> <span class='id identifier rubyid_initial_settings'>initial_settings</span>
|
305
|
+
<span class='kw'>end</span></pre>
|
306
|
+
</td>
|
307
|
+
</tr>
|
308
|
+
</table>
|
309
|
+
</div>
|
310
|
+
|
311
|
+
</div>
|
312
|
+
|
313
|
+
<div id="instance_attr_details" class="attr_details">
|
314
|
+
<h2>Instance Attribute Details</h2>
|
315
|
+
|
316
|
+
|
317
|
+
<span id=""></span>
|
318
|
+
<div class="method_details first">
|
319
|
+
<h3 class="signature first" id="settings-instance_method">
|
320
|
+
|
321
|
+
#<strong>settings</strong> ⇒ <tt>Hash</tt> <span class="extras">(readonly)</span>
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
</h3><div class="docstring">
|
328
|
+
<div class="discussion">
|
329
|
+
|
330
|
+
<p>The hash storing configuration settings.</p>
|
331
|
+
|
332
|
+
|
333
|
+
</div>
|
334
|
+
</div>
|
335
|
+
<div class="tags">
|
336
|
+
|
337
|
+
<p class="tag_title">Returns:</p>
|
338
|
+
<ul class="return">
|
339
|
+
|
340
|
+
<li>
|
341
|
+
|
342
|
+
|
343
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
—
|
348
|
+
<div class='inline'>
|
349
|
+
<p>the current value of settings</p>
|
350
|
+
</div>
|
351
|
+
|
352
|
+
</li>
|
353
|
+
|
354
|
+
</ul>
|
355
|
+
|
356
|
+
</div><table class="source_code">
|
357
|
+
<tr>
|
358
|
+
<td>
|
359
|
+
<pre class="lines">
|
360
|
+
|
361
|
+
|
362
|
+
11
|
363
|
+
12
|
364
|
+
13</pre>
|
365
|
+
</td>
|
366
|
+
<td>
|
367
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/config/base.rb', line 11</span>
|
368
|
+
|
369
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_settings'>settings</span>
|
370
|
+
<span class='ivar'>@settings</span>
|
371
|
+
<span class='kw'>end</span></pre>
|
372
|
+
</td>
|
373
|
+
</tr>
|
374
|
+
</table>
|
375
|
+
</div>
|
376
|
+
|
377
|
+
</div>
|
378
|
+
|
379
|
+
|
380
|
+
<div id="instance_method_details" class="method_details_list">
|
381
|
+
<h2>Instance Method Details</h2>
|
382
|
+
|
383
|
+
|
384
|
+
<div class="method_details first">
|
385
|
+
<h3 class="signature first" id="[]-instance_method">
|
386
|
+
|
387
|
+
#<strong>[]</strong>(key) ⇒ <tt>Object</tt>
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
</h3><div class="docstring">
|
394
|
+
<div class="discussion">
|
395
|
+
|
396
|
+
<p>Retrieves a configuration setting by key.</p>
|
397
|
+
|
398
|
+
|
399
|
+
</div>
|
400
|
+
</div>
|
401
|
+
<div class="tags">
|
402
|
+
<p class="tag_title">Parameters:</p>
|
403
|
+
<ul class="param">
|
404
|
+
|
405
|
+
<li>
|
406
|
+
|
407
|
+
<span class='name'>key</span>
|
408
|
+
|
409
|
+
|
410
|
+
<span class='type'>(<tt>Symbol</tt>, <tt>String</tt>)</span>
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
—
|
415
|
+
<div class='inline'>
|
416
|
+
<p>The key for the setting.</p>
|
417
|
+
</div>
|
418
|
+
|
419
|
+
</li>
|
420
|
+
|
421
|
+
</ul>
|
422
|
+
|
423
|
+
<p class="tag_title">Returns:</p>
|
424
|
+
<ul class="return">
|
425
|
+
|
426
|
+
<li>
|
427
|
+
|
428
|
+
|
429
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
—
|
434
|
+
<div class='inline'>
|
435
|
+
<p>The value associated with the key.</p>
|
436
|
+
</div>
|
437
|
+
|
438
|
+
</li>
|
439
|
+
|
440
|
+
</ul>
|
441
|
+
|
442
|
+
</div><table class="source_code">
|
443
|
+
<tr>
|
444
|
+
<td>
|
445
|
+
<pre class="lines">
|
446
|
+
|
447
|
+
|
448
|
+
25
|
449
|
+
26
|
450
|
+
27</pre>
|
451
|
+
</td>
|
452
|
+
<td>
|
453
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/config/base.rb', line 25</span>
|
454
|
+
|
455
|
+
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
456
|
+
<span class='ivar'>@settings</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
|
457
|
+
<span class='kw'>end</span></pre>
|
458
|
+
</td>
|
459
|
+
</tr>
|
460
|
+
</table>
|
461
|
+
</div>
|
462
|
+
|
463
|
+
<div class="method_details ">
|
464
|
+
<h3 class="signature " id="[]=-instance_method">
|
465
|
+
|
466
|
+
#<strong>[]=</strong>(key, value) ⇒ <tt>Object</tt>
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
</h3><div class="docstring">
|
473
|
+
<div class="discussion">
|
474
|
+
|
475
|
+
<p>Sets a configuration setting by key.</p>
|
476
|
+
|
477
|
+
|
478
|
+
</div>
|
479
|
+
</div>
|
480
|
+
<div class="tags">
|
481
|
+
<p class="tag_title">Parameters:</p>
|
482
|
+
<ul class="param">
|
483
|
+
|
484
|
+
<li>
|
485
|
+
|
486
|
+
<span class='name'>key</span>
|
487
|
+
|
488
|
+
|
489
|
+
<span class='type'>(<tt>Symbol</tt>, <tt>String</tt>)</span>
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
—
|
494
|
+
<div class='inline'>
|
495
|
+
<p>The key for the setting.</p>
|
496
|
+
</div>
|
497
|
+
|
498
|
+
</li>
|
499
|
+
|
500
|
+
<li>
|
501
|
+
|
502
|
+
<span class='name'>value</span>
|
503
|
+
|
504
|
+
|
505
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
—
|
510
|
+
<div class='inline'>
|
511
|
+
<p>The value to set for the key.</p>
|
512
|
+
</div>
|
513
|
+
|
514
|
+
</li>
|
515
|
+
|
516
|
+
</ul>
|
517
|
+
|
518
|
+
|
519
|
+
</div><table class="source_code">
|
520
|
+
<tr>
|
521
|
+
<td>
|
522
|
+
<pre class="lines">
|
523
|
+
|
524
|
+
|
525
|
+
33
|
526
|
+
34
|
527
|
+
35</pre>
|
528
|
+
</td>
|
529
|
+
<td>
|
530
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/config/base.rb', line 33</span>
|
531
|
+
|
532
|
+
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
533
|
+
<span class='ivar'>@settings</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
|
534
|
+
<span class='kw'>end</span></pre>
|
535
|
+
</td>
|
536
|
+
</tr>
|
537
|
+
</table>
|
538
|
+
</div>
|
539
|
+
|
540
|
+
</div>
|
541
|
+
|
542
|
+
</div>
|
543
|
+
|
544
|
+
<div id="footer">
|
545
|
+
Generated on Tue Sep 10 12:25:13 2024 by
|
546
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
547
|
+
0.9.37 (ruby-3.2.2).
|
548
|
+
</div>
|
549
|
+
|
550
|
+
</div>
|
551
|
+
</body>
|
552
|
+
</html>
|