Skip to content

r7kamura/rack-ok

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rack::Ok

Rack middleware to return OK.

Installation

Add this line to your application's Gemfile:

gem 'rack-ok'

And then execute:

bundle install

Or install it yourself as:

gem install rack-ok

Usage

Insert Rack::Ok to your rack middleware stack, and the app will respond to GET /health with 200 OK.

For Rails

Insert this before at least ActionDispatch::SSL (enabled by config.force_ssl) to prevent request from being redirected.

# config/initializers/health_check.rb
Rails.configuration.middleware.insert(0, Rack::Ok)

For Rack

# config.ru
require 'rack/ok'
use Rack::Ok

Customization

Supports these options:

  • :body (default: "OK")
  • :path (default: "/health")
use(
  Rack::Ok,
  body: 'Custom response body',
  path: '/custom_ok_path',
)

Development

Setup

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Local installation

To install this gem onto your local machine, run bundle exec rake install.

Release

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/rack-ok.

Acknowledgements

This gem is heavily inspired by rack-health.

License

The gem is available as open source under the terms of the MIT License.

About

Rack middleware to return OK.

Resources

License

Stars

10 stars

Watchers

1 watching

Forks

Contributors