middleware_healthcheck 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38b91fef5d4a3905b2813f39042c793f360204d0b9c628f4f924d659ff192a2d
+  data.tar.gz: e147717615b025caeea300ad09aaf6d340018b28a740f61cd818a7f38e7fdfd1
+SHA512:
+  metadata.gz: bffd5928ca999c46a20c7d6af18302899818b0b91aad1e6a2d5040bb02c28bb3d94d191febdf20376e820407b3785d22d03b63177275c1614c7265d8bdff5f24
+  data.tar.gz: b5798095104d400611081987408e5e4b19f1f2f4c3f13de21ab010c71d0746fe20d77497f434562d7280fec3adc449ae03d2ff4839a1302a36db7d34093480cc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Adam Wieczorkowski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# MiddlewareHealthcheck
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'middleware_healthcheck'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install middleware_healthcheck
+```
+
+## Usage
+Run basic check (without running any advanced checkers):
+```
+/healthcheck
+```
+
+To run all available checkers, add `full` parameter:
+```
+/healthcheck?full=1
+```
+
+To run selected checkers, add `checks` parameter, where the value is the name of checkers separated by a comma:
+```
+/healthcheck?checks=active_record,second_checker,another_checker
+```
+
+To change default path and parameters see Configuration section
+
+## Configuration
+Create ``config/initializers/middleware_healthcheck.rb`` file
+```ruby
+MiddlewareHealthcheck.configure do |config|
+  config.healthcheck_path = "my_custom_path"
+  ...
+end
+```
+Available options:
+```
+healthcheck_path
+full_check_param_name
+selected_check_param_name
+error_response_status
+success_response_status
+success_response_body
+errors_delimiter
+selected_check_param_split_delimiter
+```
+
+## Custom Checkers
+Your Custom Checker class should look like this:
+```ruby
+class MyCustomChecker
+  attr_accessor :error
+ 
+  def initialize(_app, _env)
+  end
+
+  def healthy?
+    if everything_ok?
+      true
+    else
+      self.error = 'Error message'
+      false
+    end
+  end
+end
+```
+
+To include Custom Checker, just add
+```ruby
+HealthcheckMiddleware.configure do |config|
+  config.checkers << MyCustomChecker
+end
+```
+in initializer.
+
+## Development
+
+```
+# build the docker containers
+docker-compose build
+
+# run the specs
+docker-compose run --rm app bundle exec rspec
+
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MiddlewareHealthcheck'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/middleware_healthcheck.rb

@@ -0,0 +1,19 @@
+require "middleware_healthcheck/rails" if defined? Rails::Railtie
+require "middleware_healthcheck/default_checkers"
+require "middleware_healthcheck/configuration"
+require "middleware_healthcheck/main_checker"
+require "middleware_healthcheck/middleware"
+
+module MiddlewareHealthcheck
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/middleware_healthcheck/configuration.rb

@@ -0,0 +1,31 @@
+module MiddlewareHealthcheck
+  class Configuration
+    DEFAULT_HEALTHCHECK_PATH = '/healthcheck'.freeze
+    DEFAULT_FULL_CHECK_PARAM_NAME = 'full'.freeze
+    DEFAULT_SELECTED_CHECK_PARAM_NAME = 'checks'.freeze
+    DEFAULT_ERROR_RESPONSE_STATUS = 422
+    DEFAULT_SUCCESS_RESPONSE_STATUS = 200
+    DEFAULT_SUCCESS_RESPONSE_BODY = "It's alive!".freeze
+    DEFAULT_ERRORS_DELIMITER = '; '.freeze
+    DEFAULT_SELECTED_CHECK_PARAM_SPLIT_DELIMITER = ','.freeze
+
+    attr_accessor :healthcheck_path, :full_check_param_name, :selected_check_param_name,
+      :error_response_status, :success_response_status, :success_response_body,
+      :errors_delimiter, :selected_check_param_split_delimiter, :checkers
+
+    def initialize
+      self.healthcheck_path = DEFAULT_HEALTHCHECK_PATH
+      self.full_check_param_name = DEFAULT_FULL_CHECK_PARAM_NAME
+      self.selected_check_param_name = DEFAULT_SELECTED_CHECK_PARAM_NAME
+      self.error_response_status = DEFAULT_ERROR_RESPONSE_STATUS
+      self.success_response_status = DEFAULT_SUCCESS_RESPONSE_STATUS
+      self.success_response_body = DEFAULT_SUCCESS_RESPONSE_BODY
+      self.errors_delimiter = DEFAULT_ERRORS_DELIMITER
+      self.selected_check_param_split_delimiter = DEFAULT_SELECTED_CHECK_PARAM_SPLIT_DELIMITER
+      self.checkers = MiddlewareHealthcheck::DefaultCheckers.constants.map do |const|
+        klass = MiddlewareHealthcheck::DefaultCheckers.const_get(const)
+        klass if klass.is_a? Class
+      end.compact
+    end
+  end
+end

data/lib/middleware_healthcheck/default_checkers.rb

@@ -0,0 +1,8 @@
+if defined? ActiveRecord::Railtie
+  require "middleware_healthcheck/default_checkers/active_record_checker"
+end
+
+module MiddlewareHealthcheck
+  module DefaultCheckers
+  end
+end

