lib/authority/controller.rb in authority-0.9.0 vs lib/authority/controller.rb in authority-1.0.0.pre2

@@ -1,39 +1,59 @@
 module Authority
   module Controller
+
+    # Gets included into the app's controllers automatically by the railtie
+
     extend ActiveSupport::Concern
 
     included do
       rescue_from Authority::SecurityTransgression, :with => :authority_forbidden
       class_attribute :authority_resource
-      class_attribute :authority_actions
+      class_attribute :controller_action_map
     end
 
     module ClassMethods
-      def check_authorization_on(model_class, options = {})
+
+      # Sets up before_filter to ensure user is allowed to perform a given controller action
+      #
+      # @param [Class] model_class - class whose authorizer should be consulted
+      # @param [Hash] options - can contain :actions to be merged with existing
+      # ones and any other options applicable to a before_filter
+      def authorize_actions_on(model_class, options = {})
         self.authority_resource = model_class
-        self.authority_actions  = Authority.configuration.authority_actions.merge(options[:actions] || {}).symbolize_keys
+        self.controller_action_map = Authority.configuration.controller_action_map.merge(options[:actions] || {}).symbolize_keys
         before_filter :run_authorization_check, options
       end
 
+      # Allows defining and overriding a controller's map of its actions to the model's authorizer methods
+      #
+      # @param [Hash] action_map - controller actions and methods, to be merged with existing action_map
       def authority_action(action_map)
-        self.authority_actions.merge!(action_map).symbolize_keys
+        self.controller_action_map.merge!(action_map).symbolize_keys
       end
     end
 
     protected
 
+    # Renders a static file to minimize the chances of further errors.
+    #
+    # @param [Exception] error, an error that indicates the user tried to perform a forbidden action. 
     def authority_forbidden(error)
       Authority.configuration.logger.warn(error.message)
       render :file => Rails.root.join('public', '403.html'), :status => 403, :layout => false
     end
 
     def run_authorization_check
-      check_authorization_for self.class.authority_resource, send(Authority.configuration.user_method)
+      authorize_action_on self.class.authority_resource, send(Authority.configuration.user_method)
     end
 
-    def check_authorization_for(authority_resource, user)
-      authority_action = self.class.authority_actions[action_name.to_sym]
+    # To be run in a before_filter; ensure this controller action is allowed for the user
+    #
+    # @param authority_resource [Class], the model class associated with this controller
+    # @param user, object representing the current user of the application
+    # @raise [MissingAction] if controller action isn't a key in `config.controller_action_map`
+    def authorize_action_on(authority_resource, user)
+      authority_action = self.class.controller_action_map[action_name.to_sym]
       if authority_action.nil?
         raise MissingAction.new("No authority action defined for #{action_name}")
       end
       Authority.enforce(authority_action, authority_resource, user)
     end