oauth2 2.0.9 → 2.0.22
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 +3 -0
- data/CHANGELOG.md +833 -182
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +24 -23
- data/CONTRIBUTING.md +262 -34
- data/FUNDING.md +74 -0
- data/LICENSE.md +110 -0
- data/README.md +923 -351
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +11 -16
- data/certs/pboling.pem +27 -0
- data/lib/oauth2/access_token.rb +233 -38
- data/lib/oauth2/auth_sanitizer.rb +36 -0
- data/lib/oauth2/authenticator.rb +43 -9
- data/lib/oauth2/client.rb +353 -97
- data/lib/oauth2/error.rb +37 -17
- data/lib/oauth2/filtered_attributes.rb +10 -0
- data/lib/oauth2/response.rb +87 -49
- data/lib/oauth2/strategy/assertion.rb +10 -7
- data/lib/oauth2/strategy/auth_code.rb +13 -3
- data/lib/oauth2/strategy/client_credentials.rb +2 -2
- data/lib/oauth2/strategy/implicit.rb +11 -3
- data/lib/oauth2/strategy/password.rb +14 -4
- data/lib/oauth2/version.rb +2 -1
- data/lib/oauth2.rb +86 -23
- data/sig/oauth2/access_token.rbs +25 -0
- data/sig/oauth2/authenticator.rbs +22 -0
- data/sig/oauth2/client.rbs +52 -0
- data/sig/oauth2/error.rbs +8 -0
- data/sig/oauth2/filtered_attributes.rbs +11 -0
- data/sig/oauth2/response.rbs +18 -0
- data/sig/oauth2/sanitized_logger.rbs +32 -0
- data/sig/oauth2/strategy.rbs +34 -0
- data/sig/oauth2/thing_filter.rbs +10 -0
- data/sig/oauth2/version.rbs +6 -0
- data/sig/oauth2.rbs +9 -0
- data.tar.gz.sig +0 -0
- metadata +270 -76
- metadata.gz.sig +0 -0
- data/LICENSE +0 -22
data/CITATION.cff
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: "oauth2"
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this work and you want to cite it,
|
|
5
|
+
then you can use the metadata from this file.
|
|
6
|
+
type: software
|
|
7
|
+
authors:
|
|
8
|
+
- given-names: "Peter H."
|
|
9
|
+
family-names: "Boling"
|
|
10
|
+
email: "floss@galtzo.com"
|
|
11
|
+
affiliation: "galtzo.com"
|
|
12
|
+
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
|
+
identifiers:
|
|
14
|
+
- type: url
|
|
15
|
+
value: 'https://github.com/ruby-oauth/oauth2'
|
|
16
|
+
description: "oauth2"
|
|
17
|
+
repository-code: 'https://github.com/ruby-oauth/oauth2'
|
|
18
|
+
abstract: >-
|
|
19
|
+
oauth2
|
|
20
|
+
license: See license file
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
|
|
2
1
|
# Contributor Covenant Code of Conduct
|
|
3
2
|
|
|
4
3
|
## Our Pledge
|
|
@@ -7,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
|
|
|
7
6
|
community a harassment-free experience for everyone, regardless of age, body
|
|
8
7
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
9
8
|
identity and expression, level of experience, education, socio-economic status,
|
|
10
|
-
nationality, personal appearance, race, religion, or sexual
|
|
11
|
-
and orientation.
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
12
11
|
|
|
13
12
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
14
13
|
diverse, inclusive, and healthy community.
|
|
@@ -23,17 +22,17 @@ community include:
|
|
|
23
22
|
* Giving and gracefully accepting constructive feedback
|
|
24
23
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
25
24
|
and learning from the experience
|
|
26
|
-
* Focusing on what is best not just for us as individuals, but for the
|
|
27
|
-
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
28
27
|
|
|
29
28
|
Examples of unacceptable behavior include:
|
|
30
29
|
|
|
31
|
-
* The use of sexualized language or imagery, and sexual attention or
|
|
32
|
-
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
33
32
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
34
33
|
* Public or private harassment
|
|
35
|
-
* Publishing others' private information, such as a physical or email
|
|
36
|
-
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
37
36
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
38
37
|
professional setting
|
|
39
38
|
|
|
@@ -53,7 +52,7 @@ decisions when appropriate.
|
|
|
53
52
|
|
|
54
53
|
This Code of Conduct applies within all community spaces, and also applies when
|
|
55
54
|
an individual is officially representing the community in public spaces.
|
|
56
|
-
Examples of representing our community include using an official
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
57
56
|
posting via an official social media account, or acting as an appointed
|
|
58
57
|
representative at an online or offline event.
|
|
59
58
|
|
|
@@ -61,7 +60,7 @@ representative at an online or offline event.
|
|
|
61
60
|
|
|
62
61
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
63
62
|
reported to the community leaders responsible for enforcement at
|
|
64
|
-
[
|
|
63
|
+
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
|
|
65
64
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
66
65
|
|
|
67
66
|
All community leaders are obligated to respect the privacy and security of the
|
|
@@ -83,15 +82,15 @@ behavior was inappropriate. A public apology may be requested.
|
|
|
83
82
|
|
|
84
83
|
### 2. Warning
|
|
85
84
|
|
|
86
|
-
**Community Impact**: A violation through a single incident or series
|
|
87
|
-
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
88
87
|
|
|
89
88
|
**Consequence**: A warning with consequences for continued behavior. No
|
|
90
89
|
interaction with the people involved, including unsolicited interaction with
|
|
91
90
|
those enforcing the Code of Conduct, for a specified period of time. This
|
|
92
91
|
includes avoiding interactions in community spaces as well as external channels
|
|
93
|
-
like social media. Violating these terms may lead to a temporary or
|
|
94
|
-
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
95
94
|
|
|
96
95
|
### 3. Temporary Ban
|
|
97
96
|
|
|
@@ -107,27 +106,29 @@ Violating these terms may lead to a permanent ban.
|
|
|
107
106
|
### 4. Permanent Ban
|
|
108
107
|
|
|
109
108
|
**Community Impact**: Demonstrating a pattern of violation of community
|
|
110
|
-
standards, including sustained inappropriate behavior,
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
111
110
|
individual, or aggression toward or disparagement of classes of individuals.
|
|
112
111
|
|
|
113
|
-
**Consequence**: A permanent ban from any sort of public interaction within
|
|
114
|
-
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
115
114
|
|
|
116
115
|
## Attribution
|
|
117
116
|
|
|
118
117
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
119
|
-
version 2.
|
|
120
|
-
[https://www.contributor-covenant.org/version/2/
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
121
120
|
|
|
122
121
|
Community Impact Guidelines were inspired by
|
|
123
122
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
124
123
|
|
|
125
124
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
126
|
-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
|
127
|
-
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
128
127
|
|
|
129
128
|
[homepage]: https://www.contributor-covenant.org
|
|
130
|
-
[v2.
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
131
130
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
132
131
|
[FAQ]: https://www.contributor-covenant.org/faq
|
|
133
132
|
[translations]: https://www.contributor-covenant.org/translations
|
|
133
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
134
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,44 +1,272 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
Bug reports and pull requests are welcome on GitLab
|
|
4
|
-
|
|
5
|
-
the [code of conduct][conduct].
|
|
6
|
-
|
|
7
|
-
To submit a patch, please fork the project
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
|
|
4
|
+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
|
+
the [code of conduct][🤝conduct].
|
|
6
|
+
|
|
7
|
+
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
8
|
+
|
|
9
|
+
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
10
|
+
|
|
11
|
+
## Developer Certificate of Origin
|
|
12
|
+
|
|
13
|
+
In order to protect users of this project, we require all contributors to comply with the
|
|
14
|
+
[Developer Certificate of Origin](https://developercertificate.org/).
|
|
15
|
+
This ensures that all contributions are properly licensed and attributed.
|
|
16
|
+
|
|
17
|
+
## Help out!
|
|
18
|
+
|
|
19
|
+
Take a look at the open issues and pull requests, or use the gem and find something to improve.
|
|
20
|
+
|
|
21
|
+
Follow these instructions:
|
|
22
|
+
|
|
23
|
+
1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
24
|
+
2. Fork the repository
|
|
25
|
+
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
26
|
+
4. Make some fixes.
|
|
27
|
+
5. Commit your changes (`git commit -am 'Added some feature'`)
|
|
28
|
+
6. Push to the branch (`git push origin my-new-feature`)
|
|
29
|
+
7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
30
|
+
8. Create new Pull Request.
|
|
31
|
+
9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
|
|
32
|
+
|
|
33
|
+
## Executables vs Rake tasks
|
|
34
|
+
|
|
35
|
+
Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
|
|
36
|
+
after running `bin/setup`. These include:
|
|
37
|
+
|
|
38
|
+
- gem_checksums
|
|
39
|
+
- kettle-changelog
|
|
40
|
+
- kettle-commit-msg
|
|
41
|
+
- kettle-dev-setup
|
|
42
|
+
- kettle-dvcs
|
|
43
|
+
- kettle-pre-release
|
|
44
|
+
- kettle-readme-backers
|
|
45
|
+
- kettle-release
|
|
46
|
+
|
|
47
|
+
There are many Rake tasks available as well. You can see them by running:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
bin/rake -T
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Code quality checks
|
|
54
|
+
|
|
55
|
+
Run the Reek task when you want a smell check that fails on current findings:
|
|
56
|
+
|
|
57
|
+
```shell
|
|
58
|
+
bin/rake reek
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
|
|
62
|
+
the raw `reek` executable output. The rake task uses the project bundle and
|
|
63
|
+
avoids stale generated binstubs shadowing the Reek gem executable:
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
bin/rake reek:update
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Environment Variables for Local Development
|
|
70
|
+
|
|
71
|
+
Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
|
|
72
|
+
|
|
73
|
+
General/runtime
|
|
74
|
+
- DEBUG: Enable extra internal logging for this library (default: false)
|
|
75
|
+
- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
|
|
76
|
+
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
77
|
+
|
|
78
|
+
Coverage (kettle-soup-cover / SimpleCov)
|
|
79
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
|
|
80
|
+
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
81
|
+
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
82
|
+
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
83
|
+
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
|
|
84
|
+
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
|
|
85
|
+
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
|
|
86
|
+
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
|
|
87
|
+
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
|
|
88
|
+
|
|
89
|
+
GitHub API and CI helpers
|
|
90
|
+
- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
|
|
91
|
+
|
|
92
|
+
Releasing and signing
|
|
93
|
+
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
94
|
+
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
95
|
+
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
96
|
+
- `kettle-release` will set this automatically for the session.
|
|
97
|
+
- Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
|
|
98
|
+
|
|
99
|
+
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
100
|
+
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
101
|
+
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
|
|
102
|
+
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
103
|
+
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
104
|
+
|
|
105
|
+
Git diff driver setup
|
|
106
|
+
- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
|
|
107
|
+
- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
|
|
108
|
+
- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
|
|
109
|
+
- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
|
|
110
|
+
|
|
111
|
+
```console
|
|
112
|
+
K_JEM_TEMPLATING=true bundle exec kettle-jem install
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Troubleshooting Git diffs
|
|
116
|
+
- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
|
|
117
|
+
- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
|
|
118
|
+
- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
|
|
119
|
+
- To remove managed local entries, run `K_JEM_TEMPLATING=true bundle exec kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
|
|
120
|
+
|
|
121
|
+
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
|
|
122
|
+
|
|
123
|
+
## Appraisals
|
|
124
|
+
|
|
125
|
+
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
126
|
+
Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
|
|
127
|
+
in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4`.
|
|
128
|
+
That value describes the lowest Ruby version expected to run the test/development
|
|
129
|
+
toolchain, and it may be higher than the gemspec runtime floor.
|
|
130
|
+
|
|
131
|
+
They are created and updated with the commands:
|
|
132
|
+
|
|
133
|
+
```console
|
|
134
|
+
bin/rake appraisal:update
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
138
|
+
|
|
139
|
+
```console
|
|
140
|
+
bin/rake appraisal:reset
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
144
|
+
|
|
145
|
+
## Run Tests
|
|
146
|
+
|
|
147
|
+
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
148
|
+
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
149
|
+
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
150
|
+
|
|
151
|
+
```console
|
|
152
|
+
bundle exec kettle-test
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
156
|
+
|
|
157
|
+
```console
|
|
158
|
+
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Spec organization (required)
|
|
162
|
+
|
|
163
|
+
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/oauth2/my_class.rb` -> `spec/oauth2/my_class_spec.rb`.
|
|
164
|
+
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
|
|
165
|
+
|
|
166
|
+
## Lint It
|
|
167
|
+
|
|
168
|
+
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
169
|
+
|
|
170
|
+
```console
|
|
171
|
+
bundle exec rake
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Or just run the linter.
|
|
175
|
+
|
|
176
|
+
```console
|
|
177
|
+
bundle exec rake rubocop_gradual:autocorrect
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
181
|
+
|
|
182
|
+
### Important: Do not add inline RuboCop disables
|
|
183
|
+
|
|
184
|
+
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
185
|
+
|
|
186
|
+
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
187
|
+
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
188
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
189
|
+
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
190
|
+
|
|
191
|
+
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
27
192
|
|
|
28
193
|
## Contributors
|
|
29
194
|
|
|
30
|
-
|
|
195
|
+
Your picture could be here!
|
|
196
|
+
|
|
197
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
198
|
+
|
|
199
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
200
|
+
|
|
201
|
+
Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/oauth2/-/graphs/main][🚎contributors-gl]
|
|
202
|
+
|
|
203
|
+
## For Maintainers
|
|
204
|
+
|
|
205
|
+
### One-time, Per-maintainer, Setup
|
|
206
|
+
|
|
207
|
+
**IMPORTANT**: To sign a build,
|
|
208
|
+
a public key for signing gems will need to be picked up by the line in the
|
|
209
|
+
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
210
|
+
All releases are signed releases.
|
|
211
|
+
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
31
212
|
|
|
32
|
-
|
|
213
|
+
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
33
214
|
|
|
34
|
-
|
|
215
|
+
### To release a new version:
|
|
35
216
|
|
|
36
|
-
|
|
217
|
+
#### Automated process
|
|
37
218
|
|
|
38
|
-
|
|
219
|
+
1. Update version.rb to contain the correct version-to-be-released.
|
|
220
|
+
2. Run `bundle exec kettle-changelog`.
|
|
221
|
+
3. Run `bundle exec kettle-release`.
|
|
222
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
39
223
|
|
|
40
|
-
|
|
224
|
+
#### Manual process
|
|
41
225
|
|
|
42
|
-
|
|
226
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
227
|
+
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
228
|
+
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
229
|
+
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
230
|
+
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
231
|
+
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
232
|
+
- NOTE: Remember to [check the build][🧪build].
|
|
233
|
+
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
234
|
+
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
235
|
+
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
236
|
+
10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
|
|
237
|
+
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
238
|
+
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
239
|
+
- If the echo above has no output, then it didn't work.
|
|
240
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
241
|
+
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
242
|
+
11. Run `bundle exec rake build`
|
|
243
|
+
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
244
|
+
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
245
|
+
[gem][💎stone_checksums].
|
|
246
|
+
- The script automatically commits but does not push the checksums
|
|
247
|
+
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
248
|
+
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
249
|
+
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
250
|
+
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
43
251
|
|
|
44
|
-
[
|
|
252
|
+
[📜src-gl]: https://gitlab.com/ruby-oauth/oauth2
|
|
253
|
+
[📜src-cb]: https://codeberg.org/ruby-oauth/oauth2
|
|
254
|
+
[📜src-gh]: https://github.com/ruby-oauth/oauth2
|
|
255
|
+
[🧪build]: https://github.com/ruby-oauth/oauth2/actions
|
|
256
|
+
[🤝conduct]: https://github.com/ruby-oauth/oauth2/blob/main/CODE_OF_CONDUCT.md
|
|
257
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
258
|
+
[🖐contributors]: https://github.com/ruby-oauth/oauth2/graphs/contributors
|
|
259
|
+
[🚎contributors-gl]: https://gitlab.com/ruby-oauth/oauth2/-/graphs/main
|
|
260
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/oauth2
|
|
261
|
+
[💎gem-coop]: https://gem.coop
|
|
262
|
+
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
263
|
+
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
264
|
+
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
265
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
266
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
267
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
268
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
269
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
270
|
+
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
271
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
272
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
data/FUNDING.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
<!-- RELEASE-NOTES-FOOTER-START -->
|
|
2
|
+
|
|
3
|
+
Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
4
|
+
|
|
5
|
+
Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
|
|
6
|
+
|
|
7
|
+
[![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]
|
|
8
|
+
|
|
9
|
+
[![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]
|
|
10
|
+
|
|
11
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
12
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
13
|
+
[🖇osc-backers]: https://opencollective.com/ruby-oauth#backer
|
|
14
|
+
[🖇osc-backers-i]: https://opencollective.com/ruby-oauth/backers/badge.svg?style=flat
|
|
15
|
+
[🖇osc-sponsors]: https://opencollective.com/ruby-oauth#sponsor
|
|
16
|
+
[🖇osc-sponsors-i]: https://opencollective.com/ruby-oauth/sponsors/badge.svg?style=flat
|
|
17
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
18
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
19
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
20
|
+
[🖇polar]: https://polar.sh/pboling
|
|
21
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
22
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
23
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
24
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
25
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
26
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
27
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
28
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
29
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
30
|
+
[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
|
|
31
|
+
|
|
32
|
+
<!-- RELEASE-NOTES-FOOTER-END -->
|
|
33
|
+
|
|
34
|
+
# 🤑 A request for help
|
|
35
|
+
|
|
36
|
+
Maintainers have teeth and need to pay their dentists.
|
|
37
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
38
|
+
I began spending most of my time building open source tools.
|
|
39
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
40
|
+
so if you value the work I am doing, I need your support.
|
|
41
|
+
Please consider sponsoring me or the project.
|
|
42
|
+
|
|
43
|
+
To join the community or get help 👇️ Join the Discord.
|
|
44
|
+
|
|
45
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
46
|
+
|
|
47
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
48
|
+
|
|
49
|
+
[![Sponsor ruby-oauth/oauth2 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]
|
|
50
|
+
|
|
51
|
+
# Another Way to Support Open Source Software
|
|
52
|
+
|
|
53
|
+
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).
|
|
54
|
+
|
|
55
|
+
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`.
|
|
56
|
+
|
|
57
|
+
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.
|
|
58
|
+
|
|
59
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
60
|
+
|
|
61
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
62
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/ruby-oauth
|
|
63
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth
|
|
64
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/ruby-oauth
|
|
65
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/ruby-oauth?style=for-the-badge
|
|
66
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth?style=for-the-badge
|
|
67
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/ruby-oauth?style=for-the-badge
|
|
68
|
+
[🖇osc]: https://opencollective.com/ruby-oauth
|
|
69
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
70
|
+
[🖇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
|
|
71
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
72
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
73
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
74
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
|
data/LICENSE.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# License
|
|
2
|
+
|
|
3
|
+
This project is made available under the following license.
|
|
4
|
+
Choose the option that best fits your use case:
|
|
5
|
+
|
|
6
|
+
- [MIT](MIT.md)
|
|
7
|
+
|
|
8
|
+
## Copyright Notice
|
|
9
|
+
|
|
10
|
+
- Copyright (c) 2010-2014, 2016-2017 Erik Michaels-Ober
|
|
11
|
+
- Copyright (c) 2010 Jeremy Kemper
|
|
12
|
+
- Copyright (c) 2010-2011 Michael Bleigh
|
|
13
|
+
- Copyright (c) 2010-2011 Paul Walker
|
|
14
|
+
- Copyright (c) 2010 rick
|
|
15
|
+
- Copyright (c) 2010 Tim Habermaas
|
|
16
|
+
- Copyright (c) 2010 Wynn Netherland
|
|
17
|
+
- Copyright (c) 2011 Alexander Lang
|
|
18
|
+
- Copyright (c) 2011 Alexander Lang
|
|
19
|
+
- Copyright (c) 2011 Greg Spurrier
|
|
20
|
+
- Copyright (c) 2011 Jay Adkisson
|
|
21
|
+
- Copyright (c) 2011 Luke Saunders
|
|
22
|
+
- Copyright (c) 2011 Paul Walker
|
|
23
|
+
- Copyright (c) 2011 Simon Gate
|
|
24
|
+
- Copyright (c) 2012 Bas Vodde
|
|
25
|
+
- Copyright (c) 2012 Damian Janowski
|
|
26
|
+
- Copyright (c) 2012 Daniël van de Burgt
|
|
27
|
+
- Copyright (c) 2012 Dorren Chen
|
|
28
|
+
- Copyright (c) 2012 Igor Sales
|
|
29
|
+
- Copyright (c) 2012 Leigh Caplan
|
|
30
|
+
- Copyright (c) 2012 Michael Andrews
|
|
31
|
+
- Copyright (c) 2012 Omer Rauchwerger
|
|
32
|
+
- Copyright (c) 2012 Saverio Trioni
|
|
33
|
+
- Copyright (c) 2012 Trent Ogren
|
|
34
|
+
- Copyright (c) 2012 Vsevolod Romashov
|
|
35
|
+
- Copyright (c) 2013 Antonio Tapiador del Dujo
|
|
36
|
+
- Copyright (c) 2013 Eduardo Gurgel
|
|
37
|
+
- Copyright (c) 2013 Geostellar Developer
|
|
38
|
+
- Copyright (c) 2013-2014, 2018 Niels Ganser
|
|
39
|
+
- Copyright (c) 2013 Rainux Luo
|
|
40
|
+
- Copyright (c) 2013 Taylor Hedberg
|
|
41
|
+
- Copyright (c) 2013 Tim Clem
|
|
42
|
+
- Copyright (c) 2014 Dave Stevens
|
|
43
|
+
- Copyright (c) 2014 Ellis Berner
|
|
44
|
+
- Copyright (c) 2014 Frank Macreery
|
|
45
|
+
- Copyright (c) 2014 Michael Bleigh
|
|
46
|
+
- Copyright (c) 2014 Olivier Lacan
|
|
47
|
+
- Copyright (c) 2014 Peter Souter
|
|
48
|
+
- Copyright (c) 2014 Ryan Williams
|
|
49
|
+
- Copyright (c) 2015 Andrew Cantino and Jeff Moore
|
|
50
|
+
- Copyright (c) 2015 Thomas Walpole
|
|
51
|
+
- Copyright (c) 2016 Bo Jeanes
|
|
52
|
+
- Copyright (c) 2016 Cody Cutrer
|
|
53
|
+
- Copyright (c) 2016 Edward Rudd
|
|
54
|
+
- Copyright (c) 2016 Lawrence Oluyede
|
|
55
|
+
- Copyright (c) 2016 Linus Pettersson
|
|
56
|
+
- Copyright (c) 2016 Motoshi Nishihira
|
|
57
|
+
- Copyright (c) 2017 Adrian Setyadi
|
|
58
|
+
- Copyright (c) 2017-2018 Benjamin Quorning
|
|
59
|
+
- Copyright (c) 2017 Christoph Petschnig
|
|
60
|
+
- Copyright (c) 2017, 2022 Nathaniel Bibler
|
|
61
|
+
- Copyright (c) 2017 Oleg
|
|
62
|
+
- Copyright (c) 2017 Samuel Cochran
|
|
63
|
+
- Copyright (c) 2017 tetsuya
|
|
64
|
+
- Copyright (c) 2017 Yury Velikanau
|
|
65
|
+
- Copyright (c) 2018 Alex Kowalczuk
|
|
66
|
+
- Copyright (c) 2018 asm__
|
|
67
|
+
- Copyright (c) 2018 David Christensen
|
|
68
|
+
- Copyright (c) 2018 fossabot
|
|
69
|
+
- Copyright (c) 2018 Jeff Moore
|
|
70
|
+
- Copyright (c) 2018 Jeff Moore
|
|
71
|
+
- Copyright (c) 2018 Jonathan del Strother
|
|
72
|
+
- Copyright (c) 2018 Joseph Page
|
|
73
|
+
- Copyright (c) 2018 Joseph Page
|
|
74
|
+
- Copyright (c) 2018 Lomey
|
|
75
|
+
- Copyright (c) 2018 Markus Bengts
|
|
76
|
+
- Copyright (c) 2018 Mathias Klippinge
|
|
77
|
+
- Copyright (c) 2018 nikz
|
|
78
|
+
- Copyright (c) 2018-2019, 2021-2022, 2024-2026 Peter H. Boling
|
|
79
|
+
- Copyright (c) 2019 Daniel Fockler
|
|
80
|
+
- Copyright (c) 2019 Elliot Crosby-McCullough
|
|
81
|
+
- Copyright (c) 2019 João Paulo
|
|
82
|
+
- Copyright (c) 2019 Orien Madgwick
|
|
83
|
+
- Copyright (c) 2019 Ryan T. Hosford
|
|
84
|
+
- Copyright (c) 2019 Tom Corley
|
|
85
|
+
- Copyright (c) 2020 anvox
|
|
86
|
+
- Copyright (c) 2020 Jesse Cotton
|
|
87
|
+
- Copyright (c) 2020 Olle Jonsson
|
|
88
|
+
- Copyright (c) 2020 Stephen Reid
|
|
89
|
+
- Copyright (c) 2021 Anders Carling
|
|
90
|
+
- Copyright (c) 2021 dobon
|
|
91
|
+
- Copyright (c) 2021 Jan Zaydowicz
|
|
92
|
+
- Copyright (c) 2021 Nicholas Palaniuk
|
|
93
|
+
- Copyright (c) 2021-2022 Stan Hu
|
|
94
|
+
- Copyright (c) 2022 Benjamin Quorning
|
|
95
|
+
- Copyright (c) 2022 Bouke van der Bijl
|
|
96
|
+
- Copyright (c) 2022 nov
|
|
97
|
+
- Copyright (c) 2022 Rick Selby
|
|
98
|
+
- Copyright (c) 2022 Ryo Takahashi
|
|
99
|
+
- Copyright (c) 2023 Jessie Young
|
|
100
|
+
- Copyright (c) 2023 Карим Гимадеев
|
|
101
|
+
- Copyright (c) 2024 Aboling0
|
|
102
|
+
- Copyright (c) 2024 Elise Wood
|
|
103
|
+
- Copyright (c) 2024 Manuel van Rijn
|
|
104
|
+
- Copyright (c) 2025-2026 Annibelle Boling
|
|
105
|
+
- Copyright (c) 2025 Mark James
|
|
106
|
+
- Copyright (c) 2025 Mridang Agarwalla
|
|
107
|
+
- Copyright (c) 2025 Sasa Rosic
|
|
108
|
+
- Copyright (c) 2026 Jonathan Grinstead
|
|
109
|
+
- Copyright (c) 2026 kain
|
|
110
|
+
- Copyright (c) 2026 StepSecurity Bot
|