Module: Allowy::AccessControl

Extended by:
ActiveSupport::Concern
Defined in:
lib/allowy/access_control.rb

Overview

This module provides the interface for implementing the access control actions. In order to use it, mix it into a plain Ruby class and define methods ending with ‘?`. For example:

@example
class PageAccess
  include Allowy::AccessControl

  def view?(page)
    page and page.wiki? and context.user_signed_in?
  end
end

And then you can check the permissions from a controller:

@example
def show
  @page = Page.find params[:id]
  authorize! :view, @page
end

You can also check the permissions outside of the controller, but you need an object that includes ‘Allowy::Context` class:

@example
class CucumberContext
  include Allowy::Context
  attr_accessor :current_user

  def initialize(user)
    @current_user = user
  end
end

CucumberContext.new(that_user).can?(:create, Blog)
CucumberContext.new(that_user).should be_able_to :create, Blog

Instance Method Summary collapse

Instance Method Details

#authorize!(*args) ⇒ Object

Raises:



60
61
62
 
# File 'lib/allowy/access_control.rb', line 60

def authorize!(*args)
  raise AccessDenied.new("Not authorized", args.first, args[1]) unless can?(*args)
end

#can?(action, *args) ⇒ Boolean

Returns:

  • (Boolean)

Raises:



50
51
52
53
54
 
# File 'lib/allowy/access_control.rb', line 50

def can?(action, *args)
  m = "#{action}?"
  raise UndefinedAction.new("The #{self.class.name} needs to have #{m} method. Please define it.") unless self.respond_to? m
  send(m, *args)
end

#cannot?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/allowy/access_control.rb', line 56

def cannot?(*args)
  not can?(*args)
end

#initialize(ctx) ⇒ Object 



46
47
48
 
# File 'lib/allowy/access_control.rb', line 46

def initialize(ctx)
  @context = ctx
end