Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

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

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.markdown
Octocat-spinner-32 Rakefile
Octocat-spinner-32 rack-private.gemspec
README.markdown

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

Something went wrong with that request. Please try again.