oauth2 2.0.24 → 2.0.26

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.
data/CONTRIBUTING.md DELETED
@@ -1,272 +0,0 @@
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 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 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.
192
-
193
- ## Contributors
194
-
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]
212
-
213
- NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
214
-
215
- ### To release a new version:
216
-
217
- #### Automated process
218
-
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.
223
-
224
- #### Manual process
225
-
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.
251
-
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 DELETED
@@ -1,74 +0,0 @@
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/RUBOCOP.md DELETED
@@ -1,71 +0,0 @@
1
- # RuboCop Usage Guide
2
-
3
- ## Overview
4
-
5
- A tale of two RuboCop plugin gems.
6
-
7
- ### RuboCop Gradual
8
-
9
- This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
10
-
11
- ### RuboCop LTS
12
-
13
- This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
14
- RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
15
-
16
- ## Checking RuboCop Violations
17
-
18
- To check for RuboCop violations in this project, always use:
19
-
20
- ```bash
21
- bundle exec rake rubocop_gradual:check
22
- ```
23
-
24
- **Do not use** the standard RuboCop commands like:
25
- - `bundle exec rubocop`
26
- - `rubocop`
27
-
28
- ## Understanding the Lock File
29
-
30
- The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
31
-
32
- 1. Prevent new violations while gradually fixing existing ones
33
- 2. Track progress on code style improvements
34
- 3. Ensure CI builds don't fail due to pre-existing violations
35
-
36
- ## Common Commands
37
-
38
- - **Check violations**
39
- - `bundle exec rake rubocop_gradual`
40
- - `bundle exec rake rubocop_gradual:check`
41
- - **(Safe) Autocorrect violations, and update lockfile if no new violations**
42
- - `bundle exec rake rubocop_gradual:autocorrect`
43
- - **Force update the lock file (w/o autocorrect) to match violations present in code**
44
- - `bundle exec rake rubocop_gradual:force_update`
45
-
46
- ## Workflow
47
-
48
- 1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
49
- a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
50
- 2. If there are new violations, either:
51
- - Fix them in your code
52
- - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
53
- 3. Commit the updated `.rubocop_gradual.lock` file along with your changes
54
-
55
- ## Never add inline RuboCop disables
56
-
57
- Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
58
-
59
- - Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
60
- - Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
61
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
62
- - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
63
-
64
- In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
65
-
66
- ## Benefits of rubocop_gradual
67
-
68
- - Allows incremental adoption of code style rules
69
- - Prevents CI failures due to pre-existing violations
70
- - Provides a clear record of code style debt
71
- - Enables focused efforts on improving code quality over time
data/SECURITY.md DELETED
@@ -1,21 +0,0 @@
1
- # Security Policy
2
-
3
- ## Supported Versions
4
-
5
- | Version | Supported |
6
- |----------|-----------|
7
- | 2.0.latest | ✅ |
8
-
9
- ## Security contact information
10
-
11
- To report a security vulnerability, please use the
12
- [Tidelift security contact](https://tidelift.com/security).
13
- Tidelift will coordinate the fix and disclosure.
14
-
15
- ## Additional Support
16
-
17
- If you are interested in support for versions older than the latest release,
18
- please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
19
- or find other sponsorship links in the [README].
20
-
21
- [README]: README.md
data/certs/pboling.pem DELETED
@@ -1,27 +0,0 @@
1
- -----BEGIN CERTIFICATE-----
2
- MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
3
- ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
4
- A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
5
- DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
6
- LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
7
- uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
8
- LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
9
- mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
10
- coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
11
- FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
12
- yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
13
- to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
14
- qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
15
- fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
16
- HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
17
- A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
18
- ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
19
- wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
20
- L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
21
- GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
22
- kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
23
- QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
24
- 0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
25
- DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
26
- L9nRqA==
27
- -----END CERTIFICATE-----
@@ -1,25 +0,0 @@
1
- module OAuth2
2
- class AccessToken
3
- def self.from_hash: (OAuth2::Client, Hash[untyped, untyped]) -> OAuth2::AccessToken
4
- def self.from_kvform: (OAuth2::Client, String) -> OAuth2::AccessToken
5
-
6
- def initialize: (OAuth2::Client, String, ?Hash[Symbol, untyped]) -> void
7
- def []: (String | Symbol) -> untyped
8
- def expires?: () -> bool
9
- def expired?: () -> bool
10
- def refresh: (?Hash[untyped, untyped], ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::AccessToken
11
- def revoke: (?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
12
- def to_hash: () -> Hash[Symbol, untyped]
13
- def request: (Symbol, String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
14
- def get: (String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
15
- def post: (String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
16
- def put: (String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
17
- def patch: (String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
18
- def delete: (String, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
19
- def headers: () -> Hash[String, String]
20
- def configure_authentication!: (Hash[Symbol, untyped], Symbol) -> void
21
- def convert_expires_at: (untyped) -> (Time | Integer | nil)
22
-
23
- attr_accessor response: OAuth2::Response
24
- end
25
- end
@@ -1,22 +0,0 @@
1
- module OAuth2
2
- class Authenticator
3
- include OAuth2::FilteredAttributes
4
-
5
- attr_reader mode: (Symbol | String)
6
- attr_reader id: String?
7
- attr_reader secret: String?
8
-
9
- def initialize: (String? id, String? secret, (Symbol | String) mode) -> void
10
-
11
- def apply: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
12
-
13
- def self.encode_basic_auth: (String, String) -> String
14
-
15
- private
16
-
17
- def apply_params_auth: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
18
- def apply_client_id: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
19
- def apply_basic_auth: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
20
- def basic_auth_header: () -> Hash[String, String]
21
- end
22
- end
@@ -1,52 +0,0 @@
1
- module OAuth2
2
- class Client
3
- RESERVED_REQ_KEYS: Array[String]
4
- RESERVED_PARAM_KEYS: Array[String]
5
-
6
- include OAuth2::FilteredAttributes
7
-
8
- attr_reader id: String
9
- attr_reader secret: String
10
- attr_reader site: String?
11
- attr_accessor options: Hash[Symbol, untyped]
12
- attr_writer connection: untyped
13
-
14
- def initialize: (String client_id, String client_secret, ?Hash[Symbol, untyped]) { (untyped) -> void } -> void
15
-
16
- def site=: (String) -> String
17
-
18
- def connection: () -> untyped
19
-
20
- def authorize_url: (?Hash[untyped, untyped]) -> String
21
- def token_url: (?Hash[untyped, untyped]) -> String
22
- def revoke_url: (?Hash[untyped, untyped]) -> String
23
-
24
- def request: (Symbol verb, String url, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
25
-
26
- def get_token: (Hash[untyped, untyped] params, ?Hash[Symbol, untyped] access_token_opts, ?Proc) { (Hash[Symbol, untyped]) -> void } -> (OAuth2::AccessToken | nil)
27
-
28
- def revoke_token: (String token, ?String token_type_hint, ?Hash[Symbol, untyped]) { (untyped) -> void } -> OAuth2::Response
29
-
30
- def http_method: () -> Symbol
31
-
32
- def auth_code: () -> OAuth2::Strategy::AuthCode
33
- def implicit: () -> OAuth2::Strategy::Implicit
34
- def password: () -> OAuth2::Strategy::Password
35
- def client_credentials: () -> OAuth2::Strategy::ClientCredentials
36
- def assertion: () -> OAuth2::Strategy::Assertion
37
-
38
- def redirection_params: () -> Hash[String, String]
39
-
40
- private
41
-
42
- def params_to_req_opts: (Hash[untyped, untyped]) -> Hash[Symbol, untyped]
43
- def parse_snaky_params_headers: (Hash[untyped, untyped]) -> [Symbol, bool, untyped, (Symbol | nil), Hash[untyped, untyped], Hash[String, String]]
44
- def execute_request: (Symbol verb, String url, ?Hash[Symbol, untyped]) { (Faraday::Request) -> void } -> OAuth2::Response
45
- def authenticator: () -> OAuth2::Authenticator
46
- def parse_response_legacy: (OAuth2::Response, Hash[Symbol, untyped], Proc) -> (OAuth2::AccessToken | nil)
47
- def parse_response: (OAuth2::Response, Hash[Symbol, untyped]) -> (OAuth2::AccessToken | nil)
48
- def build_access_token: (OAuth2::Response, Hash[Symbol, untyped], untyped) -> OAuth2::AccessToken
49
- def build_access_token_legacy: (OAuth2::Response, Hash[Symbol, untyped], Proc) -> (OAuth2::AccessToken | nil)
50
- def oauth_debug_logging: (untyped) -> void
51
- end
52
- end
data/sig/oauth2/error.rbs DELETED
@@ -1,8 +0,0 @@
1
- module OAuth2
2
- class Error < StandardError
3
- def initialize: (OAuth2::Response) -> void
4
- def code: () -> (String | Integer | nil)
5
- def description: () -> (String | nil)
6
- def response: () -> OAuth2::Response
7
- end
8
- end
@@ -1,11 +0,0 @@
1
- module OAuth2
2
- module FilteredAttributes
3
- module InitializerMethods
4
- def initialize: (*untyped args) { () -> untyped } -> untyped
5
- end
6
-
7
- def self.included: (untyped) -> untyped
8
- def filtered_attributes: (*(String | Symbol)) -> void
9
- def thing_filter: () -> OAuth2::ThingFilter
10
- end
11
- end
@@ -1,18 +0,0 @@
1
- module OAuth2
2
- class Response
3
- DEFAULT_OPTIONS: Hash[Symbol, untyped]
4
-
5
- def self.register_parser: (Symbol key, (Array[String] | String) mime_types) { (String) -> untyped } -> void
6
-
7
- def initialize: (untyped response, parse: Symbol?, snaky: bool?, snaky_hash_klass: untyped?, options: Hash[Symbol, untyped]?) -> void
8
- def headers: () -> Hash[untyped, untyped]
9
- def status: () -> Integer
10
- def body: () -> String
11
- def parsed: () -> untyped
12
- def content_type: () -> (String | nil)
13
- def parser: () -> (untyped | nil)
14
-
15
- attr_reader response: untyped
16
- attr_accessor options: Hash[Symbol, untyped]
17
- end
18
- end
@@ -1,32 +0,0 @@
1
- module OAuth2
2
- class SanitizedLogger
3
- def initialize: (untyped logger) -> void
4
-
5
- def add: (untyped severity, ?untyped message, ?untyped progname) { () -> untyped } -> untyped
6
- def <<: (String message) -> untyped
7
- def debug: (?untyped progname) { () -> untyped } -> untyped
8
- def info: (?untyped progname) { () -> untyped } -> untyped
9
- def warn: (?untyped progname) { () -> untyped } -> untyped
10
- def error: (?untyped progname) { () -> untyped } -> untyped
11
- def fatal: (?untyped progname) { () -> untyped } -> untyped
12
- def unknown: (?untyped progname) { () -> untyped } -> untyped
13
- def close: () -> void
14
- def formatter: () -> untyped
15
- def formatter=: (untyped formatter) -> void
16
- def level: () -> untyped
17
- def level=: (untyped level) -> void
18
- def progname: () -> untyped
19
- def progname=: (untyped progname) -> void
20
- def respond_to_missing?: (Symbol method_name, ?bool include_private) -> bool
21
- def method_missing: (Symbol method_name, *untyped args) { () -> untyped } -> untyped
22
-
23
- private
24
-
25
- def log: (Symbol level, ?untyped progname) { () -> untyped } -> untyped
26
- def sanitize: (untyped message) -> untyped
27
- def thing_filter: () -> OAuth2::ThingFilter
28
- def sanitize_authorization_header: (String message) -> String
29
- def sanitize_json_pairs: (String message) -> String
30
- def sanitize_form_and_query_pairs: (String message) -> String
31
- end
32
- end