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,349 @@
|
|
|
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::HttpClient::BaseClient
|
|
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::BaseClient";
|
|
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="../HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">BaseClient</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::HttpClient::BaseClient
|
|
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::HttpClient::BaseClient</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/http_client/base_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Base class for HTTP clients</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="FaradayClient.html" title="NseData::HttpClient::FaradayClient (class)">FaradayClient</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="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(endpoint) ⇒ Object </a>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
|
150
|
+
<p>Sends a GET request to the specified endpoint.</p>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<li class="public ">
|
|
157
|
+
<span class="summary_signature">
|
|
158
|
+
|
|
159
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(base_url, cache_policy) ⇒ BaseClient </a>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<span class="note title constructor">constructor</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
|
176
|
+
<p>Initializes a new instance of the BaseClient class.</p>
|
|
177
|
+
</div></span>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</ul>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<div id="constructor_details" class="method_details_list">
|
|
186
|
+
<h2>Constructor Details</h2>
|
|
187
|
+
|
|
188
|
+
<div class="method_details first">
|
|
189
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
190
|
+
|
|
191
|
+
#<strong>initialize</strong>(base_url, cache_policy) ⇒ <tt><span class='object_link'><a href="" title="NseData::HttpClient::BaseClient (class)">BaseClient</a></span></tt>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</h3><div class="docstring">
|
|
198
|
+
<div class="discussion">
|
|
199
|
+
|
|
200
|
+
<p>Initializes a new instance of the BaseClient class.</p>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
<div class="tags">
|
|
206
|
+
<p class="tag_title">Parameters:</p>
|
|
207
|
+
<ul class="param">
|
|
208
|
+
|
|
209
|
+
<li>
|
|
210
|
+
|
|
211
|
+
<span class='name'>base_url</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
—
|
|
219
|
+
<div class='inline'>
|
|
220
|
+
<p>The base URL for the HTTP client.</p>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
</ul>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</div><table class="source_code">
|
|
229
|
+
<tr>
|
|
230
|
+
<td>
|
|
231
|
+
<pre class="lines">
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
10
|
|
235
|
+
11
|
|
236
|
+
12
|
|
237
|
+
13</pre>
|
|
238
|
+
</td>
|
|
239
|
+
<td>
|
|
240
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/http_client/base_client.rb', line 10</span>
|
|
241
|
+
|
|
242
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_base_url'>base_url</span><span class='comma'>,</span> <span class='id identifier rubyid_cache_policy'>cache_policy</span><span class='rparen'>)</span>
|
|
243
|
+
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
|
244
|
+
<span class='ivar'>@cache_policy</span> <span class='op'>=</span> <span class='id identifier rubyid_cache_policy'>cache_policy</span>
|
|
245
|
+
<span class='kw'>end</span></pre>
|
|
246
|
+
</td>
|
|
247
|
+
</tr>
|
|
248
|
+
</table>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<div id="instance_method_details" class="method_details_list">
|
|
255
|
+
<h2>Instance Method Details</h2>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<div class="method_details first">
|
|
259
|
+
<h3 class="signature first" id="get-instance_method">
|
|
260
|
+
|
|
261
|
+
#<strong>get</strong>(endpoint) ⇒ <tt>Object</tt>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</h3><div class="docstring">
|
|
268
|
+
<div class="discussion">
|
|
269
|
+
|
|
270
|
+
<p>Sends a GET request to the specified endpoint.</p>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</div>
|
|
274
|
+
</div>
|
|
275
|
+
<div class="tags">
|
|
276
|
+
<p class="tag_title">Parameters:</p>
|
|
277
|
+
<ul class="param">
|
|
278
|
+
|
|
279
|
+
<li>
|
|
280
|
+
|
|
281
|
+
<span class='name'>endpoint</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
—
|
|
289
|
+
<div class='inline'>
|
|
290
|
+
<p>The endpoint to send the GET request to.</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
<p class="tag_title">Raises:</p>
|
|
298
|
+
<ul class="raise">
|
|
299
|
+
|
|
300
|
+
<li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
—
|
|
308
|
+
<div class='inline'>
|
|
309
|
+
<p>If the method is not implemented by subclasses.</p>
|
|
310
|
+
</div>
|
|
311
|
+
|
|
312
|
+
</li>
|
|
313
|
+
|
|
314
|
+
</ul>
|
|
315
|
+
|
|
316
|
+
</div><table class="source_code">
|
|
317
|
+
<tr>
|
|
318
|
+
<td>
|
|
319
|
+
<pre class="lines">
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
19
|
|
323
|
+
20
|
|
324
|
+
21</pre>
|
|
325
|
+
</td>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/http_client/base_client.rb', line 19</span>
|
|
328
|
+
|
|
329
|
+
<span class='kw'>def</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>
|
|
330
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Subclasses must implement the get method</span><span class='tstring_end'>'</span></span>
|
|
331
|
+
<span class='kw'>end</span></pre>
|
|
332
|
+
</td>
|
|
333
|
+
</tr>
|
|
334
|
+
</table>
|
|
335
|
+
</div>
|
|
336
|
+
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
<div id="footer">
|
|
342
|
+
Generated on Tue Sep 10 12:25:13 2024 by
|
|
343
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
344
|
+
0.9.37 (ruby-3.2.2).
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
</body>
|
|
349
|
+
</html>
|
|
@@ -0,0 +1,301 @@
|
|
|
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::HttpClient::FaradayClient
|
|
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::FaradayClient";
|
|
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 (F)</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="../HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">FaradayClient</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::HttpClient::FaradayClient
|
|
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="BaseClient.html" title="NseData::HttpClient::BaseClient (class)">BaseClient</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="BaseClient.html" title="NseData::HttpClient::BaseClient (class)">BaseClient</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next">NseData::HttpClient::FaradayClient</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/http_client/faraday_client.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>FaradayClient class is responsible for making HTTP requests using Faraday.</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="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(endpoint, force_refresh: false) ⇒ Faraday::Response </a>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'>
|
|
148
|
+
<p>Sends a GET request to the specified endpoint.</p>
|
|
149
|
+
</div></span>
|
|
150
|
+
|
|
151
|
+
</li>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</ul>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseClient.html" title="NseData::HttpClient::BaseClient (class)">BaseClient</a></span></h3>
|
|
167
|
+
<p class="inherited"><span class='object_link'><a href="BaseClient.html#initialize-instance_method" title="NseData::HttpClient::BaseClient#initialize (method)">#initialize</a></span></p>
|
|
168
|
+
<div id="constructor_details" class="method_details_list">
|
|
169
|
+
<h2>Constructor Details</h2>
|
|
170
|
+
|
|
171
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseClient.html#initialize-instance_method" title="NseData::HttpClient::BaseClient#initialize (method)">NseData::HttpClient::BaseClient</a></span></p>
|
|
172
|
+
|
|
173
|
+
</div>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<div id="instance_method_details" class="method_details_list">
|
|
177
|
+
<h2>Instance Method Details</h2>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<div class="method_details first">
|
|
181
|
+
<h3 class="signature first" id="get-instance_method">
|
|
182
|
+
|
|
183
|
+
#<strong>get</strong>(endpoint, force_refresh: false) ⇒ <tt>Faraday::Response</tt>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</h3><div class="docstring">
|
|
190
|
+
<div class="discussion">
|
|
191
|
+
|
|
192
|
+
<p>Sends a GET request to the specified endpoint.</p>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</div>
|
|
196
|
+
</div>
|
|
197
|
+
<div class="tags">
|
|
198
|
+
<p class="tag_title">Parameters:</p>
|
|
199
|
+
<ul class="param">
|
|
200
|
+
|
|
201
|
+
<li>
|
|
202
|
+
|
|
203
|
+
<span class='name'>endpoint</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
—
|
|
211
|
+
<div class='inline'>
|
|
212
|
+
<p>The endpoint to send the request to.</p>
|
|
213
|
+
</div>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
<li>
|
|
218
|
+
|
|
219
|
+
<span class='name'>force_refresh</span>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
—
|
|
229
|
+
<div class='inline'>
|
|
230
|
+
<p>Whether to force a cache refresh.</p>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
</ul>
|
|
236
|
+
|
|
237
|
+
<p class="tag_title">Returns:</p>
|
|
238
|
+
<ul class="return">
|
|
239
|
+
|
|
240
|
+
<li>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<span class='type'>(<tt>Faraday::Response</tt>)</span>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
—
|
|
248
|
+
<div class='inline'>
|
|
249
|
+
<p>The response object.</p>
|
|
250
|
+
</div>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
</ul>
|
|
255
|
+
|
|
256
|
+
</div><table class="source_code">
|
|
257
|
+
<tr>
|
|
258
|
+
<td>
|
|
259
|
+
<pre class="lines">
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
17
|
|
263
|
+
18
|
|
264
|
+
19
|
|
265
|
+
20
|
|
266
|
+
21
|
|
267
|
+
22
|
|
268
|
+
23
|
|
269
|
+
24
|
|
270
|
+
25</pre>
|
|
271
|
+
</td>
|
|
272
|
+
<td>
|
|
273
|
+
<pre class="code"><span class="info file"># File 'lib/nse_data/http_client/faraday_client.rb', line 17</span>
|
|
274
|
+
|
|
275
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='label'>force_refresh:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
276
|
+
<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'>"</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'>: invoking the endpoint </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
277
|
+
<span class='comment'># Use the cache policy to determine whether to fetch from cache or refresh.
|
|
278
|
+
</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='comma'>,</span> <span class='label'>force_refresh:</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
|
279
|
+
<span class='id identifier rubyid_handle_connection'>handle_connection</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_connection'>connection</span><span class='op'>|</span>
|
|
280
|
+
<span class='id identifier rubyid_connection'>connection</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>
|
|
281
|
+
<span class='kw'>end</span>
|
|
282
|
+
<span class='kw'>end</span>
|
|
283
|
+
<span class='kw'>end</span></pre>
|
|
284
|
+
</td>
|
|
285
|
+
</tr>
|
|
286
|
+
</table>
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
<div id="footer">
|
|
294
|
+
Generated on Tue Sep 10 12:25:13 2024 by
|
|
295
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
296
|
+
0.9.37 (ruby-3.2.2).
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
</div>
|
|
300
|
+
</body>
|
|
301
|
+
</html>
|