asherah 0.9.1 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/NATIVE_VERSION +1 -0
- data/README.md +336 -56
- data/ext/asherah/asherah.c +2 -0
- data/ext/asherah/extconf.rb +6 -4
- data/ext/asherah/fetch_native.rb +196 -0
- data/lib/asherah/config.rb +64 -74
- data/lib/asherah/error.rb +11 -25
- data/lib/asherah/hooks.rb +239 -0
- data/lib/asherah/native.rb +146 -0
- data/lib/asherah/session.rb +176 -0
- data/lib/asherah/session_factory.rb +35 -0
- data/lib/asherah/version.rb +1 -1
- data/lib/asherah.rb +286 -100
- metadata +44 -34
- data/.env.secrets.example +0 -9
- data/.rspec +0 -3
- data/.rubocop.yml +0 -112
- data/.ruby-version +0 -1
- data/CHANGELOG.md +0 -135
- data/CODE_OF_CONDUCT.md +0 -77
- data/CONTRIBUTING.md +0 -118
- data/Gemfile +0 -14
- data/LICENSE.txt +0 -21
- data/Rakefile +0 -29
- data/SECURITY.md +0 -19
- data/asherah.gemspec +0 -39
- data/ext/asherah/checksums.yml +0 -5
- data/ext/asherah/native_file.rb +0 -64
metadata
CHANGED
|
@@ -1,66 +1,76 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: asherah
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
-
|
|
7
|
+
- Jay Gowdy
|
|
8
|
+
- Bo Thompson
|
|
9
|
+
- Michael Micco
|
|
10
|
+
- Dalibor Nasevic
|
|
8
11
|
autorequire:
|
|
9
|
-
bindir:
|
|
12
|
+
bindir: bin
|
|
10
13
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
14
|
+
date: 2026-06-05 00:00:00.000000000 Z
|
|
12
15
|
dependencies:
|
|
13
16
|
- !ruby/object:Gem::Dependency
|
|
14
|
-
name:
|
|
17
|
+
name: ffi
|
|
15
18
|
requirement: !ruby/object:Gem::Requirement
|
|
16
19
|
requirements:
|
|
17
20
|
- - "~>"
|
|
18
21
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
22
|
+
version: '1.15'
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
26
|
requirements:
|
|
24
27
|
- - "~>"
|
|
25
28
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
-
|
|
29
|
+
version: '1.15'
|
|
30
|
+
- !ruby/object:Gem::Dependency
|
|
31
|
+
name: logger
|
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
|
33
|
+
requirements:
|
|
34
|
+
- - "~>"
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: '1.6'
|
|
37
|
+
type: :runtime
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - "~>"
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: '1.6'
|
|
44
|
+
description: Asherah application-layer encryption for Ruby with automatic key rotation,
|
|
45
|
+
powered by the native Rust implementation.
|
|
46
|
+
email: oss@godaddy.com
|
|
32
47
|
executables: []
|
|
33
48
|
extensions:
|
|
34
49
|
- ext/asherah/extconf.rb
|
|
35
50
|
extra_rdoc_files: []
|
|
36
51
|
files:
|
|
37
|
-
-
|
|
38
|
-
- ".rspec"
|
|
39
|
-
- ".rubocop.yml"
|
|
40
|
-
- ".ruby-version"
|
|
41
|
-
- CHANGELOG.md
|
|
42
|
-
- CODE_OF_CONDUCT.md
|
|
43
|
-
- CONTRIBUTING.md
|
|
44
|
-
- Gemfile
|
|
45
|
-
- LICENSE.txt
|
|
52
|
+
- NATIVE_VERSION
|
|
46
53
|
- README.md
|
|
47
|
-
-
|
|
48
|
-
- SECURITY.md
|
|
49
|
-
- asherah.gemspec
|
|
50
|
-
- ext/asherah/checksums.yml
|
|
54
|
+
- ext/asherah/asherah.c
|
|
51
55
|
- ext/asherah/extconf.rb
|
|
52
|
-
- ext/asherah/
|
|
56
|
+
- ext/asherah/fetch_native.rb
|
|
53
57
|
- lib/asherah.rb
|
|
54
58
|
- lib/asherah/config.rb
|
|
55
59
|
- lib/asherah/error.rb
|
|
60
|
+
- lib/asherah/hooks.rb
|
|
61
|
+
- lib/asherah/native.rb
|
|
62
|
+
- lib/asherah/session.rb
|
|
63
|
+
- lib/asherah/session_factory.rb
|
|
56
64
|
- lib/asherah/version.rb
|
|
57
|
-
homepage: https://github.com/godaddy/asherah-
|
|
65
|
+
homepage: https://github.com/godaddy/asherah-ffi
|
|
58
66
|
licenses:
|
|
59
|
-
-
|
|
67
|
+
- Apache-2.0
|
|
60
68
|
metadata:
|
|
61
|
-
homepage_uri: https://github.com/godaddy/asherah-
|
|
62
|
-
source_code_uri: https://github.com/godaddy/asherah-
|
|
63
|
-
|
|
69
|
+
homepage_uri: https://github.com/godaddy/asherah-ffi
|
|
70
|
+
source_code_uri: https://github.com/godaddy/asherah-ffi
|
|
71
|
+
github_repo: https://github.com/godaddy/asherah-ffi
|
|
72
|
+
changelog_uri: https://github.com/godaddy/asherah-ffi/releases
|
|
73
|
+
bug_tracker_uri: https://github.com/godaddy/asherah-ffi/issues
|
|
64
74
|
rubygems_mfa_required: 'true'
|
|
65
75
|
post_install_message:
|
|
66
76
|
rdoc_options: []
|
|
@@ -70,15 +80,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
70
80
|
requirements:
|
|
71
81
|
- - ">="
|
|
72
82
|
- !ruby/object:Gem::Version
|
|
73
|
-
version:
|
|
83
|
+
version: '3.0'
|
|
74
84
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
85
|
requirements:
|
|
76
86
|
- - ">="
|
|
77
87
|
- !ruby/object:Gem::Version
|
|
78
88
|
version: '0'
|
|
79
89
|
requirements: []
|
|
80
|
-
rubygems_version: 3.
|
|
90
|
+
rubygems_version: 3.5.22
|
|
81
91
|
signing_key:
|
|
82
92
|
specification_version: 4
|
|
83
|
-
summary:
|
|
93
|
+
summary: Asherah application-layer encryption for Ruby with automatic key rotation.
|
|
84
94
|
test_files: []
|
data/.env.secrets.example
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
# Example secrets file for KMS integration tests
|
|
2
|
-
# Copy this file to .env.secrets and fill in actual values
|
|
3
|
-
#
|
|
4
|
-
# IMPORTANT: Never commit .env.secrets to version control
|
|
5
|
-
# The .env.secrets file is already in .gitignore
|
|
6
|
-
|
|
7
|
-
# AWS KMS Key ARN for integration tests (optional)
|
|
8
|
-
# Only needed if running spec/kms_spec.rb
|
|
9
|
-
# KMS_KEY_ARN=arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
|
data/.rspec
DELETED
data/.rubocop.yml
DELETED
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
AllCops:
|
|
2
|
-
TargetRubyVersion: 2.7
|
|
3
|
-
NewCops: enable
|
|
4
|
-
SuggestExtensions: false
|
|
5
|
-
Exclude:
|
|
6
|
-
- 'vendor/**/*' # Github Actions
|
|
7
|
-
- 'tmp/**/*'
|
|
8
|
-
|
|
9
|
-
Layout/LineLength:
|
|
10
|
-
Max: 120
|
|
11
|
-
|
|
12
|
-
# Metrics cops with reasonable limits
|
|
13
|
-
Metrics/BlockLength:
|
|
14
|
-
Max: 25
|
|
15
|
-
Exclude:
|
|
16
|
-
- 'spec/**/*'
|
|
17
|
-
- '*.gemspec'
|
|
18
|
-
- 'Rakefile'
|
|
19
|
-
|
|
20
|
-
Metrics/MethodLength:
|
|
21
|
-
Max: 15
|
|
22
|
-
Exclude:
|
|
23
|
-
- 'spec/**/*'
|
|
24
|
-
- 'tasks/**/*'
|
|
25
|
-
|
|
26
|
-
Metrics/AbcSize:
|
|
27
|
-
Max: 20
|
|
28
|
-
Exclude:
|
|
29
|
-
- 'spec/**/*'
|
|
30
|
-
- 'tasks/**/*'
|
|
31
|
-
|
|
32
|
-
Metrics/CyclomaticComplexity:
|
|
33
|
-
Max: 10
|
|
34
|
-
Exclude:
|
|
35
|
-
- 'spec/**/*'
|
|
36
|
-
|
|
37
|
-
Metrics/PerceivedComplexity:
|
|
38
|
-
Max: 10
|
|
39
|
-
Exclude:
|
|
40
|
-
- 'spec/**/*'
|
|
41
|
-
|
|
42
|
-
Metrics/ClassLength:
|
|
43
|
-
Max: 150
|
|
44
|
-
Exclude:
|
|
45
|
-
- 'spec/**/*'
|
|
46
|
-
|
|
47
|
-
Metrics/ModuleLength:
|
|
48
|
-
Max: 150
|
|
49
|
-
Exclude:
|
|
50
|
-
- 'spec/**/*'
|
|
51
|
-
|
|
52
|
-
# Style cops that were disabled but should be enabled
|
|
53
|
-
Style/WordArray:
|
|
54
|
-
MinSize: 3
|
|
55
|
-
EnforcedStyle: brackets
|
|
56
|
-
|
|
57
|
-
Style/SymbolArray:
|
|
58
|
-
MinSize: 3
|
|
59
|
-
EnforcedStyle: brackets
|
|
60
|
-
|
|
61
|
-
Style/MultilineBlockChain:
|
|
62
|
-
Enabled: true
|
|
63
|
-
Exclude:
|
|
64
|
-
- 'spec/**/*'
|
|
65
|
-
|
|
66
|
-
Style/BlockDelimiters:
|
|
67
|
-
EnforcedStyle: semantic
|
|
68
|
-
FunctionalMethods:
|
|
69
|
-
- let
|
|
70
|
-
- let!
|
|
71
|
-
- subject
|
|
72
|
-
- before
|
|
73
|
-
- after
|
|
74
|
-
Exclude:
|
|
75
|
-
- 'asherah.gemspec'
|
|
76
|
-
- 'ext/asherah/native_file.rb'
|
|
77
|
-
|
|
78
|
-
Style/GuardClause:
|
|
79
|
-
MinBodyLength: 3
|
|
80
|
-
Exclude:
|
|
81
|
-
- 'ext/asherah/native_file.rb'
|
|
82
|
-
|
|
83
|
-
# Naming cop adjustment
|
|
84
|
-
Naming/AccessorMethodName:
|
|
85
|
-
Exclude:
|
|
86
|
-
- 'lib/asherah.rb' # set_env is intentionally named
|
|
87
|
-
|
|
88
|
-
# Documentation cops
|
|
89
|
-
Style/Documentation:
|
|
90
|
-
Enabled: true
|
|
91
|
-
Exclude:
|
|
92
|
-
- 'spec/**/*'
|
|
93
|
-
- 'features/**/*'
|
|
94
|
-
|
|
95
|
-
Style/DocumentationMethod:
|
|
96
|
-
Enabled: false # YARD comments are optional
|
|
97
|
-
|
|
98
|
-
Style/EmptyClassDefinition:
|
|
99
|
-
Enabled: false
|
|
100
|
-
|
|
101
|
-
# Additional cops for code quality
|
|
102
|
-
Lint/UnusedMethodArgument:
|
|
103
|
-
Enabled: true
|
|
104
|
-
|
|
105
|
-
Lint/UnusedBlockArgument:
|
|
106
|
-
Enabled: true
|
|
107
|
-
|
|
108
|
-
Security/Eval:
|
|
109
|
-
Enabled: true
|
|
110
|
-
|
|
111
|
-
Security/JSONLoad:
|
|
112
|
-
Enabled: true
|
data/.ruby-version
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
3.2.2
|
data/CHANGELOG.md
DELETED
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
## [Unreleased]
|
|
2
|
-
|
|
3
|
-
## [0.9.1] - 2026-04-23
|
|
4
|
-
|
|
5
|
-
- Upgrade to use asherah-ffi v0.6.90
|
|
6
|
-
|
|
7
|
-
## [0.9.0] - 2026-03-20
|
|
8
|
-
|
|
9
|
-
- Replace asherah-cobhan with asherah-ffi v0.6.44
|
|
10
|
-
- Remove null_data_check configuration option
|
|
11
|
-
|
|
12
|
-
## [0.8.2] - 2026-03-09
|
|
13
|
-
|
|
14
|
-
- Upgrade to use asherah-cobhan v0.5.3
|
|
15
|
-
- Add null_data_check configuration option
|
|
16
|
-
|
|
17
|
-
## [0.8.1] - 2026-03-05
|
|
18
|
-
|
|
19
|
-
- Upgrade to use asherah-cobhan v0.5.1
|
|
20
|
-
- Fix buffer undersize from float truncation in estimate_buffer
|
|
21
|
-
|
|
22
|
-
## [0.8.0] - 2026-03-04
|
|
23
|
-
|
|
24
|
-
- Upgrade to use asherah-cobhan v0.5.0
|
|
25
|
-
- Expose disable_zero_copy config option to disable zero-copy FFI input buffers
|
|
26
|
-
|
|
27
|
-
## [0.7.0] - 2025-08-15
|
|
28
|
-
|
|
29
|
-
- Fix memory leak risks in buffer management
|
|
30
|
-
- Fix inconsistent NotInitialized error handling across all methods
|
|
31
|
-
- Fix overly permissive RuboCop configuration
|
|
32
|
-
- Add Dependabot configuration for automated dependency updates
|
|
33
|
-
- Update dependencies and Github actions
|
|
34
|
-
- Update Go version to 1.24 for cross-language tests
|
|
35
|
-
|
|
36
|
-
## [0.6.0] - 2025-03-19
|
|
37
|
-
|
|
38
|
-
- Upgrade to use asherah-cobhan v0.4.35
|
|
39
|
-
- Requires minimum GLIBC 2.32 version
|
|
40
|
-
|
|
41
|
-
## [0.5.2] - 2024-01-15
|
|
42
|
-
|
|
43
|
-
- Upgrade to use asherah-cobhan v0.4.32
|
|
44
|
-
|
|
45
|
-
## [0.5.1] - 2023-10-25
|
|
46
|
-
|
|
47
|
-
- Add `sql_metastore_db_type` config option to support PostgresSQL adapter for Asherah
|
|
48
|
-
- Upgrade to use asherah-cobhan v0.4.31
|
|
49
|
-
|
|
50
|
-
## [0.5.0] - 2023-10-16
|
|
51
|
-
|
|
52
|
-
- Upgrade to use asherah-cobhan v0.4.30
|
|
53
|
-
- Expose `test-debug-static` kms type and `test-debug-memory` metastore type to skip warnings in tests
|
|
54
|
-
- Check initialized flag on setup/shutdown and raise appropriate errors
|
|
55
|
-
|
|
56
|
-
## [0.4.10] - 2023-08-10
|
|
57
|
-
|
|
58
|
-
- Upgrade to use asherah-cobhan v0.4.25
|
|
59
|
-
|
|
60
|
-
## [0.4.9] - 2023-07-05
|
|
61
|
-
|
|
62
|
-
- Upgrade to use asherah-cobhan v0.4.24
|
|
63
|
-
|
|
64
|
-
## [0.4.8] - 2023-06-06
|
|
65
|
-
|
|
66
|
-
- Upgrade to use asherah-cobhan v0.4.23
|
|
67
|
-
|
|
68
|
-
## [0.4.7] - 2023-04-20
|
|
69
|
-
|
|
70
|
-
- Upgrade to use asherah-cobhan v0.4.22
|
|
71
|
-
- Change detault ruby version to 3.2.2
|
|
72
|
-
|
|
73
|
-
## [0.4.6] - 2023-03-17
|
|
74
|
-
|
|
75
|
-
- Upgrade to use asherah-cobhan v0.4.20
|
|
76
|
-
- Change detault ruby version to 3.2
|
|
77
|
-
- Add ruby 3.2 to build matrix
|
|
78
|
-
- Remove ruby 2.5 and 2.6 from build matrix
|
|
79
|
-
|
|
80
|
-
## [0.4.5] - 2022-10-31
|
|
81
|
-
|
|
82
|
-
- Upgrade to use asherah-cobhan v0.4.18
|
|
83
|
-
|
|
84
|
-
## [0.4.4] - 2022-09-14
|
|
85
|
-
|
|
86
|
-
- Upgrade to use asherah-cobhan v0.4.17
|
|
87
|
-
|
|
88
|
-
## [0.4.3] - 2022-08-31
|
|
89
|
-
|
|
90
|
-
- Upgrade to use asherah-cobhan v0.4.16
|
|
91
|
-
|
|
92
|
-
## [0.4.2] - 2022-07-25
|
|
93
|
-
|
|
94
|
-
- Upgrade to use asherah-cobhan v0.4.15
|
|
95
|
-
- Add `set_env` method to set environment variables for Asherah
|
|
96
|
-
|
|
97
|
-
## [0.4.1] - 2022-03-25
|
|
98
|
-
|
|
99
|
-
- Build and release platform gems
|
|
100
|
-
|
|
101
|
-
## [0.4.0] - 2022-03-25
|
|
102
|
-
|
|
103
|
-
- Download native file during gem install and verify checksum
|
|
104
|
-
- Upgrade to use asherah-cobhan v0.4.11
|
|
105
|
-
|
|
106
|
-
## [0.3.0] - 2022-03-22
|
|
107
|
-
|
|
108
|
-
- Free up cobhan buffers after encrypt/decrypt to prevent growing heap memory
|
|
109
|
-
- Use local `estimate_buffer` calculation instead of FFI call
|
|
110
|
-
- Upgrade to use asherah-cobhan v0.4.3
|
|
111
|
-
|
|
112
|
-
## [0.2.0] - 2022-03-21
|
|
113
|
-
|
|
114
|
-
- Implement versioning for asherah-cobhan binaries
|
|
115
|
-
- Upgrade to use asherah-cobhan v0.3.1
|
|
116
|
-
- Add BadConfig error and expose error codes
|
|
117
|
-
- Remove DRR methods and use JSON exclusively
|
|
118
|
-
- Cross language testing using Asherah Go
|
|
119
|
-
|
|
120
|
-
## [0.1.0] - 2022-03-14
|
|
121
|
-
|
|
122
|
-
- First official release
|
|
123
|
-
|
|
124
|
-
## [0.1.0.beta2] - 2022-03-14
|
|
125
|
-
|
|
126
|
-
- Add smoke tests for native gems
|
|
127
|
-
- Change to use `SetupJson` instead of `Setup`
|
|
128
|
-
- Update config options to make them consistent with Asherah Go
|
|
129
|
-
- Add `shutdown`
|
|
130
|
-
- Add `encrypt_to_json` and `decrypt_from_json`
|
|
131
|
-
- Add coverage report
|
|
132
|
-
|
|
133
|
-
## [0.1.0.beta1] - 2022-03-07
|
|
134
|
-
|
|
135
|
-
- Initial proof of concept
|
data/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
-
contributors and maintainers pledge to making participation in our project and
|
|
7
|
-
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
-
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
9
|
-
level of experience, education, socio-economic status, nationality, personal
|
|
10
|
-
appearance, race, religion, or sexual identity and orientation.
|
|
11
|
-
|
|
12
|
-
## Our Standards
|
|
13
|
-
|
|
14
|
-
Examples of behavior that contributes to creating a positive environment
|
|
15
|
-
include:
|
|
16
|
-
|
|
17
|
-
* Using welcoming and inclusive language
|
|
18
|
-
* Being respectful of differing viewpoints and experiences
|
|
19
|
-
* Gracefully accepting constructive criticism
|
|
20
|
-
* Focusing on what is best for the community
|
|
21
|
-
* Showing empathy towards other community members
|
|
22
|
-
|
|
23
|
-
Examples of unacceptable behavior by participants include:
|
|
24
|
-
|
|
25
|
-
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
-
advances
|
|
27
|
-
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
-
* Public or private harassment
|
|
29
|
-
* Publishing others' private information, such as a physical or electronic
|
|
30
|
-
address, without explicit permission
|
|
31
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
-
professional setting
|
|
33
|
-
|
|
34
|
-
## Our Responsibilities
|
|
35
|
-
|
|
36
|
-
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
-
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
-
response to any instances of unacceptable behavior.
|
|
39
|
-
|
|
40
|
-
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
-
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
-
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
-
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
-
threatening, offensive, or harmful.
|
|
45
|
-
|
|
46
|
-
## Scope
|
|
47
|
-
|
|
48
|
-
This Code of Conduct applies within all project spaces, and it also applies when
|
|
49
|
-
an individual is representing the project or its community in public spaces.
|
|
50
|
-
Examples of representing a project or community include using an official
|
|
51
|
-
project e-mail address, posting via an official social media account, or acting
|
|
52
|
-
as an appointed representative at an online or offline event. Representation of
|
|
53
|
-
a project may be further defined and clarified by project maintainers.
|
|
54
|
-
|
|
55
|
-
## Enforcement
|
|
56
|
-
|
|
57
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
-
reported by contacting the project team at oss@godaddy.com. All
|
|
59
|
-
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
-
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
-
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
-
Further details of specific enforcement policies may be posted separately.
|
|
63
|
-
|
|
64
|
-
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
-
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
-
members of the project's leadership.
|
|
67
|
-
|
|
68
|
-
## Attribution
|
|
69
|
-
|
|
70
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
72
|
-
|
|
73
|
-
[homepage]: https://www.contributor-covenant.org
|
|
74
|
-
|
|
75
|
-
For answers to common questions about this code of conduct, see
|
|
76
|
-
https://www.contributor-covenant.org/faq
|
|
77
|
-
|
data/CONTRIBUTING.md
DELETED
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
Everyone is welcome to contribute to GoDaddy's Open Source Software.
|
|
4
|
-
Contributing doesn’t just mean submitting pull requests. To get involved,
|
|
5
|
-
you can report or triage bugs, and participate in discussions on the
|
|
6
|
-
evolution of each project.
|
|
7
|
-
|
|
8
|
-
No matter how you want to get involved, we ask that you first learn what’s
|
|
9
|
-
expected of anyone who participates in the project by reading the Contribution
|
|
10
|
-
Guidelines and our [Code of Conduct][coc].
|
|
11
|
-
|
|
12
|
-
## Answering Questions
|
|
13
|
-
|
|
14
|
-
One of the most important and immediate ways you can support this project is
|
|
15
|
-
to answer questions on [Github][issues]. Whether you’re
|
|
16
|
-
helping a newcomer understand a feature or troubleshooting an edge case with a
|
|
17
|
-
seasoned developer, your knowledge and experience with a programming language
|
|
18
|
-
can go a long way to help others.
|
|
19
|
-
|
|
20
|
-
## Reporting Bugs
|
|
21
|
-
|
|
22
|
-
**Do not report potential security vulnerabilities here. Refer to
|
|
23
|
-
[SECURITY.md](./SECURITY.md) for more details about the process of reporting
|
|
24
|
-
security vulnerabilities.**
|
|
25
|
-
|
|
26
|
-
Before submitting a ticket, please search our [Issue Tracker][issues] to make
|
|
27
|
-
sure it does not already exist and have a simple replication of the behavior. If
|
|
28
|
-
the issue is isolated to one of the dependencies of this project, please create
|
|
29
|
-
a Github issue in that project. All dependencies should be open source software
|
|
30
|
-
and can be found on Github.
|
|
31
|
-
|
|
32
|
-
Submit a ticket for your issue, assuming one does not already exist:
|
|
33
|
-
|
|
34
|
-
- Create it on the project's [issue Tracker][issues].
|
|
35
|
-
- Clearly describe the issue by following the template layout
|
|
36
|
-
- Make sure to include steps to reproduce the bug.
|
|
37
|
-
- A reproducible (unit) test could be helpful in solving the bug.
|
|
38
|
-
- Describe the environment that (re)produced the problem.
|
|
39
|
-
|
|
40
|
-
## Triaging bugs or contributing code
|
|
41
|
-
|
|
42
|
-
If you're triaging a bug, first make sure that you can reproduce it. Once a bug
|
|
43
|
-
can be reproduced, reduce it to the smallest amount of code possible. Reasoning
|
|
44
|
-
about a sample or unit test that reproduces a bug in just a few lines of code
|
|
45
|
-
is easier than reasoning about a longer sample.
|
|
46
|
-
|
|
47
|
-
From a practical perspective, contributions are as simple as:
|
|
48
|
-
|
|
49
|
-
1. Fork and clone the repo, [see Github's instructions if you need help.][fork]
|
|
50
|
-
1. Create a branch for your PR with `git checkout -b pr/your-branch-name`
|
|
51
|
-
1. Make changes on the branch of your forked repository.
|
|
52
|
-
1. When committing, reference your issue (if present) and include a note about
|
|
53
|
-
the fix.
|
|
54
|
-
1. Please also add/update unit tests for your changes.
|
|
55
|
-
1. Push the changes to your fork and submit a pull request to the 'main
|
|
56
|
-
development branch' branch of the projects' repository.
|
|
57
|
-
|
|
58
|
-
If you are interested in making a large change and feel unsure about its overall
|
|
59
|
-
effect, start with opening an Issue in the project's [Issue Tracker][issues]
|
|
60
|
-
with a high-level proposal and discuss it with the core contributors through
|
|
61
|
-
Github comments. After reaching a consensus with core
|
|
62
|
-
contributors about the change, discuss the best way to go about implementing it.
|
|
63
|
-
|
|
64
|
-
> Tip: Keep your main branch pointing at the original repository and make
|
|
65
|
-
> pull requests from branches on your fork. To do this, run:
|
|
66
|
-
>
|
|
67
|
-
> ```sh
|
|
68
|
-
> git remote add upstream https://github.com/godaddy/asherah-ruby.git
|
|
69
|
-
> git fetch upstream
|
|
70
|
-
> git branch --set-upstream-to=upstream/main main
|
|
71
|
-
> ```
|
|
72
|
-
>
|
|
73
|
-
> This will add the original repository as a "remote" called "upstream," Then
|
|
74
|
-
> fetch the git information from that remote, then set your local main
|
|
75
|
-
> branch to use the upstream main branch whenever you run git pull. Then you
|
|
76
|
-
> can make all of your pull request branches based on this main branch.
|
|
77
|
-
> Whenever you want to update your version of main, do a regular git pull.
|
|
78
|
-
|
|
79
|
-
## Code Review
|
|
80
|
-
|
|
81
|
-
Any open source project relies heavily on code review to improve software
|
|
82
|
-
quality. All significant changes, by all developers, must be reviewed before
|
|
83
|
-
they are committed to the repository. Code reviews are conducted on GitHub
|
|
84
|
-
through comments on pull requests or commits. The developer responsible for a
|
|
85
|
-
code change is also responsible for making all necessary review-related changes.
|
|
86
|
-
|
|
87
|
-
Sometimes code reviews will take longer than you would hope for, especially for
|
|
88
|
-
larger features. Here are some accepted ways to speed up review times for your
|
|
89
|
-
patches:
|
|
90
|
-
|
|
91
|
-
- Review other people’s changes. If you help out, others will more likely be
|
|
92
|
-
willing to do the same for you.
|
|
93
|
-
- Split your change into multiple smaller changes. The smaller your change,
|
|
94
|
-
the higher the probability that somebody will take a quick look at it.
|
|
95
|
-
|
|
96
|
-
**Note that anyone is welcome to review and give feedback on a change, but only
|
|
97
|
-
people with commit access to the repository can approve it.**
|
|
98
|
-
|
|
99
|
-
## Attribution of Changes
|
|
100
|
-
|
|
101
|
-
When contributors submit a change to this project, after that change is
|
|
102
|
-
approved, other developers with commit access may commit it for the author. When
|
|
103
|
-
doing so, it is important to retain correct attribution of the contribution.
|
|
104
|
-
Generally speaking, Git handles attribution automatically.
|
|
105
|
-
|
|
106
|
-
## Code Style and Documentation
|
|
107
|
-
|
|
108
|
-
Ensure that your contribution follows the standards set by the project's style
|
|
109
|
-
guide with respect to patterns, naming, documentation and testing.
|
|
110
|
-
|
|
111
|
-
# Additional Resources
|
|
112
|
-
|
|
113
|
-
- [General GitHub Documentation](https://help.github.com/)
|
|
114
|
-
- [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
|
|
115
|
-
|
|
116
|
-
[issues]: https://github.com/godaddy/asherah-ruby/issues/
|
|
117
|
-
[coc]: ./CODE_OF_CONDUCT.md
|
|
118
|
-
[fork]: https://help.github.com/en/articles/fork-a-repo
|
data/Gemfile
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
source 'https://rubygems.org'
|
|
4
|
-
|
|
5
|
-
# Specify your gem's dependencies in asherah.gemspec
|
|
6
|
-
gemspec
|
|
7
|
-
|
|
8
|
-
gem 'cucumber', '~> 9.2.1'
|
|
9
|
-
gem 'dotenv', '~> 2.8.1'
|
|
10
|
-
gem 'rake', '~> 13.0'
|
|
11
|
-
gem 'rspec', '~> 3.13.1'
|
|
12
|
-
gem 'rubocop', '~> 1.7'
|
|
13
|
-
gem 'simplecov', '~> 0.22.0'
|
|
14
|
-
gem 'simplecov-console', '~> 0.9.1'
|
data/LICENSE.txt
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2022 GoDaddy Operating Company, LLC.
|
|
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 all
|
|
13
|
-
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 THE
|
|
21
|
-
SOFTWARE.
|
data/Rakefile
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require 'bundler/gem_tasks'
|
|
4
|
-
require 'rspec/core/rake_task'
|
|
5
|
-
|
|
6
|
-
RSpec::Core::RakeTask.new(:spec)
|
|
7
|
-
|
|
8
|
-
require 'rubocop/rake_task'
|
|
9
|
-
|
|
10
|
-
RuboCop::RakeTask.new
|
|
11
|
-
|
|
12
|
-
desc 'Download the binary for the current platform'
|
|
13
|
-
task :download do
|
|
14
|
-
tmp_dir = 'tmp'
|
|
15
|
-
FileUtils.mkdir_p(tmp_dir)
|
|
16
|
-
FileUtils.cd(tmp_dir, verbose: true) do
|
|
17
|
-
system('ruby ../ext/asherah/extconf.rb')
|
|
18
|
-
end
|
|
19
|
-
end
|
|
20
|
-
|
|
21
|
-
task default: [:spec, :rubocop]
|
|
22
|
-
task spec: :download
|
|
23
|
-
|
|
24
|
-
desc 'Print current version'
|
|
25
|
-
task :version do
|
|
26
|
-
puts Asherah::VERSION
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
Rake.add_rakelib 'tasks'
|
data/SECURITY.md
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# Reporting Security Issues
|
|
2
|
-
|
|
3
|
-
We take security very seriously at GoDaddy. We appreciate your efforts to
|
|
4
|
-
responsibly disclose your findings, and will make every effort to acknowledge
|
|
5
|
-
your contributions.
|
|
6
|
-
|
|
7
|
-
## Where should I report security issues?
|
|
8
|
-
|
|
9
|
-
In order to give the community time to respond and upgrade, we strongly urge you
|
|
10
|
-
report all security issues privately.
|
|
11
|
-
|
|
12
|
-
To report a security issue in one of our Open Source projects email us directly
|
|
13
|
-
at **oss@godaddy.com** and include the word "SECURITY" in the subject line.
|
|
14
|
-
|
|
15
|
-
This mail is delivered to our Open Source Security team.
|
|
16
|
-
|
|
17
|
-
After the initial reply to your report, the team will keep you informed of the
|
|
18
|
-
progress being made towards a fix and announcement, and may ask for additional
|
|
19
|
-
information or guidance.
|