Sha256: a823dfe97644ffe9011f945d52e8182f8ae2e0bcc591856f9a9deb3f75f0ec11
Contents?: true
Size: 1.92 KB
Versions: 18
Compression:
Stored size: 1.92 KB
Contents
# TKH Authentication
This is a Rails engine which provides basic authentication. It is based on Railscasts 250 and 274.
Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful. It's primarily developed to work in sync with the tkh_cms gem suite but over time more and more effort will be made to make it work in isolation.
It's still in its infancy. Many improvements to come.
## Installation
For Rails 4.0.0 and above add this line to your application's Gemfile:
gem 'tkh_authentication', '~> 0.9'
For prior versions of Rails, use this:
gem 'tkh_authentication', '< 0.9'
And then execute:
$ bundle
Import migration and locale files
$ rake tkh_authentication:install
Run the migration
$ rake db:migrate
You need a root route in your app but most apps have that already.
And then of course restart your server!
$ rails s
Upon upgrading to a new version of the gem you might have to update the translation files
$ rails g tkh_authentication:create_or_update_locales -f
## Usage
A starting point could be:
$ /login
... and it should work out of the box.
To display the login information module anywhere in your views
render 'shared/login_info'
To restrict access to your controllers to logged in users:
before_filter :authenticate, except: 'show'
Additionally, if you want to restrict access to users whose admin boolean attribute is true, add this line just below the authenticate one.
before_filter :authenticate_with_admin, except: [ 'show', 'index' ]
## Contributing
Pull requests for new features and bug fixes are welcome.
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Create your failing tests based on the Test Unit framework.
4. Create your code which makes the tests pass.
5. Commit your changes (`git commit -am 'Added some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create new Pull Request
Version data entries
18 entries across 18 versions & 1 rubygems