data/lib/middleware_healthcheck/default_checkers/active_record_checker.rb

@@ -0,0 +1,31 @@
+module MiddlewareHealthcheck
+  module DefaultCheckers
+    class ActiveRecordChecker
+      NOT_CONNECTED_ERROR = "Can't connect to database.".freeze
+      EXCEPTION_REGEXP = /^ActiveRecord::/.freeze
+
+      attr_accessor :error
+
+      def initialize(_app, _env)
+      end
+
+      def healthy?
+        ActiveRecord::Base.establish_connection
+        ActiveRecord::Base.connection
+        if ActiveRecord::Base.connected?
+          true
+        else
+          self.error = NOT_CONNECTED_ERROR
+          false
+        end
+      rescue => e
+        if e.class.to_s.match EXCEPTION_REGEXP
+          self.error = e.message
+          false
+        else
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/middleware_healthcheck/main_checker.rb

@@ -0,0 +1,103 @@
+module MiddlewareHealthcheck
+  class MainChecker
+    QUERY_STRING_KEY = "QUERY_STRING".freeze
+    UNDEFINED_CHECKER_ERROR = "Can't find checker: ".freeze
+
+    attr_accessor :app, :env
+
+    def initialize(app, env)
+      self.app = app
+      self.env = env
+    end
+
+    def check_health
+      if full_check?
+        run_all_checkers
+      elsif selected_check?
+        run_selected_checkers
+      end
+
+      build_response
+    end
+
+    def build_response
+      if errors.present?
+        build_error_response
+      else
+        build_success_response
+      end
+    end
+
+    def build_success_response
+      build_text_response(
+        configuration.success_response_status,
+        configuration.success_response_body 
+      )
+    end
+
+    def build_error_response
+      build_text_response(
+        configuration.error_response_status,
+        errors.join(configuration.errors_delimiter)
+      )
+    end
+
+    def build_text_response(status, body)
+      [ status, { "Content-Type" => "text/plain" }, [body] ]
+    end
+
+    def run_all_checkers
+      run_checkers(configuration.checkers)
+    end
+
+    def run_selected_checkers
+      run_checkers(selected_checkers)
+    end
+
+
+    def run_checkers(checkers)
+      checkers.each do |checker|
+        checker_instance = checker.new(@app, @env)
+        errors.push(checker_instance.error) unless checker_instance.healthy?
+      end
+    end
+
+    def selected_checkers
+      selected_checkers_names.map do |checker_name|
+        find_checker_by_name(checker_name)
+      end.compact
+    end
+
+    def find_checker_by_name(name)
+      configuration.checkers.each do |checker|
+        return checker if checker.to_s.demodulize.underscore.gsub(/_checker$/, '') == name
+      end
+      errors.push(UNDEFINED_CHECKER_ERROR + name.camelize)
+      nil
+    end
+
+    def selected_checkers_names
+      @selected_check_param_names ||= params[configuration.selected_check_param_name]
+        .split(configuration.selected_check_param_split_delimiter)
+    end
+
+    def params
+      @params ||= Rack::Utils.parse_nested_query(@env[QUERY_STRING_KEY])
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def full_check?
+      params[configuration.full_check_param_name].present?
+    end
+    def selected_check?
+      params[configuration.selected_check_param_name].present?
+    end
+
+    def configuration
+      @configuration ||= MiddlewareHealthcheck.configuration
+    end
+  end
+end

data/lib/middleware_healthcheck/middleware.rb

@@ -0,0 +1,17 @@
+module MiddlewareHealthcheck
+  class Middleware
+    PATH_INFO_KEY = "PATH_INFO".freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env[PATH_INFO_KEY] == MiddlewareHealthcheck.configuration.healthcheck_path
+        MainChecker.new(@app, env).check_health
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/middleware_healthcheck/rails.rb

@@ -0,0 +1,11 @@
+module MiddlewareHealthcheck
+  class Railtie < Rails::Railtie
+    initializer "middleware_healthcheck.configure_rails_initialization" do
+      app.middleware.insert_after Rails::Rack::Logger, MiddlewareHealthcheck::Middleware
+    end
+
+    def app
+      Rails.application
+    end
+  end
+end

data/lib/middleware_healthcheck/version.rb

@@ -0,0 +1,3 @@
+module MiddlewareHealthcheck
+  VERSION = '0.2.1'
+end

data/lib/tasks/middleware_healthcheck_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :middleware_healthcheck do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: middleware_healthcheck
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Adam Wieczorkowski
+- Claudio Perez Gamayo
+- Jan Wieczorkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware to provide a healthcheck endpoint, useful for load balancers
+  health checks.
+email:
+- adam.wieczorkowski@naturaily.com
+- claudio@firefield.com
+- jan.wieczorkowski@naturaily.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/middleware_healthcheck.rb
+- lib/middleware_healthcheck/configuration.rb
+- lib/middleware_healthcheck/default_checkers.rb
+- lib/middleware_healthcheck/default_checkers/active_record_checker.rb
+- lib/middleware_healthcheck/main_checker.rb
+- lib/middleware_healthcheck/middleware.rb
+- lib/middleware_healthcheck/rails.rb
+- lib/middleware_healthcheck/version.rb
+- lib/tasks/middleware_healthcheck_tasks.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware to provide a healthcheck endpoint.
+test_files: []