oauth 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +4 -0
- data/CHANGELOG.md +317 -41
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +79 -29
- data/CONTRIBUTING.md +213 -24
- data/FUNDING.md +77 -0
- data/{LICENSE → LICENSE.txt} +1 -1
- data/README.md +543 -275
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +27 -11
- data/lib/oauth/client/action_controller_request.rb +14 -9
- data/lib/oauth/client/em_http.rb +106 -99
- data/lib/oauth/client/helper.rb +15 -11
- data/lib/oauth/client/net_http.rb +39 -13
- data/lib/oauth/consumer.rb +105 -54
- data/lib/oauth/errors/problem.rb +1 -1
- data/lib/oauth/helper.rb +25 -3
- data/lib/oauth/oauth.rb +28 -6
- data/lib/oauth/optional.rb +20 -0
- data/lib/oauth/request_proxy/action_controller_request.rb +11 -7
- data/lib/oauth/request_proxy/action_dispatch_request.rb +41 -0
- data/lib/oauth/request_proxy/base.rb +15 -12
- data/lib/oauth/request_proxy/em_http_request.rb +53 -52
- data/lib/oauth/request_proxy/jabber_request.rb +9 -2
- data/lib/oauth/request_proxy/net_http.rb +1 -1
- data/lib/oauth/request_proxy/rest_client_request.rb +4 -3
- data/lib/oauth/server.rb +12 -8
- data/lib/oauth/signature/base.rb +1 -1
- data/lib/oauth/signature/rsa/sha1.rb +11 -4
- data/lib/oauth/tokens/access_token.rb +1 -1
- data/lib/oauth/tokens/consumer_token.rb +2 -2
- data/lib/oauth/tokens/request_token.rb +9 -4
- data/lib/oauth/version.rb +1 -1
- data.tar.gz.sig +0 -0
- metadata +246 -81
- metadata.gz.sig +3 -0
- data/TODO +0 -32
data/README.md
CHANGED
|
@@ -1,243 +1,184 @@
|
|
|
1
|
-
|
|
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
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![oauth Logo by Chris Messina, CC BY-SA 3.0][🖼️oauth-i]][🖼️oauth]
|
|
9
2
|
|
|
10
|
-
|
|
3
|
+
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
4
|
+
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
|
5
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
6
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
+
[🖼️oauth-i]: https://logos.galtzo.com/assets/images/oauth/avatar-192px.svg
|
|
8
|
+
[🖼️oauth]: https://github.com/ruby-oauth/oauth
|
|
11
9
|
|
|
12
|
-
OAuth 1.0
|
|
10
|
+
# 🔑 Ruby OAuth 1.0 / 1.0a
|
|
13
11
|
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI 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 Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
13
|
+
|
|
14
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
`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.
|
|
19
|
+
|
|
20
|
+
[![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]
|
|
21
|
+
|
|
22
|
+
## 🌻 Synopsis
|
|
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.
|
|
16
31
|
|
|
17
32
|
* [OAuth 1.0 Spec][oauth1-spec]
|
|
33
|
+
* [oauth-tty sibling gem][sibling2-gem] is the OAuth 1.0 / 1.0a CLI.
|
|
18
34
|
* [oauth2 sibling gem][sibling-gem] for OAuth 2.0 implementations in Ruby.
|
|
19
35
|
|
|
20
36
|
[oauth1-spec]: http://oauth.net/core/1.0/
|
|
21
|
-
[sibling-gem]: https://
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
|
65
|
-
|
|
66
|
-
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
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
|
|
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).
|
|
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.1 Compat][💎jruby-9.1i] ![JRuby 9.2 Compat][💎jruby-9.2i] ![JRuby 9.3 Compat][💎jruby-9.3i] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
|
|
73
|
+
| Works with Truffle Ruby | ![Truffle Ruby 22.3 Compat][💎truby-22.3i] ![Truffle Ruby 23.0 Compat][💎truby-23.0i] <br/> [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
|
|
74
|
+
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
|
|
75
|
+
| Works with MRI Ruby 2 | [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎1-an-wf] [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎1-an-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎1-an-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎7-us-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf] |
|
|
76
|
+
| 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] |
|
|
77
|
+
| 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] |
|
|
78
|
+
| 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] |
|
|
79
|
+
| Compliance | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
80
|
+
| 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] |
|
|
81
|
+
| 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] |
|
|
82
|
+
| `...` 💖 | [![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] |
|
|
83
|
+
|
|
84
|
+
### Compatibility
|
|
85
|
+
|
|
86
|
+
Compatible with MRI Ruby 2.3+, and concordant releases of JRuby, and TruffleRuby.
|
|
87
|
+
|
|
88
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
89
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
90
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
91
|
+
|
|
92
|
+
### Federated DVCS
|
|
160
93
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
[peterboling]: http://www.peterboling.com
|
|
94
|
+
<details>
|
|
95
|
+
<summary>Find this repo on federated forges</summary>
|
|
164
96
|
|
|
165
|
-
|
|
97
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
98
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
99
|
+
| 🧪 [ruby-oauth/oauth on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
100
|
+
| 🧊 [ruby-oauth/oauth on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
101
|
+
| 🐙 [ruby-oauth/oauth on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
102
|
+
| 🤼 [OAuth Ruby Google Group][⛳gg-discussions] | "Active" | ➖ | ➖ | ➖ | ➖ | [💚][⛳gg-discussions] |
|
|
103
|
+
| 🎮️ [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] |
|
|
166
104
|
|
|
167
|
-
|
|
105
|
+
</details>
|
|
168
106
|
|
|
169
|
-
|
|
107
|
+
[gh-discussions]: https://github.com/ruby-oauth/oauth/discussions
|
|
170
108
|
|
|
171
|
-
|
|
109
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=readme)
|
|
172
110
|
|
|
173
|
-
|
|
111
|
+
Available as part of the Tidelift Subscription.
|
|
174
112
|
|
|
175
|
-
|
|
113
|
+
<details>
|
|
114
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
176
115
|
|
|
177
|
-
|
|
116
|
+
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.
|
|
178
117
|
|
|
179
|
-
|
|
118
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
180
119
|
|
|
181
|
-
|
|
120
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
121
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
122
|
+
- 💡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
|
|
182
123
|
|
|
183
|
-
|
|
184
|
-
Tidelift will coordinate the fix and disclosure.
|
|
124
|
+
Alternatively:
|
|
185
125
|
|
|
186
|
-
|
|
126
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
127
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
128
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
187
129
|
|
|
188
|
-
|
|
130
|
+
</details>
|
|
189
131
|
|
|
190
|
-
|
|
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.
|
|
132
|
+
## ✨ Installation
|
|
193
133
|
|
|
194
|
-
|
|
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.
|
|
134
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
197
135
|
|
|
198
|
-
|
|
136
|
+
```console
|
|
137
|
+
bundle add oauth
|
|
138
|
+
```
|
|
199
139
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
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>
|
|
140
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
141
|
+
|
|
142
|
+
```console
|
|
143
|
+
gem install oauth
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### 🔒 Secure Installation
|
|
210
147
|
|
|
211
148
|
<details>
|
|
212
|
-
<summary>
|
|
149
|
+
<summary>For Medium or High Security Installations</summary>
|
|
213
150
|
|
|
214
|
-
|
|
151
|
+
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
|
152
|
+
[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
|
153
|
+
by following the instructions below.
|
|
215
154
|
|
|
216
|
-
|
|
217
|
-
implementations, however support will only be provided for the versions listed
|
|
218
|
-
above.
|
|
155
|
+
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
|
|
219
156
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
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
|
-
</details>
|
|
157
|
+
```console
|
|
158
|
+
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
|
159
|
+
```
|
|
227
160
|
|
|
228
|
-
|
|
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 |
|
|
161
|
+
You only need to do that once. Then proceed to install with:
|
|
234
162
|
|
|
235
|
-
|
|
236
|
-
|
|
163
|
+
```console
|
|
164
|
+
gem install oauth -P HighSecurity
|
|
165
|
+
```
|
|
237
166
|
|
|
238
|
-
|
|
167
|
+
The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
|
|
168
|
+
|
|
169
|
+
If you want to up your security game full-time:
|
|
170
|
+
|
|
171
|
+
```console
|
|
172
|
+
bundle config set --global trust-policy MediumSecurity
|
|
173
|
+
```
|
|
239
174
|
|
|
240
|
-
|
|
175
|
+
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
|
176
|
+
|
|
177
|
+
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
|
178
|
+
|
|
179
|
+
</details>
|
|
180
|
+
|
|
181
|
+
## ⚙️ Configuration
|
|
241
182
|
|
|
242
183
|
This is a ruby library which is intended to be used in creating Ruby Consumer
|
|
243
184
|
and Service Provider applications. It is NOT a Rails plugin, but could easily
|
|
@@ -250,11 +191,13 @@ Unfortunately, this gem does have some Rails related bits that are
|
|
|
250
191
|
**optional** to load. You don't need Rails! The Rails bits may be pulled out
|
|
251
192
|
into a separate gem with the 1.x minor updates of this gem.
|
|
252
193
|
|
|
253
|
-
##
|
|
194
|
+
## 🔧 Basic Usage
|
|
195
|
+
|
|
196
|
+
### Extensions
|
|
254
197
|
|
|
255
|
-
* [oauth-tty (on Gitlab)](https://gitlab.com/oauth
|
|
198
|
+
* [oauth-tty (on Gitlab)](https://gitlab.com/ruby-oauth/oauth-tty) ([rubygems.org](https://rubygems.org/gems/oauth-tty))
|
|
256
199
|
|
|
257
|
-
|
|
200
|
+
### Examples
|
|
258
201
|
|
|
259
202
|
We need to specify the `oauth_callback` url explicitly, otherwise it defaults to
|
|
260
203
|
"oob" (Out of Band)
|
|
@@ -282,7 +225,7 @@ redirect_to request_token.authorize_url(oauth_callback: callback_url)
|
|
|
282
225
|
When user returns create an access_token
|
|
283
226
|
|
|
284
227
|
```ruby
|
|
285
|
-
hash = {
|
|
228
|
+
hash = {oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
|
|
286
229
|
request_token = OAuth::RequestToken.from_hash(oauth_consumer, hash)
|
|
287
230
|
access_token = request_token.get_access_token
|
|
288
231
|
# For 3-legged authorization, flow oauth_verifier is passed as param in callback
|
|
@@ -296,7 +239,7 @@ OAuth provider if you choose.
|
|
|
296
239
|
```ruby
|
|
297
240
|
require "typhoeus"
|
|
298
241
|
require "oauth/request_proxy/typhoeus_request"
|
|
299
|
-
oauth_params = {
|
|
242
|
+
oauth_params = {consumer: oauth_consumer, token: access_token}
|
|
300
243
|
hydra = Typhoeus::Hydra.new
|
|
301
244
|
req = Typhoeus::Request.new(uri, options) # :method needs to be specified in options
|
|
302
245
|
oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(request_uri: uri))
|
|
@@ -306,85 +249,410 @@ hydra.run
|
|
|
306
249
|
@response = req.response
|
|
307
250
|
```
|
|
308
251
|
|
|
309
|
-
|
|
252
|
+
### More Information
|
|
253
|
+
|
|
254
|
+
* RubyDoc Documentation: [![RubyDoc.info][🚎yard-img]][🚎yard]
|
|
255
|
+
* Mailing List/Google Group: [![Mailing List][⛳mail-list-img]][⛳mail-list]
|
|
256
|
+
* Live Chat on Gitter: [![Join the chat at https://gitter.im/ruby-oauth/oauth-ruby][🏘chat-img]][🏘chat]
|
|
257
|
+
* Maintainer's Blog: [![Blog][🚎blog-img]][🚎blog]
|
|
258
|
+
|
|
259
|
+
## 🦷 FLOSS Funding
|
|
260
|
+
|
|
261
|
+
While ruby-oauth tools are free software and will always be, the project would benefit immensely from some funding.
|
|
262
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
263
|
+
|
|
264
|
+
We welcome both individual and corporate sponsors! We also offer a
|
|
265
|
+
wide array of funding channels to account for your preferences
|
|
266
|
+
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
|
267
|
+
|
|
268
|
+
**If you're working in a company that's making significant use of ruby-oauth tools we'd
|
|
269
|
+
appreciate it if you suggest to your company to become a ruby-oauth sponsor.**
|
|
270
|
+
|
|
271
|
+
You can support the development of ruby-oauth tools via
|
|
272
|
+
[GitHub Sponsors][🖇sponsor],
|
|
273
|
+
[Liberapay][⛳liberapay],
|
|
274
|
+
[PayPal][🖇paypal],
|
|
275
|
+
[Open Collective][🖇osc]
|
|
276
|
+
and [Tidelift][🏙️entsup-tidelift].
|
|
277
|
+
|
|
278
|
+
| 📍 NOTE |
|
|
279
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
280
|
+
| 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. |
|
|
281
|
+
|
|
282
|
+
### Open Collective for Individuals
|
|
283
|
+
|
|
284
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/ruby-oauth#backer)]
|
|
285
|
+
|
|
286
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
287
|
+
|
|
288
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
289
|
+
No backers yet. Be the first!
|
|
290
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
291
|
+
|
|
292
|
+
### Open Collective for Organizations
|
|
293
|
+
|
|
294
|
+
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)]
|
|
310
295
|
|
|
311
|
-
|
|
312
|
-
* Mailing List/Google Group: [][mailinglist]
|
|
313
|
-
* GitHub Discussions: [][gh_discussions]
|
|
314
|
-
* Live Chat on Gitter: [][chat]
|
|
315
|
-
* Maintainer's Blog: [][blogpage]
|
|
296
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
316
297
|
|
|
317
|
-
|
|
298
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
299
|
+
No sponsors yet. Be the first!
|
|
318
300
|
|
|
319
|
-
|
|
301
|
+
### Open Collective for Donors
|
|
320
302
|
|
|
321
|
-
|
|
303
|
+
[Bill Woika](https://opencollective.com/bill-woika)
|
|
304
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
322
305
|
|
|
323
|
-
[
|
|
306
|
+
[kettle-readme-backers]: https://github.com/ruby-oauth/oauth/blob/main/exe/kettle-readme-backers
|
|
324
307
|
|
|
325
|
-
|
|
308
|
+
### Another way to support open-source
|
|
326
309
|
|
|
327
|
-
|
|
310
|
+
> How wonderful it is that nobody need wait a single moment before starting to improve the world.<br/>
|
|
311
|
+
>—Anne Frank
|
|
328
312
|
|
|
329
|
-
|
|
313
|
+
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 — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. 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).
|
|
330
314
|
|
|
331
|
-
|
|
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.
|
|
315
|
+
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`.
|
|
335
316
|
|
|
336
|
-
|
|
337
|
-
|
|
317
|
+
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.
|
|
318
|
+
|
|
319
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
320
|
+
|
|
321
|
+
[![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 or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
|
|
322
|
+
|
|
323
|
+
## 🔐 Security
|
|
324
|
+
|
|
325
|
+
See [SECURITY.md][🔐security].
|
|
326
|
+
|
|
327
|
+
## 🤝 Contributing
|
|
328
|
+
|
|
329
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
330
|
+
or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
|
331
|
+
or use the gem and think about how it could be better.
|
|
332
|
+
|
|
333
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
334
|
+
|
|
335
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
336
|
+
|
|
337
|
+
### 🚀 Release Instructions
|
|
338
|
+
|
|
339
|
+
See [CONTRIBUTING.md][🤝contributing].
|
|
340
|
+
|
|
341
|
+
### Code Coverage
|
|
342
|
+
|
|
343
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
344
|
+
|
|
345
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
346
|
+
|
|
347
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
348
|
+
|
|
349
|
+
### 🪇 Code of Conduct
|
|
350
|
+
|
|
351
|
+
Everyone interacting with this project's codebases, issue trackers,
|
|
352
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
353
|
+
|
|
354
|
+
## 🌈 Contributors
|
|
355
|
+
|
|
356
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
357
|
+
|
|
358
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
359
|
+
|
|
360
|
+
Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/oauth/-/graphs/main][🚎contributors-gl]
|
|
361
|
+
|
|
362
|
+
<details>
|
|
363
|
+
<summary>⭐️ Star History</summary>
|
|
364
|
+
|
|
365
|
+
<a href="https://star-history.com/#ruby-oauth/oauth&Date">
|
|
366
|
+
<picture>
|
|
367
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date&theme=dark" />
|
|
368
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date" />
|
|
369
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ruby-oauth/oauth&type=Date" />
|
|
370
|
+
</picture>
|
|
371
|
+
</a>
|
|
372
|
+
|
|
373
|
+
</details>
|
|
374
|
+
|
|
375
|
+
## 📌 Versioning
|
|
376
|
+
|
|
377
|
+
This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
|
|
378
|
+
Violations of this scheme should be reported as bugs.
|
|
379
|
+
Specifically, if a minor or patch version is released that breaks backward compatibility,
|
|
380
|
+
a new version should be immediately released that restores compatibility.
|
|
381
|
+
Breaking changes to the public API will only be introduced with new major versions.
|
|
382
|
+
|
|
383
|
+
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
|
384
|
+
>—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
|
385
|
+
|
|
386
|
+
I understand that policy doesn't work universally ("exceptions to every rule!"),
|
|
387
|
+
but it is the policy here.
|
|
388
|
+
As such, in many cases it is good to specify a dependency on this library using
|
|
389
|
+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
338
390
|
|
|
339
391
|
For example:
|
|
340
392
|
|
|
341
393
|
```ruby
|
|
342
|
-
spec.add_dependency
|
|
394
|
+
spec.add_dependency("oauth", "~> 1.0")
|
|
343
395
|
```
|
|
344
396
|
|
|
345
|
-
|
|
397
|
+
<details>
|
|
398
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
399
|
+
|
|
400
|
+
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
|
|
401
|
+
is a *breaking change* to an API.
|
|
402
|
+
It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
|
|
403
|
+
|
|
404
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
405
|
+
read this article from the creator of SemVer:
|
|
406
|
+
|
|
407
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
408
|
+
|
|
409
|
+
</details>
|
|
410
|
+
|
|
411
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
412
|
+
|
|
413
|
+
## 📄 License
|
|
346
414
|
|
|
347
415
|
The gem is available as open source under the terms of
|
|
348
|
-
the [MIT License][license] [![License: MIT]
|
|
349
|
-
See [LICENSE][license] for the [Copyright Notice][copyright-notice-explainer].
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
[
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
[
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
[
|
|
390
|
-
[
|
|
416
|
+
the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
|
|
417
|
+
See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
|
|
418
|
+
|
|
419
|
+
### © Copyright
|
|
420
|
+
|
|
421
|
+
<ul>
|
|
422
|
+
<li>
|
|
423
|
+
Copyright (c) 2020-2022, 2024-2025 Peter H. Boling, of
|
|
424
|
+
<a href="https://discord.gg/3qme4XHNKN">
|
|
425
|
+
Galtzo.com
|
|
426
|
+
<picture>
|
|
427
|
+
<img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
|
|
428
|
+
</picture>
|
|
429
|
+
</a>, and oauth contributors.
|
|
430
|
+
</li>
|
|
431
|
+
<li>
|
|
432
|
+
Copyright (c) 2007-2012, 2016-2017 Blaine Cook, Larry Halff, Pelle Braendgaard
|
|
433
|
+
</li>
|
|
434
|
+
</ul>
|
|
435
|
+
|
|
436
|
+
## 🤑 A request for help
|
|
437
|
+
|
|
438
|
+
Maintainers have teeth and need to pay their dentists.
|
|
439
|
+
After getting laid off in an RIF in March and filled with many dozens of rejections,
|
|
440
|
+
I'm now spending ~60+ hours a week building open source tools.
|
|
441
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
442
|
+
so if you value the work I am doing, I need your support.
|
|
443
|
+
Please consider sponsoring me or the project.
|
|
444
|
+
|
|
445
|
+
To join the community or get help 👇️ Join the Discord.
|
|
446
|
+
|
|
447
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
448
|
+
|
|
449
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
450
|
+
|
|
451
|
+
[![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-img] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal-img]
|
|
452
|
+
|
|
453
|
+
### Please give the project a star ⭐ ♥.
|
|
454
|
+
|
|
455
|
+
Thanks for RTFM. ☺️
|
|
456
|
+
|
|
457
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
458
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
459
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
460
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/ruby-oauth
|
|
461
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth
|
|
462
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/ruby-oauth
|
|
463
|
+
[🖇osc-backers]: https://opencollective.com/ruby-oauth#backer
|
|
464
|
+
[🖇osc-backers-i]: https://opencollective.com/ruby-oauth/backers/badge.svg?style=flat
|
|
465
|
+
[🖇osc-sponsors]: https://opencollective.com/ruby-oauth#sponsor
|
|
466
|
+
[🖇osc-sponsors-i]: https://opencollective.com/ruby-oauth/sponsors/badge.svg?style=flat
|
|
467
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/ruby-oauth?style=for-the-badge
|
|
468
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth?style=for-the-badge
|
|
469
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/ruby-oauth?style=for-the-badge
|
|
470
|
+
[🖇osc]: https://opencollective.com/ruby-oauth
|
|
471
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
472
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
473
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
474
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
475
|
+
[🖇polar]: https://polar.sh/pboling
|
|
476
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
477
|
+
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
|
478
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
479
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
480
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
481
|
+
[🖇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
|
|
482
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
483
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
484
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
485
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
486
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
487
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
488
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
489
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
490
|
+
[✉️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
|
|
491
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
492
|
+
|
|
493
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
494
|
+
[⛳️gem-namespace]: https://github.com/ruby-oauth/oauth
|
|
495
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Oauth-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
496
|
+
[⛳️gem-name]: https://rubygems.org/gems/oauth
|
|
497
|
+
[⛳️name-img]: https://img.shields.io/badge/name-oauth-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
498
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/ruby-oauth/oauth.svg
|
|
499
|
+
[⛳️tag]: http://github.com/ruby-oauth/oauth/releases
|
|
500
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/oauth
|
|
501
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
502
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
503
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
504
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
505
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
|
|
506
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
507
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
508
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
509
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
510
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
511
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
512
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
513
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
514
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
515
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
|
516
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
|
517
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
|
518
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
|
519
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
|
520
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
|
521
|
+
[💖🐙hub]: https://github.org/pboling
|
|
522
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
|
523
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
|
524
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
|
525
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
526
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
527
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
528
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=readme
|
|
529
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
530
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
531
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
532
|
+
[🚂railsbling]: http://www.railsbling.com
|
|
533
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
534
|
+
[📜src-gl]: https://gitlab.com/ruby-oauth/oauth/
|
|
535
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
536
|
+
[📜src-cb]: https://codeberg.org/ruby-oauth/oauth
|
|
537
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
|
538
|
+
[📜src-gh]: https://github.com/ruby-oauth/oauth
|
|
539
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
540
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
541
|
+
[📜gl-wiki]: https://gitlab.com/ruby-oauth/oauth/-/wikis/home
|
|
542
|
+
[📜gh-wiki]: https://github.com/ruby-oauth/oauth/wiki
|
|
543
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
544
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
545
|
+
[👽dl-rank]: https://rubygems.org/gems/oauth
|
|
546
|
+
[👽dl-ranki]: https://img.shields.io/gem/rd/oauth.svg
|
|
547
|
+
[👽oss-help]: https://www.codetriage.com/ruby-oauth/oauth
|
|
548
|
+
[👽oss-helpi]: https://www.codetriage.com/ruby-oauth/oauth/badges/users.svg
|
|
549
|
+
[👽version]: https://rubygems.org/gems/oauth
|
|
550
|
+
[👽versioni]: https://img.shields.io/gem/v/oauth.svg
|
|
551
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/ruby-oauth/projects/oauth
|
|
552
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/ruby-oauth/projects/oauth/maintainability.svg
|
|
553
|
+
[🏀qlty-cov]: https://qlty.sh/gh/ruby-oauth/projects/oauth/metrics/code?sort=coverageRating
|
|
554
|
+
[🏀qlty-covi]: https://qlty.sh/gh/ruby-oauth/projects/oauth/coverage.svg
|
|
555
|
+
[🏀codecov]: https://codecov.io/gh/ruby-oauth/oauth
|
|
556
|
+
[🏀codecovi]: https://codecov.io/gh/ruby-oauth/oauth/graph/badge.svg
|
|
557
|
+
[🏀coveralls]: https://coveralls.io/github/ruby-oauth/oauth?branch=main
|
|
558
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/ruby-oauth/oauth/badge.svg?branch=main
|
|
559
|
+
[🖐codeQL]: https://github.com/ruby-oauth/oauth/security/code-scanning
|
|
560
|
+
[🖐codeQL-img]: https://github.com/ruby-oauth/oauth/actions/workflows/codeql-analysis.yml/badge.svg
|
|
561
|
+
[🚎1-an-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/ancient.yml
|
|
562
|
+
[🚎1-an-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/ancient.yml/badge.svg
|
|
563
|
+
[🚎2-cov-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/coverage.yml
|
|
564
|
+
[🚎2-cov-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/coverage.yml/badge.svg
|
|
565
|
+
[🚎3-hd-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/heads.yml
|
|
566
|
+
[🚎3-hd-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/heads.yml/badge.svg
|
|
567
|
+
[🚎4-lg-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/legacy.yml
|
|
568
|
+
[🚎4-lg-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/legacy.yml/badge.svg
|
|
569
|
+
[🚎5-st-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/style.yml
|
|
570
|
+
[🚎5-st-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/style.yml/badge.svg
|
|
571
|
+
[🚎6-s-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/supported.yml
|
|
572
|
+
[🚎6-s-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/supported.yml/badge.svg
|
|
573
|
+
[🚎7-us-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/unsupported.yml
|
|
574
|
+
[🚎7-us-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/unsupported.yml/badge.svg
|
|
575
|
+
[🚎8-ho-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/hoary.yml
|
|
576
|
+
[🚎8-ho-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/hoary.yml/badge.svg
|
|
577
|
+
[🚎9-t-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/truffle.yml
|
|
578
|
+
[🚎9-t-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/truffle.yml/badge.svg
|
|
579
|
+
[🚎10-j-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby.yml
|
|
580
|
+
[🚎10-j-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/jruby.yml/badge.svg
|
|
581
|
+
[🚎11-c-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/current.yml
|
|
582
|
+
[🚎11-c-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/current.yml/badge.svg
|
|
583
|
+
[🚎12-crh-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/dep-heads.yml
|
|
584
|
+
[🚎12-crh-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/dep-heads.yml/badge.svg
|
|
585
|
+
[🚎13-🔒️-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/locked_deps.yml
|
|
586
|
+
[🚎13-🔒️-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/locked_deps.yml/badge.svg
|
|
587
|
+
[🚎14-🔓️-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/unlocked_deps.yml
|
|
588
|
+
[🚎14-🔓️-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/unlocked_deps.yml/badge.svg
|
|
589
|
+
[🚎15-🪪-wf]: https://github.com/ruby-oauth/oauth/actions/workflows/license-eye.yml
|
|
590
|
+
[🚎15-🪪-wfi]: https://github.com/ruby-oauth/oauth/actions/workflows/license-eye.yml/badge.svg
|
|
591
|
+
[💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
592
|
+
[💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
593
|
+
[💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
594
|
+
[💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
595
|
+
[💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
596
|
+
[💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
597
|
+
[💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
598
|
+
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
599
|
+
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
600
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
601
|
+
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
602
|
+
[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
603
|
+
[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
604
|
+
[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
605
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
606
|
+
[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
|
|
607
|
+
[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
608
|
+
[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
609
|
+
[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
610
|
+
[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
|
|
611
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
612
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
613
|
+
[🤝gh-issues]: https://github.com/ruby-oauth/oauth/issues
|
|
614
|
+
[🤝gh-pulls]: https://github.com/ruby-oauth/oauth/pulls
|
|
615
|
+
[🤝gl-issues]: https://gitlab.com/ruby-oauth/oauth/-/issues
|
|
616
|
+
[🤝gl-pulls]: https://gitlab.com/ruby-oauth/oauth/-/merge_requests
|
|
617
|
+
[🤝cb-issues]: https://codeberg.org/ruby-oauth/oauth/issues
|
|
618
|
+
[🤝cb-pulls]: https://codeberg.org/ruby-oauth/oauth/pulls
|
|
619
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
620
|
+
[🤝contributing]: CONTRIBUTING.md
|
|
621
|
+
[🏀codecov-g]: https://codecov.io/gh/ruby-oauth/oauth/graphs/tree.svg
|
|
622
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
623
|
+
[🖐contributors]: https://github.com/ruby-oauth/oauth/graphs/contributors
|
|
624
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/oauth
|
|
625
|
+
[🚎contributors-gl]: https://gitlab.com/ruby-oauth/oauth/-/graphs/main
|
|
626
|
+
[🪇conduct]: CODE_OF_CONDUCT.md
|
|
627
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
628
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
629
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
630
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
631
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
632
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
633
|
+
[📌changelog]: CHANGELOG.md
|
|
634
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
635
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
636
|
+
[📌gitmoji]:https://gitmoji.dev
|
|
637
|
+
[📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
638
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
639
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.000-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
640
|
+
[🔐security]: SECURITY.md
|
|
641
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
642
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
643
|
+
[📄license]: LICENSE.txt
|
|
644
|
+
[📄license-ref]: https://opensource.org/licenses/MIT
|
|
645
|
+
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
646
|
+
[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
|
|
647
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
|
|
648
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
649
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
650
|
+
[🚎yard-current]: http://rubydoc.info/gems/oauth
|
|
651
|
+
[🚎yard-head]: https://oauth.galtzo.com
|
|
652
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
653
|
+
[💎SHA_checksums]: https://gitlab.com/ruby-oauth/oauth/-/tree/main/checksums
|
|
654
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
655
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
656
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
657
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
658
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|