healthcheck_endpoint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b3f53e0d58a6b614f569ce987ac481728be5bb71e7edacb2eed5f4d2d94c066
+  data.tar.gz: e51746dc8cf57f7c5545eeff968e604953e85b08862190837a8bec1eac384704
+SHA512:
+  metadata.gz: 55d450f26b9c900dec3a7c619c10b55bc5a43bf60c5ba50e4fb5c23e9a42ff18522294ccef149bb3b815f16a903b299d4a20ff0e54ded9f79ae5e669db6cb5d3
+  data.tar.gz: 5ab00ab01f34147d3a4c88e8b0fefc422fd64c62e7b356725d14854283f595130e52b2fbe340e069cfe9e6d71fb431b04081896c62a394e29e9d31c7983ca6b3

data/.circleci/config.yml

@@ -0,0 +1,213 @@
+---
+
+version: 2.1
+
+defaults: &defaults
+  working_directory: ~/healthcheck-endpoint
+  docker:
+    - image: cimg/ruby:<< parameters.ruby-version >>
+
+orbs:
+  ruby: circleci/ruby@2.3.0
+
+references:
+  bundle_install: &bundle_install
+    run:
+      name: Installing gems
+      command: |
+            bundle config set --local path '~/vendor/bundle'
+            bundle install
+
+  install_linters: &install_linters
+    run:
+      name: Installing bunch of linters
+      command: |
+            curl -1sLf 'https://dl.cloudsmith.io/public/evilmartians/lefthook/setup.deb.sh' | sudo -E bash
+            sudo apt-get update -y
+            sudo apt-get install -y lefthook shellcheck yamllint
+            npm install --prefix='~/.local' --global --save-dev git+https://github.com/streetsidesoftware/cspell-cli markdownlint-cli
+            cp .circleci/linter_configs/.fasterer.yml .fasterer.yml
+            cp .circleci/linter_configs/.lefthook.yml lefthook.yml
+
+  install_codeclimate_reporter: &install_codeclimate_reporter
+    run:
+      name: Installing CodeClimate test reporter
+      command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+
+  use_latest_bundler: &use_latest_bundler
+    run:
+      name: Using latest bundler
+      command: gem install bundler
+
+  use_latest_gemspec: &use_latest_gemspec
+    run:
+      name: Using latest gemspec
+      command: cp .circleci/gemspecs/latest healthcheck_endpoint.gemspec
+
+  use_compatible_gemspec: &use_compatible_gemspec
+    run:
+      name: Using compatible gemspec
+      command: cp .circleci/gemspecs/compatible healthcheck_endpoint.gemspec
+
+jobs:
+  linters-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
+    <<: *defaults
+
+    steps:
+      - checkout
+
+      - <<: *use_latest_bundler
+      - <<: *use_latest_gemspec
+      - <<: *bundle_install
+      - <<: *install_linters
+
+      - run:
+          name: Running commit linters
+          command: lefthook run commit-linters
+
+      - run:
+          name: Running code style linters
+          command: lefthook run code-style-linters
+
+      - run:
+          name: Running code performance linters
+          command: lefthook run code-performance-linters
+
+      - run:
+          name: Running code vulnerability linters
+          command: lefthook run code-vulnerability-linters
+
+      - run:
+          name: Running code documentation linters
+          command: lefthook run code-documentation-linters
+
+      - run:
+          name: Running release linters
+          command: lefthook run release-linters
+
+  tests-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
+    <<: *defaults
+
+    steps:
+      - checkout
+
+      - <<: *use_latest_bundler
+      - <<: *use_latest_gemspec
+      - <<: *bundle_install
+      - <<: *install_codeclimate_reporter
+
+      - run:
+          name: Running RSpec
+          command: |
+            ./cc-test-reporter before-build
+            bundle exec rspec
+
+      - run:
+          name: Creating CodeClimate test coverage report
+          command: |
+            ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
+
+      - store_artifacts:
+          name: Saving Simplecov coverage artifacts
+          path: ~/healthcheck-endpoint/coverage
+          destination: coverage
+
+      - deploy:
+          name: Uploading CodeClimate test coverage report
+          command: |
+            ./cc-test-reporter sum-coverage --output - --parts $CIRCLE_NODE_TOTAL coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
+
+  compatibility-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
+    <<: *defaults
+
+    steps:
+      - checkout
+
+      - <<: *use_compatible_gemspec
+
+      - ruby/install-deps:
+          bundler-version: "2.3.26"
+          with-cache: false
+          path: '~/vendor/custom_bundle'
+
+      - run:
+          name: Running compatibility tests
+          command: bundle exec rspec
+
+  rubygems-deps-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
+    <<: *defaults
+
+    steps:
+      - checkout
+
+      - run:
+          name: Building rubygems dependencies from default gemspec on minimal Ruby version
+          command: bundle install
+
+  releasing-gem-from-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
+    <<: *defaults
+
+    steps:
+      - checkout
+
+      - add_ssh_keys:
+          fingerprints:
+            - "SHA256:eJhlVtu2gws5rDavHcqZ5GJF/aS8kCctMprdC+Twlns"
+
+      - run:
+          name: Publishing new release
+          command: ./.circleci/scripts/release.sh
+
+workflows:
+  build_test_deploy:
+    jobs:
+      - linters-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["3.3-node"]
+      - tests-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["3.3"]
+      - compatibility-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5", "2.6", "2.7", "3.0", "3.1", "3.2"]
+      - rubygems-deps-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+      - releasing-gem-from-ruby:
+          requires:
+            - linters-ruby
+            - tests-ruby
+            - compatibility-ruby
+            - rubygems-deps-ruby
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+          filters:
+            branches:
+              only: master

