oauth 0.5.6 → 1.1.7

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 (72) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +915 -0
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +134 -0
  6. data/CONTRIBUTING.md +272 -0
  7. data/FUNDING.md +74 -0
  8. data/LICENSE.md +71 -0
  9. data/README.md +718 -0
  10. data/RUBOCOP.md +71 -0
  11. data/SECURITY.md +21 -0
  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 +33 -22
  15. data/lib/oauth/client/em_http.rb +110 -103
  16. data/lib/oauth/client/helper.rb +87 -82
  17. data/lib/oauth/client/net_http.rb +140 -107
  18. data/lib/oauth/client.rb +2 -0
  19. data/lib/oauth/consumer.rb +282 -149
  20. data/lib/oauth/errors/error.rb +2 -0
  21. data/lib/oauth/errors/problem.rb +4 -1
  22. data/lib/oauth/errors/unauthorized.rb +7 -1
  23. data/lib/oauth/errors.rb +5 -3
  24. data/lib/oauth/helper.rb +48 -18
  25. data/lib/oauth/oauth.rb +31 -7
  26. data/lib/oauth/oauth_test_helper.rb +6 -4
  27. data/lib/oauth/optional.rb +20 -0
  28. data/lib/oauth/request_proxy/action_controller_request.rb +53 -71
  29. data/lib/oauth/request_proxy/action_dispatch_request.rb +42 -4
  30. data/lib/oauth/request_proxy/base.rb +146 -131
  31. data/lib/oauth/request_proxy/curb_request.rb +49 -43
  32. data/lib/oauth/request_proxy/em_http_request.rb +60 -49
  33. data/lib/oauth/request_proxy/jabber_request.rb +19 -9
  34. data/lib/oauth/request_proxy/mock_request.rb +5 -3
  35. data/lib/oauth/request_proxy/net_http.rb +61 -54
  36. data/lib/oauth/request_proxy/rack_request.rb +31 -31
  37. data/lib/oauth/request_proxy/rest_client_request.rb +55 -50
  38. data/lib/oauth/request_proxy/typhoeus_request.rb +51 -45
  39. data/lib/oauth/request_proxy.rb +21 -14
  40. data/lib/oauth/server.rb +18 -12
  41. data/lib/oauth/signature/base.rb +88 -71
  42. data/lib/oauth/signature/hmac/sha1.rb +16 -10
  43. data/lib/oauth/signature/hmac/sha256.rb +16 -10
  44. data/lib/oauth/signature/plaintext.rb +18 -20
  45. data/lib/oauth/signature/rsa/sha1.rb +71 -38
  46. data/lib/oauth/signature.rb +41 -34
  47. data/lib/oauth/token.rb +7 -5
  48. data/lib/oauth/tokens/access_token.rb +6 -4
  49. data/lib/oauth/tokens/consumer_token.rb +11 -7
  50. data/lib/oauth/tokens/request_token.rb +17 -10
  51. data/lib/oauth/tokens/server_token.rb +2 -1
  52. data/lib/oauth/tokens/token.rb +15 -1
  53. data/lib/oauth/version.rb +6 -1
  54. data/lib/oauth.rb +19 -9
  55. data/sig/oauth/consumer.rbs +9 -0
  56. data/sig/oauth/signature/base.rbs +12 -0
  57. data/sig/oauth/tokens/token.rbs +8 -0
  58. data/sig/oauth/version.rbs +6 -0
  59. data.tar.gz.sig +2 -0
  60. metadata +313 -84
  61. metadata.gz.sig +3 -0
  62. data/LICENSE +0 -20
  63. data/README.rdoc +0 -88
  64. data/TODO +0 -32
  65. data/bin/oauth +0 -11
  66. data/lib/oauth/cli/authorize_command.rb +0 -71
  67. data/lib/oauth/cli/base_command.rb +0 -208
  68. data/lib/oauth/cli/help_command.rb +0 -22
  69. data/lib/oauth/cli/query_command.rb +0 -25
  70. data/lib/oauth/cli/sign_command.rb +0 -81
  71. data/lib/oauth/cli/version_command.rb +0 -7
  72. data/lib/oauth/cli.rb +0 -56
