oauth 1.1.0 → 1.1.6

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 (50) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +1 -0
  3. data/CHANGELOG.md +637 -269
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +79 -29
  6. data/CONTRIBUTING.md +256 -24
  7. data/FUNDING.md +74 -0
  8. data/LICENSE.md +71 -0
  9. data/README.md +615 -287
  10. data/RUBOCOP.md +71 -0
  11. data/SECURITY.md +11 -16
  12. data/certs/pboling.pem +27 -0
  13. data/lib/oauth/auth_sanitizer.rb +36 -0
  14. data/lib/oauth/client/action_controller_request.rb +22 -13
  15. data/lib/oauth/client/em_http.rb +106 -99
  16. data/lib/oauth/client/helper.rb +15 -11
  17. data/lib/oauth/client/net_http.rb +39 -13
  18. data/lib/oauth/consumer.rb +194 -75
  19. data/lib/oauth/errors/problem.rb +1 -1
  20. data/lib/oauth/helper.rb +25 -3
  21. data/lib/oauth/oauth.rb +28 -6
  22. data/lib/oauth/optional.rb +20 -0
  23. data/lib/oauth/request_proxy/action_controller_request.rb +11 -7
  24. data/lib/oauth/request_proxy/action_dispatch_request.rb +34 -0
  25. data/lib/oauth/request_proxy/base.rb +38 -27
  26. data/lib/oauth/request_proxy/em_http_request.rb +53 -52
  27. data/lib/oauth/request_proxy/jabber_request.rb +9 -2
  28. data/lib/oauth/request_proxy/net_http.rb +1 -1
  29. data/lib/oauth/request_proxy/rack_request.rb +0 -4
  30. data/lib/oauth/request_proxy/rest_client_request.rb +4 -3
  31. data/lib/oauth/request_proxy.rb +17 -13
  32. data/lib/oauth/server.rb +12 -8
  33. data/lib/oauth/signature/base.rb +15 -5
  34. data/lib/oauth/signature/rsa/sha1.rb +11 -4
  35. data/lib/oauth/signature.rb +43 -39
  36. data/lib/oauth/tokens/access_token.rb +1 -1
  37. data/lib/oauth/tokens/consumer_token.rb +8 -6
  38. data/lib/oauth/tokens/request_token.rb +9 -4
  39. data/lib/oauth/tokens/token.rb +13 -1
  40. data/lib/oauth/version.rb +2 -1
  41. data/lib/oauth.rb +2 -0
  42. data/sig/oauth/consumer.rbs +9 -0
  43. data/sig/oauth/signature/base.rbs +12 -0
  44. data/sig/oauth/tokens/token.rbs +8 -0
  45. data/sig/oauth/version.rbs +6 -0
  46. data.tar.gz.sig +0 -0
  47. metadata +316 -79
  48. metadata.gz.sig +0 -0
  49. data/LICENSE +0 -22
  50. data/TODO +0 -32
data/README.md CHANGED
@@ -1,248 +1,172 @@
1
- <p align="center">
2
- <a href="http://oauth.net/core/1.0/" target="_blank" rel="noopener">
3
- <img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/main/docs/images/logo/Oauth_logo.svg?raw=true" alt="OAuth 1.0 Logo by Chris Messina, CC BY-SA 3.0, via Wikimedia Commons">
4
- </a>
5
- <a href="https://www.ruby-lang.org/" target="_blank" rel="noopener">
6
- <img width="124px" src="https://github.com/oauth-xx/oauth-ruby/raw/main/docs/images/logo/ruby-logo-198px.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5">
7
- </a>
8
- </p>
1
+ <a href="https://github.com/ruby-oauth"><img alt="ruby-oauth Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/ruby-oauth/avatar-128px.svg" width="14%" align="right"/></a>
9
2
 
10
- # Ruby OAuth
3
+ # 🔑 OAuth
11
4
 
