authority_success logging

lib/authority/configuration.rb

@@ -3,7 +3,7 @@ class Configuration
 
     # Has default settings, which can be overridden in the initializer.
 
-    attr_accessor :abilities, :controller_action_map, :user_method, :security_violation_handler, :logger
+    attr_accessor :abilities, :controller_action_map, :user_method, :security_violation_handler, :logger, :log_success
 
     def initialize
 

lib/authority/controller.rb

@@ -133,6 +133,10 @@ def authorize_action_for(authority_resource, *options)
       end
 
       Authority.enforce(authority_action, authority_resource, authority_user, *options)
+
+      # This method is always invoked, but will only log if it's enabled
+      authority_success(authority_user, authority_action, authority_resource)
+
       self.authorization_performed = true
     end
 
@@ -144,6 +148,15 @@ def authority_forbidden(error)
       render :file => Rails.root.join('public', '403.html'), :status => 403, :layout => false
     end
 
+    # Log successful authorization attempt if enabled in the authority configuration.
+    #
+    # This method can be overloaded inside the application controller, similar to authority_forbidden.
+    def authority_success(user, action, resource)
+      if Authority.configuration.log_success
+        Authority.logger.info("#{user} successfully performed the #{action} action to this resource: #{resource}")
+      end
+    end
+
     private
 
     # The `before_filter` that will be setup to run when the class method

spec/authority/controller_spec.rb

@@ -430,6 +430,24 @@ def self.before_action(*args) ; end
 
       end
 
+      describe "authority_success action" do
+
+        it "logs an info if enabled" do
+          Authority.configuration.log_success = true
+
+          expect(Authority.logger).to receive(:info)
+          controller_instance.send(:authority_success, "a", "b", "c")
+        end
+
+        it "does not log anything if disabled" do
+          Authority.configuration.log_success = false
+
+          expect(Authority.logger).not_to receive(:info)
+          controller_instance.send(:authority_success, "a", "b", "c")
+        end
+
+      end
+
     end
 
   end