rack-heartbeat 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f91474fa924440ab0c9072b3636ffa7225b28cc
-  data.tar.gz: b864ec021073c6c39fb1e84deea53378a3b760b5
+  metadata.gz: 12a90f7d887de31bbd1e56ad6cd7c2bd56b687bd
+  data.tar.gz: f2c3265b628de9751f39a5dbd4154bb715a0f6cd
 SHA512:
-  metadata.gz: 043d03774af1f1b4b4dc79a433da8030501d840e9557d7aa9fe59f1987f05e72caf4d4d7a9cfff2f1ac39d35e65d8221dc5f03c7ca2079cc3cac1abbaccfc89e
-  data.tar.gz: 7603c6b7c54a80220c9e44d58b531bcb8946c6a39fdd7aca86bd055b925c616a75898dcbabadb5fd7ccb527dfc28aa9a84bc6b5ea0f0e05264fe1706ceba6ede
+  metadata.gz: d55562bbed3240a828643da60cde037d6314bfe0fcc156ed26a94c184ea8ff14922c5bb6abcde089792817cd6bd2956e27423e852533bbc350aafa6cf5ae7dc3
+  data.tar.gz: c114fe9638a07a1cc81ad7f0f2217a6f505fa756aaf230105721c3c0eedff8add55e3915e08976c287b5c8fde9be22ba6a661ec93821339da1c69ddbc4e46008

data/.ruby-gemset

@@ -0,0 +1 @@
+.bundle

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -2,4 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rake'
 gem 'coveralls', :group => :test, :require => false
+

data/README.md

@@ -1,6 +1,6 @@
 # Rack::Heartbeat
 
-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.
+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,17 +18,28 @@ Or install it yourself as:
 
 ## Usage
 
-Once the gem is installed, you're done.  Just browse to localhost:300/heartbeat to get a text response with "OK".
+Once the gem is installed, you're done.  Just browse to http://localhost:3000/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/initializers/rack_heartbeat.rb
+# config/initializers/rack_heartbeat.rb
 Rack::Heartbeat.setup do |config|
   config.heartbeat_path = 'health-check.txt'
 end
 ```
 
+You can also customize headers and response, for example if you want to do the cross-domain request, you can
+either set the CORS headers, or just send an image:
+
+```ruby
+# config/initializers/rack_heartbeat.rb
+Rack::Heartbeat.setup do |config|
+  config.heartbeat_response = Base64.decode64('R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==')
+  config.heartbeat_headers = {'Content-Type' => 'image/gif'}
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -40,4 +51,5 @@ end
 ## Contributors
 
 * [James Cox](https://github.com/imajes)
-* [Steve Mitchell](http://github.com/theSteveMitchell)
+* [Steve Mitchell](https://github.com/theSteveMitchell)
+* [Igor Rzegocki](https://github.com/ajgon)

data/lib/rack/heartbeat.rb

@@ -4,15 +4,33 @@ module Rack
 
   class Heartbeat
     @@heartbeat_path = 'heartbeat'
+    @@heartbeat_response = 'OK'
+    @@heartbeat_headers = {"Content-Type" => "text/plain"}
 
     class << self
       def heartbeat_path
         @@heartbeat_path
       end
 
+      def heartbeat_response
+        @@heartbeat_response
+      end
+
+      def heartbeat_headers
+        @@heartbeat_headers
+      end
+
       def heartbeat_path=(path)
         @@heartbeat_path = path
       end
+
+      def heartbeat_response=(response)
+        @@heartbeat_response = response
+      end
+
+      def heartbeat_headers=(headers_hash)
+        @@heartbeat_headers = headers_hash
+      end
     end
 
     def initialize(app)
@@ -22,7 +40,7 @@ module Rack
     def call(env)
       if env['PATH_INFO'] == "/#{heartbeat_path}"
         NewRelic::Agent.ignore_transaction if defined? NewRelic
-        [200, {"Content-Type" => "text/plain"}, ["OK"]]
+        [200, heartbeat_headers, [heartbeat_response]]
       else
         @app.call(env)
       end
@@ -32,6 +50,14 @@ module Rack
       self.class.heartbeat_path
     end
 
+    def heartbeat_response
+      self.class.heartbeat_response
+    end
+
+    def heartbeat_headers
+      self.class.heartbeat_headers
+    end
+
     def self.setup
       yield self
     end

data/lib/rack/heartbeat/railtie.rb

@@ -2,7 +2,7 @@ module Rack
 
   class Heartbeat::Railtie < Rails::Railtie
     initializer "rack.heartbeat.initializer" do |app|
-      app.middleware.insert 0, 'Rack::Heartbeat'
+      app.middleware.insert 0, Rack::Heartbeat
     end
   end
 

data/rack-heartbeat.gemspec

@@ -12,7 +12,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       = '1.0.1'
+  gem.version       = '1.1.0'
 
   gem.add_development_dependency('minitest')
   gem.add_development_dependency('rack-test')

data/test/rack/test_heartbeat.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'base64'
 
 class Rack::TestHeartbeat < Minitest::Test
   def setup
@@ -9,7 +10,9 @@ class Rack::TestHeartbeat < Minitest::Test
   def teardown
     Rack::Heartbeat.setup do |config|
       config.heartbeat_path = 'heartbeat'
-    end
+      config.heartbeat_headers = {'Content-Type' => 'text/plain'}
+      config.heartbeat_response = 'OK'
+     end
   end
 
   def test_initialize_sets_default_heartbeat_path
@@ -47,11 +50,20 @@ class Rack::TestHeartbeat < Minitest::Test
   end
 
   def test_setup_configures_heartbeat_path
-    expected = 'health-check.txt'
+    expected_path = 'health-check.txt'
+    expected_headers = {'Content-Type' => 'image/gif'}
+    expected_response = Base64.decode64('R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==')
+    env = {'PATH_INFO' => "/#{expected_path}"}
+
     Rack::Heartbeat.setup do |config|
-      config.heartbeat_path = expected
+      config.heartbeat_path = expected_path
+      config.heartbeat_headers = expected_headers
+      config.heartbeat_response = expected_response
     end
 
-    assert_match expected, Rack::Heartbeat.heartbeat_path
+    assert_match expected_path, Rack::Heartbeat.heartbeat_path
+    assert_equal expected_headers, Rack::Heartbeat.heartbeat_headers
+    assert_equal expected_response, Rack::Heartbeat.heartbeat_response
+    assert_equal [200, expected_headers, [expected_response]], @heartbeat.call(env)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-heartbeat
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - James Cox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -61,6 +61,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: provides a simple endpoint for your rails app for a heartbeat client to connect