oauth2 2.0.9 → 2.0.11

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.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +329 -168
  4. data/CONTRIBUTING.md +126 -31
  5. data/{LICENSE → LICENSE.txt} +1 -1
  6. data/README.md +643 -266
  7. data/SECURITY.md +2 -2
  8. data/lib/oauth2/access_token.rb +210 -32
  9. data/lib/oauth2/authenticator.rb +9 -6
  10. data/lib/oauth2/client.rb +307 -96
  11. data/lib/oauth2/error.rb +14 -14
  12. data/lib/oauth2/filtered_attributes.rb +31 -0
  13. data/lib/oauth2/response.rb +78 -42
  14. data/lib/oauth2/strategy/assertion.rb +4 -4
  15. data/lib/oauth2/strategy/auth_code.rb +3 -3
  16. data/lib/oauth2/strategy/client_credentials.rb +2 -2
  17. data/lib/oauth2/strategy/implicit.rb +3 -3
  18. data/lib/oauth2/strategy/password.rb +6 -4
  19. data/lib/oauth2/version.rb +1 -1
  20. data/lib/oauth2.rb +23 -18
  21. data.tar.gz.sig +0 -0
  22. metadata +200 -68
  23. metadata.gz.sig +0 -0
data/README.md CHANGED
@@ -7,64 +7,250 @@
7
7
  </a>
8
8
  </p>
9
9
 
