rack-ping 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/README.md

@@ -0,0 +1,62 @@
+# Rack::Ping
+A Rack middleware that should indicate the health of your service.
+
+
+## Usage
+Here is a simple example (see `examples`)
+
+    map '/ping' do
+      use Rack::Ping do |ping|
+        ping.check_url  "http://localhost:9292/"
+        ping.ok_regex /goodbye/
+      end
+    end
+
+    run lambda{|env| [200, {'Content-Type' => 'text/html'}, ["hello"]]}
+
+## Options
+
+When building/mounting your rack, use the `ping` configuration variable,
+specify:
+
+* `version` is an accessor for your application version. `App::VERSION`
+  would be a good idea.
+* `check_url` is a url that `ping` will fetch and run `ok_regex` on. If
+  the match is ok, we're good. You must specify `check_url` and
+`ok_regex` togather. `timeout_secs` is the amount of seconds we wait
+until spitting out an error.
+* `check` will accept a block to run. This is a good alternative to
+  `check_url`: run a couple of sanity checks to indicate you're good.
+* `ok_code`, `error_code`, `ok_text`, `error_text` are configuration for
+  you to use, to configure against LB quirks. The default config should
+work against ELBs (Amazon elastic LB).
+
+## Headers
+
+`ping` will output intelligent headers. First `x-ping-error` will try to
+explain why ping failed.  
+
+Next, `x-app-version` will expose the current deployed version of your
+app. This is good in order to validate nothing crawled up to production,
+as well as validation for post-production deployment.  
+
+`ping` will bust any browser/client cache for you.
+
+
+## Contributing
+
+Guard is set up for your ease of development. Here's how to go from 0 to
+ready.
+
+    $ git clone https://github.com/jondot/rack-ping
+    $ cd rack-ping
+    $ bundle install
+    $ guard
+
+Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
+
+
+## Copyright
+
+Copyright (c) 2011 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See MIT-LICENSE for further details.
+

data/Rakefile

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

data/examples/config.ru

@@ -0,0 +1,10 @@
+require 'rack/ping'
+
+map '/ping' do
+  use Rack::Ping do |ping|
+    ping.check_url  "http://localhost:9292/"
+    ping.ok_regex /goodbye/
+  end
+end
+
+run lambda{|env| [200, {'Content-Type' => 'text/html'}, ["hello"]]}

data/lib/rack/ping.rb

@@ -0,0 +1,80 @@
+require 'open-uri'
+
+module Rack
+  class Ping
+    attr_reader :config
+
+    def initialize(app)
+      @config = {
+        :version => '0',
+        :check_url => nil,
+        :ok_regex => nil,
+        :ok_text => 'ok',
+        :ok_code => 200,
+        :timeout_secs => 5,
+        :error_text => 'error',
+        :error_code => 500
+      }
+
+      yield self if block_given?
+    end
+
+    %w[version check_url ok_regex ok_text ok_code timeout_secs error_text error_code].each do |meth|
+      define_method(meth) { |value| @config[meth.to_sym] = value }
+    end
+
+    def check(&block)
+      @check_block = block
+    end
+
+    def call(env)
+      if @check_block
+        begin
+          return @check_block.call() ? ok : error("logic")
+        rescue
+          return error("logic: #{$!}")
+        end
+      end
+
+      if @config[:ok_regex] && @config[:check_url]
+        begin
+          timeout(@config[:timeout_secs]) do
+            text = open(@config[:check_url]).read
+            return error("regex") unless text =~ @config[:ok_regex]
+          end
+          rescue Timeout::Error
+            return error("timeout")
+          rescue
+            return error("url: #{$!}")
+        end
+      end
+
+      return ok
+    end
+
+    def error(reason)
+      [   @config[:error_code],
+          NO_CACHE.merge({
+            'Content-Type' => 'text/html',
+            'x-app-version' => @config[:version],
+            'x-ping-error'  => reason
+          }),
+          [@config[:error_text]]   ]
+    end
+
+    def ok
+      [   @config[:ok_code],
+          NO_CACHE.merge({
+            'Content-Type' => 'text/html',
+            'x-app-version' => @config[:version]
+          }),
+          [@config[:ok_text]]   ]
+    end
+    private
+    NO_CACHE = {
+      "Cache-Control" => "no-cache, no-store, max-age=0, must-revalidate",
+      "Pragma" => "no-cache",
+      "Expires" => "Tue, 8 Sep 1981 08:42:00 UTC"
+    }
+  end
+end

