From bcb0e40bfca989f164a04cbf46a4175822b7cb28 Mon Sep 17 00:00:00 2001 From: "Peter H. Boling" Date: Fri, 7 Nov 2025 21:16:06 -0700 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20typos=20in=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +- docs/OAuth2.html | 2 +- docs/OAuth2/AccessToken.html | 2 +- docs/OAuth2/Authenticator.html | 2 +- docs/OAuth2/Client.html | 2 +- docs/OAuth2/Error.html | 2 +- docs/OAuth2/FilteredAttributes.html | 2 +- .../FilteredAttributes/ClassMethods.html | 2 +- docs/OAuth2/Response.html | 2 +- docs/OAuth2/Strategy.html | 2 +- docs/OAuth2/Strategy/Assertion.html | 2 +- docs/OAuth2/Strategy/AuthCode.html | 2 +- docs/OAuth2/Strategy/Base.html | 2 +- docs/OAuth2/Strategy/ClientCredentials.html | 2 +- docs/OAuth2/Strategy/Implicit.html | 2 +- docs/OAuth2/Strategy/Password.html | 2 +- docs/OAuth2/Version.html | 2 +- docs/_index.html | 2 +- docs/file.CHANGELOG.html | 2 +- docs/file.CODE_OF_CONDUCT.html | 2 +- docs/file.CONTRIBUTING.html | 2 +- docs/file.FUNDING.html | 2 +- docs/file.IRP.html | 2 +- docs/file.LICENSE.html | 2 +- docs/file.OIDC.html | 2 +- docs/file.README.html | 160 +++++++++--------- docs/file.RUBOCOP.html | 2 +- docs/file.SECURITY.html | 2 +- docs/file.THREAT_MODEL.html | 2 +- docs/index.html | 160 +++++++++--------- docs/top-level-namespace.html | 2 +- 31 files changed, 192 insertions(+), 192 deletions(-) diff --git a/README.md b/README.md index 13ab7ba0..65e7d6bc 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ NOTE: `header` - The content type specified in the `curl` is already the default -
Complete E2E single file script against mock-oauth2-server - E2E example uses [navikt/mock-oauth2-server](https://github.com/navikt/mock-oauth2-server), which was added in v2.0.11 @@ -304,7 +304,7 @@ Compatibility is further distinguished as "Best Effort Support" or "Incidental S This gem will install on Ruby versions >= v2.2 for 2.x releases. See `1-4-stable` branch for older rubies. -
Ruby Engine Compatibility Policy This gem is tested against MRI, JRuby, and Truffleruby. @@ -315,7 +315,7 @@ see [gemfiles/README.md](gemfiles/README.md), then submit a PR to the correct ma
-
Ruby Version Compatibility Policy If something doesn't work on one of these interpreters, it's a bug. @@ -470,7 +470,7 @@ They are likely not needed if you are on a newer Ruby. Expand the examples below, or the [ruby-oauth/snaky_hash](https://gitlab.com/ruby-oauth/snaky_hash) gem, or [response_spec.rb](https://github.com/ruby-oauth/oauth2/blob/main/spec/oauth2/response_spec.rb), for more ideas, especially if you need to study the hacks for older Rubies. -
See Examples ```ruby diff --git a/docs/OAuth2.html b/docs/OAuth2.html index 1ffcdd17..8f5751f6 100644 --- a/docs/OAuth2.html +++ b/docs/OAuth2.html @@ -415,7 +415,7 @@

diff --git a/docs/OAuth2/AccessToken.html b/docs/OAuth2/AccessToken.html index 2d0ed1df..1db81ede 100644 --- a/docs/OAuth2/AccessToken.html +++ b/docs/OAuth2/AccessToken.html @@ -3083,7 +3083,7 @@

diff --git a/docs/OAuth2/Authenticator.html b/docs/OAuth2/Authenticator.html index 53736878..d1a2fe57 100644 --- a/docs/OAuth2/Authenticator.html +++ b/docs/OAuth2/Authenticator.html @@ -883,7 +883,7 @@

diff --git a/docs/OAuth2/Client.html b/docs/OAuth2/Client.html index 9ff6fc48..62bc3d6f 100644 --- a/docs/OAuth2/Client.html +++ b/docs/OAuth2/Client.html @@ -2654,7 +2654,7 @@

diff --git a/docs/OAuth2/Error.html b/docs/OAuth2/Error.html index 1401cd95..68262584 100644 --- a/docs/OAuth2/Error.html +++ b/docs/OAuth2/Error.html @@ -772,7 +772,7 @@

diff --git a/docs/OAuth2/FilteredAttributes.html b/docs/OAuth2/FilteredAttributes.html index 7c738657..13010514 100644 --- a/docs/OAuth2/FilteredAttributes.html +++ b/docs/OAuth2/FilteredAttributes.html @@ -335,7 +335,7 @@

diff --git a/docs/OAuth2/FilteredAttributes/ClassMethods.html b/docs/OAuth2/FilteredAttributes/ClassMethods.html index 75bb5568..2f746c4c 100644 --- a/docs/OAuth2/FilteredAttributes/ClassMethods.html +++ b/docs/OAuth2/FilteredAttributes/ClassMethods.html @@ -280,7 +280,7 @@

diff --git a/docs/OAuth2/Response.html b/docs/OAuth2/Response.html index dccdc25b..79f4fe2f 100644 --- a/docs/OAuth2/Response.html +++ b/docs/OAuth2/Response.html @@ -1619,7 +1619,7 @@

diff --git a/docs/OAuth2/Strategy.html b/docs/OAuth2/Strategy.html index c629c668..ba6f9096 100644 --- a/docs/OAuth2/Strategy.html +++ b/docs/OAuth2/Strategy.html @@ -107,7 +107,7 @@

Defined Under Namespace

diff --git a/docs/OAuth2/Strategy/Assertion.html b/docs/OAuth2/Strategy/Assertion.html index 6153d6fa..24d17623 100644 --- a/docs/OAuth2/Strategy/Assertion.html +++ b/docs/OAuth2/Strategy/Assertion.html @@ -481,7 +481,7 @@

diff --git a/docs/OAuth2/Strategy/AuthCode.html b/docs/OAuth2/Strategy/AuthCode.html index d5081e25..90253890 100644 --- a/docs/OAuth2/Strategy/AuthCode.html +++ b/docs/OAuth2/Strategy/AuthCode.html @@ -479,7 +479,7 @@

diff --git a/docs/OAuth2/Strategy/Base.html b/docs/OAuth2/Strategy/Base.html index dd410d38..7ad9e5bb 100644 --- a/docs/OAuth2/Strategy/Base.html +++ b/docs/OAuth2/Strategy/Base.html @@ -195,7 +195,7 @@

diff --git a/docs/OAuth2/Strategy/ClientCredentials.html b/docs/OAuth2/Strategy/ClientCredentials.html index efa4fdb8..1c69124f 100644 --- a/docs/OAuth2/Strategy/ClientCredentials.html +++ b/docs/OAuth2/Strategy/ClientCredentials.html @@ -343,7 +343,7 @@

diff --git a/docs/OAuth2/Strategy/Implicit.html b/docs/OAuth2/Strategy/Implicit.html index 32f63999..b03f9047 100644 --- a/docs/OAuth2/Strategy/Implicit.html +++ b/docs/OAuth2/Strategy/Implicit.html @@ -418,7 +418,7 @@

diff --git a/docs/OAuth2/Strategy/Password.html b/docs/OAuth2/Strategy/Password.html index 91d2fe7c..83b4d0be 100644 --- a/docs/OAuth2/Strategy/Password.html +++ b/docs/OAuth2/Strategy/Password.html @@ -372,7 +372,7 @@

diff --git a/docs/OAuth2/Version.html b/docs/OAuth2/Version.html index 35c06cb4..a997000b 100644 --- a/docs/OAuth2/Version.html +++ b/docs/OAuth2/Version.html @@ -111,7 +111,7 @@

diff --git a/docs/_index.html b/docs/_index.html index f023b32d..0535ab06 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -315,7 +315,7 @@

Namespace Listing A-Z

diff --git a/docs/file.CHANGELOG.html b/docs/file.CHANGELOG.html index b22f44a2..ce161097 100644 --- a/docs/file.CHANGELOG.html +++ b/docs/file.CHANGELOG.html @@ -1299,7 +1299,7 @@

diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html index 818acbd7..732d3293 100644 --- a/docs/file.CODE_OF_CONDUCT.html +++ b/docs/file.CODE_OF_CONDUCT.html @@ -191,7 +191,7 @@

Attribution

diff --git a/docs/file.CONTRIBUTING.html b/docs/file.CONTRIBUTING.html index 08f3438c..48eef79e 100644 --- a/docs/file.CONTRIBUTING.html +++ b/docs/file.CONTRIBUTING.html @@ -296,7 +296,7 @@

Manual process

diff --git a/docs/file.FUNDING.html b/docs/file.FUNDING.html index 59b0b074..6d232159 100644 --- a/docs/file.FUNDING.html +++ b/docs/file.FUNDING.html @@ -99,7 +99,7 @@

Another Way to Support Open diff --git a/docs/file.IRP.html b/docs/file.IRP.html index 6664d497..cd701065 100644 --- a/docs/file.IRP.html +++ b/docs/file.IRP.html @@ -203,7 +203,7 @@

Appendix: Example checklist diff --git a/docs/file.LICENSE.html b/docs/file.LICENSE.html index 428dfecc..ac83a495 100644 --- a/docs/file.LICENSE.html +++ b/docs/file.LICENSE.html @@ -60,7 +60,7 @@
MIT License

Copyright (c) 2017-2025 Peter H. Boling, of Galtzo.com, and oauth2 contributors
Copyright (c) 2011-2013 Michael Bleigh and Intridea, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
diff --git a/docs/file.OIDC.html b/docs/file.OIDC.html index e73faa29..b5ebfaf2 100644 --- a/docs/file.OIDC.html +++ b/docs/file.OIDC.html @@ -257,7 +257,7 @@

Optionally: call UserInfo

diff --git a/docs/file.README.html b/docs/file.README.html index f103d44c..40081e21 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -153,15 +153,15 @@

Quick Examples

-

<details markdown=”1>

-Complete E2E single file script against mock-oauth2-server +
+ Complete E2E single file script against mock-oauth2-server -
    -
  • E2E example uses navikt/mock-oauth2-server, which was added in v2.0.11
    • -
  • E2E example does not ship with the released gem, so clone the source to play with it.
    • -
+
    +
  • E2E example uses navikt/mock-oauth2-server, which was added in v2.0.11
    • +
  • E2E example does not ship with the released gem, so clone the source to play with it.
    • +
-

console +

console docker compose -f docker-compose-ssl.yml up -d --wait ruby examples/e2e.rb # If your machine is slow or Docker pulls are cold, increase the wait: @@ -169,9 +169,9 @@

Quick Examples

# The mock server serves HTTP on 8080; the example points to http://localhost:8080 by default.

-

The output should be something like this:

+

The output should be something like this:

-

console +

console ➜ ruby examples/e2e.rb Access token (truncated): eyJraWQiOiJkZWZhdWx0... userinfo status: 200 @@ -179,69 +179,69 @@

Quick Examples

E2E complete

-

Make sure to shut down the mock server when you are done:

+

Make sure to shut down the mock server when you are done:

-

console +

console docker compose -f docker-compose-ssl.yml down

-

Troubleshooting: validate connectivity to the mock server

+

Troubleshooting: validate connectivity to the mock server

-
    -
  • Check container status and port mapping: -
      -
    • docker compose -f docker-compose-ssl.yml ps
      • -
    -
    • -
  • From the host, try the discovery URL directly (this is what the example uses by default): -
      -
    • curl -v http://localhost:8080/default/.well-known/openid-configuration
      • -
    • If that fails immediately, also try: curl -v --connect-timeout 2 http://127.0.0.1:8080/default/.well-known/openid-configuration +
        +
      • Check container status and port mapping: +
          +
        • docker compose -f docker-compose-ssl.yml ps
          • +
        +
        • +
      • From the host, try the discovery URL directly (this is what the example uses by default): +
          +
        • curl -v http://localhost:8080/default/.well-known/openid-configuration
          • +
        • If that fails immediately, also try: curl -v --connect-timeout 2 http://127.0.0.1:8080/default/.well-known/openid-configuration
          • -
        -
        • -
      • From inside the container (to distinguish container vs. host networking): -
          -
        • docker exec -it oauth2-mock-oauth2-server-1 curl -v http://127.0.0.1:8080/default/.well-known/openid-configuration
          • -
        -
        • -
      • Simple TCP probe from the host: -
          -
        • nc -vz localhost 8080 # or: ruby -rsocket -e 'TCPSocket.new("localhost",8080).close; puts "tcp ok"'
          • -
        -
        • -
      • Inspect which host port 8080 is bound to (should be 8080): -
          -
        • docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' oauth2-mock-oauth2-server-1
          • -
        -
        • -
      • Look at server logs for readiness/errors: -
          -
        • docker logs -n 200 oauth2-mock-oauth2-server-1
          • -
        -
        • -
      • On Linux, ensure nothing else is bound to 8080 and that firewall/SELinux aren’t blocking: -
          -
        • ss -ltnp | grep :8080
          • -
        -
        • -
      +
    +
    • +
  • From inside the container (to distinguish container vs. host networking): +
      +
    • docker exec -it oauth2-mock-oauth2-server-1 curl -v http://127.0.0.1:8080/default/.well-known/openid-configuration
      • +
    +
    • +
  • Simple TCP probe from the host: +
      +
    • nc -vz localhost 8080 # or: ruby -rsocket -e 'TCPSocket.new("localhost",8080).close; puts "tcp ok"'
      • +
    +
    • +
  • Inspect which host port 8080 is bound to (should be 8080): +
      +
    • docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' oauth2-mock-oauth2-server-1
      • +
    +
    • +
  • Look at server logs for readiness/errors: +
      +
    • docker logs -n 200 oauth2-mock-oauth2-server-1
      • +
    +
    • +
  • On Linux, ensure nothing else is bound to 8080 and that firewall/SELinux aren’t blocking: +
      +
    • ss -ltnp | grep :8080
      • +
    +
    • +
-

Notes

+

Notes

-
    -
  • Discovery URL pattern is: http://localhost:8080/<realm>/.well-known/openid-configuration, where <realm> defaults to default.
    • -
  • You can change these with env vars when running the example: -
      -
    • +
        +
      • Discovery URL pattern is: http://localhost:8080/<realm>/.well-known/openid-configuration, where <realm> defaults to default.
        • +
      • You can change these with env vars when running the example: +
          +
        • E2E_ISSUER_BASE (default: http://localhost:8080)
          • -
        • +
        • E2E_REALM (default: default)
          • -
        -
        • -
      +
    +
    • +
-

</details>

+

If it seems like you are in the wrong place, you might try one of these:

@@ -550,34 +550,34 @@

Compatibility

This gem will install on Ruby versions >= v2.2 for 2.x releases. See 1-4-stable branch for older rubies.

-

<details markdown=”1>

-Ruby Engine Compatibility Policy +
+ Ruby Engine Compatibility Policy -

This gem is tested against MRI, JRuby, and Truffleruby. +

This gem is tested against MRI, JRuby, and Truffleruby. Each of those has varying versions that target a specific version of MRI Ruby. This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below. If you would like to add support for additional engines, see gemfiles/README.md, then submit a PR to the correct maintenance branch as according to the table below.

-

</details>

+
-

<details markdown=”1>

-Ruby Version Compatibility Policy +
+ Ruby Version Compatibility Policy -

If something doesn’t work on one of these interpreters, it’s a bug.

+

If something doesn’t work on one of these interpreters, it’s a bug.

-

This library may inadvertently work (or seem to work) on other Ruby +

This library may inadvertently work (or seem to work) on other Ruby implementations; however, support will only be provided for the versions listed above.

-

If you would like this library to support another Ruby version, you may +

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

-

</details>

+
@@ -751,15 +751,15 @@
Serialization Extensions
Expand the examples below, or the ruby-oauth/snaky_hash gem, or response_spec.rb, for more ideas, especially if you need to study the hacks for older Rubies.

-

<details markdown=”1>

-See Examples +
+ See Examples -

```ruby +

```ruby class MySnakyHash < SnakyHash::StringKeyed # Give this hash class dump and load abilities! extend SnakyHash::Serializer

-

#### Serialization Extentions +

#### Serialization Extentions # # Act on the non-hash values (including the values of hashes) as they are dumped to JSON # In other words, this retains nested hashes, and only the deepest leaf nodes become bananas. @@ -768,14 +768,14 @@

Serialization Extensions
“banana” # => Make values “banana” on dump end

-

# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump +

# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump # In other words, this retains nested hashes, and only the deepest leaf nodes become . # WARNING: This is a silly example! load_value_extensions.add(:to_stars) do |value| “” # Turn dumped bananas into *** when they are loaded end

-

# Act on the entire hash as it is prepared for dumping to JSON +

# Act on the entire hash as it is prepared for dumping to JSON # WARNING: This is a silly example! dump_hash_extensions.add(:to_cheese) do |value| if value.is_a?(Hash) @@ -789,7 +789,7 @@

Serialization Extensions
end end

-

# Act on the entire hash as it is loaded from the JSON dump +

# Act on the entire hash as it is loaded from the JSON dump # WARNING: This is a silly example! load_hash_extensions.add(:to_pizza) do |value| if value.is_a?(Hash) @@ -808,7 +808,7 @@

Serialization Extensions
end ```

-

</details>

+

Prefer camelCase over snake_case? => snaky: false

@@ -1677,7 +1677,7 @@

Please give the project a star ⭐ ♥ diff --git a/docs/file.RUBOCOP.html b/docs/file.RUBOCOP.html index 99b4a4b1..a05b5068 100644 --- a/docs/file.RUBOCOP.html +++ b/docs/file.RUBOCOP.html @@ -160,7 +160,7 @@

Benefits of rubocop_gradual

diff --git a/docs/file.SECURITY.html b/docs/file.SECURITY.html index b1a7d6ea..39842b81 100644 --- a/docs/file.SECURITY.html +++ b/docs/file.SECURITY.html @@ -93,7 +93,7 @@

Additional Support

diff --git a/docs/file.THREAT_MODEL.html b/docs/file.THREAT_MODEL.html index d9568287..71e52de8 100644 --- a/docs/file.THREAT_MODEL.html +++ b/docs/file.THREAT_MODEL.html @@ -206,7 +206,7 @@

8. References

diff --git a/docs/index.html b/docs/index.html index 95578274..57948e36 100644 --- a/docs/index.html +++ b/docs/index.html @@ -153,15 +153,15 @@

Quick Examples

-

<details markdown=”1>

-Complete E2E single file script against mock-oauth2-server +
+ Complete E2E single file script against mock-oauth2-server -
    -
  • E2E example uses navikt/mock-oauth2-server, which was added in v2.0.11
    • -
  • E2E example does not ship with the released gem, so clone the source to play with it.
    • -
+
    +
  • E2E example uses navikt/mock-oauth2-server, which was added in v2.0.11
    • +
  • E2E example does not ship with the released gem, so clone the source to play with it.
    • +
-

console +

console docker compose -f docker-compose-ssl.yml up -d --wait ruby examples/e2e.rb # If your machine is slow or Docker pulls are cold, increase the wait: @@ -169,9 +169,9 @@

Quick Examples

# The mock server serves HTTP on 8080; the example points to http://localhost:8080 by default.

-

The output should be something like this:

+

The output should be something like this:

-

console +

console ➜ ruby examples/e2e.rb Access token (truncated): eyJraWQiOiJkZWZhdWx0... userinfo status: 200 @@ -179,69 +179,69 @@

Quick Examples

E2E complete

-

Make sure to shut down the mock server when you are done:

+

Make sure to shut down the mock server when you are done:

-

console +

console docker compose -f docker-compose-ssl.yml down

-

Troubleshooting: validate connectivity to the mock server

+

Troubleshooting: validate connectivity to the mock server

-
    -
  • Check container status and port mapping: -
      -
    • docker compose -f docker-compose-ssl.yml ps
      • -
    -
    • -
  • From the host, try the discovery URL directly (this is what the example uses by default): -
      -
    • curl -v http://localhost:8080/default/.well-known/openid-configuration
      • -
    • If that fails immediately, also try: curl -v --connect-timeout 2 http://127.0.0.1:8080/default/.well-known/openid-configuration +
        +
      • Check container status and port mapping: +
          +
        • docker compose -f docker-compose-ssl.yml ps
          • +
        +
        • +
      • From the host, try the discovery URL directly (this is what the example uses by default): +
          +
        • curl -v http://localhost:8080/default/.well-known/openid-configuration
          • +
        • If that fails immediately, also try: curl -v --connect-timeout 2 http://127.0.0.1:8080/default/.well-known/openid-configuration
          • -
        -
        • -
      • From inside the container (to distinguish container vs. host networking): -
          -
        • docker exec -it oauth2-mock-oauth2-server-1 curl -v http://127.0.0.1:8080/default/.well-known/openid-configuration
          • -
        -
        • -
      • Simple TCP probe from the host: -
          -
        • nc -vz localhost 8080 # or: ruby -rsocket -e 'TCPSocket.new("localhost",8080).close; puts "tcp ok"'
          • -
        -
        • -
      • Inspect which host port 8080 is bound to (should be 8080): -
          -
        • docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' oauth2-mock-oauth2-server-1
          • -
        -
        • -
      • Look at server logs for readiness/errors: -
          -
        • docker logs -n 200 oauth2-mock-oauth2-server-1
          • -
        -
        • -
      • On Linux, ensure nothing else is bound to 8080 and that firewall/SELinux aren’t blocking: -
          -
        • ss -ltnp | grep :8080
          • -
        -
        • -
      +
    +
    • +
  • From inside the container (to distinguish container vs. host networking): +
      +
    • docker exec -it oauth2-mock-oauth2-server-1 curl -v http://127.0.0.1:8080/default/.well-known/openid-configuration
      • +
    +
    • +
  • Simple TCP probe from the host: +
      +
    • nc -vz localhost 8080 # or: ruby -rsocket -e 'TCPSocket.new("localhost",8080).close; puts "tcp ok"'
      • +
    +
    • +
  • Inspect which host port 8080 is bound to (should be 8080): +
      +
    • docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' oauth2-mock-oauth2-server-1
      • +
    +
    • +
  • Look at server logs for readiness/errors: +
      +
    • docker logs -n 200 oauth2-mock-oauth2-server-1
      • +
    +
    • +
  • On Linux, ensure nothing else is bound to 8080 and that firewall/SELinux aren’t blocking: +
      +
    • ss -ltnp | grep :8080
      • +
    +
    • +
-

Notes

+

Notes

-
    -
  • Discovery URL pattern is: http://localhost:8080/<realm>/.well-known/openid-configuration, where <realm> defaults to default.
    • -
  • You can change these with env vars when running the example: -
      -
    • +
        +
      • Discovery URL pattern is: http://localhost:8080/<realm>/.well-known/openid-configuration, where <realm> defaults to default.
        • +
      • You can change these with env vars when running the example: +
          +
        • E2E_ISSUER_BASE (default: http://localhost:8080)
          • -
        • +
        • E2E_REALM (default: default)
          • -
        -
        • -
      +
    +
    • +
-

</details>

+

If it seems like you are in the wrong place, you might try one of these:

@@ -550,34 +550,34 @@

Compatibility

This gem will install on Ruby versions >= v2.2 for 2.x releases. See 1-4-stable branch for older rubies.

-

<details markdown=”1>

-Ruby Engine Compatibility Policy +
+ Ruby Engine Compatibility Policy -

This gem is tested against MRI, JRuby, and Truffleruby. +

This gem is tested against MRI, JRuby, and Truffleruby. Each of those has varying versions that target a specific version of MRI Ruby. This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below. If you would like to add support for additional engines, see gemfiles/README.md, then submit a PR to the correct maintenance branch as according to the table below.

-

</details>

+
-

<details markdown=”1>

-Ruby Version Compatibility Policy +
+ Ruby Version Compatibility Policy -

If something doesn’t work on one of these interpreters, it’s a bug.

+

If something doesn’t work on one of these interpreters, it’s a bug.

-

This library may inadvertently work (or seem to work) on other Ruby +

This library may inadvertently work (or seem to work) on other Ruby implementations; however, support will only be provided for the versions listed above.

-

If you would like this library to support another Ruby version, you may +

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

-

</details>

+
@@ -751,15 +751,15 @@
Serialization Extensions
Expand the examples below, or the ruby-oauth/snaky_hash gem, or response_spec.rb, for more ideas, especially if you need to study the hacks for older Rubies.

-

<details markdown=”1>

-See Examples +
+ See Examples -

```ruby +

```ruby class MySnakyHash < SnakyHash::StringKeyed # Give this hash class dump and load abilities! extend SnakyHash::Serializer

-

#### Serialization Extentions +

#### Serialization Extentions # # Act on the non-hash values (including the values of hashes) as they are dumped to JSON # In other words, this retains nested hashes, and only the deepest leaf nodes become bananas. @@ -768,14 +768,14 @@

Serialization Extensions
“banana” # => Make values “banana” on dump end

-

# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump +

# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump # In other words, this retains nested hashes, and only the deepest leaf nodes become . # WARNING: This is a silly example! load_value_extensions.add(:to_stars) do |value| “” # Turn dumped bananas into *** when they are loaded end

-

# Act on the entire hash as it is prepared for dumping to JSON +

# Act on the entire hash as it is prepared for dumping to JSON # WARNING: This is a silly example! dump_hash_extensions.add(:to_cheese) do |value| if value.is_a?(Hash) @@ -789,7 +789,7 @@

Serialization Extensions
end end

-

# Act on the entire hash as it is loaded from the JSON dump +

# Act on the entire hash as it is loaded from the JSON dump # WARNING: This is a silly example! load_hash_extensions.add(:to_pizza) do |value| if value.is_a?(Hash) @@ -808,7 +808,7 @@

Serialization Extensions
end ```

-

</details>

+

Prefer camelCase over snake_case? => snaky: false

@@ -1677,7 +1677,7 @@

Please give the project a star ⭐ ♥ diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html index ba975a96..6dacf828 100644 --- a/docs/top-level-namespace.html +++ b/docs/top-level-namespace.html @@ -100,7 +100,7 @@

Defined Under Namespace