Merge pull request #15 from on-strum/develop

OnStrum::Healthcheck v0.1.0
on-strum · Mar 26, 2024 · 8c2703a · 8c2703a
2 parents 244dfaa + 87fa612
commit 8c2703a
Show file tree

Hide file tree

Showing 54 changed files with 1,660 additions and 120 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,7 @@
 version: 2.1
 
 defaults: &defaults
-  working_directory: ~/ruby-on-strum-gem-name
+  working_directory: ~/ruby-on-strum-healthcheck
   docker:
     - image: cimg/ruby:<< parameters.ruby-version >>
 
@@ -44,12 +44,12 @@ references:
   use_latest_gemspec: &use_latest_gemspec
     run:
       name: Using latest gemspec
-      command: cp .circleci/gemspecs/latest on_strum-gem_name.gemspec
+      command: cp .circleci/gemspecs/latest on_strum-healthcheck.gemspec
 
   use_compatible_gemspec: &use_compatible_gemspec
     run:
       name: Using compatible gemspec
-      command: cp .circleci/gemspecs/compatible on_strum-gem_name.gemspec
+      command: cp .circleci/gemspecs/compatible on_strum-healthcheck.gemspec
 
 jobs:
   linters-ruby:
@@ -119,7 +119,7 @@ jobs:
 
       - store_artifacts:
           name: Saving Simplecov coverage artifacts
-          path: ~/ruby-on-strum-gem-name/coverage
+          path: ~/ruby-on-strum-healthcheck/coverage
           destination: coverage
 
       - deploy:
@@ -174,7 +174,7 @@ jobs:
 
       - add_ssh_keys:
           fingerprints:
-            - "SO:ME:FIN:G:ER:PR:IN:T"
+            - "SHA256:eJhlVtu2gws5rDavHcqZ5GJF/aS8kCctMprdC+Twlns"
 
       - run:
           name: Publishing new release

diff --git a/.circleci/gemspecs/compatible b/.circleci/gemspecs/compatible
@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require_relative 'lib/on_strum/logs/version'
+require_relative 'lib/on_strum/healthcheck/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'on_strum-gem_name'
-  spec.version       = OnStrum::GemName::VERSION
+  spec.name          = 'on_strum-healthcheck'
+  spec.version       = OnStrum::Healthcheck::VERSION
   spec.authors       = ['Vladislav Trotsenko']
   spec.email         = %w[admin@on-strum.org]
-  spec.summary       = %(on_strum-gem_name)
-  spec.description   = %(on_strum-gem_name description)
-  spec.homepage      = 'https://github.com/on-strum/ruby-on-strum-gem-name'
+  spec.summary       = %(Simple configurable application healthcheck rack middleware)
+  spec.description   = %(Simple configurable application healthcheck rack middleware.)
+  spec.homepage      = 'https://github.com/on-strum/ruby-on-strum-healthcheck'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 2.5.0'
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = %w[lib]
 
+  spec.add_runtime_dependency 'rack', '>= 2.0.1'
+
+  spec.add_development_dependency 'ffaker'
+  spec.add_development_dependency 'json_matchers'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 end
diff --git a/.circleci/gemspecs/latest b/.circleci/gemspecs/latest
@@ -1,28 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'lib/on_strum/logs/version'
+require_relative 'lib/on_strum/healthcheck/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'on_strum-gem_name'
-  spec.version       = OnStrum::GemName::VERSION
+  spec.name          = 'on_strum-healthcheck'
+  spec.version       = OnStrum::Healthcheck::VERSION
   spec.authors       = ['Vladislav Trotsenko']
   spec.email         = %w[admin@on-strum.org]
-  spec.summary       = %(on_strum-gem_name)
-  spec.description   = %(on_strum-gem_name description)
-  spec.homepage      = 'https://github.com/on-strum/ruby-on-strum-gem-name'
+  spec.summary       = %(Simple configurable application healthcheck rack middleware)
+  spec.description   = %(Simple configurable application healthcheck rack middleware.)
+  spec.homepage      = 'https://github.com/on-strum/ruby-on-strum-healthcheck'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 2.5.0'
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = %w[lib]
 
+  spec.add_runtime_dependency 'rack', '>= 2.0.1'
+
   spec.add_development_dependency 'bundler-audit', '~> 0.9.1'
   spec.add_development_dependency 'fasterer', '~> 0.11.0'
+  spec.add_development_dependency 'ffaker', '~> 2.23'
+  spec.add_development_dependency 'json_matchers', '~> 0.11.1'
   spec.add_development_dependency 'pry-byebug', '~> 3.10', '>= 3.10.1'
   spec.add_development_dependency 'rake', '~> 13.1'
   spec.add_development_dependency 'reek', '~> 6.3'
   spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.61'
