stethoscope 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in stethoscope.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    stethoscope (0.0.1)
+      dictionary (>= 1.0)
+      rack (> 1.0)
+      tilt (>= 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    dictionary (1.0.0)
+    nanotest (0.9.4.1)
+    nanotest_extensions (0.6.3)
+    rack (1.2.1)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec-core (2.0.0.beta.20)
+    tilt (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  dictionary (>= 1.0)
+  nanotest
+  nanotest_extensions
+  rack (> 1.0)
+  rack-test
+  rake
+  rspec-core (>= 2.0.0.beta.20)
+  stethoscope!
+  tilt (>= 1.0)

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 NZX
+
+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,73 @@
+# Stethoscope
+
+Stethoscope is Rack Middelware that provides heartbeats for your application.  Heartbeats are used to check that your application is functioning correctly.
+
+Typically, a tool like Nagios will monitor a heartbeat URL which will return a 200 OK status if everything is ok, or a 500 response for any issues.
+
+## Usage
+
+### Rack
+
+    use Stethoscope
+    run MyApp
+
+### Rails 2
+
+    # config/environment.rb
+    config.middleware.use Stethoscope
+
+### Rails 3
+
+Just require Stethoscope in your application. Stethoscope has a Railtie that will configure Stethoscope to work
+
+## Customizing Stethoscope
+
+### Heartbeat URL
+
+Default: `/heartbeat`
+
+    Stethoscope.url = "/some/custom/path"
+
+### Checks
+
+Stethoscope uses _checks_ to check some component of the application.  A check is simply a block that is executed when the heartbeat url is hit.
+
+A response hash is made available to store any information which is then made available to the heartbeat template.
+
+Returning a response _:status_ outside 200..299 will trigger Stethoscope to return a 500 status code to the client.
+
+#### Example
+
+    Stethoscope.check :database do |response|
+      ActiveRecord::Base.connection.execute('select 1')
+    end
+
+    Stethoscope.check :some_service do |response|
+      start   = Time.now
+      response['result']    = SomeSerivce.check_availability!
+      response['Ping Time'] = Time.now - start
+      response[:status]     = 245 # Any status outside 200..299 will result in a 500 status being returned from the heartbeat
+    end
+
+Any exceptions are caught and added to the response with the _:error_ key.  The template can then handle them appropriately
+
+#### Defaults
+
+* ActiveRecord
+  * Check name - :database
+  * require 'stethoscope/checks/active\_record'
+  * Included if the ActiveRecord constant is present in Rails 3
+* DataMapper
+  * Check name - :database
+  * require 'stethoscope/checks/data\_mapper'
+  * Included if the DataMapper constant is present in Rails 3
+
+### Template
+
+Stethoscope uses [Tilt](http://github.com/rtomayko/tilt) to render a template for the heartbeat response
+
+By default, Stethoscope provides a simple template to render the responses of the checks in the _lib/stethoscope/template.erb_ file.
+
+You can overwrite the template used:
+
+    Stethoscope.template = Tilt.new("my_new_tempalte_file.haml")

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Run all tests'
+task :test do
+  test_path = File.join(File.expand_path(File.dirname(__FILE__)), "test")
+  $:.unshift test_path
+  require 'test_helper'
+
+  require 'test_stethoscope'
+end

data/lib/stethoscope/checks/active_record.rb

@@ -0,0 +1,7 @@
+require 'stethoscope'
+
+# Provides a check for active record databases
+Stethoscope.check :database do |response|
+  ActiveRecord::Base.connection.execute("SELECT 1")
+  response["ActiveRecord"] = "OK"
+end

data/lib/stethoscope/checks/data_mapper.rb

@@ -0,0 +1,8 @@
+require 'stethoscope'
+
+# Provides a check for datamapper databases
+Stethoscope.check :database do |response|
+  DataMapper.repository.adapter.execute("select 1")
+  response['Datamapper'] = "OK"
+end
+

data/lib/stethoscope/rails.rb

@@ -0,0 +1,13 @@
+if defined?(Rails::Railtie)
+  # Adds the heartbeat to the stack
+  class Stethoscope
+    class Railtie < Rails::Railtie
+      initializer 'stethoscope.middleare' do |app|
+        app.middleware.use Stethoscope
+
+        require 'stethoscope/checks/active_record'  if defined? ( ActiveRecord )
+        require 'stethoscope/checks/data_mapper'    if defined? ( DataMapper   )
+      end
+    end
+  end
+end

data/lib/stethoscope/template.erb

@@ -0,0 +1,39 @@
+<!Doctype html>
+<html>
+  <head>
+    <title>Heartbeat</title>
+  </head>
+  <body>
+    <h1>Heartbeat (Ba-Boomp)</h1>
+    <div class='results'>
+      <% if checks.empty? %>
+        <p class='error'>No Checks Enabled</p>
+      <% else %>
+        <ul class='checks'>
+        <% checks.each do |name, hash| %>
+          <li>
+            <strong><%= name %>:<strong>
+            <ul>
+              <% hash.each do |item, value| %>
+                <li>
+                  <% if item.to_s == 'error' %>
+                    <h4><%= item.class %></h4>
+                    <p class='error-message'><%= value.message %></p>
+                    <ul class='stack-trace'>
+                      <% value.backtrace.each do |line| %>
+                        <li><%= line %></li>
+                      <% end %>
+                  <% else %>
+                    <strong><%= item %>:</strong> <%= value %>
+                  <% end %>
+                </li>
+              <% end %>
+            </ul>
+          </li>
+        <% end %>
+      <% end %>
+    </div>
+  </body>
+</html>
+
+

data/lib/stethoscope/version.rb

@@ -0,0 +1,3 @@
+class Stethoscope
+  VERSION = "0.1.0"
+end

data/lib/stethoscope.rb

@@ -0,0 +1,137 @@
+require 'dictionary'
+require 'tilt'
+require 'stethoscope/rails'
+
+# Stethoscope is Rack middleware that provides a heartbeat function to an application.
+#
+# Stethoscope provides a mechanism to add checks to the application, and will render a template
+# in response to a request
+#
+# @example
+#   Rack::Builder.new do
+#     use Stethoscope
+#     run MyApp.new
+#   end
+#
+# @see Rack
+class Stethoscope
+  # Set the url to check for the heartbeat in this application
+  #
+  # @example
+  #   Stethoscope.url = "/my/heartbeat/location"
+  #
+  #   GET "/my/heartbeat/location" <-- intercepted by stethoscope
+  #
+  # @see Stethoscope.url
+  # @api public
+  def self.url=(url)
+    @url = url
+  end
+
+  # The current url that Stethoscope is setup to listen for
+  # @see Stethoscope.url=
+  # @api public
+  def self.url
+    @url ||= "/heartbeat"
+  end
+
+  # The collection of checks currently in place in Stethoscope
+  # @see Stethoscope.check
+  # @api public
+  def self.checks
+    @checks ||= Dictionary.new
+  end
+
+  # Add a check to Stethoscope
+  #
+  # A check is a block that checks the health of some aspect of your application
+  # You add information to the response of the check, including a status (if not successful)
+  #
+  # Any resonse that has a status outside 200..299 will cause the heartbeat to fail
+  #
+  # @example
+  #   Stethoscope.check("My Database") do |response|
+  #     if my_db_check
+  #       response[:result] = "Success"
+  #     else
+  #       response[:result] = "Bad Bad Bad"
+  #       response[:arbitrary] = "something else"
+  #       response[:status] = 500 # <---- VERY IMPORTANT
+  #     end
+  #   end
+  #
+  # @see Stethoscope.check
+  # @api public
+  def self.check(name, &blk)
+    checks[name] = blk
+  end
+
+  # Removes a give check
+  # @example
+  #   Stethoscope.remove_check("my check to remove")
+  #
+  # @see Stethoscope.check
+  # @api public
+  def self.remove_check(name)
+    checks.delete(name)
+  end
+
+  # Clears all defined checks
+  # @see Stethoscope.check
+  # @api public
+  def self.clear_checks
+    checks.clear
+  end
+
+  # Sets the Tilt template that will be used for heartbeat rendering
+  #
+  # @param template - A Tilt template object
+  #
+  # @see Stethoscope.template
+  # @see Tilt
+  # @api public
+  def self.template=(template)
+    @template = template
+  end
+
+  # Getter for the Tilt template for heartbeat rendering
+  # By default, the Stethoscope default template is used.  Overwrite this to use a custom template
+  #
+  # @see Stethoscope.template=
+  # @see Tilt
+  #
+  # @api public
+  def self.template
+    @template ||= Tilt.new(File.join(File.dirname(__FILE__), "stethoscope", "template.erb"))
+  end
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    if request.path == Stethoscope.url
+      responses  = Dictionary.new do |d,k|
+        dict = Dictionary.new
+        dict[:status] = 200
+        d[k] = dict
+      end
+
+      Stethoscope.checks.each do |name, check|
+        begin
+          check.call(responses[name])
+        rescue => e
+          responses[name][:error]  = e
+          responses[name][:status] = 500
+        end
+      end
+
+      status = responses.any?{ |k,v| v[:status] && !((200..299).include?(v[:status])) } ? 500 : 200
+      result = Stethoscope.template.render(Object.new, :checks => responses)
+
+      Rack::Response.new(result, status).finish
+    else
+      @app.call(env)
+    end
+  end
+end

data/stethoscope.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/stethoscope/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "stethoscope"
+  s.version     = Stethoscope::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Daniel Neighman']
+  s.email       = ['has.sox@gmail.com']
+  s.homepage    = "http://rubygems.org/gems/stethoscope"
+  s.summary     = "Heartbeat middleware for responding to heartbeat pings"
+  s.description = "Heartbeat middleware for responding to heartbeat pings"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "stethoscope"
+
+  s.add_dependency              "rack",        ">  1.0"
+  s.add_dependency              "dictionary",  ">= 1.0"
+  s.add_dependency              "tilt",        ">= 1.0"
+
+  s.add_development_dependency  "bundler",     ">= 1.0.0"
+  s.add_development_dependency  "rspec-core",  ">= 2.0.0.beta.20"
+  s.add_development_dependency  "nanotest"
+  s.add_development_dependency  "nanotest_extensions"
+  s.add_development_dependency  "rake"
+  s.add_development_dependency  "rack-test"
+
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+require 'nanotest'
+require 'nanotest/contexts'
+require 'nanotest/stats'
+require 'rack/test'
+
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+require 'stethoscope'
+
+APP = lambda{ |e| Rack::Response.new("default").finish }
+
+module StethoscopeTestHelpers
+  def setup_app(&blk)
+    @app = begin
+      Rack::Builder.new do
+        if blk
+          instance_eval &blk
+        else
+          use Stethoscope
+        end
+        run APP
+      end
+    end
+  end
+
+  def app
+    @app
+  end
+end

data/test/test_stethoscope.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+class TestStethoscope
+  extend  Nanotest
+  extend  Nanotest::Contexts
+  extend StethoscopeTestHelpers
+  extend Rack::Test::Methods
+
+  context do
+    setup    { setup_app }
+    teardown do
+      Stethoscope.url = "/heartbeat"
+      Stethoscope.clear_checks
+    end
+
+
+    # When accessing normal url's should not intercept anything
+    test do
+      response = get "/"
+      assert { response.status == 200     }
+      assert { response.body.to_s == "default" }
+    end
+
+    # When accessing the Stethoscope.url should intercept the call
+    test do
+      response = get "/heartbeat"
+      assert { response.status == 200 }
+      assert { response.body.to_s =~ /Ba-Boomp/ }
+    end
+
+    # With a different url
+    test do
+      Stethoscope.url = "/something_else"
+      response = get "/heartbeat"
+      assert {response.body.to_s =~ /default/  }
+      response = get "/something_else"
+      assert {response.body.to_s =~ /Ba-Boomp/ }
+    end
+
+    # Check checks
+    context do
+      setup    { $captures = []  }
+      teardown { $captures.clear }
+      # Check that checks run
+      test do
+        Stethoscope.check(:foo){ |response| response[:status] = 200;$captures << :foo; }
+        Stethoscope.check(:bar){ |response| response[:status] = 200;$captures << :bar; }
+
+        response = get "/heartbeat"
+        assert { response.status == 200    }
+        assert { $captures == [:foo, :bar] }
+      end
+
+      # Check, and fail the run
+      test do
+        Stethoscope.check(:foo){ |response| $captures << :foo; }
+        Stethoscope.check(:bar){ |response| response[:status] = 500;$captures << :bar; }
+
+        response = get "/heartbeat"
+        assert { response.status == 500 }
+      end
+
+      # should render the reason
+      test do
+        Stethoscope.check(:something) do |resp|
+          resp[:status] = 423
+          resp[:reason] = "Something went wrong capt'n"
+        end
+
+        response = get "/heartbeat"
+        assert { response.status == 500 }
+        assert { response.body.to_s =~ /Something went wrong capt'n/m }
+      end
+
+      # should handle tests being nilled
+      test do
+        Stethoscope.check('foo'){}
+        assert { Proc === Stethoscope.checks['foo'] }
+        Stethoscope.remove_check('foo')
+        assert { !Stethoscope.checks.key?('foo') }
+      end
+
+      # should give a 500 status if there is an exception
+      test do
+        Stethoscope.check('foo'){ |resp| raise "Oh Noes" }
+
+        response = get "/heartbeat"
+        assert { response.status == 500 }
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification 
+name: stethoscope
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-07 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dictionary
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: nanotest
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nanotest_extensions
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Heartbeat middleware for responding to heartbeat pings
+email: 
+- has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/stethoscope.rb
+- lib/stethoscope/checks/active_record.rb
+- lib/stethoscope/checks/data_mapper.rb
+- lib/stethoscope/rails.rb
+- lib/stethoscope/template.erb
+- lib/stethoscope/version.rb
+- stethoscope.gemspec
+- test/test_helper.rb
+- test/test_stethoscope.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/stethoscope
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: stethoscope
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Heartbeat middleware for responding to heartbeat pings
+test_files: []
+