📝 CHANGELOG.md PR links

pboling · pboling · commit 2974db93f1b7 · 2025-08-31T05:32:32.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,19 +31,25 @@ Please file a bug if you notice a violation of semantic versioning.
 - 90.48% documented
 ### Added
 - improved documentation by @pboling
-- Document Mutual TLS (mTLS) usage with example in README (connection_opts.ssl client_cert/client_key and auth_scheme: :tls_client_auth) by @pboling
-- Document usage of flat query params using Faraday::FlatParamsEncoder, with example URI, in README by @pboling
-- Spec: verify flat params are preserved with Faraday::FlatParamsEncoder (skips on Faraday without FlatParamsEncoder) by @pboling
-- documentation notes in code comments and README highlighting OAuth 2.1 differences, with references, such as: by @pboling
+- [gh665][gh665] - Document Mutual TLS (mTLS) usage with example in README (connection_opts.ssl client_cert/client_key and auth_scheme: :tls_client_auth) by @pboling
+- [gh666][gh666] - Document usage of flat query params using Faraday::FlatParamsEncoder, with example URI, in README by @pboling
+  - Spec: verify flat params are preserved with Faraday::FlatParamsEncoder (skips on Faraday without FlatParamsEncoder)
+- [gh662][gh662] - documentation notes in code comments and README highlighting OAuth 2.1 differences, with references, such as: by @pboling
   - PKCE required for auth code,
   - exact redirect URI match,
   - implicit/password grants omitted,
   - avoid bearer tokens in query,
   - refresh token guidance for public clients,
   - simplified client definitions)
-- document how to implement an OIDC client with this gem in OIDC.md by @pboling
+- [gh663][gh663] - document how to implement an OIDC client with this gem in OIDC.md by @pboling
   - also, list libraries built on top of the oauth2 gem that implement OIDC
-- README: Add example for JHipster UAA (Spring Cloud) password grant, converted from Postman/Net::HTTP by @pboling
+- [gh664][gh664] - README: Add example for JHipster UAA (Spring Cloud) password grant, converted from Postman/Net::HTTP by @pboling
+
+[gh662]: https://github.com/ruby-oauth/oauth2/pull/662
+[gh663]: https://github.com/ruby-oauth/oauth2/pull/663
+[gh664]: https://github.com/ruby-oauth/oauth2/pull/664
+[gh665]: https://github.com/ruby-oauth/oauth2/pull/665
+[gh666]: https://github.com/ruby-oauth/oauth2/pull/666
 
 ## [2.0.13] - 2025-08-30
 - TAG: [v2.0.13][2.0.13t]
diff --git a/docs/OAuth2.html b/docs/OAuth2.html
@@ -415,7 +415,7 @@ <h3 class="signature first" id="configure-class_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Authenticator.html b/docs/OAuth2/Authenticator.html
@@ -883,7 +883,7 @@ <h3 class="signature first" id="apply-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Client.html b/docs/OAuth2/Client.html
@@ -2656,7 +2656,7 @@ <h3 class="signature " id="token_url-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Error.html b/docs/OAuth2/Error.html
@@ -772,7 +772,7 @@ <h3 class="signature " id="response-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes.html b/docs/OAuth2/FilteredAttributes.html
@@ -335,7 +335,7 @@ <h3 class="signature first" id="inspect-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes/ClassMethods.html b/docs/OAuth2/FilteredAttributes/ClassMethods.html
@@ -280,7 +280,7 @@ <h3 class="signature " id="filtered_attributes-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/AuthCode.html b/docs/OAuth2/Strategy/AuthCode.html
@@ -483,7 +483,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Implicit.html b/docs/OAuth2/Strategy/Implicit.html
@@ -420,7 +420,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Password.html b/docs/OAuth2/Strategy/Password.html
@@ -374,7 +374,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:32:00 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Version.html b/docs/OAuth2/Version.html
@@ -111,7 +111,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/_index.html b/docs/_index.html
@@ -87,63 +87,6 @@ <h2>File Listing</h2>
     <li class="r1"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
     
   
