pingable 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+/.rspec
+/Gemfile.lock
+*.gem
+.bundle
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+Pinger
+======
+
+Pinger is a simple framework to implement a 'ping' URL in Rack-based web applications.
+
+For example, a Rails or Sinatra app's `config.ru` may look like this:
+
+    map '/ping' do
+      use Pingable::Handler
+    end
+    run MyApp
+
+Now you can add checks in a modular fashion:
+
+    Pingable.add_check lambda {
+      unless check_something
+        "Oh noes, something failed"
+      end
+    }
+
+Something a bit more complex:
+
+    class TwitterCheck
+      def initialize(url)
+        @url = url
+      end
+
+      def call
+        # ... check the URL ...
+      end
+    end
+
+    Pingable.add_check TwitterCheck.new(:url => "http://twitter.com/")
+
+A check is simply an object which:
+
+* implements `call` with no arguments.
+* returns one of the following on error:
+  * a string
+  * a hash of {:message => message}
+  * an array of the above
+* returns nil on success.
+
+Common checks
+-------------
+
+Pingable comes with a set of checks that are commonly needed for web applications. To install these, add the following:
+
+    Pingable.common_checks!
+
+These include:
+
+* A check to verify ActiveRecord's current connection.
+* A check to check the ability for Rails' cache to read and write values.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/config.ru

@@ -0,0 +1,14 @@
+require 'pingable'
+require 'active_record'
+
+Pingable.common_checks!
+Pingable.add_check lambda {
+  {:message => "oh noes"}
+}
+
+map '/ping' do
+  use Pingable::Handler
+end
+run lambda { |env|
+  [200, {'Content-Type' => 'text/plain'}, ['OK']]
+}

data/lib/pingable/common_checks.rb

@@ -0,0 +1,51 @@
+module Pingable
+
+  class << self
+    @@common_checks_added ||= false
+
+    # Add checks for standard gems such as Active Record.
+    def common_checks!
+      unless @@common_checks_added
+        add_active_record!
+        add_rails_cache!
+        @@common_checks_added = true
+      end
+    end
+
+    private
+
+      def add_active_record!
+        if defined?(ActiveRecord)
+          add_check lambda {
+            begin
+              ActiveRecord::Base.verify_active_connections!
+              ActiveRecord::Base.connection.execute('select 1')
+              nil
+            rescue Exception => e
+              if e.class.name == e.message
+                "ActiveRecord: #{e}"
+              else
+                "ActiveRecord: #{e.class}: #{e.message}"
+              end
+            end
+          }
+        end
+      end
+
+      def add_rails_cache!
+        if defined?(Rails) and Rails.respond_to?(:cache)
+          add_check lambda {
+            begin
+              Rails.cache.read('ping_check')
+              Rails.cache.write('ping_check', 'ok')
+              nil
+            rescue Exception => e
+              "Rails cache: #{e.class}: #{e.message}"
+            end
+          }
+        end
+      end
+
+  end
+
+end

data/lib/pingable/core.rb

@@ -0,0 +1,34 @@
+module Pingable
+  class << self
+
+    @@checks ||= []
+
+    def add_check(check)
+      @@checks << check
+    end
+
+    def run_checks!
+      failures = []
+      @@checks.each do |check|
+        begin
+          result = check.call
+        rescue Exception => e
+          failures.push(:message => "Pinger check failed: #{e}")
+        else
+          if result
+            case result
+              when Array
+                failures.concat result
+              when String
+                failures.push(:message => result)
+              else
+                failures.push(result)
+            end
+          end
+        end
+      end
+      failures
+    end
+
+  end
+end

data/lib/pingable/handler.rb

@@ -0,0 +1,26 @@
+module Pingable
+
+  class Handler
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      failures = Pingable.run_checks!
+      if failures.any?
+        [500, HEADERS, failures.map { |f| f[:message] }.join("\n")]
+      else
+        app_name = env['pingable.name']
+        app_name ||= ''
+        [200, HEADERS, app_name]
+      end
+    end
+
+    private
+
+      HEADERS = {'Cache-Control' => 'private'}
+
+  end
+
+end

data/lib/pingable/version.rb

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

data/lib/pingable.rb

@@ -0,0 +1,4 @@
+require "pingable/core"
+require "pingable/version"
+require "pingable/handler"
+require "pingable/common_checks"

data/pingable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "pingable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pingable"
+  s.version     = Pingable::VERSION
+  s.authors     = ["Alexander Staubo"]
+  s.email       = ["alex@origo.no"]
+  s.homepage    = "http://github.com/origo/pingable"
+  s.summary     = s.description = %q{Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks}
+
+  s.rubyforge_project = "pingable"
+
+  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"]
+
+  s.add_development_dependency "rspec"
+  
+  s.add_runtime_dependency "rack", '>= 1.0.0'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: pingable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Staubo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks
+email: 
+- alex@origo.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- example/config.ru
+- lib/pingable.rb
+- lib/pingable/common_checks.rb
+- lib/pingable/core.rb
+- lib/pingable/handler.rb
+- lib/pingable/version.rb
+- pingable.gemspec
+homepage: http://github.com/origo/pingable
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: pingable
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks
+test_files: []
+