may_may 0.0.2 → 0.0.3

data/README.md

@@ -19,7 +19,6 @@ Simplify your views. Show/hide view elements based on intended action instead of
       <%= link_to 'only visible if user may edit people', edit_people_path %>
     <% end %>
 
-### 
 ### Create a model named "may":
 
     # in app/models/may.rb
@@ -38,7 +37,7 @@ Simplify your views. Show/hide view elements based on intended action instead of
       end
     end
 
-### Add a current_roles method to your ApplicationController:
+### Add a role_names method to your User object
 
 Here is a simple example setup:
 
@@ -59,13 +58,22 @@ Here is a simple example setup:
     class User
       has_many :user_roles
       has_many :roles, through: :user_roles
+
+      def role_names
+        roles.map {|role| role.name.to_sym }
+      end
     end
 
     # in app/controllers/application_controller.rb
 
     class ApplicationController < ActionController::Base
-      def current_roles
-        current_user.roles.map {|role| role.name.to_sym }
+      def current_user
+        @current_user ||= User.find(session[:user_id]) rescue nil
+      end
+
+      def current_user=(value)
+        value ? session[:user_id] = value.id : session.delete(:id)
+        @current_user = value
       end
     end
 
@@ -80,6 +88,36 @@ You could instead define permissions within the controller itself:
       may :show, method: [:may_show?]
     end
 
+## In more depth
+
+MayMay adds a few methods to ActionController::Base:
+
+*** `may` (class method)  
+
+Define permissions in your controller instead of May model. Shortcut for `May.may(self, ...)`  
+
+Usage:
+
+    class SomeController < ApplicationController
+      may :index, except: [:this_role]
+    end
+
+*** `current_roles`  
+
+Returns `current_user.role_names` or empty array if `current_user` returns nil or is missing
+
+*** `has_role?`  
+
+Check `current_roles` for a specific role.  
+
+Usage: if `has_role? :some_role`
+
+*** may? (helper method)  
+
+Check for permission to perform an action.  
+
+Usage: if `may? :action_name, :controller_name`
+
 ## Licence
 
 MIT-LICENSE

data/lib/may_may.rb

@@ -65,7 +65,31 @@ module MayMay
 
     def access_denied
       response.status = 403
-      render :text => 'Access Denied'
+      if Rails.env == 'development'
+        render_text = "Permission denied to action :#{params[:action]} on controller :#{params[:controller]}"
+        if May.respond_to? get_permission_method
+          render text: render_text
+        else
+          render_text = '<h1>' + render_text + '</h1>' + %{
+            <p>Controller action permission needs to be specified in your May model. Example:</p>
+
+            <pre>
+            # in app/models/may.rb:
+
+            class May
+              controller: :#{params[:controller]} do
+                may :#{params[:action]}, only: [:role_1, :role_2]
+              end
+            end
+            </pre>
+
+            <p>For more detailed information, view the <a href="https://github.com/without/may_may/blob/master/README.md">MayMay gem's README.md</a></p>
+          }
+          render layout: false, inline: render_text
+        end
+      else
+        render text: "Access Denied."
+      end
     end
 
     def current_roles
@@ -83,9 +107,13 @@ module MayMay
 
     private
 
+    def get_permission_method
+      May.get_permission_method params[:action], params[:controller].to_s.pluralize.to_sym
+    end
+
     def may_may_setup
-      May.permissions_setup
-      access_denied unless May.permission_to? params[:action], params[:controller].to_s.pluralize.to_sym, self
+      method = get_permission_method
+      access_denied unless May.respond_to?(method) && May.send(get_permission_method, self)
     end
   end
 

data/lib/may_may/version.rb

@@ -1,3 +1,3 @@
 module MayMay
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/dummy/log/test.log

