rubygems | ruby-toolbox |
Rails 4
Stabile, tested, configurable. I like it ;)
gem "the_role", "~> 2.0.0"
Rails 3
First prototype. Not recommended for use.
gem "the_role", "1.7.0"
TheRole in contrast to CanCan has simple and predefined way to find access state for current role. If you didn't want to create your own role scheme with CanCan Abilities - TheRole can be great solution for your.
You can manage roles with simple UI. TheRole's ACL structure inspired by Rails controllers, that is why it's so great for Rails application.
TheRole management web interface => localhost:3000/admin/roles |
![]() |
# Optional for UI.
# You can use any Bootstrap version (CSS, LESS, SCSS)
# See required components below
gem 'bootstrap-sass', '~> 2.3.1.0'
gem "the_role", "~> 2.0.0"
bundle
Add role_id:integer field to your User Model
def self.up
create_table :users do |t|
t.string :login, :null => false
t.string :email, :default => nil
t.string :crypted_password, :default => nil
t.string :salt, :default => nil
# TheRole field
t.integer :role_id, :default => nil
t.timestamps
end
end
Generate Role model
rails g model role --migration=false
Change your Role model
class Role < ActiveRecord::Base
include RoleModel
end
install TheRole migrations
rake the_role_engine:install:migrations
rake db:create && rake db:migrate
bin/rails c
role = Role.new
role.name = "admin"
role.title = "role for admin"
role.description = "this user can do anything"
role.save
role.create_rule(:system, :administrator)
role.rule_on(:system, :administrator)
role.admin? # => true
User.first.update( role: Role.with_name(:admin) )
include TheRoleController in your Application controller
Define aliases method for correctly work TheRole's controllers
class ApplicationController < ActionController::Base
include TheRoleController
protect_from_forgery
# your Access Denied processor
def access_denied
return render(text: 'access_denied: requires an role')
end
# 1) LOGIN_REQUIRE => authenticate_user! for Devise
# 2) LOGIN_REQUIRE => require_login for Sorcery
alias_method :login_required, :LOGIN_REQUIRE
alias_method :role_access_denied, :access_denied
end
class PagesController < ApplicationController
before_filter :login_required, :except => [:index, :show]
before_filter :role_required, :except => [:index, :show]
before_filter :find_page, :only => [:edit, :update, :destroy]
before_filter :owner_required, :only => [:edit, :update, :destroy]
private
def find_page
@page = Page.find params[:id]
# TheRole: You should define OWNER CHECK OBJECT
# When editable object was found
# You should to define @owner_check_object before invoke of **owner_required** method
@owner_check_object = @page
end
end
config/initializers/the_role.rb
TheRole.configure do |config|
config.layout = :application
config.default_user_role = :user
end
Bootstrap components
app/assets/stylesheets/the_role/bootstrap_components.css.scss
@import "bootstrap/variables";
@import "bootstrap/mixins";
@import "bootstrap/reset";
@import "bootstrap/scaffolding";
@import "bootstrap/grid";
@import "bootstrap/layouts";
@import "bootstrap/navs";
@import "bootstrap/wells";
@import "bootstrap/forms";
@import "bootstrap/close";
@import "bootstrap/tables";
@import "bootstrap/navbar";
@import "bootstrap/dropdowns";
@import "bootstrap/alerts";
@import "bootstrap/buttons";
@import "bootstrap/button-groups";
application.css
//= require the_role/bootstrap_components
//= require the_role
<% if @user.has_role?(:twitter, :button) %>
Twitter Button is Here
<% else %>
Nothing here :(
<% end %>
Administrator it's a user who can access any section and the rules of your application.
Administrator is the owner of any objects in your application.
Administrator it's a user, which has virtual section system and rule administrator in the role-hash.
admin_role_fragment = {
:system => {
:administrator => true
}
}
Moderator it's a user, which has access to any actions of some section(s).
Moderator is's owner of any objects of some class.
Moderator it's a user, which has a virtual section moderator, with section name as rule name.
There is Moderator of Pages (controller) and Twitter (virtual section)
moderator_role_fragment = {
:moderator => {
:pages => true,
:blogs => false,
:twitter => true
}
}
Administrator is owner of any object in system.
Moderator of pages is owner of any page.
User is owner of object, when Object#user_id == User#id.
Semantic - the science of meaning. Human should fast to understand what is happening in a role system.
Look at next Role hash. If you can understand access rules - this authorization system is semantically.
role = {
'pages' => {
'index' => true,
'show' => true,
'new' => false,
'edit' => false,
'update' => false,
'destroy' => false
},
'articles' => {
'index' => true,
'show' => true
},
'twitter' => {
'button' => true,
'follow' => false
}
}
Usually, we use real names of controllers and actions for names of sections and rules:
current_user.has_role?(:pages, :show)
But, also, you can use virtual names of sections, and virtual names of section's rules.
current_user.has_role?(:twitter, :button)
current_user.has_role?(:facebook, :like)
And you can use them as well as other access rules.
Has a user an access to rule of section (action of controller)?
current_user.has_role?(:pages, :show) => true | false
current_user.has_role?(:blogs, :new) => true | false
current_user.has_role?(:articles, :edit) => true | false
Is it Moderator?
current_user.moderator?(:pages) => true | false
current_user.moderator?(:blogs) => true | false
current_user.moderator?(:articles) => true | false
Is it Administrator?
current_user.admin? => true | false
Is it Owner of object?
current_user.owner?(@page) => true | false
current_user.owner?(@blog) => true | false
current_user.owner?(@article) => true | false
# User's role
@role = current_user.role
# Find a Role by name
@role = Role.find_by_name(:user)
@role.has?(:pages, :show) => true | false
@role.moderator?(:pages) => true | false
@role.admin? => true | false
# Create a section of rules
@role.create_section(:pages)
# Create rule in section (false value by default)
@role.create_rule(:pages, :index)
@role.to_hash => Hash
# JSON string
@role.to_json => String
# JSON string
@role.to_s => String
# check method
@role.has_section?(:pages) => true | false
# check method
@role.has_rule?(:pages, :index) => true | false
# Incoming hash is true-mask-hash
# All rules of Role will be reset to false
# Only rules from true-mask-hash will be set on true
new_role_hash = {
:pages => {
:index => true,
:show => true
}
}
@role.update_role(new_role_hash)
# set this rule on true
@role.rule_on(:pages, :index)
# set this rule on false
@role.rule_off(:pages, :index)
# delete a section
@role.delete_section(:pages)
# delete rule in section
@role.delete_rule(:pages, :show)
- 2.0.0 - Rails 4 ready, configurable, tests
- 1.7.0 - mass assignment for User#role_id, doc, locales, changes in test app
- 1.6.9 - assets precompile addon
- 1.6.8 - doc, re dependencies
- 1.6.7 - Es locale (beta 0.2)
- 1.6.6 - Ru locale, localization (beta 0.1)
- 1.6.5 - has_section?, fixes, tests (alpha 0.3)
- 1.6.4 - En locale (alpha 0.2)
- 1.6.3 - notifications
- 1.6.0 - stabile release (alpha 0.1)
Ru, En (by me)
Es by @igmarin
zh_CN by @doabit & @linjunpop
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.