hey_doctor 1.0.0

data/spec/dummy/tmp/development_secret.txt

@@ -0,0 +1 @@
+6c551440807532181e3e1a6bdfb56b4ef8baadbd7e5b3d24cc76fe479bc2a64b9fec206c9cae0a8f3b1e2de825e495322c1ccd215cec04058f0477b7436a95a3

data/spec/dummy/tmp/pids/server.pid

@@ -0,0 +1 @@
+1

data/spec/lib/hey_doctor/hey_doctor_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe '.Rack HealthCheck endpoint' do
+  let(:expected_response) do
+    {
+      app: {
+        message: 'foo',
+        success: true
+      },
+      database: {
+        message: 'foo',
+        success: true
+      },
+      redis: {
+        message: 'foo',
+        success: true
+      }
+    }.to_json
+  end
+
+  let(:env) { { 'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/_ah/health' } }
+
+  before do
+    allow(HeyDoctor::CheckApplicationHealthService).to receive(:call)
+      .and_return({ message: 'foo', success: true })
+
+    allow(HeyDoctor::CheckDatabaseHealthService).to receive(:call)
+      .and_return({ message: 'foo', success: true })
+
+    allow(HeyDoctor::CheckRedisHealthService).to receive(:call)
+      .and_return({ message: 'foo', success: true })
+  end
+
+  it 'build the json response' do
+    response = HeyDoctor::Rack::HealthCheck.new.call(env)
+    body = response[2].first
+
+    expect(body).to eq(expected_response)
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('dummy/config/environment.rb', __dir__)
+
+if Rails.env.production?
+  abort('The Rails environment is running in production mode!')
+end
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/spec/requests/health_check_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Health Check endpoint', type: :request do
+  let(:expected_response) do
+    {
+      app: {
+        message: 'Application is running',
+        success: true
+      },
+      database: {
+        message: 'Database is connected',
+        success: true
+      },
+      redis: {
+        message: 'Redis is connected',
+        success: true
+      }
+    }.to_json
+  end
+
+  before { get '/_ah/health' }
+
+  xit 'builds the response' do
+    expect(response.body).to eq(expected_response)
+  end
+end

data/spec/services/hey_doctor/check_application_health_service_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'net/http'
+
+RSpec.describe HeyDoctor::CheckApplicationHealthService do
+  describe '.call' do
+    let(:http) { double }
+
+    before do
+      allow(Net::HTTP).to receive(:start).and_yield(http)
+
+      allow(http).to receive(:head).and_return(response_double)
+    end
+
+    context 'When app is running' do
+      let(:expected_response) do
+        {
+          message: 'Application is running',
+          success: true
+        }
+      end
+
+      let(:response_double) { double(Net::HTTP, code: '200') }
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+
+    context 'When app is down' do
+      let(:expected_response) do
+        {
+          message: 'Application down, call the firefighters',
+          success: false
+        }
+      end
+
+      let(:response_double) { double(Net::HTTP, code: '500') }
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+  end
+end

data/spec/services/hey_doctor/check_database_health_service_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe HeyDoctor::CheckDatabaseHealthService do
+  describe '.call' do
+    context 'when it is connected' do
+      let(:expected_response) do
+        {
+          message: 'Database is connected',
+          success: true
+        }
+      end
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+
+    context 'when it is not connected' do
+      let(:expected_response) do
+        {
+          message: 'Error connecting to database',
+          success: false
+        }
+      end
+
+      before do
+        allow(ActiveRecord::Base).to receive(:connection)
+          .and_raise(ActiveRecord::StatementInvalid)
+      end
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+
+    context 'When migration is Pending' do
+      let(:expected_response) do
+        {
+          message: 'Pending migrations detected',
+          success: true
+        }
+      end
+
+      before do
+        allow(described_class).to receive(:connected?).and_return(true).twice
+        allow(described_class).to receive(:needs_migration?).and_return(true)
+      end
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+  end
+
+  describe '.connected?' do
+    context 'when it is connected' do
+      it 'respond with success' do
+        expect(described_class.send(:connected?)).to eq(true)
+      end
+    end
+
+    context 'when it is not connected' do
+      before do
+        allow(ActiveRecord::Base).to receive(:connection)
+          .and_raise(ActiveRecord::StatementInvalid)
+      end
+
+      it 'respond with success' do
+        expect(described_class.send(:connected?)).to eq(false)
+      end
+    end
+  end
+
+  describe 'needs_migration?' do
+    context 'when migration is Pending' do
+      before do
+        allow(described_class).to receive(:connected?).and_return(true).twice
+
+        allow(ActiveRecord::Base).to receive_message_chain(
+          :connection, :migration_context, :needs_migration?
+        ).and_return(true)
+      end
+
+      it 'respond with success' do
+        expect(described_class.send(:needs_migration?)).to eq(true)
+      end
+    end
+  end
+end

