services_health_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 842c8c15f8766929a33acaacdaf629045285224e25f0dee4b38f0c4dc4ae1d12
+  data.tar.gz: 43cc485ed097501766ab0a969a6a28a690dad7c86e8182e5dd708624e6063157
+SHA512:
+  metadata.gz: 644c3071863602e02ba456a559d3789a05363699f4ea1f425a8e5438b51608c9fbf5a72f3267f91b4c0682156a96d117ca04f84222d7bb944c71d6f2357d8c24
+  data.tar.gz: 7aabcf6713998a6a72f624882e746136d9a7612a70bc84d52c1af88d96333536ac2f2c36574e5d59eb251445e7c23f057d605773963f59af7c8dfdd763524a31

data/lib/generators/services_health_check/install/install_generator.rb

@@ -0,0 +1,26 @@
+require "rails/generators"
+
+module ServicesHealthCheck
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Adds GET /health_check with HealthCheckController and HealthCheckService"
+
+      def add_route
+        if File.read(File.join(destination_root, "config/routes.rb")).include?("health_check#show")
+          say_status :skip, "health_check route already present", :yellow
+        else
+          route 'get "health_check", to: "health_check#show", as: :health_check'
+        end
+      end
+
+      def create_controller
+        template "health_check_controller.rb", "app/controllers/health_check_controller.rb"
+      end
+
+      def create_service
+        template "health_check_service.rb", "app/services/health_check_service.rb"
+      end
+    end
+  end
+end

data/lib/generators/services_health_check/install/templates/health_check_controller.rb.tt

@@ -0,0 +1,10 @@
+# GET /health_check: always JSON, 200 when every check passes, 503 otherwise (services_health_check).
+class HealthCheckController < ActionController::API
+  def show
+    results = HealthCheckService.new.call
+    render json: results, status: results.values.all? ? :ok : :service_unavailable
+  rescue StandardError, ScriptError => error
+    Rails.logger.error("[services_health_check] #{error.class}: #{error.message}")
+    render json: { app: false }, status: :service_unavailable
+  end
+end

data/lib/generators/services_health_check/install/templates/health_check_service.rb.tt

@@ -0,0 +1,37 @@
+# Each public method is one check: its name is the JSON key, and it returns true or false.
+# `app` is always here; uncomment and implement the others the project uses.
+class HealthCheckService
+  TIMEOUT = 5
+
+  def call
+    checks.index_with { |name| safely { public_send(name) } }
+  end
+
+  # The project answers its own /up (Rails' built-in health page).
+  def app
+    HTTParty.get(ENV.fetch("SERVICES_HEALTH_CHECK_APP_URL", "http://localhost:#{ENV.fetch("PORT", 3000)}/up"),
+                 timeout: TIMEOUT).success?
+  end
+
+  # def sidekiq
+  #   TODO: implement the code
+  # end
+
+  # def redis
+  #   TODO: implement the code
+  # end
+
+  private
+    # `app` first, then the other checks by name.
+    def checks
+      [ :app, *(self.class.public_instance_methods(false) - [ :call, :app ]).sort ]
+    end
+
+    # A check that raises, or returns anything but true, is off. ScriptError covers checks
+    # left as `raise NotImplementedError` and a `require` that fails.
+    def safely
+      yield == true
+    rescue StandardError, ScriptError
+      false
+    end
+end

data/lib/services_health_check/railtie.rb

@@ -0,0 +1,5 @@
+module ServicesHealthCheck
+  class Railtie < Rails::Railtie
+    rake_tasks { load File.expand_path("../tasks/services_health_check.rake", __dir__) }
+  end
+end

data/lib/services_health_check/version.rb

@@ -0,0 +1,3 @@
+module ServicesHealthCheck
+  VERSION = "0.1.0"
+end

data/lib/services_health_check.rb

@@ -0,0 +1,3 @@
+require "services_health_check/version"
+require "httparty"
+require "services_health_check/railtie" if defined?(Rails::Railtie)

data/lib/tasks/services_health_check.rake

@@ -0,0 +1,12 @@
+namespace :services_health_check do
+  desc "Add GET /health_check (route, HealthCheckController, HealthCheckService); safe to re-run"
+  task install: :environment do
+    require "rails/generators"
+
+    # Same as `bin/rails generate services_health_check:install --skip`, but aimed at Rails.root
+    # directly: Rails::Command.root is only set when the task runs through bin/rails.
+    Rails.application.load_generators
+    Rails::Generators.invoke "services_health_check:install", [ "--skip" ],
+                             behavior: :invoke, destination_root: Rails.root
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: services_health_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andre Oliveira
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+description: Adds a GET /health_check endpoint to a Rails app that answers in JSON
+  whether the app and each service it declares are working.
+email: andreoliveirar2d2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/services_health_check/install/install_generator.rb
+- lib/generators/services_health_check/install/templates/health_check_controller.rb.tt
+- lib/generators/services_health_check/install/templates/health_check_service.rb.tt
+- lib/services_health_check.rb
+- lib/services_health_check/railtie.rb
+- lib/services_health_check/version.rb
+- lib/tasks/services_health_check.rake
+homepage: https://rubygems.org/gems/services_health_check
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Made for checking the rails and related services are up and running
+test_files: []