Module: SimpleAccessControl

Defined in:
lib/simple_access_control.rb,
lib/simple_access_control/version.rb,
lib/simple_access_control/access_control_handler.rb

Defined Under Namespace

Modules: ClassMethods Classes: AccessControlHandler

Constant Summary collapse

VERSION = 
"1.0"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



6
7
8
9
10
11
12
13
 
# File 'lib/simple_access_control.rb', line 6

def self.included(base)
  base.extend(ClassMethods)
  if base.respond_to?(:helper_method)
    base.send :helper_method, :restrict_to
    base.send :helper_method, :has_permission?
    base.send :helper_method, :permit?
  end
end

Instance Method Details

#access_controller ⇒ Object

:nodoc:



71
72
73
 
# File 'lib/simple_access_control.rb', line 71

def access_controller #:nodoc:
  @access_controller ||= AccessControlHandler.new
end

#has_permission?(rule, user = nil) ⇒ Boolean

For use in both controllers and views.

Check if a role has permission?

has_permission?('role')
has_permission?('admin', other_user)

Returns:

  • (Boolean) —

    Boolean



53
54
55
56
 
# File 'lib/simple_access_control.rb', line 53

def has_permission?(rule, user = nil)
  user ||= (send(:current_user) if respond_to?(:current_user, true)) || nil
  access_controller.process(rule, user)
end

#permission_required(rule = nil) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/simple_access_control.rb', line 35

def permission_required(rule = nil)
  if respond_to?(:logged_in?, true) && logged_in? && has_permission?(rule)
    send(:permission_granted) if respond_to?(:permission_granted)
    true
  else
    send(:permission_denied) if respond_to?(:permission_denied)
    false
  end
end

#permit?(rule, context = {}) ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/simple_access_control.rb', line 58

def permit?(rule, context = {})
  has_permission?(rule, (context && context[:user] ? context[:user] : nil))
end

#restrict_to(rule, user = nil) ⇒ Object

Execute a code block ONLY if the user has access

restrict_to "admin | moderator" do
  link_to "foo"
end



67
68
69
 
# File 'lib/simple_access_control.rb', line 67

def restrict_to(rule, user = nil)
  yield if block_given? && has_permission?(rule, user)
end