+  spec.add_development_dependency 'rubocop', '~> 1.62', '>= 1.62.1'
   spec.add_development_dependency 'rubocop-performance', '~> 1.20', '>= 1.20.2'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.27', '>= 2.27.1'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'

diff --git a/.circleci/linter_configs/.commitspell.yml b/.circleci/linter_configs/.commitspell.yml
@@ -19,7 +19,9 @@ words:
   - codebases
   - codeclimate
   - commitspell
+  - creds
   - gemspecs
+  - healthcheck
   - lefthook
   - markdownlint
   - rubocop

diff --git a/.circleci/linter_configs/.cspell.yml b/.circleci/linter_configs/.cspell.yml
@@ -19,11 +19,13 @@ languageSettings:
       - MarkdownCodeBlock
 
 words:
-  - Commiting
-  - Nazarov
   - Serhiy
-  - Vladislav
-  - Trotsenko
+  - Nazarov
+  - commiting
   - codebases
   - gemspecs
-  - onStrum
+  - onstrum
+  - healthcheck
+  - healthchecks
+  - roda
+  - hanami
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -9,7 +9,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-1-61
+    channel: rubocop-1-62
     config:
       file: .circleci/linter_configs/.rubocop.yml
 

diff --git a/.github/DEVELOPMENT_ENVIRONMENT_GUIDE.md b/.github/DEVELOPMENT_ENVIRONMENT_GUIDE.md
@@ -2,25 +2,25 @@
 
 ## Preparing
 
-Clone `ruby-on-strum-gem-name` repository:
+Clone `ruby-on-strum-healthcheck` repository:
 
 ```bash
-git clone https://github.com/on-strum/ruby-on-strum-gem-name.git
+git clone https://github.com/on-strum/ruby-on-strum-healthcheck.git
 cd  ruby-gem
 ```
 
 Configure latest Ruby environment:
 
 ```bash
 echo 'ruby-3.2.0' > .ruby-version
-cp .circleci/gemspec_latest on_strum-gem_name.gemspec
+cp .circleci/gemspec_latest on_strum-healthcheck.gemspec
 ```
 
 ## Commiting
 
-Commit your changes excluding `.ruby-version`, `on_strum-gem_name.gemspec`
+Commit your changes excluding `.ruby-version`, `on_strum-healthcheck.gemspec`
 
 ```bash
-git add . ':!.ruby-version' ':!on_strum-gem_name.gemspec'
-git commit -m 'Your new awesome on_strum-gem_name feature'
+git add . ':!.ruby-version' ':!on_strum-healthcheck.gemspec'
+git commit -m 'Your new awesome on_strum-healthcheck feature'
 ```
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,21 +7,21 @@ assignees: Serhiy-Nazarov
 
 ---
 
-<!-- Thanks for helping to make `on_strum-gem_name` better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+<!-- Thanks for helping to make `on_strum-healthcheck` better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
 ### New bug checklist
 
-- [ ] I have updated `on_strum-gem_name` to the latest version
-- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/README.md)
-- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-gem-name/issues)
+- [ ] I have updated `on_strum-healthcheck` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/README.md)
+- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-healthcheck/issues)
 
 <!-- Please use next pattern for your bug report title: [BUG] Your bug report title here -->
 
 ### Bug description
 <!-- Please include what's happening, expected behavior, and any relevant code samples -->
 
-##### Complete output when running `on_strum-gem_name`, including the stack trace and command used
+##### Complete output when running `on_strum-healthcheck`, including the stack trace and command used
 
 <details>
   <pre>[INSERT OUTPUT HERE]</pre>

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,14 +7,14 @@ assignees: Serhiy-Nazarov
 
 ---
 
-<!-- Thanks for helping to make `on_strum-gem_name` better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+<!-- Thanks for helping to make `on_strum-healthcheck` better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
 ### New feature request checklist
 
-- [ ] I have updated `on_strum-gem_name` to the latest version
-- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/README.md)
-- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-gem-name/issues)
+- [ ] I have updated `on_strum-healthcheck` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/README.md)
+- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-healthcheck/issues)
 
 <!-- Please use next pattern for your feature request title: [FEATURE] Your feature request title here -->
 

diff --git a/.github/ISSUE_TEMPLATE/issue_report.md b/.github/ISSUE_TEMPLATE/issue_report.md
@@ -7,21 +7,21 @@ assignees: Serhiy-Nazarov
 
 ---
 
-<!-- Thanks for helping to make `on_strum-gem_name` better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+<!-- Thanks for helping to make `on_strum-healthcheck` better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
 ### New issue checklist
 
