health_rails 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/README.textile

@@ -0,0 +1 @@
+h1. HealthRails "!https://secure.travis-ci.org/parcydo/health_rails.png?branch=master!":http://travis-ci.org/parcydo/health_rails

data/Rakefile

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

data/app/controllers/health_rails/health_controller.rb

@@ -1,4 +1,6 @@
 class HealthRails::HealthController < ApplicationController
+  before_filter :login_required
+
   # GET /health
   def index
     health_check = HealthRails::HealthCheck.new
@@ -8,4 +10,13 @@ class HealthRails::HealthController < ApplicationController
       render text: health_check.error_messages, status: :service_unavailable
     end
   end
+
+  private
+    def login_required
+      if HealthRails.authentication
+        authenticate_or_request_with_http_basic("#{Rails.application.class.parent_name}'s health is important to us!") do |username, password|
+          HealthRails.authentication.has_key?(username) && HealthRails.authentication[username] == password
+        end
+      end
+    end
 end

data/lib/generators/health_rails/install_generator.rb

@@ -0,0 +1,15 @@
+require 'securerandom'
+
+module HealthRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a HealthRails initializer."
+
+      def copy_initializer
+        template "health_rails.rb", "config/initializers/health_rails.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/health_rails.rb

@@ -0,0 +1,24 @@
+# Use this hook to configure health rails.
+HealthRails.setup do |config|
+  # Configure who can access your health check url.
+  # You can configure as much users as you want,
+  # or pass another backend for authentification.
+  # If you don't want to have authentification,
+  # remove the next line. This is not recommended!
+  config.authentication = { "admin" => <%= SecureRandom.hex(16).inspect %> }
+
+  # Configure which health checks should be processed.
+  config.health_checks = [ 'ActiveRecord connection' ]
+
+  # Custom checks
+  #
+  # check "Fail" do
+  #   raise HealthCheckFailure, "It failed!"
+  # end
+  #
+  # check "Pass" do
+  #   if false
+  #     raise HealthCheckFailure, "It failed, OMG!"
+  #   end
+  # end
+end

data/lib/health_rails.rb

@@ -1,5 +1,19 @@
-require 'health_rails/engine'
+require 'health_rails/dsl'
+require 'health_rails/health_check'
+require 'health_rails/rails'
 
 module HealthRails
-  autoload :HealthCheck, 'health_rails/health_check'
+  # Users which have access to the health check url.
+  mattr_accessor :authentication
+  @@authentication = false
+
+  # Health checks which will be processed.
+  mattr_accessor :health_checks
+  @@health_checks = []
+
+  # Default way to setup HealthRails. Run rails generate health_rails:install to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
 end

data/lib/health_rails/dsl.rb

@@ -0,0 +1,12 @@
+module HealthRails
+  module DSL
+    class HealthCheckFailure < Exception
+    end
+
+    def check(description, auto_activated=true, &health_check_block)
+      HealthRails::HealthCheck.check(description, auto_activated, &health_check_block)
+    end
+  end
+end
+
+include HealthRails::DSL

data/lib/health_rails/health_check.rb

@@ -1,13 +1,18 @@
 module HealthRails
   class HealthCheck
-    class HealthCheckFailure < Exception
-    end
-
     def all_ok?
       process_checks
       !errors.any?
     end
 
+    def check(description)
+      checks[description]
+    end
+
+    def checks
+      HealthCheck.checks
+    end
+
     def error_messages
       errors.join("\n")
     end
@@ -18,26 +23,26 @@ module HealthRails
 
     def process_check(description)
       begin
-        HealthCheck.check(description).call
+        check(description).call
       rescue HealthCheckFailure => error_message
         errors << "#{description}: #{error_message}"
       end
     end
 
     def process_checks
-      HealthCheck.checks.each do |description, proc|
+      checks.each do |description, proc|
+        next unless HealthRails.health_checks.include?(description)
         process_check(description)
       end
     end
 
     class << self
 
-      def check(description, &block)
-        if block.nil?
-          checks[description]
-        else
-          checks[description] = block
+      def check(description, auto_activated, &block)
+        if auto_activated && !HealthRails.health_checks.include?(description)
+          HealthRails.health_checks << description
         end
+        checks[description] = block
       end
 
       def checks

data/lib/health_rails/health_checks/active_record_health_check.rb

@@ -1,12 +1,8 @@
 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
