flexible_accessibility 0.3.2 → 0.3.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flexible_accessibility (0.3.2)
+    flexible_accessibility (0.3.3)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -8,17 +8,43 @@ Installation:
 
   or add to your Gemfile
 
-		gem 'flexible_accessibility', '0.3.2'
+		gem 'flexible_accessibility', '0.3.3'
 
-  Do
+  then do
 
-    rails g flexible_accessibility:install 
+        rails g flexible_accessibility:install
 
   to install migrations
 
+Usage:
+
+  All routes in application are closed by default
+  To add route for check or open it you have to use 'authorize' macro in your controller
+  The macro has a couple of options:
+
+  Add all routes to check:
+
+        authorize :all
+
+  Add some routes to check but close all others
+
+        authorize :only => [:index, :new]
+
+  Add all routes except :index to check, :index remains closed
+
+        authorize :except => [:index]
+
+  Add :index and :new to check, skip (open) create for all
+
+        authorize :only => [:index, :new], :skip => [:create]
+
+  Open all routes for all
+
+        authorize :skip => :all
+
 ======================
 
 ## Copyright
-Copyright (c) 2012-2013 Sergey Avanesov and 7 Pikes, Inc.
+Copyright (c) 2012-2014 Sergey Avanesov and 7 Pikes, Inc.
 
 ![7pikes logo](https://github.com/7Pikes/flexible_accessibility/wiki/Logo.png)

data/flexible_accessibility.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name = 'flexible_accessibility'
-  s.version = '0.3.2'
+  s.version = '0.3.3'
   s.authors = ['Sergey Avanesov']
-  s.date = '2013-09-30'
+  s.date = '2014-01-08'
   s.summary = 'Flexible access control system'
   s.description = 'Flexible access control system for your rails application. Based on analysis of controller actions'
   s.email = 'sergey.awanesov@gmail.com'
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = '1.8.24'
   s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
 
   s.add_development_dependency 'i18n'

data/lib/flexible_accessibility/controller_methods.rb

@@ -4,39 +4,54 @@ module FlexibleAccessibility
 
       # Compatibility with previous versions
       def skip_authorization_here
-        not_authorize :all
-      end
-
-      # Macro for define actions without authorization
-      def not_authorize(args={})
-        valid_arguments = parse_and_validate_arguments(args)
-        self.instance_variable_set(:@_non_verifiable_routes, self.action_methods) if valid_arguments[:all]
-        self.instance_variable_set(:@_non_verifiable_routes, valid_arguments[:only]) unless valid_arguments[:only].nil?
-        self.instance_variable_set(:@_verifiable_routes, []) if self.instance_variable_get(:@_non_verifiable_routes).nil?
+        authorize :skip => :all
       end
 
       # Macro for define actions with authorization
   	  def authorize(args={})
-        valid_arguments = parse_and_validate_arguments(args)
-        self.instance_variable_set(:@_verifiable_routes, valid_arguments[:only]) unless valid_arguments[:only].nil?
-        self.instance_variable_set(:@_verifiable_routes, self.action_methods - valid_arguments[:except]) unless valid_arguments[:except].nil?
-        self.instance_variable_set(:@_verifiable_routes, self.action_methods) if valid_arguments[:all]
-        self.instance_variable_set(:@_non_verifiable_routes, []) if self.instance_variable_get(:@_non_verifiable_routes).nil?
+        arguments = parse_arguments(args)
+        validate_arguments(arguments)
+        available_routes = Utils.new.app_routes[self.to_s.gsub(/Controller/, '')]
+        available_routes = available_routes.to_set unless available_routes.nil?
+        unless available_routes.nil?
+          self.instance_variable_set(:@_verifiable_routes, available_routes) if arguments[:all]
+          self.instance_variable_set(:@_verifiable_routes, arguments[:only]) unless arguments[:only].nil?
+          self.instance_variable_set(:@_verifiable_routes, available_routes - arguments[:except]) unless arguments[:except].nil?
+          unless arguments[:skip].nil?
+            non_verifiable_routes = arguments[:skip].first == 'all' ? available_routes : arguments[:skip]
+            self.instance_variable_set(:@_non_verifiable_routes, non_verifiable_routes)
+          end
+        end
   	  end
 
       private
       # Parse arguments from macro calls
-      def parse_and_validate_arguments(args={})
+      def parse_arguments(args={})
         result = {}
-        (result[:all] = true) and return result if args.to_s == 'all'
-        [:only, :except].each do |key|
+        (result[:all] = ['all'].to_set) and return result if args.to_s == 'all'
+        [:only, :except, :skip].each do |key|
           unless args[key].nil?
+            result[key] = [args[key].to_s].to_set and next if args[key].to_s == 'all' && key == :skip
             raise ActionsValueException unless args[key].instance_of?(Array)
             result[key] = args[key].map!{ |v| v.to_s }.to_set
           end
         end
         result
       end
+
+      def validate_arguments(args={})
+        return if args.count == 1 && args.keys.include?(:all)
+        only_options = args[:only] || Set.new
+        except_options =  args[:except] || Set.new
+        skip_options = args[:skip] || Set.new
+        unless (only_options & except_options).empty? &&
+               (only_options & skip_options).empty?
+          raise IncorrectArgumentException.new(nil, 'The same arguments shouldn\'t be used with different keys excluding except and skip')
+        end
+        if args[:skip] == 'all' && args.count > 1
+          raise IncorrectArgumentException.new(nil, 'Option \'skip\' with argument \'all\' shouldn\'t be used with another options')
+        end
+      end
     end
  
     # Callback is needed for include methods and define helper method

data/lib/flexible_accessibility/exceptions.rb

@@ -1,6 +1,6 @@
 module FlexibleAccessibility
   class FlexibleAccessibilityException < StandardError
-    attr_reader :action, :subject, :default_message
+    attr_reader :action, :subject
 
     def initialize(action = nil, subject = nil)
       @action = action
@@ -8,71 +8,84 @@ module FlexibleAccessibility
     end
 
     def to_s
-      message || default_message
+      message || default_message || @subject
     end
 
-    private
     def message
-      nil
+      @subject || nil
     end
 
+    private
     def default_message
       'An exception is occurred'
     end
   end
 
 	class AccessDeniedException < FlexibleAccessibilityException
-    private
+
     def message
       I18n.t('flexible_accessibility.errors.access_denied', :action => @action)
     end
 
+    private
     def default_message
 		  "The access for resource #{@action} is denied"
     end
 	end
 
   class UserNotLoggedInException < FlexibleAccessibilityException
-    private
+
     def message
       I18n.t('flexible_accessibility.errors.user_is_not_logged_in')
     end
 
+    private
     def default_message
       'Current user is not logged in'
     end
   end
 
   class NoWayToDetectLoggerUserException < FlexibleAccessibilityException
-    private
+
     def message
       I18n.t('flexible_accessibility.errors.no_way_to_detect_logged_user')
     end
 
+    private
     def default_message
       'No way to detect a logged user - may you have forgot to define a current_user helper'
     end
   end
  
   class UnknownUserException < FlexibleAccessibilityException
-    private
+
     def message
       I18n.t('flexible_accessibility.errors.unknown_user')
     end
 
+    private
     def default_message
       'Probably you have forgot to send a user in has_access?'
     end
   end
 
   class ActionsValueException < FlexibleAccessibilityException
-    private
+
     def message
       I18n.t('flexible_accessibility.errors.incorrect_value_of_actions')
     end
 
+    private
     def default_message
       'The value of any \'authorize\' macro argument should be declared as Array'
     end
   end
+
+  class IncorrectArgumentException < FlexibleAccessibilityException
+
+    private
+    def default_message
+      nil
+    end
+  end
 end

data/lib/flexible_accessibility/filters.rb

@@ -31,14 +31,17 @@ module FlexibleAccessibility
 
   	# Check access to route and we expected the existing of current_user helper
   	def check_permission_to_route
+      self.class.instance_variable_set(:@_verifiable_routes, []) if self.class.instance_variable_get(:@_verifiable_routes).nil?
+      self.class.instance_variable_set(:@_non_verifiable_routes, []) if self.class.instance_variable_get(:@_non_verifiable_routes).nil?
+
       if self.class.instance_variable_get(:@_verifiable_routes).include?(current_action)
         raise UserNotLoggedInException.new(current_route, nil) if logged_user.nil?
-  	    self.class.instance_variable_set(:@_route_permitted, AccessProvider.is_action_permitted_for_user?(current_route, logged_user))
+        self.class.instance_variable_set(:@_route_permitted, AccessProvider.is_action_permitted_for_user?(current_route, logged_user))
       elsif self.class.instance_variable_get(:@_non_verifiable_routes).include? current_action
         self.class.instance_variable_set(:@_route_permitted, true)
       else
         self.class.instance_variable_set(:@_route_permitted, false)
-  	  end
+      end
     end
 
     def allow_route

data/lib/flexible_accessibility/permission.rb

@@ -20,11 +20,11 @@ module FlexibleAccessibility
     class << self
   	  def all
   			permissions = []
-  			Utils.new.get_controllers.each do |scope|
+  			Utils.new.app_controllers.each do |scope|
   				namespace = scope.first.to_s
   			  scope.last.each do |resource|
-  			  	resource = "#{namespace}/#{resource}" unless namespace == "default"
-  			  	permissions << Permission.new(:resource => resource.gsub(/_controller/, ""), :actions => ApplicationResource.new(resource).klass.instance_variable_get(:@_verifiable_routes))
+  			  	resource = "#{namespace}/#{resource}" unless namespace == 'default'
+  			  	permissions << Permission.new(:resource => resource.gsub(/_controller/, ''), :actions => ApplicationResource.new(resource).klass.instance_variable_get(:@_verifiable_routes))
   			  end
   			end
   			permissions

data/lib/flexible_accessibility/utils.rb

@@ -1,19 +1,27 @@
 module FlexibleAccessibility
   class Utils
+    @@routes ||= {}
+
     def initialize
       @path = "#{::Rails.root}/app/controllers/"
       @controllers = {}
     end
 
-    def get_controllers
-      get_controllers_recursive(@path)
+    def app_controllers
+      app_controllers_recursive(@path)
+    end
+
+    def app_routes
+      app_routes_as_hash if @@routes.empty?
+      @@routes
     end
 
+    private
     # All controller classes placed in :default scope
-    def get_controllers_recursive(path)
+    def app_controllers_recursive(path)
       (Dir.new(path).entries - ['..', '.']).each do |entry|
         if File.directory?(path + entry)
-          get_controllers_recursive(path + entry + '/')
+          app_controllers_recursive(path + entry + '/')
         else
           parent_directory = File.dirname(path + entry).split(/\//).last
           container = parent_directory == 'controllers' ? 'default' : parent_directory
@@ -23,5 +31,17 @@ module FlexibleAccessibility
       end
       @controllers
     end
+
+    # Routes from routes.rb
+    def app_routes_as_hash
+      Rails.application.routes.routes.each do |route|
+        controller = route.defaults[:controller]
+        unless controller.nil?
+          key = controller.split('/').map { |p| p.camelize }.join('::')
+          @@routes[key] ||= []
+          @@routes[key] << route.defaults[:action]
+        end
+      end
+    end
   end
 end

metadata

@@ -2,14 +2,14 @@
 name: flexible_accessibility
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Sergey Avanesov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false