pingable 0.0.8 → 0.0.9

data/README.md

@@ -5,18 +5,22 @@ Pingable is a simple framework to implement a 'ping' URL in Rack-based web appli
 
 For example, a Rails or Sinatra app's `config.ru` may look like this (Rack 1.4.0 and later):
 
-    map '/ping' do
-      run Pingable::Handler
-    end
-    run MyApp
+```ruby
+map '/ping' do
+  run 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
-    }
+```ruby
+Pingable.add_check lambda {
+  unless check_something
+    "Oh noes, something failed"
+  end
+}
+```
 
 Checks
 ------
@@ -32,27 +36,31 @@ A check is simply an object which:
 
 Something a bit more complex:
 
-    class TwitterCheck
-      def initialize(url)
-        @url = url
-      end
+```ruby
+class TwitterCheck
+  def initialize(url)
+    @url = url
+  end
 
-      def call
-        # ... check the URL ...
-      end
-    end
+  def call
+    # ... check the URL ...
+  end
+end
 
-    Pingable.add_check TwitterCheck.new(:url => "http://twitter.com/")
+Pingable.add_check TwitterCheck.new(:url => "http://twitter.com/")
+```
 
 Configuration
 -------------
 
 To set the name that a successful ping check will return, provide a name in the rackup file:
 
-    map '/ping' do
-      use Pingable::Handler, 'my fancy app'
-    end
-    run MyApp
+```ruby
+map '/ping' do
+  use Pingable::Handler.new('my fancy app')
+end
+run MyApp
+```
 
 Ping check
 ----------
@@ -66,16 +74,18 @@ On success, a `200 OK` is returned, with either the application's name as the bo
 Common checks
 -------------
 
-Pingable comes with a set of checks that are commonly needed for web applications. To install these, add the following:
+Pingable comes with a set of checks that are commonly needed for web applications:
 
-    Pingable.common_checks!
+* `Pingable.active_record_checks!`: Checks ActiveRecord.
+* `Pingable.rails_cache_checks!`: Checks Rails cache.
 
-These include:
+To install all common checks based on available dependencies:
 
-* A check to verify ActiveRecord's current connection.
-* A check to check the ability for Rails' cache to read and write values.
+```ruby
+Pingable.common_checks!
+```
 
-Common checks for are only installed for dependencies that are discovered automatically. For example, if ActiveRecord has not been `require`d, then the ActiveRecord check is not included.
+For example, if ActiveRecord has not been `require`d, then the ActiveRecord check is not included.
 
 License
 -------

data/lib/pingable/common_checks.rb

@@ -3,53 +3,54 @@ module Pingable
   class << self
     @@common_checks_added ||= false
 
-    # Add checks for standard gems such as Active Record.
+    # Add checks for standard gems such as Active Record, based on
+    # what is currently available.
     def common_checks!
       unless @@common_checks_added
-        add_active_record!
-        add_rails_cache!
+        if defined?(ActiveRecord)
+          active_record_checks!
+        end
+        if defined?(Rails) and Rails.respond_to?(:cache)
+          rails_cache_checks!
+        end
         @@common_checks_added = true
       end
     end
 
-    private
-
-      def add_active_record!
-        if defined?(ActiveRecord)
-          require 'timeout'
-          add_check lambda {
-            begin
-              timeout(10) do
-                ActiveRecord::Base.verify_active_connections!
-              end
-              ActiveRecord::Base.connection.execute('select 1')
-              nil
-            rescue Timeout::Error
-              "ActiveRecord: Timed out"
-            rescue Exception => e
-              if e.class.name == e.message
-                "ActiveRecord: #{e}"
-              else
-                "ActiveRecord: #{e.class}: #{e.message}"
-              end
-            end
-          }
+    # Add checks for ActiveRecord.
+    def active_record_checks!
+      require 'timeout'
+      add_check lambda {
+        begin
+          timeout(10) do
+            ActiveRecord::Base.verify_active_connections!
+          end
+          ActiveRecord::Base.connection.execute('select 1')
+          nil
+        rescue Timeout::Error
+          "ActiveRecord: Timed out"
+        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
-          }
+    # Add Rails cache checks.
+    def rails_cache_checks!
+      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
 

data/lib/pingable/version.rb

@@ -1,3 +1,3 @@
 module Pingable
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pingable
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Alexander Staubo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-31 00:00:00 Z
+date: 2012-02-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec