leafy-health 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19b3d546b5202841ed7456d0e3558311f3d485d8
+  data.tar.gz: 2942aaf142b3c01f4ddaf1ffd07d2d011d5bbc4b
+SHA512:
+  metadata.gz: 11fcc8168409f777ebfed83bc2286615e40b5e0b50223d7dfa992512b57a0ca8fabf41ee108afb1a93f46cd6fec17ce4c53c644157f8a864f21531ab80fea2af
+  data.tar.gz: dfbb26d6b09877fe02f6a3dacf56aec6d6008868b17e0cd936bab395663bd202274f3dd60449e8d9d474e9ee4d56a05fe8e36f27fe822ab888cb40ae1e62072e

data/.gitignore

@@ -0,0 +1,4 @@
+.yardoc
+doc
+pkg
+*.lock

data/Gemfile

@@ -0,0 +1,7 @@
+#-*- mode: ruby -*-
+
+source 'https://rubygems.org'
+
+gemspec
+
+# vim: syntax=Ruby

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lookout
+
+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,96 @@
+# Leafy-Health
+
+## installation
+
+via rubygems
+```
+gem install leafy-health
+```
+or add to your Gemfile
+```
+gem 'leqfy-health'
+```
+
+installing the gem also takes care of the jar dependencies with jruby-1.7.16+
+
+## usage
+
+an instance of the registry ```Leafy::Health::Registry``` can register and unresgister health-checks under a given name. any object with a #call method will do or block on the register method.
+
+     registry = Leafy::Health::Registry.new
+
+you can ask the registry which names have already health-checks registered:
+
+     registry.names
+
+### simple health check
+
+simple in the sense that either call returns ```nil``` which means healthy or a message which is the unhealthy state. the message can be any ```String```.
+     
+    registry.register( 'simple.block') do
+      if app.crashed
+        'application crashed'
+      end
+    end
+
+or with a health-check object
+
+    class AppCheck
+      def call
+        if app.crashed
+          'application crashed'
+        end
+      enf
+    end
+    registry.register( 'simple.class', AppCheck.new )
+
+### health checks with message on healthy state
+
+here the call method gets an argument which allows to create both
+healthy and unhealthy states with message.
+         
+    registry.register( 'app.block') do |health|
+      if app.crashed
+        health.unhealthy( 'application crashed' )
+      else
+        health.healthy( 'application ok' )
+      end
+    end
+
+or with a health-check object
+
+    class AppCheck
+      def call( health )
+        if app.crashed
+          health.unhealthy( 'application crashed' )
+        else
+          health.healthy( 'application ok' )
+        end
+      end
+    end
+    registry.register( 'app.class', AppCheck.new )
+
+### unregister health checks
+
+    registry.unregister( 'app.class' )
+
+### note
+
+currently there is not further introspection on the registry and its health-check. with the ```Leafy::Json::HealthWriter``` (from leafy-rack) you can get a json representation of the current **health report**
+
+    Leafy::Json::HealthWriter.to_json( registry.health )
+
+## developement
+
+get all the gems and jars in place
+
+    gem install jar-dependencies --development
+	bundle install
+
+for running all specs
+
+	rake
+
+or
+
+    rspec spec/reporter_spec.rb

data/Rakefile

@@ -0,0 +1,14 @@
+#-*- mode: ruby -*-
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "yard"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options += ["--title", "Leafy Health API"]
+end
+
+task :default => [ :spec ]
+
+# vim: syntax=Ruby

data/leafy-health.gemspec

@@ -0,0 +1,26 @@
+#-*- mode: ruby -*-
+
+require File.expand_path( '../lib/leafy/health/version', __FILE__ )
+
+Gem::Specification.new do |s|
+  s.name = 'leafy-health'
+  s.version = Leafy::Health::VERSION
+  s.author = 'christian meier'
+  s.email = [ 'christian.meier@lookout.com' ]
+
+  s.license = 'MIT'
+  s.summary = %q(provides an API to register healthchecks)
+  s.homepage = 'https://github.com/lookout/leafy'
+  s.description = %q(provides an API to register healthchecks which uses dropwizrd-metrics-healthchecks)
+  
+  s.files = `git ls-files`.split($/)
+
+  s.requirements << 'jar io.dropwizard.metrics:metrics-healthchecks, 3.1.0'
+
+  s.add_runtime_dependency 'jar-dependencies', '~> 0.1.8'
+  s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'yard', '~> 0.8.7'
+  s.add_development_dependency 'rake', '~> 10.2'
+end
+
+# vim: syntax=Ruby

data/lib/leafy/health/registry.rb

