module ActiveAdmin::BaseController::Authorization

Constants

ACTIONS_DICTIONARY

Protected Instance Methods

action_to_permission(action) click to toggle source

Converts a controller action into one of the correct Active Admin authorization names. Uses the ACTIONS_DICTIONARY to convert the action name to permission.

@param [String, Symbol] action The controller action name.

@return [Symbol] The permission name to use.

# File lib/active_admin/base_controller/authorization.rb, line 98
def action_to_permission(action)
  if action && action = action.to_sym
    Authorization::ACTIONS_DICTIONARY[action] || action
  end
end
active_admin_authorization() click to toggle source

Retrieve or instantiate the authorization instance for this resource

@return [ActiveAdmin::AuthorizationAdapter]

# File lib/active_admin/base_controller/authorization.rb, line 74
def active_admin_authorization
  @active_admin_authorization ||=
   active_admin_authorization_adapter.new active_admin_config, current_active_admin_user
end
active_admin_authorization_adapter() click to toggle source

Returns the class to be used as the authorization adapter

@return [Class]

# File lib/active_admin/base_controller/authorization.rb, line 82
def active_admin_authorization_adapter
  adapter = active_admin_namespace.authorization_adapter
  if adapter.is_a? String
    adapter.constantize
  else
    adapter
  end
end
authorize!(action, subject = nil) click to toggle source

Authorize the action and subject. Available in the controller as well as all the views. If the action is not allowd, it raises an ActiveAdmin::AccessDenied exception.

@param [Symbol] action The action to check if the user has permission

to perform on the subject.

@param [any] subject The subject that the user is trying to perform

the action on.

@return [Boolean] True if authorized, otherwise raises

an ActiveAdmin::AccessDenied.
# File lib/active_admin/base_controller/authorization.rb, line 54
def authorize!(action, subject = nil)
  unless authorized? action, subject
    raise ActiveAdmin::AccessDenied.new(
      current_active_admin_user,
      action,
      subject)
  end
end
authorize_resource!(resource) click to toggle source

Performs authorization on the resource using the current controller action as the permission action.

# File lib/active_admin/base_controller/authorization.rb, line 66
def authorize_resource!(resource)
  permission = action_to_permission(params[:action])
  authorize! permission, resource
end
authorized?(action, subject = nil) click to toggle source

Authorize the action and subject. Available in the controller as well as all the views.

@param [Symbol] action The action to check if the user has permission

to perform on the subject.

@param [any] subject The subject that the user is trying to perform

the action on.

@return [Boolean]

# File lib/active_admin/base_controller/authorization.rb, line 38
def authorized?(action, subject = nil)
  active_admin_authorization.authorized?(action, subject)
end
dispatch_active_admin_access_denied(exception) click to toggle source
# File lib/active_admin/base_controller/authorization.rb, line 104
def dispatch_active_admin_access_denied(exception)
  instance_exec(self, exception, &active_admin_namespace.on_unauthorized_access.to_proc)
end
redirect_backwards_or_to_root() click to toggle source
# File lib/active_admin/base_controller/authorization.rb, line 123
def redirect_backwards_or_to_root
  redirect_back fallback_location: active_admin_root
end
rescue_active_admin_access_denied(exception) click to toggle source
# File lib/active_admin/base_controller/authorization.rb, line 108
def rescue_active_admin_access_denied(exception)
  error = exception.message

  respond_to do |format|
    format.html do
      flash[:error] = error
      redirect_backwards_or_to_root
    end

    format.csv { render body: error, status: :unauthorized }
    format.json { render json: { error: error }, status: :unauthorized }
    format.xml { render xml: "<error>#{error}</error>", status: :unauthorized }
  end
end