data/README.md ADDED
@@ -0,0 +1,718 @@
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>
2
+
3
+ # 🔮 OAuth
4
+
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]
6
+
7
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the [discord notification][✉️discord-invite].
8
+
9
+ ---
10
+
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.
12
+
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]
14
+
15
+ <details>
16
+ <summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
17
+
18
+ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
19
+
20
+ </details>
21
+
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>
23
+
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.
26
+
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.
29
+
30
+ All dependencies of this gem are signed, so it can be installed with a `HighSecurity` profile.
31
+
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.
35
+
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] |
108
+
109
+ </details>
110
+
111
+ [gh-discussions]: https://github.com/ruby-oauth/oauth/discussions
112
+
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)
114
+
115
+ Available as part of the Tidelift Subscription.
116
+
117
+ <details markdown="1">
118
+ <summary>Need enterprise-level guarantees?</summary>
119
+
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.
121
+
122
+ [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
123
+
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
127
+
128
+ Alternatively:
129
+
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]
133
+
134
+ </details>
135
+
136
+ ## ✨ Installation
137
+
138
+ Install the gem and add to the application's Gemfile by executing:
139
+
140
+ ```console
141
+ bundle add oauth
142
+ ```
143
+
144
+ If bundler is not being used to manage dependencies, install the gem by executing:
145
+
146
+ ```console
147
+ gem install oauth
148
+ ```
149
+
150
+ ## ⚙️ Configuration
151
+
152
+ This is a ruby library which is intended to be used in creating Ruby Consumer
153
+ and Service Provider applications. It is NOT a Rails plugin, but could easily
154
+ be used for the foundation for such a Rails plugin.
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
+
170
+ This gem was originally extracted from @pelle's [oauth-plugin](https://github.com/pelle/oauth-plugin)
171
+ gem. After extraction that gem was made to depend on this gem.
172
+
173
+ Unfortunately, this gem does have some Rails related bits that are
174
+ **optional** to load. You don't need Rails! The Rails bits may be pulled out
175
+ into a separate gem with the 1.x minor updates of this gem.
176
+
177
+ ## 🔧 Basic Usage
178
+
179
+ ### Extensions
180
+
181
+ * [oauth-tty (on Gitlab)](https://gitlab.com/ruby-oauth/oauth-tty) ([rubygems.org](https://rubygems.org/gems/oauth-tty))
182
+
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.
189
+
190
+ ```ruby
191
+ callback_url = "http://127.0.0.1:3000/oauth/callback"
192
+ ```
193
+
194
+ Create a new `OAuth::Consumer` instance by passing it a configuration hash:
195
+
196
+ ```ruby
197
+ oauth_consumer = OAuth::Consumer.new(
198
+ "consumer_key",
199
+ "consumer_secret",
200
+ site: "https://provider.example"
201
+ )
202
+ ```
203
+
204
+ Start the process by requesting a token:
205
+
206
+ ```ruby
207
+ request_token = oauth_consumer.get_request_token(oauth_callback: callback_url)
208
+
209
+ session[:token] = request_token.token
210
+ session[:token_secret] = request_token.secret
211
+ redirect_to request_token.authorize_url
212
+ ```
213
+
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.
218
+
219
+ ```ruby
220
+ hash = {oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
221
+ request_token = OAuth::RequestToken.from_hash(oauth_consumer, hash)
222
+ access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
223
+ @photos = access_token.get("/photos.xml")
224
+ ```
225
+
226
+ For OAuth 1.0 providers that do not use `oauth_verifier`, call
227
+ `request_token.get_access_token` without the verifier.
228
+
229
+ Now that you have an access token, you can use Typhoeus to interact with the
230
+ OAuth provider if you choose.
231
+
232
+ ```ruby
233
+ require "typhoeus"
234
+ require "oauth/request_proxy/typhoeus_request"
235
+
236
+ uri = "https://provider.example/photos.xml"
237
+ options = {method: :get, headers: {}}
238
+ oauth_params = {consumer: oauth_consumer, token: access_token}
239
+
240
+ hydra = Typhoeus::Hydra.new
241
+ req = Typhoeus::Request.new(uri, options) # :method needs to be specified in options
242
+ oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(request_uri: uri))
243
+ req.options[:headers] ||= {}
244
+ req.options[:headers]["Authorization"] = oauth_helper.header # Signs the request
245
+ hydra.queue(req)
246
+ hydra.run
247
+ @response = req.response
248
+ ```
249
+
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 -->
302
+
303
+ [kettle-readme-backers]: https://github.com/ruby-oauth/oauth/blob/main/exe/kettle-readme-backers
304
+
305
+ ### Another way to support open-source
306
+
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).
308
+
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`.
310
+
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.
312
+
313
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
314
+
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]
316
+
317
+ ## 🔐 Security
318
+
319
+ See [SECURITY.md][🔐security].
320
+
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.
378
+
379
+ For example:
380
+
381
+ ```ruby
382
+ spec.add_dependency("oauth", "~> 1.0")
383
+ ```
384
+
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
401
+
402
+ The gem is available as open source under the terms of
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.950-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-%E2%9C%93-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.6 |
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 -->