data/lib/rack/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Ping
+    VERSION = "0.0.1"
+  end
+end

data/rack-ping.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-ping"
+  s.version     = Rack::Ping::VERSION
+  s.authors     = ["Dotan Nahum"]
+  s.email       = ["jondotan@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Health checking Rack middleware}
+  s.description = %q{Health checking Rack middleware}
+
+  s.rubyforge_project = "rack-ping"
+
+  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 'guard-minitest'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'webmock'
+end

data/spec/rack/ping_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'rack/ping'
+
+
+def app
+  lambda{|env| [200, {'Content-Type' => 'text/html'}, ["hello"]]}
+end
+
+def must_bust_cache(h)
+  h["Cache-Control"].must_equal "no-cache, no-store, max-age=0, must-revalidate"
+  h["Pragma"].must_equal "no-cache"
+  h["Expires"].must_equal "Tue, 8 Sep 1981 08:42:00 UTC"
+end
+
+describe Rack::Ping do
+  it "should bust cache" do
+    s, h, b = Rack::Ping.new(app).call({})
+    must_bust_cache(h)
+  end
+
+  it "should have sane defaults" do
+    # when ok
+    s, h, b = Rack::Ping.new(app).call({})
+ 
+    s.must_equal 200
+    h['x-app-version'].must_equal '0'
+    b[0].must_equal 'ok'
+    must_bust_cache(h)
+
+    # when error
+    s, h, b = Rack::Ping.new(app) do |ping| 
+      ping.check { false } 
+    end.call({})
+
+    s.must_equal 500
+    b[0].must_equal 'error'
+    must_bust_cache(h)
+  end
+
+  module MyApp
+    VERSION = '1.0.0'
+  end
+
+  it "should pick up application version" do
+    s, h, b = Rack::Ping.new(app) do |ping| 
+      ping.version MyApp::VERSION
+    end.call({})
+    h['x-app-version'].must_equal '1.0.0'
+  end
+
+
+  it "should run check code when available" do
+    s, h, b = Rack::Ping.new(app) do |ping|
+      ping.check do
+        false
+      end
+    end.call({})
+
+    s.must_equal 500
+    b[0].must_equal 'error'
+    h['x-ping-error'].must_equal "logic"
+    must_bust_cache(h)
+
+
+    s, h, b = Rack::Ping.new(app) do |ping|
+      ping.check do
+        raise "error"
+      end
+    end.call({})
+
+    s.must_equal 500
+    b[0].must_equal 'error'
+    h['x-ping-error'].must_equal "logic: error"
+    must_bust_cache(h)
+  end
+
+  it "should fetch url content and run regex on it when available" do
+    stub_request(:any, "http://google.com").to_return(:body => "google is awesome")
+    s, h, b = Rack::Ping.new(app) do |ping|
+      ping.check_url "http://google.com"
+      ping.ok_regex /awesome/
+      ping.ok_text "groovy"
+    end.call({})
+
+    s.must_equal 200
+    b[0].must_equal 'groovy'
+    must_bust_cache(h)
+
+
+    s, h, b = Rack::Ping.new(app) do |ping|
+      ping.check_url "http://google.com"
+      ping.ok_regex /bing/
+      ping.ok_text "groovy"
+    end.call({})
+
+    s.must_equal 500
+    b[0].must_equal 'error'
+    must_bust_cache(h)
+  end
+
+  it "should timeout when resource at url is unavailable" do
+    stub_request(:any, "http://google.com").to_timeout
+    s, h, b = Rack::Ping.new(app) do |ping|
+      ping.check_url "http://google.com"
+      ping.ok_regex /awesome/
+      ping.error_text "shitty"
+    end.call({})
+
+    s.must_equal 500
+    b[0].must_equal 'shitty'
+    h['x-ping-error'].must_equal "timeout"
+    must_bust_cache(h)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'rack/test'
+require 'webmock/minitest'
+
+include Rack::Test::Methods
+def r
+  last_response
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rack-ping
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dotan Nahum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &89268900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *89268900
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &89268680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *89268680
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &89268450 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *89268450
+description: Health checking Rack middleware
+email:
+- jondotan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- examples/config.ru
+- lib/rack/ping.rb
+- lib/rack/version.rb
+- rack-ping.gemspec
+- spec/rack/ping_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rack-ping
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Health checking Rack middleware
+test_files: []