mdarby-restful_acl 1.2.1 → 2.0

data/README.textile

@@ -0,0 +1,173 @@
+h1. BIG CHANGES!
+
+RESTful_ACL has recently been overhauled (v2.0), please read this carefully for changes!
+
+h2. RESTful_ACL
+
+A Ruby on Rails plugin that provides fine grained access control through the MVC stack to RESTful resources in a Ruby on Rails 2.0+ application. Authorization is as simple as true or false.
+
+h3. What it does
+
+RESTful_ACL is a simple Access Control Layer for Ruby on Rails. It restricts access on a fine-grained level to any RESTful MVC stack. Every application is different and everyone likes to setup their User / Account / Role resources differently; this plugin will allow you to do your thing and keep that thing locked down.
+
+h3. Requirements
+
+RESTful_ACL requires the super amazing "RESTful_Authentication":https://github.com/technoweenie/restful-authentication plugin.
+
+h3. How to Install
+
+<pre>sudo gem install mdarby-restful_acl -s http://gems.github.com</pre>
+
+And add the gem to your environment.rb file as thus:
+<pre>
+# In environment.rb:
+config.gem "mdarby-restful_acl", :lib => 'restful_acl_controller'
+</pre>
+
+RESTful_ACL requires two named routes: "error" and "denied". Add the following to your routes.rb file:
+<pre>
+map.error '/error', :controller => '<some_controller>', :action => '<error_action>'
+map.denied '/denied', :controller => '<some_controller>', :action => '<denied_action>'
+</pre>
+
+h3. How to Use
+
+h4. Controllers
+
+Add this before_filter into any controller that you'd like to restrict access to (or application.rb for your entire app).
+<pre>before_filter :has_permission?</pre>
+
+h4. Models
+
+Define a parent resource (if one exists) by using the <b>my_mom</b> method, and define the following five methods in the model of every resource you'd like to restrict access to. The five methods can contain anything you'd like so long as they return a boolean true or false. This allows you to define your User's roles any way you wish. 
+
+<pre>
+  class Issue < ActiveRecord::Base
+    my_mom :some_model_name
+    
+    # This method checks permissions for the :index action
+    def self.is_indexable_by(user, parent = nil)
+      
+    end
+
+    # This method checks permissions for the :create and :new action
+    def self.is_creatable_by(user, parent = nil)
+
+    end
+
+    # This method checks permissions for the :show action
+    def is_readable_by(user, parent = nil)
+
+    end
+
+    # This method checks permissions for the :update and :edit action
+    def is_updatable_by(user, parent = nil)
+
+    end
+
+    # This method checks permissions for the :destroy action
+    def is_deletable_by(user, parent = nil)
+
+    end
+    
+  end
+</pre>
+
+H4. View Helpers
+
+There are five view helpers also included in RESTful_ACL: #indexable, #creatable, #readable, #updatable, and #deletable. These enable you to do nifty things like:
+<pre>
+<%= link_to ‘Foo Index’, foos_path if indexable %>
+<%= link_to 'Edit Foo', edit_foo_path(@foo) if updatable(@foo) %>
+<%= link_to 'Create Foo', new_foo_path if creatable %>
+<%= link_to 'View Foo', foo_path(@foo) if readable(@foo) %>
+<%= link_to 'Delete Foo', foo_path(@foo) if deletable(@foo), :method => :destroy %>
+</pre>
+
+h3. Huh? Here's an example
+
+Let's say that you have two resources: Project and Issue. A Project has many Issues, an Issue belongs to a Project. I'd like to make sure that the current user is a member of the Project before they can create a new Issue in that Project:
+
+<pre>
+  class Issue < ActiveRecord::Base
+    my_mom :project
+    
+    belongs_to :author
+    belongs_to :project
+
+    def self.is_indexable_by(user, parent = nil)
+      user.projects.include?(parent)
+    end
+  
+    def self.is_creatable_by(user, parent = nil)
+      user.projects.include?(parent)
+    end
+  
+    def is_updatable_by(user, parent = nil)
+      user == author && parent.is_active?
+    end
+
+    def is_deletable_by(user, parent = nil)
+      user == author
+    end
+
+    def is_readable_by(user, parent = nil)
+      user.projects.include?(parent)
+    end
+  end
+</pre>
+
+h3. Admins RULE!
+
+RESTful_ACL grants global access to all actions to site administrators. To enable this, make sure that your User model defines an "is_admin?" method *and/or* an 'is_admin' attribute. If the current_user.is_admin? returns true, access will be granted automatically.
+
+h3. How to Test
+
+I normally do something along these lines in RSpec:
+<pre>
+describe "Issue" do
+  before do
+    @project = mock_model(Project)
+    @author  = mock_model(User, :projects => [@project])
+    
+    @issue = Issue.factory_girl(:issue, :author => @author, :project => @project)
+  end
+
+  it "should be modifiable by the author when the Project is active" do
+    @project.stub!(:is_active? => true)
+    @issue.is_updatable_by(@author, @project).should be_true
+  end
+
+  it "should be deletable by the author" do
+    @issue.is_deletable_by(@author, @project).should be_true
+  end
+
+  it "should be readable by those assigned to the Project" do
+    Issue.is_readable_by(@author, @project).should be_true
+  end
+
+  it "should be creatable by those assigned to the Project" do
+    Issue.is_creatable_by(@author, @project).should be_true
+  end
+end
+</pre>
+
+h3. Caveats
+
+Polymorphic resources (Comments, Attachments, etc) are a bit iffy for obvious reasons.
+RESTful_ACL doesn't work with nested singleton resources. Wha? Yeah. Those are things in routes.rb like:
+
+<pre>
+# Note the singular forms in 'user.resource :profile'
+map.resources :users do |user|
+  user.resource :profile
+end
+</pre>
+
+In these situations I normally skip permission checking altogether as a Profile will always be mapped to the currently logged in User, regardless of the params[:user_id] passed in. You don't trust those either right? Good.
+
+h3. About the Author
+
+My name is Matt Darby. I'm a 29 year old professional Web Developer and IT Manager. I am the IT Manager and Lead Web Developer at "Dynamix Engineering":http://dynamix-ltd.com and hold a MSCS from "Franklin University":http://franklin.edu in Columbus, OH.
+
+Feel free to check out my "blog":http://blog.matt-darby.com or to "recommend me":http://www.workingwithrails.com/recommendation/new/person/10908-matt-darby

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/restful_acl_controller.rb

