Merge pull request #41 from ahasunos/ss/update-changelog

chore: update changelog uri and docs
ahasunos · Sep 10, 2024 · 055fc39 · 055fc39
2 parents 75ee0f9 + 5e95962
commit 055fc39
Show file tree

Hide file tree

Showing 19 changed files with 1,488 additions and 48 deletions.
diff --git a/doc/NseData.html b/doc/NseData.html
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/nse_data.rb<span class="defines">,<br />
-  lib/nse_data/version.rb,<br /> lib/nse_data/api_manager.rb,<br /> lib/nse_data/cache/cache_store.rb,<br /> lib/nse_data/cache/cache_policy.rb,<br /> lib/nse_data/http_client/base_client.rb,<br /> lib/nse_data/http_client/faraday_client.rb</span>
+  lib/nse_data/version.rb,<br /> lib/nse_data/api_manager.rb,<br /> lib/nse_data/config/base.rb,<br /> lib/nse_data/config/logger.rb,<br /> lib/nse_data/cache/cache_store.rb,<br /> lib/nse_data/cache/cache_policy.rb,<br /> lib/nse_data/http_client/base_client.rb,<br /> lib/nse_data/http_client/faraday_client.rb</span>
 </dd>
   </dl>
 
@@ -100,7 +100,7 @@ <h2>Overview</h2><div class="docstring">
 <p class="children">
 
 
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="NseData/Cache.html" title="NseData::Cache (module)">Cache</a></span>, <span class='object_link'><a href="NseData/HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="NseData/Cache.html" title="NseData::Cache (module)">Cache</a></span>, <span class='object_link'><a href="NseData/Config.html" title="NseData::Config (module)">Config</a></span>, <span class='object_link'><a href="NseData/HttpClient.html" title="NseData::HttpClient (module)">HttpClient</a></span>
 
 
 
@@ -120,7 +120,7 @@ <h2>
         <dt id="VERSION-constant" class="">VERSION =
 
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.12</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
 
     </dl>
 
@@ -142,6 +142,30 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
+      <a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|config| ... } &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+<p>Configure the logger for the NseData gem.</p>
+</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
       <a href="#define_api_methods-class_method" title="define_api_methods (class method)">.<strong>define_api_methods</strong>  &#x21d2; Object </a>
 
 
@@ -184,6 +208,30 @@ <h2>
 <p>Returns a list of all available endpoints.</p>
 </div></span>
 
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#logger-class_method" title="logger (class method)">.<strong>logger</strong>  &#x21d2; Logger </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+<p>Access the configured logger.</p>
+</div></span>
+
 </li>
 
 
@@ -197,7 +245,83 @@ <h2>Class Method Details</h2>
 
 
       <div class="method_details first">
