okcomputer 0.1.3 → 0.2.0

data/README.markdown

@@ -45,25 +45,26 @@ Register additional checks in an initializer, like do:
 
 ```ruby
 # config/initializers/okcomputer.rb
-OKComputer::Registry.register "resque_down", OKComputer::ResqueDownCheck.new("critical", 100)
-OKComputer::Registry.register "resque_backed_up", OKComputer::ResqueBackedUpCheck.new
+OKComputer::Registry.register "resque_down", OKComputer::ResqueDownCheck.new
+OKComputer::Registry.register "resque_backed_up", OKComputer::ResqueBackedUpCheck.new("critical", 100)
 ```
 
 ### Registering 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.
+OKComputer::Check and implement your own `#check` method, which sets the
+display message with `mark_message`, and calls `mark_failure` if anything is
+wrong.
 
 ```ruby
 # config/initializers/okcomputer.rb
 class MyCustomCheck < OKComputer::Check
-  def call
+  def check
     if rand(10).even?
-      "Even is great!"
+      mark_message "Even is great!"
     else
       mark_failure
-      "We don't like odd numbers"
+      mark_message "We don't like odd numbers"
     end
   end
 end
@@ -71,6 +72,14 @@ end
 OKComputer::Registry.register "check_for_odds", MyCustomCheck.new
 ```
 
+#### Deprecation of Check#call
+
+Versions before 0.2.0 implemented a "#call" method which returned the message.
+This has been deprecated and will be removed in a future version. Please
+define a #check method which calls `mark_failure` and `mark_message` as
+appropriate. In the meantime, OKComputer displays a warning and uses the result
+of the #call method as the message.
+
 ## Performing Checks
 
 * Perform a simple up check: http://example.com/okcomputer

data/app/controllers/ok_computer_controller.rb

@@ -4,12 +4,14 @@ class OkComputerController < ActionController::Base
 
   def index
     checks = OKComputer::Registry.all
+    checks.run
 
     respond_with checks, status: status_code(checks)
   end
 
   def show
     check = OKComputer::Registry.fetch(params[:check])
+    check.run
 
     respond_with check, status: status_code(check)
   end

data/lib/okcomputer/built_in_checks/active_record_check.rb

@@ -1,11 +1,11 @@
 module OKComputer
   class ActiveRecordCheck < Check
     # Public: Return the schema version of the database
-    def call
-      "Schema version: #{schema_version}"
+    def check
+      mark_message "Schema version: #{schema_version}"
     rescue ConnectionFailed => e
       mark_failure
-      "Failed to connect: '#{e}'"
+      mark_message "Failed to connect: '#{e}'"
     end
 
     # Public: The scema version of the app's database

data/lib/okcomputer/built_in_checks/default_check.rb

@@ -1,8 +1,8 @@
 module OKComputer
   class DefaultCheck < Check
     # Public: Check that Rails can render anything at all
-    def call
-      "OKComputer Site Check Passed"
+    def check
+      mark_message "OKComputer Site Check Passed"
     end
   end
 end

data/lib/okcomputer/built_in_checks/mongoid_check.rb

@@ -1,11 +1,11 @@
 module OKComputer
   class MongoidCheck < Check
     # Public: Return the status of the mongodb
-    def call
-      "Successfully connected to mongodb #{mongodb_name}"
+    def check
+      mark_message "Successfully connected to mongodb #{mongodb_name}"
     rescue ConnectionFailed => e
       mark_failure
-      "Failed to connect: '#{e}'"
+      mark_message "Failed to connect: '#{e}'"
     end
 
     # Public: The stats for the app's mongodb

data/lib/okcomputer/built_in_checks/resque_backed_up_check.rb

@@ -14,12 +14,12 @@ module OKComputer
     end
 
     # Public: Check whether the given queue is backed up
-    def call
+    def check
       if count <= threshold
-        "Resque queue '#{queue}' at reasonable level (#{count})"
+        mark_message "Resque queue '#{queue}' at reasonable level (#{count})"
       else
         mark_failure
-        "Resque queue '#{queue}' backed up! (#{count})"
+        mark_message "Resque queue '#{queue}' backed up! (#{count})"
       end
     end
 

data/lib/okcomputer/built_in_checks/resque_down_check.rb

@@ -1,12 +1,12 @@
 module OKComputer
   class ResqueDownCheck < Check
     # Public: Check whether Resque workers are working
-    def call
+    def check
       if queued? and not working?
         mark_failure
-        "Resque is DOWN. No workers are working the queue."
+        mark_message "Resque is DOWN. No workers are working the queue."
       else
-        "Resque is working"
+        mark_message "Resque is working"
       end
     end
 

data/lib/okcomputer/check.rb

@@ -1,23 +1,40 @@
 module OKComputer
   class Check
+    CALL_DEPRECATION_MESSAGE = "Deprecation warning: Please define #check rather than defining #call"
+
     # to be set by Registry upon registration
     attr_accessor :name
     # nil by default, only set to true if the check deems itself failed
     attr_accessor :failure_occurred
+    # nil by default, set by #check to control the output
+    attr_accessor :message
+
+    # Public: Run the check
+    def run
+      clear
+      check
+    end
 
-    # Public: Perform the appropriate check
+    # Private: Perform the appropriate check
     #
-    # Your subclass of Check must define its own #call method. This method
+    # Your subclass of Check must define its own #check method. This method
     # must return the string to render when performing the check.
-    def call
-      raise(CallNotDefined, "Your subclass must define its own #call.")
+    def check
+      if respond_to? :call
+        warn CALL_DEPRECATION_MESSAGE
+        # The old #call methods returned the message, so use that to set the message output
+        mark_message call
+      else
+        raise(CheckNotDefined, "Your subclass must define its own #check.")
+      end
     end
+    private :check
 
     # Public: The text output of performing the check
     #
     # Returns a String
     def to_text
-      "#{name}: #{call}"
+      "#{name}: #{message}"
     end
 
     # Public: The JSON output of performing the check
@@ -26,7 +43,7 @@ module OKComputer
     def to_json(*args)
       # NOTE swallowing the arguments that Rails passes by default since we don't care. This may prove to be a bad idea
       # Rails passes stuff like this: {:prefixes=>["ok_computer", "application"], :template=>"show", :layout=>#<Proc>}]
-      {name => call}.to_json
+      {name => message}.to_json
     end
 
     # Public: Whether the check passed
@@ -41,6 +58,19 @@ module OKComputer
       self.failure_occurred = true
     end
 
-    CallNotDefined = Class.new(StandardError)
+    # Public: Capture the desired message to display
+    #
+    # message - Text of the message to display for this check
+    def mark_message(message)
+      self.message = message
+    end
+
+    # Public: Clear any prior failures
+    def clear
+      self.failure_occurred = false
+      self.message = nil
+    end
+
+    CheckNotDefined = Class.new(StandardError)
   end
 end

data/lib/okcomputer/check_collection.rb

@@ -10,6 +10,11 @@ module OKComputer
       self.registry = registry
     end
 
+    # Public: Run the registry's checks
+    def run
+      checks.each(&:run)
+    end
+
     # Public: The list of checks in the collection
     #
     # Returns an Array of the registry's values

data/lib/okcomputer/version.rb

@@ -1,3 +1,3 @@
 module OKComputer
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -2,14 +2,14 @@
 name: okcomputer
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -847942118796970126
+      hash: -1241122917546608114
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -847942118796970126
+      hash: -1241122917546608114
   none: false
 requirements: []
 rubyforge_project: