rails-healthcheck 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97361dff356d270a871f8db2f19d6f8d30bb591aef43bb646bf8bb9c1829477
-  data.tar.gz: 77e4d0501a81cea51466508b87449eff38c434c01f74ef81b8c7b2ddb5f23bba
+  metadata.gz: 0101c38ef564e878ce55f0aaea701606c624fd2f7c7bb35d1b5c40d814dccf1b
+  data.tar.gz: baf68a65097dfaae941df75caa1a263b7e7a2c27bb8f32f818a62af95c4f85f1
 SHA512:
-  metadata.gz: 860bc298d1d6ae2287c3697f1bd1867881e07c449e40025c616da36c688f57fea38f55dfe9a6b94d480aa032349505c5b1603bd7cd98c1a0dde2769121ef9622
-  data.tar.gz: fd95568f86ee97ef48b5d65399e83942cf96a4b0ef04b29885fdf2d63ae1160b1cce32e593ebb492e30107d045630c31d06153e5e7962454fe6b2a7de566506b
+  metadata.gz: ae53712ee12b40e78121ebf6de7d9d36b278d8c5b57472e046354b247c92bafbfe69966e691b4b2ae712034da84d223742d85498587cb81b6c342c9ce1ea5f70
+  data.tar.gz: a6237e5a946d94fc3ad885fdc963b89db21b124260e3c5544594736856893130d5f31165e748a2d585c5f6115b0fae1b5c5897d3a9f847423e73fe2725ad58aa

data/lib/healthcheck.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'healthcheck/version'
+require 'healthcheck/configuration'
+require 'healthcheck/check'
+require 'healthcheck/checker'
+require 'healthcheck/error'
+require 'healthcheck/router'
+require 'healthcheck/engine'
+
+module Healthcheck
+  require 'healthcheck/railtie' if defined?(Rails)
+
+  Configuration::SETTINGS.each do |setting|
+    send(:define_singleton_method, setting, -> { configuration.send(setting) })
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.routes(router)
+    Healthcheck::Router.mount(router)
+  end
+end

data/lib/healthcheck/check.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  class Check
+    attr_accessor :name, :block
+
+    def initialize(name, block)
+      @name = name
+      @block = block
+    end
+
+    def execute!
+      block.call
+    end
+  end
+end

data/lib/healthcheck/checker.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  class Checker
+    attr_accessor :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def check
+      Healthcheck.checks.map { |c| Thread.new { execute(c) } }.each(&:join)
+    end
+
+    def errored?
+      @errors.any?
+    end
+
+    private
+
+    def execute(check)
+      check.execute!
+    rescue StandardError => e
+      @errors << Error.new(check.name, e.class, e.message)
+    end
+  end
+end

data/lib/healthcheck/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  class Configuration
+    SETTINGS = %i[success error verbose route method checks].freeze
+
+    attr_accessor(*SETTINGS)
+
+    def initialize
+      SETTINGS.each { |key, _| instance_variable_set("@#{key}", nil) }
+      clear!
+    end
+
+    def add_check(name, block)
+      @checks << Check.new(name, block)
+    end
+
+    def clear!
+      @checks = []
+    end
+  end
+end

data/lib/healthcheck/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Healthcheck
+  class Engine < Rails::Engine
+  end
+end

data/lib/healthcheck/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  class Error
+    attr_accessor :name, :exception, :message
+
+    def initialize(name, exception, message)
+      @name = name
+      @exception = exception.to_s
+      @message = message&.squish
+    end
+  end
+end

data/lib/healthcheck/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'healthcheck'
+require 'rails'
+
+module Healthcheck
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/healthcheck/router.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  class Router
+    def self.mount(router)
+      router.send(Healthcheck.method, Healthcheck.route => 'healthcheck/healthchecks#check')
+    end
+  end
+end

data/lib/healthcheck/tasks/setup.rake

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+INITIALIZER = 'config/initializers/healthcheck.rb'
+OLD_ROUTES = 'config/routes.rb'
+NEW_ROUTES = 'config/routes.rb.new'
+ROUTES_SETUP = '  Healthcheck.routes(self)'
+ROUTES_INIT = 'Rails.application.routes.draw do'
+
+namespace :healthcheck do
+  desc 'Install the files and settings to the gem Healthcheck works'
+  task :install do
+    puts '  -  invoke        Rails::Healthcheck'
+    create_initializer
+    mount_route
+  end
+end
+
+def create_initializer
+  FileUtils.mkdir_p(File.dirname(INITIALIZER))
+  File.open(INITIALIZER, 'w') { |file| file << settings }
+  puts '  -    create      config/initializers/healthcheck.rb'
+end
+
+def mount_route
+  return unless File.exist?(OLD_ROUTES)
+
+  puts '  -    modify      config/routes.rb'
+  File.open(NEW_ROUTES, 'w') do |new_routes|
+    File.foreach(OLD_ROUTES) do |line|
+      new_routes.puts(line)
+      if line.strip == ROUTES_INIT
+        new_routes.puts(ROUTES_SETUP)
+        new_routes.puts ''
+      end
+    end
+  end
+
+  File.delete(OLD_ROUTES)
+  File.rename(NEW_ROUTES, OLD_ROUTES)
+end
+
+def settings
+  <<~SETTINGS
+    # frozen_string_literal: true
+
+    Healthcheck.configure do |config|
+      config.success = 200
+      config.error = 503
+      config.verbose = false
+      config.route = '/healthcheck'
+      config.method = :get
+
+      # -- Checks --
+      # Check if the db is available
+      # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
+      # Check if the db is available and without pending migrations
+      # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
+      # Check if the cache is available
+      # config.add_check :cache, -> { Rails.cache.read('some_key') }
+      # Check if the application required envs are defined
+      # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
+    end
+  SETTINGS
+end

data/lib/healthcheck/version.rb

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

data/lib/rails-healthcheck.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'healthcheck'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - linqueta
@@ -131,6 +131,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - app/controllers/healthcheck/healthchecks_controller.rb
+- lib/healthcheck.rb
+- lib/healthcheck/check.rb
+- lib/healthcheck/checker.rb
+- lib/healthcheck/configuration.rb
+- lib/healthcheck/engine.rb
+- lib/healthcheck/error.rb
+- lib/healthcheck/railtie.rb
+- lib/healthcheck/router.rb
+- lib/healthcheck/tasks/setup.rake
+- lib/healthcheck/version.rb
+- lib/rails-healthcheck.rb
 homepage: https://github.com/linqueta/rails-healthcheck
 licenses:
 - MIT