+check "ActiveRecord connection", false 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

data/lib/health_rails/{engine.rb → rails.rb}

@@ -1,4 +1,3 @@
-require 'health_rails'
 require 'rails'
 
 module HealthRails

data/lib/health_rails/version.rb

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

data/spec/health_check_spec.rb

@@ -6,35 +6,51 @@ module HealthRails
 
     before(:each) do
       HealthRails::HealthCheck.stub(:checks).and_return({})
+      HealthRails.stub(:health_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"
+        check "Failing" do
+          raise HealthCheckFailure, "Exception"
         end
-        HealthRails::HealthCheck.check("Passing") do
+        check "Passing" do
           nil
         end
         health_check.all_ok?.should be(false)
       end
 
       it "passes" do
-        HealthRails::HealthCheck.check("Passing 1") do
+        check "Passing 1" do
           nil
         end
-        HealthRails::HealthCheck.check("Passing 2") do
+        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)
+    describe "check" do
+      it "push check in checks hash" do
+        block = lambda {}
+        check("Foo Bar", &block)
+        health_check.checks.size.should be(1)
+        health_check.check("Foo Bar").should be(block)
+      end
+
+      it "push check in health_checks config if auto activated" do
+        check "Foo" do
+          nil
+        end
+        check "Bar", false do
+          nil
+        end
+        check "Baz" do
+          nil
+        end
+        HealthRails.health_checks.should eql(["Foo", "Baz"])
+      end
     end
 
     it "join error messages" do
@@ -44,8 +60,8 @@ module HealthRails
 
     describe "process check" do
       it "pushes error on exception" do
-        HealthRails::HealthCheck.check("Foo Bar") do
-          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+      check "Foo Bar" do
+          raise HealthCheckFailure, "Exception"
         end
         health_check.process_check("Foo Bar")
         health_check.errors.size.should be(1)
@@ -54,14 +70,14 @@ module HealthRails
     end
 
     describe "process checks" do
-      it "run process check on each" do
-        HealthRails::HealthCheck.check("Foo") do
-          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+      it "run process check on each check" do
+        check "Foo" do
+          raise HealthCheckFailure, "Exception"
         end
-        HealthRails::HealthCheck.check("Bar") do
-          raise HealthRails::HealthCheck::HealthCheckFailure, "Exception"
+        check "Bar" do
+          raise HealthCheckFailure, "Exception"
         end
-        HealthRails::HealthCheck.check("Baz") do
+        check "Baz" do
           nil
         end
         health_check.process_checks
@@ -69,6 +85,21 @@ module HealthRails
         health_check.errors.first.should eql("Foo: Exception")
         health_check.errors.last.should eql("Bar: Exception")
       end
+
+      it "run only checks which are in the health_checks config" do
+        check "Foo", false do
+          raise HealthCheckFailure, "Exception"
+        end
+        check "Bar" do
+          raise HealthCheckFailure, "Exception"
+        end
+        check "Baz" do
+          nil
+        end
+        health_check.process_checks
+        health_check.errors.size.should be(1)
+        health_check.errors.last.should eql("Bar: Exception")        
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00.000000000 +02:00
+date: 2011-07-28 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2164618080 !ruby/object:Gem::Requirement
+  requirement: &2169069860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164618080
+  version_requirements: *2169069860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164617500 !ruby/object:Gem::Requirement
+  requirement: &2169069200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164617500
+  version_requirements: *2169069200
 description: Health rails gives you some default checks and a DSL for defining your
   own checks.
 email:
@@ -45,15 +45,20 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
+- README.textile
 - Rakefile
 - app/controllers/health_rails/health_controller.rb
 - config/routes.rb
 - health_rails.gemspec
+- lib/generators/health_rails/install_generator.rb
+- lib/generators/templates/health_rails.rb
 - lib/health_rails.rb
-- lib/health_rails/engine.rb
+- lib/health_rails/dsl.rb
 - lib/health_rails/health_check.rb
 - lib/health_rails/health_checks/active_record_health_check.rb
+- lib/health_rails/rails.rb
 - lib/health_rails/version.rb
 - spec/health_check_spec.rb
 - spec/health_checks/active_record_health_check_spec.rb
@@ -73,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1905505185732161742
+      hash: -2292776394260562768
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1905505185732161742
+      hash: -2292776394260562768
 requirements: []
 rubyforge_project: health_rails
 rubygems_version: 1.6.2