hcheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d9d1373ccfab7fe053f2413da9474f371b5cd9
+  data.tar.gz: ece2db1ed128d3356a931cc635129f6369872645
+SHA512:
+  metadata.gz: 35332044c5f470d706ed3ec67fc080a316fdc707f52c4852b47e80bf720dd95b3a28d45b8c34e8d57f066134e5476056d6006ab275f51f95b37d7dfd8169953b
+  data.tar.gz: 83aee556a3c44eb030fcb7df957f758b9c4bfa5febff4f2a60a7dc6c01da5584ddd004d9481d6af7937af479e4d83b2ad436627ee4fd2aaf719dba7869d73e78

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rspec_status
+.DS_Store
+*.gem
+spec/.env
+
+/log/
+hcheck.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/BlockLength:
+  Exclude:
+    - hcheck.gemspec
+    - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Max: 16
+Metrics/LineLength:
+  Max: 110
+  Exclude:
+    - hcheck.gemspec
+    - 'spec/**/*.rb'
+Lint/AssignmentInCondition:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.3
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hcheck.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    hcheck (0.1.0)
+      haml (~> 5.0)
+      sinatra (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.0)
+    ast (2.4.0)
+    bson (4.3.0)
+    bunny (2.9.2)
+      amq-protocol (~> 2.3.0)
+    coderay (1.1.2)
+    dalli (2.7.8)
+    diff-lcs (1.2.5)
+    dotenv (2.5.0)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
+    jaro_winkler (1.5.1)
+    method_source (0.9.0)
+    mongo (2.4.3)
+      bson (>= 4.2.1, < 5.0.0)
+    mustermann (1.0.2)
+    mysql2 (0.5.2)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    pg (0.21.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-protection (2.0.3)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.0.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    sinatra (2.0.3)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.3)
+      tilt (~> 2.0)
+    temple (0.8.0)
+    tilt (2.0.8)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  bunny (~> 2.9.2)
+  dalli (~> 2.7.8)
+  dotenv (~> 2.5.0)
+  haml (~> 5.0)
+  hcheck!
+  mongo (~> 2.4.3)
+  mysql2 (~> 0.5.2)
+  pg (~> 0.18)
+  pry (~> 0.11)
+  rack-test (~> 1.1.0)
+  rake (~> 10.0)
+  redis (~> 4.0.2)
+  rspec (~> 3.0)
+  rubocop (~> 0.58.2)
+  sinatra (~> 2.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rohit Joshi
+
+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,125 @@
+# Hcheck
+
+Configuration driven health checker for ruby apps. Can be mounted or booted as standalone app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hcheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hcheck
+
+## Usage
+
+To run as standalone server:
+``` bash
+  hcheck -c path/to/hcheck.yml
+  hcheck # looks for hcheck.yml in current project root path
+```
+
+Usage in rails:
+``` ruby
+  # routes.rb
+  mount Hcheck::Status => '/hcheck' # Needs hcheck.yml in config directory.
+```
+
+Example `hcheck.yml`
+``` yaml
+postgresql:
+  check: App Main Store # Name of the check
+  host: localhost
+  port: 5432
+  username: root
+  password:
+  database: postgres
+
+```
+A complex `hcheck.yml`
+``` yaml
+postgresql:
+  check: App Main Store
+  host: <%= ENV['PG_HOST'] %>
+  port: 5432
+  username: <%= `whoami` %>
+  password: <%= ENV['PG_PASSWORD'] %>
+  database: <%= ENV['PG_DBNAME'] %>
+redis:
+  - check: App Main Cache
+    url: redis://localhost:6379
+    db: hcheck
+    password:
+  - check: Delayed Jobs Store
+    url: redis://mymaster
+    db: hcheck
+    password:
+    role: master
+    sentinels:
+      - host: localhost
+        port: 26379
+      - host: localhost
+        port: 26380
+mongodb:
+  check: Mongo DB
+  hosts:
+    - localhost:27017
+  user:
+  password:
+mysql:
+  check: Mysql Connection
+  host: localhost
+  username: localuser
+  password: password
+rabbitmq:
+  check: Rabbit Main
+  host: localhost
+  port: 5672
+  user: guest
+  pass: guest
+ping:
+  check: Main App Home
+  url: http://127.0.0.1:3033/
+```
+
+`check` key refers to name or description than can be given to a check.
+
+There is also a generator available if you fancy it: `hcheck g:config`, generates a sample hcheck yaml config file for you.
+
+## Authenticated Hcheck
+
+Basic token based authentication can be enabled if desired. Env variable `HCHECK_SECURE` can set set to protect the hcheck path and `HCHECK_ACCESS_TOKEN`can be used to set token. Token can then sent as `token` get params, like `/hcheck?token=xxx`. Authentication failure will render 401.
+
+## Dependencies
+
+The checks are implemented with the help of available gems. Postgresql check require `pg` gem, redis requires `redis` and so on. Check out individual module files in `lib/hcheck/checks` to see what and how they are being required.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `rubocop` to smash all silly errors and style deficiencies.
+
+The checks during test loads the environmental settings from `spec/.env` for helping with testing in local machine.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Todo
+
+Travis CI Integrations
+  - Github PR status
+  - Continuous Integration
+  - Continuous release to RubyGems
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rohitrox/hcheck.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hcheck'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+cp spec/.env.sample spec/.env
+cp hcheck.sample.yml hcheck.yml

data/exe/hcheck

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'hcheck'
+
+# check if command is to generate config
+if ARGV.any? && ARGV[0].eql?('g:config')
+  Hcheck::Configuration.generate_config
+else
+  # try load config from args if supplied
+  if ARGV.any?
+    Hcheck::Configuration.load_argv(ARGV)
+  else
+    Hcheck::Configuration.load_default
+  end
+  Hcheck::Application.run!
+end

data/hcheck.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hcheck'
+  spec.version       = Hcheck::VERSION
+  spec.authors       = ['Rohit Joshi']
+  spec.email         = ['link2j.roy@gmail.com']
+
+  spec.summary       = 'Health checker for ruby apps'
+  spec.description   = 'Health checker for ruby apps. Can be mounted or booted as standalone app'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'haml', '~> 5.0'
+  spec.add_runtime_dependency 'sinatra', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+
+  spec.add_development_dependency 'bunny', '~> 2.9.2'
+  spec.add_development_dependency 'dalli', '~> 2.7.8'
+  spec.add_development_dependency 'mongo', '~> 2.4.3'
+  spec.add_development_dependency 'mysql2', '~> 0.5.2'
+  spec.add_development_dependency 'pg', '~> 0.18'
+  spec.add_development_dependency 'redis', '~> 4.0.2'
+
+  spec.add_development_dependency 'haml', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sinatra', '~> 2.0'
+
+  spec.add_development_dependency 'dotenv', '~> 2.5.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rack-test', '~> 1.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.2'
+end

data/hcheck.sample.yml

@@ -0,0 +1,47 @@
+postgresql:
+  check: Core Datastore
+  host: localhost
+  port: 5432
+  username: <%= `whoami` %>
+  password:
+  database: postgres
+redis:
+  - check: Store Cache
+    url: redis://localhost:6379
+    db: hcheck
+    password:
+  - check: Cache Sentinels
+    url: redis://mymaster
+    db: hcheck
+    password:
+    role: master
+    sentinels:
+      - host: localhost
+        port: 26379
+      - host: localhost
+        port: 26380
+mongodb:
+  check: Mongo DB
+  hosts:
+    - localhost:27017
+  user:
+  password:
+mysql:
+  check: Mysql Connection
+  host: localhost
+  username: localuser
+  password: password
+rabbitmq:
+  check: Rabbit
+  host: localhost
+  port: 5672
+  user: guest
+  pass: guest
+ping:
+  check: Core Api
+  url: https://google.com
+memcached:
+  check: Memcached Cache
+  url: localhost:11211
+  namespace: app
+  compress: true