12
- OAuth 1.0 is an industry-standard protocol for authorization.
5
+ [![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
13
6
 
14
- This is a RubyGem for implementing both OAuth 1.0 clients and servers in Ruby applications.
15
- See the sibling `oauth2` gem for OAuth 2.0 implementations in Ruby.
7
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the [discord notification][✉️discord-invite].
16
8
 
17
- * [OAuth 1.0 Spec][oauth1-spec]
18
- * [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
9
+ ---
19
10
 
20
- [oauth1-spec]: http://oauth.net/core/1.0/
21
- [sibling-gem]: https://github.com/oauth-xx/oauth-ruby
22
-
23
- **New EOL Policy**
24
-
25
- Versions 1.x will be EOL no later than April, 2025.
26
- Versions 0.6.x will be EOL no later than April, 2024.
27
- Versions 0.5.x will be EOL no later than April, 2023.
28
-
29
- This will facilitate dropping support for old, dead, and crusty versions of Ruby.
30
-
31
- Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April.
32
-
33
- Please upgrade to version 1.1. The only breaking change in 1.x is dropping old Rubies.
34
-
35
- ## Status
36
-
37
- <!--
38
- Numbering rows and badges in each row as a visual "database" lookup,
39
- as the table is extremely dense, and it can be very difficult to find anything
40
- Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
41
-
42
- row #s:
43
- 1️⃣
44
- 2️⃣
45
- 3️⃣
46
- 4️⃣
47
- 5️⃣
48
- 6️⃣
49
- 7️⃣
50
-
51
- badge #s:
52
- ⛳️
53
- 🖇
54
- 🏘
55
- 🚎
56
- 🖐
57
- 🧮
58
- 📗
59
-
60
- appended indicators:
61
- ♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
62
- -->
63
-
64
- | | Project | bundle add oauth |
65
- |:----|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
66
- | 1️⃣ | name, license, docs | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] [![RubyDoc.info][🚎yard-img]][🚎yard] |
67
- | 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]--> |
68
- | 3️⃣ | maintenance & 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] |
69
- | 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] [![MacOS][🧮mac-wf-img]][🧮mac-wf] [![Windows][📗win-wf-img]][📗win-wf] |
70
- | 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] |
71
- | 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] |
72
- | 7️⃣ | spread 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Tweet @ Peter][🏘tweet-img]][🏘tweet] [🌏][aboutme] [👼][angelme] [💻][coderme] |
73
-
74
- <!--
75
- The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
76
- -->
77
-
78
- <!-- 1️⃣ name, license, docs -->
79
- [⛳️gem]: https://rubygems.org/gems/oauth
80
- [⛳️name-img]: https://img.shields.io/badge/name-oauth-brightgreen.svg?style=flat
81
- [🖇src-license]: https://opensource.org/licenses/MIT
82
- [🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
83
- [🚎yard]: https://www.rubydoc.info/github/oauth-xx/oauth-ruby
84
- [🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
85
-
86
- <!-- 2️⃣ version & activity -->
87
- [⛳️version-img]: http://img.shields.io/gem/v/oauth.svg
88
- [🖇DL-total-img]: https://img.shields.io/gem/dt/oauth.svg
89
- [🏘DL-rank-img]: https://img.shields.io/gem/rt/oauth.svg
90
- [🚎src-home]: https://github.com/oauth-xx/oauth-ruby
91
- [🚎src-home-img]: https://img.shields.io/badge/source-github-brightgreen.svg?style=flat
92
- [🖐prs-o]: https://github.com/oauth-xx/oauth-ruby/pulls
93
- [🖐prs-o-img]: https://img.shields.io/github/issues-pr/oauth-xx/oauth-ruby
94
- [🧮prs-c]: https://github.com/oauth-xx/oauth-ruby/pulls?q=is%3Apr+is%3Aclosed
95
- [🧮prs-c-img]: https://img.shields.io/github/issues-pr-closed/oauth-xx/oauth-ruby
96
- [📗next]: https://github.com/oauth-xx/oauth-ruby/milestone/1
97
- [📗next-img]: https://img.shields.io/github/milestones/progress/oauth-xx/oauth-ruby/1?label=Next%20Version
98
-
99
- <!-- 3️⃣ maintanence & linting -->
100
- [⛳cclim-maint]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
101
- [⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/maintainability
102
- [🖇triage-help]: https://www.codetriage.com/oauth-xx/oauth-ruby
103
- [🖇triage-help-img]: https://www.codetriage.com/oauth-xx/oauth-ruby/badges/users.svg
104
- [🏘depfu♻️]: https://depfu.com/github/oauth-xx/oauth-ruby?project_id=22868
105
- [🏘depfu-img♻️]: https://badges.depfu.com/badges/d570491bac0ad3b0b65deb3c82028327/count.svg
106
- [🚎contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
107
- [🚎contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby
108
- [🖐style-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml
109
- [🖐style-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/style.yml/badge.svg
110
- [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
111
- [🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/oauth-xx/oauth-ruby
112
-
113
- <!-- 4️⃣ testing -->
114
- [⛳iss-o]: https://github.com/oauth-xx/oauth-ruby/issues
115
- [⛳iss-o-img]: https://img.shields.io/github/issues-raw/oauth-xx/oauth-ruby
116
- [🖇iss-c]: https://github.com/oauth-xx/oauth-ruby/issues?q=is%3Aissue+is%3Aclosed
117
- [🖇iss-c-img]: https://img.shields.io/github/issues-closed-raw/oauth-xx/oauth-ruby
118
- [🏘sup-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml
119
- [🏘sup-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/supported.yml/badge.svg
120
- [🚎heads-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml
121
- [🚎heads-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/heads.yml/badge.svg
122
- [🧮mac-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml
123
- [🧮mac-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/macos.yml/badge.svg
124
- [📗win-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml
125
- [📗win-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/windows.yml/badge.svg
126
-
127
- <!-- 5️⃣ coverage & security -->
128
- [⛳cclim-cov]: https://codeclimate.com/github/oauth-xx/oauth-ruby/test_coverage
129
- [⛳cclim-cov-img♻️]: https://api.codeclimate.com/v1/badges/3cf23270c21e8791d788/test_coverage
130
- [🖇codecov-img♻️]: https://codecov.io/gh/oauth-xx/oauth-ruby/branch/main/graph/badge.svg?token=4ZNAWNxrf9
131
- [🖇codecov]: https://codecov.io/gh/oauth-xx/oauth-ruby
132
- [🏘coveralls]: https://coveralls.io/github/oauth-xx/oauth-ruby?branch=main
133
- [🏘coveralls-img]: https://coveralls.io/repos/github/oauth-xx/oauth-ruby/badge.svg?branch=main
134
- [🚎sec-pol]: https://github.com/oauth-xx/oauth-ruby/blob/main/SECURITY.md
135
- [🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
136
- [🖐codeQL]: https://github.com/oauth-xx/oauth-ruby/security/code-scanning
137
- [🖐codeQL-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/codeql-analysis.yml/badge.svg
138
- [🧮cov-wf]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml
139
- [🧮cov-wf-img]: https://github.com/oauth-xx/oauth-ruby/actions/workflows/coverage.yml/badge.svg
140
-
141
- <!-- 6️⃣ resources -->
142
- [⛳gh-discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
143
- [⛳gh-discussions-img]: https://img.shields.io/github/discussions/oauth-xx/oauth-ruby
144
- [🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
145
- [🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
146
- [🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
147
- [🏘chat-img]: https://img.shields.io/gitter/room/oauth-xx/oauth-ruby.svg
148
- [🚎blog]: http://www.railsbling.com/tags/oauth-ruby/
149
- [🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
150
- [🖐wiki]: https://github.com/oauth-xx/oauth-ruby/wiki
151
- [🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
152
-
153
- <!-- 7️⃣ spread 💖 -->
154
- [⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
155
- [⛳liberapay]: https://liberapay.com/pboling/donate
156
- [🖇sponsor-img]: https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github
157
- [🖇sponsor]: https://github.com/sponsors/pboling
158
- [🏘tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
159
- [🏘tweet]: http://twitter.com/galtzo
11
+ `if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
160
12
 
161
- <!-- Maintainer Contact Links -->
162
- [railsbling]: http://www.railsbling.com
163
- [peterboling]: http://www.peterboling.com
13
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
164
14
 
165
- ## Installation
15
+ <details>
16
+ <summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
166
17
 
167
- Install the gem and add to the application's Gemfile by executing:
18
+ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
168
19
 
169
- $ bundle add oauth
20
+ </details>
170
21
 
171
- If bundler is not being used to manage dependencies, install the gem by executing:
22
+ ## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
172
23
 
173
- $ gem install oauth
24
+ OAuth 1.0a is an industry-standard protocol for authorization.
25
+ It is an update to the original OAuth 1.0 protocol, and is used by many popular services.
174
26
 
175
- ## OAuth for Enterprise
27
+ This is a RubyGem for implementing OAuth 1.0 or 1.0a _clients_ and _servers_ in Ruby applications.
28
+ See the sibling `oauth2` gem for OAuth 2.0, 2.1, & OIDC clients in Ruby.
176
29
 
177
- Available as part of the Tidelift Subscription.
30
+ All dependencies of this gem are signed, so it can be installed with a `HighSecurity` profile.
178
31
 
179
- 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.](https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise)
32
+ * [OAuth 1.0 Spec][oauth1-spec]
33
+ * [oauth-tty sibling gem][sibling2-gem] is the OAuth 1.0 / 1.0a CLI.
34
+ * [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
180
35
 
181
- ## Security contact information [![Security Policy][🚎sec-pol-img]][🚎sec-pol]
36
+ [oauth1-spec]: http://oauth.net/core/1.0/
37
+ [sibling-gem]: https://gitlab.com/ruby-oauth/oauth2
38
+ [sibling2-gem]: https://gitlab.com/ruby-oauth/oauth-tty
39
+
40
+ ### OAuth 1.0 vs 1.0a: What this library implements
41
+
42
+ This gem targets the OAuth 1.0a behavior (the errata that became RFC 5849), while maintaining compatibility with providers that still behave like classic 1.0.
43
+ Here are the key differences between the two and how this gem handles them:
44
+
45
+ - oauth_callback
46
+ - 1.0: Optional in practice; some providers accepted flows without it.
47
+ - 1.0a: Consumer SHOULD send oauth_callback when obtaining a Request Token, or explicitly use the out-of-band value "oob".
48
+ - This gem: If you do not pass oauth_callback, we default it to "oob" (OUT_OF_BAND). You can opt-out by passing exclude_callback: true.
49
+ - oauth_callback_confirmed
50
+ - 1.0: Not specified.
51
+ - 1.0a: Service Provider MUST return oauth_callback_confirmed=true with the Request Token response. This mitigates session fixation.
52
+ - This gem: Parses token responses but does not include oauth_callback_confirmed in the signature base string (it is a response param, not a signed request param).
53
+ - oauth_verifier
54
+ - 1.0: Not present.
55
+ - 1.0a: After the user authorizes, the Provider returns an oauth_verifier to the Consumer, and the Consumer MUST include it when exchanging the Request Token for an Access Token.
56
+ - This gem: Supports oauth_verifier across request helpers and request proxies; pass oauth_verifier to get_access_token in 3‑legged flows.
57
+
58
+ Practical guidance:
59
+ - For 3‑legged flows, always supply oauth_callback when calling consumer.get_request_token, and include oauth_verifier when calling request_token.get_access_token.
60
+ - For command‑line or non-HTTP clients, use the special OUT_OF_BAND value ("oob") as the oauth_callback and prompt the user to paste back the displayed verifier.
61
+
62
+ References: [RFC 5849 (OAuth 1.0)](https://datatracker.ietf.org/doc/html/rfc5849), sections 5–7; [1.0a security errata](https://oauth.net/core/1.0a/).
63
+
64
+ Ruby OAuth has been maintained by a large number of talented
65
+ individuals over the years.
66
+ The primary maintainer since 2020 is Peter Boling ([@pboling](https://github.com/pboling)).
67
+
68
+ ## 💡 Info you can shake a stick at
69
+
70
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
71
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
72
+ | Works with JRuby | [![JRuby 9.2 Compat][💎jruby-9.2i]][🚎jruby-9.2-wf] [![JRuby 9.3 Compat][💎jruby-9.3i]][🚎jruby-9.3-wf] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎jruby-9.4-wf] [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
73
+ | Works with Truffle Ruby | [![Truffle Ruby 22.3 Compat][💎truby-22.3i]][🚎truby-22.3-wf] [![Truffle Ruby 23.0 Compat][💎truby-23.0i]][🚎truby-23.0-wf] [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎truby-23.1-wf] <br/> [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf]|
74
+ | Works with MRI Ruby 4 | [![Ruby 4.0 Compat][💎ruby-4.0i]][🚎11-c-wf] [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
75
+ | Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎ruby-3.0-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎ruby-3.1-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
76
+ | Works with MRI Ruby 2 | ![Ruby 2.3 Compat][💎ruby-2.3i] <br/> [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎ruby-2.4-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎ruby-2.5-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎ruby-2.6-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎ruby-2.7-wf]|
77
+ | Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
78
+ | 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] |
79
+ | Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
80
+ | Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
81
+ | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
82
+ | Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
83
+ | `...` 💖 | [![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] |
84
+
85
+ ### Compatibility
86
+
87
+ Compatible with MRI Ruby 2.3+, and concordant releases of JRuby, and TruffleRuby.
88
+ CI workflows and Appraisals are generated for MRI Ruby 2.4+.
89
+ This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
90
+ may be higher than the gem's runtime compatibility floor when legacy Rubies are
91
+ not practical for the current toolchain.
92
+
93
+ | 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
94
+ |------------------------------------------------|--------------------------------------------------------|
95
+ | 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
96
+
97
+ ### Federated DVCS
98
+
99
+ <details markdown="1">
100
+ <summary>Find this repo on federated forges (Coming soon!)</summary>
101
+
102
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
103
+ |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
104
+ | 🧪 [ruby-oauth/oauth on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
105
+ | 🧊 [ruby-oauth/oauth on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
106
+ | 🐙 [ruby-oauth/oauth on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
107
+ | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
182
108
 
183
- To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
184
- Tidelift will coordinate the fix and disclosure.
109
+ </details>
185
110
 
186
- For more see [SECURITY.md][🚎sec-pol].
111
+ [gh-discussions]: https://github.com/ruby-oauth/oauth/discussions
187
112
 
188
- ## Compatibility
113
+ ### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/oauth)](https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=readme)
189
114
 
190
- Targeted ruby compatibility is non-EOL versions of Ruby, currently 2.7, 3.0, and
191
- 3.1. Ruby is limited to 2.7+ in the gemspec, and this will change with minor version bumps,
192
- while the gem is still in 0.x, in accordance with the SemVer spec.
115
+ Available as part of the Tidelift Subscription.
193
116
 
194
- The `main` branch now targets 1.x releases, for Ruby >= 2.7.
195
- See `v0.6-maintenance` (EOL April, 2024) branch for Ruby >= 2.4.
196
- See `v0.5-maintenance` (EOL April, 2023) branch for Ruby >= 2.0.
117
+ <details markdown="1">
118
+ <summary>Need enterprise-level guarantees?</summary>
197
119
 
198
- NOTE: No further releases of version < 1.0.x are anticipated.
120
+ 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.
199
121
 
200
- <details>
201
- <summary>Ruby Engine Compatibility Policy</summary>
202
-
203
- This gem is tested against MRI, and to a lesser extent, against JRuby, and Truffleruby.
204
- Each of those has varying versions that target a specific version of MRI Ruby.
205
- This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
206
- If you would like to add support for additional engines,
207
- first make sure Github Actions supports the engine,
208
- then submit a PR to the correct maintenance branch as according to the table below.
209
- </details>
122
+ [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
210
123
 
211
- <details>
212
- <summary>Ruby Version Compatibility Policy</summary>
124
+ - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
125
+ - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
126
+ - 💡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
213
127
 
214
- If something doesn't work on one of these interpreters, it's a bug.
128
+ Alternatively:
215
129
 
216
- This library may inadvertently work (or seem to work) on other Ruby
217
- implementations, however support will only be provided for the versions listed
218
- above.
130
+ - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
131
+ - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
132
+ - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
219
133
 
220
- If you would like this library to support another Ruby version, you may
221
- volunteer to be a maintainer. Being a maintainer entails making sure all tests
222
- run and pass on that implementation. When something breaks on your
223
- implementation, you will be responsible for providing patches in a timely
224
- fashion. If critical issues for a particular implementation exist at the time
225
- of a major release, support for that Ruby version may be dropped.
226
134
  </details>
227
135
 
228
- | | Ruby OAuth Version | Maintenance Branch | EOL | 🚂 Compatibility | Official 💎 | Unofficial 💎 | Incidental 💎 |
229
- |:----|--------------------|--------------------|-----------|------------------------|----------------------|------------------------------|---------------|
230
- | 1️⃣ | 1.0.x | `main` | | Rails 6, 7 | 2.7, 3.0, 3.1 | sorry, not sorry | nope |
231
- | 2️⃣ | 0.6.x | `v0.6-maintenance` | 04/2024 | Rails 5, 6, 7 | 2.7, 3.0, 3.1 | 2.5, 2.6 | 2.4 |
232
- | 3️⃣ | 0.5.x | `v0.5-maintenance` | 04/2023 | Rails 2, 3, 4, 5, 6, 7 | 2.7, 3.0, 3.1 | 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 | 2.0 |
233
- | 4️⃣ | older | N/A | yesterday | | Best of luck to you! | Please upgrade! | noop |
136
+ ## ✨ Installation
137
+
138
+ Install the gem and add to the application's Gemfile by executing:
234
139
 
235
- NOTE: Once 1.0 is released, the 0.x series will only receive critical bug and security updates.
236
- See [SECURITY.md][🚎sec-pol]
140
+ ```console
141
+ bundle add oauth
142
+ ```
237
143
 
238
- 🚂 NOTE: See notes on Rails in next section.
144
+ If bundler is not being used to manage dependencies, install the gem by executing:
239
145
 
240
- ## Basics
146
+ ```console
147
+ gem install oauth
148
+ ```
149
+
150
+ ## ⚙️ Configuration
241
151
 
242
152
  This is a ruby library which is intended to be used in creating Ruby Consumer
243
153
  and Service Provider applications. It is NOT a Rails plugin, but could easily
244
154
  be used for the foundation for such a Rails plugin.
245
155
 
156
+ The main client entry point is `OAuth::Consumer.new(consumer_key, consumer_secret, options)`.
157
+ Common options include:
158
+
159
+ - `:site` - Provider origin, for example `https://provider.example`.
160
+ - `:request_token_path`, `:authorize_path`, `:authenticate_path`, `:access_token_path` - Provider endpoint paths. Defaults are `/oauth/request_token`, `/oauth/authorize`, `/oauth/authenticate`, and `/oauth/access_token`.
161
+ - `:request_token_url`, `:authorize_url`, `:access_token_url` - Full endpoint URLs. Use these when endpoints are not all under the same `:site` origin.
162
+ - `:scheme` - Where OAuth parameters are sent: `:header` by default, or `:body` / `:query_string`.
163
+ - `:http_method` - HTTP method for token endpoint requests, `:post` by default.
164
+ - `:signature_method` - Signature method, `HMAC-SHA1` by default.
165
+ - `:body_hash_enabled` - Whether request body hashes are signed where applicable. Defaults to `true`.
166
+ - `:ca_file`, `:proxy`, `:debug_output` - Net::HTTP transport options.
167
+ - `:token_request_max_redirects` - Maximum redirects followed while requesting OAuth tokens. Defaults to `10`.
168
+ - `:token_request_cross_origin_redirects` - Whether token requests may follow redirects to a different scheme, host, or effective port. Defaults to `false`; only enable this when the provider's token endpoints intentionally redirect across origins.
169
+
246
170
  This gem was originally extracted from @pelle's [oauth-plugin](https://github.com/pelle/oauth-plugin)
247
171
  gem. After extraction that gem was made to depend on this gem.
248
172
 
@@ -250,14 +174,18 @@ Unfortunately, this gem does have some Rails related bits that are
250
174
  **optional** to load. You don't need Rails! The Rails bits may be pulled out
251
175
  into a separate gem with the 1.x minor updates of this gem.
252
176
 
253
- ## Extensions
177
+ ## 🔧 Basic Usage
254
178
 
255
- * [oauth-tty (on Gitlab)](https://gitlab.com/oauth-xx/oauth-tty) ([rubygems.org](https://rubygems.org/gems/oauth-tty))
179
+ ### Extensions
256
180
 
257
- ## Usage
181
+ * [oauth-tty (on Gitlab)](https://gitlab.com/ruby-oauth/oauth-tty) ([rubygems.org](https://rubygems.org/gems/oauth-tty))
258
182
 
259
- We need to specify the `oauth_callback` url explicitly, otherwise it defaults to
260
- "oob" (Out of Band)
183
+ ### Examples
184
+
185
+ For browser-based three-legged OAuth 1.0a flows, pass an explicit
186
+ `oauth_callback` URL when requesting the request token. If you do not pass
187
+ `oauth_callback`, this gem defaults it to `"oob"` (out of band), which is
188
+ intended for command-line and non-HTTP clients.
261
189
 
262
190
  ```ruby
263
191
  callback_url = "http://127.0.0.1:3000/oauth/callback"
@@ -266,125 +194,525 @@ callback_url = "http://127.0.0.1:3000/oauth/callback"
266
194
  Create a new `OAuth::Consumer` instance by passing it a configuration hash:
267
195
 
268
196
  ```ruby
269
- oauth_consumer = OAuth::Consumer.new("key", "secret", site: "https://agree2")
197
+ oauth_consumer = OAuth::Consumer.new(
198
+ "consumer_key",
199
+ "consumer_secret",
200
+ site: "https://provider.example"
201
+ )
270
202
  ```
271
203
 
272
- Start the process by requesting a token
204
+ Start the process by requesting a token:
273
205
 
274
206
  ```ruby
275
207
  request_token = oauth_consumer.get_request_token(oauth_callback: callback_url)
276
208
 
277
209
  session[:token] = request_token.token
278
210
  session[:token_secret] = request_token.secret
279
- redirect_to request_token.authorize_url(oauth_callback: callback_url)
211
+ redirect_to request_token.authorize_url
280
212
  ```
281
213
 
282
- When user returns create an access_token
214
+ When the user returns to your callback URL, rebuild the request token from the
215
+ values you stored and exchange it for an access token. OAuth 1.0a providers
216
+ return `oauth_verifier` in the callback, and it must be included in this
217
+ exchange.
283
218
 
284
219
  ```ruby
285
- hash = { oauth_token: session[:token], oauth_token_secret: session[:token_secret] }
220
+ hash = {oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
286
221
  request_token = OAuth::RequestToken.from_hash(oauth_consumer, hash)
287
- access_token = request_token.get_access_token
288
- # For 3-legged authorization, flow oauth_verifier is passed as param in callback
289
- # access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
222
+ access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
290
223
  @photos = access_token.get("/photos.xml")
291
224
  ```
292
225
 
226
+ For OAuth 1.0 providers that do not use `oauth_verifier`, call
227
+ `request_token.get_access_token` without the verifier.
228
+
293
229
  Now that you have an access token, you can use Typhoeus to interact with the
294
230
  OAuth provider if you choose.
295
231
 
296
232
  ```ruby
297
233
  require "typhoeus"
298
234
  require "oauth/request_proxy/typhoeus_request"
299
- oauth_params = { consumer: oauth_consumer, token: access_token }
235
+
236
+ uri = "https://provider.example/photos.xml"
237
+ options = {method: :get, headers: {}}
238
+ oauth_params = {consumer: oauth_consumer, token: access_token}
239
+
300
240
  hydra = Typhoeus::Hydra.new
301
241
  req = Typhoeus::Request.new(uri, options) # :method needs to be specified in options
302
242
  oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(request_uri: uri))
243
+ req.options[:headers] ||= {}
303
244
  req.options[:headers]["Authorization"] = oauth_helper.header # Signs the request
304
245
  hydra.queue(req)
305
246
  hydra.run
306
247
  @response = req.response
307
248
  ```
308
249
 
309
- ## More Information
250
+ ### More Information
251
+
252
+ * RubyDoc Documentation: [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head]
253
+ * Mailing List/Google Group: [![OAuth Ruby Google Group][⛳gg-discussions-img]][⛳gg-discussions]
254
+ * Maintainer Blog: [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog]
255
+ * Live ruby-oauth Chat: [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
256
+
257
+ [⛳gg-discussions]: https://groups.google.com/g/oauth-ruby
258
+ [⛳gg-discussions-img]: https://img.shields.io/badge/google-group-0093D0.svg?style=for-the-badge&logo=google&logoColor=orange
259
+
260
+ ## 🦷 FLOSS Funding
261
+
262
+ While ruby-oauth tools are free software and will always be, the project would benefit immensely from some funding.
263
+ Raising a monthly budget of... "dollars" would make the project more sustainable.
264
+
265
+ We welcome both individual and corporate sponsors! We also offer a
266
+ wide array of funding channels to account for your preferences.
267
+ Currently, [Open Collective][🖇osc] is our preferred funding platform.
268
+
269
+ **If you're working in a company that's making significant use of ruby-oauth tools we'd
270
+ appreciate it if you suggest to your company to become a ruby-oauth sponsor.**
271
+
272
+ You can support the development of ruby-oauth tools via
273
+ [GitHub Sponsors][🖇sponsor],
274
+ [Liberapay][⛳liberapay],
275
+ [PayPal][🖇paypal],
276
+ [Open Collective][🖇osc]
277
+ and [Tidelift][🏙️entsup-tidelift].
278
+
279
+ | 📍 NOTE |
280
+ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
281
+ | If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
282
+
283
+ ### Open Collective for Individuals
284
+
285
+ Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/ruby-oauth#backer)]
286
+
287
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
288
+
289
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
290
+ No backers yet. Be the first!
291
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
292
+
293
+ ### Open Collective for Organizations
294
+
295
+ Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/ruby-oauth#sponsor)]
296
+
297
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
298
+
299
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
300
+ No sponsors yet. Be the first!
301
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
310
302
 
311
- * RubyDoc Documentation: [![RubyDoc.info](https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat)][documentation]
312
- * Mailing List/Google Group: [![Mailing List](https://img.shields.io/badge/group-mailinglist-violet.svg?style=social&logo=google)][mailinglist]
313
- * GitHub Discussions: [![Discussion](https://img.shields.io/badge/discussions-github-brightgreen.svg?style=flat)][gh_discussions]
314
- * Live Chat on Gitter: [![Join the chat at https://gitter.im/oauth-xx/oauth-ruby](https://badges.gitter.im/Join%20Chat.svg)][chat]
315
- * Maintainer's Blog: [![Blog](https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat)][blogpage]
303
+ [kettle-readme-backers]: https://github.com/ruby-oauth/oauth/blob/main/exe/kettle-readme-backers
316
304
 
317
- ## Contributing
305
+ ### Another way to support open-source
318
306
 
319
- See [CONTRIBUTING.md][contributing]
307
+ I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
320
308
 
321
- ## Contributors
309
+ If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
322
310
 
323
- [![Contributors](https://contrib.rocks/image?repo=oauth-xx/oauth-ruby)][contributors]
311
+ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
324
312
 
325
- Made with [contributors-img][contrib-rocks].
313
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
326
314
 
327
- [contrib-rocks]: https://contrib.rocks
315
+ [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
328
316
 
329
- ## Versioning
317
+ ## 🔐 Security
330
318
 
331
- This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations of this scheme should be reported as
332
- bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be
333
- immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new
334
- major versions. Compatibility with a major and minor versions of Ruby will only be changed with a major version bump.
319
+ See [SECURITY.md][🔐security].
335
320
 
336
- As a result of this policy, you can (and should) specify a dependency on this gem using
337
- the [Pessimistic Version Constraint][pvc] with two digits of precision.
321
+ ## 🤝 Contributing
322
+
323
+ If you need some ideas of where to help, you could work on adding more code coverage,
324
+ or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
325
+ or use the gem and think about how it could be better.
326
+
327
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
328
+
329
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
330
+
331
+ ### 🚀 Release Instructions
332
+
333
+ See [CONTRIBUTING.md][🤝contributing].
334
+
335
+ ### Code Coverage
336
+
337
+ <details markdown="1">
338
+ <summary>Coverage service badges</summary>
339
+
340
+ [![Coverage Graph][🏀codecov-g]][🏀codecov]
341
+
342
+ [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
343
+
344
+ [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
345
+
346
+ </details>
347
+
348
+ ### 🪇 Code of Conduct
349
+
350
+ Everyone interacting with this project's codebases, issue trackers,
351
+ chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
352
+
353
+ ## 🌈 Contributors
354
+
355
+ [![Contributors][🖐contributors-img]][🖐contributors]
356
+
357
+ Made with [contributors-img][🖐contrib-rocks].
358
+
359
+ Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/oauth/-/graphs/main][🚎contributors-gl]
360
+
361
+ <details>
362
+ <summary>⭐️ Star History</summary>
363
+
364
+ <a href="https://star-history.com/ruby-oauth/oauth&Date">
365
+ <picture>
366
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date&theme=dark" />
367
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date" />
368
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date" />
369
+ </picture>
370
+ </a>
371
+
372
+ </details>
373
+
374
+ ## 📌 Versioning
375
+
376
+ This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
377
+ For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
338
378
 
339
379
  For example:
340
380
 
341
381
  ```ruby
342
- spec.add_dependency "oauth", "~> 1.1"
382
+ spec.add_dependency("oauth", "~> 1.0")
343
383
  ```
344
384
 
345
- ## License
385
+ <details markdown="1">
386
+ <summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
387
+
388
+ Dropping support for a platform can be a breaking change for affected users.
389
+ If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
390
+
391
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
392
+ read this article from the creator of SemVer:
393
+
394
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
395
+
396
+ </details>
397
+
398
+ See [CHANGELOG.md][📌changelog] for a list of releases.
399
+
400
+ ## 📄 License
346
401
 
347
402
  The gem is available as open source under the terms of
348
- the [MIT License][license] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref].
349
- See [LICENSE][license] for the [Copyright Notice][copyright-notice-explainer].
350
-
351
- ## Contact
352
-
353
- OAuth Ruby has been created and maintained by a large number of talented
354
- individuals. The current maintainer is Peter Boling ([@pboling][gh_sponsors]).
355
-
356
- Comments are welcome. Contact the [OAuth Ruby mailing list (Google Group)][mailinglist] or [GitHub Discussions][gh_discussions].
357
-
358
- [comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
359
-
360
- [conduct]: https://github.com/oauth-xx/oauth-ruby/blob/main/CODE_OF_CONDUCT.md
361
- [contributing]: https://github.com/oauth-xx/oauth-ruby/blob/main/CONTRIBUTING.md
362
- [contributors]: https://github.com/oauth-xx/oauth-ruby/graphs/contributors
363
- [mailinglist]: http://groups.google.com/group/oauth-ruby
364
- [source]: https://github.com/oauth-xx/oauth-ruby/
365
-
366
- [comment]: <> (Following links are used by README, Homepage)
367
-
368
- [aboutme]: https://about.me/peter.boling
369
- [actions]: https://github.com/oauth-xx/oauth-ruby/actions
370
- [angelme]: https://angel.co/peter-boling
371
- [blogpage]: http://www.railsbling.com/tags/oauth/
372
- [chat]: https://gitter.im/oauth-xx/oauth-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
373
- [climate_coverage]: https://codeclimate.com/github/oauth-xx/oauth-ruby/test_coverage
374
- [climate_maintainability]: https://codeclimate.com/github/oauth-xx/oauth-ruby/maintainability
375
- [code_triage]: https://www.codetriage.com/oauth-xx/oauth-ruby
376
- [codecov_coverage]: https://codecov.io/gh/oauth-xx/oauth-ruby
377
- [coderme]:http://coderwall.com/pboling
378
- [depfu]: https://depfu.com/github/oauth-xx/oauth-ruby?project_id=22868
379
- [documentation]: https://rubydoc.info/github/oauth-xx/oauth-ruby
380
- [followme-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
381
- [gh_discussions]: https://github.com/oauth-xx/oauth-ruby/discussions
382
- [gh_sponsors]: https://github.com/sponsors/pboling
383
- [license]: https://github.com/oauth-xx/oauth-ruby/blob/main/LICENSE
384
- [license-ref]: https://opensource.org/licenses/MIT
385
- [liberapay_donate]: https://liberapay.com/pboling/donate
386
- [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
387
- [rubygems]: https://rubygems.org/gems/oauth
388
- [security]: https://github.com/oauth-xx/oauth-ruby/blob/main/SECURITY.md
389
- [semver]: http://semver.org/
390
- [tweetme]: http://twitter.com/galtzo
403
+ the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
404
+
405
+ ### © Copyright
406
+
407
+ See [LICENSE.md][📄license] for the official copyright notice.
408
+
409
+ <details markdown="1">
410
+ <summary>Copyright holders</summary>
411
+
412
+ - Copyright (c) 2007-2010 Pelle Braendgaard
413
+ - Copyright (c) 2008 Chris Mear
414
+ - Copyright (c) 2008 Jon Crosby
415
+ - Copyright (c) 2008-2010 Seth Fitzsimmons
416
+ - Copyright (c) 2008 Tilmann Singer
417
+ - Copyright (c) 2008 Tom Insam
418
+ - Copyright (c) 2008 tsailipu
419
+ - Copyright (c) 2009-2012 Aaron Quint
420
+ - Copyright (c) 2009 Anders Conbere
421
+ - Copyright (c) 2009 Bill Kocik
422
+ - Copyright (c) 2009 Darcy Laycock
423
+ - Copyright (c) 2009 Eric Hartmann
424
+ - Copyright (c) 2009 Greg Weber
425
+ - Copyright (c) 2009 Laszlo Bacsi
426
+ - Copyright (c) 2009 Marshall Huss
427
+ - Copyright (c) 2009 Matt Sanford
428
+ - Copyright (c) 2009 Neill Pearman
429
+ - Copyright (c) 2009 Seth Cousins
430
+ - Copyright (c) 2009 Yoan Blanc
431
+ - Copyright (c) 2010 andrehjr
432
+ - Copyright (c) 2010 Brian Finney
433
+ - Copyright (c) 2010 ecavazos
434
+ - Copyright (c) 2010 Joshua Hull
435
+ - Copyright (c) 2010 Marsh Gardiner
436
+ - Copyright (c) 2010 Michael Reinsch
437
+ - Copyright (c) 2010 Sean Cribbs
438
+ - Copyright (c) 2010 Steven Parkes
439
+ - Copyright (c) 2010 成田 一生
440
+ - Copyright (c) 2011 Shaliko Usubov
441
+ - Copyright (c) 2012 Ernie Miller
442
+ - Copyright (c) 2012 Jonathon M. Abbott
443
+ - Copyright (c) 2012 Richard Huang
444
+ - Copyright (c) 2012 rick
445
+ - Copyright (c) 2012 Steven Hammond
446
+ - Copyright (c) 2013 Craig Walker
447
+ - Copyright (c) 2013 Khem Veasna
448
+ - Copyright (c) 2014 Brian John
449
+ - Copyright (c) 2014 Michal Papis
450
+ - Copyright (c) 2014 raeno
451
+ - Copyright (c) 2015 jremmen
452
+ - Copyright (c) 2015 Kevin Hughes
453
+ - Copyright (c) 2016 Eric True
454
+ - Copyright (c) 2016-2017 James Pinto
455
+ - Copyright (c) 2016 jianben
456
+ - Copyright (c) 2016 Nik Wakelin
457
+ - Copyright (c) 2017 Ondrej Prazak
458
+ - Copyright (c) 2018 Nicholas Souphandavong
459
+ - Copyright (c) 2018 Yvonne
460
+ - Copyright (c) 2019 Agora@Ubuntu-dev
461
+ - Copyright (c) 2019 Shohei Maeda
462
+ - Copyright (c) 2020-2021, 2026 Khem
463
+ - Copyright (c) 2021 Chuck Remes
464
+ - Copyright (c) 2021 iamibi
465
+ - Copyright (c) 2021 Jeremy Sioui
466
+ - Copyright (c) 2021 Nick Morgan
467
+ - Copyright (c) 2021-2022, 2025-2026 Peter H. Boling
468
+ - Copyright (c) 2021 Richard Vowles
469
+ - Copyright (c) 2022 Shalvah
470
+ - Copyright (c) 2024-2025 Annibelle Boling
471
+ - Copyright (c) 2025 Aboling0
472
+ - Copyright (c) 2026 David Varga
473
+ - Copyright (c) 2026 StepSecurity Bot
474
+
475
+ </details>
476
+
477
+ ## 🤑 A request for help
478
+
479
+ Maintainers have teeth and need to pay their dentists.
480
+ After getting laid off in an RIF in March, and encountering difficulty finding a new one,
481
+ I began spending most of my time building open source tools.
482
+ I'm hoping to be able to pay for my kids' health insurance this month,
483
+ so if you value the work I am doing, I need your support.
484
+ Please consider sponsoring me or the project.
485
+
486
+ To join the community or get help 👇️ Join the Discord.
487
+
488
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
489
+
490
+ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
491
+
492
+ [![Sponsor ruby-oauth/oauth on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
493
+
494
+ ### Please give the project a star ⭐ ♥.
495
+
496
+ Many parts of this project are actively managed by a [kettle-jem](https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/kettle-jem) smart template utilizing [StructuredMerge.org](https://structuredmerge.org) merge contracts.
497
+
498
+ Thanks for RTFM. ☺️
499
+
500
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
501
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
502
+ [⛳liberapay]: https://liberapay.com/pboling/donate
503
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/ruby-oauth
504
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth
505
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/ruby-oauth
506
+ [🖇osc-backers]: https://opencollective.com/ruby-oauth#backer
507
+ [🖇osc-backers-i]: https://opencollective.com/ruby-oauth/backers/badge.svg?style=flat
508
+ [🖇osc-sponsors]: https://opencollective.com/ruby-oauth#sponsor
509
+ [🖇osc-sponsors-i]: https://opencollective.com/ruby-oauth/sponsors/badge.svg?style=flat
510
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/ruby-oauth?style=for-the-badge
511
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth?style=for-the-badge
512
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/ruby-oauth?style=for-the-badge
513
+ [🖇osc]: https://opencollective.com/ruby-oauth
514
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
515
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
516
+ [🖇sponsor]: https://github.com/sponsors/pboling
517
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
518
+ [🖇polar]: https://polar.sh/pboling
519
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
520
+ [🖇kofi]: https://ko-fi.com/pboling
521
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
522
+ [🖇patreon]: https://patreon.com/galtzo
523
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
524
+ [🖇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
525
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
526
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
527
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
528
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
529
+ [🖇floss-funding.dev]: https://floss-funding.dev
530
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
531
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
532
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
533
+ [✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
534
+ [✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
535
+
536
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
537
+ [⛳️gem-namespace]: https://github.com/ruby-oauth/oauth
538
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-OAuth-3C2D2D.svg?style=square&logo=ruby&logoColor=white
539
+ [⛳️gem-name]: https://bestgems.org/gems/oauth
540
+ [⛳️name-img]: https://img.shields.io/badge/name-oauth-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
541
+ [⛳️tag-img]: https://img.shields.io/github/tag/ruby-oauth/oauth.svg
542
+ [⛳️tag]: https://github.com/ruby-oauth/oauth/releases
543
+ [🚂maint-blog]: http://www.railsbling.com/tags/oauth
544
+ [🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
545
+ [🚂maint-contact]: http://www.railsbling.com/contact
546
+ [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
547
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
548
+ [💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
549
+ [💖✌️wellfound]: https://wellfound.com/u/peter-boling
550
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
551
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
552
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
553
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
554
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
555
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
556
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
557
+ [💖🌳linktree]: https://linktr.ee/galtzo
558
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
559
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
560
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
561
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
562
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
563
+ [💖🧊berg]: https://codeberg.org/pboling
564
+ [💖🐙hub]: https://github.org/pboling
565
+ [💖🛖hut]: https://sr.ht/~galtzo/
566
+ [💖🧪lab]: https://gitlab.com/pboling
567
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
568
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
569
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
570
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
571
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=readme
572
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
573
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
574
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
575
+ [🚂railsbling]: http://www.railsbling.com
576
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
577
+ [📜src-gl]: https://gitlab.com/ruby-oauth/oauth
578
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
579
+ [📜src-cb]: https://codeberg.org/ruby-oauth/oauth
580
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
581
+ [📜src-gh]: https://github.com/ruby-oauth/oauth
582
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
583
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
584
+ [📜gl-wiki]: https://gitlab.com/ruby-oauth/oauth/-/wikis/home
585
+ [📜gh-wiki]: https://github.com/ruby-oauth/oauth/wiki
586
+ [📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
587
+ [📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
588
+ [👽dl-rank]: https://bestgems.org/gems/oauth
589
+ [👽dl-ranki]: https://img.shields.io/gem/rd/oauth.svg
590
+ [👽version]: https://bestgems.org/gems/oauth
591
+ [👽versioni]: https://img.shields.io/gem/v/oauth.svg
592
+ [🏀qlty-mnt]: https://qlty.sh/gh/ruby-oauth/projects/oauth
593
+ [🏀qlty-mnti]: https://qlty.sh/gh/ruby-oauth/projects/oauth/maintainability.svg
594
+ [🏀qlty-cov]: https://qlty.sh/gh/ruby-oauth/projects/oauth/metrics/code?sort=coverageRating
595
+ [🏀qlty-covi]: https://qlty.sh/gh/ruby-oauth/projects/oauth/coverage.svg
596
+ [🏀codecov]: https://codecov.io/gh/ruby-oauth/oauth
597
+ [🏀codecovi]: https://codecov.io/gh/ruby-oauth/oauth/graph/badge.svg
598
+ [🏀coveralls]: https://coveralls.io/github/ruby-oauth/oauth?branch=main
599
+ [🏀coveralls-img]: https://coveralls.io/repos/github/ruby-oauth/oauth/badge.svg?branch=main
600
+ [🚎ruby-2.4-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-2.4.yml
601
+ [🚎ruby-2.5-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-2.5.yml
602
+ [🚎ruby-2.6-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-2.6.yml
603
+ [🚎ruby-2.7-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-2.7.yml
604
+ [🚎ruby-3.0-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-3.0.yml
605
+ [🚎ruby-3.1-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-3.1.yml
606
+ [🚎ruby-3.2-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-3.2.yml
607
+ [🚎ruby-3.3-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-3.3.yml
608
+ [🚎ruby-3.4-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ruby-3.4.yml
609
+ [🚎jruby-9.2-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby-9.2.yml
610
+ [🚎jruby-9.3-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby-9.3.yml
611
+ [🚎jruby-9.4-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby-9.4.yml
612
+ [🚎truby-22.3-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffleruby-22.3.yml
613
+ [🚎truby-23.0-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffleruby-23.0.yml
614
+ [🚎truby-23.1-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffleruby-23.1.yml
615
+ [🚎truby-24.2-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffleruby-24.2.yml
616
+ [🚎truby-25.0-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffleruby-25.0.yml
617
+ [🚎2-cov-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/coverage.yml
618
+ [🚎2-cov-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/coverage.yml/badge.svg
619
+ [🚎3-hd-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/heads.yml
620
+ [🚎3-hd-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/heads.yml/badge.svg
621
+ [🚎5-st-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/style.yml
622
+ [🚎5-st-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/style.yml/badge.svg
623
+ [🚎9-t-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffle.yml
624
+ [🚎9-t-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/truffle.yml/badge.svg
625
+ [🚎10-j-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby.yml
626
+ [🚎10-j-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby.yml/badge.svg
627
+ [🚎11-c-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/current.yml
628
+ [🚎11-c-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/current.yml/badge.svg
629
+ [🚎12-crh-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/dep-heads.yml
630
+ [🚎12-crh-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/dep-heads.yml/badge.svg
631
+ [🚎13-🔒️-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/locked_deps.yml
632
+ [🚎13-🔒️-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/locked_deps.yml/badge.svg
633
+ [🚎14-🔓️-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/unlocked_deps.yml
634
+ [🚎14-🔓️-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/unlocked_deps.yml/badge.svg
635
+ [🚎15-🪪-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/license-eye.yml
636
+ [🚎15-🪪-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/license-eye.yml/badge.svg
637
+ [💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
638
+ [💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
639
+ [💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
640
+ [💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
641
+ [💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
642
+ [💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
643
+ [💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
644
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
645
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
646
+ [💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
647
+ [💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
648
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
649
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
650
+ [💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
651
+ [💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
652
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
653
+ [💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
654
+ [💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
655
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
656
+ [💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2-FBE742?style=for-the-badge&logo=ruby&logoColor=red
657
+ [💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3-FBE742?style=for-the-badge&logo=ruby&logoColor=red
658
+ [💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
659
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
660
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
661
+ [🤝gh-issues]: https://github.com/ruby-oauth/oauth/issues
662
+ [🤝gh-pulls]: https://github.com/ruby-oauth/oauth/pulls
663
+ [🤝gl-issues]: https://gitlab.com/ruby-oauth/oauth/-/issues
664
+ [🤝gl-pulls]: https://gitlab.com/ruby-oauth/oauth/-/merge_requests
665
+ [🤝cb-issues]: https://codeberg.org/ruby-oauth/oauth/issues
666
+ [🤝cb-pulls]: https://codeberg.org/ruby-oauth/oauth/pulls
667
+ [🤝cb-donate]: https://donate.codeberg.org/
668
+ [🤝contributing]: https://github.com/ruby-oauth/oauth/blob/main/CONTRIBUTING.md
669
+ [🏀codecov-g]: https://codecov.io/gh/ruby-oauth/oauth/graph/badge.svg
670
+ [🖐contrib-rocks]: https://contrib.rocks
671
+ [🖐contributors]: https://github.com/ruby-oauth/oauth/graphs/contributors
672
+ [🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/oauth
673
+ [🚎contributors-gl]: https://gitlab.com/ruby-oauth/oauth/-/graphs/main
674
+ [🪇conduct]: https://github.com/ruby-oauth/oauth/blob/main/CODE_OF_CONDUCT.md
675
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
676
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
677
+ [📌semver]: https://semver.org/spec/v2.0.0.html
678
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
679
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
680
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
681
+ [📌changelog]: https://github.com/ruby-oauth/oauth/blob/main/CHANGELOG.md
682
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
683
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
684
+ [📌gitmoji]: https://gitmoji.dev
685
+ [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
686
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
687
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-0.941-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
688
+ [🔐security]: https://github.com/ruby-oauth/oauth/blob/main/SECURITY.md
689
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
690
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
691
+ [📄license]: LICENSE.md
692
+ [📄license-ref]: MIT.md
693
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
694
+ [📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
695
+ [📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-✓-259D6C.svg?style=flat&logo=Apache
696
+
697
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
698
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
699
+ [🚎yard-current]: http://rubydoc.info/gems/oauth
700
+ [🚎yard-head]: https://oauth.galtzo.com
701
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
702
+ [💎SHA_checksums]: https://gitlab.com/ruby-oauth/oauth/-/tree/main/checksums
703
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
704
+ [💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
705
+ [💎appraisal2]: https://github.com/appraisal-rb/appraisal2
706
+ [💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
707
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
708
+
709
+ <!-- kettle-jem:metadata:start -->
710
+ | Field | Value |
711
+ |---|---|
712
+ | Package | oauth |
713
+ | Description | 🔑 A Ruby wrapper for the original OAuth 1.0 / 1.0a spec. |
714
+ | Homepage | https://github.com/ruby-oauth/oauth |
715
+ | Source | https://github.com/ruby-oauth/oauth/tree/v1.1.5 |
716
+ | License | `MIT` |
717
+ | Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/ruby-oauth, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/oauth, https://www.buymeacoffee.com/pboling |
718
+ <!-- kettle-jem:metadata:end -->