health_rails 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@health_rails --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in health_rails.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/health_rails/health_controller.rb

@@ -0,0 +1,11 @@
+class HealthRails::HealthController < ApplicationController
+  # GET /health
+  def index
+    health_check = HealthRails::HealthCheck.new
+    if health_check.all_ok?
+      render text: "All OK"
+    else
+      render text: health_check.error_messages, status: :service_unavailable
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match "/health" => "health_rails/health#index"
+end

data/health_rails.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "health_rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "health_rails"
+  s.version     = HealthRails::VERSION
+  s.authors     = ["Daniel Spangenberg"]
+  s.email       = ["daniel.spangenberg@parcydo.com"]
+  s.homepage    = "http://github.com/parcydo/health_rails"
+  s.summary     = %q{Health rails provides your rails app a simple password protected health status page for other web services.}
+  s.description = %q{Health rails gives you some default checks and a DSL for defining your own checks.}
+
+  s.add_development_dependency "rails"
+  s.add_development_dependency "rspec"
+
+  s.rubyforge_project = "health_rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/health_rails.rb

@@ -0,0 +1,5 @@
+require 'health_rails/engine'
+
+module HealthRails
+  autoload :HealthCheck, 'health_rails/health_check'
+end

data/lib/health_rails/engine.rb

@@ -0,0 +1,7 @@
+require 'health_rails'
+require 'rails'
+
+module HealthRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/health_rails/health_check.rb

@@ -0,0 +1,51 @@
+module HealthRails
+  class HealthCheck
+    class HealthCheckFailure < Exception
+    end
+
+    def all_ok?
+      process_checks
+      !errors.any?
+    end
+
+    def error_messages
+      errors.join("\n")
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def process_check(description)
+      begin
+        HealthCheck.check(description).call
+      rescue HealthCheckFailure => error_message
+        errors << "#{description}: #{error_message}"
+      end
+    end
+
+    def process_checks
+      HealthCheck.checks.each do |description, proc|
+        process_check(description)
+      end
+    end
+
+    class << self
+
+      def check(description, &block)
+        if block.nil?
+          checks[description]
+        else
+          checks[description] = block
+        end
+      end
+
+      def checks
+        @@checks ||= {}
+      end
+    end
+  end
+end
+
+# Load all health checks
+Dir["#{File.dirname(__FILE__)}/health_checks/**/*.rb"].each { |f| require f }

data/lib/health_rails/health_checks/active_record_health_check.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+module HealthRails
+  class HealthCheck
+    check "ActiveRecord connection" do
+      active_record_connection = ActiveRecord::Base.connection
+      unless active_record_connection.active?
+        raise HealthCheckFailure, "#{active_record_connection.adapter_name} connection is gone from us!"
+      end
+    end
+  end
+end

data/lib/health_rails/version.rb

@@ -0,0 +1,3 @@
+module HealthRails
+  VERSION = "0.0.1"
+end

data/spec/health_check_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module HealthRails
+  describe HealthCheck do
+    let(:health_check) { HealthRails::HealthCheck.new }
+
+    before(:each) do
+      HealthRails::HealthCheck.stub(:checks).and_return({})
+    end
+
+    describe "run all checks and return status" do
+      it "fails" do
+        HealthRails::HealthCheck.check("Failing") do
+          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+        end
+        HealthRails::HealthCheck.check("Passing") do
+          nil
+        end
+        health_check.all_ok?.should be(false)
+      end
+
+      it "passes" do
+        HealthRails::HealthCheck.check("Passing 1") do
+          nil
+        end
+        HealthRails::HealthCheck.check("Passing 2") do
+          nil
+        end
+        health_check.all_ok?.should be(true)
+      end
+    end
+
+    it "push check in checks hash" do
+      block = lambda {}
+      HealthRails::HealthCheck.check("Foo Bar", &block)
+      HealthRails::HealthCheck.checks.size.should be(1)
+      HealthRails::HealthCheck.check("Foo Bar").should be(block)
+    end
+
+    it "join error messages" do
+      health_check.stub(:errors).and_return(["Foo", "Bar", "Baz"])
+      health_check.error_messages.should eql("Foo\nBar\nBaz")
+    end
+
+    describe "process check" do
+      it "pushes error on exception" do
+        HealthRails::HealthCheck.check("Foo Bar") do
+          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+        end
+        health_check.process_check("Foo Bar")
+        health_check.errors.size.should be(1)
+        health_check.errors.first.should eql("Foo Bar: Exception")
+      end
+    end
+
+    describe "process checks" do
+      it "run process check on each" do
+        HealthRails::HealthCheck.check("Foo") do
+          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+        end
+        HealthRails::HealthCheck.check("Bar") do
+          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+        end
+        HealthRails::HealthCheck.check("Baz") do
+          nil
+        end
+        health_check.process_checks
+        health_check.errors.size.should be(2)
+        health_check.errors.first.should eql("Foo: Exception")
+        health_check.errors.last.should eql("Bar: Exception")
+      end
+    end
+
+  end
+end

data/spec/health_checks/active_record_health_check_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'active_record'
+
+describe "active record health check" do
+  let(:health_check) { HealthRails::HealthCheck.new }
+
+  it "raise exception if connection is not active" do
+    foo_bar_adapter = mock("ActiveRecord::ConnectionAdapters::FooBarAdapter", active?: false, adapter_name: "FooBar")
+    ActiveRecord::Base.stub(:connection).and_return(foo_bar_adapter)
+    health_check.process_check("ActiveRecord connection")
+    health_check.errors.size.should be(1)
+    health_check.errors.first.should eql("ActiveRecord connection: FooBar connection is gone from us!")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'health_rails'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: health_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Spangenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-27 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2164618080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164618080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164617500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164617500
+description: Health rails gives you some default checks and a DSL for defining your
+  own checks.
+email:
+- daniel.spangenberg@parcydo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Rakefile
+- app/controllers/health_rails/health_controller.rb
+- config/routes.rb
+- health_rails.gemspec
+- lib/health_rails.rb
+- lib/health_rails/engine.rb
+- lib/health_rails/health_check.rb
+- lib/health_rails/health_checks/active_record_health_check.rb
+- lib/health_rails/version.rb
+- spec/health_check_spec.rb
+- spec/health_checks/active_record_health_check_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/parcydo/health_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1905505185732161742
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1905505185732161742
+requirements: []
+rubyforge_project: health_rails
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Health rails provides your rails app a simple password protected health status
+  page for other web services.
+test_files:
+- spec/health_check_spec.rb
+- spec/health_checks/active_record_health_check_spec.rb
+- spec/spec_helper.rb