omniauth-ldap 2.0.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 4a580a1583118feff557707be44e27399e53b1b4
4
- data.tar.gz: 2b1e9f565c330b999f2724f0ea192ab86c47ca33
2
+ SHA256:
3
+ metadata.gz: 6521def9ea4ad73235bbf1c8147822ab3b59e211fdc5f4959dfa2178a82a5bd4
4
+ data.tar.gz: 4f6f08af41228c4e0a20f6a957d9927165f1d8109835a4c239abdcc3c6f79f4f
5
5
  SHA512:
6
- metadata.gz: 790f8a998f080ccd92746f748fb4d0066a4e2e87d62cd9f0434dc639fc829e7711a52ab640c97541eb8346528c6e4556bd25c6cfc86a69f09639bfbb8ce14d2c
7
- data.tar.gz: 5722ea2a9335f2171b70aafdf461790eb22ebbbb7e48fc56a646b776ec96d9915fdcfc4e581c7afe8b53cc5ead645eedfbf89e9aaa4e7e7ed2ea6acbb1584a6c
6
+ metadata.gz: 51fca6cf72c8331c82ecb35b89d4cca511bd6de423da5c24c659b2de9a0f7c29dd74eca283edeb45672ca0a745a1a970478d42b972f518d68fc9a9dd155fef80
7
+ data.tar.gz: f08359c99200c2192abc312a80859d7cd9671061318605b680ef6bf03c14ea667b9b7d288dd4754939e062da7f5de1b7c887d33fa56846b10e6f826172bfbe76
checksums.yaml.gz.sig ADDED
Binary file
data/CHANGELOG.md ADDED
@@ -0,0 +1,202 @@
1
+ # Changelog
2
+
3
+ [![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
4
+
5
+ Since version v2.3.1, all notable changes to this project will be documented in this file.
6
+
7
+ This changelog lists the releases of the original omniauth-ldap, and the GitLab forked versions, up until v2.3.0.
8
+
9
+ The format is based on [Keep a Changelog][📗keep-changelog],
10
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
11
+ and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
12
+ Please file a bug if you notice a violation of semantic versioning.
13
+
14
+ [📌semver]: https://semver.org/spec/v2.0.0.html
15
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
16
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
17
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
18
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
19
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
20
+
21
+ ## [Unreleased]
22
+
23
+ ### Added
24
+
25
+ ### Changed
26
+
27
+ ### Deprecated
28
+
29
+ ### Removed
30
+
31
+ ### Fixed
32
+
33
+ ### Security
34
+
35
+ ## [2.3.1] - 2025-11-05
36
+
37
+ - TAG: [v2.3.1][2.3.1t]
38
+ - COVERAGE: 97.85% -- 228/233 lines in 4 files
39
+ - BRANCH COVERAGE: 81.58% -- 62/76 branches in 4 files
40
+ - 37.50% documented
41
+
42
+ ### Added
43
+
44
+ - Added RBS types
45
+ - Upgraded RSpec tests to v3 syntax
46
+ - Improved code coverage to 98% lines and 78% branches
47
+ - Added integration tests with a complete Roda-based demo app for specs
48
+ - Well tested support for all versions of OmniAuth >= v1 and Rack >= v1 via appraisals
49
+ - Document why auth.uid == dn
50
+ - Support for LDAP-based SSO identity via HTTP Header
51
+ - Document how to use filter option
52
+ - All fixes and updates from the GitLab fork since up to v2.3.0
53
+ - https://github.com/omniauth/omniauth-ldap/pull/100
54
+ - https://gitlab.com/gitlab-org/gitlab-ce/issues/13280
55
+
56
+ ### Changed
57
+
58
+ - Make support for Ruby v2.0 explicit
59
+ - Make support for OmniAuth v1+ explicit
60
+ - Make support for Rack v1+ explicit
61
+ - Modernize codebase to use more recent Ruby syntax (upgrade from Ruby v1 to v2 syntax) and conventions
62
+
63
+ ### Fixed
64
+
65
+ - Prevent key duplication in symbolize_hash_keys
66
+
67
+ ## [2.3.0-gl] (gitlab fork) - 2025-08-20
68
+
69
+ - TAG: [v2.3.0][2.3.0t-gl] (gitlab)
70
+
71
+ ## [2.2.0-gl] (gitlab fork) - 2022-06-24
72
+
73
+ - TAG: [v2.2.0][2.2.0t-gl] (gitlab)
74
+
75
+ ## [2.1.1-gl] (gitlab fork) - 2019-02-22
76
+
77
+ - TAG: [v2.1.1][2.1.1t-gl] (gitlab)
78
+
79
+ ### Added
80
+
81
+ - Add a String check to `tls_options` sanitization to allow other objects
82
+
83
+ ## [2.1.0-gl] (gitlab fork) - 2018-06-18
84
+
85
+ - TAG: [v2.1.0][2.1.0t-gl] (gitlab)
86
+
87
+ ### Added
88
+
89
+ - Expose `:tls_options` SSL configuration option.
90
+
91
+ ### Deprecated
92
+
93
+ - Deprecate :ca_file, :ssl_version
94
+
95
+ ## [2.0.4-gl] (gitlab fork) - 2017-08-10
96
+
97
+ - TAG: [v2.0.4][2.0.4t-gl] (gitlab)
98
+
99
+ - Improve log message when invalid credentials are used
100
+
101
+ ## 2.0.3 (gitlab fork) - 2017-07-20
102
+
103
+ - Protects against wrong request method call to callback
104
+
105
+ ## [2.0.2-gl] (gitlab fork) - 2017-06-13
106
+
107
+ - TAG: [v2.0.2][2.0.2t-gl] (gitlab)
108
+
109
+ ## [2.0.1-gl] (gitlab fork) - 2017-06-09
110
+
111
+ - TAG: [v2.0.1][2.0.1t-gl] (gitlab)
112
+
113
+ ## [2.0.0-gl] (gitlab fork) - 2017-06-07
114
+
115
+ - TAG: [v2.0.0][2.0.0t-gl] (gitlab)
116
+
117
+ ## [2.0.0] (intridea) - 2018-01-09
118
+
119
+ - TAG: [v2.0.0][2.0.0t] (github)
120
+
121
+ ## [1.2.1-gl] (gitlab fork) - 2015-03-17
122
+
123
+ - TAG: [v1.2.1][1.2.1t-gl] (gitlab)
124
+
125
+ ## [1.2.0-gl] (gitlab fork) - 2014-10-29
126
+
127
+ - TAG: [v1.2.0][1.2.0t-gl] (gitlab)
128
+
129
+ ## [1.1.0-gl] (gitlab fork) - 2014-09-08
130
+
131
+ - TAG: [v1.1.0][1.1.0t-gl] (gitlab)
132
+
133
+ ## [1.0.5-gl] - 2016-02-17
134
+
135
+ - TAG: [v1.0.5][1.0.5t-gl] (gitlab fork, gem not released)
136
+ - TAG: [v1.0.5][1.0.5t] (github)
137
+
138
+ ## 1.0.4
139
+
140
+ - released 2014-02-03 (intridea)
141
+ - released 2013-11-13 (gitlab fork)
142
+
143
+ ## 1.0.3
144
+
145
+ - released 2013-01-23 (intridea)
146
+ - released 2013-06-13 (gitlab fork)
147
+
148
+ ## [1.0.2-gl]
149
+
150
+ - TAG: [v1.0.2][1.0.2t-gl] (gitlab) - released 2012-12-30
151
+ - TAG: [v1.0.2][1.0.2t] (github) - released 2011-12-17
152
+
153
+ ## 1.0.1 - 2011-11-02
154
+
155
+ ## [1.0.0-gl] - 2011-11-02
156
+
157
+ - TAG: [v1.0.0][1.0.0t-gl] (gitlab)
158
+ - TAG: [v1.0.0][1.0.0t] (github)
159
+
160
+ [2.3.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.2.0...v2.3.0
161
+ [2.3.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.3.0
162
+ [2.2.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.1.1...v2.2.0
163
+ [2.2.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.2.0
164
+ [2.1.1-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.1.0...v2.1.1
165
+ [2.1.1t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.1.1
166
+ [2.1.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.0.4...v2.1.0
167
+ [2.1.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.1.0
168
+ [2.0.4-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.0.2...v2.0.4
169
+ [2.0.4t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.0.4
170
+ [//]: # ( There is no tag for v2.0.3 on GitLab)
171
+ [2.0.2-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.0.1...v2.0.2
172
+ [2.0.2t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.0.2
173
+ [2.0.1-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v2.0.0...v2.0.1
174
+ [2.0.1t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.0.1
175
+ [2.0.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.2.1...v2.0.0
176
+ [2.0.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/2.0.0
177
+ [2.0.0]: https://github.com/omniauth/omniauth-ldap/compare/v1.0.5...v2.0.0
178
+ [2.0.0t]: https://github.com/omniauth/omniauth-ldap/releases/tag/v2.0.0
179
+ [1.2.1-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.2.0...v1.2.1
180
+ [1.2.1t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.2.1
181
+ [1.2.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.1.0...v1.2.0
182
+ [1.2.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.2.0
183
+ [1.1.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.0.2...v1.1.0
184
+ [1.1.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.1.0
185
+ [1.0.5-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.0.2...v1.0.5
186
+ [1.0.5t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.0.5
187
+ [1.0.5]: https://github.com/omniauth/omniauth-ldap/compare/v1.0.2...v1.0.5
188
+ [1.0.5t]: https://github.com/omniauth/omniauth-ldap/releases/tag/v1.0.5
189
+ [//]: # ( There are no tags for v1.0.3, v1.0.4 on GitHub, or GitLab)
190
+ [1.0.2-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/v1.0.1...v1.0.2
191
+ [1.0.2t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.0.2
192
+ [1.0.2]: https://github.com/omniauth/omniauth-ldap/compare/v1.0.1...v1.0.2
193
+ [1.0.2t]: https://github.com/omniauth/omniauth-ldap/releases/tag/v1.0.2
194
+ [//]: # ( There are no tags for v1.0.1 on GitHub, or GitLab)
195
+ [1.0.0-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/compare/5656da80d4193e0d0584f44bac493a87695e580f...v1.0.0
196
+ [1.0.0t-gl]: https://gitlab.com/gitlab-org/ruby/gems/omniauth-ldap/-/tags/1.0.0
197
+ [1.0.0]: https://github.com/omniauth/omniauth-ldap/compare/5656da80d4193e0d0584f44bac493a87695e580f...v1.0.0
198
+ [1.0.0t]: https://github.com/omniauth/omniauth-ldap/releases/tag/v1.0.0
199
+
200
+ [Unreleased]: https://github.com/omniauth/omniauth-ldap/compare/v2.3.1...HEAD
201
+ [2.3.1]: https://github.com/omniauth/omniauth-ldap/compare/v2.0.0...v2.3.1
202
+ [2.3.1t]: https://github.com/omniauth/omniauth-ldap/releases/tag/v2.3.1
data/CITATION.cff ADDED
@@ -0,0 +1,20 @@
1
+ cff-version: 1.2.0
2
+ title: omniauth-ldap
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 Hurn
9
+ family-names: Boling
10
+ email: peter@railsbling.com
11
+ affiliation: railsbling.com
12
+ orcid: 'https://orcid.org/0009-0008-8519-441X'
13
+ identifiers:
14
+ - type: url
15
+ value: 'https://github.com/omniauth/omniauth-ldap'
16
+ description: omniauth-ldap
17
+ repository-code: 'https://github.com/omniauth/omniauth-ldap'
18
+ abstract: >-
19
+ omniauth-ldap
20
+ license: See license file
@@ -0,0 +1,134 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
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 ADDED
@@ -0,0 +1,213 @@
1
+ # Contributing
2
+
3
+ Bug reports and pull requests are welcome on [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
+ ## Help out!
12
+
13
+ Take a look at the `reek` list which is the file called `REEK` and find something to improve.
14
+
15
+ Follow these instructions:
16
+
17
+ 1. Fork the repository
18
+ 2. Create a feature branch (`git checkout -b my-new-feature`)
19
+ 3. Make some fixes.
20
+ 4. Commit changes (`git commit -am 'Added some feature'`)
21
+ 5. Push to the branch (`git push origin my-new-feature`)
22
+ 6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
23
+ 7. Create new Pull Request.
24
+
25
+ ## Executables vs Rake tasks
26
+
27
+ Executables shipped by dependencies, such as omniauth-ldap, and stone_checksums, are available
28
+ after running `bin/setup`. These include:
29
+
30
+ - gem_checksums
31
+ - kettle-changelog
32
+ - kettle-commit-msg
33
+ - omniauth-ldap-setup
34
+ - kettle-dvcs
35
+ - kettle-pre-release
36
+ - kettle-readme-backers
37
+ - kettle-release
38
+
39
+ There are many Rake tasks available as well. You can see them by running:
40
+
41
+ ```shell
42
+ bin/rake -T
43
+ ```
44
+
45
+ ## Environment Variables for Local Development
46
+
47
+ 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.
48
+
49
+ General/runtime
50
+ - DEBUG: Enable extra internal logging for this library (default: false)
51
+ - REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
52
+ - CI: When set to true, adjusts default rake tasks toward CI behavior
53
+
54
+ Coverage (kettle-soup-cover / SimpleCov)
55
+ - K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
56
+ - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
57
+ - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
58
+ - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
59
+ - K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
60
+ - K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
61
+ - K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
62
+ - MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
63
+ 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.
64
+
65
+ GitHub API and CI helpers
66
+ - GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
67
+
68
+ Releasing and signing
69
+ - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
70
+ - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
71
+ - SOURCE_DATE_EPOCH: Reproducible build timestamp. `kettle-release` will set this automatically for the session.
72
+
73
+ Git hooks and commit message helpers (exe/kettle-commit-msg)
74
+ - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
75
+ - GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
76
+ - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
77
+ - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
78
+
79
+ For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
80
+
81
+ ## Appraisals
82
+
83
+ From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
84
+ They are created and updated with the commands:
85
+
86
+ ```console
87
+ bin/rake appraisal:update
88
+ ```
89
+
90
+ When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
91
+
92
+ ## The Reek List
93
+
94
+ Take a look at the `reek` list which is the file called `REEK` and find something to improve.
95
+
96
+ To refresh the `reek` list:
97
+
98
+ ```console
99
+ bundle exec reek > REEK
100
+ ```
101
+
102
+ ## Run Tests
103
+
104
+ To run all tests
105
+
106
+ ```console
107
+ bundle exec rake test
108
+ ```
109
+
110
+ ### Spec organization (required)
111
+
112
+ - 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/omniauth/ldap/my_class.rb` -> `spec/omniauth/ldap/my_class_spec.rb`.
113
+ - 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.
114
+
115
+ ## Lint It
116
+
117
+ Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
118
+
119
+ ```console
120
+ bundle exec rake
121
+ ```
122
+
123
+ Or just run the linter.
124
+
125
+ ```console
126
+ bundle exec rake rubocop_gradual:autocorrect
127
+ ```
128
+
129
+ 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.
130
+
131
+ ### Important: Do not add inline RuboCop disables
132
+
133
+ 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:
134
+
135
+ - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
136
+ - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
137
+ - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
138
+ - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
139
+
140
+ 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.
141
+
142
+ ## Contributors
143
+
144
+ Your picture could be here!
145
+
146
+ [![Contributors][🖐contributors-img]][🖐contributors]
147
+
148
+ Made with [contributors-img][🖐contrib-rocks].
149
+
150
+ ## For Maintainers
151
+
152
+ ### One-time, Per-maintainer, Setup
153
+
154
+ **IMPORTANT**: To sign a build,
155
+ a public key for signing gems will need to be picked up by the line in the
156
+ `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
157
+ All releases are signed releases.
158
+ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
159
+
160
+ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
161
+
162
+ ### To release a new version:
163
+
164
+ #### Automated process
165
+
166
+ 1. Update version.rb to contain the correct version-to-be-released.
167
+ 2. Run `bundle exec kettle-changelog`.
168
+ 3. Run `bundle exec kettle-release`.
169
+
170
+ #### Manual process
171
+
172
+ 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
173
+ 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
174
+ 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
175
+ 4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
176
+ 5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
177
+ - NOTE: Remember to [check the build][🧪build].
178
+ 6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
179
+ 7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
180
+ 8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
181
+ 9. 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
182
+ - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
183
+ - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
184
+ - If the echo above has no output, then it didn't work.
185
+ - Note: `zsh/datetime` module is needed, if running `zsh`.
186
+ - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
187
+ 10. Run `bundle exec rake build`
188
+ 11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
189
+ to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
190
+ [gem][💎stone_checksums].
191
+ - The script automatically commits but does not push the checksums
192
+ 12. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
193
+ - `sha256sum pkg/<gem name>-<version>.gem`
194
+ 13. Run `bundle exec rake release` which will create a git tag for the version,
195
+ push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
196
+
197
+ [📜src-gh]: https://github.com/omniauth/omniauth-ldap
198
+ [🧪build]: https://github.com/omniauth/omniauth-ldap/actions
199
+ [🤝conduct]: https://gitlab.com/omniauth/omniauth-ldap/-/blob/main/CODE_OF_CONDUCT.md
200
+ [🖐contrib-rocks]: https://contrib.rocks
201
+ [🖐contributors]: https://github.com/omniauth/omniauth-ldap/graphs/contributors
202
+ [🖐contributors-img]: https://contrib.rocks/image?repo=omniauth/omniauth-ldap
203
+ [💎gem-coop]: https://gem.coop
204
+ [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
205
+ [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
206
+ [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
207
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
208
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
209
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
210
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
211
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
212
+ [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
213
+ [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
data/FUNDING.md ADDED
@@ -0,0 +1,66 @@
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
+ [![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 or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee 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
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
14
+ [🖇sponsor]: https://github.com/sponsors/pboling
15
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
16
+ [🖇polar]: https://polar.sh/pboling
17
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
18
+ [🖇kofi]: https://ko-fi.com/O5O86SNP4
19
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
20
+ [🖇patreon]: https://patreon.com/galtzo
21
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
22
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
23
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
24
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
25
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
26
+ [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
27
+
28
+ <!-- RELEASE-NOTES-FOOTER-END -->
29
+
30
+ # 🤑 Request for Help
31
+
32
+ Maintainers have teeth and need to pay their dentists.
33
+ After getting laid off in an RIF in March and filled with many dozens of rejections,
34
+ I'm now spending ~60+ hours a week building open source tools.
35
+ I'm hoping to be able to pay for my kids' health insurance this month,
36
+ so if you value the work I am doing, I need your support.
37
+ Please consider sponsoring me or the project.
38
+
39
+ To join the community or get help 👇️ Join the Discord.
40
+
41
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
42
+
43
+ To say "thanks for maintaining such a great tool" ☝️ Join the Discord or 👇️ send money.
44
+
45
+ [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay-img] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal-img]
46
+
47
+ # Another Way to Support Open Source Software
48
+
49
+ > How wonderful it is that nobody need wait a single moment before starting to improve the world.<br/>
50
+ >—Anne Frank
51
+
52
+ I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
53
+
54
+ 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`.
55
+
56
+ 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.
57
+
58
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
59
+
60
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
61
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
62
+ [🖇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
63
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
64
+ [🖇floss-funding.dev]: https://floss-funding.dev
65
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
66
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge