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.
Files changed (52) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +7 -0
  3. data/CHANGELOG.md +22 -0
  4. data/CODE_OF_CONDUCT.md +84 -0
  5. data/Gemfile +24 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +179 -0
  8. data/Rakefile +72 -0
  9. data/doc/NseData/API/Base.html +350 -0
  10. data/doc/NseData/API/SpecialPreopen.html +220 -0
  11. data/doc/NseData/API.html +117 -0
  12. data/doc/NseData/APIManager.html +644 -0
  13. data/doc/NseData/Cache/CachePolicy.html +907 -0
  14. data/doc/NseData/Cache/CacheStore.html +674 -0
  15. data/doc/NseData/Cache.html +117 -0
  16. data/doc/NseData/Client.html +385 -0
  17. data/doc/NseData/Config/Base.html +552 -0
  18. data/doc/NseData/Config/Logger.html +430 -0
  19. data/doc/NseData/Config.html +117 -0
  20. data/doc/NseData/Error.html +124 -0
  21. data/doc/NseData/HttpClient/BaseClient.html +349 -0
  22. data/doc/NseData/HttpClient/FaradayClient.html +301 -0
  23. data/doc/NseData/HttpClient.html +117 -0
  24. data/doc/NseData.html +524 -0
  25. data/doc/_index.html +243 -0
  26. data/doc/class_list.html +54 -0
  27. data/doc/css/common.css +1 -0
  28. data/doc/css/full_list.css +58 -0
  29. data/doc/css/style.css +503 -0
  30. data/doc/file.README.html +304 -0
  31. data/doc/file_list.html +59 -0
  32. data/doc/frames.html +22 -0
  33. data/doc/index.html +304 -0
  34. data/doc/js/app.js +344 -0
  35. data/doc/js/full_list.js +242 -0
  36. data/doc/js/jquery.js +4 -0
  37. data/doc/method_list.html +294 -0
  38. data/doc/top-level-namespace.html +110 -0
  39. data/lib/nse_data/api_manager.rb +83 -0
  40. data/lib/nse_data/cache/README.md +77 -0
  41. data/lib/nse_data/cache/cache_policy.rb +118 -0
  42. data/lib/nse_data/cache/cache_store.rb +84 -0
  43. data/lib/nse_data/cache/redis_cache_store.rb +3 -0
  44. data/lib/nse_data/config/api_endpoints.yml +56 -0
  45. data/lib/nse_data/config/base.rb +38 -0
  46. data/lib/nse_data/config/logger.rb +39 -0
  47. data/lib/nse_data/http_client/base_client.rb +26 -0
  48. data/lib/nse_data/http_client/faraday_client.rb +68 -0
  49. data/lib/nse_data/version.rb +5 -0
  50. data/lib/nse_data.rb +65 -0
  51. data/nse_data.gemspec +34 -0
  52. metadata +131 -0
