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