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/API/Base.html ADDED
@@ -0,0 +1,350 @@
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::API::Base
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::API::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> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NseData.html" title="NseData (module)">NseData</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../API.html" title="NseData::API (module)">API</a></span></span>
41
+ &raquo;
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::API::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::API::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/api/base.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>NseData::API::Base serves as the base class for making API calls to the NSE. It contains shared functionality that other API classes can inherit and extend.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><div id="subclasses">
114
+ <h2>Direct Known Subclasses</h2>
115
+ <p class="children"><span class='object_link'><a href="SpecialPreopen.html" title="NseData::API::SpecialPreopen (class)">SpecialPreopen</a></span></p>
116
+ </div>
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <h2>
126
+ Instance Method Summary
127
+ <small><a href="#" class="summary_toggle">collapse</a></small>
128
+ </h2>
129
+
130
+ <ul class="summary">
131
+
132
+ <li class="public ">
133
+ <span class="summary_signature">
134
+
135
+ <a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> &#x21d2; Object </a>
136
+
137
+
138
+
139
+ </span>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <span class="summary_desc"><div class='inline'></div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#fetch-instance_method" title="#fetch (instance method)">#<strong>fetch</strong> &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'></div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) &#x21d2; Base </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+
186
+ <span class="note title constructor">constructor</span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>A new instance of Base.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ </ul>
203
+
204
+
205
+ <div id="constructor_details" class="method_details_list">
206
+ <h2>Constructor Details</h2>
207
+
208
+ <div class="method_details first">
209
+ <h3 class="signature first" id="initialize-instance_method">
210
+
211
+ #<strong>initialize</strong>(client) &#x21d2; <tt><span class='object_link'><a href="" title="NseData::API::Base (class)">Base</a></span></tt>
212
+
213
+
214
+
215
+
216
+
217
+ </h3><div class="docstring">
218
+ <div class="discussion">
219
+
220
+ <p>Returns a new instance of Base.</p>
221
+
222
+
223
+ </div>
224
+ </div>
225
+ <div class="tags">
226
+
227
+
228
+ </div><table class="source_code">
229
+ <tr>
230
+ <td>
231
+ <pre class="lines">
232
+
233
+
234
+ 8
235
+ 9
236
+ 10</pre>
237
+ </td>
238
+ <td>
239
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api/base.rb', line 8</span>
240
+
241
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
242
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
243
+ <span class='kw'>end</span></pre>
244
+ </td>
245
+ </tr>
246
+ </table>
247
+ </div>
248
+
249
+ </div>
250
+
251
+
252
+ <div id="instance_method_details" class="method_details_list">
253
+ <h2>Instance Method Details</h2>
254
+
255
+
256
+ <div class="method_details first">
257
+ <h3 class="signature first" id="endpoint-instance_method">
258
+
259
+ #<strong>endpoint</strong> &#x21d2; <tt>Object</tt>
260
+
261
+
262
+
263
+
264
+
265
+ </h3><div class="docstring">
266
+ <div class="discussion">
267
+
268
+
269
+ </div>
270
+ </div>
271
+ <div class="tags">
272
+
273
+ <p class="tag_title">Raises:</p>
274
+ <ul class="raise">
275
+
276
+ <li>
277
+
278
+
279
+ <span class='type'>(<tt>NotImplementedError</tt>)</span>
280
+
281
+
282
+
283
+ </li>
284
+
285
+ </ul>
286
+
287
+ </div><table class="source_code">
288
+ <tr>
289
+ <td>
290
+ <pre class="lines">
291
+
292
+
293
+ 12
294
+ 13
295
+ 14</pre>
296
+ </td>
297
+ <td>
298
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api/base.rb', line 12</span>
299
+
300
+ <span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
301
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Subclasses must define the endpoint method</span><span class='tstring_end'>&#39;</span></span>
302
+ <span class='kw'>end</span></pre>
303
+ </td>
304
+ </tr>
305
+ </table>
306
+ </div>
307
+
308
+ <div class="method_details ">
309
+ <h3 class="signature " id="fetch-instance_method">
310
+
311
+ #<strong>fetch</strong> &#x21d2; <tt>Object</tt>
312
+
313
+
314
+
315
+
316
+
317
+ </h3><table class="source_code">
318
+ <tr>
319
+ <td>
320
+ <pre class="lines">
321
+
322
+
323
+ 16
324
+ 17
325
+ 18</pre>
326
+ </td>
327
+ <td>
328
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api/base.rb', line 16</span>
329
+
330
+ <span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
331
+ <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='rparen'>)</span>
332
+ <span class='kw'>end</span></pre>
333
+ </td>
334
+ </tr>
335
+ </table>
336
+ </div>
337
+
338
+ </div>
339
+
340
+ </div>
341
+
342
+ <div id="footer">
343
+ Generated on Thu Sep 5 12:14:01 2024 by
344
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
345
+ 0.9.37 (ruby-3.2.2).
346
+ </div>
347
+
348
+ </div>
349
+ </body>
350
+ </html>
data/doc/NseData/API/SpecialPreopen.html ADDED
@@ -0,0 +1,220 @@
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::API::SpecialPreopen
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::API::SpecialPreopen";
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 (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NseData.html" title="NseData (module)">NseData</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../API.html" title="NseData::API (module)">API</a></span></span>
41
+ &raquo;
42
+ <span class="title">SpecialPreopen</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::API::SpecialPreopen
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="NseData::API::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Base.html" title="NseData::API::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next">NseData::API::SpecialPreopen</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/nse_data/api/special_preopen.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>NseData::API::SpecialPreopen inherits from NseData::API::Base and is responsible for fetching the special pre-open market data from the NSE.</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <h2>
124
+ Instance Method Summary
125
+ <small><a href="#" class="summary_toggle">collapse</a></small>
126
+ </h2>
127
+
128
+ <ul class="summary">
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'></div></span>
148
+
149
+ </li>
150
+
151
+
152
+ </ul>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="NseData::API::Base (class)">Base</a></span></h3>
165
+ <p class="inherited"><span class='object_link'><a href="Base.html#fetch-instance_method" title="NseData::API::Base#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="NseData::API::Base#initialize (method)">#initialize</a></span></p>
166
+ <div id="constructor_details" class="method_details_list">
167
+ <h2>Constructor Details</h2>
168
+
169
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="NseData::API::Base#initialize (method)">NseData::API::Base</a></span></p>
170
+
171
+ </div>
172
+
173
+
174
+ <div id="instance_method_details" class="method_details_list">
175
+ <h2>Instance Method Details</h2>
176
+
177
+
178
+ <div class="method_details first">
179
+ <h3 class="signature first" id="endpoint-instance_method">
180
+
181
+ #<strong>endpoint</strong> &#x21d2; <tt>Object</tt>
182
+
183
+
184
+
185
+
186
+
187
+ </h3><table class="source_code">
188
+ <tr>
189
+ <td>
190
+ <pre class="lines">
191
+
192
+
193
+ 8
194
+ 9
195
+ 10</pre>
196
+ </td>
197
+ <td>
198
+ <pre class="code"><span class="info file"># File 'lib/nse_data/api/special_preopen.rb', line 8</span>
199
+
200
+ <span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
201
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>special-preopen-listing</span><span class='tstring_end'>&#39;</span></span>
202
+ <span class='kw'>end</span></pre>
203
+ </td>
204
+ </tr>
205
+ </table>
206
+ </div>
207
+
208
+ </div>
209
+
210
+ </div>
211
+
212
+ <div id="footer">
213
+ Generated on Thu Sep 5 12:14:01 2024 by
214
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
215
+ 0.9.37 (ruby-3.2.2).
216
+ </div>
217
+
218
+ </div>
219
+ </body>
220
+ </html>
data/doc/NseData/API.html ADDED
@@ -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::API
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::API";
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">API</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::API
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/api/base.rb<span class="defines">,<br />
82
+ lib/nse_data/api/special_preopen.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="API/Base.html" title="NseData::API::Base (class)">Base</a></span>, <span class='object_link'><a href="API/SpecialPreopen.html" title="NseData::API::SpecialPreopen (class)">SpecialPreopen</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 Thu Sep 5 12:14:01 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>