@@ -0,0 +1,71 @@
+module RestfulAclController
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send :include, ClassMethods
+  end
+
+  module ClassMethods
+
+    def has_permission?
+      return true if administrator?
+
+      begin
+        # Load the Model based on the controller name
+        klass = self.controller_name.classify.constantize
+
+        if params[:id]
+          # Load the object and possible parent requested
+          object = klass.find(params[:id])
+          parent = object.get_mom rescue nil
+        else
+          object = nil
+          parent = get_parent_from_request_uri(klass) if klass.has_parent?
+        end
+
+        # Let's let the Model decide what is acceptable
+        permission_denied unless case params[:action]
+          when "index"          then klass.is_indexable_by(current_user, parent)
+          when "new", "create"  then klass.is_creatable_by(current_user, parent)
+          when "show"           then object.is_readable_by(current_user, parent)
+          when "edit", "update" then object.is_updatable_by(current_user, parent)
+          when "destroy"        then object.is_deletable_by(current_user, parent)
+          else object.is_readable_by(current_user, parent)
+        end
+
+      rescue
+        # Failsafe: If any funny business is going on, log and redirect
+        routing_error
+      end
+    end
+
+    private
+
+      def get_parent_from_request_uri(child_klass)
+        parent_klass = child_klass.mom.to_s
+        bits         = request.request_uri.split('/')
+        parent_id    = bits.at(bits.index(parent_klass.pluralize) + 1)
+
+        parent_klass.classify.constantize.find(parent_id)
+      end
+
+      def administrator?
+        current_user.respond_to?("is_admin?") && current_user.is_admin?
+      end
+
+      def permission_denied
+        logger.info("[ACL] Permission denied to %s at %s for %s" %
+        [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
+
+        redirect_to denied_url
+      end
+
+      def routing_error
+        logger.info("[ACL] Routing error by %s at %s for %s" %
+        [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
+
+        redirect_to error_url
+      end
+
+  end
+end

data/lib/restful_acl_helper.rb

@@ -1,43 +1,53 @@
 module RestfulAclHelper
+  def indexable
+    return true if admin_enabled
+
+    parent = klass.mom rescue nil
+    klass.is_indexable_by(current_user, parent)
+  end
 
   def creatable
     return true if admin_enabled
-    
-    klass.is_creatable_by(current_user)
+
+    parent = klass.mom rescue nil
+    klass.is_creatable_by(current_user, parent)
   end
   alias_method :createable, :creatable
-  
-  
+
+
   def updatable(object)
     return true if admin_enabled
-    
-    object.is_updatable_by(current_user)
+
+    parent = object.get_mom rescue nil
+    object.is_updatable_by(current_user, parent)
   end
   alias_method :updateable, :updatable
-  
-  
+
+
   def deletable(object)
     return true if admin_enabled
-    
-    object.is_deletable_by(current_user)
+
+    parent = object.get_mom rescue nil
+    object.is_deletable_by(current_user, parent)
   end
   alias_method :deleteable, :deletable
-  
-  
-  def readable(object = nil)
+
+
+  def readable(object)
     return true if admin_enabled
-    
-    klass.is_readable_by(current_user, object)
-  end  
+
+    parent = object.get_mom rescue nil
+    object.is_readable_by(current_user, parent)
+  end
+
 
   private
-    
+
     def admin_enabled
       current_user.respond_to?("is_admin?") && current_user.is_admin?
     end
-    
+
     def klass
       params[:controller].classify.constantize
     end
-
-end
+end

data/lib/restful_acl_model.rb

@@ -0,0 +1,52 @@
+module RestfulAclModel
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send :include, ClassMethods
+  end
+
+  module ClassMethods
+    attr_accessor :mom
+
+    def my_mom(model)
+      self.mom = model
+      include RestfulAclModel::InstanceMethods
+    end
+
+    def has_parent?
+      !self.mom.nil?
+    end
+
+  end
+
+
+  module InstanceMethods
+
+    def get_mom
+      parent_klass.find(parent_id) if has_parent?
+    end
+
+    private
+
+      def klass
+        self.class
+      end
+
+      def mom
+        klass.mom
+      end
+
+      def has_parent?
+        !mom.nil?
+      end
+
+      def parent_klass
+        mom.to_s.classify.constantize
+      end
+
+      def parent_id
+        self.instance_eval("#{mom}_id")
+      end
+  end
+
+end

data/rails/init.rb

@@ -1,7 +1,9 @@
-require 'restful_acl'
+require 'restful_acl_controller'
 require 'restful_acl_helper'
+require 'restful_acl_model'
 
-ActionController::Base.send :include, RestfulAcl
+ActionController::Base.send :include, RestfulAclController
 ActionView::Base.send :include, RestfulAclHelper
+ActiveRecord::Base.send :include, RestfulAclModel
 
 RAILS_DEFAULT_LOGGER.debug "** [RESTful_ACL] loaded"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mdarby-restful_acl
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: "2.0"
 platform: ruby
 authors: 
 - Matt Darby
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-08 00:00:00 -08:00
+date: 2009-01-15 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: A Rails gem that provides fine grained access control to RESTful resources in a Rails 2.0+ project.
+description: A Rails gem that provides fine grained access control to RESTful resources in a Rails 2.0+ application.
 email: matt@matt-darby.com
 executables: []
 
@@ -23,16 +23,17 @@ extra_rdoc_files: []
 
 files: 
 - MIT-LICENSE
-- README
+- README.textile
 - Rakefile
 - init.rb
-- lib/restful_acl.rb
+- install.rb
+- lib/restful_acl_controller.rb
 - lib/restful_acl_helper.rb
+- lib/restful_acl_model.rb
 - rails/init.rb
-- tasks/restful_acl_tasks.rake
 - uninstall.rb
 has_rdoc: false
-homepage: http://github.com/mdarby/restful_acl/tree/master
+homepage: http://github.com/mdarby/restful_acl
 post_install_message: 
 rdoc_options: []
 

data/lib/restful_acl.rb

@@ -1,54 +0,0 @@
-module RestfulAcl
-  
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.send :include, ClassMethods
-  end
-  
-  module ClassMethods
-
-    def has_permission?
-      return true if current_user.respond_to?("is_admin?") && current_user.is_admin? # Admins rule.
-      
-      begin
-        # Load the Model based on the controller name
-        klass = self.controller_name.classify.constantize
-
-        # Load the object requested if the param[:id] exists
-        object = klass.find(params[:id]) unless params[:id].blank?
-        
-        # Let's let the Model decide what is acceptable
-        permission_denied unless case params[:action] 
-          when "index"          then klass.is_readable_by(current_user)
-          when "show"           then klass.is_readable_by(current_user, object)
-          when "edit", "update" then object.is_updatable_by(current_user)
-          when "new", "create"  then klass.is_creatable_by(current_user)
-          when "destroy"        then object.is_deletable_by(current_user)
-          else klass.is_readable_by(current_user)
-        end
-      
-      rescue
-        # Failsafe: If any funny business is going on, log and redirect
-        routing_error
-      end
-    end
-
-
-    private
-
-    def permission_denied
-      logger.info("[ACL] Permission denied to %s at %s for %s" %
-      [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
-  
-      redirect_to denied_url
-    end
-
-    def routing_error
-      logger.info("[ACL] Routing error by %s at %s for %s" %
-      [(logged_in? ? current_user.login : 'guest'), Time.now, request.request_uri])
-  
-      redirect_to error_url
-    end
-  
-  end
-end

data/tasks/restful_acl_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :restful_acl do
-#   # Task goes here
-# end