pinglish 0.0.1 → 0.1.0

data/.gitignore

@@ -1,2 +1,3 @@
 /*.gem
 /.bundle
+/Gemfile.lock

data/README.md

@@ -29,16 +29,16 @@ conforms to the spec below.
    serialization or other fundamental code fails.
 
 0. The response __must__ contain a `"status"` key set either to `"ok"`
-   or `"fail"`.
+   or `"failures"`.
 
 0. The response __must__ contain a `"now"` key set to the current
    server's time in seconds since epoch as a string.
 
-0. If the `"status"` key is set to `"fail"`, the response __may__
+0. If the `"status"` key is set to `"failures"`, the response __may__
    contain a `"failures"` key set to an Array of string names
    representing failed checks.
 
-0. If the `"status"` key is set to `"fail"`, the response __may__
+0. If the `"status"` key is set to `"failures"`, the response __may__
    contain a `"timeouts"` key set to an Array of string names
    representing checks that exceeded an implementation-specific
    individual timeout.
@@ -56,7 +56,7 @@ conforms to the spec below.
   // These two keys will always exist.
 
   "now": "1359055102",
-  "status": "fail",
+  "status": "failures",
 
   // This key may only exist when a named check has failed.
 
@@ -75,8 +75,6 @@ conforms to the spec below.
 
 ## The Middleware
 
-FIX: exegesis
-
 ```ruby
 require "pinglish"
 
@@ -108,14 +106,10 @@ use Pinglish do |ping|
     App.dawdle
   end
 
-  # Signal check failure by raising an exception.
+  # Signal check failure by raising an exception. Any exception will do.
 
   ping.check :fails do
-    false or raise "Everything's ruined."
+    raise "Everything's ruined."
   end
 end
 ```
-
-## Contributing
-
-FIX

data/lib/pinglish.rb

@@ -1,6 +1,7 @@
 require "json"
-require "timeout"
+require "pinglish/check"
 require "rack/request"
+require "timeout"
 
 # This Rack middleware provides a "/_ping" endpoint for configurable
 # system health checks. It's intended to be consumed by machines.
@@ -13,42 +14,21 @@ class Pinglish
     "Content-Type" => "application/json; charset=UTF-8"
   }
 
-  # The maximum amount of time for all checks. 29 seconds, to come in
-  # just under the 30 second limit of many monitoring services.
-
-  MAX_TOTAL_TIME = 29
-
-  # Represents a check, which is a behavior block with a name and
-  # timeout in seconds.
-
-  class Check
-    attr_reader :name
-    attr_reader :timeout
-
-    def initialize(name, options = nil, &block)
-      @name    = name
-      @timeout = options && options[:timeout] || 1
-      @block   = block
-    end
-
-    # Call this check's behavior, returning the result of the block.
-
-    def call(*args, &block)
-      @block.call *args, &block
-    end
-  end
-
   # Raised when a check exceeds its timeout.
 
   class TooLong < RuntimeError; end
 
   # Create a new instance of the middleware wrapping `app`, with an
-  # optional `path` (the default is `"/_ping"`) and behavior `block`.
+  # optional `:path` (default: `"/_ping"`), `:max` timeout in seconds
+  # (default: `29`), and behavior `block`.
+
+  def initialize(app, options = nil, &block)
+    options ||= {}
 
-  def initialize(app, path = nil, &block)
     @app    = app
     @checks = {}
-    @path   = path || "/_ping"
+    @max    = options[:max] || 29 # seconds
+    @path   = options[:path] || "/_ping"
 
     yield self if block_given?
   end
@@ -61,63 +41,71 @@ class Pinglish
 
     return @app.call env unless request.path == @path
 
-    timeout MAX_TOTAL_TIME do
-      results = {}
+    groups = [].map(&:to_s) # FIX
+
+    begin
+      timeout @timeout do
+        results  = {}
+        filtered = @checks.values
 
-      @checks.values.each do |check|
-        begin
-          timeout check.timeout do
-            results[check.name] = check.call
+        unless groups.empty?
+          filtered = filtered.select { |c| groups.include? c.group.to_s }
+        end
+
+        filtered.each do |check|
+          begin
+            timeout check.timeout do
+              results[check.name] = check.call
+            end
+          rescue StandardError => e
+            results[check.name] = e
           end
-        rescue StandardError => e
-          results[check.name] = e
         end
-      end
 
-      failed      = results.values.any? { |v| failure? v }
-      http_status = failed ? 503 : 200
-      text_status = failed ? "fail" : "ok"
+        failed      = results.values.any? { |v| failure? v }
+        http_status = failed ? 503 : 200
+        text_status = failed ? "failures" : "ok"
 
-      data = {
-        :now    => Time.now.to_i.to_s,
-        :status => text_status
-      }
+        data = {
+          :now    => Time.now.to_i.to_s,
+          :status => text_status
+        }
 
-      results.each do |name, value|
+        results.each do |name, value|
 
-        # The unnnamed/default check doesn't contribute data.
-        next if name.nil?
+          # The unnnamed/default check doesn't contribute data.
+          next if name.nil?
 
-        if failure? value
+          if failure? value
 
-          # If a check fails its name is added to a `failures` array.
-          # If the check failed because it timed out, its name is
-          # added to a `timeouts` array instead.
+            # If a check fails its name is added to a `failures` array.
+            # If the check failed because it timed out, its name is
+            # added to a `timeouts` array instead.
 
-          key = timeout?(value) ? :timeouts : :failures
-          (data[key] ||= []) << name
+            key = timeout?(value) ? :timeouts : :failures
+            (data[key] ||= []) << name
 
-        elsif value
+          elsif value
 
-          # If the check passed and returned a value, the stringified
-          # version of the value is returned under the `name` key.
+            # If the check passed and returned a value, the stringified
+            # version of the value is returned under the `name` key.
 
-          data[name] = value.to_s
+            data[name] = value.to_s
+          end
         end
-      end
 
-      [http_status, HEADERS, [JSON.generate(data)]]
-    end
+        [http_status, HEADERS, [JSON.generate(data)]]
+      end
 
-  rescue Exception => ex
+    rescue Exception => ex
 
-    p :fuck => ex
-    # Something catastrophic happened. We can't even run the checks
-    # and render a JSON response. Fall back on a pre-rendered string
-    # and interpolate the current epoch time.
+      # Something catastrophic happened. We can't even run the checks
+      # and render a JSON response. Fall back on a pre-rendered string
+      # and interpolate the current epoch time.
 
-    now = Time.now.to_i.to_s
-    [500, HEADERS, ['{"status":"fail","now":"' + now + '"}']]
+      now = Time.now.to_i.to_s
+      [500, HEADERS, ['{"status":"failures","now":"' + now + '"}']]
+    end
   end
 
   # Add a new check with optional `name`. A `:timeout` option can be

data/lib/pinglish/check.rb

@@ -0,0 +1,21 @@
+class Pinglish
+  class Check
+    attr_reader :group
+    attr_reader :name
+    attr_reader :timeout
+
+    def initialize(name, options = nil, &block)
+      options ||= {}
+      @group    = options[:group]
+      @name     = name
+      @timeout  = options[:timeout] || 1
+      @block    = block
+    end
+
+    # Call this check's behavior, returning the result of the block.
+
+    def call(*args, &block)
+      @block.call *args, &block
+    end
+  end
+end

data/pinglish.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "pinglish"
-  gem.version       = "0.0.1"
+  gem.version       = "0.1.0"
   gem.authors       = ["John Barnette", "Will Farrington"]
   gem.email         = ["jbarnette@github.com", "wfarr@github.com"]
   gem.description   = "A simple Rack middleware for checking app health."

data/script/bootstrap

@@ -6,4 +6,4 @@ set -e
 cd $(dirname "$0")/..
 rm -rf .bundle/config
 
-bundle install --path .bundle --binstubs .bundle/binstubs --quiet
+bundle install --path .bundle --binstubs .bundle/binstubs --quiet "$@"

data/test/pinglish_test.rb

@@ -2,7 +2,7 @@ require "helper"
 require "rack/test"
 
 class PinglishTest < MiniTest::Unit::TestCase
-  FakeApp = lambda { |env| [404, {}, []] }
+  FakeApp = lambda { |env| [200, {}, ["fake"]] }
 
   def build_app(*args, &block)
     Rack::Builder.new do |builder|
@@ -11,18 +11,40 @@ class PinglishTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_with_non_matching_request_path
+    app = build_app
+
+    session = Rack::Test::Session.new(app)
+    session.get "/something"
+    assert_equal 200, session.last_response.status
+    assert_equal "fake", session.last_response.body
+  end
+
+  def test_with_non_matching_request_path_and_exception
+    app = Rack::Builder.new do |builder|
+      builder.use Pinglish
+      builder.run lambda { |env| raise "boom" }
+    end
+
+    session = Rack::Test::Session.new(app)
+
+    assert_raises RuntimeError do
+      session.get "/something"
+    end
+  end
+
   def test_with_defaults
     app = build_app
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
     assert_equal 200, session.last_response.status
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'ok', json['status']
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
   end
 
   def test_with_good_check
@@ -32,16 +54,16 @@ class PinglishTest < MiniTest::Unit::TestCase
     end
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
 
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'ok', json['status']
-    assert_equal 'up_and_at_em', json['db']
-    assert_equal 'pushin_and_poppin', json['queue']
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
+    assert_equal "up_and_at_em", json["db"]
+    assert_equal "pushin_and_poppin", json["queue"]
   end
 
   def test_with_unnamed_check
@@ -50,32 +72,32 @@ class PinglishTest < MiniTest::Unit::TestCase
     end
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
 
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'ok', json['status']
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
   end
 
   def test_with_check_that_raises
     app = build_app do |ping|
       ping.check(:db) { :ok }
-      ping.check(:raise) { raise 'nooooope' }
+      ping.check(:raise) { raise "nooooope" }
     end
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
 
     assert_equal 503, session.last_response.status
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'fail', json['status']
+    assert json.key?("now")
+    assert_equal "failures", json["status"]
   end
 
   def test_with_check_that_returns_false
@@ -85,16 +107,16 @@ class PinglishTest < MiniTest::Unit::TestCase
     end
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
 
     assert_equal 503, session.last_response.status
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'fail', json['status']
-    assert_equal ['fail'], json['failures']
+    assert json.key?("now")
+    assert_equal "failures", json["status"]
+    assert_equal ["fail"], json["failures"]
   end
 
   def test_with_check_that_times_out
@@ -104,30 +126,30 @@ class PinglishTest < MiniTest::Unit::TestCase
     end
 
     session = Rack::Test::Session.new(app)
-    session.get '/_ping'
+    session.get "/_ping"
 
     assert_equal 503, session.last_response.status
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'fail', json['status']
-    assert_equal ['long'], json['timeouts']
+    assert json.key?("now")
+    assert_equal "failures", json["status"]
+    assert_equal ["long"], json["timeouts"]
   end
 
   def test_with_custom_path
-    app = build_app("/_piiiiing")
+    app = build_app(:path => "/_piiiiing")
 
     session = Rack::Test::Session.new(app)
-    session.get '/_piiiiing'
+    session.get "/_piiiiing"
     assert_equal 200, session.last_response.status
-    assert_equal 'application/json; charset=UTF-8',
+    assert_equal "application/json; charset=UTF-8",
       session.last_response.content_type
 
     json = JSON.load(session.last_response.body)
-    assert json.key?('now')
-    assert_equal 'ok', json['status']
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
   end
 
   def test_check_without_name
@@ -146,32 +168,25 @@ class PinglishTest < MiniTest::Unit::TestCase
   def test_failure_boolean
     pinglish = Pinglish.new(FakeApp)
 
-    assert pinglish.failure?(Exception.new),
-      "Expected failure with exception to be true"
+    assert pinglish.failure?(Exception.new)
+    assert pinglish.failure?(false)
 
-    assert pinglish.failure?(false),
-      "Expected failure with false to be true"
-
-    assert !pinglish.failure?(true),
-      "Expected failure with true value to be false"
-
-    assert !pinglish.failure?(:ok),
-      "Expected failure with non-false and non-exception to be false"
+    refute pinglish.failure?(true)
+    refute pinglish.failure?(:ok)
   end
 
   def test_timeout
     pinglish = Pinglish.new(FakeApp)
-    begin
+
+    assert_raises Pinglish::TooLong do
       pinglish.timeout(0.001) { sleep 0.003 }
-      assert false, "Timeout did not happen, but should have."
-    rescue Pinglish::TooLong => e
-      # all good
     end
   end
 
   def test_timeout_boolean
     pinglish = Pinglish.new(FakeApp)
-    assert_equal true, pinglish.timeout?(Pinglish::TooLong.new)
-    assert_equal false, pinglish.timeout?(Exception.new)
+
+    assert pinglish.timeout?(Pinglish::TooLong.new)
+    refute pinglish.timeout?(Exception.new)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinglish
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -70,14 +70,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - lib/pinglish.rb
+- lib/pinglish/check.rb
 - pinglish.gemspec
 - script/bootstrap
 - script/release
-- script/tests
+- script/test
 - test/check_test.rb
 - test/helper.rb
 - test/pinglish_test.rb

data/Gemfile.lock

@@ -1,21 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pinglish (0.0.0)
-      rack
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (4.5.0)
-    rack (1.5.0)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest (~> 4.5)
-  pinglish!
-  rack-test (~> 0.6)