10
- ## What
10
+ ## 🔐 OAuth2
11
+
12
+ [![Version][👽versioni]][👽version] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![Depfu][🔑depfui♻️]][🔑depfu] [![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 Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-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 Caboose is an absolute WAGON][🚎13-cbs-wfi]][🚎13-cbs-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL]
13
+
14
+ ---
15
+
16
+ [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
11
17
 
12
18
  OAuth 2.0 is the industry-standard protocol for authorization.
13
19
  OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications,
14
20
  desktop applications, mobile phones, and living room devices.
15
- This is a RubyGem for implementing OAuth 2.0 clients and servers in Ruby applications.
16
- See the sibling `oauth` gem for OAuth 1.0 implementations in Ruby.
21
+ This is a RubyGem for implementing OAuth 2.0 clients (not servers) in Ruby applications.
17
22
 
18
- ---
23
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
24
+ |-----------------------------------------------|-------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
25
+ | 🧪 [oauth-xx/oauth2 on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜wiki] | 🏀 Tiny Matrix | ➖ |
26
+ | 🧊 [oauth-xx/oauth2 on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | ➖ | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
27
+ | 🐙 [oauth-xx/oauth2 on GitHub][📜src-gh] | A Dirty Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | ➖ | 💯 Full Matrix | ➖ |
28
+ | 🤼 [OAuth Ruby Google Group][⛳gg-discussions] | "Active" | ➖ | ➖ | ➖ | ➖ | [💚][⛳gg-discussions] |
29
+ | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
30
+
31
+ ### Upgrading Runtime Gem Dependencies
32
+
33
+ This project sits underneath a large portion of the authorization systems on the internet.
34
+ According to GitHub's project tracking, which I believe only reports on public projects,
35
+ [100,000+ projects](https://github.com/oauth-xx/oauth2/network/dependents), and
36
+ [500+ packages](https://github.com/oauth-xx/oauth2/network/dependents?dependent_type=PACKAGE) depend on this project.
37
+
38
+ That means it is painful for the Ruby community when this gem forces updates to its runtime dependencies.
39
+
40
+ As a result, great care, and a lot of time, have been invested to ensure this gem is working with all the
41
+ leading versions per each minor version of Ruby of all the runtime dependencies it can install with.
42
+
43
+ What does that mean specifically for the runtime dependencies?
44
+
45
+ We have 100% test coverage of lines and branches, and this test suite runs across a large matrix
46
+ covering the latest patch for each of the following minor versions:
47
+
48
+ * MRI Ruby @ v2.3, v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2, v3.3, v3.4, HEAD
49
+ * NOTE: This gem will still install on ruby v2.2, but vanilla GitHub Actions no longer supports testing against it, so YMMV.
50
+ * JRuby @ v9.2, v9.3, v9.4, v10.0, HEAD
51
+ * TruffleRuby @ v23.1, v23.2, HEAD
52
+ * gem `faraday` @ v0, v1, v2, HEAD ⏩️ [lostisland/faraday](https://github.com/lostisland/faraday)
53
+ * gem `jwt` @ v1, v2, v3, HEAD ⏩️ [lostisland/faraday](https://github.com/lostisland/faraday)
54
+ * gem `logger` @ v1.2, v1.5, v1.7, HEAD ⏩️ [jwt/ruby-jwt](https://github.com/jwt/ruby-jwt)
55
+ * gem `multi_xml` @ v0.5, v0.6, v0.7, HEAD ⏩️ [sferik/multi_xml](https://github.com/sferik/multi_xml)
56
+ * gem `rack` @ v1.2, v1.6, v2, v3, HEAD ⏩️ [rack/rack](https://github.com/rack/rack)
57
+ * gem `snaky_hash` @v2, HEAD ⏩️ [oauth-xx/snaky_hash](https://gitlab.com/oauth-xx/snaky_hash)
58
+ * gem `version_gem` - @v1, HEAD ⏩️ [oauth-xx/version_gem](https://gitlab.com/oauth-xx/version_gem)
59
+
60
+ The last two were extracted from this gem. They are part of the `oauth-xx` org,
61
+ and are developed in tight collaboration with this gem.
62
+
63
+ Also, where reasonable, tested against the runtime dependencies of those dependencies:
64
+
65
+ * gem `hashie` @ v0, v1, v2, v3, v4, v5, HEAD ⏩️ [hashie/hashie](https://github.com/hashie/hashie)
66
+
67
+ #### You should upgrade this gem with confidence\*.
68
+
69
+ - This gem follows a _strict & correct_ (according to the maintainer of SemVer; [more info][sv-pub-api]) interpretation of SemVer.
70
+ - Dropping support for **any** of the runtime dependency versions above will be a major version bump.
71
+ - If you aren't on one of the minor versions above, make getting there a priority.
72
+ - You should upgrade the dependencies of this gem with confidence\*.
73
+ - Please do upgrade, and then, when it goes smooth as butter [please sponsor me][🖇sponsor]. Thanks!
74
+
75
+ [sv-pub-api]: #-is-platform-support-part-of-the-public-api
76
+
77
+ \* MIT license; I am unable to make guarantees.
78
+
79
+ | 🚚 Test matrix brought to you by | 🔎 appraisal++ |
80
+ |----------------------------------|-------------------------------------------------------------------------|
81
+ | Adds back support for old Rubies | ✨ [appraisal PR #250](https://github.com/thoughtbot/appraisal/pull/250) |
82
+ | Adds support for `eval_gemfile` | ✨ [appraisal PR #248](https://github.com/thoughtbot/appraisal/pull/248) |
83
+ | Please review | my PRs! |
84
+
85
+ <details>
86
+ <summary>Standard Library Dependencies</summary>
87
+
88
+ The various versions of each are tested via the Ruby test matrix, along with whatever Ruby includes them.
89
+
90
+ * base64
91
+ * cgi
92
+ * json
93
+ * time
94
+ * logger (removed from stdlib in Ruby 3.5 so added as runtime dependency in v2.0.10)
95
+
96
+ If you use a gem version it should work fine!
97
+
98
+ </details>
99
+
100
+ ### Quick Usage Example for AI and Copy / Pasting
101
+
102
+ Convert the following `curl` command into a token request using this gem...
103
+
104
+ ```shell
105
+ curl --request POST \
106
+ --url 'https://login.microsoftonline.com/REDMOND_REDACTED/oauth2/token' \
107
+ --header 'content-type: application/x-www-form-urlencoded' \
108
+ --data grant_type=client_credentials \
109
+ --data client_id=REDMOND_CLIENT_ID \
110
+ --data client_secret=REDMOND_CLIENT_SECRET \
111
+ --data resource=REDMOND_RESOURCE_UUID
112
+ ```
113
+
114
+ NOTE: In the ruby version below, certain params are passed to the `get_token` call, instead of the client creation.
115
+
116
+ ```ruby
117
+ OAuth2::Client.new(
118
+ "REDMOND_CLIENT_ID", # client_id
119
+ "REDMOND_CLIENT_SECRET", # client_secret
120
+ auth_scheme: :request_body, # Other modes are supported: :basic_auth, :tls_client_auth, :private_key_jwt
121
+ token_url: "oauth2/token", # relative path, except with leading `/`, then absolute path
122
+ site: "https://login.microsoftonline.com/REDMOND_REDACTED",
123
+ ). # The base path for token_url when it is relative
124
+ client_credentials. # There are many other types to choose from!
125
+ get_token(resource: "REDMOND_RESOURCE_UUID")
126
+ ```
127
+
128
+ NOTE: `header` - The content type specified in the `curl` is already the default!
129
+
130
+ If any of the above makes you uncomfortable, you may be in the wrong place.
131
+ One of these might be what you are looking for:
19
132
 
20
133
  * [OAuth 2.0 Spec][oauth2-spec]
134
+ * [doorkeeper gem][doorkeeper-gem] for OAuth 2.0 server/provider implementation.
21
135
  * [oauth sibling gem][sibling-gem] for OAuth 1.0 implementations in Ruby.
22
136
 
23
137
  [oauth2-spec]: https://oauth.net/2/
24
138
  [sibling-gem]: https://gitlab.com/oauth-xx/oauth
25
-
26
- ## Release Documentation
139
+ [doorkeeper-gem]: https://github.com/doorkeeper-gem/doorkeeper
140
+
141
+ ## 💡 Info you can shake a stick at
142
+
143
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
144
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
145
+ | Works with JRuby | [![JRuby 9.2 Compat][💎jruby-9.2i]][🚎10-j-wf] [![JRuby 9.3 Compat][💎jruby-9.3i]][🚎10-j-wf] [![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] |
146
+ | Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf] |
147
+ | 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] |
148
+ | Works with MRI Ruby 2 | [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎13-cbs-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] |
149
+ | 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] |
150
+ | Documentation | [![Discussion][⛳gg-discussions-img]][⛳gg-discussions] [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![HEAD on RubyDoc.info][📜docs-head-rd-img]][🚎yard-head] [![BDFL Blog][🚂bdfl-blog-img]][🚂bdfl-blog] [![Wiki][📜wiki-img]][📜wiki] |
151
+ | Compliance | [![License: MIT][📄license-img]][📄license-ref] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
152
+ | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] |
153
+ | Support | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
154
+ | Enterprise Support | [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]<br/>💡Subscribe for support guarantees covering _all_ FLOSS dependencies!<br/>💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]!<br/>💡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! |
155
+ | Comrade BDFL 🎖️ | [![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 BDFL][🚂bdfl-contact-img]][🚂bdfl-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
156
+ | `...` 💖 | [![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] |
157
+
158
+ ## 🚀 Release Documentation
27
159
 
28
160
  ### Version 2.0.x
29
161
 
30
162
  <details>
31
- <summary>2.0.x Readmes</summary>
32
-
33
- | Version | Release Date | Readme |
34
- |---------|--------------|----------------------------------------------------------|
35
- | 2.0.9 | 2022-09-16 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.9/README.md |
36
- | 2.0.8 | 2022-09-01 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.8/README.md |
37
- | 2.0.7 | 2022-08-22 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.7/README.md |
38
- | 2.0.6 | 2022-07-13 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.6/README.md |
39
- | 2.0.5 | 2022-07-07 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.5/README.md |
40
- | 2.0.4 | 2022-07-01 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.4/README.md |
41
- | 2.0.3 | 2022-06-28 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.3/README.md |
42
- | 2.0.2 | 2022-06-24 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.2/README.md |
43
- | 2.0.1 | 2022-06-22 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.1/README.md |
44
- | 2.0.0 | 2022-06-21 | https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.0/README.md |
163
+ <summary>2.0.x CHANGELOGs and READMEs</summary>
164
+
165
+ | Version | Release Date | CHANGELOG | README |
166
+ |---------|--------------|---------------------------------------|---------------------------------|
167
+ | 2.0.11 | 2025-05-23 | [v2.0.11 CHANGELOG][2.0.11-changelog] | [v2.0.10 README][2.0.11-readme] |
168
+ | 2.0.10 | 2025-05-17 | [v2.0.10 CHANGELOG][2.0.10-changelog] | [v2.0.10 README][2.0.10-readme] |
169
+ | 2.0.9 | 2022-09-16 | [v2.0.9 CHANGELOG][2.0.9-changelog] | [v2.0.9 README][2.0.9-readme] |
170
+ | 2.0.8 | 2022-09-01 | [v2.0.8 CHANGELOG][2.0.8-changelog] | [v2.0.8 README][2.0.8-readme] |
171
+ | 2.0.7 | 2022-08-22 | [v2.0.7 CHANGELOG][2.0.7-changelog] | [v2.0.7 README][2.0.7-readme] |
172
+ | 2.0.6 | 2022-07-13 | [v2.0.6 CHANGELOG][2.0.6-changelog] | [v2.0.6 README][2.0.6-readme] |
173
+ | 2.0.5 | 2022-07-07 | [v2.0.5 CHANGELOG][2.0.5-changelog] | [v2.0.5 README][2.0.5-readme] |
174
+ | 2.0.4 | 2022-07-01 | [v2.0.4 CHANGELOG][2.0.4-changelog] | [v2.0.4 README][2.0.4-readme] |
175
+ | 2.0.3 | 2022-06-28 | [v2.0.3 CHANGELOG][2.0.3-changelog] | [v2.0.3 README][2.0.3-readme] |
176
+ | 2.0.2 | 2022-06-24 | [v2.0.2 CHANGELOG][2.0.2-changelog] | [v2.0.2 README][2.0.2-readme] |
177
+ | 2.0.1 | 2022-06-22 | [v2.0.1 CHANGELOG][2.0.1-changelog] | [v2.0.1 README][2.0.1-readme] |
178
+ | 2.0.0 | 2022-06-21 | [v2.0.0 CHANGELOG][2.0.0-changelog] | [v2.0.0 README][2.0.0-readme] |
45
179
  </details>
46
180
 
181
+ [2.0.11-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#2011---2025-05-23
182
+ [2.0.10-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#2010---2025-05-17
183
+ [2.0.9-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#209---2022-09-16
184
+ [2.0.8-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#208---2022-09-01
185
+ [2.0.7-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#207---2022-08-22
186
+ [2.0.6-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#206---2022-07-13
187
+ [2.0.5-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#205---2022-07-07
188
+ [2.0.4-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#204---2022-07-01
189
+ [2.0.3-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#203---2022-06-28
190
+ [2.0.2-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#202---2022-06-24
191
+ [2.0.1-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#201---2022-06-22
192
+ [2.0.0-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#200---2022-06-21
193
+
194
+ [2.0.10-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.11/README.md
195
+ [2.0.10-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.10/README.md
196
+ [2.0.9-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.9/README.md
197
+ [2.0.8-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.8/README.md
198
+ [2.0.7-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.7/README.md
199
+ [2.0.6-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.6/README.md
200
+ [2.0.5-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.5/README.md
201
+ [2.0.4-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.4/README.md
202
+ [2.0.3-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.3/README.md
203
+ [2.0.2-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.2/README.md
204
+ [2.0.1-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.1/README.md
205
+ [2.0.0-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.0/README.md
206
+
47
207
  ### Older Releases
48
208
 
49
209
  <details>
50
- <summary>1.4.x Readmes</summary>
51
-
52
- | Version | Release Date | Readme |
53
- |---------|--------------|-------------------------------------------------------------|
54
- | 1.4.11 | Sep 16, 2022 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.11/README.md |
55
- | 1.4.10 | Jul 1, 2022 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.10/README.md |
56
- | 1.4.9 | Feb 20, 2022 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.9/README.md |
57
- | 1.4.8 | Feb 18, 2022 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.8/README.md |
58
- | 1.4.7 | Mar 19, 2021 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.7/README.md |
59
- | 1.4.6 | Mar 19, 2021 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.6/README.md |
60
- | 1.4.5 | Mar 18, 2021 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.5/README.md |
61
- | 1.4.4 | Feb 12, 2020 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.4/README.md |
62
- | 1.4.3 | Jan 29, 2020 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.3/README.md |
63
- | 1.4.2 | Oct 1, 2019 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.2/README.md |
64
- | 1.4.1 | Oct 13, 2018 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.1/README.md |
65
- | 1.4.0 | Jun 9, 2017 | https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.0/README.md |
210
+ <summary>1.4.x CHANGELOGs and READMEs</summary>
211
+
212
+ | Version | Release Date | CHANGELOG | README |
213
+ |---------|--------------|---------------------------------------|---------------------------------|
214
+ | 1.4.11 | Sep 16, 2022 | [v1.4.11 CHANGELOG][1.4.11-changelog] | [v1.4.11 README][1.4.11-readme] |
215
+ | 1.4.10 | Jul 1, 2022 | [v1.4.10 CHANGELOG][1.4.10-changelog] | [v1.4.10 README][1.4.10-readme] |
216
+ | 1.4.9 | Feb 20, 2022 | [v1.4.9 CHANGELOG][1.4.9-changelog] | [v1.4.9 README][1.4.9-readme] |
217
+ | 1.4.8 | Feb 18, 2022 | [v1.4.8 CHANGELOG][1.4.8-changelog] | [v1.4.8 README][1.4.8-readme] |
218
+ | 1.4.7 | Mar 19, 2021 | [v1.4.7 CHANGELOG][1.4.7-changelog] | [v1.4.7 README][1.4.7-readme] |
219
+ | 1.4.6 | Mar 19, 2021 | [v1.4.6 CHANGELOG][1.4.6-changelog] | [v1.4.6 README][1.4.6-readme] |
220
+ | 1.4.5 | Mar 18, 2021 | [v1.4.5 CHANGELOG][1.4.5-changelog] | [v1.4.5 README][1.4.5-readme] |
221
+ | 1.4.4 | Feb 12, 2020 | [v1.4.4 CHANGELOG][1.4.4-changelog] | [v1.4.4 README][1.4.4-readme] |
222
+ | 1.4.3 | Jan 29, 2020 | [v1.4.3 CHANGELOG][1.4.3-changelog] | [v1.4.3 README][1.4.3-readme] |
223
+ | 1.4.2 | Oct 1, 2019 | [v1.4.2 CHANGELOG][1.4.2-changelog] | [v1.4.2 README][1.4.2-readme] |
224
+ | 1.4.1 | Oct 13, 2018 | [v1.4.1 CHANGELOG][1.4.1-changelog] | [v1.4.1 README][1.4.1-readme] |
225
+ | 1.4.0 | Jun 9, 2017 | [v1.4.0 CHANGELOG][1.4.0-changelog] | [v1.4.0 README][1.4.0-readme] |
66
226
  </details>
67
227
 
228
+ [1.4.11-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#1411---2022-09-16
229
+ [1.4.10-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#1410---2022-07-01
230
+ [1.4.9-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#149---2022-02-20
231
+ [1.4.8-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#148---2022-02-18
232
+ [1.4.7-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#147---2021-03-19
233
+ [1.4.6-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#146---2021-03-19
234
+ [1.4.5-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#145---2021-03-18
235
+ [1.4.4-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#144---2020-02-12
236
+ [1.4.3-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#143---2020-01-29
237
+ [1.4.2-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#142---2019-10-01
238
+ [1.4.1-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#141---2018-10-13
239
+ [1.4.0-changelog]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md?ref_type=heads#140---2017-06-09
240
+
241
+ [1.4.11-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.11/README.md
242
+ [1.4.10-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.10/README.md
243
+ [1.4.9-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.9/README.md
244
+ [1.4.8-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.8/README.md
245
+ [1.4.7-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.7/README.md
246
+ [1.4.6-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.6/README.md
247
+ [1.4.5-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.5/README.md
248
+ [1.4.4-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.4/README.md
249
+ [1.4.3-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.3/README.md
250
+ [1.4.2-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.2/README.md
251
+ [1.4.1-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.1/README.md
252
+ [1.4.0-readme]: https://gitlab.com/oauth-xx/oauth2/-/blob/v1.4.0/README.md
253
+
68
254
  <details>
69
255
  <summary>1.3.x Readmes</summary>
70
256
 
@@ -85,135 +271,7 @@ See the sibling `oauth` gem for OAuth 1.0 implementations in Ruby.
85
271
  | < 1.0.0 | Find here | https://gitlab.com/oauth-xx/oauth2/-/tags |
86
272
  </details>
87
273
 
88
- ## Status
89
-
90
- <!--
91
- Numbering rows and badges in each row as a visual "database" lookup,
92
- as the table is extremely dense, and it can be very difficult to find anything
93
- Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
94
-
95
- row #s:
96
- 1️⃣
97
- 2️⃣
98
- 3️⃣
99
- 4️⃣
100
- 5️⃣
101
- 6️⃣
102
- 7️⃣
103
-
104
- badge #s:
105
- ⛳️
106
- 🖇
107
- 🏘
108
- 🚎
109
- 🖐
110
- 🧮
111
- 📗
112
-
113
- appended indicators:
114
- ♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
115
- -->
116
-
117
- | | Project | bundle add oauth2 |
118
- |:----|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
119
- | 1️⃣ | name, license, docs | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] [![FOSSA][🏘fossa-img]][🏘fossa] [![RubyDoc.info][🚎yard-img]][🚎yard] [![InchCI][🖐inch-ci-img]][🚎yard] |
120
- | 2️⃣ | version & activity | [![Gem Version][⛳️version-img]][⛳️gem] [![Total Downloads][🖇DL-total-img]][⛳️gem] [![Download Rank][🏘DL-rank-img]][⛳️gem] [![Source Code][🚎src-home-img]][🚎src-home] |
121
- | 3️⃣ | maintanence & linting | [![Maintainability][⛳cclim-maint-img♻️]][⛳cclim-maint] [![Helpers][🖇triage-help-img]][🖇triage-help] [![Depfu][🏘depfu-img♻️]][🏘depfu♻️] [![Contributors][🚎contributors-img]][🚎contributors] [![Style][🖐style-wf-img]][🖐style-wf] [![Kloc Roll][🧮kloc-img]][🧮kloc] |
122
- | 4️⃣ | testing | [![Supported][🏘sup-wf-img]][🏘sup-wf] [![Heads][🚎heads-wf-img]][🚎heads-wf] [![Unofficial Support][🖐uns-wf-img]][🖐uns-wf] [![MacOS][🧮mac-wf-img]][🧮mac-wf] [![Windows][📗win-wf-img]][📗win-wf] |
123
- | 5️⃣ | coverage & security | [![CodeClimate][⛳cclim-cov-img♻️]][⛳cclim-cov] [![CodeCov][🖇codecov-img♻️]][🖇codecov] [![Coveralls][🏘coveralls-img]][🏘coveralls] [![Security Policy][🚎sec-pol-img]][🚎sec-pol] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Code Coverage][🧮cov-wf-img]][🧮cov-wf] |
124
- | 6️⃣ | resources | [![Discussion][⛳gg-discussions-img]][⛳gg-discussions] [![Get help on Codementor][🖇codementor-img]][🖇codementor] [![Chat][🏘chat-img]][🏘chat] [![Blog][🚎blog-img]][🚎blog] [![Blog][🖐wiki-img]][🖐wiki] |
125
- | 7️⃣ | spread 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Tweet @ Peter][🏘tweet-img]][🏘tweet] [🌏][aboutme] [👼][angelme] [💻][coderme] |
126
-
127
- <!--
128
- The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
129
- -->
130
-
131
- <!-- 1️⃣ name, license, docs -->
132
- [⛳️gem]: https://rubygems.org/gems/oauth2
133
- [⛳️name-img]: https://img.shields.io/badge/name-oauth2-brightgreen.svg?style=flat
134
- [🖇src-license]: https://opensource.org/licenses/MIT
135
- [🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
136
- [🏘fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2?ref=badge_shield
137
- [🏘fossa-img]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2.svg?type=shield
138
- [🚎yard]: https://www.rubydoc.info/github/oauth-xx/oauth2
139
- [🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
140
- [🖐inch-ci-img]: http://inch-ci.org/github/oauth-xx/oauth2.png
141
-
142
- <!-- 2️⃣ version & activity -->
143
- [⛳️version-img]: http://img.shields.io/gem/v/oauth2.svg
144
- [🖇DL-total-img]: https://img.shields.io/gem/dt/oauth2.svg
145
- [🏘DL-rank-img]: https://img.shields.io/gem/rt/oauth2.svg
146
- [🚎src-home]: https://gitlab.com/oauth-xx/oauth2/
147
- [🚎src-home-img]: https://img.shields.io/badge/source-gitlab-blue.svg?style=flat
148
-
149
- <!-- 3️⃣ maintenance & linting -->
150
- [⛳cclim-maint]: https://codeclimate.com/github/oauth-xx/oauth2/maintainability
151
- [⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/688c612528ff90a46955/maintainability
152
- [🖇triage-help]: https://www.codetriage.com/oauth-xx/oauth2
153
- [🖇triage-help-img]: https://www.codetriage.com/oauth-xx/oauth2/badges/users.svg
154
- [🏘depfu♻️]: https://depfu.com/github/oauth-xx/oauth2?project_id=4445
155
- [🏘depfu-img♻️]: https://badges.depfu.com/badges/6d34dc1ba682bbdf9ae2a97848241743/count.svg
156
- [🚎contributors]: https://gitlab.com/oauth-xx/oauth2/-/graphs/main
157
- [🚎contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth2
158
- [🖐style-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/style.yml
159
- [🖐style-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/style.yml/badge.svg
160
- [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
161
- [🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/oauth-xx/oauth2
162
-
163
- <!-- 4️⃣ testing -->
164
- [🏘sup-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/supported.yml
165
- [🏘sup-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/supported.yml/badge.svg
166
- [🚎heads-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/heads.yml
167
- [🚎heads-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/heads.yml/badge.svg
168
- [🖐uns-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/unsupported.yml
169
- [🖐uns-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/unsupported.yml/badge.svg
170
- [🧮mac-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/macos.yml
171
- [🧮mac-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/macos.yml/badge.svg
172
- [📗win-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/windows.yml
173
- [📗win-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/windows.yml/badge.svg
174
-
175
- <!-- 5️⃣ coverage & security -->
176
- [⛳cclim-cov]: https://codeclimate.com/github/oauth-xx/oauth2/test_coverage
177
- [⛳cclim-cov-img♻️]: https://api.codeclimate.com/v1/badges/688c612528ff90a46955/test_coverage
178
- [🖇codecov-img♻️]: https://codecov.io/gh/oauth-xx/oauth2/branch/main/graph/badge.svg?token=bNqSzNiuo2
179
- [🖇codecov]: https://codecov.io/gh/oauth-xx/oauth2
180
- [🏘coveralls]: https://coveralls.io/github/oauth-xx/oauth2?branch=main
181
- [🏘coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth2/badge.svg?branch=main
182
- [🚎sec-pol]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/SECURITY.md
183
- [🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
184
- [🖐codeQL]: https://github.com/oauth-xx/oauth2/security/code-scanning
185
- [🖐codeQL-img]: https://github.com/oauth-xx/oauth2/actions/workflows/codeql-analysis.yml/badge.svg
186
- [🧮cov-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/coverage.yml
187
- [🧮cov-wf-img]: https://github.com/oauth-xx/oauth2/actions/workflows/coverage.yml/badge.svg
188
-
189
- <!-- 6️⃣ resources -->
190
- [⛳gg-discussions]: https://groups.google.com/g/oauth-ruby
191
- [⛳gg-discussions-img]: https://img.shields.io/badge/google-group-purple.svg?style=flat
192
- [🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
193
- [🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
194
- [🏘chat]: https://gitter.im/oauth-xx/oauth2
195
- [🏘chat-img]: https://img.shields.io/gitter/room/oauth-xx/oauth2.svg
196
- [🚎blog]: http://www.railsbling.com/tags/oauth2/
197
- [🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
198
- [🖐wiki]: https://gitlab.com/oauth-xx/oauth2/-/wikis/home
199
- [🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
200
-
201
- <!-- 7️⃣ spread 💖 -->
202
- [⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
203
- [⛳liberapay]: https://liberapay.com/pboling/donate
204
- [🖇sponsor-img]: https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github
205
- [🖇sponsor]: https://github.com/sponsors/pboling
206
- [🏘tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
207
- [🏘tweet]: http://twitter.com/galtzo
208
-
209
- <!-- Maintainer Contact Links -->
210
- [railsbling]: http://www.railsbling.com
211
- [peterboling]: http://www.peterboling.com
212
- [aboutme]: https://about.me/peter.boling
213
- [angelme]: https://angel.co/peter-boling
214
- [coderme]:http://coderwall.com/pboling
215
-
216
- ## Installation
274
+ ## ✨ Installation
217
275
 
218
276
  Install the gem and add to the application's Gemfile by executing:
219
277
 
@@ -223,11 +281,41 @@ If bundler is not being used to manage dependencies, install the gem by executin
223
281
 
224
282
  $ gem install oauth2
225
283
 
284
+ ### 🔒 Secure Installation
285
+
286
+ `oauth2` is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
287
+ [stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
288
+ by following the instructions below.
289
+
290
+ Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
291
+
292
+ ```shell
293
+ gem cert --add <(curl -Ls https://raw.github.com/oauth-xx/oauth2/main/certs/pboling.pem)
294
+ ```
295
+
296
+ You only need to do that once. Then proceed to install with:
297
+
298
+ ```shell
299
+ gem install oauth2 -P MediumSecurity
300
+ ```
301
+
302
+ The `MediumSecurity` trust profile will verify signed gems, but allow the installation of unsigned dependencies.
303
+
304
+ This is necessary because not all of `oauth2`’s dependencies are signed, so we cannot use `HighSecurity`.
305
+
306
+ If you want to up your security game full-time:
307
+
308
+ ```shell
309
+ bundle config set --global trust-policy MediumSecurity
310
+ ```
311
+
312
+ NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
313
+
226
314
  ## OAuth2 for Enterprise
227
315
 
228
316
  Available as part of the Tidelift Subscription.
229
317
 
230
- The maintainers of OAuth2 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]
318
+ 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]
231
319
 
232
320
  [tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth2?utm_source=rubygems-oauth2&utm_medium=referral&utm_campaign=enterprise
233
321
 
@@ -236,36 +324,38 @@ The maintainers of OAuth2 and thousands of other packages are working with Tidel
236
324
  To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
237
325
  Tidelift will coordinate the fix and disclosure.
238
326
 
239
- For more see [SECURITY.md][🚎sec-pol].
327
+ For more see [SECURITY.md][🔐security].
240
328
 
241
329
  ## What is new for v2.0?
242
330
 
243
- - Officially support Ruby versions >= 2.7
244
- - Unofficially support Ruby versions >= 2.5
245
- - Incidentally support Ruby versions >= 2.2
331
+ - Works with Ruby versions >= 2.2
246
332
  - Drop support for the expired MAC Draft (all versions)
247
333
  - Support IETF rfc7523 JWT Bearer Tokens
248
334
  - Support IETF rfc7231 Relative Location in Redirect
249
335
  - Support IETF rfc6749 Don't set oauth params when nil
336
+ - Support IETF rfc7009 Token Revocation (since v2.0.10)
250
337
  - 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)
251
338
  - 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`
252
- - Adds new option to `OAuth2::Client#get_token`:
339
+ - Adds option to `OAuth2::Client#get_token`:
253
340
  - `:access_token_class` (`AccessToken`); user specified class to use for all calls to `get_token`
254
- - Adds new option to `OAuth2::AccessToken#initialize`:
341
+ - Adds option to `OAuth2::AccessToken#initialize`:
255
342
  - `:expires_latency` (`nil`); number of seconds by which AccessToken validity will be reduced to offset latency
256
- - By default, keys are transformed to camel case.
257
- - Original keys will still work as previously, in most scenarios, thanks to `rash_alt` gem.
258
- - However, this is a _breaking_ change if you rely on `response.parsed.to_h`, as the keys in the result will be camel case.
343
+ - By default, keys are transformed to snake case.
344
+ - Original keys will still work as previously, in most scenarios, thanks to [snaky_hash][snaky_hash] gem.
345
+ - 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.
259
346
  - As of version 2.0.4 you can turn key transformation off with the `snaky: false` option.
260
347
  - By default, the `:auth_scheme` is now `:basic_auth` (instead of `:request_body`)
261
348
  - Third-party strategies and gems may need to be updated if a provider was requiring client id/secret in the request body
262
- - [... A lot more](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md#2.0.0)
349
+ - [... A lot more](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md#200-2022-06-21-tag)
350
+
351
+ [snaky_hash]: https://gitlab.com/oauth-xx/snaky_hash
263
352
 
264
353
  ## Compatibility
265
354
 
266
- Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.7, 3.0 and
267
- 3.1. Compatibility is further distinguished by supported and unsupported versions of Ruby.
268
- Ruby is limited to 2.2+ for 2.x releases. See `1-4-stable` branch for older rubies.
355
+ Targeted ruby compatibility is non-EOL versions of Ruby, currently 3.2, 3.3, and 3.4.
356
+ Compatibility is further distinguished as "Best Effort Support" or "Incidental Support" for older versions of Ruby.
357
+ This gem will install on Ruby versions >= v2.2 for 2.x releases.
358
+ See `1-4-stable` branch for older rubies.
269
359
 
270
360
  <details>
271
361
  <summary>Ruby Engine Compatibility Policy</summary>
@@ -274,7 +364,7 @@ This gem is tested against MRI, JRuby, and Truffleruby.
274
364
  Each of those has varying versions that target a specific version of MRI Ruby.
275
365
  This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
276
366
  If you would like to add support for additional engines,
277
- see `gemfiles/README.md`, then submit a PR to the correct maintenance branch as according to the table below.
367
+ see [gemfiles/README.md](gemfiles/README.md), then submit a PR to the correct maintenance branch as according to the table below.
278
368
  </details>
279
369
 
280
370
  <details>
@@ -294,41 +384,55 @@ fashion. If critical issues for a particular implementation exist at the time
294
384
  of a major release, support for that Ruby version may be dropped.
295
385
  </details>
296
386
 
297
- | | Ruby OAuth2 Version | Maintenance Branch | Supported Officially | Supported Unofficially | Supported Incidentally |
298
- |:----|---------------------|--------------------|-------------------------|------------------------|------------------------|
299
- | 1️⃣ | 2.0.x | `main` | 2.7, 3.0, 3.1 | 2.5, 2.6 | 2.2, 2.3, 2.4 |
300
- | 2️⃣ | 1.4.x | `1-4-stable` | 2.5, 2.6, 2.7, 3.0, 3.1 | 2.1, 2.2, 2.3, 2.4 | 1.9, 2.0 |
301
- | 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
387
+ | | Ruby OAuth2 Version | Maintenance Branch | Targeted Support | Best Effort Support | Incidental Support |
388
+ |:----|---------------------|--------------------|----------------------|-------------------------|------------------------------|
389
+ | 1️⃣ | 2.0.x | `main` | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 2.2, 2.3, 2.4 |
390
+ | 2️⃣ | 1.4.x | `1-4-stable` | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 1.9, 2.0, 2.1, 2.2, 2.3, 2.4 |
391
+ | 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
302
392
 
303
393
  NOTE: The 1.4 series will only receive critical security updates.
304
- See [SECURITY.md][🚎sec-pol]
394
+ See [SECURITY.md][🔐security].
305
395
 
306
- ## Usage Examples
396
+ ## 🔧 Basic Usage
307
397
 
308
398
  ### Global Configuration
309
399
 
310
- If you started seeing this warning, but everything it working fine, you can now silence it.
311
- ```log
312
- OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
313
- ```
400
+ You can turn on additional warnings.
314
401
 
315
402
  ```ruby
316
403
  OAuth2.configure do |config|
317
- config.silence_extra_tokens_warning = true # default: false
404
+ # Turn on a warning like:
405
+ # OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
406
+ config.silence_extra_tokens_warning = false # default: true
407
+ # Set to true if you want to also show warnings about no tokens
408
+ config.silence_no_tokens_warning = false # default: true,
318
409
  end
319
410
  ```
320
411
 
412
+ The "extra tokens" problem comes from ambiguity in the spec about which token is the right token.
413
+ Some OAuth 2.0 standards legitimately have multiple tokens.
414
+ You may need to subclass `OAuth2::AccessToken`, or write your own custom alternative to it, and pass it in.
415
+ Specify your custom class with the `access_token_class` option.
416
+
417
+ If you only need one token you can, as of v2.0.10,
418
+ specify the exact token name you want to extract via the `OAuth2::AccessToken` using
419
+ the `token_name` option.
420
+
421
+ You'll likely need to do some source diving.
422
+ This gem has 100% test coverage for lines and branches, so the specs are a great place to look for ideas.
423
+ If you have time and energy please contribute to the documentation!
424
+
321
425
  ### `authorize_url` and `token_url` are on site root (Just Works!)
322
426
 
323
427
  ```ruby
324
- require 'oauth2'
325
- client = OAuth2::Client.new('client_id', 'client_secret', site: 'https://example.org')
428
+ require "oauth2"
429
+ client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org")
326
430
  # => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
327
- client.auth_code.authorize_url(redirect_uri: 'http://localhost:8080/oauth2/callback')
431
+ client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
328
432
  # => "https://example.org/oauth/authorize?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
329
433
 
330
- access = client.auth_code.get_token('authorization_code_value', redirect_uri: 'http://localhost:8080/oauth2/callback', headers: {'Authorization' => 'Basic some_password'})
331
- response = access.get('/api/resource', params: {'query_foo' => 'bar'})
434
+ access = client.auth_code.get_token("authorization_code_value", redirect_uri: "http://localhost:8080/oauth2/callback", headers: {"Authorization" => "Basic some_password"})
435
+ response = access.get("/api/resource", params: {"query_foo" => "bar"})
332
436
  response.class.name
333
437
  # => OAuth2::Response
334
438
  ```
@@ -338,9 +442,9 @@ response.class.name
338
442
  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.
339
443
 
340
444
  ```ruby
341
- client = OAuth2::Client.new('client_id', 'client_secret', site: 'https://example.org/nested/directory/on/your/server')
445
+ client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org/nested/directory/on/your/server")
342
446
  # => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
343
- client.auth_code.authorize_url(redirect_uri: 'http://localhost:8080/oauth2/callback')
447
+ client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
344
448
  # => "https://example.org/nested/directory/on/your/server/oauth/authorize?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
345
449
  ```
346
450
 
@@ -349,12 +453,15 @@ client.auth_code.authorize_url(redirect_uri: 'http://localhost:8080/oauth2/callb
349
453
  You can specify custom URLs for authorization and access token, and when using a leading `/` they will _not be relative_, as shown below:
350
454
 
351
455
  ```ruby
352
- client = OAuth2::Client.new('client_id', 'client_secret',
353
- site: 'https://example.org/nested/directory/on/your/server',
354
- authorize_url: '/jaunty/authorize/',
355
- token_url: '/stirrups/access_token')
456
+ client = OAuth2::Client.new(
457
+ "client_id",
458
+ "client_secret",
459
+ site: "https://example.org/nested/directory/on/your/server",
460
+ authorize_url: "/jaunty/authorize/",
461
+ token_url: "/stirrups/access_token",
462
+ )
356
463
  # => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
357
- client.auth_code.authorize_url(redirect_uri: 'http://localhost:8080/oauth2/callback')
464
+ client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
358
465
  # => "https://example.org/jaunty/authorize/?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
359
466
  client.class.name
360
467
  # => OAuth2::Client
@@ -363,7 +470,7 @@ client.class.name
363
470
  ### snake_case and indifferent access in Response#parsed
364
471
 
365
472
  ```ruby
366
- response = access.get('/api/resource', params: {'query_foo' => 'bar'})
473
+ response = access.get("/api/resource", params: {"query_foo" => "bar"})
367
474
  # Even if the actual response is CamelCase. it will be made available as snaky:
368
475
  JSON.parse(response.body) # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
369
476
  response.parsed # => {"access_token"=>"aaaaaaaa", "additional_data"=>"additional"}
@@ -371,65 +478,80 @@ response.parsed.access_token # => "aaaaaaaa"
371
478
  response.parsed[:access_token] # => "aaaaaaaa"
372
479
  response.parsed.additional_data # => "additional"
373
480
  response.parsed[:additional_data] # => "additional"
374
- response.parsed.class.name # => OAuth2::SnakyHash (subclass of Hashie::Mash::Rash, from `rash_alt` gem)
481
+ response.parsed.class.name # => SnakyHash::StringKeyed (from snaky_hash gem)
375
482
  ```
376
483
 
484
+ #### Serialization
485
+
486
+ As of v2.0.11, if you need to serialize the parsed result, you can!
487
+
488
+ There are two ways to do this, and the second option recommended.
489
+
490
+ 1. Globally configure `SnakyHash::StringKeyed` to use the serializer. Put this in your code somewhere reasonable (like an initializer for Rails):
491
+
492
+ ```ruby
493
+ SnakyHash::StringKeyed.class_eval do
494
+ extend SnakyHash::Serializer
495
+ end
496
+ ```
497
+
498
+
377
499
  #### What if I hate snakes and/or indifference?
378
500
 
379
501
  ```ruby
380
- response = access.get('/api/resource', params: {'query_foo' => 'bar'}, snaky: false)
502
+ response = access.get("/api/resource", params: {"query_foo" => "bar"}, snaky: false)
381
503
  JSON.parse(response.body) # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
382
504
  response.parsed # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
383
- response.parsed['accessToken'] # => "aaaaaaaa"
384
- response.parsed['additionalData'] # => "additional"
505
+ response.parsed["accessToken"] # => "aaaaaaaa"
506
+ response.parsed["additionalData"] # => "additional"
385
507
  response.parsed.class.name # => Hash (just, regular old Hash)
386
508
  ```
387
509
 
388
510
  <details>
389
- <summary>Debugging</summary>
511
+ <summary>Debugging & Logging</summary>
390
512
 
391
- Set an environment variable, however you would [normally do that](https://github.com/bkeepers/dotenv).
513
+ Set an environment variable as per usual (e.g. with [dotenv](https://github.com/bkeepers/dotenv)).
392
514
 
393
515
  ```ruby
394
516
  # will log both request and response, including bodies
395
- ENV['OAUTH_DEBUG'] = 'true'
517
+ ENV["OAUTH_DEBUG"] = "true"
396
518
  ```
397
519
 
398
520
  By default, debug output will go to `$stdout`. This can be overridden when
399
521
  initializing your OAuth2::Client.
400
522
 
401
523
  ```ruby
402
- require 'oauth2'
524
+ require "oauth2"
403
525
  client = OAuth2::Client.new(
404
- 'client_id',
405
- 'client_secret',
406
- site: 'https://example.org',
407
- logger: Logger.new('example.log', 'weekly')
526
+ "client_id",
527
+ "client_secret",
528
+ site: "https://example.org",
529
+ logger: Logger.new("example.log", "weekly"),
408
530
  )
409
531
  ```
410
532
  </details>
411
533
 
412
- ## OAuth2::Response
534
+ ### OAuth2::Response
413
535
 
414
536
  The `AccessToken` methods `#get`, `#post`, `#put` and `#delete` and the generic `#request`
415
537
  will return an instance of the #OAuth2::Response class.
416
538
 
417
539
  This instance contains a `#parsed` method that will parse the response body and
418
- return a Hash-like [`OAuth2::SnakyHash`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/snaky_hash.rb) if the `Content-Type` is `application/x-www-form-urlencoded` or if
540
+ return a Hash-like [`SnakyHash::StringKeyed`](https://gitlab.com/oauth-xx/snaky_hash/-/blob/main/lib/snaky_hash/string_keyed.rb) if the `Content-Type` is `application/x-www-form-urlencoded` or if
419
541
  the body is a JSON object. It will return an Array if the body is a JSON
420
542
  array. Otherwise, it will return the original body string.
421
543
 
422
544
  The original response body, headers, and status can be accessed via their
423
545
  respective methods.
424
546
 
425
- ## OAuth2::AccessToken
547
+ ### OAuth2::AccessToken
426
548
 
427
549
  If you have an existing Access Token for a user, you can initialize an instance
428
550
  using various class methods including the standard new, `from_hash` (if you have
429
551
  a hash of the values), or `from_kvform` (if you have an
430
552
  `application/x-www-form-urlencoded` encoded string of the values).
431
553
 
432
- ## OAuth2::Error
554
+ ### OAuth2::Error
433
555
 
434
556
  On 400+ status code responses, an `OAuth2::Error` will be raised. If it is a
435
557
  standard OAuth2 error response, the body will be parsed and `#code` and `#description` will contain the values provided from the error and
@@ -441,9 +563,9 @@ option on initialization of the client. In this case the `OAuth2::Response`
441
563
  instance will be returned as usual and on 400+ status code responses, the
442
564
  Response instance will contain the `OAuth2::Error` instance.
443
565
 
444
- ## Authorization Grants
566
+ ### Authorization Grants
445
567
 
446
- Currently the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
568
+ Currently, the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
447
569
  authentication grant types have helper strategy classes that simplify client
448
570
  use. They are available via the [`#auth_code`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/strategy/auth_code.rb),
449
571
  [`#implicit`](https://gitlab.com/oauth-xx/oauth2/-/blob/main/lib/oauth2/strategy/implicit.rb),
@@ -453,96 +575,351 @@ use. They are available via the [`#auth_code`](https://gitlab.com/oauth-xx/oauth
453
575
 
454
576
  These aren't full examples, but demonstrative of the differences between usage for each strategy.
455
577
  ```ruby
456
- auth_url = client.auth_code.authorize_url(redirect_uri: 'http://localhost:8080/oauth/callback')
457
- access = client.auth_code.get_token('code_value', redirect_uri: 'http://localhost:8080/oauth/callback')
578
+ auth_url = client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth/callback")
579
+ access = client.auth_code.get_token("code_value", redirect_uri: "http://localhost:8080/oauth/callback")
458
580
 
459
- auth_url = client.implicit.authorize_url(redirect_uri: 'http://localhost:8080/oauth/callback')
581
+ auth_url = client.implicit.authorize_url(redirect_uri: "http://localhost:8080/oauth/callback")
460
582
  # get the token params in the callback and
461
583
  access = OAuth2::AccessToken.from_kvform(client, query_string)
462
584
 
463
- access = client.password.get_token('username', 'password')
585
+ access = client.password.get_token("username", "password")
464
586
 
465
587
  access = client.client_credentials.get_token
466
588
 
467
589
  # Client Assertion Strategy
468
590
  # see: https://tools.ietf.org/html/rfc7523
469
591
  claimset = {
470
- iss: 'http://localhost:3001',
471
- aud: 'http://localhost:8080/oauth2/token',
472
- sub: 'me@example.com',
592
+ iss: "http://localhost:3001",
593
+ aud: "http://localhost:8080/oauth2/token",
594
+ sub: "me@example.com",
473
595
  exp: Time.now.utc.to_i + 3600,
474
596
  }
475
- assertion_params = [claimset, 'HS256', 'secret_key']
597
+ assertion_params = [claimset, "HS256", "secret_key"]
476
598
  access = client.assertion.get_token(assertion_params)
477
599
 
478
600
  # The `access` (i.e. access token) is then used like so:
479
601
  access.token # actual access_token string, if you need it somewhere
480
- access.get('/api/stuff') # making api calls with access token
602
+ access.get("/api/stuff") # making api calls with access token
481
603
  ```
482
604
 
483
605
  If you want to specify additional headers to be sent out with the
484
606
  request, add a 'headers' hash under 'params':
485
607
 
486
608
  ```ruby
487
- access = client.auth_code.get_token('code_value', redirect_uri: 'http://localhost:8080/oauth/callback', headers: {'Some' => 'Header'})
609
+ access = client.auth_code.get_token("code_value", redirect_uri: "http://localhost:8080/oauth/callback", headers: {"Some" => "Header"})
488
610
  ```
489
611
 
490
612
  You can always use the `#request` method on the `OAuth2::Client` instance to make
491
613
  requests for tokens for any Authentication grant type.
492
614
 
493
- ## Versioning
615
+ ### 🚀 Release Instructions
616
+
617
+ See [CONTRIBUTING.md][🤝contributing].
618
+
619
+ ## 🔐 Security
620
+
621
+ See [SECURITY.md][🔐security].
622
+
623
+ ## 🤝 Contributing
624
+
625
+ If you need some ideas of where to help, you could work on adding more code coverage,
626
+ or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
627
+ or use the gem and think about how it could be better.
628
+
629
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
630
+
631
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
494
632
 
495
- This library aims to adhere to [Semantic Versioning 2.0.0][semver].
496
- Violations of this scheme should be reported as bugs. Specifically,
497
- if a minor or patch version is released that breaks backward
498
- compatibility, a new version should be immediately released that
499
- restores compatibility. Breaking changes to the public API will
500
- only be introduced with new major versions.
633
+ ### Code Coverage
501
634
 
502
- As a result of this policy, you can (and should) specify a
503
- dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
635
+ [![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls]
636
+ [![QLTY Test Coverage][🔑qlty-covi♻️]][🔑qlty-cov]
637
+
638
+ ### 🪇 Code of Conduct
639
+
640
+ Everyone interacting in this project's codebases, issue trackers,
641
+ chat rooms and mailing lists is expected to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
642
+
643
+ ## 🌈 Contributors
644
+
645
+ [![Contributors][🖐contributors-img]][🖐contributors]
646
+
647
+ Made with [contributors-img][🖐contrib-rocks].
648
+
649
+ Also see GitLab Contributors: [https://gitlab.com/oauth-xx/oauth2/-/graphs/main][🚎contributors-gl]
650
+
651
+ ## ⭐️ Star History
652
+
653
+ <a href="https://star-history.com/#oauth-xx/oauth2&Date">
654
+ <picture>
655
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=oauth-xx/oauth2&type=Date&theme=dark" />
656
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=oauth-xx/oauth2&type=Date" />
657
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=oauth-xx/oauth2&type=Date" />
658
+ </picture>
659
+ </a>
660
+
661
+ ## 📌 Versioning
662
+
663
+ This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
664
+ Violations of this scheme should be reported as bugs.
665
+ Specifically, if a minor or patch version is released that breaks backward compatibility,
666
+ a new version should be immediately released that restores compatibility.
667
+ Breaking changes to the public API will only be introduced with new major versions.
668
+
669
+ ### 📌 Is "Platform Support" part of the public API?
670
+
671
+ Yes. But I'm obligated to include notes...
672
+
673
+ SemVer should, but doesn't explicitly, say that dropping support for specific Platforms
674
+ is a *breaking change* to an API.
675
+ It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
676
+
677
+ > dropping support for a platform is both obviously and objectively a breaking change
678
+
679
+ - Jordan Harband (@ljharb, maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
680
+
681
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
682
+ read this article from the creator of SemVer:
683
+
684
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
685
+
686
+ As a result of this policy, and the interpretive lens used by the maintainer,
687
+ you can (and should) specify a dependency on these libraries using
688
+ the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
504
689
 
505
690
  For example:
506
691
 
507
692
  ```ruby
508
- spec.add_dependency 'oauth2', '~> 2.0'
693
+ spec.add_dependency("oauth2", "~> 2.0")
509
694
  ```
510
695
 
511
- [semver]: http://semver.org/
512
- [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
696
+ See [CHANGELOG.md][📌changelog] for list of releases.
513
697
 
514
- ## License
698
+ ## 📄 License
515
699
 
516
- [![License: MIT][🖇src-license-img]][🖇src-license]
700
+ The gem is available as open source under the terms of
701
+ the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
702
+ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
517
703
 
518
- - Copyright (c) 2011-2013 Michael Bleigh and Intridea, Inc.
519
- - Copyright (c) 2017-2022 [oauth-xx organization][oauth-xx]
520
- - See [LICENSE][license] for details.
704
+ ### © Copyright
521
705
 
522
- [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2.svg?type=large)][fossa2]
706
+ <ul>
707
+ <li>
708
+ 2017 - 2025 Peter H. Boling, of
709
+ <a href="https://railsbling.com">
710
+ RailsBling.com
711
+ <picture>
712
+ <img alt="Rails Bling" height="20" src="https://railsbling.com/images/logos/RailsBling-TrainLogo.svg" />
713
+ </picture>
714
+ </a>, and oauth2 contributors
715
+ </li>
716
+ <li>
717
+ Copyright (c) 2011 - 2013 Michael Bleigh and Intridea, Inc.
718
+ </li>
719
+ </ul>
523
720
 
524
- [license]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/LICENSE
525
- [oauth-xx]: https://gitlab.com/oauth-xx
526
- [fossa2]: https://app.fossa.io/projects/git%2Bgithub.com%2Foauth-xx%2Foauth2?ref=badge_large
721
+ ## 🤑 One more thing
527
722
 
528
- ## Development
723
+ You made it to the bottom of the page,
724
+ so perhaps you'll indulge me for another 20 seconds.
725
+ I maintain many dozens of gems, including this one,
726
+ because I want Ruby to be a great place for people to solve problems, big and small.
727
+ Please consider supporting my efforts via the giant yellow link below,
728
+ or one of the others at the head of this README.
529
729
 
530
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
730
+ [![Buy me a latte][🖇buyme-img]][🖇buyme]
531
731
 
532
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
533
-
534
- ## Contributing
732
+ [⛳gg-discussions]: https://groups.google.com/g/oauth-ruby
733
+ [⛳gg-discussions-img]: https://img.shields.io/badge/google-group-0093D0.svg?style=for-the-badge&logo=google&logoColor=orange
734
+
735
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
736
+ [⛳️gem-namespace]: https://github.com/oauth-xx/oauth2
737
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-OAuth2-brightgreen.svg?style=flat&logo=ruby&logoColor=white
738
+ [⛳️gem-name]: https://rubygems.org/gems/oauth2
739
+ [⛳️name-img]: https://img.shields.io/badge/name-oauth2-brightgreen.svg?style=flat&logo=rubygems&logoColor=red
740
+ [🚂bdfl-blog]: http://www.railsbling.com/tags/oauth2
741
+ [🚂bdfl-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
742
+ [🚂bdfl-contact]: http://www.railsbling.com/contact
743
+ [🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
744
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
745
+ [💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
746
+ [💖✌️wellfound]: https://angel.co/u/peter-boling
747
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
748
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
749
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
750
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
751
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=flat&logo=mastodon&label=Ruby%20%40galtzo
752
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
753
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
754
+ [💖🌳linktree]: https://linktr.ee/galtzo
755
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
756
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
757
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
758
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
759
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
760
+ [💖🧊berg]: https://codeberg.org/pboling
761
+ [💖🐙hub]: https://github.org/pboling
762
+ [💖🛖hut]: https://sr.ht/~galtzo/
763
+ [💖🧪lab]: https://gitlab.com/pboling
764
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
765
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
766
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
767
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
768
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription
769
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
770
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
771
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
772
+ [🚂railsbling]: http://www.railsbling.com
773
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
774
+ [📜src-gl]: https://gitlab.com/oauth-xx/oauth2/
775
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
776
+ [📜src-cb]: https://codeberg.org/oauth-xx/oauth2
777
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
778
+ [📜src-gh]: https://github.com/oauth-xx/oauth2
779
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
780
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
781
+ [📜wiki]: https://gitlab.com/oauth-xx/oauth2/-/wikis/home
782
+ [📜wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=Wiki&logoColor=white
783
+ [👽dl-rank]: https://rubygems.org/gems/oauth2
784
+ [👽dl-ranki]: https://img.shields.io/gem/rd/oauth2.svg
785
+ [👽oss-help]: https://www.codetriage.com/oauth-xx/oauth2
786
+ [👽oss-helpi]: https://www.codetriage.com/oauth-xx/oauth2/badges/users.svg
787
+ [👽version]: https://rubygems.org/gems/oauth2
788
+ [👽versioni]: https://img.shields.io/gem/v/oauth2.svg
789
+ [🔑qlty-mnt]: https://qlty.sh/gh/oauth-xx/projects/oauth2
790
+ [🔑qlty-mnti♻️]: https://qlty.sh/badges/d3370c2c-8791-4202-9759-76f527f76005/maintainability.svg
791
+ [🔑qlty-cov]: https://qlty.sh/gh/oauth-xx/projects/oauth2
792
+ [🔑qlty-covi♻️]: https://qlty.sh/badges/d3370c2c-8791-4202-9759-76f527f76005/test_coverage.svg
793
+ [🔑codecov]: https://codecov.io/gh/oauth-xx/oauth2
794
+ [🔑codecovi♻️]: https://codecov.io/gh/oauth-xx/oauth2/graph/badge.svg?token=bNqSzNiuo2
795
+ [🔑coveralls]: https://coveralls.io/github/oauth-xx/oauth2?branch=main
796
+ [🔑coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth2/badge.svg?branch=main
797
+ [🔑depfu]: https://depfu.com/github/oauth-xx/oauth2?project_id=5884
798
+ [🔑depfui♻️]: https://badges.depfu.com/badges/6d34dc1ba682bbdf9ae2a97848241743/count.svg
799
+ [🖐codeQL]: https://github.com/oauth-xx/oauth2/security/code-scanning
800
+ [🖐codeQL-img]: https://github.com/oauth-xx/oauth2/actions/workflows/codeql-analysis.yml/badge.svg
801
+ [🚎1-an-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/ancient.yml
802
+ [🚎1-an-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/ancient.yml/badge.svg
803
+ [🚎2-cov-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/coverage.yml
804
+ [🚎2-cov-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/coverage.yml/badge.svg
805
+ [🚎3-hd-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/heads.yml
806
+ [🚎3-hd-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/heads.yml/badge.svg
807
+ [🚎4-lg-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/legacy.yml
808
+ [🚎4-lg-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/legacy.yml/badge.svg
809
+ [🚎5-st-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/style.yml
810
+ [🚎5-st-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/style.yml/badge.svg
811
+ [🚎6-s-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/supported.yml
812
+ [🚎6-s-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/supported.yml/badge.svg
813
+ [🚎7-us-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/unsupported.yml
814
+ [🚎7-us-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/unsupported.yml/badge.svg
815
+ [🚎8-ho-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/hoary.yml
816
+ [🚎8-ho-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/hoary.yml/badge.svg
817
+ [🚎9-t-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/truffle.yml
818
+ [🚎9-t-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/truffle.yml/badge.svg
819
+ [🚎10-j-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/jruby.yml
820
+ [🚎10-j-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/jruby.yml/badge.svg
821
+ [🚎11-c-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/current.yml
822
+ [🚎11-c-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/current.yml/badge.svg
823
+ [🚎12-crh-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/current-runtime-heads.yml
824
+ [🚎12-crh-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/current-runtime-heads.yml/badge.svg
825
+ [🚎13-cbs-wf]: https://github.com/oauth-xx/oauth2/actions/workflows/caboose.yml
826
+ [🚎13-cbs-wfi]: https://github.com/oauth-xx/oauth2/actions/workflows/caboose.yml/badge.svg
827
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay
828
+ [⛳liberapay]: https://liberapay.com/pboling/donate
829
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
830
+ [🖇sponsor]: https://github.com/sponsors/pboling
831
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-yellow.svg
832
+ [🖇polar]: https://polar.sh/pboling
833
+ [🖇kofi-img]: https://img.shields.io/badge/a_more_different_coffee-✓-yellow.svg
834
+ [🖇kofi]: https://ko-fi.com/O5O86SNP4
835
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
836
+ [🖇patreon]: https://patreon.com/galtzo
837
+ [🖇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
838
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
839
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-yellow.svg?style=flat
840
+ [💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
841
+ [💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
842
+ [💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
843
+ [💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
844
+ [💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
845
+ [💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
846
+ [💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
847
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
848
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
849
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
850
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
851
+ [💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
852
+ [💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
853
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
854
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
855
+ [💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
856
+ [💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1-FBE742?style=for-the-badge&logo=ruby&logoColor=red
857
+ [💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2-FBE742?style=for-the-badge&logo=ruby&logoColor=red
858
+ [💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3-FBE742?style=for-the-badge&logo=ruby&logoColor=red
859
+ [💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
860
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
861
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
862
+ [🤝gh-issues]: https://github.com/oauth-xx/oauth2/issues
863
+ [🤝gh-pulls]: https://github.com/oauth-xx/oauth2/pulls
864
+ [🤝gl-issues]: https://gitlab.com/oauth-xx/oauth2/-/issues
865
+ [🤝gl-pulls]: https://gitlab.com/oauth-xx/oauth2/-/merge_requests
866
+ [🤝cb-issues]: https://codeberg.org/oauth-xx/oauth2/issues
867
+ [🤝cb-pulls]: https://codeberg.org/oauth-xx/oauth2/pulls
868
+ [🤝cb-donate]: https://donate.codeberg.org/
869
+ [🤝contributing]: CONTRIBUTING.md
870
+ [🔑codecov-g♻️]: https://codecov.io/gh/oauth-xx/oauth2/graphs/tree.svg?token=bNqSzNiuo2
871
+ [🖐contrib-rocks]: https://contrib.rocks
872
+ [🖐contributors]: https://github.com/oauth-xx/oauth2/graphs/contributors
873
+ [🖐contributors-img]: https://contrib.rocks/image?repo=oauth-xx/oauth2
874
+ [🚎contributors-gl]: https://gitlab.com/oauth-xx/oauth2/-/graphs/main
875
+ [🪇conduct]: CODE_OF_CONDUCT.md
876
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
877
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
878
+ [📌semver]: https://semver.org/spec/v2.0.0.html
879
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
880
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
881
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
882
+ [📌changelog]: CHANGELOG.md
883
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
884
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
885
+ [📌gitmoji]:https://gitmoji.dev
886
+ [📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20😜%20😍-34495e.svg?style=flat-square
887
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
888
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-0.518-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
889
+ [🔐security]: SECURITY.md
890
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
891
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
892
+ [📄license]: LICENSE.txt
893
+ [📄license-ref]: https://opensource.org/licenses/MIT
894
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
895
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
896
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
897
+ [🚎yard-current]: http://rubydoc.info/gems/oauth2
898
+ [🚎yard-head]: https://oauth2.galtzo.com
899
+ [💎stone_checksums]: https://github.com/pboling/stone_checksums
900
+ [💎SHA_checksums]: https://gitlab.com/oauth-xx/oauth2/-/tree/main/checksums
901
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
902
+ [💎rlts-img]: https://img.shields.io/badge/code_style_%26_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
903
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
904
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
905
+ [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
535
906
 
536
- See [CONTRIBUTING.md][contributing]
907
+ <details>
908
+ <summary>
909
+ rel="me" Social Proofs
910
+ </summary>
537
911
 
538
- [contributing]: https://gitlab.com/oauth-xx/oauth2/-/blob/main/CONTRIBUTING.md
912
+ <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%3A%2F%2Fruby.social&style=social&label=Follow%20%40galtzo%20on%20Ruby.social"></a>
913
+ <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%3A%2F%2Ffloss.social&style=social&label=Follow%20%40galtzo%20on%20Floss.social"></a>
914
+ </details>
539
915
 
540
- ## Contributors
916
+ <details>
917
+ <summary>Deprecated Badges</summary>
541
918
 
542
- [![Contributors](https://contrib.rocks/image?repo=oauth-xx/oauth2)]("https://gitlab.com/oauth-xx/oauth2/-/graphs/main")
919
+ CodeCov currently fails to parse the coverage upload.
543
920
 
544
- Made with [contributors-img](https://contrib.rocks).
921
+ [![CodeCov Test Coverage][🔑codecovi♻️]][🔑codecov]
545
922
 
546
- ## Code of Conduct
923
+ [![Coverage Graph][🔑codecov-g♻️]][🔑codecov]
547
924
 
548
- Everyone interacting in the OAuth2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CODE_OF_CONDUCT.md).
925
+ </details>