oauth2 2.0.10 → 2.0.18
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 +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +671 -286
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +24 -23
- data/CONTRIBUTING.md +130 -48
- data/FUNDING.md +74 -0
- data/IRP.md +107 -0
- data/LICENSE.txt +2 -2
- data/OIDC.md +167 -0
- data/README.md +1049 -458
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +13 -15
- data/THREAT_MODEL.md +85 -0
- data/lib/oauth2/access_token.rb +51 -7
- data/lib/oauth2/authenticator.rb +30 -1
- data/lib/oauth2/client.rb +35 -15
- data/lib/oauth2/error.rb +21 -3
- data/lib/oauth2/filtered_attributes.rb +21 -0
- data/lib/oauth2/response.rb +63 -31
- data/lib/oauth2/strategy/assertion.rb +6 -3
- data/lib/oauth2/strategy/auth_code.rb +10 -0
- data/lib/oauth2/strategy/base.rb +0 -0
- data/lib/oauth2/strategy/implicit.rb +8 -0
- data/lib/oauth2/strategy/password.rb +8 -0
- data/lib/oauth2/version.rb +1 -1
- data/lib/oauth2.rb +36 -0
- data/sig/oauth2/access_token.rbs +25 -0
- data/sig/oauth2/authenticator.rbs +22 -0
- data/sig/oauth2/client.rbs +52 -0
- data/sig/oauth2/error.rbs +8 -0
- data/sig/oauth2/filtered_attributes.rbs +6 -0
- data/sig/oauth2/response.rbs +18 -0
- data/sig/oauth2/strategy.rbs +34 -0
- data/sig/oauth2/version.rbs +5 -0
- data/sig/oauth2.rbs +9 -0
- data.tar.gz.sig +0 -0
- metadata +138 -86
- metadata.gz.sig +0 -0
data/README.md
CHANGED
|
@@ -1,123 +1,66 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
[
|
|
13
|
-
|
|
14
|
-
[
|
|
15
|
-
[
|
|
16
|
-
[
|
|
17
|
-
[
|
|
18
|
-
[
|
|
19
|
-
[
|
|
20
|
-
[
|
|
21
|
-
[
|
|
22
|
-
[
|
|
23
|
-
[
|
|
24
|
-
[
|
|
25
|
-
[
|
|
26
|
-
[
|
|
27
|
-
[
|
|
28
|
-
[
|
|
29
|
-
|
|
30
|
-
[![
|
|
1
|
+
| 📍 NOTE |
|
|
2
|
+
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
3
|
+
| RubyGems (the [GitHub org][rubygems-org], not the website) [suffered][draper-security] a [hostile takeover][ellen-takeover] in September 2025. |
|
|
4
|
+
| Ultimately [4 maintainers][simi-removed] were [hard removed][martin-removed] and a reason has been given for only 1 of those, while 2 others resigned in protest. |
|
|
5
|
+
| It is a [complicated story][draper-takeover] which is difficult to [parse quickly][draper-lies]. |
|
|
6
|
+
| I'm adding notes like this to gems because I [don't condone theft][draper-theft] of repositories or gems from their rightful owners. |
|
|
7
|
+
| If a similar theft happened with my repos/gems, I'd hope some would stand up for me. |
|
|
8
|
+
| Disenfranchised former-maintainers have started [gem.coop][gem-coop]. |
|
|
9
|
+
| Once available I will publish there exclusively; unless RubyCentral makes amends with the community. |
|
|
10
|
+
| The ["Technology for Humans: Joel Draper"][reinteractive-podcast] podcast episode by [reinteractive][reinteractive] is the most cogent summary I'm aware of. |
|
|
11
|
+
| See [here][gem-naming], [here][gem-coop] and [here][martin-ann] for more info on what comes next. |
|
|
12
|
+
| What I'm doing: A (WIP) proposal for [bundler/gem scopes][gem-scopes], and a (WIP) proposal for a federated [gem server][gem-server]. |
|
|
13
|
+
|
|
14
|
+
[rubygems-org]: https://github.com/rubygems/
|
|
15
|
+
[draper-security]: https://joel.drapper.me/p/ruby-central-security-measures/
|
|
16
|
+
[draper-takeover]: https://joel.drapper.me/p/ruby-central-takeover/
|
|
17
|
+
[ellen-takeover]: https://pup-e.com/blog/goodbye-rubygems/
|
|
18
|
+
[simi-removed]: https://www.reddit.com/r/ruby/s/gOk42POCaV
|
|
19
|
+
[martin-removed]: https://bsky.app/profile/martinemde.com/post/3m3occezxxs2q
|
|
20
|
+
[draper-lies]: https://joel.drapper.me/p/ruby-central-fact-check/
|
|
21
|
+
[draper-theft]: https://joel.drapper.me/p/ruby-central/
|
|
22
|
+
[reinteractive]: https://reinteractive.com/ruby-on-rails
|
|
23
|
+
[gem-coop]: https://gem.coop
|
|
24
|
+
[gem-naming]: https://github.com/gem-coop/gem.coop/issues/12
|
|
25
|
+
[martin-ann]: https://martinemde.com/2025/10/05/announcing-gem-coop.html
|
|
26
|
+
[gem-scopes]: https://github.com/galtzo-floss/bundle-namespace
|
|
27
|
+
[gem-server]: https://github.com/galtzo-floss/gem-server
|
|
28
|
+
[reinteractive-podcast]: https://youtu.be/_H4qbtC5qzU?si=BvuBU90R2wAqD2E6
|
|
29
|
+
|
|
30
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![oauth2 Logo by Chris Messina, CC BY-SA 3.0][🖼️oauth2-i]][🖼️oauth2]
|
|
31
|
+
|
|
32
|
+
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
33
|
+
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
|
34
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
35
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
36
|
+
[🖼️oauth2-i]: https://logos.galtzo.com/assets/images/oauth/oauth2/avatar-192px.svg
|
|
37
|
+
[🖼️oauth2]: https://github.com/ruby-oauth/oauth2
|
|
38
|
+
|
|
39
|
+
# 🔐 OAuth 2.0 Authorization Framework
|
|
40
|
+
|
|
41
|
+
⭐️ including OAuth 2.1 draft spec & OpenID Connect (OIDC)
|
|
42
|
+
|
|
43
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
44
|
+
|
|
45
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
|
|
31
46
|
|
|
32
47
|
---
|
|
33
48
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
[![Buy me a coffee][🖇buyme-small-img]][🖇buyme]
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
|
|
49
|
+
`if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
|
|
50
|
+
|
|
51
|
+
[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
52
|
+
|
|
53
|
+
## 🌻 Synopsis
|
|
40
54
|
|
|
41
55
|
OAuth 2.0 is the industry-standard protocol for authorization.
|
|
42
56
|
OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications,
|
|
43
57
|
desktop applications, mobile phones, and living room devices.
|
|
44
58
|
This is a RubyGem for implementing OAuth 2.0 clients (not servers) in Ruby applications.
|
|
45
59
|
|
|
46
|
-
|
|
47
|
-
|-----------------------------------------------|----------------|--------|-----|------|----------------|-------------|
|
|
48
|
-
| 🧪 [oauth-xx/oauth2 on GitLab][📜src-gl] | The Truth | 💚 | 💚 | 💚 | 🏀 Tiny Matrix | ➖ |
|
|
49
|
-
| 🐙 [oauth-xx/oauth2 on GitHub][📜src-gh] | A Dirty Mirror | 💚 | 💚 | ➖ | 💯 Full Matrix | ➖ |
|
|
50
|
-
| 🤼 [OAuth Ruby Google Group][⛳gg-discussions] | "Active" | ➖ | ➖ | ➖ | ➖ | 💚 |
|
|
51
|
-
|
|
52
|
-
### Upgrading Runtime Gem Dependencies
|
|
53
|
-
|
|
54
|
-
This project sits underneath a large portion of the authentication systems on the internet.
|
|
55
|
-
According to GitHub's project tracking, which I believe only reports on public projects,
|
|
56
|
-
[100,000+ projects](https://github.com/oauth-xx/oauth2/network/dependents), and
|
|
57
|
-
[500+ packages](https://github.com/oauth-xx/oauth2/network/dependents?dependent_type=PACKAGE) depend on this project.
|
|
58
|
-
|
|
59
|
-
That means it is painful for the Ruby community when this gem forces updates to its runtime dependencies.
|
|
60
|
-
|
|
61
|
-
As a result, great care, and a lot of time, have been invested to ensure this gem is working with all the
|
|
62
|
-
leading versions per each minor version of Ruby of all the runtime dependencies it can install with.
|
|
63
|
-
|
|
64
|
-
What does that mean specifically for the runtime dependencies?
|
|
65
|
-
|
|
66
|
-
We have 100% test coverage of lines and branches, and this test suite runs across a large matrix
|
|
67
|
-
covering the latest patch for each of the following minor versions:
|
|
68
|
-
|
|
69
|
-
* MRI Ruby @ v2.3, v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2, v3.3, v3.4, HEAD
|
|
70
|
-
* NOTE: This gem will still install on ruby v2.2, but vanilla GitHub Actions no longer supports testing against it, so YMMV.
|
|
71
|
-
* JRuby @ v9.2, v9.3, v9.4, v10.0, HEAD
|
|
72
|
-
* TruffleRuby @ v23.1, v23.2, HEAD
|
|
73
|
-
* gem `faraday` @ v0, v1, v2, HEAD
|
|
74
|
-
* gem `jwt` @ v1, v2, v3, HEAD
|
|
75
|
-
* gem `logger` @ v1.2, v1.5, v1.7, HEAD
|
|
76
|
-
* gem `multi_xml` @ v0.5, v0.6, v0.7, HEAD
|
|
77
|
-
* gem `rack` @ v1.2, v1.6, v2, v3, HEAD
|
|
78
|
-
|
|
79
|
-
- This gem follows a _strict & correct_ (according to the maintainer of SemVer; [more info][sv-pub-api]) interpretation of SemVer.
|
|
80
|
-
- Dropping support for **any** of the runtime dependency versions above will be a major version bump.
|
|
81
|
-
- If you aren't on one of the minor versions above, make getting there a priority.
|
|
82
|
-
- You should upgrade this gem with confidence\*.
|
|
83
|
-
- You should upgrade the dependencies of this gem with confidence\*.
|
|
84
|
-
- Please do upgrade, and then, when it goes smooth as butter [please sponsor me][🖇sponsor]. Thanks!
|
|
85
|
-
|
|
86
|
-
If you are thinking, "that list is missing two runtime dependencies", you are correct!
|
|
87
|
-
Both of them were extracted from this gem. They are part of the `oauth-xx` org,
|
|
88
|
-
and are developed in tight collaboration with this gem, so not much more needs to be said about them.
|
|
89
|
-
|
|
90
|
-
* gem `snaky_hash` - https://gitlab.com/oauth-xx/snaky_hash
|
|
91
|
-
* gem `version_gem` - https://gitlab.com/oauth-xx/version_gem
|
|
92
|
-
|
|
93
|
-
[sv-pub-api]: #-is-platform-support-part-of-the-public-api
|
|
94
|
-
|
|
95
|
-
\* MIT license; I am unable to make guarantees.
|
|
96
|
-
|
|
97
|
-
| 🚚 Test matrix brought to you by | 🔎 appraisal++ |
|
|
98
|
-
|----------------------------------|-------------------------------------------------------------------------|
|
|
99
|
-
| Adds back support for old Rubies | ✨ [appraisal PR #250](https://github.com/thoughtbot/appraisal/pull/250) |
|
|
100
|
-
| Adds support for `eval_gemfile` | ✨ [appraisal PR #248](https://github.com/thoughtbot/appraisal/pull/248) |
|
|
101
|
-
| Please review | my PRs! |
|
|
102
|
-
|
|
103
|
-
<details>
|
|
104
|
-
<summary>Standard Library Dependencies</summary>
|
|
105
|
-
|
|
106
|
-
The various versions of each are tested via the Ruby test matrix, along with whatever Ruby includes them.
|
|
107
|
-
|
|
108
|
-
* base64
|
|
109
|
-
* cgi
|
|
110
|
-
* json
|
|
111
|
-
* time
|
|
112
|
-
* logger (removed from stdlib in Ruby 3.5 so added as runtime dependency in v2.0.10)
|
|
113
|
-
|
|
114
|
-
If you use a gem version it should work fine!
|
|
115
|
-
|
|
116
|
-
</details>
|
|
117
|
-
|
|
118
|
-
### Quick Usage Example for AI and Copy / Pasting
|
|
60
|
+
### Quick Examples
|
|
119
61
|
|
|
120
|
-
|
|
62
|
+
<details markdown="1">
|
|
63
|
+
<summary>Convert the following `curl` command into a token request using this gem...</summary>
|
|
121
64
|
|
|
122
65
|
```shell
|
|
123
66
|
curl --request POST \
|
|
@@ -145,171 +88,170 @@ OAuth2::Client.new(
|
|
|
145
88
|
|
|
146
89
|
NOTE: `header` - The content type specified in the `curl` is already the default!
|
|
147
90
|
|
|
148
|
-
|
|
149
|
-
|
|
91
|
+
</details>
|
|
92
|
+
|
|
93
|
+
<details markdown="1">
|
|
94
|
+
<summary>Complete E2E single file script against mock-oauth2-server</summary>
|
|
95
|
+
|
|
96
|
+
- E2E example uses [navikt/mock-oauth2-server](https://github.com/navikt/mock-oauth2-server), which was added in v2.0.11
|
|
97
|
+
- E2E example does not ship with the released gem, so clone the source to play with it.
|
|
98
|
+
|
|
99
|
+
```console
|
|
100
|
+
docker compose -f docker-compose-ssl.yml up -d --wait
|
|
101
|
+
ruby examples/e2e.rb
|
|
102
|
+
# If your machine is slow or Docker pulls are cold, increase the wait:
|
|
103
|
+
E2E_WAIT_TIMEOUT=120 ruby examples/e2e.rb
|
|
104
|
+
# The mock server serves HTTP on 8080; the example points to http://localhost:8080 by default.
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The output should be something like this:
|
|
108
|
+
|
|
109
|
+
```console
|
|
110
|
+
➜ ruby examples/e2e.rb
|
|
111
|
+
Access token (truncated): eyJraWQiOiJkZWZhdWx0...
|
|
112
|
+
userinfo status: 200
|
|
113
|
+
userinfo body: {"sub" => "demo-sub", "aud" => ["demo-aud"], "nbf" => 1757816758000, "iss" => "http://localhost:8080/default", "exp" => 1757820358000, "iat" => 1757816758000, "jti" => "d63b97a7-ebe5-4dea-93e6-d542caba6104"}
|
|
114
|
+
E2E complete
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Make sure to shut down the mock server when you are done:
|
|
118
|
+
|
|
119
|
+
```console
|
|
120
|
+
docker compose -f docker-compose-ssl.yml down
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Troubleshooting: validate connectivity to the mock server
|
|
124
|
+
|
|
125
|
+
- Check container status and port mapping:
|
|
126
|
+
- `docker compose -f docker-compose-ssl.yml ps`
|
|
127
|
+
- From the host, try the discovery URL directly (this is what the example uses by default):
|
|
128
|
+
- `curl -v http://localhost:8080/default/.well-known/openid-configuration`
|
|
129
|
+
- If that fails immediately, also try: `curl -v --connect-timeout 2 http://127.0.0.1:8080/default/.well-known/openid-configuration`
|
|
130
|
+
- From inside the container (to distinguish container vs. host networking):
|
|
131
|
+
- `docker exec -it oauth2-mock-oauth2-server-1 curl -v http://127.0.0.1:8080/default/.well-known/openid-configuration`
|
|
132
|
+
- Simple TCP probe from the host:
|
|
133
|
+
- `nc -vz localhost 8080 # or: ruby -rsocket -e 'TCPSocket.new("localhost",8080).close; puts "tcp ok"'`
|
|
134
|
+
- Inspect which host port 8080 is bound to (should be 8080):
|
|
135
|
+
- `docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' oauth2-mock-oauth2-server-1`
|
|
136
|
+
- Look at server logs for readiness/errors:
|
|
137
|
+
- `docker logs -n 200 oauth2-mock-oauth2-server-1`
|
|
138
|
+
- On Linux, ensure nothing else is bound to 8080 and that firewall/SELinux aren’t blocking:
|
|
139
|
+
- `ss -ltnp | grep :8080`
|
|
140
|
+
|
|
141
|
+
Notes
|
|
142
|
+
|
|
143
|
+
- Discovery URL pattern is: `http://localhost:8080/<realm>/.well-known/openid-configuration`, where `<realm>` defaults to `default`.
|
|
144
|
+
- You can change these with env vars when running the example:
|
|
145
|
+
- `E2E_ISSUER_BASE` (default: http://localhost:8080)
|
|
146
|
+
- `E2E_REALM` (default: default)
|
|
147
|
+
|
|
148
|
+
</details>
|
|
149
|
+
|
|
150
|
+
If it seems like you are in the wrong place, you might try one of these:
|
|
150
151
|
|
|
151
152
|
* [OAuth 2.0 Spec][oauth2-spec]
|
|
152
153
|
* [doorkeeper gem][doorkeeper-gem] for OAuth 2.0 server/provider implementation.
|
|
153
|
-
* [oauth sibling gem][sibling-gem] for OAuth 1.
|
|
154
|
+
* [oauth sibling gem][sibling-gem] for OAuth 1.0a implementations in Ruby.
|
|
154
155
|
|
|
155
156
|
[oauth2-spec]: https://oauth.net/2/
|
|
156
|
-
[sibling-gem]: https://gitlab.com/oauth
|
|
157
|
+
[sibling-gem]: https://gitlab.com/ruby-oauth/oauth
|
|
157
158
|
[doorkeeper-gem]: https://github.com/doorkeeper-gem/doorkeeper
|
|
158
159
|
|
|
159
160
|
## 💡 Info you can shake a stick at
|
|
160
161
|
|
|
161
|
-
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace]
|
|
162
|
-
|
|
163
|
-
| Works with JRuby |
|
|
164
|
-
| Works with Truffle Ruby |
|
|
165
|
-
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]
|
|
166
|
-
| Works with MRI Ruby 2 | [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎1-an-wf] [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎1-an-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎1-an-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎7-us-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf]
|
|
167
|
-
|
|
|
168
|
-
|
|
|
169
|
-
|
|
|
170
|
-
|
|
|
171
|
-
|
|
|
172
|
-
|
|
|
173
|
-
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab]
|
|
162
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
163
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
164
|
+
| Works with JRuby | ![JRuby 9.1 Compat][💎jruby-9.1i] ![JRuby 9.2 Compat][💎jruby-9.2i] ![JRuby 9.3 Compat][💎jruby-9.3i] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
|
|
165
|
+
| Works with Truffle Ruby | ![Truffle Ruby 22.3 Compat][💎truby-22.3i] ![Truffle Ruby 23.0 Compat][💎truby-23.0i] ![Truffle Ruby 23.1 Compat][💎truby-23.1i] <br/> [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
|
|
166
|
+
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
|
|
167
|
+
| Works with MRI Ruby 2 | ![Ruby 2.2 Compat][💎ruby-2.2i] <br/> [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎1-an-wf] [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎1-an-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎1-an-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎7-us-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf] |
|
|
168
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor] |
|
|
169
|
+
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
|
|
170
|
+
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
|
|
171
|
+
| Compliance | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
172
|
+
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
|
|
173
|
+
| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
|
174
|
+
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
|
|
174
175
|
|
|
175
|
-
|
|
176
|
+
### Compatibility
|
|
176
177
|
|
|
177
|
-
|
|
178
|
+
Compatible with MRI Ruby 2.2.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
178
179
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
| Version | Release Date | CHANGELOG | README |
|
|
183
|
-
|---------|--------------|---------------------------------------|---------------------------------|
|
|
184
|
-
| 2.0.10 | 2025-05-16 | [v2.0.10 CHANGELOG][2.0.10-changelog] | [v2.0.10 README][2.0.10-readme] |
|
|
185
|
-
| 2.0.9 | 2022-09-16 | [v2.0.9 CHANGELOG][2.0.9-changelog] | [v2.0.9 README][2.0.9-readme] |
|
|
186
|
-
| 2.0.8 | 2022-09-01 | [v2.0.8 CHANGELOG][2.0.8-changelog] | [v2.0.8 README][2.0.8-readme] |
|
|
187
|
-
| 2.0.7 | 2022-08-22 | [v2.0.7 CHANGELOG][2.0.7-changelog] | [v2.0.7 README][2.0.7-readme] |
|
|
188
|
-
| 2.0.6 | 2022-07-13 | [v2.0.6 CHANGELOG][2.0.6-changelog] | [v2.0.6 README][2.0.6-readme] |
|
|
189
|
-
| 2.0.5 | 2022-07-07 | [v2.0.5 CHANGELOG][2.0.5-changelog] | [v2.0.5 README][2.0.5-readme] |
|
|
190
|
-
| 2.0.4 | 2022-07-01 | [v2.0.4 CHANGELOG][2.0.4-changelog] | [v2.0.4 README][2.0.4-readme] |
|
|
191
|
-
| 2.0.3 | 2022-06-28 | [v2.0.3 CHANGELOG][2.0.3-changelog] | [v2.0.3 README][2.0.3-readme] |
|
|
192
|
-
| 2.0.2 | 2022-06-24 | [v2.0.2 CHANGELOG][2.0.2-changelog] | [v2.0.2 README][2.0.2-readme] |
|
|
193
|
-
| 2.0.1 | 2022-06-22 | [v2.0.1 CHANGELOG][2.0.1-changelog] | [v2.0.1 README][2.0.1-readme] |
|
|
194
|
-
| 2.0.0 | 2022-06-21 | [v2.0.0 CHANGELOG][2.0.0-changelog] | [v2.0.0 README][2.0.0-readme] |
|
|
195
|
-
</details>
|
|
180
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
181
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
182
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
196
183
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
[
|
|
203
|
-
|
|
204
|
-
[
|
|
205
|
-
[
|
|
206
|
-
[
|
|
207
|
-
[
|
|
208
|
-
|
|
209
|
-
[2.0.10-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.10/README.md
|
|
210
|
-
[2.0.9-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.9/README.md
|
|
211
|
-
[2.0.8-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.8/README.md
|
|
212
|
-
[2.0.7-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.7/README.md
|
|
213
|
-
[2.0.6-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.6/README.md
|
|
214
|
-
[2.0.5-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.5/README.md
|
|
215
|
-
[2.0.4-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.4/README.md
|
|
216
|
-
[2.0.3-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.3/README.md
|
|
217
|
-
[2.0.2-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.2/README.md
|
|
218
|
-
[2.0.1-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.1/README.md
|
|
219
|
-
[2.0.0-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.0/README.md
|
|
220
|
-
|
|
221
|
-
### Older Releases
|
|
184
|
+
### Federated DVCS
|
|
185
|
+
|
|
186
|
+
<details markdown="1">
|
|
187
|
+
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
188
|
+
|
|
189
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
190
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
191
|
+
| 🧪 [ruby-oauth/oauth2 on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
192
|
+
| 🧊 [ruby-oauth/oauth2 on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
193
|
+
| 🐙 [ruby-oauth/oauth2 on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
194
|
+
| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
|
|
222
195
|
|
|
223
|
-
<details>
|
|
224
|
-
<summary>1.4.x CHANGELOGs and READMEs</summary>
|
|
225
|
-
|
|
226
|
-
| Version | Release Date | CHANGELOG | README |
|
|
227
|
-
|---------|--------------|---------------------------------------|---------------------------------|
|
|
228
|
-
| 1.4.11 | Sep 16, 2022 | [v1.4.11 CHANGELOG][1.4.11-changelog] | [v1.4.11 README][1.4.11-readme] |
|
|
229
|
-
| 1.4.10 | Jul 1, 2022 | [v1.4.10 CHANGELOG][1.4.10-changelog] | [v1.4.10 README][1.4.10-readme] |
|
|
230
|
-
| 1.4.9 | Feb 20, 2022 | [v1.4.9 CHANGELOG][1.4.9-changelog] | [v1.4.9 README][1.4.9-readme] |
|
|
231
|
-
| 1.4.8 | Feb 18, 2022 | [v1.4.8 CHANGELOG][1.4.8-changelog] | [v1.4.8 README][1.4.8-readme] |
|
|
232
|
-
| 1.4.7 | Mar 19, 2021 | [v1.4.7 CHANGELOG][1.4.7-changelog] | [v1.4.7 README][1.4.7-readme] |
|
|
233
|
-
| 1.4.6 | Mar 19, 2021 | [v1.4.6 CHANGELOG][1.4.6-changelog] | [v1.4.6 README][1.4.6-readme] |
|
|
234
|
-
| 1.4.5 | Mar 18, 2021 | [v1.4.5 CHANGELOG][1.4.5-changelog] | [v1.4.5 README][1.4.5-readme] |
|
|
235
|
-
| 1.4.4 | Feb 12, 2020 | [v1.4.4 CHANGELOG][1.4.4-changelog] | [v1.4.4 README][1.4.4-readme] |
|
|
236
|
-
| 1.4.3 | Jan 29, 2020 | [v1.4.3 CHANGELOG][1.4.3-changelog] | [v1.4.3 README][1.4.3-readme] |
|
|
237
|
-
| 1.4.2 | Oct 1, 2019 | [v1.4.2 CHANGELOG][1.4.2-changelog] | [v1.4.2 README][1.4.2-readme] |
|
|
238
|
-
| 1.4.1 | Oct 13, 2018 | [v1.4.1 CHANGELOG][1.4.1-changelog] | [v1.4.1 README][1.4.1-readme] |
|
|
239
|
-
| 1.4.0 | Jun 9, 2017 | [v1.4.0 CHANGELOG][1.4.0-changelog] | [v1.4.0 README][1.4.0-readme] |
|
|
240
196
|
</details>
|
|
241
197
|
|
|
242
|
-
[
|
|
243
|
-
[1.4.10-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#1410---2022-07-01
|
|
244
|
-
[1.4.9-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#149---2022-02-20
|
|
245
|
-
[1.4.8-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#148---2022-02-18
|
|
246
|
-
[1.4.7-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#147---2021-03-19
|
|
247
|
-
[1.4.6-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#146---2021-03-19
|
|
248
|
-
[1.4.5-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#145---2021-03-18
|
|
249
|
-
[1.4.4-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#144---2020-02-12
|
|
250
|
-
[1.4.3-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#143---2020-01-29
|
|
251
|
-
[1.4.2-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#142---2019-10-01
|
|
252
|
-
[1.4.1-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#141---2018-10-13
|
|
253
|
-
[1.4.0-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#140---2017-06-09
|
|
254
|
-
|
|
255
|
-
[1.4.11-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.11/README.md
|
|
256
|
-
[1.4.10-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.10/README.md
|
|
257
|
-
[1.4.9-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.9/README.md
|
|
258
|
-
[1.4.8-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.8/README.md
|
|
259
|
-
[1.4.7-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.7/README.md
|
|
260
|
-
[1.4.6-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.6/README.md
|
|
261
|
-
[1.4.5-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.5/README.md
|
|
262
|
-
[1.4.4-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.4/README.md
|
|
263
|
-
[1.4.3-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.3/README.md
|
|
264
|
-
[1.4.2-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.2/README.md
|
|
265
|
-
[1.4.1-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.1/README.md
|
|
266
|
-
[1.4.0-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.0/README.md
|
|
198
|
+
[gh-discussions]: https://github.com/ruby-oauth/oauth2/discussions
|
|
267
199
|
|
|
268
|
-
|
|
269
|
-
<summary>1.3.x Readmes</summary>
|
|
200
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-oauth2?utm_source=rubygems-oauth2&utm_medium=referral&utm_campaign=readme)
|
|
270
201
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
202
|
+
Available as part of the Tidelift Subscription.
|
|
203
|
+
|
|
204
|
+
<details markdown="1">
|
|
205
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
206
|
+
|
|
207
|
+
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
|
|
208
|
+
|
|
209
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
210
|
+
|
|
211
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
212
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
213
|
+
- 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
|
|
214
|
+
|
|
215
|
+
Alternatively:
|
|
216
|
+
|
|
217
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
218
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
219
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
276
220
|
|
|
277
|
-
<details>
|
|
278
|
-
<summary>≤= 1.2.x Readmes (2016 and before)</summary>
|
|
279
|
-
|
|
280
|
-
| Version | Release Date | Readme |
|
|
281
|
-
|----------|--------------|----------------------------------------------------------|
|
|
282
|
-
| 1.2.0 | Jun 30, 2016 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.2.0/README.md |
|
|
283
|
-
| 1.1.0 | Jan 30, 2016 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.1.0/README.md |
|
|
284
|
-
| 1.0.0 | May 23, 2014 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.0.0/README.md |
|
|
285
|
-
| < 1.0.0 | Find here | https://gitlab.com/oauth-xx/oauth2/-/tags |
|
|
286
221
|
</details>
|
|
287
222
|
|
|
288
223
|
## ✨ Installation
|
|
289
224
|
|
|
290
225
|
Install the gem and add to the application's Gemfile by executing:
|
|
291
226
|
|
|
292
|
-
|
|
227
|
+
```console
|
|
228
|
+
bundle add oauth2
|
|
229
|
+
```
|
|
293
230
|
|
|
294
231
|
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
295
232
|
|
|
296
|
-
|
|
233
|
+
```console
|
|
234
|
+
gem install oauth2
|
|
235
|
+
```
|
|
297
236
|
|
|
298
237
|
### 🔒 Secure Installation
|
|
299
238
|
|
|
300
|
-
|
|
239
|
+
<details markdown="1">
|
|
240
|
+
<summary>For Medium or High Security Installations</summary>
|
|
241
|
+
|
|
242
|
+
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
|
301
243
|
[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
|
302
244
|
by following the instructions below.
|
|
303
245
|
|
|
304
246
|
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
|
|
305
247
|
|
|
306
|
-
```
|
|
307
|
-
gem cert --add <(curl -Ls https://raw.github.com/
|
|
248
|
+
```console
|
|
249
|
+
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
|
308
250
|
```
|
|
309
251
|
|
|
310
252
|
You only need to do that once. Then proceed to install with:
|
|
311
253
|
|
|
312
|
-
```
|
|
254
|
+
```console
|
|
313
255
|
gem install oauth2 -P MediumSecurity
|
|
314
256
|
```
|
|
315
257
|
|
|
@@ -319,49 +261,41 @@ This is necessary because not all of `oauth2`’s dependencies are signed, so we
|
|
|
319
261
|
|
|
320
262
|
If you want to up your security game full-time:
|
|
321
263
|
|
|
322
|
-
```
|
|
264
|
+
```console
|
|
323
265
|
bundle config set --global trust-policy MediumSecurity
|
|
324
266
|
```
|
|
325
267
|
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
## OAuth2 for Enterprise
|
|
329
|
-
|
|
330
|
-
Available as part of the Tidelift Subscription.
|
|
331
|
-
|
|
332
|
-
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.][tidelift-ref]
|
|
333
|
-
|
|
334
|
-
[tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth2?utm_source=rubygems-oauth2&utm_medium=referral&utm_campaign=enterprise
|
|
335
|
-
|
|
336
|
-
## Security contact information
|
|
268
|
+
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
|
337
269
|
|
|
338
|
-
|
|
339
|
-
Tidelift will coordinate the fix and disclosure.
|
|
270
|
+
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
|
340
271
|
|
|
341
|
-
|
|
272
|
+
</details>
|
|
342
273
|
|
|
343
274
|
## What is new for v2.0?
|
|
344
275
|
|
|
345
|
-
-
|
|
346
|
-
- Unofficially support Ruby versions >= 2.5
|
|
347
|
-
- Incidentally support Ruby versions >= 2.2
|
|
276
|
+
- Works with Ruby versions >= 2.2
|
|
348
277
|
- Drop support for the expired MAC Draft (all versions)
|
|
349
|
-
- Support IETF
|
|
350
|
-
- Support
|
|
351
|
-
- Support IETF
|
|
278
|
+
- Support IETF rfc7515 JSON Web Signature - JWS (since v2.0.12)
|
|
279
|
+
- Support JWT `kid` for key discovery and management
|
|
280
|
+
- Support IETF rfc7523 JWT Bearer Tokens (since v2.0.0)
|
|
281
|
+
- Support IETF rfc7231 Relative Location in Redirect (since v2.0.0)
|
|
282
|
+
- Support IETF rfc6749 Don't set oauth params when nil (since v2.0.0)
|
|
283
|
+
- Support IETF rfc7009 Token Revocation (since v2.0.10, updated in v2.0.13 to support revocation via URL-encoded parameters)
|
|
352
284
|
- Support [OIDC 1.0 Private Key JWT](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication); based on the OAuth JWT assertion specification [(RFC 7523)](https://tools.ietf.org/html/rfc7523)
|
|
353
285
|
- Support new formats, including from [jsonapi.org](http://jsonapi.org/format/): `application/vdn.api+json`, `application/vnd.collection+json`, `application/hal+json`, `application/problem+json`
|
|
354
|
-
- Adds
|
|
286
|
+
- Adds option to `OAuth2::Client#get_token`:
|
|
355
287
|
- `:access_token_class` (`AccessToken`); user specified class to use for all calls to `get_token`
|
|
356
|
-
- Adds
|
|
288
|
+
- Adds option to `OAuth2::AccessToken#initialize`:
|
|
357
289
|
- `:expires_latency` (`nil`); number of seconds by which AccessToken validity will be reduced to offset latency
|
|
358
290
|
- By default, keys are transformed to snake case.
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
291
|
+
- Original keys will still work as previously, in most scenarios, thanks to [snaky_hash][snaky_hash] gem.
|
|
292
|
+
- However, this is a _breaking_ change if you rely on `response.parsed.to_h` to retain the original case, and the original wasn't snake case, as the keys in the result will be snake case.
|
|
293
|
+
- As of version 2.0.4 you can turn key transformation off with the `snaky: false` option.
|
|
362
294
|
- By default, the `:auth_scheme` is now `:basic_auth` (instead of `:request_body`)
|
|
363
|
-
|
|
364
|
-
- [... A lot more](https://gitlab.com/oauth
|
|
295
|
+
- Third-party strategies and gems may need to be updated if a provider was requiring client id/secret in the request body
|
|
296
|
+
- [... A lot more](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/CHANGELOG.md#200-2022-06-21-tag)
|
|
297
|
+
|
|
298
|
+
[snaky_hash]: https://gitlab.com/ruby-oauth/snaky_hash
|
|
365
299
|
|
|
366
300
|
## Compatibility
|
|
367
301
|
|
|
@@ -370,23 +304,24 @@ Compatibility is further distinguished as "Best Effort Support" or "Incidental S
|
|
|
370
304
|
This gem will install on Ruby versions >= v2.2 for 2.x releases.
|
|
371
305
|
See `1-4-stable` branch for older rubies.
|
|
372
306
|
|
|
373
|
-
<details>
|
|
307
|
+
<details markdown="1">
|
|
374
308
|
<summary>Ruby Engine Compatibility Policy</summary>
|
|
375
309
|
|
|
376
310
|
This gem is tested against MRI, JRuby, and Truffleruby.
|
|
377
311
|
Each of those has varying versions that target a specific version of MRI Ruby.
|
|
378
312
|
This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
|
|
379
313
|
If you would like to add support for additional engines,
|
|
380
|
-
|
|
314
|
+
see [gemfiles/README.md](gemfiles/README.md), then submit a PR to the correct maintenance branch as according to the table below.
|
|
315
|
+
|
|
381
316
|
</details>
|
|
382
317
|
|
|
383
|
-
<details>
|
|
318
|
+
<details markdown="1">
|
|
384
319
|
<summary>Ruby Version Compatibility Policy</summary>
|
|
385
320
|
|
|
386
321
|
If something doesn't work on one of these interpreters, it's a bug.
|
|
387
322
|
|
|
388
323
|
This library may inadvertently work (or seem to work) on other Ruby
|
|
389
|
-
implementations
|
|
324
|
+
implementations; however, support will only be provided for the versions listed
|
|
390
325
|
above.
|
|
391
326
|
|
|
392
327
|
If you would like this library to support another Ruby version, you may
|
|
@@ -395,6 +330,7 @@ run and pass on that implementation. When something breaks on your
|
|
|
395
330
|
implementation, you will be responsible for providing patches in a timely
|
|
396
331
|
fashion. If critical issues for a particular implementation exist at the time
|
|
397
332
|
of a major release, support for that Ruby version may be dropped.
|
|
333
|
+
|
|
398
334
|
</details>
|
|
399
335
|
|
|
400
336
|
| | Ruby OAuth2 Version | Maintenance Branch | Targeted Support | Best Effort Support | Incidental Support |
|
|
@@ -404,36 +340,36 @@ of a major release, support for that Ruby version may be dropped.
|
|
|
404
340
|
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
|
|
405
341
|
|
|
406
342
|
NOTE: The 1.4 series will only receive critical security updates.
|
|
407
|
-
See [SECURITY.md][
|
|
343
|
+
See [SECURITY.md][🔐security] and [IRP.md][🔐irp].
|
|
408
344
|
|
|
409
|
-
##
|
|
345
|
+
## ⚙️ Configuration
|
|
410
346
|
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
If you started seeing this warning, but everything is working fine, you can now silence it.
|
|
414
|
-
```log
|
|
415
|
-
OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
|
|
416
|
-
```
|
|
347
|
+
You can turn on additional warnings.
|
|
417
348
|
|
|
418
349
|
```ruby
|
|
419
350
|
OAuth2.configure do |config|
|
|
420
|
-
|
|
421
|
-
|
|
351
|
+
# Turn on a warning like:
|
|
352
|
+
# OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
|
|
353
|
+
config.silence_extra_tokens_warning = false # default: true
|
|
354
|
+
# Set to true if you want to also show warnings about no tokens
|
|
355
|
+
config.silence_no_tokens_warning = false # default: true,
|
|
422
356
|
end
|
|
423
357
|
```
|
|
424
358
|
|
|
425
|
-
|
|
359
|
+
The "extra tokens" problem comes from ambiguity in the spec about which token is the right token.
|
|
426
360
|
Some OAuth 2.0 standards legitimately have multiple tokens.
|
|
427
361
|
You may need to subclass `OAuth2::AccessToken`, or write your own custom alternative to it, and pass it in.
|
|
428
362
|
Specify your custom class with the `access_token_class` option.
|
|
429
363
|
|
|
430
|
-
If you only need one token you can, as of v2.0.10,
|
|
364
|
+
If you only need one token, you can, as of v2.0.10,
|
|
431
365
|
specify the exact token name you want to extract via the `OAuth2::AccessToken` using
|
|
432
366
|
the `token_name` option.
|
|
433
367
|
|
|
434
368
|
You'll likely need to do some source diving.
|
|
435
369
|
This gem has 100% test coverage for lines and branches, so the specs are a great place to look for ideas.
|
|
436
|
-
If you have time and energy please contribute to the documentation!
|
|
370
|
+
If you have time and energy, please contribute to the documentation!
|
|
371
|
+
|
|
372
|
+
## 🔧 Basic Usage
|
|
437
373
|
|
|
438
374
|
### `authorize_url` and `token_url` are on site root (Just Works!)
|
|
439
375
|
|
|
@@ -452,7 +388,7 @@ response.class.name
|
|
|
452
388
|
|
|
453
389
|
### Relative `authorize_url` and `token_url` (Not on site root, Just Works!)
|
|
454
390
|
|
|
455
|
-
In above example, the default Authorization URL is `oauth/authorize` and default Access Token URL is `oauth/token`, and, as they are missing a leading `/`, both are relative.
|
|
391
|
+
In the above example, the default Authorization URL is `oauth/authorize` and default Access Token URL is `oauth/token`, and, as they are missing a leading `/`, both are relative.
|
|
456
392
|
|
|
457
393
|
```ruby
|
|
458
394
|
client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org/nested/directory/on/your/server")
|
|
@@ -491,10 +427,109 @@ response.parsed.access_token # => "aaaaaaaa"
|
|
|
491
427
|
response.parsed[:access_token] # => "aaaaaaaa"
|
|
492
428
|
response.parsed.additional_data # => "additional"
|
|
493
429
|
response.parsed[:additional_data] # => "additional"
|
|
494
|
-
response.parsed.class.name # =>
|
|
430
|
+
response.parsed.class.name # => SnakyHash::StringKeyed (from snaky_hash gem)
|
|
495
431
|
```
|
|
496
432
|
|
|
497
|
-
####
|
|
433
|
+
#### Serialization
|
|
434
|
+
|
|
435
|
+
As of v2.0.11, if you need to serialize the parsed result, you can!
|
|
436
|
+
|
|
437
|
+
There are two ways to do this, globally, or discretely. The discrete way is recommended.
|
|
438
|
+
|
|
439
|
+
##### Global Serialization Config
|
|
440
|
+
|
|
441
|
+
Globally configure `SnakyHash::StringKeyed` to use the serializer. Put this in your code somewhere reasonable (like an initializer for Rails).
|
|
442
|
+
|
|
443
|
+
```ruby
|
|
444
|
+
SnakyHash::StringKeyed.class_eval do
|
|
445
|
+
extend SnakyHash::Serializer
|
|
446
|
+
end
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
##### Discrete Serialization Config
|
|
450
|
+
|
|
451
|
+
Discretely configure a custom Snaky Hash class to use the serializer.
|
|
452
|
+
|
|
453
|
+
```ruby
|
|
454
|
+
class MySnakyHash < SnakyHash::StringKeyed
|
|
455
|
+
# Give this hash class `dump` and `load` abilities!
|
|
456
|
+
extend SnakyHash::Serializer
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
# And tell your client to use the custom class in each call:
|
|
460
|
+
client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org/oauth2")
|
|
461
|
+
token = client.get_token({snaky_hash_klass: MySnakyHash})
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
##### Serialization Extensions
|
|
465
|
+
|
|
466
|
+
These extensions work regardless of whether you used the global or discrete config above.
|
|
467
|
+
|
|
468
|
+
There are a few hacks you may need in your class to support Ruby < 2.4.2 or < 2.6.
|
|
469
|
+
They are likely not needed if you are on a newer Ruby.
|
|
470
|
+
Expand the examples below, or the [ruby-oauth/snaky_hash](https://gitlab.com/ruby-oauth/snaky_hash) gem,
|
|
471
|
+
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.
|
|
472
|
+
|
|
473
|
+
<details markdown="1">
|
|
474
|
+
<summary>See Examples</summary>
|
|
475
|
+
|
|
476
|
+
```ruby
|
|
477
|
+
class MySnakyHash < SnakyHash::StringKeyed
|
|
478
|
+
# Give this hash class `dump` and `load` abilities!
|
|
479
|
+
extend SnakyHash::Serializer
|
|
480
|
+
|
|
481
|
+
#### Serialization Extentions
|
|
482
|
+
#
|
|
483
|
+
# Act on the non-hash values (including the values of hashes) as they are dumped to JSON
|
|
484
|
+
# In other words, this retains nested hashes, and only the deepest leaf nodes become bananas.
|
|
485
|
+
# WARNING: This is a silly example!
|
|
486
|
+
dump_value_extensions.add(:to_fruit) do |value|
|
|
487
|
+
"banana" # => Make values "banana" on dump
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump
|
|
491
|
+
# In other words, this retains nested hashes, and only the deepest leaf nodes become ***.
|
|
492
|
+
# WARNING: This is a silly example!
|
|
493
|
+
load_value_extensions.add(:to_stars) do |value|
|
|
494
|
+
"***" # Turn dumped bananas into *** when they are loaded
|
|
495
|
+
end
|
|
496
|
+
|
|
497
|
+
# Act on the entire hash as it is prepared for dumping to JSON
|
|
498
|
+
# WARNING: This is a silly example!
|
|
499
|
+
dump_hash_extensions.add(:to_cheese) do |value|
|
|
500
|
+
if value.is_a?(Hash)
|
|
501
|
+
value.transform_keys do |key|
|
|
502
|
+
split = key.split("_")
|
|
503
|
+
first_word = split[0]
|
|
504
|
+
key.sub(first_word, "cheese")
|
|
505
|
+
end
|
|
506
|
+
else
|
|
507
|
+
value
|
|
508
|
+
end
|
|
509
|
+
end
|
|
510
|
+
|
|
511
|
+
# Act on the entire hash as it is loaded from the JSON dump
|
|
512
|
+
# WARNING: This is a silly example!
|
|
513
|
+
load_hash_extensions.add(:to_pizza) do |value|
|
|
514
|
+
if value.is_a?(Hash)
|
|
515
|
+
res = klass.new
|
|
516
|
+
value.keys.each_with_object(res) do |key, result|
|
|
517
|
+
split = key.split("_")
|
|
518
|
+
last_word = split[-1]
|
|
519
|
+
new_key = key.sub(last_word, "pizza")
|
|
520
|
+
result[new_key] = value[key]
|
|
521
|
+
end
|
|
522
|
+
res
|
|
523
|
+
else
|
|
524
|
+
value
|
|
525
|
+
end
|
|
526
|
+
end
|
|
527
|
+
end
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
</details>
|
|
531
|
+
|
|
532
|
+
#### Prefer camelCase over snake_case? => snaky: false
|
|
498
533
|
|
|
499
534
|
```ruby
|
|
500
535
|
response = access.get("/api/resource", params: {"query_foo" => "bar"}, snaky: false)
|
|
@@ -505,10 +540,10 @@ response.parsed["additionalData"] # => "additional"
|
|
|
505
540
|
response.parsed.class.name # => Hash (just, regular old Hash)
|
|
506
541
|
```
|
|
507
542
|
|
|
508
|
-
<details>
|
|
509
|
-
<summary>Debugging</summary>
|
|
543
|
+
<details markdown="1">
|
|
544
|
+
<summary>Debugging & Logging</summary>
|
|
510
545
|
|
|
511
|
-
Set an environment variable
|
|
546
|
+
Set an environment variable as per usual (e.g. with [dotenv](https://github.com/bkeepers/dotenv)).
|
|
512
547
|
|
|
513
548
|
```ruby
|
|
514
549
|
# will log both request and response, including bodies
|
|
@@ -527,29 +562,46 @@ client = OAuth2::Client.new(
|
|
|
527
562
|
logger: Logger.new("example.log", "weekly"),
|
|
528
563
|
)
|
|
529
564
|
```
|
|
565
|
+
|
|
530
566
|
</details>
|
|
531
567
|
|
|
532
|
-
|
|
568
|
+
### OAuth2::Response
|
|
533
569
|
|
|
534
570
|
The `AccessToken` methods `#get`, `#post`, `#put` and `#delete` and the generic `#request`
|
|
535
571
|
will return an instance of the #OAuth2::Response class.
|
|
536
572
|
|
|
537
573
|
This instance contains a `#parsed` method that will parse the response body and
|
|
538
|
-
return a Hash-like [`
|
|
574
|
+
return a Hash-like [`SnakyHash::StringKeyed`](https://gitlab.com/ruby-oauth/snaky_hash/-/blob/main/lib/snaky_hash/string_keyed.rb) if the `Content-Type` is `application/x-www-form-urlencoded` or if
|
|
539
575
|
the body is a JSON object. It will return an Array if the body is a JSON
|
|
540
576
|
array. Otherwise, it will return the original body string.
|
|
541
577
|
|
|
542
578
|
The original response body, headers, and status can be accessed via their
|
|
543
579
|
respective methods.
|
|
544
580
|
|
|
545
|
-
|
|
581
|
+
### OAuth2::AccessToken
|
|
546
582
|
|
|
547
583
|
If you have an existing Access Token for a user, you can initialize an instance
|
|
548
584
|
using various class methods including the standard new, `from_hash` (if you have
|
|
549
585
|
a hash of the values), or `from_kvform` (if you have an
|
|
550
586
|
`application/x-www-form-urlencoded` encoded string of the values).
|
|
551
587
|
|
|
552
|
-
|
|
588
|
+
Options (since v2.0.x unless noted):
|
|
589
|
+
|
|
590
|
+
- `expires_latency` (Integer | nil): Seconds to subtract from expires_in when computing #expired? to offset latency.
|
|
591
|
+
- `token_name` (String | Symbol | nil): When multiple token-like fields exist in responses, select the field name to use as the access token (since v2.0.10).
|
|
592
|
+
- `mode` (Symbol | Proc | Hash): Controls how the token is transmitted on requests made via this AccessToken instance.
|
|
593
|
+
- `:header` — Send as Authorization: Bearer <token> header (default and preferred by OAuth 2.1 draft guidance).
|
|
594
|
+
- `:query` — Send as access_token query parameter (discouraged in general, but required by some providers).
|
|
595
|
+
- Verb-dependent (since v2.0.15): Provide either:
|
|
596
|
+
- a `Proc` taking `|verb|` and returning `:header` or `:query`, or
|
|
597
|
+
- a `Hash` with verb symbols as keys, for example `{get: :query, post: :header, delete: :header}`.
|
|
598
|
+
|
|
599
|
+
Note: Verb-dependent mode supports providers like Instagram that require query mode for `GET` and header mode for `POST`/`DELETE`
|
|
600
|
+
|
|
601
|
+
- Verb-dependent mode via `Proc` was added in v2.0.15
|
|
602
|
+
- Verb-dependent mode via `Hash` was added in v2.0.16
|
|
603
|
+
|
|
604
|
+
### OAuth2::Error
|
|
553
605
|
|
|
554
606
|
On 400+ status code responses, an `OAuth2::Error` will be raised. If it is a
|
|
555
607
|
standard OAuth2 error response, the body will be parsed and `#code` and `#description` will contain the values provided from the error and
|
|
@@ -561,17 +613,36 @@ option on initialization of the client. In this case the `OAuth2::Response`
|
|
|
561
613
|
instance will be returned as usual and on 400+ status code responses, the
|
|
562
614
|
Response instance will contain the `OAuth2::Error` instance.
|
|
563
615
|
|
|
564
|
-
|
|
616
|
+
### Authorization Grants
|
|
617
|
+
|
|
618
|
+
Note on OAuth 2.1 (draft):
|
|
619
|
+
|
|
620
|
+
- PKCE is required for all OAuth clients using the authorization code flow (especially public clients). Implement PKCE in your app when required by your provider. See RFC 7636 and RFC 8252.
|
|
621
|
+
- Redirect URIs must be compared using exact string matching by the Authorization Server.
|
|
622
|
+
- The Implicit grant (response_type=token) and the Resource Owner Password Credentials grant are omitted from OAuth 2.1; they remain here for OAuth 2.0 compatibility but should be avoided for new apps.
|
|
623
|
+
- Bearer tokens in the query string are omitted due to security risks; prefer Authorization header usage.
|
|
624
|
+
- Refresh tokens for public clients must either be sender-constrained (e.g., DPoP/MTLS) or one-time use.
|
|
625
|
+
- The definitions of public and confidential clients are simplified to refer only to whether the client has credentials.
|
|
565
626
|
|
|
566
|
-
|
|
627
|
+
References:
|
|
628
|
+
|
|
629
|
+
- OAuth 2.1 draft: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-13
|
|
630
|
+
- Aaron Parecki: https://aaronparecki.com/2019/12/12/21/its-time-for-oauth-2-dot-1
|
|
631
|
+
- FusionAuth: https://fusionauth.io/blog/2020/04/15/whats-new-in-oauth-2-1
|
|
632
|
+
- Okta: https://developer.okta.com/blog/2019/12/13/oauth-2-1-how-many-rfcs
|
|
633
|
+
- Video: https://www.youtube.com/watch?v=g_aVPdwBTfw
|
|
634
|
+
- Differences overview: https://fusionauth.io/learn/expert-advice/oauth/differences-between-oauth-2-oauth-2-1/
|
|
635
|
+
|
|
636
|
+
Currently, the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
|
|
567
637
|
authentication grant types have helper strategy classes that simplify client
|
|
568
|
-
use. They are available via the [`#auth_code`](https://gitlab.com/oauth
|
|
569
|
-
[`#implicit`](https://gitlab.com/oauth
|
|
570
|
-
[`#password`](https://gitlab.com/oauth
|
|
571
|
-
[`#client_credentials`](https://gitlab.com/oauth
|
|
572
|
-
[`#assertion`](https://gitlab.com/oauth
|
|
638
|
+
use. They are available via the [`#auth_code`](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/lib/oauth2/strategy/auth_code.rb),
|
|
639
|
+
[`#implicit`](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/lib/oauth2/strategy/implicit.rb),
|
|
640
|
+
[`#password`](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/lib/oauth2/strategy/password.rb),
|
|
641
|
+
[`#client_credentials`](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/lib/oauth2/strategy/client_credentials.rb), and
|
|
642
|
+
[`#assertion`](https://gitlab.com/ruby-oauth/oauth2/-/blob/main/lib/oauth2/strategy/assertion.rb) methods respectively.
|
|
573
643
|
|
|
574
644
|
These aren't full examples, but demonstrative of the differences between usage for each strategy.
|
|
645
|
+
|
|
575
646
|
```ruby
|
|
576
647
|
auth_url = client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth/callback")
|
|
577
648
|
access = client.auth_code.get_token("code_value", redirect_uri: "http://localhost:8080/oauth/callback")
|
|
@@ -610,34 +681,513 @@ access = client.auth_code.get_token("code_value", redirect_uri: "http://localhos
|
|
|
610
681
|
You can always use the `#request` method on the `OAuth2::Client` instance to make
|
|
611
682
|
requests for tokens for any Authentication grant type.
|
|
612
683
|
|
|
613
|
-
|
|
684
|
+
## 📘 Comprehensive Usage
|
|
614
685
|
|
|
615
|
-
|
|
686
|
+
### Common Flows (end-to-end)
|
|
687
|
+
|
|
688
|
+
- Authorization Code (server-side web app):
|
|
689
|
+
|
|
690
|
+
```ruby
|
|
691
|
+
require "oauth2"
|
|
692
|
+
client = OAuth2::Client.new(
|
|
693
|
+
ENV["CLIENT_ID"],
|
|
694
|
+
ENV["CLIENT_SECRET"],
|
|
695
|
+
site: "https://provider.example.com",
|
|
696
|
+
redirect_uri: "https://my.app.example.com/oauth/callback",
|
|
697
|
+
)
|
|
698
|
+
|
|
699
|
+
# Step 1: redirect user to consent
|
|
700
|
+
state = SecureRandom.hex(16)
|
|
701
|
+
auth_url = client.auth_code.authorize_url(scope: "openid profile email", state: state)
|
|
702
|
+
# redirect_to auth_url
|
|
703
|
+
|
|
704
|
+
# Step 2: handle the callback
|
|
705
|
+
# params[:code], params[:state]
|
|
706
|
+
raise "state mismatch" unless params[:state] == state
|
|
707
|
+
access = client.auth_code.get_token(params[:code])
|
|
708
|
+
|
|
709
|
+
# Step 3: call APIs
|
|
710
|
+
profile = access.get("/api/v1/me").parsed
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
- Client Credentials (machine-to-machine):
|
|
714
|
+
|
|
715
|
+
```ruby
|
|
716
|
+
client = OAuth2::Client.new(ENV["CLIENT_ID"], ENV["CLIENT_SECRET"], site: "https://provider.example.com")
|
|
717
|
+
access = client.client_credentials.get_token(audience: "https://api.example.com")
|
|
718
|
+
resp = access.get("/v1/things")
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
- Resource Owner Password (legacy; avoid when possible):
|
|
722
|
+
|
|
723
|
+
```ruby
|
|
724
|
+
access = client.password.get_token("jdoe", "s3cret", scope: "read")
|
|
725
|
+
```
|
|
726
|
+
|
|
727
|
+
#### Examples
|
|
728
|
+
|
|
729
|
+
<details markdown="1">
|
|
730
|
+
<summary>JHipster UAA (Spring Cloud) password grant example (legacy; avoid when possible)</summary>
|
|
731
|
+
|
|
732
|
+
```ruby
|
|
733
|
+
# This converts a Postman/Net::HTTP multipart token request to oauth2 gem usage.
|
|
734
|
+
# JHipster UAA typically exposes the token endpoint at /uaa/oauth/token.
|
|
735
|
+
# The original snippet included:
|
|
736
|
+
# - Basic Authorization header for the client (web_app:changeit)
|
|
737
|
+
# - X-XSRF-TOKEN header from a cookie (some deployments require it)
|
|
738
|
+
# - grant_type=password with username/password and client_id
|
|
739
|
+
# Using oauth2 gem, you don't need to build multipart bodies; the gem sends
|
|
740
|
+
# application/x-www-form-urlencoded as required by RFC 6749.
|
|
741
|
+
|
|
742
|
+
require "oauth2"
|
|
743
|
+
|
|
744
|
+
client = OAuth2::Client.new(
|
|
745
|
+
"web_app", # client_id
|
|
746
|
+
"changeit", # client_secret
|
|
747
|
+
site: "http://localhost:8080/uaa",
|
|
748
|
+
token_url: "/oauth/token", # absolute under site (or "oauth/token" relative)
|
|
749
|
+
auth_scheme: :basic_auth, # sends HTTP Basic Authorization header
|
|
750
|
+
)
|
|
751
|
+
|
|
752
|
+
# If your UAA requires an XSRF header for the token call, provide it as a header.
|
|
753
|
+
# Often this is not required for token endpoints, but if your gateway enforces it,
|
|
754
|
+
# obtain the value from the XSRF-TOKEN cookie and pass it here.
|
|
755
|
+
xsrf_token = ENV["X_XSRF_TOKEN"] # e.g., pulled from a prior set-cookie value
|
|
756
|
+
|
|
757
|
+
access = client.password.get_token(
|
|
758
|
+
"admin", # username
|
|
759
|
+
"admin", # password
|
|
760
|
+
headers: xsrf_token ? {"X-XSRF-TOKEN" => xsrf_token} : {},
|
|
761
|
+
# JHipster commonly also accepts/needs the client_id in the body; include if required:
|
|
762
|
+
# client_id: "web_app",
|
|
763
|
+
)
|
|
764
|
+
|
|
765
|
+
puts access.token
|
|
766
|
+
puts access.to_hash # full token response
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
Notes:
|
|
770
|
+
|
|
771
|
+
- Resource Owner Password Credentials (ROPC) is deprecated in OAuth 2.1 and discouraged. Prefer Authorization Code + PKCE.
|
|
772
|
+
- If your deployment strictly demands the X-XSRF-TOKEN header, first fetch it from an endpoint that sets the XSRF-TOKEN cookie (often "/" or a login page) and pass it to headers.
|
|
773
|
+
- For Basic auth, auth_scheme: :basic_auth handles the Authorization header; you do not need to base64-encode manually.
|
|
774
|
+
|
|
775
|
+
</details>
|
|
776
|
+
|
|
777
|
+
### Instagram API (verb‑dependent token mode)
|
|
778
|
+
|
|
779
|
+
Providers like Instagram require the access token to be sent differently depending on the HTTP verb:
|
|
780
|
+
|
|
781
|
+
- GET requests: token must be in the query string (?access_token=...)
|
|
782
|
+
- POST/DELETE requests: token must be in the Authorization header (Bearer ...)
|
|
783
|
+
|
|
784
|
+
Since v2.0.15, you can configure an AccessToken with a verb‑dependent mode. The gem will choose how to send the token based on the request method.
|
|
785
|
+
|
|
786
|
+
Example: exchanging and refreshing long‑lived Instagram tokens, and making API calls
|
|
787
|
+
|
|
788
|
+
```ruby
|
|
789
|
+
require "oauth2"
|
|
790
|
+
|
|
791
|
+
# NOTE: Users authenticate via Facebook Login to obtain a short‑lived user token (not shown here).
|
|
792
|
+
# See Facebook Login docs for obtaining the initial short‑lived token.
|
|
793
|
+
|
|
794
|
+
client = OAuth2::Client.new(nil, nil, site: "https://graph.instagram.com")
|
|
795
|
+
|
|
796
|
+
# Start with a short‑lived token you already obtained via Facebook Login
|
|
797
|
+
short_lived = OAuth2::AccessToken.new(
|
|
798
|
+
client,
|
|
799
|
+
ENV["IG_SHORT_LIVED_TOKEN"],
|
|
800
|
+
# Key part: verb‑dependent mode
|
|
801
|
+
mode: {get: :query, post: :header, delete: :header},
|
|
802
|
+
)
|
|
803
|
+
|
|
804
|
+
# 1) Exchange for a long‑lived token (Instagram requires GET with access_token in query)
|
|
805
|
+
# Endpoint: GET https://graph.instagram.com/access_token
|
|
806
|
+
# Params: grant_type=ig_exchange_token, client_secret=APP_SECRET
|
|
807
|
+
exchange = short_lived.get(
|
|
808
|
+
"/access_token",
|
|
809
|
+
params: {
|
|
810
|
+
grant_type: "ig_exchange_token",
|
|
811
|
+
client_secret: ENV["IG_APP_SECRET"],
|
|
812
|
+
# access_token param will be added automatically by the AccessToken (mode => :query for GET)
|
|
813
|
+
},
|
|
814
|
+
)
|
|
815
|
+
long_lived_token_value = exchange.parsed["access_token"]
|
|
816
|
+
|
|
817
|
+
long_lived = OAuth2::AccessToken.new(
|
|
818
|
+
client,
|
|
819
|
+
long_lived_token_value,
|
|
820
|
+
mode: {get: :query, post: :header, delete: :header},
|
|
821
|
+
)
|
|
822
|
+
|
|
823
|
+
# 2) Refresh the long‑lived token (Instagram uses GET with token in query)
|
|
824
|
+
# Endpoint: GET https://graph.instagram.com/refresh_access_token
|
|
825
|
+
refresh_resp = long_lived.get(
|
|
826
|
+
"/refresh_access_token",
|
|
827
|
+
params: {grant_type: "ig_refresh_token"},
|
|
828
|
+
)
|
|
829
|
+
long_lived = OAuth2::AccessToken.new(
|
|
830
|
+
client,
|
|
831
|
+
refresh_resp.parsed["access_token"],
|
|
832
|
+
mode: {get: :query, post: :header, delete: :header},
|
|
833
|
+
)
|
|
834
|
+
|
|
835
|
+
# 3) Typical API GET request (token in query automatically)
|
|
836
|
+
me = long_lived.get("/me", params: {fields: "id,username"}).parsed
|
|
837
|
+
|
|
838
|
+
# 4) Example POST (token sent via Bearer header automatically)
|
|
839
|
+
# Note: Replace the path/params with a real Instagram Graph API POST you need,
|
|
840
|
+
# such as publishing media via the Graph API endpoints.
|
|
841
|
+
# long_lived.post("/me/media", body: {image_url: "https://...", caption: "hello"})
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
Tips:
|
|
845
|
+
|
|
846
|
+
- Avoid query‑string bearer tokens unless required by your provider. Instagram explicitly requires it for `GET` requests.
|
|
847
|
+
- If you need a custom rule, you can pass a `Proc` for `mode`, e.g. `mode: ->(verb) { verb == :get ? :query : :header }`.
|
|
848
|
+
|
|
849
|
+
### Refresh Tokens
|
|
850
|
+
|
|
851
|
+
When the server issues a refresh_token, you can refresh manually or implement an auto-refresh wrapper.
|
|
852
|
+
|
|
853
|
+
- Manual refresh:
|
|
854
|
+
|
|
855
|
+
```ruby
|
|
856
|
+
if access.expired?
|
|
857
|
+
access = access.refresh
|
|
858
|
+
end
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
- Auto-refresh wrapper pattern:
|
|
862
|
+
|
|
863
|
+
```ruby
|
|
864
|
+
class AutoRefreshingToken
|
|
865
|
+
def initialize(token_provider, store: nil)
|
|
866
|
+
@token = token_provider
|
|
867
|
+
@store = store # e.g., something that responds to read/write for token data
|
|
868
|
+
end
|
|
869
|
+
|
|
870
|
+
def with(&blk)
|
|
871
|
+
tok = ensure_fresh!
|
|
872
|
+
blk ? blk.call(tok) : tok
|
|
873
|
+
rescue OAuth2::Error => e
|
|
874
|
+
# If a 401 suggests token invalidation, try one refresh and retry once
|
|
875
|
+
if e.response && e.response.status == 401 && @token.refresh_token
|
|
876
|
+
@token = @token.refresh
|
|
877
|
+
@store.write(@token.to_hash) if @store
|
|
878
|
+
retry
|
|
879
|
+
end
|
|
880
|
+
raise
|
|
881
|
+
end
|
|
882
|
+
|
|
883
|
+
private
|
|
884
|
+
|
|
885
|
+
def ensure_fresh!
|
|
886
|
+
if @token.expired? && @token.refresh_token
|
|
887
|
+
@token = @token.refresh
|
|
888
|
+
@store.write(@token.to_hash) if @store
|
|
889
|
+
end
|
|
890
|
+
@token
|
|
891
|
+
end
|
|
892
|
+
end
|
|
893
|
+
|
|
894
|
+
# usage
|
|
895
|
+
keeper = AutoRefreshingToken.new(access)
|
|
896
|
+
keeper.with { |tok| tok.get("/v1/protected") }
|
|
897
|
+
```
|
|
898
|
+
|
|
899
|
+
Persist the token across processes using `AccessToken#to_hash` and `AccessToken.from_hash(client, hash)`.
|
|
900
|
+
|
|
901
|
+
### Token Revocation (RFC 7009)
|
|
902
|
+
|
|
903
|
+
You can revoke either the access token or the refresh token.
|
|
904
|
+
|
|
905
|
+
```ruby
|
|
906
|
+
# Revoke the current access token
|
|
907
|
+
access.revoke(token_type_hint: :access_token)
|
|
908
|
+
|
|
909
|
+
# Or explicitly revoke the refresh token (often also invalidates associated access tokens)
|
|
910
|
+
access.revoke(token_type_hint: :refresh_token)
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
### Client Configuration Tips
|
|
914
|
+
|
|
915
|
+
#### Mutual TLS (mTLS) client authentication
|
|
916
|
+
|
|
917
|
+
Some providers require OAuth requests (including the token request and subsequent API calls) to be sender‑constrained using mutual TLS (mTLS). With this gem, you enable mTLS by providing a client certificate/private key to Faraday via connection_opts.ssl and, if your provider requires it for client authentication, selecting the tls_client_auth auth_scheme.
|
|
918
|
+
|
|
919
|
+
Example using PEM files (certificate and key):
|
|
920
|
+
|
|
921
|
+
```ruby
|
|
922
|
+
require "oauth2"
|
|
923
|
+
require "openssl"
|
|
924
|
+
|
|
925
|
+
client = OAuth2::Client.new(
|
|
926
|
+
ENV.fetch("CLIENT_ID"),
|
|
927
|
+
ENV.fetch("CLIENT_SECRET"),
|
|
928
|
+
site: "https://example.com",
|
|
929
|
+
authorize_url: "/oauth/authorize/",
|
|
930
|
+
token_url: "/oauth/token/",
|
|
931
|
+
auth_scheme: :tls_client_auth, # if your AS requires mTLS-based client authentication
|
|
932
|
+
connection_opts: {
|
|
933
|
+
ssl: {
|
|
934
|
+
client_cert: OpenSSL::X509::Certificate.new(File.read("localhost.pem")),
|
|
935
|
+
client_key: OpenSSL::PKey::RSA.new(File.read("localhost-key.pem")),
|
|
936
|
+
# Optional extras, uncomment as needed:
|
|
937
|
+
# ca_file: "/path/to/ca-bundle.pem", # custom CA(s)
|
|
938
|
+
# verify: true # enable server cert verification (recommended)
|
|
939
|
+
},
|
|
940
|
+
},
|
|
941
|
+
)
|
|
942
|
+
|
|
943
|
+
# Example token request (any grant type can be used). The mTLS handshake
|
|
944
|
+
# will occur automatically on HTTPS calls using the configured cert/key.
|
|
945
|
+
access = client.client_credentials.get_token
|
|
946
|
+
|
|
947
|
+
# Subsequent resource requests will also use mTLS on HTTPS endpoints of `site`:
|
|
948
|
+
resp = access.get("/v1/protected")
|
|
949
|
+
```
|
|
950
|
+
|
|
951
|
+
Notes:
|
|
952
|
+
|
|
953
|
+
- Files must contain the appropriate PEMs. The private key may be encrypted; if so, pass a password to `OpenSSL::PKey::RSA.new(File.read(path), ENV["KEY_PASSWORD"])`.
|
|
954
|
+
- If your certificate and key are in a PKCS#12/PFX bundle, you can load them like:
|
|
955
|
+
- `p12 = OpenSSL::PKCS12.new(File.read("client.p12"), ENV["P12_PASSWORD"])`
|
|
956
|
+
- `client_cert = p12.certificate; client_key = p12.key`
|
|
957
|
+
- Server trust:
|
|
958
|
+
- If your environment does not have system CAs, specify `ca_file` or `ca_path` inside the `ssl:` hash.
|
|
959
|
+
- Keep `verify: true` in production. Set `verify: false` only for local testing.
|
|
960
|
+
- Faraday adapter: Any adapter that supports Ruby’s OpenSSL should work. `net_http` (default) and `net_http_persistent` are common choices.
|
|
961
|
+
- Scope of mTLS: The SSL client cert is applied to any HTTPS request made by this client (token and resource requests) to the configured site base URL (and absolute URLs you call with the same client).
|
|
962
|
+
- OIDC tie-in: Some OPs require tls_client_auth at the token endpoint per OIDC/OAuth specifications. That is enabled via `auth_scheme: :tls_client_auth` as shown above.
|
|
963
|
+
|
|
964
|
+
#### Authentication schemes for the token request
|
|
965
|
+
|
|
966
|
+
```ruby
|
|
967
|
+
OAuth2::Client.new(
|
|
968
|
+
id,
|
|
969
|
+
secret,
|
|
970
|
+
site: "https://provider.example.com",
|
|
971
|
+
auth_scheme: :basic_auth, # default. Alternatives: :request_body, :tls_client_auth, :private_key_jwt
|
|
972
|
+
)
|
|
973
|
+
```
|
|
974
|
+
|
|
975
|
+
#### Faraday connection, timeouts, proxy, custom adapter/middleware:
|
|
976
|
+
|
|
977
|
+
```ruby
|
|
978
|
+
client = OAuth2::Client.new(
|
|
979
|
+
id,
|
|
980
|
+
secret,
|
|
981
|
+
site: "https://provider.example.com",
|
|
982
|
+
connection_opts: {
|
|
983
|
+
request: {open_timeout: 5, timeout: 15},
|
|
984
|
+
proxy: ENV["HTTPS_PROXY"],
|
|
985
|
+
ssl: {verify: true},
|
|
986
|
+
},
|
|
987
|
+
) do |faraday|
|
|
988
|
+
faraday.request(:url_encoded)
|
|
989
|
+
# faraday.response :logger, Logger.new($stdout) # see OAUTH_DEBUG below
|
|
990
|
+
faraday.adapter(:net_http_persistent) # or any Faraday adapter you need
|
|
991
|
+
end
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
##### Using flat query params (`Faraday::FlatParamsEncoder`)
|
|
995
|
+
|
|
996
|
+
Some APIs expect repeated key parameters to be sent as flat params rather than arrays. Faraday provides `FlatParamsEncoder` for this purpose. You can configure the oauth2 client to use it when building requests.
|
|
997
|
+
|
|
998
|
+
```ruby
|
|
999
|
+
require "faraday"
|
|
1000
|
+
|
|
1001
|
+
client = OAuth2::Client.new(
|
|
1002
|
+
id,
|
|
1003
|
+
secret,
|
|
1004
|
+
site: "https://api.example.com",
|
|
1005
|
+
# Pass Faraday connection options to make FlatParamsEncoder the default
|
|
1006
|
+
connection_opts: {
|
|
1007
|
+
request: {params_encoder: Faraday::FlatParamsEncoder},
|
|
1008
|
+
},
|
|
1009
|
+
) do |faraday|
|
|
1010
|
+
faraday.request(:url_encoded)
|
|
1011
|
+
faraday.adapter(:net_http)
|
|
1012
|
+
end
|
|
1013
|
+
|
|
1014
|
+
access = client.client_credentials.get_token
|
|
1015
|
+
|
|
1016
|
+
# Example of a GET with two flat filter params (not an array):
|
|
1017
|
+
# Results in: ?filter=order.clientCreatedTime%3E1445006997000&filter=order.clientCreatedTime%3C1445611797000
|
|
1018
|
+
resp = access.get(
|
|
1019
|
+
"/v1/orders",
|
|
1020
|
+
params: {
|
|
1021
|
+
# Provide the values as an array; FlatParamsEncoder expands them as repeated keys
|
|
1022
|
+
filter: [
|
|
1023
|
+
"order.clientCreatedTime>1445006997000",
|
|
1024
|
+
"order.clientCreatedTime<1445611797000",
|
|
1025
|
+
],
|
|
1026
|
+
},
|
|
1027
|
+
)
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
If you instead need to build a raw Faraday connection yourself, the equivalent configuration is:
|
|
1031
|
+
|
|
1032
|
+
```ruby
|
|
1033
|
+
conn = Faraday.new("https://api.example.com", request: {params_encoder: Faraday::FlatParamsEncoder})
|
|
1034
|
+
```
|
|
1035
|
+
|
|
1036
|
+
#### Redirection
|
|
1037
|
+
|
|
1038
|
+
The library follows up to `max_redirects` (default 5).
|
|
1039
|
+
You can override per-client via `options[:max_redirects]`.
|
|
1040
|
+
|
|
1041
|
+
### Handling Responses and Errors
|
|
1042
|
+
|
|
1043
|
+
- Parsing:
|
|
1044
|
+
|
|
1045
|
+
```ruby
|
|
1046
|
+
resp = access.get("/v1/thing")
|
|
1047
|
+
resp.status # Integer
|
|
1048
|
+
resp.headers # Hash
|
|
1049
|
+
resp.body # String
|
|
1050
|
+
resp.parsed # SnakyHash::StringKeyed or Array when JSON array
|
|
1051
|
+
```
|
|
1052
|
+
|
|
1053
|
+
- Error handling:
|
|
1054
|
+
|
|
1055
|
+
```ruby
|
|
1056
|
+
begin
|
|
1057
|
+
access.get("/v1/forbidden")
|
|
1058
|
+
rescue OAuth2::Error => e
|
|
1059
|
+
e.code # OAuth2 error code (when present)
|
|
1060
|
+
e.description # OAuth2 error description (when present)
|
|
1061
|
+
e.response # OAuth2::Response (full access to status/headers/body)
|
|
1062
|
+
end
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
- Disable raising on 4xx/5xx to inspect the response yourself:
|
|
1066
|
+
|
|
1067
|
+
```ruby
|
|
1068
|
+
client = OAuth2::Client.new(id, secret, site: site, raise_errors: false)
|
|
1069
|
+
res = client.request(:get, "/v1/maybe-errors")
|
|
1070
|
+
if res.status == 429
|
|
1071
|
+
sleep res.headers["retry-after"].to_i
|
|
1072
|
+
end
|
|
1073
|
+
```
|
|
1074
|
+
|
|
1075
|
+
### Making Raw Token Requests
|
|
1076
|
+
|
|
1077
|
+
If a provider requires non-standard parameters or headers, you can call `client.get_token` directly:
|
|
1078
|
+
|
|
1079
|
+
```ruby
|
|
1080
|
+
access = client.get_token({
|
|
1081
|
+
grant_type: "client_credentials",
|
|
1082
|
+
audience: "https://api.example.com",
|
|
1083
|
+
headers: {"X-Custom" => "value"},
|
|
1084
|
+
parse: :json, # override parsing
|
|
1085
|
+
})
|
|
1086
|
+
```
|
|
1087
|
+
|
|
1088
|
+
### OpenID Connect (OIDC) Notes
|
|
1089
|
+
|
|
1090
|
+
- If the token response includes an `id_token` (a JWT), this gem surfaces it but does not validate the signature. Use a JWT library and your provider's JWKs to verify it.
|
|
1091
|
+
- For private_key_jwt client authentication, provide `auth_scheme: :private_key_jwt` and ensure your key configuration matches the provider requirements.
|
|
1092
|
+
- See [OIDC.md](OIDC.md) for a more complete OIDC overview, example, and links to the relevant specifications.
|
|
1093
|
+
|
|
1094
|
+
### Debugging
|
|
1095
|
+
|
|
1096
|
+
- Set environment variable `OAUTH_DEBUG=true` to enable verbose Faraday logging (uses the client-provided logger).
|
|
1097
|
+
- To mirror a working curl request, ensure you set the same auth scheme, params, and content type. The Quick Example at the top shows a curl-to-ruby translation.
|
|
1098
|
+
|
|
1099
|
+
---
|
|
1100
|
+
|
|
1101
|
+
## 🦷 FLOSS Funding
|
|
1102
|
+
|
|
1103
|
+
While ruby-oauth tools are free software and will always be, the project would benefit immensely from some funding.
|
|
1104
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
1105
|
+
|
|
1106
|
+
We welcome both individual and corporate sponsors! We also offer a
|
|
1107
|
+
wide array of funding channels to account for your preferences
|
|
1108
|
+
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
|
1109
|
+
|
|
1110
|
+
**If you're working in a company that's making significant use of ruby-oauth tools we'd
|
|
1111
|
+
appreciate it if you suggest to your company to become a ruby-oauth sponsor.**
|
|
1112
|
+
|
|
1113
|
+
You can support the development of ruby-oauth tools via
|
|
1114
|
+
[GitHub Sponsors][🖇sponsor],
|
|
1115
|
+
[Liberapay][⛳liberapay],
|
|
1116
|
+
[PayPal][🖇paypal],
|
|
1117
|
+
[Open Collective][🖇osc]
|
|
1118
|
+
and [Tidelift][🏙️entsup-tidelift].
|
|
1119
|
+
|
|
1120
|
+
| 📍 NOTE |
|
|
1121
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
1122
|
+
| If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
|
|
1123
|
+
|
|
1124
|
+
### Open Collective for Individuals
|
|
1125
|
+
|
|
1126
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/ruby-oauth#backer)]
|
|
1127
|
+
|
|
1128
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
1129
|
+
|
|
1130
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
1131
|
+
No backers yet. Be the first!
|
|
1132
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
1133
|
+
|
|
1134
|
+
### Open Collective for Organizations
|
|
1135
|
+
|
|
1136
|
+
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/ruby-oauth#sponsor)]
|
|
1137
|
+
|
|
1138
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
1139
|
+
|
|
1140
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
1141
|
+
No sponsors yet. Be the first!
|
|
1142
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
1143
|
+
|
|
1144
|
+
[kettle-readme-backers]: https://github.com/ruby-oauth/oauth2/blob/main/exe/kettle-readme-backers
|
|
1145
|
+
|
|
1146
|
+
### Another way to support open-source
|
|
1147
|
+
|
|
1148
|
+
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
|
|
1149
|
+
|
|
1150
|
+
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
|
|
1151
|
+
|
|
1152
|
+
I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
|
|
1153
|
+
|
|
1154
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
1155
|
+
|
|
1156
|
+
[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
|
|
616
1157
|
|
|
617
1158
|
## 🔐 Security
|
|
618
1159
|
|
|
619
|
-
|
|
1160
|
+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
|
|
1161
|
+
Tidelift will coordinate the fix and disclosure.
|
|
1162
|
+
|
|
1163
|
+
For more see [SECURITY.md][🔐security], [THREAT_MODEL.md][🔐threat-model], and [IRP.md][🔐irp].
|
|
620
1164
|
|
|
621
1165
|
## 🤝 Contributing
|
|
622
1166
|
|
|
623
1167
|
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
624
|
-
or if it is already 💯 (see [below](#code-coverage)) check
|
|
625
|
-
or check [issues][🤝issues], or [PRs][🤝pulls],
|
|
1168
|
+
or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
|
626
1169
|
or use the gem and think about how it could be better.
|
|
627
1170
|
|
|
628
1171
|
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
629
1172
|
|
|
630
1173
|
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
631
1174
|
|
|
1175
|
+
### 🚀 Release Instructions
|
|
1176
|
+
|
|
1177
|
+
See [CONTRIBUTING.md][🤝contributing].
|
|
1178
|
+
|
|
632
1179
|
### Code Coverage
|
|
633
1180
|
|
|
634
|
-
[![
|
|
635
|
-
|
|
1181
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
1182
|
+
|
|
1183
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
1184
|
+
|
|
1185
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
636
1186
|
|
|
637
1187
|
### 🪇 Code of Conduct
|
|
638
1188
|
|
|
639
|
-
Everyone interacting
|
|
640
|
-
chat rooms and mailing lists
|
|
1189
|
+
Everyone interacting with this project's codebases, issue trackers,
|
|
1190
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
641
1191
|
|
|
642
1192
|
## 🌈 Contributors
|
|
643
1193
|
|
|
@@ -645,18 +1195,21 @@ chat rooms and mailing lists is expected to follow the [![Contributor Covenant 2
|
|
|
645
1195
|
|
|
646
1196
|
Made with [contributors-img][🖐contrib-rocks].
|
|
647
1197
|
|
|
648
|
-
Also see GitLab Contributors: [https://gitlab.com/oauth
|
|
1198
|
+
Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/oauth2/-/graphs/main][🚎contributors-gl]
|
|
649
1199
|
|
|
650
|
-
|
|
1200
|
+
<details>
|
|
1201
|
+
<summary>⭐️ Star History</summary>
|
|
651
1202
|
|
|
652
|
-
<a href="https://star-history.com/#oauth
|
|
1203
|
+
<a href="https://star-history.com/#ruby-oauth/oauth2&Date">
|
|
653
1204
|
<picture>
|
|
654
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=oauth
|
|
655
|
-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=oauth
|
|
656
|
-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=oauth
|
|
1205
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth2&type=Date&theme=dark" />
|
|
1206
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth2&type=Date" />
|
|
1207
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ruby-oauth/oauth2&type=Date" />
|
|
657
1208
|
</picture>
|
|
658
1209
|
</a>
|
|
659
1210
|
|
|
1211
|
+
</details>
|
|
1212
|
+
|
|
660
1213
|
## 📌 Versioning
|
|
661
1214
|
|
|
662
1215
|
This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
|
|
@@ -665,34 +1218,34 @@ Specifically, if a minor or patch version is released that breaks backward compa
|
|
|
665
1218
|
a new version should be immediately released that restores compatibility.
|
|
666
1219
|
Breaking changes to the public API will only be introduced with new major versions.
|
|
667
1220
|
|
|
668
|
-
|
|
1221
|
+
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
|
1222
|
+
>—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
|
1223
|
+
|
|
1224
|
+
I understand that policy doesn't work universally ("exceptions to every rule!"),
|
|
1225
|
+
but it is the policy here.
|
|
1226
|
+
As such, in many cases it is good to specify a dependency on this library using
|
|
1227
|
+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
669
1228
|
|
|
670
|
-
|
|
1229
|
+
For example:
|
|
671
1230
|
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
1231
|
+
```ruby
|
|
1232
|
+
spec.add_dependency("oauth2", "~> 2.0")
|
|
1233
|
+
```
|
|
675
1234
|
|
|
676
|
-
>
|
|
1235
|
+
<details markdown="1">
|
|
1236
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
677
1237
|
|
|
678
|
-
|
|
1238
|
+
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
|
|
1239
|
+
is a *breaking change* to an API, and for that reason the bike shedding is endless.
|
|
679
1240
|
|
|
680
1241
|
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
681
1242
|
read this article from the creator of SemVer:
|
|
682
1243
|
|
|
683
1244
|
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
684
1245
|
|
|
685
|
-
|
|
686
|
-
you can (and should) specify a dependency on these libraries using
|
|
687
|
-
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
688
|
-
|
|
689
|
-
For example:
|
|
690
|
-
|
|
691
|
-
```ruby
|
|
692
|
-
spec.add_dependency("oauth2", "~> 2.0")
|
|
693
|
-
```
|
|
1246
|
+
</details>
|
|
694
1247
|
|
|
695
|
-
See [CHANGELOG.md][📌changelog] for list of releases.
|
|
1248
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
696
1249
|
|
|
697
1250
|
## 📄 License
|
|
698
1251
|
|
|
@@ -700,59 +1253,102 @@ The gem is available as open source under the terms of
|
|
|
700
1253
|
the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
|
|
701
1254
|
See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
|
|
702
1255
|
|
|
703
|
-
[![FOSSA Status][fossa2-img])][fossa2]
|
|
704
|
-
|
|
705
|
-
[fossa2]: https://app.fossa.io/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2?ref=badge_large
|
|
706
|
-
[fossa2-img]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2.svg?type=large
|
|
707
|
-
|
|
708
1256
|
### © Copyright
|
|
709
1257
|
|
|
710
1258
|
<ul>
|
|
711
1259
|
<li>
|
|
712
|
-
2017
|
|
713
|
-
<a href="https://
|
|
714
|
-
|
|
1260
|
+
Copyright (c) 2017 – 2025 Peter H. Boling, of
|
|
1261
|
+
<a href="https://discord.gg/3qme4XHNKN">
|
|
1262
|
+
Galtzo.com
|
|
715
1263
|
<picture>
|
|
716
|
-
|
|
1264
|
+
<img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
|
|
717
1265
|
</picture>
|
|
718
|
-
</a>, and oauth2 contributors
|
|
1266
|
+
</a>, and oauth2 contributors.
|
|
719
1267
|
</li>
|
|
720
1268
|
<li>
|
|
721
1269
|
Copyright (c) 2011 - 2013 Michael Bleigh and Intridea, Inc.
|
|
722
1270
|
</li>
|
|
723
1271
|
</ul>
|
|
724
1272
|
|
|
725
|
-
## 🤑
|
|
1273
|
+
## 🤑 A request for help
|
|
1274
|
+
|
|
1275
|
+
Maintainers have teeth and need to pay their dentists.
|
|
1276
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
1277
|
+
I began spending most of my time building open source tools.
|
|
1278
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
1279
|
+
so if you value the work I am doing, I need your support.
|
|
1280
|
+
Please consider sponsoring me or the project.
|
|
1281
|
+
|
|
1282
|
+
To join the community or get help 👇️ Join the Discord.
|
|
1283
|
+
|
|
1284
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
726
1285
|
|
|
727
|
-
|
|
728
|
-
so perhaps you'll indulge me for another 20 seconds.
|
|
729
|
-
I maintain many dozens of gems, including this one,
|
|
730
|
-
because I want Ruby to be a great place for people to solve problems, big and small.
|
|
731
|
-
Please consider supporting my efforts via the giant yellow link below,
|
|
732
|
-
or one of the others at the head of this README.
|
|
1286
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
733
1287
|
|
|
734
|
-
[![
|
|
1288
|
+
[![Sponsor ruby-oauth/oauth2 on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
|
|
1289
|
+
|
|
1290
|
+
### Please give the project a star ⭐ ♥.
|
|
1291
|
+
|
|
1292
|
+
Thanks for RTFM. ☺️
|
|
1293
|
+
|
|
1294
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
1295
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
1296
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
1297
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/ruby-oauth
|
|
1298
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth
|
|
1299
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/ruby-oauth
|
|
1300
|
+
[🖇osc-backers]: https://opencollective.com/ruby-oauth#backer
|
|
1301
|
+
[🖇osc-backers-i]: https://opencollective.com/ruby-oauth/backers/badge.svg?style=flat
|
|
1302
|
+
[🖇osc-sponsors]: https://opencollective.com/ruby-oauth#sponsor
|
|
1303
|
+
[🖇osc-sponsors-i]: https://opencollective.com/ruby-oauth/sponsors/badge.svg?style=flat
|
|
1304
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/ruby-oauth?style=for-the-badge
|
|
1305
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth?style=for-the-badge
|
|
1306
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/ruby-oauth?style=for-the-badge
|
|
1307
|
+
[🖇osc]: https://opencollective.com/ruby-oauth
|
|
1308
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
1309
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
1310
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
1311
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
1312
|
+
[🖇polar]: https://polar.sh/pboling
|
|
1313
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
1314
|
+
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
|
1315
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
1316
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
1317
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
1318
|
+
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
|
1319
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
1320
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
1321
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
1322
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
1323
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
1324
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
1325
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
1326
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
1327
|
+
[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
|
|
1328
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
735
1329
|
|
|
736
1330
|
[⛳gg-discussions]: https://groups.google.com/g/oauth-ruby
|
|
737
|
-
[⛳gg-discussions-img]: https://img.shields.io/badge/google-group-
|
|
1331
|
+
[⛳gg-discussions-img]: https://img.shields.io/badge/google-group-0093D0.svg?style=for-the-badge&logo=google&logoColor=orange
|
|
738
1332
|
|
|
739
1333
|
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
740
|
-
[⛳️gem-namespace]: https://github.com/oauth
|
|
741
|
-
[⛳️namespace-img]: https://img.shields.io/badge/namespace-OAuth2-
|
|
742
|
-
[⛳️gem-name]: https://
|
|
743
|
-
[⛳️name-img]: https://img.shields.io/badge/name-oauth2-
|
|
744
|
-
[
|
|
745
|
-
[
|
|
746
|
-
[🚂
|
|
747
|
-
[🚂
|
|
1334
|
+
[⛳️gem-namespace]: https://github.com/ruby-oauth/oauth2
|
|
1335
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-OAuth2-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
1336
|
+
[⛳️gem-name]: https://bestgems.org/gems/oauth2
|
|
1337
|
+
[⛳️name-img]: https://img.shields.io/badge/name-oauth2-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
1338
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/ruby-oauth/oauth2.svg
|
|
1339
|
+
[⛳️tag]: http://github.com/ruby-oauth/oauth2/releases
|
|
1340
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/oauth2
|
|
1341
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
1342
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
1343
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
748
1344
|
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
749
1345
|
[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
|
|
750
|
-
[💖✌️wellfound]: https://
|
|
1346
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
751
1347
|
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
752
1348
|
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
753
1349
|
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
754
1350
|
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
755
|
-
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https
|
|
1351
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
756
1352
|
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
757
1353
|
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
758
1354
|
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
@@ -769,76 +1365,70 @@ or one of the others at the head of this README.
|
|
|
769
1365
|
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
770
1366
|
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
771
1367
|
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
772
|
-
[🏙️entsup-tidelift]: https://tidelift.com/subscription
|
|
1368
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-oauth2?utm_source=rubygems-oauth2&utm_medium=referral&utm_campaign=readme
|
|
773
1369
|
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
774
1370
|
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
775
1371
|
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
776
1372
|
[🚂railsbling]: http://www.railsbling.com
|
|
777
1373
|
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
778
|
-
[📜src-gl]: https://gitlab.com/oauth
|
|
1374
|
+
[📜src-gl]: https://gitlab.com/ruby-oauth/oauth2/
|
|
779
1375
|
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
780
|
-
[📜src-cb]: https://codeberg.org/oauth
|
|
1376
|
+
[📜src-cb]: https://codeberg.org/ruby-oauth/oauth2
|
|
781
1377
|
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
|
782
|
-
[📜src-gh]: https://github.com/oauth
|
|
1378
|
+
[📜src-gh]: https://github.com/ruby-oauth/oauth2
|
|
783
1379
|
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
784
|
-
[📜docs-head-rd-img]: https://img.shields.io/badge/
|
|
785
|
-
[📜wiki]: https://gitlab.com/oauth
|
|
786
|
-
[📜wiki
|
|
787
|
-
[
|
|
1380
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
1381
|
+
[📜gl-wiki]: https://gitlab.com/ruby-oauth/oauth2/-/wikis/home
|
|
1382
|
+
[📜gh-wiki]: https://github.com/ruby-oauth/oauth2/wiki
|
|
1383
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
1384
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
1385
|
+
[👽dl-rank]: https://bestgems.org/gems/oauth2
|
|
788
1386
|
[👽dl-ranki]: https://img.shields.io/gem/rd/oauth2.svg
|
|
789
|
-
[👽oss-help]: https://www.codetriage.com/oauth
|
|
790
|
-
[👽oss-helpi]: https://www.codetriage.com/oauth
|
|
791
|
-
[👽version]: https://
|
|
1387
|
+
[👽oss-help]: https://www.codetriage.com/ruby-oauth/oauth2
|
|
1388
|
+
[👽oss-helpi]: https://www.codetriage.com/ruby-oauth/oauth2/badges/users.svg
|
|
1389
|
+
[👽version]: https://bestgems.org/gems/oauth2
|
|
792
1390
|
[👽versioni]: https://img.shields.io/gem/v/oauth2.svg
|
|
793
|
-
[
|
|
794
|
-
[
|
|
795
|
-
[
|
|
796
|
-
[
|
|
797
|
-
[
|
|
798
|
-
[
|
|
799
|
-
[
|
|
800
|
-
[
|
|
801
|
-
[
|
|
802
|
-
[
|
|
803
|
-
[
|
|
804
|
-
[
|
|
805
|
-
[🚎
|
|
806
|
-
[🚎
|
|
807
|
-
[🚎
|
|
808
|
-
[🚎
|
|
809
|
-
[🚎
|
|
810
|
-
[🚎
|
|
811
|
-
[🚎
|
|
812
|
-
[🚎
|
|
813
|
-
[🚎
|
|
814
|
-
[🚎
|
|
815
|
-
[🚎
|
|
816
|
-
[🚎
|
|
817
|
-
[🚎
|
|
818
|
-
[🚎
|
|
819
|
-
[🚎
|
|
820
|
-
[🚎
|
|
821
|
-
[🚎
|
|
822
|
-
[🚎
|
|
823
|
-
[🚎
|
|
824
|
-
[🚎
|
|
825
|
-
[🚎
|
|
826
|
-
[🚎
|
|
827
|
-
[🚎
|
|
828
|
-
[🚎
|
|
829
|
-
[
|
|
830
|
-
[
|
|
831
|
-
[
|
|
832
|
-
[
|
|
833
|
-
[
|
|
834
|
-
[🖇polar]: https://polar.sh/pboling
|
|
835
|
-
[🖇kofi-img]: https://img.shields.io/badge/a_more_different_coffee-✓-yellow.svg
|
|
836
|
-
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
|
837
|
-
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
|
|
838
|
-
[🖇patreon]: https://patreon.com/galtzo
|
|
839
|
-
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
|
840
|
-
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
841
|
-
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-yellow.svg?style=flat
|
|
1391
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/ruby-oauth/projects/oauth2
|
|
1392
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/ruby-oauth/projects/oauth2/maintainability.svg
|
|
1393
|
+
[🏀qlty-cov]: https://qlty.sh/gh/ruby-oauth/projects/oauth2/metrics/code?sort=coverageRating
|
|
1394
|
+
[🏀qlty-covi]: https://qlty.sh/gh/ruby-oauth/projects/oauth2/coverage.svg
|
|
1395
|
+
[🏀codecov]: https://codecov.io/gh/ruby-oauth/oauth2
|
|
1396
|
+
[🏀codecovi]: https://codecov.io/gh/ruby-oauth/oauth2/graph/badge.svg
|
|
1397
|
+
[🏀coveralls]: https://coveralls.io/github/ruby-oauth/oauth2?branch=main
|
|
1398
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/ruby-oauth/oauth2/badge.svg?branch=main
|
|
1399
|
+
[🖐codeQL]: https://github.com/ruby-oauth/oauth2/security/code-scanning
|
|
1400
|
+
[🖐codeQL-img]: https://github.com/ruby-oauth/oauth2/actions/workflows/codeql-analysis.yml/badge.svg
|
|
1401
|
+
[🚎1-an-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/ancient.yml
|
|
1402
|
+
[🚎1-an-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/ancient.yml/badge.svg
|
|
1403
|
+
[🚎2-cov-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/coverage.yml
|
|
1404
|
+
[🚎2-cov-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/coverage.yml/badge.svg
|
|
1405
|
+
[🚎3-hd-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/heads.yml
|
|
1406
|
+
[🚎3-hd-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/heads.yml/badge.svg
|
|
1407
|
+
[🚎4-lg-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/legacy.yml
|
|
1408
|
+
[🚎4-lg-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/legacy.yml/badge.svg
|
|
1409
|
+
[🚎5-st-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/style.yml
|
|
1410
|
+
[🚎5-st-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/style.yml/badge.svg
|
|
1411
|
+
[🚎6-s-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/supported.yml
|
|
1412
|
+
[🚎6-s-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/supported.yml/badge.svg
|
|
1413
|
+
[🚎7-us-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/unsupported.yml
|
|
1414
|
+
[🚎7-us-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/unsupported.yml/badge.svg
|
|
1415
|
+
[🚎8-ho-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/hoary.yml
|
|
1416
|
+
[🚎8-ho-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/hoary.yml/badge.svg
|
|
1417
|
+
[🚎10-j-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/jruby.yml
|
|
1418
|
+
[🚎10-j-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/jruby.yml/badge.svg
|
|
1419
|
+
[🚎11-c-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/current.yml
|
|
1420
|
+
[🚎11-c-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/current.yml/badge.svg
|
|
1421
|
+
[🚎12-crh-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/dep-heads.yml
|
|
1422
|
+
[🚎12-crh-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/dep-heads.yml/badge.svg
|
|
1423
|
+
[🚎13-cbs-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/caboose.yml
|
|
1424
|
+
[🚎13-cbs-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/caboose.yml/badge.svg
|
|
1425
|
+
[🚎13-🔒️-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/locked_deps.yml
|
|
1426
|
+
[🚎13-🔒️-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/locked_deps.yml/badge.svg
|
|
1427
|
+
[🚎14-🔓️-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/unlocked_deps.yml
|
|
1428
|
+
[🚎14-🔓️-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/unlocked_deps.yml/badge.svg
|
|
1429
|
+
[🚎15-🪪-wf]: https://github.com/ruby-oauth/oauth2/actions/workflows/license-eye.yml
|
|
1430
|
+
[🚎15-🪪-wfi]: https://github.com/ruby-oauth/oauth2/actions/workflows/license-eye.yml/badge.svg
|
|
1431
|
+
[💎ruby-2.2i]: https://img.shields.io/badge/Ruby-2.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
|
|
842
1432
|
[💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
843
1433
|
[💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
844
1434
|
[💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
@@ -850,55 +1440,66 @@ or one of the others at the head of this README.
|
|
|
850
1440
|
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
851
1441
|
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
852
1442
|
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
853
|
-
[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.
|
|
854
|
-
[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.
|
|
855
|
-
[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.
|
|
1443
|
+
[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
1444
|
+
[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
1445
|
+
[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
856
1446
|
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
857
1447
|
[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
|
|
858
|
-
[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.
|
|
859
|
-
[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.
|
|
860
|
-
[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.
|
|
1448
|
+
[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
1449
|
+
[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
1450
|
+
[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
861
1451
|
[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
|
|
862
1452
|
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
863
1453
|
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
864
|
-
[🤝issues]: https://github.com/oauth
|
|
865
|
-
[🤝pulls]: https://github.com/oauth
|
|
1454
|
+
[🤝gh-issues]: https://github.com/ruby-oauth/oauth2/issues
|
|
1455
|
+
[🤝gh-pulls]: https://github.com/ruby-oauth/oauth2/pulls
|
|
1456
|
+
[🤝gl-issues]: https://gitlab.com/ruby-oauth/oauth2/-/issues
|
|
1457
|
+
[🤝gl-pulls]: https://gitlab.com/ruby-oauth/oauth2/-/merge_requests
|
|
1458
|
+
[🤝cb-issues]: https://codeberg.org/ruby-oauth/oauth2/issues
|
|
1459
|
+
[🤝cb-pulls]: https://codeberg.org/ruby-oauth/oauth2/pulls
|
|
1460
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
866
1461
|
[🤝contributing]: CONTRIBUTING.md
|
|
867
|
-
[
|
|
1462
|
+
[🏀codecov-g]: https://codecov.io/gh/ruby-oauth/oauth2/graphs/tree.svg
|
|
868
1463
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
869
|
-
[🖐contributors]: https://github.com/oauth
|
|
870
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=oauth
|
|
871
|
-
[🚎contributors-gl]: https://gitlab.com/oauth
|
|
1464
|
+
[🖐contributors]: https://github.com/ruby-oauth/oauth2/graphs/contributors
|
|
1465
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/oauth2
|
|
1466
|
+
[🚎contributors-gl]: https://gitlab.com/ruby-oauth/oauth2/-/graphs/main
|
|
872
1467
|
[🪇conduct]: CODE_OF_CONDUCT.md
|
|
873
|
-
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-
|
|
1468
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
874
1469
|
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
875
1470
|
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
876
|
-
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-
|
|
1471
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
877
1472
|
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
878
1473
|
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
879
1474
|
[📌changelog]: CHANGELOG.md
|
|
880
1475
|
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
881
|
-
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-
|
|
882
|
-
[📌gitmoji]:https://gitmoji.dev
|
|
883
|
-
[📌gitmoji-img]:https://img.shields.io/badge/
|
|
1476
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
1477
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
1478
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
884
1479
|
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
885
|
-
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.
|
|
1480
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.526-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
886
1481
|
[🔐security]: SECURITY.md
|
|
887
|
-
[🔐security-img]: https://img.shields.io/badge/security-policy-
|
|
1482
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
1483
|
+
[🔐irp]: IRP.md
|
|
1484
|
+
[🔐irp-img]: https://img.shields.io/badge/IRP-259D6C.svg?style=flat
|
|
1485
|
+
[🔐threat-model]: THREAT_MODEL.md
|
|
1486
|
+
[🔐threat-model-img]: https://img.shields.io/badge/threat-model-259D6C.svg?style=flat
|
|
888
1487
|
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
889
1488
|
[📄license]: LICENSE.txt
|
|
890
1489
|
[📄license-ref]: https://opensource.org/licenses/MIT
|
|
891
|
-
[📄license-img]: https://img.shields.io/badge/License-MIT-
|
|
1490
|
+
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
1491
|
+
[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
|
|
1492
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
|
|
892
1493
|
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
893
|
-
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-
|
|
1494
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
894
1495
|
[🚎yard-current]: http://rubydoc.info/gems/oauth2
|
|
895
|
-
[🚎yard-head]: https://
|
|
896
|
-
[💎stone_checksums]: https://github.com/
|
|
897
|
-
[💎SHA_checksums]: https://gitlab.com/oauth
|
|
1496
|
+
[🚎yard-head]: https://oauth2.galtzo.com
|
|
1497
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
1498
|
+
[💎SHA_checksums]: https://gitlab.com/ruby-oauth/oauth2/-/tree/main/checksums
|
|
898
1499
|
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
899
|
-
[💎rlts-img]: https://img.shields.io/badge/
|
|
900
|
-
[
|
|
901
|
-
[
|
|
1500
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
1501
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
1502
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
902
1503
|
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|
|
903
1504
|
|
|
904
1505
|
<details>
|
|
@@ -906,17 +1507,7 @@ or one of the others at the head of this README.
|
|
|
906
1507
|
rel="me" Social Proofs
|
|
907
1508
|
</summary>
|
|
908
1509
|
|
|
909
|
-
<a rel="me" alt="Follow me on Ruby.social" href="https://ruby.social/@galtzo"><img src="https://img.shields.io/mastodon/follow/109447111526622197?domain=https
|
|
910
|
-
<a rel="me" alt="Follow me on FLOSS.social" href="https://floss.social/@galtzo"><img src="https://img.shields.io/mastodon/follow/110304921404405715?domain=https
|
|
911
|
-
</details>
|
|
912
|
-
|
|
913
|
-
<details>
|
|
914
|
-
<summary>Deprecated Badges</summary>
|
|
915
|
-
|
|
916
|
-
CodeCov currently fails to parse the coverage upload.
|
|
917
|
-
|
|
918
|
-
[![CodeCov Test Coverage][🔑codecovi♻️]][🔑codecov]
|
|
1510
|
+
<a rel="me" alt="Follow me on Ruby.social" href="https://ruby.social/@galtzo"><img src="https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=social&label=Follow%20@galtzo%20on%20Ruby.social"></a>
|
|
1511
|
+
<a rel="me" alt="Follow me on FLOSS.social" href="https://floss.social/@galtzo"><img src="https://img.shields.io/mastodon/follow/110304921404405715?domain=https://floss.social&style=social&label=Follow%20@galtzo%20on%20Floss.social"></a>
|
|
919
1512
|
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
</details>
|
|
1513
|
+
</details>
|