active_security 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 3c68226e5113d5925222d0e456dfbccac3866b3d526d35a018a52a4a8f2aa476
4
+ data.tar.gz: 5590c5054131249ee7fa5fa3875a3fe64440154f37f7614d7c6fce0a4807b25f
5
+ SHA512:
6
+ metadata.gz: aa9c8e50b69b7427a4f769da3132324c3c0d5fa8f6ba5a1d78955194573e7c84accfebb1666cf144520cb9fb90c3b553f23501ee3657f8841ed53553312e690d
7
+ data.tar.gz: 961dd3238ba102b5b5b7100a88a080d1f42b62c619e16fbeafa25469c5d090d38c23b33bdafd032631cda644f4c6dfdcdca0d3817f4890870667ae1c2cc2ee1c
checksums.yaml.gz.sig ADDED
Binary file
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [1.0.0] - 2024-07-04
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at peter.boling@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,66 @@
1
+ ## Contributing
2
+
3
+ Bug reports and pull requests are welcome on GitHub at [https://github.com/pboling/active_security][🚎src-main]
4
+ . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
5
+ the [code of conduct][🤝conduct].
6
+
7
+ To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request.
8
+
9
+ ## Appraisal & Combustion
10
+
11
+ ### Generate a new set of Appraisal gemfiles:
12
+
13
+ ```sh
14
+ BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal generate
15
+ ```
16
+
17
+ NOTE: Due to a bug in Appraisal, in each generated gemfile, you'll need to replace this line:
18
+ ```ruby
19
+ gemspec path: "../../"
20
+ ```
21
+ with
22
+ ```ruby
23
+ gemspec path: "../"
24
+ ```
25
+
26
+ ## Release
27
+
28
+ To release a new version:
29
+
30
+ 1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
31
+ 2. Update the version number in `version.rb`
32
+ 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
33
+ 4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
34
+ 5. Run `git push` to trigger the final CI pipeline before release, & merge PRs
35
+ a. NOTE: Remember to [check the build][🧪build]!
36
+ 6. Run `git checkout main`
37
+ 7. Run `git pull origin main` to ensure you will release the latest trunk code.
38
+ 8. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
39
+ a. Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
40
+ b. If the echo above has no output, then it didn't work.
41
+ c. Note that you'll need the `zsh/datetime` module, if running `zsh`.
42
+ 9. Run `bundle exec rake build`
43
+ 10. Run [`bin/checksums`][🔒️rubygems-checksums-pr] to create SHA-256 and SHA-512 checksums
44
+ a. Checksums will be committed automatically by the script, but not pushed
45
+ 11. Run `bundle exec rake release` which will create a git tag for the version,
46
+ push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
47
+
48
+ NOTE: You will need to have a public key in `certs/`, and list your cert in the
49
+ `gemspec`, in order to sign the new release.
50
+ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
51
+
52
+ ## Contributors
53
+
54
+ [![Contributors][🖐contributors-img]][🖐contributors]
55
+
56
+ Made with [contributors-img][🖐contrib-rocks].
57
+
58
+ [🧪build]: https://github.com/pboling/active_security/actions
59
+ [🤝conduct]: https://github.com/pboling/active_security/blob/main/CODE_OF_CONDUCT.md
60
+ [🖐contrib-rocks]: https://contrib.rocks
61
+ [🖐contributors]: https://github.com/pboling/active_security/graphs/contributors
62
+ [🖐contributors-img]: https://contrib.rocks/image?repo=pboling/active_security
63
+ [💎rubygems]: https://rubygems.org
64
+ [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
65
+ [🔒️rubygems-checksums-pr]: https://github.com/rubygems/guides/pull/325
66
+ [🚎src-main]: https://github.com/pboling/active_security
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Peter Boling
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,263 @@
1
+ # ActiveSecurity
2
+
3
+ <div id="badges">
4
+
5
+ [![CI Build][🚎dl-cwfi]][🚎dl-cwf]
6
+ [![Test Coverage][🔑cc-covi]][🔑cc-cov]
7
+ [![Maintainability][🔑cc-mnti]][🔑cc-mnt]
8
+ [![Depfu][🔑depfui]][🔑depfu]
9
+
10
+ [🚎dl-cwf]: https://github.com/pboling/active_security/actions/workflows/supported.yml
11
+ [🚎dl-cwfi]: https://github.com/pboling/active_security/actions/workflows/supported.yml/badge.svg
12
+
13
+ [comment]: <> ( 🔑 KEYED LINKS )
14
+
15
+ [🔑cc-mnt]: https://codeclimate.com/github/pboling/active_security/maintainability
16
+ [🔑cc-mnti]: https://api.codeclimate.com/v1/badges/a6280f7e5533aed38d05/maintainability
17
+ [🔑cc-cov]: https://codeclimate.com/github/pboling/active_security/test_coverage
18
+ [🔑cc-covi]: https://api.codeclimate.com/v1/badges/a6280f7e5533aed38d05/test_coverage
19
+ [🔑depfu]: https://depfu.com/github/pboling/active_security?project_id=41757
20
+ [🔑depfui]: https://badges.depfu.com/badges/88e0dac6be89feaa9bd6bb0dd12b3e3a/count.svg
21
+
22
+ -----
23
+
24
+ [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
25
+ [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
26
+
27
+ <span class="badge-buymeacoffee">
28
+ <a href="https://ko-fi.com/O5O86SNP4" target='_blank' title="Donate to my FLOSS or refugee efforts at ko-fi.com"><img src="https://img.shields.io/badge/buy%20me%20coffee-donate-yellow.svg" alt="Buy me coffee donation button" /></a>
29
+ </span>
30
+ <span class="badge-patreon">
31
+ <a href="https://patreon.com/galtzo" title="Donate to my FLOSS or refugee efforts using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a>
32
+ </span>
33
+
34
+ </div>
35
+
36
+ [⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
37
+ [⛳liberapay]: https://liberapay.com/pboling/donate
38
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
39
+ [🖇sponsor]: https://github.com/sponsors/pboling
40
+
41
+ ## Compatibility
42
+
43
+ * ⚙️ Ruby >= 2.7, plus JRuby and Truffleruby, but only non-EOL Rubies are officially supported
44
+ * ⚙️ Rails >= 7.0 (actually, it only requires `activerecord`)
45
+
46
+ <!--
47
+ Numbering rows and badges in each row as a visual "database" lookup,
48
+ as the table is extremely dense, and it can be very difficult to find anything
49
+ Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
50
+
51
+ row #s:
52
+ 1️⃣
53
+ 2️⃣
54
+ 3️⃣
55
+ 4️⃣
56
+ 5️⃣
57
+ 6️⃣
58
+ 7️⃣
59
+
60
+ badge #s:
61
+ ⛳️
62
+ 🖇
63
+ 🏘
64
+ 🚎
65
+ 🖐
66
+ 🧮
67
+ 📗
68
+
69
+ appended indicators:
70
+ ♻️ / 🔑 - Tagged URLs need to be updated from SAAS integration. Find / Replace is insufficient.
71
+ -->
72
+
73
+ | | Project | bundle add active_security |
74
+ |:----|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
75
+ | 1️⃣ | name, license, docs, standards | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] [![RubyDoc.info][🚎yard-img]][🚎yard] [![YARD Documentation](http://inch-ci.org/github/pboling/active_security.svg)][🚎yard] [![SemVer 2.0.0][🧮semver-img]][🧮semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] |
76
+ | 2️⃣ | version & activity | [![Gem Version][⛳️version-img]][⛳️gem] [![Total Downloads][🖇DL-total-img]][⛳️gem] [![Download Rank][🏘DL-rank-img]][⛳️gem] [![Source Code][🚎src-main-img]][🚎src-main] [![Open PRs][🖐prs-o-img]][🖐prs-o] [![Closed PRs][🧮prs-c-img]][🧮prs-c] |
77
+ | 3️⃣ | maintenance & linting | [![Maintainability][🔑cc-mnti]][🔑cc-mnt] [![Helpers][🖇triage-help-img]][🖇triage-help] [![Depfu][🔑depfui]][🔑depfu] [![Contributors][🚎contributors-img]][🚎contributors] [![Style][🖐style-wf-img]][🖐style-wf] |
78
+ | 4️⃣ | testing | [![Supported][🏘sup-wf-img]][🏘sup-wf] [![Heads][🚎heads-wf-img]][🚎heads-wf] [![Unsupported][🖐uns-wf-img]][🖐uns-wf] |
79
+ | 5️⃣ | coverage & security | [![CodeClimate][🔑cc-covi]][🔑cc-cov] [![CodeCov][🖇codecov-img♻️]][🖇codecov] [![Coveralls][🏘coveralls-img]][🏘coveralls] [![Security Policy][🚎sec-pol-img]][🚎sec-pol] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Code Coverage][🧮cov-wf-img]][🧮cov-wf] |
80
+ | 6️⃣ | resources | [![Get help on Codementor][🖇codementor-img]][🖇codementor] [![Blog][🚎blog-img]][🚎blog] [![Wiki][🖐wiki-img]][🖐wiki] |
81
+ | 7️⃣ | `...` 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
82
+
83
+ <!--
84
+ The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
85
+ -->
86
+
87
+ <!-- 1️⃣ name, license, docs -->
88
+ [⛳️gem]: https://rubygems.org/gems/active_security
89
+ [⛳️name-img]: https://img.shields.io/badge/name-sanitize__email-brightgreen.svg?style=flat
90
+ [🖇src-license]: https://opensource.org/licenses/MIT
91
+ [🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
92
+ [🚎yard]: https://www.rubydoc.info/gems/active_security
93
+ [🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
94
+ [🧮semver]: http://semver.org/
95
+ [🧮semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
96
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
97
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
98
+
99
+ <!-- 2️⃣ version & activity -->
100
+ [⛳️version-img]: http://img.shields.io/gem/v/active_security.svg
101
+ [🖇DL-total-img]: https://img.shields.io/gem/dt/active_security.svg
102
+ [🏘DL-rank-img]: https://img.shields.io/gem/rt/active_security.svg
103
+ [🚎src-main]: https://gitlab.com/pboling/active_security
104
+ [🚎src-main-img]: https://img.shields.io/badge/source-gitlab-brightgreen.svg?style=flat
105
+ [🖐prs-o]: https://gitlab.com/pboling/active_security/-/merge_requests
106
+ [🖐prs-o-img]: https://img.shields.io/github/issues-pr/pboling/active_security
107
+ [🧮prs-c]: https://github.com/pboling/active_security/pulls?q=is%3Apr+is%3Aclosed
108
+ [🧮prs-c-img]: https://img.shields.io/github/issues-pr-closed/pboling/active_security
109
+
110
+ <!-- 3️⃣ maintenance & linting -->
111
+ [🖇triage-help]: https://www.codetriage.com/pboling/active_security
112
+ [🖇triage-help-img]: https://www.codetriage.com/pboling/active_security/badges/users.svg
113
+ [🚎contributors]: https://gitlab.com/pboling/active_security/-/graphs/main
114
+ [🚎contributors-img]: https://img.shields.io/github/contributors-anon/pboling/active_security
115
+ [🖐style-wf]: https://github.com/pboling/active_security/actions/workflows/style.yml
116
+ [🖐style-wf-img]: https://github.com/pboling/active_security/actions/workflows/style.yml/badge.svg
117
+ <!-- TODO: tokei/lines shields badge is broken -->
118
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
119
+ [🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/pboling/active_security
120
+
121
+ <!-- 4️⃣ testing -->
122
+ [🏘sup-wf]: https://github.com/pboling/active_security/actions/workflows/supported.yml
123
+ [🏘sup-wf-img]: https://github.com/pboling/active_security/actions/workflows/supported.yml/badge.svg
124
+ [🚎heads-wf]: https://github.com/pboling/active_security/actions/workflows/heads.yml
125
+ [🚎heads-wf-img]: https://github.com/pboling/active_security/actions/workflows/heads.yml/badge.svg
126
+ [🖐uns-wf]: https://github.com/pboling/active_security/actions/workflows/unsupported.yml
127
+ [🖐uns-wf-img]: https://github.com/pboling/active_security/actions/workflows/unsupported.yml/badge.svg
128
+
129
+ <!-- 5️⃣ coverage & security -->
130
+ [🖇codecov-img♻️]: https://codecov.io/gh/pboling/active_security/graph/badge.svg?token=Joire8DbSW
131
+ [🖇codecov]: https://codecov.io/gh/pboling/active_security
132
+ [🏘coveralls]: https://coveralls.io/github/pboling/active_security?branch=main
133
+ [🏘coveralls-img]: https://coveralls.io/repos/github/pboling/active_security/badge.svg?branch=main
134
+ [🚎sec-pol]: https://gitlab.com/pboling/active_security/-/blob/main/SECURITY.md
135
+ [🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
136
+ [🖐codeQL]: https://github.com/pboling/active_security/security/code-scanning
137
+ [🖐codeQL-img]: https://github.com/pboling/active_security/actions/workflows/codeql-analysis.yml/badge.svg
138
+ [🧮cov-wf]: https://github.com/pboling/active_security/actions/workflows/coverage.yml
139
+ [🧮cov-wf-img]: https://github.com/pboling/active_security/actions/workflows/coverage.yml/badge.svg
140
+
141
+ <!-- 6️⃣ resources -->
142
+ [🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
143
+ [🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
144
+ [🚎blog]: http://www.railsbling.com/tags/active_security/
145
+ [🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
146
+ [🖐wiki]: https://gitlab.com/pboling/active_security/-/wikis/home
147
+ [🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
148
+
149
+ <!-- 7️⃣ spread 💖 -->
150
+ [🐦tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow%20%40galtzo
151
+ [🐦tweet]: http://twitter.com/galtzo
152
+ [🚎blog]: http://www.railsbling.com/tags/debug_logging/
153
+ [🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
154
+ [🖇linkedin]: http://www.linkedin.com/in/peterboling
155
+ [🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-blue?style=plastic&logo=linkedin
156
+ [✌️wellfound]: https://angel.co/u/peter-boling
157
+ [✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=plastic&logo=wellfound
158
+ [💲crunchbase]: https://www.crunchbase.com/person/peter-boling
159
+ [💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=plastic&logo=crunchbase
160
+ [🐘ruby-mast]: https://ruby.social/@galtzo
161
+ [🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
162
+ [🐘floss-mast]: https://floss.social/@galtzo
163
+ [🐘floss-mast-img]: https://img.shields.io/mastodon/follow/110304921404405715?domain=https%3A%2F%2Ffloss.social&style=plastic&logo=mastodon&label=FLOSS%20%40galtzo
164
+ [🐘mast]: https://mastodon.social/@galtzo
165
+ [🐘mast-img]: https://img.shields.io/mastodon/follow/000924127?domain=https%3A%2F%2Fmastodon.social&style=plastic&logo=mastodon&label=Mastodon%20%40galtzo
166
+ [🌳linktree]: https://linktr.ee/galtzo
167
+ [🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
168
+
169
+ <!-- Maintainer Contact Links -->
170
+ [aboutme]: https://about.me/peter.boling
171
+ [coderme]: https://coderwall.com/Peter%20Boling
172
+
173
+ ## Installation
174
+
175
+ Install the gem and add to the application's Gemfile by executing:
176
+
177
+ $ bundle add active_security
178
+
179
+ If bundler is not being used to manage dependencies, install the gem by executing:
180
+
181
+ $ gem install active_security
182
+
183
+ ## Documentation
184
+
185
+ All documentation is in the source for now, but there is a lot of it.
186
+ If you'd like to help add documentation to this readme, please submit a pull request.
187
+
188
+ ## Running Specs
189
+
190
+ The basic compatibility matrix:
191
+ ```sh
192
+ appraisal install
193
+ appraisal rake test
194
+ ```
195
+
196
+ Sometimes also:
197
+ ```sh
198
+ BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal update
199
+ ```
200
+
201
+ NOTE: This results in bad paths to the gemspec.
202
+ `gemspec path: "../../"` needs to be replaced with `gemspec path: "../"` in each Appraisal gemfile.
203
+
204
+ ### Code Coverage
205
+
206
+ [![Coverage Graph][🔑codecov-g]][🖇codecov]
207
+
208
+ [🔑codecov-g]: https://codecov.io/gh/pboling/active_security/graphs/tree.svg?token=hk0IktRjVc
209
+
210
+ ## 🪇 Code of Conduct
211
+
212
+ Everyone interacting in this project's codebases, issue trackers,
213
+ chat rooms and mailing lists is expected to follow the [code of conduct][🪇conduct].
214
+
215
+ [🪇conduct]: CODE_OF_CONDUCT.md
216
+
217
+ ## 📌 Versioning
218
+
219
+ This Library adheres to [Semantic Versioning 2.0.0][📌semver].
220
+ Violations of this scheme should be reported as bugs.
221
+ Specifically, if a minor or patch version is released that breaks backward compatibility,
222
+ a new version should be immediately released that restores compatibility.
223
+ Breaking changes to the public API will only be introduced with new major versions.
224
+
225
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
226
+ read this article from the creator of SemVer:
227
+
228
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
229
+
230
+ As a result of this policy, you can (and should) specify a dependency on these libraries using
231
+ the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
232
+
233
+ For example:
234
+
235
+ ```ruby
236
+ spec.add_dependency("active_security", "~> 1.0")
237
+ ```
238
+
239
+ [comment]: <> ( 📌 VERSIONING LINKS )
240
+
241
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
242
+ [📌semver]: http://semver.org/
243
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
244
+
245
+ ## 📄 License
246
+
247
+ The gem is available as open source under the terms of
248
+ the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
249
+ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
250
+
251
+ [comment]: <> ( 📄 LEGAL LINKS )
252
+
253
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
254
+ [📄license]: LICENSE.txt
255
+ [📄license-ref]: https://opensource.org/licenses/MIT
256
+ [📄license-img]: https://img.shields.io/badge/License-MIT-green.svg
257
+
258
+ ### © Copyright
259
+
260
+ * Copyright (c) 2024 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
261
+
262
+ [railsbling]: http://www.railsbling.com
263
+ [peterboling]: http://www.peterboling.com
data/SECURITY.md ADDED
@@ -0,0 +1,13 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ | Version | Supported |
6
+ |---------|-----------|
7
+ | 0.x | ✅ |
8
+
9
+ ## Reporting a Vulnerability
10
+
11
+ Peter Boling is the primary maintainer of this gem. Please find a way
12
+ to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
13
+ possible.