healthcheck_endpoint 1.0.0

data/lib/healthcheck_endpoint/resolver.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module HealthcheckEndpoint
+  class Resolver
+    require 'rack'
+    require 'securerandom'
+    require 'json'
+
+    PROBE_ENDPOINTS = %i[endpoint_startup endpoint_liveness endpoint_readiness].freeze
+    CONTENT_TYPE = { 'Content-Type' => 'application/json' }.freeze
+    ROOT_NAMESPACE = '/'
+
+    def self.call(rack_env)
+      new(rack_env).call
+    end
+
+    def initialize(rack_env)
+      @request = ::Rack::Request.new(rack_env)
+    end
+
+    def call
+      return unless probe_name
+
+      [response_status, HealthcheckEndpoint::Resolver::CONTENT_TYPE, [response_jsonapi]]
+    end
+
+    private
+
+    attr_reader :request
+
+    def configuration
+      HealthcheckEndpoint.configuration
+    end
+
+    def root_namespace
+      @root_namespace ||= configuration.endpoints_namespace
+    end
+
+    def root_namespace?
+      root_namespace.eql?(HealthcheckEndpoint::Resolver::ROOT_NAMESPACE)
+    end
+
+    HealthcheckEndpoint::Resolver::PROBE_ENDPOINTS.each do |method|
+      define_method(method) do
+        target_endpoint = configuration.public_send(method)
+        root_namespace? ? target_endpoint : "#{root_namespace}#{target_endpoint}"
+      end
+    end
+
+    def probe_name
+      @probe_name ||=
+        case request.path
+        when endpoint_startup then :startup
+        when endpoint_liveness then :liveness
+        when endpoint_readiness then :readiness
+        end
+    end
+
+    def probe_result
+      @probe_result ||=
+        configuration.public_send(:"services_#{probe_name}").each_with_object({}) do |service_name, response|
+          response[service_name] = configuration.services[service_name].call
+        end
+    end
+
+    def response_status
+      configuration.public_send(
+        probe_result.values.all? ? :"endpoint_#{probe_name}_status_success" : :"endpoint_#{probe_name}_status_failure"
+      )
+    end
+
+    def response_jsonapi
+      {
+        data: {
+          id: ::SecureRandom.uuid,
+          type: "application-#{probe_name}-healthcheck", # TODO: it would be great to be able to configure this
+          attributes: probe_result
+        }
+      }.to_json
+    end
+  end
+end

data/lib/healthcheck_endpoint/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HealthcheckEndpoint
+  VERSION = '1.0.0'
+end

data/lib/healthcheck_endpoint.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'healthcheck_endpoint/core'
+
+module HealthcheckEndpoint
+  class << self
+    def configuration(&block)
+      @configuration ||= begin
+        return unless block
+
+        HealthcheckEndpoint::Configuration.new(&block)
+      end
+    end
+
+    def configure(&block)
+      return configuration {} unless block # rubocop:disable Lint/EmptyBlock
+
+      configuration(&block)
+    end
+
+    def reset_configuration!
+      @configuration = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: healthcheck_endpoint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladislav Trotsenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+- !ruby/object:Gem::Dependency
+  name: json_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Simple configurable application healthcheck rack middleware.
+email:
+- admin@bestweb.com.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".circleci/gemspecs/compatible"
+- ".circleci/gemspecs/latest"
+- ".circleci/linter_configs/.bundler-audit.yml"
+- ".circleci/linter_configs/.commitspell.yml"
+- ".circleci/linter_configs/.cspell.yml"
+- ".circleci/linter_configs/.fasterer.yml"
+- ".circleci/linter_configs/.lefthook.yml"
+- ".circleci/linter_configs/.markdownlint.yml"
+- ".circleci/linter_configs/.rubocop.yml"
+- ".circleci/linter_configs/.yamllint.yml"
+- ".circleci/scripts/changeloglint.sh"
+- ".circleci/scripts/commitspell.sh"
+- ".circleci/scripts/release.sh"
+- ".circleci/scripts/set_publisher_credentials.sh"
+- ".codeclimate.yml"
+- ".github/BRANCH_NAMING_CONVENTION.md"
+- ".github/DEVELOPMENT_ENVIRONMENT_GUIDE.md"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/issue_report.md"
+- ".github/ISSUE_TEMPLATE/question.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- healthcheck_endpoint.gemspec
+- lib/healthcheck_endpoint.rb
+- lib/healthcheck_endpoint/configuration.rb
+- lib/healthcheck_endpoint/core.rb
+- lib/healthcheck_endpoint/error/configuration/argument_type.rb
+- lib/healthcheck_endpoint/error/configuration/enpoint_pattern.rb
+- lib/healthcheck_endpoint/error/configuration/http_status_failure.rb
+- lib/healthcheck_endpoint/error/configuration/http_status_success.rb
+- lib/healthcheck_endpoint/error/configuration/not_callable_service.rb
+- lib/healthcheck_endpoint/error/configuration/not_configured.rb
+- lib/healthcheck_endpoint/error/configuration/unknown_service.rb
+- lib/healthcheck_endpoint/rack_middleware.rb
+- lib/healthcheck_endpoint/resolver.rb
+- lib/healthcheck_endpoint/version.rb
+homepage: https://github.com/obstools/healthcheck-endpoint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Simple configurable application healthcheck rack middleware
+test_files: []