simple_acl 1.0.0 → 1.0.1

data/README.md

@@ -1,10 +1,8 @@
-# SimpleAcl
-
-[![Build Status](https://travis-ci.org/ifeelgoods/simple_acl.png?branch=master)](https://travis-ci.org/ifeelgoods/simple_acl)
+# SimpleAcl [![Gem Version](https://badge.fury.io/rb/simple_acl.png)](http://badge.fury.io/rb/simple_acl) [![Build Status](https://travis-ci.org/ifeelgoods/simple_acl.png?branch=master)](https://travis-ci.org/ifeelgoods/simple_acl) [![Coverage Status](https://coveralls.io/repos/ifeelgoods/simple_acl/badge.png?branch=master)](https://coveralls.io/r/ifeelgoods/simple_acl?branch=master) [![Code Climate](https://codeclimate.com/github/ifeelgoods/simple_acl.png)](https://codeclimate.com/github/ifeelgoods/simple_acl)
 
 This gem eases the implementation of ACL in Ruby (especially Rails).
 
-All access are refused is only rule by default.
+All access are refused : the only default rule.
 
 ## Installation
 
@@ -18,17 +16,19 @@ And then execute:
 
 ## Usage
 
-You need to include the main module:
+Include the main module:
 
 `include SimpleAcl`
 
 SimpleAcl need 3 variables:
-- the action : by default use `params[:action]` if available, nil otherwise
-- the role : by default use method `current_role` if available, nil otherwise
-- optional values for custom assertion : by default use `params` if available, nil otherwise
+- the action : by default `params[:action]` if available, nil otherwise
+- the role : by default `current_role` if available, nil otherwise
+- optional values for custom assertion : by default `params` if available, nil otherwise
 
-You can manually define these by using following methods in the controller:
-`acl_current_role=` `acl_action=` `acl_values=`
+You can manually define these by using following instance methods:
+* `acl_current_role=`
+* `acl_action=`
+* `acl_values=`
 
 Use the following before_filter to check ACL before the
 execution of the code in the action.
@@ -37,13 +37,25 @@ execution of the code in the action.
   before_filter :do_acl
 ```
 
-## Configuration
+When the access is refused to a given role, an `ExceptionUnauthorized`
+exception will be raised.
+Catch it to render/do whatever you want in this case (exemple with Rails):
+
+```ruby
+rescue_from ExceptionUnauthorized do
+  # render 403
+end
+```
+
+### Define yours ACL
 
 To configure the ability of a role you can use:
 
-`acl_user, acl_admin, acl_guest`
+* `acl_user`
+* `acl_admin`
+* `acl_guest`
 
-or the basic method `acl_role` with which you need to specify the role.
+Or the basic method `acl_role` with which you need to specify the role.
 
 The key `privileges` must be a hash of assertions.
 The key `inherit` must be the symbol of previous defined role.
@@ -64,17 +76,36 @@ Example:
     acl_role(:guest, show: true)
 ```
 
-If the role trying to access to the resource is not allowed a ExceptionUnauthorized
-exception will be raised.
-Catch it to render/do whatever you want in this case:
+### Define assertions in your ACL
+
+An assertion has to return `TrueClass` or `FalseClass`.
+(other values will have same effect than a `FalseClass`)
+
+You can also use lambda to write advanced assertion.
+The two parameters `current_role` and `values` are passed to the lambda,
+you can use these for your assertion.
+
+Example:
 
 ```ruby
-rescue_from ExceptionUnauthorized do
-  # render 403
-end
+  acl_guest privileges: {
+      show: lambda{|current_role, values| YourModel.find(values[:id]).guest_access?},
+  }
+
 ```
 
-In an initializers, you can specify the role you want to use.
+If you have values containing `params` and your user model `current_user`
+
+```ruby
+  acl_user privileges: {
+      update: lambda{|current_role, values| values[:current_user].profile_id == values[:params][:id]},
+  }
+
+```
+
+## Configuration
+
+In an initializer, you can specify the role you want to use.
 (defaults are :admin, :user, :guest)
 
 ```
@@ -93,3 +124,4 @@ SimpleAcl::Configuration.authorized_roles = [:admin, :user]
 Inspired from `racl-rails` and `racl`.
 https://github.com/ifeelgoods/racl/
 https://github.com/ifeelgoods/racl-rails/
+

data/lib/simple_acl.rb

@@ -28,9 +28,6 @@ module SimpleAcl
       acl.configuration.add_role(role, privileges)
     end
 
-    def acl_to_json
-      acl.configuration.acl_privileges.to_json
-    end
   end
 
   # @param values used for custom lambda assertion
@@ -65,7 +62,7 @@ module SimpleAcl
     return Acl.unauthorized unless self.class.acl
 
     begin
-      self.class.acl.check_acl(acl_current_role, params[:action], acl_values)
+      self.class.acl.check_acl(acl_current_role, acl_action, acl_values)
     ensure
       # in case of Thread,current is not cleaned
       Thread.current[:acl_action] = nil

data/lib/simple_acl/configuration.rb

@@ -17,10 +17,8 @@ module SimpleAcl
 
     def add_role(role, privileges)
       raise ExceptionConfiguration, ExceptionConfiguration, "Unauthorized role #{role}" unless self.class.authorized_roles.include?(role)
-      privileges.keys.each do |configuration_key|
-        raise ExceptionConfiguration, "Unknow configuration key #{configuration_key}" unless [:privileges, :inherit].include?(configuration_key)
-      end
-      raise ExceptionConfiguration, 'Inherit specified is not defined previously' if privileges[:inherit] && !@acl_privileges[privileges[:inherit]]
+
+      check_keys(privileges)
 
       @acl_privileges[role] = (@acl_privileges[privileges[:inherit]] || {}).merge(privileges[:privileges] || {})
 
@@ -31,6 +29,14 @@ module SimpleAcl
 
     private
 
+    # check defined keys in privileges
+    def check_keys(privileges)
+      privileges.keys.each do |configuration_key|
+        raise ExceptionConfiguration, "Unknow configuration key #{configuration_key}" unless [:privileges, :inherit].include?(configuration_key)
+      end
+      raise ExceptionConfiguration, 'Inherit specified is not defined previously' if privileges[:inherit] && !@acl_privileges[privileges[:inherit]]
+    end
+
     # check of the set up
     def check_set_up(privileges)
       privileges.keys.each{|action| check_assertion(privileges[action]) }

data/lib/simple_acl/version.rb

@@ -1,3 +1,3 @@
 module SimpleAcl
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_acl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,8 +27,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
-description: Simple Gem to use ACL in ruby (and especially in Rails) based on a role
-  given. Great use with Devise.
+description: Simple gem to implement ACL in Ruby (especially in Rails) based on a
+  role given. Great use with Devise.
 email: tech@ifeelgoods.com
 executables: []
 extensions: []
@@ -63,5 +63,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Simple Gem to implement ACL in Rails based on a role given.
+summary: Simple gem to implement ACL in Ruby (especially in Rails).
 test_files: []