README.md

RailsAdminPundit

RailsAdmin integration with Pundit authorization system

Installation

Add this line to your application's Gemfile:

gem "rails_admin_pundit", :github => "sudosu/rails_admin_pundit"

And then execute:

$ bundle

Usage

1. First of all you need to configure Pundit (if you configured it already, skip this step). Include Pundit in your application controller:

   class ApplicationController < ActionController::Base
     include Pundit
     protect_from_forgery
   end

   Run the generator, which will set up an application policy:

   rails g pundit:install

   For other configurations see Pundit's readme.

2. In your app/policies/application_policy.rb policy you need to add rails_admin? method:

   class ApplicationPolicy
     ......
     def rails_admin?(action)
       case action
         when :dashboard
           user.admin?
         when :index
           user.admin?
         when :show
           user.admin?
         when :new
           user.admin?
         when :edit
           user.admin?
         when :destroy
           user.admin?
         when :export
           user.admin?
         when :history
           user.admin?
         when :show_in_app
           user.admin?
         else
           raise ::Pundit::NotDefinedError, "unable to find policy #{action} for #{record}."
       end
     end
   
     # Hash of initial attributes for :new, :create and :update actions. This is optional
     def attributes_for(action)
     end
   
   end

   Set pundit authorize method in config/initializers/rails_admin.rb initializer:

   RailsAdmin.config do |config|
     ## == Pundit ==
     config.authorize_with :pundit
   
     ## == method to call for current_user ==
     config.current_user_method(&:current_user)
     ......
   end

   Now, in your model's policy you can specify a policy for rails_admin actions. For example:

   class CityPolicy < ApplicationPolicy
     ......
     def rails_admin?(action)
       case action
         when :destroy, :new
           false
         else
           super
       end
     end
   end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

Licensed under the MIT license, see the separate LICENSE.txt file.