okcomputer 0.1.0 → 0.1.1

data/README.markdown

@@ -22,7 +22,14 @@ Or install it yourself as:
 
 ## Usage
 
-To perform the default checks (application running and database connection), do nothing other than adding to your application's Gemfile.
+To perform the default checks (application running and ActiveRecord database
+connection), do nothing other than adding to your application's Gemfile.
+
+If you use a database adapter other than ActiveRecord, see Registering Custom
+Checks below to build your own database check and register it with the name
+"database" to replace the built-in check, or use
+`OKComputer::Registry.deregister "database"` to stop checking your database
+altogether.
 
 ### Registering Additional Checks
 
@@ -30,15 +37,31 @@ Register additional checks in an initializer, like do:
 
 ```ruby
 # config/initializers/okcomputer.rb
-OKComputer::Registry.register "resque", OKComputer::Checks::Resque
-OKComputer::Registry.register "load", OKComputer::Checks::CPULoad
+OKComputer::Registry.register "resque_down", OKComputer::ResqueDownCheck.new("critical", 100)
+OKComputer::Registry.register "resque_backed_up", OKComputer::ResqueBackedUpCheck.new
 ```
 
-TODO: Figure out interface for configuring checks (e.g., Resque looking for more than 100 jobs in the "critical" queue)
-
 ### Registering Custom Checks
 
-TODO: Figre out interface for custom checks
+The simplest way to register a check unique to your application is to subclass
+OKComputer::Check and implement your own `#call` method, which returns the
+output string, and calls `mark_failure` if anything is wrong.
+
+```ruby
+# config/initializers/okcomputer.rb
+class MyCustomCheck < OKComputer::Check
+  def call
+    if rand(10).even?
+      "Even is great!"
+    else
+      mark_failure
+      "We don't like odd numbers"
+    end
+  end
+end
+
+OKComputer::Registry.register "check_for_odds", MyCustomCheck.new
+```
 
 ## Performing Checks
 

data/app/controllers/ok_computer_controller.rb

@@ -1,4 +1,4 @@
-class OkComputerController < ApplicationController
+class OkComputerController < ActionController::Base
   layout nil
   respond_to :text, :json
 

data/lib/okcomputer/version.rb

@@ -1,3 +1,3 @@
 module OKComputer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2558154404506305637
+      hash: 2772861255282844585
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2558154404506305637
+      hash: 2772861255282844585
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24