Authoreyes

Gem Version Build Status Dependency Status Code Climate Test Coverage Inline docs

Warning! This gem is an alpha!

Authoreyes (pronounced "authorize") is intended to be a modern, Rails 5 compatible replacement for Declarative Authorization.

Installation

Add this line to your application's Gemfile:

gem 'authoreyes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install authoreyes

Usage

For Rails authorization in Rails versions 4 and below, please use Declarative Authorization or one of its forks.

Warning! This gem is not finished! Although authorization functionality does work, you will need to do a few things to actually use it in your application...

At this point, to use Authoreyes, you must do the following:

  1. Add an authorization_rules.rb file. See the included one for an example.
  2. Define privileges for every single action you want to be accessed. As of now, Authoreyes has only one mode: authorize everything.

If you want to customize authorization behavior, in your ApplicationController override Authoreyes's redirect_if_unauthorized before_action and set_unauthorized_status_code after_action. See lib/authoreyes/helpers/in_controller for details.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tektite-software/authoreyes.

Please check out the wiki for guides on contributing to this project.

Acknowledgements

This gem was originally based on stffn's gem Declarative_Authorization. Many thanks to stffn and all who contributed to Declarative Authorization for a great gem!

License

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

:copyright: 2016 Tektite Software