data/doc/NseData/APIManager.html ADDED
@@ -0,0 +1,644 @@
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::APIManager
8
+
9
+ &mdash; 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::APIManager";
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 (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span>
41
+ &raquo;
42
+ <span class="title">APIManager</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::APIManager
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::APIManager</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/api_manager.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>APIManager class to handle API calls to NSE (National Stock Exchange) India website.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+ <h2>
116
+ Constant Summary
117
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
118
+ </h2>
119
+
120
+ <dl class="constants">
121
+
122
+ <dt id="BASE_URL-constant" class="">BASE_URL =
123
+
124
+ </dt>
125
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.nseindia.com/api/</span><span class='tstring_end'>&#39;</span></span></pre></dd>
126
+
127
+ </dl>
128
+
129
+
130
+
131
+
132
+
133
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
134
+ <ul class="summary">
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#endpoints-instance_method" title="#endpoints (instance method)">#<strong>endpoints</strong> &#x21d2; Hash </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+ <span class="note title readonly">readonly</span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>The hash containing the loaded API endpoints.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ </ul>
166
+
167
+
168
+
169
+
170
+
171
+ <h2>
172
+ Instance Method Summary
173
+ <small><a href="#" class="summary_toggle">collapse</a></small>
174
+ </h2>
175
+
176
+ <ul class="summary">
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#fetch_data-instance_method" title="#fetch_data (instance method)">#<strong>fetch_data</strong>(endpoint_key, force_refresh: false) &#x21d2; Faraday::Response </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Fetches data from the specified API endpoint.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(cache_store: nil) &#x21d2; APIManager </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+ <span class="note title constructor">constructor</span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'>
222
+ <p>Initializes a new instance of the APIManager class.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#load_endpoints-instance_method" title="#load_endpoints (instance method)">#<strong>load_endpoints</strong> &#x21d2; Hash </a>
232
+
233
+
234
+
235
+ </span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'>
246
+ <p>Loads the API endpoints from the configuration file.</p>
247
+ </div></span>
248
+
249
+ </li>
250
+
251
+
252
+ </ul>
253
+
254
+
255
+ <div id="constructor_details" class="method_details_list">
256
+ <h2>Constructor Details</h2>
257
+
258
+ <div class="method_details first">
259
+ <h3 class="signature first" id="initialize-instance_method">
260
+
261
+ #<strong>initialize</strong>(cache_store: nil) &#x21d2; <tt><span class='object_link'><a href="" title="NseData::APIManager (class)">APIManager</a></span></tt>
262
+
263
+
264
+
265
+
266
+
267
+ </h3><div class="docstring">
268
+ <div class="discussion">
269
+
270
+ <p>Initializes a new instance of the APIManager class.</p>
271
+
272
+ <p>If nil, in-memory cache is used.</p>
273
+
274
+
275
+ </div>
276
+ </div>
277
+ <div class="tags">
278
+ <p class="tag_title">Parameters:</p>
279
+ <ul class="param">
280
+
281
+ <li>
282
+
283
+ <span class='name'>cache_store</span>
284
+
285
+
286
+ <span class='type'>(<tt>CacheStore</tt>, <tt>RedisCacheStore</tt>, <tt>nil</tt>)</span>
287
+
288
+
289
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
290
+
291
+
292
+ &mdash;
293
+ <div class='inline'>
294
+ <p>The cache store to use for caching.</p>
295
+ </div>
296
+
297
+ </li>
298
+
299
+ </ul>
300
+
301
+
302
+ </div><table class="source_code">
303
+ <tr>
304
+ <td>
305
+ <pre class="lines">
306
+
307
+
308
+ 17
309
+ 18
310
+ 19
311
+ 20
312
+ 21
313
+ 22
314
+ 23
315
+ 24
316
+ 25
317
+ 26
318
+ 27
319
+ 28
320
+ 29</pre>
321
+ </td>
322
+ <td>
323
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 17</span>
324
+
325
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>cache_store:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
326
+ <span class='comment'># Initialize cache policy with the provided cache store or default to in-memory cache.
327
+ </span> <span class='ivar'>@cache_policy</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cache.html" title="NseData::Cache (module)">Cache</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cache/CachePolicy.html" title="NseData::Cache::CachePolicy (class)">CachePolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cache/CachePolicy.html#initialize-instance_method" title="NseData::Cache::CachePolicy#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cache.html" title="NseData::Cache (module)">Cache</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cache/CacheStore.html" title="NseData::Cache::CacheStore (class)">CacheStore</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cache/CacheStore.html#initialize-instance_method" title="NseData::Cache::CacheStore#initialize (method)">new</a></span></span><span class='rparen'>)</span>
328
+
329
+ <span class='comment'># Configure cache policy (e.g., setting endpoints with no cache or custom TTL).
330
+ </span> <span class='id identifier rubyid_configure_cache_policy'>configure_cache_policy</span>
331
+
332
+ <span class='comment'># Initialize Faraday client with the base URL and cache policy.
333
+ </span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient/FaradayClient.html" title="NseData::HttpClient::FaradayClient (class)">FaradayClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient/BaseClient.html#initialize-instance_method" title="NseData::HttpClient::BaseClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#BASE_URL-constant" title="NseData::APIManager::BASE_URL (constant)">BASE_URL</a></span></span><span class='comma'>,</span> <span class='ivar'>@cache_policy</span><span class='rparen'>)</span>
334
+
335
+ <span class='comment'># Load API endpoints from the configuration file.
336
+ </span> <span class='ivar'>@endpoints</span> <span class='op'>=</span> <span class='id identifier rubyid_load_endpoints'>load_endpoints</span>
337
+ <span class='kw'>end</span></pre>
338
+ </td>
339
+ </tr>
340
+ </table>
341
+ </div>
342
+
343
+ </div>
344
+
345
+ <div id="instance_attr_details" class="attr_details">
346
+ <h2>Instance Attribute Details</h2>
347
+
348
+
349
+ <span id=""></span>
350
+ <div class="method_details first">
351
+ <h3 class="signature first" id="endpoints-instance_method">
352
+
353
+ #<strong>endpoints</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span>
354
+
355
+
356
+
357
+
358
+
359
+ </h3><div class="docstring">
360
+ <div class="discussion">
361
+
362
+ <p>Returns The hash containing the loaded API endpoints.</p>
363
+
364
+
365
+ </div>
366
+ </div>
367
+ <div class="tags">
368
+
369
+ <p class="tag_title">Returns:</p>
370
+ <ul class="return">
371
+
372
+ <li>
373
+
374
+
375
+ <span class='type'>(<tt>Hash</tt>)</span>
376
+
377
+
378
+
379
+ &mdash;
380
+ <div class='inline'>
381
+ <p>The hash containing the loaded API endpoints.</p>
382
+ </div>
383
+
384
+ </li>
385
+
386
+ </ul>
387
+
388
+ </div><table class="source_code">
389
+ <tr>
390
+ <td>
391
+ <pre class="lines">
392
+
393
+
394
+ 62
395
+ 63
396
+ 64</pre>
397
+ </td>
398
+ <td>
399
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 62</span>
400
+
401
+ <span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
402
+ <span class='ivar'>@endpoints</span>
403
+ <span class='kw'>end</span></pre>
404
+ </td>
405
+ </tr>
406
+ </table>
407
+ </div>
408
+
409
+ </div>
410
+
411
+
412
+ <div id="instance_method_details" class="method_details_list">
413
+ <h2>Instance Method Details</h2>
414
+
415
+
416
+ <div class="method_details first">
417
+ <h3 class="signature first" id="fetch_data-instance_method">
418
+
419
+ #<strong>fetch_data</strong>(endpoint_key, force_refresh: false) &#x21d2; <tt>Faraday::Response</tt>
420
+
421
+
422
+
423
+
424
+
425
+ </h3><div class="docstring">
426
+ <div class="discussion">
427
+
428
+ <p>Fetches data from the specified API endpoint.</p>
429
+
430
+
431
+ </div>
432
+ </div>
433
+ <div class="tags">
434
+ <p class="tag_title">Parameters:</p>
435
+ <ul class="param">
436
+
437
+ <li>
438
+
439
+ <span class='name'>endpoint_key</span>
440
+
441
+
442
+ <span class='type'>(<tt>String</tt>)</span>
443
+
444
+
445
+
446
+ &mdash;
447
+ <div class='inline'>
448
+ <p>The key of the API endpoint to fetch data from.</p>
449
+ </div>
450
+
451
+ </li>
452
+
453
+ <li>
454
+
455
+ <span class='name'>force_refresh</span>
456
+
457
+
458
+ <span class='type'>(<tt>Boolean</tt>)</span>
459
+
460
+
461
+ <em class="default">(defaults to: <tt>false</tt>)</em>
462
+
463
+
464
+ &mdash;
465
+ <div class='inline'>
466
+ <p>Whether to force refresh the data, bypassing the cache.</p>
467
+ </div>
468
+
469
+ </li>
470
+
471
+ </ul>
472
+
473
+ <p class="tag_title">Returns:</p>
474
+ <ul class="return">
475
+
476
+ <li>
477
+
478
+
479
+ <span class='type'>(<tt>Faraday::Response</tt>)</span>
480
+
481
+
482
+
483
+ &mdash;
484
+ <div class='inline'>
485
+ <p>The response object containing the fetched data.</p>
486
+ </div>
487
+
488
+ </li>
489
+
490
+ </ul>
491
+ <p class="tag_title">Raises:</p>
492
+ <ul class="raise">
493
+
494
+ <li>
495
+
496
+
497
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
498
+
499
+
500
+
501
+ &mdash;
502
+ <div class='inline'>
503
+ <p>If the provided endpoint key is invalid.</p>
504
+ </div>
505
+
506
+ </li>
507
+
508
+ </ul>
509
+
510
+ </div><table class="source_code">
511
+ <tr>
512
+ <td>
513
+ <pre class="lines">
514
+
515
+
516
+ 37
517
+ 38
518
+ 39
519
+ 40
520
+ 41
521
+ 42
522
+ 43
523
+ 44
524
+ 45
525
+ 46</pre>
526
+ </td>
527
+ <td>
528
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 37</span>
529
+
530
+ <span class='kw'>def</span> <span class='id identifier rubyid_fetch_data'>fetch_data</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_key'>endpoint_key</span><span class='comma'>,</span> <span class='label'>force_refresh:</span> <span class='kw'>false</span><span class='rparen'>)</span>
531
+ <span class='const'><span class='object_link'><a href="../NseData.html" title="NseData (module)">NseData</a></span></span><span class='period'>.</span><span class='id identifier rubyid_logger'><span class='object_link'><a href="../NseData.html#logger-class_method" title="NseData.logger (method)">logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_content'>: fetching data for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint_key'>endpoint_key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
532
+ <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='ivar'>@endpoints</span><span class='lbracket'>[</span><span class='id identifier rubyid_endpoint_key'>endpoint_key</span><span class='rbracket'>]</span>
533
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid endpoint key: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint_key'>endpoint_key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
534
+
535
+ <span class='comment'># Use cache policy to fetch data, with an option to force refresh.
536
+ </span> <span class='ivar'>@cache_policy</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>force_refresh:</span><span class='rparen'>)</span> <span class='kw'>do</span>
537
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
538
+ <span class='kw'>end</span>
539
+ <span class='kw'>end</span></pre>
540
+ </td>
541
+ </tr>
542
+ </table>
543
+ </div>
544
+
545
+ <div class="method_details ">
546
+ <h3 class="signature " id="load_endpoints-instance_method">
547
+
548
+ #<strong>load_endpoints</strong> &#x21d2; <tt>Hash</tt>
549
+
550
+
551
+
552
+
553
+
554
+ </h3><div class="docstring">
555
+ <div class="discussion">
556
+
557
+ <p>Loads the API endpoints from the configuration file.</p>
558
+
559
+
560
+ </div>
561
+ </div>
562
+ <div class="tags">
563
+
564
+ <p class="tag_title">Returns:</p>
565
+ <ul class="return">
566
+
567
+ <li>
568
+
569
+
570
+ <span class='type'>(<tt>Hash</tt>)</span>
571
+
572
+
573
+
574
+ &mdash;
575
+ <div class='inline'>
576
+ <p>The hash containing the loaded API endpoints.</p>
577
+ </div>
578
+
579
+ </li>
580
+
581
+ </ul>
582
+ <p class="tag_title">Raises:</p>
583
+ <ul class="raise">
584
+
585
+ <li>
586
+
587
+
588
+ <span class='type'>(<tt>RuntimeError</tt>)</span>
589
+
590
+
591
+
592
+ &mdash;
593
+ <div class='inline'>
594
+ <p>If the configuration file is missing or has syntax errors.</p>
595
+ </div>
596
+
597
+ </li>
598
+
599
+ </ul>
600
+
601
+ </div><table class="source_code">
602
+ <tr>
603
+ <td>
604
+ <pre class="lines">
605
+
606
+
607
+ 52
608
+ 53
609
+ 54
610
+ 55
611
+ 56
612
+ 57
613
+ 58
614
+ 59</pre>
615
+ </td>
616
+ <td>
617
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 52</span>
618
+
619
+ <span class='kw'>def</span> <span class='id identifier rubyid_load_endpoints'>load_endpoints</span>
620
+ <span class='id identifier rubyid_yaml_content'>yaml_content</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config/api_endpoints.yml</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid___dir__'>__dir__</span><span class='rparen'>)</span><span class='rparen'>)</span>
621
+ <span class='id identifier rubyid_yaml_content'>yaml_content</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>apis</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
622
+ <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
623
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Configuration file not found: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
624
+ <span class='kw'>rescue</span> <span class='const'>Psych</span><span class='op'>::</span><span class='const'>SyntaxError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
625
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>YAML syntax error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
626
+ <span class='kw'>end</span></pre>
627
+ </td>
628
+ </tr>
629
+ </table>
630
+ </div>
631
+
632
+ </div>
633
+
634
+ </div>
635
+
636
+ <div id="footer">
637
+ Generated on Tue Sep 10 12:25:13 2024 by
638
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
639
+ 0.9.37 (ruby-3.2.2).
640
+ </div>
641
+
642
+ </div>
643
+ </body>
644
+ </html>