simple_acl 1.0.3 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGZjN2RlMDM5ZjQ3NDFiMDYzNmM5ZGJiNTJiNGYxODEzZDJiMTMzYQ==
+  data.tar.gz: !binary |-
+    MzExYTAzZjc3NjZmMjYxMGU2MzE5ZTljNjE0NTdmOTg1MjQ5YmU4Yw==
+SHA512:
+  metadata.gz: !binary |-
+    MzkwMzA4MGY5MWRiMDNlMWM2MWU0Y2U3NjE3Y2ZmZjhmYWFjOTkwZGZjYzY1
+    NmUzNzRhN2JmYTFmY2Y2YTEzZmMxZjA2NWUyNjcyM2Y1NTgxNzU0MzAxYzBk
+    ZTBlMjg3ZjQ2MTE1M2MyNzA4MzkwYmRlNTdmZmM4NDcwOGU1MmI=
+  data.tar.gz: !binary |-
+    NDc2ZTMxMjlhNTk2NmY5Yzk1OTYyMjA2ZWJkNmUxZjc3OGVjMjJlMmZlOGIz
+    NzNlNDczNTZiYTU1YWRmOGVjMGUzNmFjZDFhYjkzNTc3ZmNkY2RjMWZjMzIx
+    Mjk5ZjlkMmQ3MDRjZTM5N2ViYmEyYTlkNjdiOWM3ZTcwNjNhNzg=

data/README.md

@@ -69,6 +69,7 @@ To configure the ability of a role you can use:
 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 `filters` must be a hash of params filters
 The key `inherit` must be the symbol of previous defined role.
 
 Example:
@@ -117,6 +118,38 @@ If you have values containing `params` and your user model `current_user`
 
 ```
 
+### Define filters for your roles
+
+A filter is a list of allowed tokens for a given parameter. It assume the parameter is a comma delimited string.
+A typical use case for this feature is to accept a prameter that provide a list of options. You want to control which options are available for each role.
+
+Example
+
+```ruby
+  acl_user privileges: { show: true },
+           filters: { features: [ 'opt1', 'opt2', 'opt3'] }
+
+```
+
+The filter above will parse the parameter 'features' and remove all token that are not one of the following `opt1`,`opt2`,`opt3`
+
+a role can inherit filters from its parent. You can overide an inherited filter by redefining it. You can take advantage of the special value below.
+
+* `:all` : Accept any value. It allow to remove an inherited filter
+* `:none` : Reject any value
+
+Example
+
+```ruby
+
+  acl_user privileges: { show: true },
+           filters: { features: [ 'opt1', 'opt2', 'opt3'] }
+
+  acl_guest inherit: :user, filters: { features: :none }
+
+  acl_admin inherit: :user, filters: { features: :all }
+```
+
 ## Contributing
 
 1. Fork it

data/lib/simple_acl.rb

@@ -36,7 +36,7 @@ module SimpleAcl
   end
 
   def acl_values
-    Thread.current[:acl_values] ||= defined?(params) ? params : nil
+    Thread.current[:acl_values] ||= { params: (defined?(params) ? params : nil) }
   end
 
   # @param current_role used for the assertion
@@ -63,6 +63,7 @@ module SimpleAcl
 
     begin
       self.class.acl.check_acl(acl_current_role, acl_action, acl_values)
+      self.class.acl.filter_params(acl_current_role, acl_values[:params])
     ensure
       # in case of Thread,current is not cleaned
       Thread.current[:acl_action] = nil
@@ -70,4 +71,4 @@ module SimpleAcl
       Thread.current[:acl_values] = nil
     end
   end
-end
+end

data/lib/simple_acl/acl.rb

@@ -38,6 +38,15 @@ module SimpleAcl
       unauthorized
     end
 
+    def filter_params(role, params)
+      filters = configuration.acl_filters[role.to_sym] || {}
+      filters.each do |key,value|
+        if params.has_key?(key)
+          params[key] = filter(params[key], value)
+        end
+      end
+    end
+
     def self.unauthorized
       raise ExceptionUnauthorized
     end
@@ -46,5 +55,19 @@ module SimpleAcl
       true
     end
 
+    private
+
+    def filter(values, accepted_values)
+      if accepted_values == :all
+        values
+      elsif accepted_values == :none
+        ''
+      elsif values == 'all'
+        accepted_values.join(',')
+      else
+        (values.split(',') & accepted_values).join(',')
+      end
+    end
+
   end
 end

data/lib/simple_acl/configuration.rb

@@ -2,15 +2,18 @@ module SimpleAcl
   class Configuration
 
     attr_reader :acl_privileges
+    attr_reader :acl_filters
 
     def initialize
       @acl_privileges = {}
+      @acl_filters = {}
     end
 
     def add_role(role, privileges)
       check_keys(privileges)
 
       @acl_privileges[role] = (@acl_privileges[privileges[:inherit]] || {}).merge(privileges[:privileges] || {})
+      acl_filters[role] = (acl_filters[privileges[:inherit]] || {}).merge(privileges[:filters] || {})
 
       check_set_up(@acl_privileges[role])
 
@@ -22,7 +25,7 @@ module SimpleAcl
     # 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)
+        raise ExceptionConfiguration, "Unknow configuration key #{configuration_key}" unless [:privileges, :inherit, :filters].include?(configuration_key)
       end
       raise ExceptionConfiguration, 'Inherit specified is not defined previously' if privileges[:inherit] && !@acl_privileges[privileges[:inherit]]
     end

data/lib/simple_acl/version.rb

@@ -1,3 +1,3 @@
 module SimpleAcl
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: simple_acl
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - mtparet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -35,34 +32,33 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/simple_acl.rb
 - lib/simple_acl/acl.rb
-- lib/simple_acl/version.rb
 - lib/simple_acl/configuration.rb
 - lib/simple_acl/exceptions.rb
-- lib/simple_acl.rb
+- lib/simple_acl/version.rb
 homepage: https://github.com/ifeelgoods/simple_acl
 licenses:
 - Apache License Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple gem to implement ACL in Ruby (especially in Rails).
 test_files: []