rack-heartbeat 0.6 → 0.7

data/README.md

@@ -1,6 +1,6 @@
 # Rack::Heartbeat
 
-TODO: Write a gem description
+A tiny gem that installs a Rack middleware to respond to heartbeat requests.  This saves you all the trouble of creating custom controllers, routes, and static files, and prevents your logs from bloating.
 
 ## Installation
 
@@ -18,7 +18,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Once the gem is installed, you're done.  Just browse to localhost:300/heartbeat to get a text response with "OK".
+
+If you want to customize the url for any reason, you can configure that, too:
+
+```ruby
+#config/initilializers/rack_heartbeat.rb
+Rack::Heartbeat.setup do |config|
+  config.heartbeat_path = 'health-check.txt'
+end
+```
 
 ## Contributing
 
@@ -27,3 +36,8 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Contributors
+
+* [James Cox](https://github.com/imajes)
+* [Steve Mitchell](http://github.com/theSteveMitchell)

data/lib/rack/heartbeat.rb

@@ -1,17 +1,25 @@
 module Rack
   # A heartbeat mechanism for the server. This will add a _/heartbeat_ endpoint
   # that returns status 200 and content OK when executed.
+
   class Heartbeat
+    cattr_accessor :heartbeat_path
+    @@heartbeat_path = 'heartbeat'
+    
     def initialize(app)
       @app = app
     end
 
     def call(env)
-      if env['PATH_INFO'] == '/heartbeat'
-        [200, {}, ['OK']]
+      if env['PATH_INFO'] == "/#{heartbeat_path}"
+        [200, {"Content-Type" => "text/plain"}, ["OK"]]
       else
         @app.call(env)
       end
     end
+
+    def self.setup
+      yield self
+    end
   end
 end

data/rack-heartbeat.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "rack-heartbeat"
   gem.require_paths = ["lib"]
-  gem.version       = '0.6'
+  gem.version       = '0.7'
 
   # deps
   gem.add_dependency('rack')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-heartbeat
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: provides a simple endpoint for your rails app for a heartbeat client to connect