@@ -0,0 +1,90 @@
+require 'leafy/health'
+module Leafy
+  module Health
+    class Registry
+
+      class HealthCheck < com.codahale.metrics.health.HealthCheck
+
+        # create healthy result object with given message
+        #
+        # param [String] optional result message, can be nil
+        # return [com.codahale.metrics.health.HealthCheck::Result]
+        def healthy( result = nil )
+          com.codahale.metrics.health.HealthCheck::Result.healthy( result )
+        end
+
+        # create unhealthy result object with given message
+        #
+        # param [String] result message
+        # return [com.codahale.metrics.health.HealthCheck::Result]
+        def unhealthy( result )
+          com.codahale.metrics.health.HealthCheck::Result.unhealthy( result )
+        end
+
+        def initialize( block )
+          super()
+          @block = block
+        end
+    
+        def check
+          case result = @block.call( self )
+          when String
+            unhealthy( result )
+          when NilClass
+            healthy
+          else
+            result
+          end
+        end
+      end
+
+      # state ofthe registry
+      attr_reader :health
+
+      def initialize
+        @health = com.codahale.metrics.health.HealthCheckRegistry.new
+      end
+
+      # register a HealthCheck under a given name
+      # 
+      # @param [String] name
+      # @param [String] instead of block any check object which responds to 'call'
+      # @yieldparam [HealthCheckRegistry::HealthCheck] which has convienient methods to create healthy and unhealthy results with message
+      # @yieldreturn [String] if the healthcheck fails return the message
+      # @yieldreturn [NilClass] if the healthcheck succeeds
+      # @yieldreturn [com.codahale.metrics.health.HealthCheck::Result] if the check produces its own result object
+      def register(name, check = nil, &block )
+        if check and not block_given? and check.respond_to? :call
+          @health.register( name, HealthCheck.new( check ) )
+          
+        elsif check.nil? and block_given?
+          @health.register( name, HealthCheck.new( block ) )
+        else
+          raise 'needs either a block and object with call method'
+        end
+      end
+ 
+      # unregister a HealthCheck for a given name
+      # 
+      # @param [String] name
+      def unregister(name)
+        @health.unregister(name)
+      end
+
+      # the names of all registered HealthCheck
+      # 
+      # @return [Array<String>] names of HealthCheck in order of their registration
+      def names
+        @health.names.to_a
+      end
+
+      # # run a healthcheck for a given name
+      # # 
+      # # @param [String] name
+      # # @return [Java::ComCodahaleMetricsHealth::HealthCheck::Result] result of the health-check
+      # def run_health_check(name) 
+      #   @health.runHealthCheck(name)
+      # end
+    end
+  end
+end

data/lib/leafy/health/version.rb

@@ -0,0 +1,6 @@
+module Leafy
+  module Health
+    VERSION = '0.1.0'.freeze
+  end
+end
+    

data/lib/leafy/health.rb

@@ -0,0 +1,2 @@
+require 'leafy-health_jars'
+require 'leafy/health/registry'

data/lib/leafy-health.rb

@@ -0,0 +1,2 @@
+require 'leafy-health_jars'
+require 'leafy/health/registry'

data/lib/leafy-health_jars.rb

@@ -0,0 +1,5 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+require 'jar_dependencies'
+
+require_jar( 'io.dropwizard.metrics', 'metrics-healthchecks', '3.1.0' )
+require_jar( 'org.slf4j', 'slf4j-api', '1.7.7' )

data/spec/registry_spec.rb

@@ -0,0 +1,63 @@
+require 'leafy/health'
+
+describe Leafy::Health::Registry do
+
+  subject { Leafy::Health::Registry.new }
+
+  it 'registers and unregister check as block' do
+    subject.register('me') do
+      'error'
+    end
+    expect(subject.names).to eq ['me']
+    expect(subject.health.run_health_checks.keys).to eq ['me']
+
+    subject.unregister('me')
+    expect(subject.names).to be_empty
+  end
+
+  it 'registers and unregister check as object with call method' do
+    subject.register('me', Proc.new {} )
+    expect(subject.names).to eq ['me']
+    expect(subject.health.run_health_checks.keys).to eq ['me']
+    
+    subject.unregister('me')
+    expect(subject.names).to be_empty
+  end
+
+  it 'fails register check as object without call method' do
+    expect { subject.register('me', Object.new ) }.to raise_error
+  end
+
+  describe Leafy::Health::Registry::HealthCheck do
+
+    it 'is healthy with simple block' do
+      check = Leafy::Health::Registry::HealthCheck.new( Proc.new { nil } )
+      expect( check.check.healthy? ).to be true
+      expect( check.check.message ).to be nil
+    end
+
+    it 'is healthy' do
+      checker = Proc.new do |health|
+        health.healthy( 'ok' )
+      end
+      check = Leafy::Health::Registry::HealthCheck.new( checker )
+      expect( check.check.healthy? ).to be true
+      expect( check.check.message ).to eq 'ok'
+    end
+
+    it 'is unhealthy with simple block' do
+      check = Leafy::Health::Registry::HealthCheck.new( Proc.new { 'sick' } )
+      expect( check.check.healthy? ).to be false
+      expect( check.check.message ).to eq 'sick'
+    end
+
+    it 'is unhealthy' do
+      checker = Proc.new do |health|
+        health.unhealthy( 'not ok' )
+      end
+      check = Leafy::Health::Registry::HealthCheck.new( checker )
+      expect( check.check.healthy? ).to be false
+      expect( check.check.message ).to eq 'not ok'
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path( '../../lib', __FILE__ )

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: leafy-health
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- christian meier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jar-dependencies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+description: provides an API to register healthchecks which uses dropwizrd-metrics-healthchecks
+email:
+- christian.meier@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- leafy-health.gemspec
+- lib/leafy-health.rb
+- lib/leafy-health_jars.rb
+- lib/leafy/health.rb
+- lib/leafy/health/registry.rb
+- lib/leafy/health/version.rb
+- spec/registry_spec.rb
+- spec/setup.rb
+homepage: https://github.com/lookout/leafy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar io.dropwizard.metrics:metrics-healthchecks, 3.1.0
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: provides an API to register healthchecks
+test_files: []