-- [ ] I have updated `on_strum-gem_name` to the latest version
-- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/README.md)
-- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-gem-name/issues)
+- [ ] I have updated `on_strum-healthcheck` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/README.md)
+- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-healthcheck/issues)
 
 <!-- Please use next pattern for your issue report title: [ISSUE] Your issue report title here -->
 
 ### Issue description
 <!-- Please include what's happening, expected behavior, and any relevant code samples -->
 
-##### Complete output when running `on_strum-gem_name`, including the stack trace and command used
+##### Complete output when running `on_strum-healthcheck`, including the stack trace and command used
 
 <details>
 

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -7,13 +7,13 @@ assignees: Serhiy-Nazarov
 
 ---
 
-<!-- Thanks for helping to make `on_strum-gem_name` better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+<!-- Thanks for helping to make `on_strum-healthcheck` better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
 ### New question checklist
 
-- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/README.md)
-- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-gem-name/issues)
+- [ ] I have read the [Contribution Guidelines](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/README.md)
+- [ ] I have searched for [existing GitHub issues](https://github.com/on-strum/ruby-on-strum-healthcheck/issues)
 
 <!-- Please use next pattern for your question title: [QUESTION] Your question title here -->
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -43,7 +43,7 @@
 - [ ] My code follows the code style of this project
 - [ ] My change requires a change to the documentation
 - [ ] I have updated the documentation accordingly
-- [ ] I have read the [**CONTRIBUTING** document](https://github.com/on-strum/ruby-on-strum-gem-name/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [**CONTRIBUTING** document](https://github.com/on-strum/ruby-on-strum-healthcheck/blob/master/CONTRIBUTING.md)
 - [ ] I have added tests to cover my changes
 - [ ] I have run `bundle exec rspec` from the root directory to see all new and existing tests pass
 - [ ] I have run `rubocop` and `reek` to ensure the code style is valid
diff --git a/.reek.yml b/.reek.yml
@@ -4,5 +4,36 @@ detectors:
   IrresponsibleModule:
     enabled: false
 
+  ControlParameter:
+    exclude:
+      - OnStrum::Healthcheck::Configuration#raise_unless
+      - OnStrum::Healthcheck::Configuration#validator_argument_type
+
+  LongParameterList:
+    exclude:
+      - OnStrum::Healthcheck::Configuration#raise_unless
+
+  ManualDispatch:
+    exclude:
+      - OnStrum::Healthcheck::Configuration#validator_services_callable
+
+  TooManyConstants:
+    exclude:
+      - OnStrum::Healthcheck::Configuration
+
+  TooManyStatements:
+    exclude:
+      - OnStrum::Healthcheck::Configuration#validate_attribute
+
+  UtilityFunction:
+    exclude:
+      - OnStrum::Healthcheck::Configuration#build_configuration_settings
+      - OnStrum::Healthcheck::Configuration#validator_argument_type
+      - OnStrum::Healthcheck::Configuration#validator_endpoint
+      - OnStrum::Healthcheck::Configuration#validator_http_status_failure
+      - OnStrum::Healthcheck::Configuration#validator_http_status_success
+      - OnStrum::Healthcheck::Configuration#validator_services_callable
+      - OnStrum::Healthcheck::Resolver#configuration
+
 exclude_paths:
   - spec/support/helpers
diff --git a/.ruby-gemset b/.ruby-gemset
@@ -1 +1 @@
-on_strum-gem_name
+on_strum-healthcheck
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,8 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2023-xx-xx
+## [0.1.0] - 2024-03-26
 
 ### Added
 
-- First release of `on_strum-gem_name`.
+- First release of `on_strum-healthcheck`.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to `on_strum-gem_name`
+# Contributing to `on_strum-healthcheck`
 
 Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
 
@@ -16,7 +16,7 @@ Guidelines for issue/bug reports:
 
 1. **Use the GitHub issue search** &mdash; check if the issue has already been reported
 2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or `develop` branch in the repository
-3. `on_strum-gem_name` [issue template](.github/ISSUE_TEMPLATE/issue_report.md)/[bug template](.github/ISSUE_TEMPLATE/bug_report.md)
+3. `on_strum-healthcheck` [issue template](.github/ISSUE_TEMPLATE/issue_report.md)/[bug template](.github/ISSUE_TEMPLATE/bug_report.md)
 
 A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
 
@@ -38,7 +38,7 @@ Please adhere to the coding conventions used throughout a project (indentation,
 
 Guidelines for pull requests:
 
-1. `on_strum-gem_name` [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
+1. `on_strum-healthcheck` [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
 2. Fork the repo, checkout to `develop` branch
 3. Run the tests. This is to make sure your starting point works
 4. Read our [branch naming convention](.github/BRANCH_NAMING_CONVENTION.md)