data/.circleci/gemspecs/compatible

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/healthcheck_endpoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'healthcheck_endpoint'
+  spec.version       = HealthcheckEndpoint::VERSION
+  spec.authors       = ['Vladislav Trotsenko']
+  spec.email         = %w[admin@bestweb.com.ua]
+  spec.summary       = %(Simple configurable application healthcheck rack middleware)
+  spec.description   = %(Simple configurable application healthcheck rack middleware.)
+  spec.homepage      = 'https://github.com/obstools/healthcheck-endpoint'
+  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

data/.circleci/gemspecs/latest

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/healthcheck_endpoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'healthcheck_endpoint'
+  spec.version       = HealthcheckEndpoint::VERSION
+  spec.authors       = ['Vladislav Trotsenko']
+  spec.email         = %w[admin@bestweb.com.ua]
+  spec.summary       = %(Simple configurable application healthcheck rack middleware)
+  spec.description   = %(Simple configurable application healthcheck rack middleware.)
+  spec.homepage      = 'https://github.com/obstools/healthcheck-endpoint'
+  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.2'
+  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.2', '>= 13.2.1'
+  spec.add_development_dependency 'reek', '~> 6.3'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.67'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.22', '>= 1.22.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.1'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
+end

data/.circleci/linter_configs/.bundler-audit.yml

@@ -0,0 +1,4 @@
+---
+
+ignore:
+  - EXA-MPLE-XXXX

data/.circleci/linter_configs/.commitspell.yml

@@ -0,0 +1,33 @@
+---
+
+enableGlobDot: true
+
+patterns:
+  - name: GithubUser
+    pattern: /\[@.+\]/gmx
+
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - Email
+      - GithubUser
+
+words:
+  - Vladislav
+  - Trotsenko
+  - bagage
+  - bagages
+  - bestwebua
+  - codebases
+  - codeclimate
+  - commitspell
+  - creds
+  - gemspecs
+  - healthcheck
+  - lefthook
+  - markdownlint
+  - rubocop
+  - simplecov
+  - stdlib
+  - obstools
+  - yamlint

data/.circleci/linter_configs/.cspell.yml

