pingable 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2011 Alexander Staubo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,7 +1,7 @@
-Pinger
-======
+Pingable
+========
 
-Pinger is a simple framework to implement a 'ping' URL in Rack-based web applications.
+Pingable is a simple framework to implement a 'ping' URL in Rack-based web applications.
 
 For example, a Rails or Sinatra app's `config.ru` may look like this:
 
@@ -18,6 +18,18 @@ Now you can add checks in a modular fashion:
       end
     }
 
+Checks
+------
+
+A check is simply an object which:
+
+* implements `call` with no arguments.
+* returns one of the following on error:
+  * a string
+  * a hash of `{:message => message}`
+  * an array of the above
+* returns nil on success.
+
 Something a bit more complex:
 
     class TwitterCheck
@@ -32,14 +44,24 @@ Something a bit more complex:
 
     Pingable.add_check TwitterCheck.new(:url => "http://twitter.com/")
 
-A check is simply an object which:
+Configuration
+-------------
 
-* implements `call` with no arguments.
-* returns one of the following on error:
-  * a string
-  * a hash of {:message => message}
-  * an array of the above
-* returns nil on success.
+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
+
+Ping check
+----------
+
+`/ping` is implemented by running all registered checks.
+
+On failure, an HTTP `500` is returned, with the body of the response being a `text/plain` text with each error on separate lines.
+
+On success, a `200 OK` is returned, with either the application's name as the body (if defined), or an empty body.
 
 Common checks
 -------------
@@ -52,3 +74,10 @@ These include:
 
 * A check to verify ActiveRecord's current connection.
 * A check to check the ability for Rails' cache to read and write values.
+
+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.
+
+License
+-------
+
+Licensed under the MIT license. See `LICENSE` file.

data/example/config.ru

@@ -7,7 +7,7 @@ Pingable.add_check lambda {
 }
 
 map '/ping' do
-  use Pingable::Handler
+  use Pingable::Handler, "myapp"
 end
 run lambda { |env|
   [200, {'Content-Type' => 'text/plain'}, ['OK']]

data/lib/pingable/handler.rb

@@ -2,8 +2,9 @@ module Pingable
 
   class Handler
 
-    def initialize(app)
+    def initialize(app, name = nil)
       @app = app
+      @name = name
     end
 
     def call(env)
@@ -11,15 +12,13 @@ module Pingable
       if failures.any?
         [500, HEADERS, failures.map { |f| f[:message] }.join("\n")]
       else
-        app_name = env['pingable.name']
-        app_name ||= ''
-        [200, HEADERS, app_name]
+        [200, HEADERS, @name ||= '']
       end
     end
 
     private
 
-      HEADERS = {'Cache-Control' => 'private'}
+      HEADERS = {'Cache-Control' => 'private', 'Content-Type': 'text/plain'}
 
   end
 

data/lib/pingable/version.rb

@@ -1,3 +1,3 @@
 module Pingable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/pingable.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Alexander Staubo"]
   s.email       = ["alex@origo.no"]
   s.homepage    = "http://github.com/origo/pingable"
-  s.summary     = s.description = %q{Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks}
+  s.summary     = s.description = %q{Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks.}
 
   s.rubyforge_project = "pingable"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pingable
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alexander Staubo
@@ -47,7 +47,7 @@ dependencies:
         version: 1.0.0
   type: :runtime
   version_requirements: *id002
-description: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks
+description: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks.
 email: 
 - alex@origo.no
 executables: []
@@ -59,6 +59,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - example/config.ru
@@ -100,6 +101,6 @@ rubyforge_project: pingable
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks
+summary: Pingable is a Rack handler that let an app respond to a path /ping, with pluggable checks.
 test_files: []