deep_health_check 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837e823c90a18054f24eeb42e3079edfaed7de08d103dc66c476e5f31d237640
-  data.tar.gz: 94b9be499506937b5728f7f24863a7fec3ecad6ef0dcf892fca13098cd2d3af7
+  metadata.gz: 0e806e827a25b48a56d508d9e002831bad2cabd996fa91ced9409bf2cf74edf4
+  data.tar.gz: b72f0abcf77e96dc49a4968ed5094b24b70714fb721ae2c04a20067ea448b503
 SHA512:
-  metadata.gz: 1774e274f3cb5a3843629d446cd3e462d063ed9419ac0c904d1261006c4095c3338a7a08fbed249ace233270722528f6871aef8865417e31701ce8eba1e4467d
-  data.tar.gz: 9a7496f4e793c9b2a6a127b0276154ea14f24171c5857780f8109f00e5c56f9f1a152bce7063cc543bc8e5690bb477f4f5ebadccdb40ced497309a703f0841a0
+  metadata.gz: 67a85264724ece119c51a703211a4010757d112120ce4ae9b6d0d6bd51f8b9b339b3b510e1b957e98efecc3b3e79c06fe732945c9fa5e4c01bac8d926e862699
+  data.tar.gz: 4af00a8c3c81f2fcbe87f3f4482962eeb386ae60ed3adfab61c2813f7621872737cff08e2fff68eb53b05e2d1caadbbc8a60ae96e517a7b334142721da1e7650

data/.github/workflows/codecov.yml

@@ -0,0 +1,36 @@
+name: Codecov
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Run rspec to generate code coverage
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Run test cases
+      run: |
+        gem install bundler
+        bundle install
+        bundle exec rspec
+      env:
+        CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+
+    - name: Slack notification Success
+      if: success()
+      env:
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+      uses: cemkiy/action-slacker@master
+      with:
+        channel: '#github-ci-actions'
+        icon_url: 'https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png'
+        username: 'GitHub'

data/.rubocop.yml

@@ -1,7 +1,8 @@
 AllCops:
   Exclude:
     - 'bin/*'
-Documentation:
+
+Style/Documentation:
     Enabled: false
 
 Metrics/BlockLength:

data/.travis.yml

@@ -5,7 +5,10 @@ language: ruby
 rvm:
   - 2.6.4
 
-bundler_args: --without system_tests
+bundler_args: --without system_tests --jobs=3 --retry=3
+
+before_install:
+  - gem install bundler
 
 script: bin/travis
 

data/README.md

@@ -1,4 +1,11 @@
-# HealthCheck
+# DeepHealthCheck
+
+[![Gem Version](https://badge.fury.io/rb/deep_health_check.svg)](https://badge.fury.io/rb/deep_health_check)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Build Status](https://travis-ci.org/wshihadeh/deep_health_check.svg?branch=master)](https://travis-ci.org/wshihadeh/deep_health_check)
+[![Depfu](https://badges.depfu.com/badges/b29d275b0743e77163a813ac51251be9/count.svg)](https://depfu.com/github/wshihadeh/deep_health_check?project_id=10389)
+![Codecov](https://img.shields.io/codecov/c/github/wshihadeh/deep_health_check)
+
 
 A simple Health status API
 
@@ -26,7 +33,17 @@ Health check middleware expose the following endpoints
   - /health
   - /db_health
   - /tcp_dependencies_health
+      + dependencies must follow the below format and can be coonfigured using envioronment varables such as:
+       ```sh
+       # TCP_DEPENDENCY_${00..99}=${ip_or_host}:${port}
+       TCP_DEPENDENCY_00=127.0.0.0:8080
+       ```
   - /http_dependencies_health
+      + dependencies must be valid http url and can be coonfigured using envioronment varables such as:
+       ```sh
+       # HTTP_DEPENDENCY_${00..99}=${ip_or_host}:${port}
+       HTTP_DEPENDENCY_00=http://127.0.0.0:8080/health
+       ```
 
 Some of these endpoints provide information about the database and system status. By Default these endpoints are not protected and are accessible publicly. To reduce the security risk introduced by exposing these endpoints, We can protect them using htauth credentials. The following page provide all the necessary steps needed to achieve this task.
 

data/deep_health_check.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'deep_health_check/version'
 
@@ -13,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['shihadeh.dev@gmail.com']
 
   spec.summary       = 'Provides a health check API endpoint'
-  spec.description   = 'Provides a health check API endpoint'
+  spec.description   = 'Provides a health check API endpoint for rack apps'
   spec.homepage      = 'https://github.com/wshihadeh/deep_health_check'
   spec.license       = 'MIT'
 
@@ -24,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'net-telnet'
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'net-telnet', '~> 0.2'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rack-test', '~> 1.1.0'
-  spec.add_development_dependency 'rspec', '~> 3.5.0'
-  spec.add_development_dependency 'rubocop', '0.78.0'
+  spec.add_development_dependency 'codecov', '~> 0'
+  spec.add_development_dependency 'rack-test', '~> 1.1', '>= 1.1.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
+  spec.add_development_dependency 'rubocop', '1.23.0'
 end

data/lib/deep_health_check/db_health_check.rb

@@ -25,7 +25,7 @@ module DeepHealthCheck
       data[:db_size] = ActiveRecord::Base.connection_pool.size
       data[:db_conn_size] = ActiveRecord::Base.connection_pool.connections.size
       data
-    rescue
+    rescue StandardError
       {}
     end
 
@@ -35,7 +35,7 @@ module DeepHealthCheck
       data[:terminated_count] = Delayed::Job.where.not(failed_at: nil).count
       data[:faild_dj_count] = Delayed::Job.where(failed_at: nil)
                                           .where('attempts > 0').count
-    rescue
+    rescue StandardError
       {}
     end
   end

data/lib/deep_health_check/dependency_health_check.rb

@@ -10,6 +10,7 @@ module DeepHealthCheck
 
     def call
       return no_dependencies_response if @dependencies.nil?
+
       api_health_check health_status_code, @dependencies
     end
 

data/lib/deep_health_check/http_dependency_health_check.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
 
 module DeepHealthCheck
   class HTTPDependencyHealthCheck < DependencyHealthCheck
+    CONTENT_TYPE    = 'Content-Type'
+    JSON_MIME_TYPE  = 'application/json'
+
     def initialize
       @type = 'http'
       @dependencies = process_dependencies fetch_dependencies_from_env
@@ -32,14 +34,23 @@ module DeepHealthCheck
 
     def http_status(url)
       response = faraday.get url
-      { status: response.status, details: response.body }
+      response_body = extract_response_body response
+      { status: response.status, details: response_body }
     rescue RuntimeError, Faraday::Error => e
       { status: nil, details: e.inspect }
     end
 
+    def extract_response_body(response)
+      unless response.headers[CONTENT_TYPE] == JSON_MIME_TYPE
+        return response.body
+      end
+
+      require 'json' unless defined?(::JSON)
+      JSON.parse(response.body)
+    end
+
     def faraday
       Faraday.new do |builder|
-        builder.response :json, content_type: /\bjson$/
         builder.response(:encoding) if defined?(Faraday::Encoding)
         builder.adapter Faraday.default_adapter
       end

data/lib/deep_health_check/tcp_dependency_health_check.rb

@@ -35,8 +35,9 @@ module DeepHealthCheck
         'Telnetmode' => false,
         'Prompt' => /^\+OK/n
       )
+
       down
-    rescue
+    rescue StandardError
       down
     end
 

data/lib/deep_health_check/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeepHealthCheck
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,134 +1,147 @@
 --- !ruby/object:Gem::Specification
 name: deep_health_check
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Al-waleed shihadeh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net-telnet
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: net-telnet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.78.0
-description: Provides a health check API endpoint
+        version: 1.23.0
+description: Provides a health check API endpoint for rack apps
 email:
 - shihadeh.dev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codecov.yml"
 - ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rspec"
@@ -173,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provides a health check API endpoint