middleware_healthcheck 0.2.2 → 1.0.0

data/lib/middleware_healthcheck/configuration.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
   class Configuration
-    DEFAULT_HEALTHCHECK_PATH = '/healthcheck'.freeze
-    DEFAULT_FULL_CHECK_PARAM_NAME = 'full'.freeze
-    DEFAULT_SELECTED_CHECK_PARAM_NAME = 'checks'.freeze
+    DEFAULT_HEALTHCHECK_PATH = '/healthcheck'
+    DEFAULT_FULL_CHECK_PARAM_NAME = 'full'
+    DEFAULT_SELECTED_CHECK_PARAM_NAME = 'checks'
     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
+    DEFAULT_SUCCESS_RESPONSE_BODY = "It's alive!"
+    DEFAULT_ERRORS_DELIMITER = '; '
+    DEFAULT_SELECTED_CHECK_PARAM_SPLIT_DELIMITER = ','
 
     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
+                  :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

data/lib/middleware_healthcheck/default_checkers.rb

@@ -1,6 +1,6 @@
-if defined? ActiveRecord::Railtie
-  require "middleware_healthcheck/default_checkers/active_record_checker"
-end
+# frozen_string_literal: true
+
+require 'middleware_healthcheck/default_checkers/active_record_checker' if defined? ActiveRecord::Railtie
 
 module MiddlewareHealthcheck
   module DefaultCheckers

data/lib/middleware_healthcheck/default_checkers/active_record_checker.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
   module DefaultCheckers
     class ActiveRecordChecker
-      NOT_CONNECTED_ERROR = "Can't connect to database.".freeze
+      NOT_CONNECTED_ERROR = "Can't connect to database."
       EXCEPTION_REGEXP = /^ActiveRecord::/.freeze
 
       attr_accessor :error
 
-      def initialize(_app, _env)
-      end
+      def initialize(_app, _env); end
 
       def healthy?
         ActiveRecord::Base.establish_connection
@@ -18,8 +19,8 @@ module MiddlewareHealthcheck
           self.error = NOT_CONNECTED_ERROR
           false
         end
-      rescue => e
-        if e.class.to_s.match EXCEPTION_REGEXP
+      rescue StandardError => e
+        if e.class.to_s.match? EXCEPTION_REGEXP # rubocop:disable Style/GuardClause
           self.error = e.message
           false
         else

data/lib/middleware_healthcheck/main_checker.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
   class MainChecker
-    QUERY_STRING_KEY = "QUERY_STRING".freeze
-    UNDEFINED_CHECKER_ERROR = "Can't find checker: ".freeze
+    QUERY_STRING_KEY = 'QUERY_STRING'
+    UNDEFINED_CHECKER_ERROR = "Can't find checker: "
 
     attr_accessor :app, :env
 
@@ -31,7 +33,7 @@ module MiddlewareHealthcheck
     def build_success_response
       build_text_response(
         configuration.success_response_status,
-        configuration.success_response_body 
+        configuration.success_response_body
       )
     end
 
@@ -43,7 +45,7 @@ module MiddlewareHealthcheck
     end
 
     def build_text_response(status, body)
-      [ status, { "Content-Type" => "text/plain" }, [body] ]
+      [status, { 'Content-Type' => 'text/plain' }, [body]]
     end
 
     def run_all_checkers
@@ -54,7 +56,6 @@ module MiddlewareHealthcheck
       run_checkers(selected_checkers)
     end
 
-
     def run_checkers(checkers)
       checkers.each do |checker|
         checker_instance = checker.new(@app, @env)
@@ -77,7 +78,8 @@ module MiddlewareHealthcheck
     end
 
     def selected_checkers_names
-      @selected_check_param_names ||= params[configuration.selected_check_param_name]
+      @selected_checkers_names ||=
+        params[configuration.selected_check_param_name]
         .split(configuration.selected_check_param_split_delimiter)
     end
 
@@ -92,6 +94,7 @@ module MiddlewareHealthcheck
     def full_check?
       params[configuration.full_check_param_name].present?
     end
+
     def selected_check?
       params[configuration.selected_check_param_name].present?
     end

data/lib/middleware_healthcheck/middleware.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
   class Middleware
-    PATH_INFO_KEY = "PATH_INFO".freeze
+    PATH_INFO_KEY = 'PATH_INFO'
 
     def initialize(app)
       @app = app

data/lib/middleware_healthcheck/rails.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
   class Railtie < Rails::Railtie
-    initializer "middleware_healthcheck.configure_rails_initialization" do
+    initializer 'middleware_healthcheck.configure_rails_initialization' do
       app.middleware.insert_after Rails::Rack::Logger, MiddlewareHealthcheck::Middleware
     end
 

data/lib/middleware_healthcheck/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiddlewareHealthcheck
-  VERSION = '0.2.2'
+  VERSION = '1.0.0'
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class HomeController < ApplicationController
+  def show; end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/home/show.html.erb

@@ -0,0 +1 @@
+<h1>Home</h1>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'boot'
+
+# Pick the frameworks you want:
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'active_job/railtie'
+require 'action_cable/engine'
+# require "rails/test_unit/railtie"
+require 'sprockets/railtie'
+
+Bundler.require(*Rails.groups)
+require 'middleware_healthcheck'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)