-  <h3 class="signature first" id="define_api_methods-class_method">
+  <h3 class="signature first" id="configure-class_method">
+
+    .<strong>configure</strong> {|config| ... } &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+
+<p>Configure the logger for the NseData gem.</p>
+
+<p>This method allows users to customize the logger used throughout the library. To use it, call ‘NseData.configure` and provide a block to set up the logger.</p>
+
+<p>Example:</p>
+
+<p>NseData.configure do |config|</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_custom_logger'>custom_logger</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nse_data.log</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_custom_logger'>custom_logger</span><span class='period'>.</span><span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span>
+<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_custom_logger'>custom_logger</span>
+</code></pre>
+
+<p>end</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Yield Parameters:</p>
+<ul class="yieldparam">
+
+    <li>
+
+        <span class='name'>config</span>
+
+
+        <span class='type'>(<tt><span class='object_link'><a href="NseData/Config/Logger.html" title="NseData::Config::Logger (class)">NseData::Config::Logger</a></span></tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>The configuration object to be customized.</p>
+</div>
+
+    </li>
+
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+45
+46
+47
+48</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 45</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
+  <span class='ivar'>@logger_config</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="NseData/Config.html" title="NseData::Config (module)">Config</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NseData/Config/Logger.html" title="NseData::Config::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/Config/Logger.html#initialize-instance_method" title="NseData::Config::Logger#initialize (method)">new</a></span></span>
+  <span class='kw'>yield</span><span class='lparen'>(</span><span class='ivar'>@logger_config</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="define_api_methods-class_method">
 
     .<strong>define_api_methods</strong>  &#x21d2; <tt>Object</tt> 
 
@@ -222,19 +346,19 @@ <h3 class="signature first" id="define_api_methods-class_method">
       <pre class="lines">
 
 
-13
-14
 15
 16
 17
 18
 19
-20</pre>
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 15</span>
 
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_define_api_methods'>define_api_methods</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_define_api_methods'>define_api_methods</span>
   <span class='id identifier rubyid_api_manager'>api_manager</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NseData/APIManager.html" title="NseData::APIManager (class)">APIManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/APIManager.html#initialize-instance_method" title="NseData::APIManager#initialize (method)">new</a></span></span>
   <span class='id identifier rubyid_api_manager'>api_manager</span><span class='period'>.</span><span class='id identifier rubyid_endpoints'>endpoints</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_method_name'>method_name</span><span class='op'>|</span>
     <span class='id identifier rubyid_define_singleton_method'>define_singleton_method</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>fetch_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method_name'>method_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
@@ -291,27 +415,106 @@ <h3 class="signature " id="list_all_endpoints-class_method">
       <pre class="lines">
 
 
-25
-26
-27</pre>
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 27</span>
 
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_all_endpoints'>list_all_endpoints</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_list_all_endpoints'>list_all_endpoints</span>
   <span class='ivar'>@list_all_endpoints</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="NseData/APIManager.html" title="NseData::APIManager (class)">APIManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NseData/APIManager.html#initialize-instance_method" title="NseData::APIManager#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_load_endpoints'><span class='object_link'><a href="NseData/APIManager.html#load_endpoints-instance_method" title="NseData::APIManager#load_endpoints (method)">load_endpoints</a></span></span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="logger-class_method">
+
+    .<strong>logger</strong>  &#x21d2; <tt>Logger</tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+
+<p>Access the configured logger.</p>
+
+<p>This method returns the Logger instance configured through ‘NseData.configure`.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+    <li>
+
+
+        <span class='type'>(<tt>Logger</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>The configured Logger instance.</p>
+</div>
+
+    </li>
+
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+
+    <li>
+
+
+        <span class='type'>(<tt>RuntimeError</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>If the logger has not been configured.</p>
+</div>
+
+    </li>
+
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+56
+57
+58</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/nse_data.rb', line 56</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
+  <span class='ivar'>@logger_config</span><span class='op'>&amp;.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Logger not configured. Please call NseData.configure first.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
 
   </div>
 
 </div>
 
       <div id="footer">
-  Generated on Sat Sep  7 18:06:52 2024 by
+  Generated on Tue Sep 10 12:25:13 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.2.2).
 </div>

diff --git a/doc/NseData/APIManager.html b/doc/NseData/APIManager.html
@@ -391,12 +391,12 @@ <h3 class="signature first" id="endpoints-instance_method">
       <pre class="lines">
 
 
-61
 62
-63</pre>
+63
+64</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 61</span>
+      <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 62</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
   <span class='ivar'>@endpoints</span>
@@ -521,12 +521,14 @@ <h3 class="signature first" id="fetch_data-instance_method">
 42
 43
 44
-45</pre>
+45
+46</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 37</span>
 
 <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>
+  <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>
   <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>
   <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>
 
@@ -602,17 +604,17 @@ <h3 class="signature " id="load_endpoints-instance_method">
       <pre class="lines">
 
 
-51
 52
 53
 54
 55
 56
 57
-58</pre>
+58
+59</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 51</span>
+      <pre class="code"><span class="info file"># File 'lib/nse_data/api_manager.rb', line 52</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_load_endpoints'>load_endpoints</span>
   <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>
@@ -632,7 +634,7 @@ <h3 class="signature " id="load_endpoints-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sat Sep  7 18:06:52 2024 by
+  Generated on Tue Sep 10 12:25:13 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.2.2).
 </div>

diff --git a/doc/NseData/Cache.html b/doc/NseData/Cache.html
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Sat Sep  7 18:06:52 2024 by
+  Generated on Tue Sep 10 12:25:13 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.2.2).
 </div>

diff --git a/doc/NseData/Cache/CachePolicy.html b/doc/NseData/Cache/CachePolicy.html
@@ -897,7 +897,7 @@ <h3 class="signature " id="use_cache?-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sat Sep  7 18:06:52 2024 by
+  Generated on Tue Sep 10 12:25:13 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.2.2).
 </div>