hey_doctor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0824d2e802a96ba8586c63f1ee7a193ca8675ce69b35d73f0dcdaeebf7c5e082'
+  data.tar.gz: 567451703ce9ead34d72691ba51071e8c11e39c9086d5cf9cec63b5e04feca38
+SHA512:
+  metadata.gz: f5add1a4598b39cc55c0f5b50855e1089caf5e3f5728a08988a75e98b0e4cf1fa1a98a4eeb43e286cf1234cd818ea33f0e91c8e6aed596d6cbf52dd84a4b91c9
+  data.tar.gz: f022c57f63cfa656aea89af82e0d85d8c57349634c73fd45a9f4c109a520774159d1f92b0d26c39ac24e414a9aeb2c990bddd317d313685457c08257691069b2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Matheus A Martins
+
+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 @@
+# HeyDoctor - doc c'mon man!
+
+![banner](banner.png)
+
+This is a simple stack health check for rails based applications, it mounts a endpoint with the current status of database, application and redis.
+
+## Usage
+
+After installing this gem it will mount a endpoint in `/_ah/health`, this will bring a response like this:
+
+`curl localhost:8000/_ah/health`
+
+```json
+{
+   "app":{
+      "message":"Application is running",
+      "success":true
+   },
+   "database":{
+      "message":"Database is connected",
+      "success":true
+   },
+   "redis":{
+      "message":"Redis is connected",
+      "success":true
+   }
+}
+```
+
+## Installation
+
+If you have a redis instance in you application add the following initializer to create a `Redis.current`, so it don't need to use global vars, or create a new connection each request:
+
+```ruby
+# config/initializers/redis.rb
+
+Redis.current ||= Redis.new(url: ENV['REDIS_URL'])
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hey_doctor'
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+After installing the gem just mount the HealthCheck endpoint inside config.ru:
+
+```ruby
+# config.ru
+
+# bunch of requires here
+require "hey_doctor"
+
+map '/_ah/health' do
+  run HeyDoctor::Rack::HealthCheck.new
+end
+
+...
+```
+
+## Developing
+
+```bash
+docker-compose build && docker-compose up
+
+docker-compose exec web bash
+
+rails db:setup
+
+rubocop -A && rspec
+```
+
+Minimum coverage is set to 95%.
+
+## Releasing
+
+Change the tag in `lib/hey_doctor/version.rb` each release using [SEMVER](https://semver.org/lang/pt-BR/).
+
+```bash
+bundle exec rake build
+# build gem in pkg/hey_doctor-TAG.gem
+
+bundle exec rake release
+# Ask for rubygems credentials and makes the release
+```
+## Contributing
+
+Fell free to send a PR.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/services/hey_doctor/check_application_health_service.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class HeyDoctor::CheckApplicationHealthService
+  class << self
+    SUCCESS = {
+      message: 'Application is running',
+      success: true
+    }.freeze
+
+    ERROR = {
+      message: 'Application down, call the firefighters',
+      success: false
+    }.freeze
+
+    def call
+      return SUCCESS if responding?
+
+      ERROR
+    end
+
+    private
+
+    def responding?
+      Net::HTTP.start('localhost', 8000) { |http| http.head('/') }.code == '200'
+    rescue StandardError
+      false
+    end
+  end
+end

data/app/services/hey_doctor/check_database_health_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class HeyDoctor::CheckDatabaseHealthService
+  class << self
+    SUCCESS = {
+      message: 'Database is connected',
+      success: true
+    }.freeze
+
+    MIGRATION_PENDING = {
+      message: 'Pending migrations detected',
+      success: true
+    }.freeze
+
+    ERROR = {
+      message: 'Error connecting to database',
+      success: false
+    }.freeze
+
+    def call
+      return ERROR unless connected?
+      return MIGRATION_PENDING if needs_migration?
+
+      SUCCESS
+    end
+
+    private
+
+    def connected?
+      ActiveRecord::Base.connection.execute('select 1')
+
+      true
+    rescue ActiveRecord::StatementInvalid, ActiveRecord::NoDatabaseError
+      false
+    end
+
+    def needs_migration?
+      return false unless connected?
+
+      ActiveRecord::Base.connection.migration_context.needs_migration?
+    end
+  end
+end

data/app/services/hey_doctor/check_redis_health_service.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class HeyDoctor::CheckRedisHealthService
+  class << self
+    SUCCESS = {
+      message: 'Redis is connected',
+      success: true
+    }.freeze
+
+    ERROR = {
+      message: 'Error connecting to redis',
+      success: false
+    }.freeze
+
+    def call
+      return SUCCESS if connected?
+
+      ERROR
+    end
+
+    private
+
+    def connected?
+      Redis.current.get('viva_a_sociedade_alternativa')
+
+      true
+    rescue Redis::CannotConnectError, NameError
+      false
+    end
+  end
+end

data/lib/hey_doctor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'hey_doctor/version'
+require 'hey_doctor/engine'
+
+module HeyDoctor::Rack
+  class HealthCheck
+    def call(_env)
+      [200, {}, [status]]
+    end
+
+    private
+
+    def status
+      {
+        app: ::HeyDoctor::CheckApplicationHealthService.call,
+        database: ::HeyDoctor::CheckDatabaseHealthService.call,
+        redis: ::HeyDoctor::CheckRedisHealthService.call
+      }.to_json
+    end
+  end
+end

data/lib/hey_doctor/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class HeyDoctor::Engine < ::Rails::Engine
+  isolate_namespace HeyDoctor
+  config.generators.api_only = true
+
+  config.generators do |generators|
+    generators.test_framework :rspec
+  end
+end

data/lib/hey_doctor/version.rb

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

data/lib/tasks/hey_doctor_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :hey_doctor do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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 @@
+//= link_directory ../stylesheets .css

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,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

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

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

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

@@ -0,0 +1,5 @@
+class HomeController < ApplicationController
+  def index
+    render :ok, json: { funfa: 'sim' }
+  end
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// 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 rails-ujs
+//= require activestorage
+//= require_tree .

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

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

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

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

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

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

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/rails

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

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # 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')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end