-    <li class="r2"><a href="file.CITATION.html" title="CITATION">CITATION</a></li>
-    
-  
-    <li class="r1"><a href="file.oauth2-2.0.10.gem.html" title="oauth2-2.0.10.gem">oauth2-2.0.10.gem</a></li>
-    
-  
-    <li class="r2"><a href="file.oauth2-2.0.11.gem.html" title="oauth2-2.0.11.gem">oauth2-2.0.11.gem</a></li>
-    
-  
-    <li class="r1"><a href="file.oauth2-2.0.12.gem.html" title="oauth2-2.0.12.gem">oauth2-2.0.12.gem</a></li>
-    
-  
-    <li class="r2"><a href="file.oauth2-2.0.13.gem.html" title="oauth2-2.0.13.gem">oauth2-2.0.13.gem</a></li>
-    
-  
-    <li class="r1"><a href="file.oauth2-2.0.10.gem.html" title="oauth2-2.0.10.gem">oauth2-2.0.10.gem</a></li>
-    
-  
-    <li class="r2"><a href="file.oauth2-2.0.11.gem.html" title="oauth2-2.0.11.gem">oauth2-2.0.11.gem</a></li>
-    
-  
-    <li class="r1"><a href="file.oauth2-2.0.12.gem.html" title="oauth2-2.0.12.gem">oauth2-2.0.12.gem</a></li>
-    
-  
-    <li class="r2"><a href="file.oauth2-2.0.13.gem.html" title="oauth2-2.0.13.gem">oauth2-2.0.13.gem</a></li>
-    
-  
-    <li class="r1"><a href="file.REEK.html" title="REEK">REEK</a></li>
-    
-  
-    <li class="r2"><a href="file.access_token.html" title="access_token">access_token</a></li>
-    
-  
-    <li class="r1"><a href="file.authenticator.html" title="authenticator">authenticator</a></li>
-    
-  
-    <li class="r2"><a href="file.client.html" title="client">client</a></li>
-    
-  
-    <li class="r1"><a href="file.error.html" title="error">error</a></li>
-    
-  
-    <li class="r2"><a href="file.filtered_attributes.html" title="filtered_attributes">filtered_attributes</a></li>
-    
-  
-    <li class="r1"><a href="file.response.html" title="response">response</a></li>
-    
-  
-    <li class="r2"><a href="file.strategy.html" title="strategy">strategy</a></li>
-    
-  
-    <li class="r1"><a href="file.version.html" title="version">version</a></li>
-    
-  
-    <li class="r2"><a href="file.oauth2.html" title="oauth2">oauth2</a></li>
-    
-  
   </ul>
 
 <div class="clear"></div>
@@ -366,7 +309,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:12 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CHANGELOG.html b/docs/file.CHANGELOG.html
@@ -87,10 +87,16 @@ <h2 id="2014---2025-08-31">
     <h3 id="added-1">Added</h3>
   </li>
   <li>improved documentation by @pboling</li>
-  <li>Document Mutual TLS (mTLS) usage with example in README (connection_opts.ssl client_cert/client_key and auth_scheme: :tls_client_auth)</li>
-  <li>Document usage of flat query params using Faraday::FlatParamsEncoder, with example URI, in README</li>
-  <li>Spec: verify flat params are preserved with Faraday::FlatParamsEncoder (skips on Faraday without FlatParamsEncoder)</li>
-  <li>documentation notes in code comments and README highlighting OAuth 2.1 differences, with references, such as:
+  <li>
+<a href="https://github.com/ruby-oauth/oauth2/pull/665">gh665</a> - Document Mutual TLS (mTLS) usage with example in README (connection_opts.ssl client_cert/client_key and auth_scheme: :tls_client_auth) by @pboling</li>
+  <li>
+<a href="https://github.com/ruby-oauth/oauth2/pull/666">gh666</a> - Document usage of flat query params using Faraday::FlatParamsEncoder, with example URI, in README by @pboling
+    <ul>
+      <li>Spec: verify flat params are preserved with Faraday::FlatParamsEncoder (skips on Faraday without FlatParamsEncoder)</li>
+    </ul>
+  </li>
+  <li>
+<a href="https://github.com/ruby-oauth/oauth2/pull/662">gh662</a> - documentation notes in code comments and README highlighting OAuth 2.1 differences, with references, such as: by @pboling
     <ul>
       <li>PKCE required for auth code,</li>
       <li>exact redirect URI match,</li>
