oauth2 2.0.8 → 2.0.10

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