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,117 @@
|
|
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
|
+
Module: NseData::HttpClient
|
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::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> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span>
|
41
|
+
»
|
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>Module: NseData::HttpClient
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/nse_data/http_client/base_client.rb<span class="defines">,<br />
|
82
|
+
lib/nse_data/http_client/faraday_client.rb</span>
|
83
|
+
</dd>
|
84
|
+
</dl>
|
85
|
+
|
86
|
+
</div>
|
87
|
+
|
88
|
+
<h2>Defined Under Namespace</h2>
|
89
|
+
<p class="children">
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="HttpClient/BaseClient.html" title="NseData::HttpClient::BaseClient (class)">BaseClient</a></span>, <span class='object_link'><a href="HttpClient/FaradayClient.html" title="NseData::HttpClient::FaradayClient (class)">FaradayClient</a></span>
|
95
|
+
|
96
|
+
|
97
|
+
</p>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
</div>
|
108
|
+
|
109
|
+
<div id="footer">
|
110
|
+
Generated on Tue Sep 10 12:25:13 2024 by
|
111
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
112
|
+
0.9.37 (ruby-3.2.2).
|
113
|
+
</div>
|
114
|
+
|
115
|
+
</div>
|
116
|
+
</body>
|
117
|
+
</html>
|
data/doc/NseData.html
ADDED
@@ -0,0 +1,524 @@
|
|
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
|
+
Module: NseData
|
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";
|
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 (N)</a> »
|
40
|
+
|
41
|
+
|
42
|
+
<span class="title">NseData</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>Module: NseData
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/nse_data.rb<span class="defines">,<br />
|
82
|
+
lib/nse_data/version.rb,<br /> lib/nse_data/api_manager.rb,<br /> lib/nse_data/config/base.rb,<br /> lib/nse_data/config/logger.rb,<br /> lib/nse_data/cache/cache_store.rb,<br /> lib/nse_data/cache/cache_policy.rb,<br /> lib/nse_data/http_client/base_client.rb,<br /> lib/nse_data/http_client/faraday_client.rb</span>
|
83
|
+
</dd>
|
84
|
+
</dl>
|
85
|
+
|
86
|
+
</div>
|
87
|
+
|
88
|
+
<h2>Overview</h2><div class="docstring">
|
89
|
+
<div class="discussion">
|
90
|
+
|
91
|
+
<p>The NseData module serves as the namespace for the NSE Data gem, which provides an interface to interact with and retrieve stock market data from the National Stock Exchange of India.</p>
|
92
|
+
|
93
|
+
|
94
|
+
</div>
|
95
|
+
</div>
|
96
|
+
<div class="tags">
|
97
|
+
|
98
|
+
|
99
|
+
</div><h2>Defined Under Namespace</h2>
|
100
|
+
<p class="children">
|
101
|
+
|
102
|
+
|
103
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="NseData/Cache.html" title="NseData::Cache (module)">Cache</a></span>, <span class='object_link'><a href="NseData/Config.html" title="NseData::Config (module)">Config</a></span>, <span class='object_link'><a href="NseData/HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span>
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="NseData/APIManager.html" title="NseData::APIManager (class)">APIManager</a></span>, <span class='object_link'><a href="NseData/Error.html" title="NseData::Error (class)">Error</a></span>
|
108
|
+
|
109
|
+
|
110
|
+
</p>
|
111
|
+
|
112
|
+
|
113
|
+
<h2>
|
114
|
+
Constant Summary
|
115
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
116
|
+
</h2>
|
117
|
+
|
118
|
+
<dl class="constants">
|
119
|
+
|
120
|
+
<dt id="VERSION-constant" class="">VERSION =
|
121
|
+
|
122
|
+
</dt>
|
123
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>'</span></span></pre></dd>
|
124
|
+
|
125
|
+
</dl>
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
<h2>
|
136
|
+
Class Method Summary
|
137
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
138
|
+
</h2>
|
139
|
+
|
140
|
+
<ul class="summary">
|
141
|
+
|
142
|
+
<li class="public ">
|
143
|
+
<span class="summary_signature">
|
144
|
+
|
145
|
+
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|config| ... } ⇒ Object </a>
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
</span>
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
<span class="summary_desc"><div class='inline'>
|
160
|
+
<p>Configure the logger for the NseData gem.</p>
|
161
|
+
</div></span>
|
162
|
+
|
163
|
+
</li>
|
164
|
+
|
165
|
+
|
166
|
+
<li class="public ">
|
167
|
+
<span class="summary_signature">
|
168
|
+
|
169
|
+
<a href="#define_api_methods-class_method" title="define_api_methods (class method)">.<strong>define_api_methods</strong> ⇒ Object </a>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
</span>
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
<span class="summary_desc"><div class='inline'>
|
184
|
+
<p>This module provides functionality for accessing NSE data.</p>
|
185
|
+
</div></span>
|
186
|
+
|
187
|
+
</li>
|
188
|
+
|
189
|
+
|
190
|
+
<li class="public ">
|
191
|
+
<span class="summary_signature">
|
192
|
+
|
193
|
+
<a href="#list_all_endpoints-class_method" title="list_all_endpoints (class method)">.<strong>list_all_endpoints</strong> ⇒ Array </a>
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
</span>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
<span class="summary_desc"><div class='inline'>
|
208
|
+
<p>Returns a list of all available endpoints.</p>
|
209
|
+
</div></span>
|
210
|
+
|
211
|
+
</li>
|
212
|
+
|
213
|
+
|
214
|
+
<li class="public ">
|
215
|
+
<span class="summary_signature">
|
216
|
+
|
217
|
+
<a href="#logger-class_method" title="logger (class method)">.<strong>logger</strong> ⇒ Logger </a>
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
</span>
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
<span class="summary_desc"><div class='inline'>
|
232
|
+
<p>Access the configured logger.</p>
|
233
|
+
</div></span>
|
234
|
+
|
235
|
+
</li>
|
236
|
+
|
237
|
+
|
238
|
+
</ul>
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
<div id="class_method_details" class="method_details_list">
|
244
|
+
<h2>Class Method Details</h2>
|
245
|
+
|
246
|
+
|
247
|
+
<div class="method_details first">
|
248
|
+
<h3 class="signature first" id="configure-class_method">
|
249
|
+
|
250
|
+
.<strong>configure</strong> {|config| ... } ⇒ <tt>Object</tt>
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
</h3><div class="docstring">
|
257
|
+
<div class="discussion">
|
258
|
+
|
259
|
+
<p>Configure the logger for the NseData gem.</p>
|
260
|
+
|
261
|
+
<p>This method allows users to customize the logger used throughout the library. To use it, call ‘NseData.configure` and provide a block to set up the logger.</p>
|
262
|
+
|
263
|
+
<p>Example:</p>
|
264
|
+
|
265
|
+
<p>NseData.configure do |config|</p>
|
266
|
+
|
267
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_custom_logger'>custom_logger</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>nse_data.log</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
268
|
+
<span class='id identifier rubyid_custom_logger'>custom_logger</span><span class='period'>.</span><span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span>
|
269
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_custom_logger'>custom_logger</span>
|
270
|
+
</code></pre>
|
271
|
+
|
272
|
+
<p>end</p>
|
273
|
+
|
274
|
+
|
275
|
+
</div>
|
276
|
+
</div>
|
277
|
+
<div class="tags">
|
278
|
+
|
279
|
+
<p class="tag_title">Yield Parameters:</p>
|
280
|
+
<ul class="yieldparam">
|
281
|
+
|
282
|
+
<li>
|
283
|
+
|
284
|
+
<span class='name'>config</span>
|
285
|
+
|
286
|
+
|
287
|
+
<span class='type'>(<tt><span class='object_link'><a href="NseData/Config/Logger.html" title="NseData::Config::Logger (class)">NseData::Config::Logger</a></span></tt>)</span>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
—
|
292
|
+
<div class='inline'>
|
293
|
+
<p>The configuration object to be customized.</p>
|
294
|
+
</div>
|
295
|
+
|
296
|
+
</li>
|
297
|
+
|
298
|
+
</ul>
|
299
|
+
|
300
|
+
</div><table class="source_code">
|
301
|
+
<tr>
|
302
|
+
<td>
|
303
|
+
<pre class="lines">
|
304
|
+
|
305
|
+
|
306
|
+
45
|
307
|
+
46
|
308
|
+
47
|
309
|
+
48</pre>
|
310
|
+
</td>
|
311
|
+
<td>
|
312
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 45</span>
|
313
|
+
|
314
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
|
315
|
+
<span class='ivar'>@logger_config</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="NseData/Config.html" title="NseData::Config (module)">Config</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NseData/Config/Logger.html" title="NseData::Config::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/Config/Logger.html#initialize-instance_method" title="NseData::Config::Logger#initialize (method)">new</a></span></span>
|
316
|
+
<span class='kw'>yield</span><span class='lparen'>(</span><span class='ivar'>@logger_config</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
317
|
+
<span class='kw'>end</span></pre>
|
318
|
+
</td>
|
319
|
+
</tr>
|
320
|
+
</table>
|
321
|
+
</div>
|
322
|
+
|
323
|
+
<div class="method_details ">
|
324
|
+
<h3 class="signature " id="define_api_methods-class_method">
|
325
|
+
|
326
|
+
.<strong>define_api_methods</strong> ⇒ <tt>Object</tt>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
</h3><div class="docstring">
|
333
|
+
<div class="discussion">
|
334
|
+
|
335
|
+
<p>This module provides functionality for accessing NSE data.</p>
|
336
|
+
|
337
|
+
|
338
|
+
</div>
|
339
|
+
</div>
|
340
|
+
<div class="tags">
|
341
|
+
|
342
|
+
|
343
|
+
</div><table class="source_code">
|
344
|
+
<tr>
|
345
|
+
<td>
|
346
|
+
<pre class="lines">
|
347
|
+
|
348
|
+
|
349
|
+
15
|
350
|
+
16
|
351
|
+
17
|
352
|
+
18
|
353
|
+
19
|
354
|
+
20
|
355
|
+
21
|
356
|
+
22</pre>
|
357
|
+
</td>
|
358
|
+
<td>
|
359
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 15</span>
|
360
|
+
|
361
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_define_api_methods'>define_api_methods</span>
|
362
|
+
<span class='id identifier rubyid_api_manager'>api_manager</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NseData/APIManager.html" title="NseData::APIManager (class)">APIManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/APIManager.html#initialize-instance_method" title="NseData::APIManager#initialize (method)">new</a></span></span>
|
363
|
+
<span class='id identifier rubyid_api_manager'>api_manager</span><span class='period'>.</span><span class='id identifier rubyid_endpoints'>endpoints</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_method_name'>method_name</span><span class='op'>|</span>
|
364
|
+
<span class='id identifier rubyid_define_singleton_method'>define_singleton_method</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>fetch_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method_name'>method_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
|
365
|
+
<span class='id identifier rubyid_api_manager'>api_manager</span><span class='period'>.</span><span class='id identifier rubyid_fetch_data'>fetch_data</span><span class='lparen'>(</span><span class='id identifier rubyid_method_name'>method_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
|
366
|
+
<span class='kw'>end</span>
|
367
|
+
<span class='kw'>end</span>
|
368
|
+
<span class='kw'>end</span></pre>
|
369
|
+
</td>
|
370
|
+
</tr>
|
371
|
+
</table>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
<div class="method_details ">
|
375
|
+
<h3 class="signature " id="list_all_endpoints-class_method">
|
376
|
+
|
377
|
+
.<strong>list_all_endpoints</strong> ⇒ <tt>Array</tt>
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
</h3><div class="docstring">
|
384
|
+
<div class="discussion">
|
385
|
+
|
386
|
+
<p>Returns a list of all available endpoints.</p>
|
387
|
+
|
388
|
+
|
389
|
+
</div>
|
390
|
+
</div>
|
391
|
+
<div class="tags">
|
392
|
+
|
393
|
+
<p class="tag_title">Returns:</p>
|
394
|
+
<ul class="return">
|
395
|
+
|
396
|
+
<li>
|
397
|
+
|
398
|
+
|
399
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
—
|
404
|
+
<div class='inline'>
|
405
|
+
<p>An array of endpoint names.</p>
|
406
|
+
</div>
|
407
|
+
|
408
|
+
</li>
|
409
|
+
|
410
|
+
</ul>
|
411
|
+
|
412
|
+
</div><table class="source_code">
|
413
|
+
<tr>
|
414
|
+
<td>
|
415
|
+
<pre class="lines">
|
416
|
+
|
417
|
+
|
418
|
+
27
|
419
|
+
28
|
420
|
+
29</pre>
|
421
|
+
</td>
|
422
|
+
<td>
|
423
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 27</span>
|
424
|
+
|
425
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_all_endpoints'>list_all_endpoints</span>
|
426
|
+
<span class='ivar'>@list_all_endpoints</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="NseData/APIManager.html" title="NseData::APIManager (class)">APIManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/APIManager.html#initialize-instance_method" title="NseData::APIManager#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_load_endpoints'><span class='object_link'><a href="NseData/APIManager.html#load_endpoints-instance_method" title="NseData::APIManager#load_endpoints (method)">load_endpoints</a></span></span>
|
427
|
+
<span class='kw'>end</span></pre>
|
428
|
+
</td>
|
429
|
+
</tr>
|
430
|
+
</table>
|
431
|
+
</div>
|
432
|
+
|
433
|
+
<div class="method_details ">
|
434
|
+
<h3 class="signature " id="logger-class_method">
|
435
|
+
|
436
|
+
.<strong>logger</strong> ⇒ <tt>Logger</tt>
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
</h3><div class="docstring">
|
443
|
+
<div class="discussion">
|
444
|
+
|
445
|
+
<p>Access the configured logger.</p>
|
446
|
+
|
447
|
+
<p>This method returns the Logger instance configured through ‘NseData.configure`.</p>
|
448
|
+
|
449
|
+
|
450
|
+
</div>
|
451
|
+
</div>
|
452
|
+
<div class="tags">
|
453
|
+
|
454
|
+
<p class="tag_title">Returns:</p>
|
455
|
+
<ul class="return">
|
456
|
+
|
457
|
+
<li>
|
458
|
+
|
459
|
+
|
460
|
+
<span class='type'>(<tt>Logger</tt>)</span>
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
—
|
465
|
+
<div class='inline'>
|
466
|
+
<p>The configured Logger instance.</p>
|
467
|
+
</div>
|
468
|
+
|
469
|
+
</li>
|
470
|
+
|
471
|
+
</ul>
|
472
|
+
<p class="tag_title">Raises:</p>
|
473
|
+
<ul class="raise">
|
474
|
+
|
475
|
+
<li>
|
476
|
+
|
477
|
+
|
478
|
+
<span class='type'>(<tt>RuntimeError</tt>)</span>
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
—
|
483
|
+
<div class='inline'>
|
484
|
+
<p>If the logger has not been configured.</p>
|
485
|
+
</div>
|
486
|
+
|
487
|
+
</li>
|
488
|
+
|
489
|
+
</ul>
|
490
|
+
|
491
|
+
</div><table class="source_code">
|
492
|
+
<tr>
|
493
|
+
<td>
|
494
|
+
<pre class="lines">
|
495
|
+
|
496
|
+
|
497
|
+
56
|
498
|
+
57
|
499
|
+
58</pre>
|
500
|
+
</td>
|
501
|
+
<td>
|
502
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 56</span>
|
503
|
+
|
504
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
|
505
|
+
<span class='ivar'>@logger_config</span><span class='op'>&.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Logger not configured. Please call NseData.configure first.</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
506
|
+
<span class='kw'>end</span></pre>
|
507
|
+
</td>
|
508
|
+
</tr>
|
509
|
+
</table>
|
510
|
+
</div>
|
511
|
+
|
512
|
+
</div>
|
513
|
+
|
514
|
+
</div>
|
515
|
+
|
516
|
+
<div id="footer">
|
517
|
+
Generated on Tue Sep 10 12:25:13 2024 by
|
518
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
519
|
+
0.9.37 (ruby-3.2.2).
|
520
|
+
</div>
|
521
|
+
|
522
|
+
</div>
|
523
|
+
</body>
|
524
|
+
</html>
|