@@ -5026,3 +5026,320 @@ Completed 200 OK in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.4ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"admin"}
+  Rendered text template (0.0ms)
+Completed 200 OK in 375ms (Views: 72.0ms | ActiveRecord: 7.1ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Completed 200 OK in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 2ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#index as HTML
+  Parameters: {"user"=>"guest"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"guest"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"guest", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"admin"}
+Completed 200 OK in 18ms (Views: 17.2ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 3ms (Views: 0.5ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"standard"}
+Completed 200 OK in 1ms (Views: 0.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"admin"}
+  Rendered text template (0.0ms)
+Completed 200 OK in 191ms (Views: 60.5ms | ActiveRecord: 5.7ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Completed 200 OK in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#index as HTML
+  Parameters: {"user"=>"guest"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"guest"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"guest", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"admin"}
+Completed 200 OK in 19ms (Views: 17.6ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 2ms (Views: 0.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"standard"}
+Completed 200 OK in 2ms (Views: 0.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"admin"}
+  Rendered text template (0.0ms)
+Completed 200 OK in 206ms (Views: 34.5ms | ActiveRecord: 6.5ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Completed 200 OK in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 2ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#index as HTML
+  Parameters: {"user"=>"guest"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"guest"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.1ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"guest", "id"=>"1"}
+Completed 200 OK in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"admin"}
+Completed 200 OK in 13ms (Views: 11.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"standard"}
+Completed 200 OK in 2ms (Views: 0.9ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"admin"}
+  Rendered text template (0.0ms)
+Completed 200 OK in 229ms (Views: 93.5ms | ActiveRecord: 5.5ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Completed 200 OK in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"admin", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#index as HTML
+  Parameters: {"user"=>"guest"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#create as HTML
+  Parameters: {"user"=>"guest"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"guest", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"admin"}
+Completed 200 OK in 13ms (Views: 11.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#destroy as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Filter chain halted as :may_may_setup rendered or redirected
+Completed 403 Forbidden in 2ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#new as HTML
+  Parameters: {"user"=>"standard"}
+Completed 200 OK in 1ms (Views: 0.3ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by MayMaysController#show as HTML
+  Parameters: {"user"=>"standard", "id"=>"1"}
+Completed 200 OK in 1ms (Views: 0.2ms | ActiveRecord: 0.0ms)
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/may_may_test.rb

@@ -20,24 +20,23 @@ end
 
 class MayMayTest < ActiveSupport::TestCase
   test "access_denied if not specifically permitted" do
-    May.permissions_setup {}
     assert !May.permission_to?(:test_1_action, :people, Roles.new)
   end
 
   test "access allowed for anyone if named but no roles specified" do
-    May.permissions_setup { controller(:people) { may :test_2_action } }
+    May.controller(:people) { May.may :test_2_action }
     assert May.permission_to?(:test_2_action, :people, Roles.new)
   end
 
   test "access allowed for specified role only" do
-    May.permissions_setup { controller(:people) { may :test_3_action, :only => :a_role } }
+    May.controller(:people) { May.may :test_3_action, :only => :a_role }
     with_correct_role = May.permission_to?(:test_3_action, :people, Roles.new(:a_role))
     without_correct_role = May.permission_to?(:test_3_action, :people, Roles.new(:b_role))
     assert_equal [true, false], [with_correct_role, without_correct_role]
   end
 
   test "access allowed for specified roles" do
-    May.permissions_setup { controller(:people) { may :test_4_action, :only => [:a_role1, :a_role2] } }
+    May.controller(:people) { May.may :test_4_action, :only => [:a_role1, :a_role2] }
     with_first_role = May.permission_to?(:test_4_action, :people, Roles.new(:a_role1))
     with_second_role = May.permission_to?(:test_4_action, :people, Roles.new(:a_role2))
     with_both_roles = May.permission_to?(:test_4_action, :people, Roles.new([:a_role1, :a_role2]))
@@ -46,7 +45,7 @@ class MayMayTest < ActiveSupport::TestCase
   end
 
   test "access denied for specified roles" do
-    May.permissions_setup { controller(:people) { may :test_5_action, :except => [:a_role1, :a_role2] } }
+    May.controller(:people) { May.may :test_5_action, :except => [:a_role1, :a_role2] }
     with_first_role = May.permission_to?(:test_5_action, :people, Roles.new(:a_role1))
     with_second_role = May.permission_to?(:test_5_action, :people, Roles.new(:a_role2))
     with_both_roles = May.permission_to?(:test_5_action, :people, Roles.new([:a_role1, :a_role2]))
@@ -55,24 +54,24 @@ class MayMayTest < ActiveSupport::TestCase
   end
 
   test "access denied by block" do
-    May.permissions_setup { controller(:people) { may(:test_6_action) {|controller| false } } }
+    May.controller(:people) { May.may(:test_6_action) {|controller| false } }
     assert !May.permission_to?(:test_6_action, :people, Roles.new)
   end
 
   test "access allowed by block" do
-    May.permissions_setup { controller(:people) { may(:test_7_action) {|controller| true } } }
+    May.controller(:people) { May.may(:test_7_action) {|controller| true } }
     assert May.permission_to?(:test_7_action, :people, Roles.new)
   end
 
   test "controller may method works" do
-    May.permissions_setup { controller(:people) { may(:test_8_action, :only => [:a_role]) } }
+    May.controller(:people) { May.may(:test_8_action, :only => [:a_role]) }
     with_role = Roles.new(:a_role).may?(:test_8_action, :people)
     without_role = Roles.new.may?(:test_8_action, :people)
     assert_equal [true, false], [with_role, without_role]
   end
 
   test "controller may method with block" do
-    May.permissions_setup { controller(:people) { may(:test_9_action, :only => [:a_role]) } }
+    May.controller(:people) { May.may(:test_9_action, :only => [:a_role]) }
     with_role = false
     Roles.new(:a_role).may?(:test_9_action, :people) { with_role = 'allowed!' }
     without_role = Roles.new.may?(:test_9_action, :people) { without_role = 'not allowed!' }
@@ -81,7 +80,7 @@ class MayMayTest < ActiveSupport::TestCase
 
   test "controller may with permission block" do
     can = true
-    May.permissions_setup {controller(:people) { may(:test_10_action) { can } } }
+    May.controller(:people) { May.may(:test_10_action) { can } }
     should = false
     Roles.new.may?(:test_10_action, :people) { should = 'allowed!' }
     can = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: may_may
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: