conjur-rack-heartbeat 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 787168e29f4219e9b151d18ca6b9316b1c872ade
+  data.tar.gz: a8cde571d1fb2b9873dd1b49bf872a41d8b3df79
+SHA512:
+  metadata.gz: 4112db2d4e98f16d60dd52c8b3465a1ed0116d635cffaa8986c87a5eaf7798ae1a5b6bf7b9ae6b9a2a15eac6b546bd7724a08ffcba313e4fd6260317cd8837e1
+  data.tar.gz: b780e23f6ed4d3a155b7e301de7e165e1dd1c54907bac1bf4c8c73fb58de61fbf4bd31d5d6a634d45c64a53ba2a115b2adb17dfeac1c7028b4612bf874c7e5da

data/.gitignore

@@ -0,0 +1,18 @@
+report.xml
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>rack-heartbeat</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', :group => :test, :require => false

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Cox [https://github.com/imajes]
+
+MIT License
+
+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

@@ -0,0 +1,34 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'conjur-rack-heartbeat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install conjur-rack-heartbeat
+
+## Usage
+
+Once the gem is installed, you're done.  Just `curl -X OPTIONS localhost:3000` to get a text response with "OK".
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new(:jenkins) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.options = '--junit'
+  t.verbose = true
+end

data/config.ru

@@ -0,0 +1,3 @@
+require 'conjur-rack-heartbeat'
+
+run Rack::Heartbeat.new(proc{ raise "Method not handled"})

data/jenkins.sh

@@ -0,0 +1,5 @@
+#!/bin/bash -e
+
+gem install -N bundler
+bundle
+bundle exec rake jenkins

data/lib/conjur-rack-heartbeat.rb

@@ -0,0 +1,2 @@
+require 'rack/heartbeat'
+require 'rack/heartbeat/railtie' if defined?(Rails)

data/lib/rack/heartbeat.rb

@@ -0,0 +1,28 @@
+module Rack
+  # A heartbeat mechanism for the server. This will add a _/_ endpoint
+  # that responds to OPTIONS, returning status 200 when executed.
+
+  class Heartbeat
+    DEFAULT_ALLOW = %w(HEAD GET PUT DELETE OPTIONS)
+
+    attr_accessor :allow
+    
+    def initialize(app, allow = nil)
+      @app = app
+      @allow = allow || DEFAULT_ALLOW
+    end
+    
+    def call(env)
+      if env['PATH_INFO'] == "/" && (env['REQUEST_METHOD']||'').upcase == 'OPTIONS'
+        NewRelic::Agent.ignore_transaction if defined? NewRelic
+        [200, {"Content-Type" => "text/plain", "Allow" => @allow.join(',')}, ["OK"]]
+      else
+        @app.call(env)
+      end
+    end
+
+    def self.setup
+      yield self
+    end
+  end
+end

data/lib/rack/heartbeat/railtie.rb

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

data/rack-heartbeat.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["James Cox", "Kevin Gilpin"]
+  gem.email         = ["james@imaj.es", "kgilpin@gmail.com"]
+  gem.summary       = %q{Provides OPTIONS / as a heartbeat URL}
+  gem.homepage      = "https://github.com/conjurinc/rack-heartbeat"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "conjur-rack-heartbeat"
+  gem.require_paths = ["lib"]
+  gem.version       = '2.0.0'
+
+  gem.add_development_dependency('minitest')
+  gem.add_development_dependency('rack-test')
+  gem.add_development_dependency('minitest-junit')
+  gem.add_runtime_dependency('rack')
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'conjur-rack-heartbeat'

data/test/rack/test_heartbeat.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class Rack::TestHeartbeat < Minitest::Test
+  def setup
+    @app = Minitest::Mock.new
+    @heartbeat = Rack::Heartbeat.new(@app)
+  end
+  
+  def test_call_when_env_empty_sends_app_call
+    env = {}
+
+    @app.expect :call, nil, [env]
+    @heartbeat.call(env)
+    @app.verify
+  end
+
+  def test_call_when_path_info_is_nil_sends_app_call
+    env = {'PATH_INFO' => nil}
+
+    @app.expect :call, nil, [env]
+    @heartbeat.call(env)
+    @app.verify
+  end
+
+  def test_call_when_path_info_does_not_match_heartbeat_sends_app_call
+    env = {'PATH_INFO' => 'some-path'}
+  
+    @app.expect :call, nil, [env]
+    @heartbeat.call(env)
+    @app.verify
+  end
+  
+  def test_call_when_request_method_does_not_match_heartbeat_sends_app_call
+    env = {'PATH_INFO' => '/', 'REQUEST_METHOD' => 'GET'}
+  
+    @app.expect :call, nil, [env]
+    @heartbeat.call(env)
+    @app.verify
+  end
+
+  def test_call_when_path_info_matches_heartbeat_path_returns_200_response
+    env = {'PATH_INFO' => '/', 'REQUEST_METHOD' => 'OPTIONS'}
+
+    assert_equal [200, {'Content-Type' => 'text/plain', 'Allow' => 'HEAD,GET,PUT,DELETE,OPTIONS'}, ['OK']], @heartbeat.call(env)
+  end
+  
+  def test_call_with_custom_allow_when_path_info_matches_heartbeat_path_returns_200_response
+    env = {'PATH_INFO' => '/', 'REQUEST_METHOD' => 'OPTIONS'}
+  
+    @heartbeat.allow = %w(GET)
+    assert_equal [200, {'Content-Type' => 'text/plain', 'Allow' => 'GET'}, ['OK']], @heartbeat.call(env)
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: conjur-rack-heartbeat
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- James Cox
+- Kevin Gilpin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-junit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- james@imaj.es
+- kgilpin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .project
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- jenkins.sh
+- lib/conjur-rack-heartbeat.rb
+- lib/rack/heartbeat.rb
+- lib/rack/heartbeat/railtie.rb
+- rack-heartbeat.gemspec
+- test/helper.rb
+- test/rack/test_heartbeat.rb
+homepage: https://github.com/conjurinc/rack-heartbeat
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Provides OPTIONS / as a heartbeat URL
+test_files:
+- test/helper.rb
+- test/rack/test_heartbeat.rb