data/spec/services/hey_doctor/check_redis_health_service_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe HeyDoctor::CheckRedisHealthService do
+  describe '.call' do
+    context 'when it is connected' do
+      let(:expected_response) do
+        {
+          message: 'Redis is connected',
+          success: true
+        }
+      end
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+
+    context 'when it is not connected' do
+      let(:expected_response) do
+        {
+          message: 'Error connecting to redis',
+          success: false
+        }
+      end
+
+      before do
+        allow(Redis.current).to receive(:get).and_raise(NameError)
+      end
+
+      it 'respond with success' do
+        expect(described_class.call).to eq(expected_response)
+      end
+    end
+  end
+
+  describe '.connected?' do
+    context 'when it is connected' do
+      it 'respond with success' do
+        expect(described_class.send(:connected?)).to eq(true)
+      end
+    end
+
+    context 'when it is not connected' do
+      before do
+        allow(Redis.current).to receive(:get)
+          .and_raise(Redis::CannotConnectError)
+      end
+
+      it 'respond with success' do
+        expect(described_class.send(:connected?)).to eq(false)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'rack/test'
+
+SimpleCov.start 'rails' do
+  add_filter '/bin'
+  add_filter '/coverage'
+  add_filter '/db'
+  add_filter '/lib/hey_doctor/version.rb'
+end
+
+SimpleCov.minimum_coverage 95
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: hey_doctor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matheus Acosta
+- Erick Nascimento
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv-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: redis
+  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: rubocop-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: simplecov
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+description: It mounts a middleware endpoint to check the stack health.
+email:
+- matheus.martins@deliverycenter.com
+- erick.nascimento@deliverycenter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/services/hey_doctor/check_application_health_service.rb
+- app/services/hey_doctor/check_database_health_service.rb
+- app/services/hey_doctor/check_redis_health_service.rb
+- lib/hey_doctor.rb
+- lib/hey_doctor/engine.rb
+- lib/hey_doctor/version.rb
+- lib/tasks/hey_doctor_tasks.rake
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
+- spec/dummy/app/javascript/packs/application.js
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cors.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/redis.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/db/schema.rb
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/tmp/development_secret.txt
+- spec/dummy/tmp/pids/server.pid
+- spec/lib/hey_doctor/hey_doctor_spec.rb
+- spec/rails_helper.rb
+- spec/requests/health_check_spec.rb
+- spec/services/hey_doctor/check_application_health_service_spec.rb
+- spec/services/hey_doctor/check_database_health_service_spec.rb
+- spec/services/hey_doctor/check_redis_health_service_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deliverycenter/hey_doctor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deliverycenter/hey_doctor
+  source_code_uri: https://github.com/deliverycenter/hey_doctor
+  changelog_uri: https://github.com/deliverycenter/hey_doctor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A health check gem implementation in ruby.
+test_files:
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
+- spec/dummy/app/javascript/packs/application.js
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cors.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/redis.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/config.ru
+- spec/dummy/db/schema.rb
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/tmp/development_secret.txt
+- spec/dummy/tmp/pids/server.pid
+- spec/lib/hey_doctor/hey_doctor_spec.rb
+- spec/rails_helper.rb
+- spec/requests/health_check_spec.rb
+- spec/services/hey_doctor/check_application_health_service_spec.rb
+- spec/services/hey_doctor/check_database_health_service_spec.rb
+- spec/services/hey_doctor/check_redis_health_service_spec.rb
+- spec/spec_helper.rb