📝 Update documentation

pboling · pboling · commit 0b499963e59d · 2025-06-01T00:43:12.000+07:00
diff --git a/.rubocop_gradual.lock b/.rubocop_gradual.lock
@@ -21,7 +21,7 @@
   "lib/oauth2/response.rb:2054901929": [
     [53, 5, 204, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 996912427]
   ],
-  "oauth2.gemspec:3059367295": [
+  "oauth2.gemspec:232642695": [
     [5, 23, 12, "Gemspec/RubyVersionGlobalsUsage: Do not use `RUBY_VERSION` in gemspec file.", 31296028]
   ],
   "spec/oauth2/access_token_spec.rb:1202129469": [
diff --git a/REEK b/REEK
@@ -99,7 +99,7 @@ lib/oauth2/response.rb -- 12 warnings:
   [106]:TooManyStatements: OAuth2::Response#parsed has approx 7 statements [https://github.com/troessner/reek/blob/v6.5.0/docs/Too-Many-Statements.md]
   [7]:UncommunicativeModuleName: OAuth2 has the name 'OAuth2' [https://github.com/troessner/reek/blob/v6.5.0/docs/Uncommunicative-Module-Name.md]
 lib/oauth2/strategy/assertion.rb -- 5 warnings:
-  [96, 96, 98, 98]:FeatureEnvy: OAuth2::Strategy::Assertion#build_assertion refers to 'encoding_opts' more than self (maybe move it to another class?) [https://github.com/troessner/reek/blob/v6.5.0/docs/Feature-Envy.md]
+  [96, 96, 99, 99, 101, 101]:FeatureEnvy: OAuth2::Strategy::Assertion#build_assertion refers to 'encoding_opts' more than self (maybe move it to another class?) [https://github.com/troessner/reek/blob/v6.5.0/docs/Feature-Envy.md]
   [32]:InstanceVariableAssumption: OAuth2::Strategy::Assertion assumes too much for instance variable '@client' [https://github.com/troessner/reek/blob/v6.5.0/docs/Instance-Variable-Assumption.md]
   [79]:LongParameterList: OAuth2::Strategy::Assertion#get_token has 4 parameters [https://github.com/troessner/reek/blob/v6.5.0/docs/Long-Parameter-List.md]
   [5]:UncommunicativeModuleName: OAuth2 has the name 'OAuth2' [https://github.com/troessner/reek/blob/v6.5.0/docs/Uncommunicative-Module-Name.md]
diff --git a/docs/OAuth2.html b/docs/OAuth2.html
@@ -326,7 +326,7 @@ <h3 class="signature first" id="configure-class_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/AccessToken.html b/docs/OAuth2/AccessToken.html
@@ -3069,7 +3069,7 @@ <h3 class="signature " id="to_hash-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Authenticator.html b/docs/OAuth2/Authenticator.html
@@ -631,7 +631,7 @@ <h3 class="signature first" id="apply-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Client.html b/docs/OAuth2/Client.html
@@ -2651,7 +2651,7 @@ <h3 class="signature " id="token_url-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Error.html b/docs/OAuth2/Error.html
@@ -518,7 +518,7 @@ <h3 class="signature " id="response-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes.html b/docs/OAuth2/FilteredAttributes.html
@@ -268,7 +268,7 @@ <h3 class="signature first" id="inspect-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes/ClassMethods.html b/docs/OAuth2/FilteredAttributes/ClassMethods.html
@@ -218,7 +218,7 @@ <h3 class="signature " id="filtered_attributes-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Response.html b/docs/OAuth2/Response.html
@@ -1619,7 +1619,7 @@ <h3 class="signature " id="status-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy.html b/docs/OAuth2/Strategy.html
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/Assertion.html b/docs/OAuth2/Strategy/Assertion.html
@@ -481,7 +481,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/AuthCode.html b/docs/OAuth2/Strategy/AuthCode.html
@@ -469,7 +469,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/Base.html b/docs/OAuth2/Strategy/Base.html
@@ -195,7 +195,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/ClientCredentials.html b/docs/OAuth2/Strategy/ClientCredentials.html
@@ -343,7 +343,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/Implicit.html b/docs/OAuth2/Strategy/Implicit.html
@@ -410,7 +410,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Strategy/Password.html b/docs/OAuth2/Strategy/Password.html
@@ -364,7 +364,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/OAuth2/Version.html b/docs/OAuth2/Version.html
@@ -111,7 +111,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/_index.html b/docs/_index.html
@@ -78,6 +78,9 @@ <h2>File Listing</h2>
     <li class="r2"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
     
   
+    <li class="r1"><a href="file.CITATION.html" title="CITATION">CITATION</a></li>
+    
+  
   </ul>
 
 <div class="clear"></div>
@@ -300,7 +303,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.CHANGELOG.html b/docs/file.CHANGELOG.html
@@ -801,7 +801,7 @@ <h2 id="001---2010-04-22-tag">
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.CITATION.html b/docs/file.CITATION.html
@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: CITATION
+  
+    &mdash; Documentation by YARD 0.9.37
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "CITATION";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="file_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: CITATION</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><div id='filecontents'><p>cff-version: 1.2.0<br>
+title: oauth2<br>
+message: &gt;-<br>
+  If you use this work and you want to cite it,<br>
+  then you can use the metadata from this file.<br>
+type: software<br>
+authors:</p>
+<ul>
+  <li>given-names: Peter Hurn<br>
+family-names: Boling<br>
+email: peter@railsbling.com<br>
+affiliation: railsbling.com<br>
+orcid: ‘https://orcid.org/0009-0008-8519-441X’</li>
+  <li>given-names: Aboling0<br>
+email: aboling@railsbling.com<br>
+affiliation: railsbling.com<br>
+identifiers:</li>
+  <li>type: url<br>
+value: ‘https://github.com/oauth-xx/oauth2’<br>
+description: oauth2<br>
+repository-code: ‘https://github.com/oauth-xx/oauth2’<br>
+abstract: &gt;-<br>
+  oauth2<br>
+license: See license file</li>
+</ul>
+</div></div>
+
+      <div id="footer">
+  Generated on Sun Jun  1 00:42:25 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.4.3).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html
@@ -192,7 +192,7 @@ <h2 id="attribution">Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.CONTRIBUTING.html b/docs/file.CONTRIBUTING.html
@@ -195,7 +195,7 @@ <h3 id="to-release-a-new-version">To release a new version:</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.LICENSE.html b/docs/file.LICENSE.html
@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>MIT License<br><br>Copyright (c) 2011 - 2013 Michael Bleigh and Intridea, Inc.<br>Copyright (c) 2017 - 2025 Peter H. Boling, of RailsBling.com, and OAuth2 contributors<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy<br>of this software and associated documentation files (the "Software"), to deal<br>in the Software without restriction, including without limitation the rights<br>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br>copies of the Software, and to permit persons to whom the Software is<br>furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in all<br>copies or substantial portions of the Software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE<br>SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.README.html b/docs/file.README.html
@@ -969,7 +969,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file.SECURITY.html b/docs/file.SECURITY.html
@@ -110,7 +110,7 @@ <h2 id="oauth2-for-enterprise">OAuth2 for Enterprise</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/file_list.html b/docs/file_list.html
@@ -77,6 +77,11 @@ <h1 id="full_list_header">File List</h1>
   </li>
   
 
+  <li id="object_CITATION" class="odd">
+    <div class="item"><span class="object_link"><a href="file.CITATION.html" title="CITATION">CITATION</a></span></div>
+  </li>
+  
+
 
       </ul>
     </div>
diff --git a/docs/index.html b/docs/index.html
@@ -969,7 +969,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
@@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Fri May 30 01:46:41 2025 by
+  Generated on Sun Jun  1 00:42:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