@@ -0,0 +1,32 @@
+---
+
+enableGlobDot: true
+
+patterns:
+  - name: GithubUser
+    pattern: /\[@.+\]/gmx
+  - name: MarkdownCode
+    pattern: /`{1,3}.+`{1,3}/gmx
+  - name: MarkdownCodeBlock
+    pattern: /^\s*```[\s\S]*?^\s*```/gmx
+
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - Email
+      - GithubUser
+      - MarkdownCode
+      - MarkdownCodeBlock
+
+words:
+  - Vladislav
+  - Trotsenko
+  - bestwebua
+  - codebases
+  - commiting
+  - gemspecs
+  - hanami
+  - healthcheck
+  - healthchecks
+  - obstools
+  - roda

data/.circleci/linter_configs/.fasterer.yml

@@ -0,0 +1,4 @@
+---
+
+exclude_paths:
+  - '.circleci/**/*.rb'

data/.circleci/linter_configs/.lefthook.yml

@@ -0,0 +1,44 @@
+---
+
+no_tty: true
+skip_output:
+  - meta
+
+commit-linters:
+  commands:
+    commitspell:
+      run: .circleci/scripts/commitspell.sh -c '.circleci/linter_configs/.commitspell.yml'
+
+code-style-linters:
+  commands:
+    reek:
+      run: bundle exec reek
+    rubocop:
+      run: bundle exec rubocop -c '.circleci/linter_configs/.rubocop.yml'
+    shellcheck:
+      glob: '*.{sh}'
+      run: shellcheck --norc {all_files}
+    yamllint:
+      run: yamllint -c '.circleci/linter_configs/.yamllint.yml' .
+
+code-performance-linters:
+  commands:
+    fasterer:
+      run: bundle exec fasterer
+
+code-vulnerability-linters:
+  commands:
+    bundle-audit:
+      run: bundle exec bundle-audit check -c '.circleci/linter_configs/.bundler-audit.yml' --update
+
+code-documentation-linters:
+  commands:
+    cspell:
+      run: cspell-cli lint -c '.circleci/linter_configs/.cspell.yml' '**/*.{txt,md}'
+    markdownlint:
+      run: markdownlint -c '.circleci/linter_configs/.markdownlint.yml' '**/*.md'
+
+release-linters:
+  commands:
+    changeloglint:
+      run: .circleci/scripts/changeloglint.sh

data/.circleci/linter_configs/.markdownlint.yml

@@ -0,0 +1,9 @@
+---
+
+default: true
+
+MD013:
+  line_length: 500
+
+MD024:
+  siblings_only: true

data/.circleci/linter_configs/.rubocop.yml

@@ -0,0 +1,143 @@
+---
+
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  NewCops: enable
+
+# Metrics ---------------------------------------------------------------------
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Naming ----------------------------------------------------------------------
+
+Naming/VariableNumber:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Naming/InclusiveLanguage:
+  Enabled: false
+
+# Style -----------------------------------------------------------------------
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/RedundantConstantBase:
+  Enabled: false
+
+# Layout ----------------------------------------------------------------------
+
+Layout/LineLength:
+  Max: 150
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# Lint ------------------------------------------------------------------------
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: false
+
+# Gemspec ---------------------------------------------------------------------
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/AddRuntimeDependency:
+  Enabled: false
+
+# Performance -----------------------------------------------------------------
+
+Performance/MethodObjectAsBlock:
+  Enabled: false
+
+# RSpec -----------------------------------------------------------------------
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+
+RSpec/StringAsInstanceDoubleConstant:
+  Enabled: false

data/.circleci/linter_configs/.yamllint.yml

@@ -0,0 +1,7 @@
+---
+
+extends: default
+
+rules:
+  line-length:
+    max: 200

data/.circleci/scripts/changeloglint.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+
+changelog=$(if [ "$1" = "" ]; then echo "CHANGELOG.md"; else echo "$1"; fi)
+
+get_current_gem_version() {
+  ruby -r rubygems -e "puts Gem::Specification::load('$(ls -- *.gemspec)').version"
+}
+
+latest_changelog_tag() {
+  grep -Po "(?<=\#\# \[)[0-9]+\.[0-9]+\.[0-9]+?(?=\])" "$changelog" | head -n 1
+}
+
+current_gem_version="$(get_current_gem_version)"
+
+if [ "$current_gem_version" = "$(latest_changelog_tag)" ]
+then
+  echo "SUCCESS: Current gem version ($current_gem_version) has been found on the top of project changelog."
+else
+  echo "FAILURE: Following to \"Keep a Changelog\" convention current gem version ($current_gem_version) must be mentioned on the top of project changelog."
+  exit 1
+fi

