0.01
No commit activity in last 3 years
No release in over 3 years
Private Rack middleware purpose is to protect your Rack application from anonymous via a secret code form.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

Rack::Private

Private Rack middleware purpose is to protect your Rack application from anonymous via a secret code form.

Installation

$ gem install rack-private

Usage

require 'rack-private'
use Rack::Private, :code => 'secret'

You can also define multiple codes.

use Rack::Private, :codes => ['secret', 'super-secret']

And provide your own template.

use Rack::Private, :code => 'secret', :template_path => Rails.root.join("app/templates/private.html")

You can specify exceptions, using strings or regular expressions

use Rack::Private, :code => 'secret', :except => ["public"]

This will allow access to any URL containing 'public'. If you want more control, use a regular expression:

use Rack::Private, :code => 'secret', :except => [/public$/]

This will only allow access to URLs that end in 'public'. You can use any expressions you want.

If you have a lot of exceptions, you can specify a block

use Rack::Private, :code => 'secret' do
  except /foo$/
  except 'public'
end

You can also specify a HTTP method in the block form

use Rack::Private, :code => 'secret' do
  except /foo$/, :method => 'post'
  except 'public', :method => :get
end

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Author

Thibaud Guillaume-Gentil