@@ -100,12 +106,14 @@ <h3 id="added-1">Added</h3>
       <li>simplified client definitions)</li>
     </ul>
   </li>
-  <li>document how to implement an OIDC client with this gem in OIDC.md
+  <li>
+<a href="https://github.com/ruby-oauth/oauth2/pull/663">gh663</a> - document how to implement an OIDC client with this gem in OIDC.md by @pboling
     <ul>
       <li>also, list libraries built on top of the oauth2 gem that implement OIDC</li>
     </ul>
   </li>
-  <li>README: Add example for JHipster UAA (Spring Cloud) password grant, converted from Postman/Net::HTTP</li>
+  <li>
+<a href="https://github.com/ruby-oauth/oauth2/pull/664">gh664</a> - README: Add example for JHipster UAA (Spring Cloud) password grant, converted from Postman/Net::HTTP by @pboling</li>
 </ul>
 
 <h2 id="2013---2025-08-30">
@@ -1262,7 +1270,7 @@ <h2 id="001---2010-04-22">
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html
@@ -191,7 +191,7 @@ <h2 id="attribution">Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CONTRIBUTING.html b/docs/file.CONTRIBUTING.html
@@ -274,7 +274,7 @@ <h4 id="manual-process">Manual process</h4>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.FUNDING.html b/docs/file.FUNDING.html
@@ -104,7 +104,7 @@ <h1 id="another-way-to-support-open-source-software">Another Way to Support Open
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </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) 2017-2025 Peter H. Boling, of Galtzo.com, and oauth2 contributors<br>Copyright (c) 2011-2013 Michael Bleigh and Intridea, Inc.<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 Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.OIDC.html b/docs/file.OIDC.html
@@ -247,7 +247,7 @@ <h2 id="raw-oidc-with-ruby-oauthoauth2">Raw OIDC with ruby-oauth/oauth2</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.README.html b/docs/file.README.html
@@ -1322,7 +1322,7 @@ <h2 id="-security">🔐 Security</h2>
 <h2 id="-contributing">🤝 Contributing</h2>
 
 <p>If you need some ideas of where to help, you could work on adding more code coverage,<br>
-or if it is already 💯 (see <a href="#code-coverage">below</a>) check <a href="file.REEK.html" title="reek">reek</a>, <a href="https://github.com/ruby-oauth/oauth2/issues">issues</a>, or <a href="https://github.com/ruby-oauth/oauth2/pulls">PRs</a>,<br>
+or if it is already 💯 (see <a href="#code-coverage">below</a>) check <a href="REEK">reek</a>, <a href="https://github.com/ruby-oauth/oauth2/issues">issues</a>, or <a href="https://github.com/ruby-oauth/oauth2/pulls">PRs</a>,<br>
 or use the gem and think about how it could be better.</p>
 
 <p>We <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat" alt="Keep A Changelog"></a> so if you make changes, remember to update it.</p>
@@ -1468,7 +1468,7 @@ <h3 id="please-give-the-project-a-star--">Please give the project a star ⭐ ♥
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:12 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.RUBOCOP.html b/docs/file.RUBOCOP.html
@@ -161,7 +161,7 @@ <h2 id="benefits-of-rubocop_gradual">Benefits of rubocop_gradual</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.SECURITY.html b/docs/file.SECURITY.html
@@ -113,7 +113,7 @@ <h2 id="enterprise-support">Enterprise Support</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 05:27:13 2025 by
+  Generated on Sun Aug 31 05:31:59 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file_list.html b/docs/file_list.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
