acts_as_authoritah 1.0.3 → 1.0.4

data/README.rdoc

@@ -1,13 +1,111 @@
 = acts_as_authoritah
 
-In config/environment.rb add 
-require 'acts_as_authoritah'
+INSTALLATION
 
-ActsAsAuthoritah::AccessRights::FileNotFound - if acl file is not found in the specified location
+gem install acts_as_authoritah
 
-include ActsAsAuthoritah in application.rb
+Rails 2.*
+Add in environemnt.rb
+  config.gem 'acts_as_authoritah'
 
-one file is mandatory - default.xls, or specify a :default =>
+Rails 3.*
+Add in Gemfile
+  gem 'acts_as_authoritah'
+
+= A sample blogging app.
+
+ - Creating blog posts.
+ - Editing blog posts.
+ - Commenting on blog posts.
+
+A blog post when first created will be in unpublished state. The post can be published later.
+
+User Roles and capabilities.
+
+- Author
+   He can create blog posts
+   He can edit posts
+   He can view blog posts
+   He cannot add comments
+- Registered user (who has signed up and logged-in)
+   He can view blog posts
+   He can comment on blog posts
+   He cannot create blog posts
+   He cannot edit blog posts
+- anonymous user 
+   He can view blog posts
+   He cannot add comments
+   He cannot create blog posts
+   He cannot edit blog posts
+- admin
+   unrestricted access to everything.
+
+
+When post is unpublished
+
+- Logged-in user (who has signed up)
+    He cannot comment on blog posts
+    He cannot view blog posts.
+
+
+= Getting this done with ActsAsAuthoritah
+
+1. Create an excel sheet (or download a sample https://github.com/bangthetable/acts_as_authoritah/blob/master/sample/default.xls)
+   and save it at config/acl/default.xls. When the post is unpublished, there are two rules which are different from the default set of rules.
+   We need to add these two rules alone in config/acl/unpublished.xls https://github.com/bangthetable/acts_as_authoritah/blob/master/sample/unpublished.xls
+
+2. Add the following line to your User model (or to whichever is your equivalent of User model)
+
+    acts_as_authoritah :acl_folder => File.join(RAILS_ROOT,"config","acl")
+
+3. Add 'include ActsAsAuthoritah' in ApplicationController
+
+4. ActsAsAuthoritah needs a wrapper around your 'current_user' method (name may differ based on the authentication system you use), to make it return an empty User object when
+   user is not logged in.
+
+   A sample - 
+
+     def present_user
+       current_user.to_s == "false" ? User.new : current_user
+     end
+
+5. In your User model, you need to define a 'usertype' method which should return the role of that user (same as in the first row of the spreadsheet).
+
+   A sample -
+
+     def usertype(args={})
+       return role.name if role
+       return "anonymous" if new_record?
+       return "registered"
+     end
+
+   Implementation of usertype method can vary, based on the role-system you are following. Just make sure it always returns role of the user (string), which should match with the roles
+   specified in the first row of the spreadsheet.
+
+
+6. in Post model
+
+     def status
+       published? ? nil : 'unpublished'
+     end
+
+   This will be used to let authoritah know when a post in in unpublished state, so that authoritah can override the default rules with those in unpublished.xls
+
+7. For access control of methods in PostController and CommentController, put these two files in lib/access_control/
+   https://github.com/bangthetable/acts_as_authoritah/blob/master/sample/comment_controller_access.rb
+   https://github.com/bangthetable/acts_as_authoritah/blob/master/sample/post_controller_access.rb
+
+8. To make sure that links are shown only to appropriate users, add lines like these in in the views.
+
+     <% if present_user.can_post_a_comment?(:context => @post.status) %>
+     <%= link_to 'Add a comment', {:controller => 'comment', :action => 'new', :post_id => @post.id} %>
+     <% end%>
+
+9. Thats all - your application is access controlled by ActsAsAuthoritah now.
+
+   - You can grant/revoke access to different features to different roles just by editing the spreadsheets.
+   - You can add a new user-role by adding a column in the spreadsheets.
+   - If your application needs to have one more context (say, archived posts), you can do that by adding one more spreadsheet called archived.xls.
 
 == Note on Patches/Pull Requests
  

data/acts_as_authoritah.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_authoritah}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["BangTheTable","Unnikrishnan KP"]

data/lib/acts_as_authoritah.rb

@@ -1,4 +1,5 @@
 require "active_record"
+require "active_support"
 require "spreadsheet"
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/acts_as_authoritah_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class ActsAsAuthoritahTest < Test::Unit::TestCase
   def test_responds_to_all_can_methods

data/test/test_helper.rb

@@ -4,13 +4,13 @@ require 'factory_girl'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'activerecord_test_connector' 
 require 'acts_as_authoritah'
+require 'activerecord_test_connector' 
 
 ActiveRecordTestConnector.setup
 
 #load users factory
-require 'test/factories/users'
+require_relative 'factories/users'
 
 class Test::Unit::TestCase
   protected

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_authoritah
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - BangTheTable
@@ -21,18 +15,14 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: spreadsheet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id001
+    version: 
 description: role based access rights for a user specified via spreadsheet
 email: devteam@bangthetable.com, unni.tallman@gmail.com
 executables: []
@@ -68,27 +58,21 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: role based access rights for a user specified via spreadsheet