api_wrapper 0.1.6
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 +18 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Gemfile +22 -0
- data/LICENSE.txt +21 -0
- data/README.md +153 -0
- data/Rakefile +31 -0
- data/api_wrapper.gemspec +34 -0
- data/doc/ApiWrapper/ApiManager.html +807 -0
- data/doc/ApiWrapper/Cache/CachePolicy.html +907 -0
- data/doc/ApiWrapper/Cache/CacheStore.html +674 -0
- data/doc/ApiWrapper/Cache.html +117 -0
- data/doc/ApiWrapper/Configuration.html +366 -0
- data/doc/ApiWrapper/HttpClient/BaseClient.html +349 -0
- data/doc/ApiWrapper/HttpClient/FaradayClient.html +299 -0
- data/doc/ApiWrapper/HttpClient.html +117 -0
- data/doc/ApiWrapper.html +543 -0
- data/doc/_index.html +195 -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 +248 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +248 -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 +286 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/api_wrapper/api_manager.rb +86 -0
- data/lib/api_wrapper/cache/README.md +78 -0
- data/lib/api_wrapper/cache/cache_policy.rb +115 -0
- data/lib/api_wrapper/cache/cache_store.rb +84 -0
- data/lib/api_wrapper/cache/redis_cache_store.rb +3 -0
- data/lib/api_wrapper/http_client/base_client.rb +26 -0
- data/lib/api_wrapper/http_client/faraday_client.rb +81 -0
- data/lib/api_wrapper/version.rb +5 -0
- data/lib/api_wrapper.rb +83 -0
- metadata +121 -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: ApiWrapper::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 = "ApiWrapper::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="../ApiWrapper.html" title="ApiWrapper (module)">ApiWrapper</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: ApiWrapper::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/api_wrapper/http_client/base_client.rb<span class="defines">,<br />
|
|
82
|
+
lib/api_wrapper/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="ApiWrapper::HttpClient::BaseClient (class)">BaseClient</a></span>, <span class='object_link'><a href="HttpClient/FaradayClient.html" title="ApiWrapper::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 Mon Sep 16 23:22:30 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/ApiWrapper.html
ADDED
|
@@ -0,0 +1,543 @@
|
|
|
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: ApiWrapper
|
|
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 = "ApiWrapper";
|
|
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> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">ApiWrapper</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: ApiWrapper
|
|
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/api_wrapper.rb<span class="defines">,<br />
|
|
82
|
+
lib/api_wrapper/version.rb,<br /> lib/api_wrapper/api_manager.rb,<br /> lib/api_wrapper/cache/cache_store.rb,<br /> lib/api_wrapper/cache/cache_policy.rb,<br /> lib/api_wrapper/http_client/base_client.rb,<br /> lib/api_wrapper/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>ApiWrapper provides a unified interface for managing API interactions and caching.</p>
|
|
92
|
+
|
|
93
|
+
<p>It simplifies API management and caching with sensible defaults and customization options.</p>
|
|
94
|
+
|
|
95
|
+
<p>Usage:</p>
|
|
96
|
+
|
|
97
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># Fetch data using default configuration
|
|
98
|
+
</span><span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>ApiWrapper</span><span class='period'>.</span><span class='id identifier rubyid_fetch_data'><span class='object_link'><a href="#fetch_data-class_method" title="ApiWrapper.fetch_data (method)">fetch_data</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>endpoint_key</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
99
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
|
|
100
|
+
|
|
101
|
+
<span class='comment'># Configure with custom settings
|
|
102
|
+
</span><span class='const'>ApiWrapper</span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="#configure-class_method" title="ApiWrapper.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
103
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_configuration_path'>api_configuration_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>custom/path/to/config.yml</span><span class='tstring_end'>'</span></span>
|
|
104
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>=</span> <span class='const'>CustomCacheStore</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
105
|
+
<span class='kw'>end</span>
|
|
106
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>ApiWrapper</span><span class='period'>.</span><span class='id identifier rubyid_fetch_data'><span class='object_link'><a href="#fetch_data-class_method" title="ApiWrapper.fetch_data (method)">fetch_data</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>endpoint_key</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
107
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
|
|
108
|
+
</code></pre>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div><h2>Defined Under Namespace</h2>
|
|
117
|
+
<p class="children">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="ApiWrapper/Cache.html" title="ApiWrapper::Cache (module)">Cache</a></span>, <span class='object_link'><a href="ApiWrapper/HttpClient.html" title="ApiWrapper::HttpClient (module)">HttpClient</a></span>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ApiWrapper/ApiManager.html" title="ApiWrapper::ApiManager (class)">ApiManager</a></span>, <span class='object_link'><a href="ApiWrapper/Configuration.html" title="ApiWrapper::Configuration (class)">Configuration</a></span>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</p>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<h2>
|
|
131
|
+
Constant Summary
|
|
132
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
133
|
+
</h2>
|
|
134
|
+
|
|
135
|
+
<dl class="constants">
|
|
136
|
+
|
|
137
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
138
|
+
|
|
139
|
+
</dt>
|
|
140
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.5</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
141
|
+
|
|
142
|
+
</dl>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<h2>
|
|
153
|
+
Class Method Summary
|
|
154
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
155
|
+
</h2>
|
|
156
|
+
|
|
157
|
+
<ul class="summary">
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#api_manager-class_method" title="api_manager (class method)">.<strong>api_manager</strong> ⇒ Object </a>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="summary_desc"><div class='inline'>
|
|
177
|
+
<p>Returns the singleton ApiManager instance.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#configuration-class_method" title="configuration (class method)">.<strong>configuration</strong> ⇒ Object </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
|
201
|
+
<p>Accesses the configuration instance, initializing if needed.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|configuration| ... } ⇒ Object </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Configures ApiWrapper with a block.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#fetch_data-class_method" title="fetch_data (class method)">.<strong>fetch_data</strong>(endpoint_key, force_refresh: false) ⇒ Object </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Fetches data from the specified endpoint.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#reset_api_manager!-class_method" title="reset_api_manager! (class method)">.<strong>reset_api_manager!</strong> ⇒ Object </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Resets the ApiManager instance.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</ul>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<div id="class_method_details" class="method_details_list">
|
|
285
|
+
<h2>Class Method Details</h2>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<div class="method_details first">
|
|
289
|
+
<h3 class="signature first" id="api_manager-class_method">
|
|
290
|
+
|
|
291
|
+
.<strong>api_manager</strong> ⇒ <tt>Object</tt>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</h3><div class="docstring">
|
|
298
|
+
<div class="discussion">
|
|
299
|
+
|
|
300
|
+
<p>Returns the singleton ApiManager instance</p>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</div>
|
|
304
|
+
</div>
|
|
305
|
+
<div class="tags">
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</div><table class="source_code">
|
|
309
|
+
<tr>
|
|
310
|
+
<td>
|
|
311
|
+
<pre class="lines">
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
66
|
|
315
|
+
67
|
|
316
|
+
68
|
|
317
|
+
69
|
|
318
|
+
70
|
|
319
|
+
71</pre>
|
|
320
|
+
</td>
|
|
321
|
+
<td>
|
|
322
|
+
<pre class="code"><span class="info file"># File 'lib/api_wrapper.rb', line 66</span>
|
|
323
|
+
|
|
324
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_api_manager'>api_manager</span>
|
|
325
|
+
<span class='ivar'>@api_manager</span> <span class='op'>||=</span> <span class='kw'>begin</span>
|
|
326
|
+
<span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='id identifier rubyid_configuration'>configuration</span>
|
|
327
|
+
<span class='const'><span class='object_link'><a href="ApiWrapper/ApiManager.html" title="ApiWrapper::ApiManager (class)">ApiManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ApiWrapper/ApiManager.html#initialize-instance_method" title="ApiWrapper::ApiManager#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_configuration_path'>api_configuration_path</span><span class='comma'>,</span> <span class='label'>cache_store:</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='rparen'>)</span>
|
|
328
|
+
<span class='kw'>end</span>
|
|
329
|
+
<span class='kw'>end</span></pre>
|
|
330
|
+
</td>
|
|
331
|
+
</tr>
|
|
332
|
+
</table>
|
|
333
|
+
</div>
|
|
334
|
+
|
|
335
|
+
<div class="method_details ">
|
|
336
|
+
<h3 class="signature " id="configuration-class_method">
|
|
337
|
+
|
|
338
|
+
.<strong>configuration</strong> ⇒ <tt>Object</tt>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</h3><div class="docstring">
|
|
345
|
+
<div class="discussion">
|
|
346
|
+
|
|
347
|
+
<p>Accesses the configuration instance, initializing if needed</p>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</div>
|
|
351
|
+
</div>
|
|
352
|
+
<div class="tags">
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</div><table class="source_code">
|
|
356
|
+
<tr>
|
|
357
|
+
<td>
|
|
358
|
+
<pre class="lines">
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
53
|
|
362
|
+
54
|
|
363
|
+
55</pre>
|
|
364
|
+
</td>
|
|
365
|
+
<td>
|
|
366
|
+
<pre class="code"><span class="info file"># File 'lib/api_wrapper.rb', line 53</span>
|
|
367
|
+
|
|
368
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
|
|
369
|
+
<span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="ApiWrapper/Configuration.html" title="ApiWrapper::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ApiWrapper/Configuration.html#initialize-instance_method" title="ApiWrapper::Configuration#initialize (method)">new</a></span></span>
|
|
370
|
+
<span class='kw'>end</span></pre>
|
|
371
|
+
</td>
|
|
372
|
+
</tr>
|
|
373
|
+
</table>
|
|
374
|
+
</div>
|
|
375
|
+
|
|
376
|
+
<div class="method_details ">
|
|
377
|
+
<h3 class="signature " id="configure-class_method">
|
|
378
|
+
|
|
379
|
+
.<strong>configure</strong> {|configuration| ... } ⇒ <tt>Object</tt>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</h3><div class="docstring">
|
|
386
|
+
<div class="discussion">
|
|
387
|
+
|
|
388
|
+
<p>Configures ApiWrapper with a block</p>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
</div>
|
|
393
|
+
<div class="tags">
|
|
394
|
+
|
|
395
|
+
<p class="tag_title">Yields:</p>
|
|
396
|
+
<ul class="yield">
|
|
397
|
+
|
|
398
|
+
<li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<span class='type'>(<tt><span class='object_link'><a href="#configuration-class_method" title="ApiWrapper.configuration (method)">configuration</a></span></tt>)</span>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</li>
|
|
406
|
+
|
|
407
|
+
</ul>
|
|
408
|
+
<p class="tag_title">Raises:</p>
|
|
409
|
+
<ul class="raise">
|
|
410
|
+
|
|
411
|
+
<li>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</li>
|
|
419
|
+
|
|
420
|
+
</ul>
|
|
421
|
+
|
|
422
|
+
</div><table class="source_code">
|
|
423
|
+
<tr>
|
|
424
|
+
<td>
|
|
425
|
+
<pre class="lines">
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
58
|
|
429
|
+
59
|
|
430
|
+
60
|
|
431
|
+
61
|
|
432
|
+
62
|
|
433
|
+
63</pre>
|
|
434
|
+
</td>
|
|
435
|
+
<td>
|
|
436
|
+
<pre class="code"><span class="info file"># File 'lib/api_wrapper.rb', line 58</span>
|
|
437
|
+
|
|
438
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
|
|
439
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Configuration block required</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
|
440
|
+
|
|
441
|
+
<span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span>
|
|
442
|
+
<span class='id identifier rubyid_reset_api_manager!'>reset_api_manager!</span>
|
|
443
|
+
<span class='kw'>end</span></pre>
|
|
444
|
+
</td>
|
|
445
|
+
</tr>
|
|
446
|
+
</table>
|
|
447
|
+
</div>
|
|
448
|
+
|
|
449
|
+
<div class="method_details ">
|
|
450
|
+
<h3 class="signature " id="fetch_data-class_method">
|
|
451
|
+
|
|
452
|
+
.<strong>fetch_data</strong>(endpoint_key, force_refresh: false) ⇒ <tt>Object</tt>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</h3><div class="docstring">
|
|
459
|
+
<div class="discussion">
|
|
460
|
+
|
|
461
|
+
<p>Fetches data from the specified endpoint</p>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</div>
|
|
465
|
+
</div>
|
|
466
|
+
<div class="tags">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div><table class="source_code">
|
|
470
|
+
<tr>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="lines">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
74
|
|
476
|
+
75
|
|
477
|
+
76</pre>
|
|
478
|
+
</td>
|
|
479
|
+
<td>
|
|
480
|
+
<pre class="code"><span class="info file"># File 'lib/api_wrapper.rb', line 74</span>
|
|
481
|
+
|
|
482
|
+
<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>
|
|
483
|
+
<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_endpoint_key'>endpoint_key</span><span class='comma'>,</span> <span class='label'>force_refresh:</span><span class='rparen'>)</span>
|
|
484
|
+
<span class='kw'>end</span></pre>
|
|
485
|
+
</td>
|
|
486
|
+
</tr>
|
|
487
|
+
</table>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
<div class="method_details ">
|
|
491
|
+
<h3 class="signature " id="reset_api_manager!-class_method">
|
|
492
|
+
|
|
493
|
+
.<strong>reset_api_manager!</strong> ⇒ <tt>Object</tt>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</h3><div class="docstring">
|
|
500
|
+
<div class="discussion">
|
|
501
|
+
|
|
502
|
+
<p>Resets the ApiManager instance</p>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
</div>
|
|
506
|
+
</div>
|
|
507
|
+
<div class="tags">
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</div><table class="source_code">
|
|
511
|
+
<tr>
|
|
512
|
+
<td>
|
|
513
|
+
<pre class="lines">
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
79
|
|
517
|
+
80
|
|
518
|
+
81</pre>
|
|
519
|
+
</td>
|
|
520
|
+
<td>
|
|
521
|
+
<pre class="code"><span class="info file"># File 'lib/api_wrapper.rb', line 79</span>
|
|
522
|
+
|
|
523
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reset_api_manager!'>reset_api_manager!</span>
|
|
524
|
+
<span class='ivar'>@api_manager</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
525
|
+
<span class='kw'>end</span></pre>
|
|
526
|
+
</td>
|
|
527
|
+
</tr>
|
|
528
|
+
</table>
|
|
529
|
+
</div>
|
|
530
|
+
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
<div id="footer">
|
|
536
|
+
Generated on Mon Sep 16 23:22:30 2024 by
|
|
537
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
538
|
+
0.9.37 (ruby-3.2.2).
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
</body>
|
|
543
|
+
</html>
|