data/.circleci/scripts/commitspell.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+
+configuration=$(if [ "$2" = "" ]; then echo "$2"; else echo " $1 $2"; fi)
+latest_commit=$(git rev-parse HEAD)
+
+spellcheck_info() {
+  echo "Checking the spelling of the latest commit ($latest_commit) message..."
+}
+
+compose_cspell_command() {
+  echo "cspell-cli lint stdin$configuration"
+}
+
+cspell="$(compose_cspell_command)"
+
+spellcheck_latest_commit() {
+  git log -1 --pretty=%B | $cspell
+}
+
+spellcheck_info
+spellcheck_latest_commit

data/.circleci/scripts/release.sh

@@ -0,0 +1,69 @@
+#!/bin/sh
+set -e
+
+GH_CLI_RELEASES_URL="https://github.com/cli/cli/releases"
+FILE_NAME="gh"
+BUILD_ARCHITECTURE="linux_amd64.deb"
+DELIMETER="_"
+PACKAGE_FILE="$FILE_NAME$DELIMETER$BUILD_ARCHITECTURE"
+
+gh_cli_latest_release() {
+  curl -sL -o /dev/null -w '%{url_effective}' "$GH_CLI_RELEASES_URL/latest" | rev | cut -f 1 -d '/'| rev
+}
+
+download_gh_cli() {
+  test -z "$VERSION" && VERSION="$(gh_cli_latest_release)"
+  test -z "$VERSION" && {
+    echo "Unable to get GitHub CLI release." >&2
+    exit 1
+  }
+  curl -s -L -o "$PACKAGE_FILE" "$GH_CLI_RELEASES_URL/download/$VERSION/$FILE_NAME$DELIMETER$(printf '%s' "$VERSION" | cut -c 2-100)$DELIMETER$BUILD_ARCHITECTURE"
+}
+
+install_gh_cli() {
+  sudo dpkg -i "$PACKAGE_FILE"
+  rm "$PACKAGE_FILE"
+}
+
+get_release_candidate_version() {
+  ruby -r rubygems -e "puts Gem::Specification::load('$(ls -- *.gemspec)').version"
+}
+
+release_candidate_tag="v$(get_release_candidate_version)"
+
+is_an_existing_github_release() {
+  git fetch origin "refs/tags/$release_candidate_tag" >/dev/null 2>&1
+}
+
+release_to_rubygems() {
+  echo "Setting RubyGems publisher credentials..."
+  ./.circleci/scripts/set_publisher_credentials.sh
+  echo "Preparation for release..."
+  git config --global user.email "${PUBLISHER_EMAIL}"
+  git config --global user.name "${PUBLISHER_NAME}"
+  git stash
+  gem install yard gem-ctags
+  bundle install
+  echo "Publishing new gem release to RubyGems..."
+  rake release
+}
+
+release_to_github() {
+  echo "Downloading and installing latest gh cli..."
+  download_gh_cli
+  install_gh_cli
+  echo "Publishing new release notes to GitHub..."
+  gh release create "$release_candidate_tag" --generate-notes
+}
+
+update_develop_branch() {
+  echo "Updating develop branch with new release tag..."
+  git checkout develop
+  git merge "$release_candidate_tag" --ff --no-edit
+  git push origin develop
+}
+
+if is_an_existing_github_release
+then echo "Tag $release_candidate_tag already exists on GitHub. Skipping releasing flow..."
+else release_to_rubygems; release_to_github; update_develop_branch
+fi

data/.circleci/scripts/set_publisher_credentials.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+set -e
+set +x
+mkdir -p ~/.gem
+
+cat << EOF > ~/.gem/credentials
+---
+:rubygems_api_key: ${RUBYGEMS_API_KEY}
+EOF
+
+chmod 0600 ~/.gem/credentials
+set -x