flexible_accessibility 0.3.0 → 0.3.1

data/.gitignore

@@ -2,8 +2,6 @@
 *.rbc
 .bundle
 .config
-*.sublime-project
-*.sublime-workspace
 coverage
 InstalledFiles
 lib/bundler/man
@@ -13,11 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rvmrc
-.DS_Store
-.idea
-
-# YARD artifacts
 .yardoc
 _yardoc
 doc/
+

data/Gemfile

@@ -1,3 +1,4 @@
 source "http://rubygems.org"
+
 gemspec
 

data/Gemfile.lock

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Sergey Awanesov
+Copyright (c) 2012-2013 Sergey Awanesov and 7 Pikes, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -10,9 +10,15 @@ Installation:
 
 		gem "flexible_accessibility", "~> 0.3.0"
 
+  Do
+
+    rails g flexible_accessibility:install 
+
+  to install migrations
+
 ======================
 
 ## Copyright
-Copyright (c) 2012 Sergey Awanesov and 7 Pikes, Inc.
+Copyright (c) 2012-2013 Sergey Awanesov and 7 Pikes, Inc.
 
 ![7pikes logo](https://github.com/7Pikes/flexible_accessibility/wiki/Logo.png)

data/Rakefile

@@ -10,8 +10,8 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
+require 'rake'
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/flexible_accessibility.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name = "flexible_accessibility"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
   s.authors = ["Sergey Awanesov"]
-  s.date = "2012-09-05"
+  s.date = "2013-09-30"
   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"

data/lib/flexible_accessibility.rb

@@ -4,4 +4,6 @@ require 'flexible_accessibility/exceptions.rb'
 require 'flexible_accessibility/permission.rb'
 require 'flexible_accessibility/filters.rb'
 require 'flexible_accessibility/resource.rb'
-require 'flexible_accessibility/utils.rb'
+require 'flexible_accessibility/utils.rb'
+require 'flexible_accessibility/access_provider.rb'
+require 'flexible_accessibility/access_rule.rb'

data/lib/flexible_accessibility/access_provider.rb

@@ -0,0 +1,16 @@
+module FlexibleAccessibility
+  class AccessProvider
+    class << self
+      def preload_permissions(user)
+        if user.instance_variable_get(:@_available_permissions).nil?
+          user.instance_variable_set(:@_available_permissions, AccessRule.where(:owner => user.id).map(&:permission))
+        end
+      end
+
+      def is_action_permitted_for_user?(permission, user)
+        preload_permissions(user)
+        user.instance_variable_get(:@_available_permissions).include? permission
+      end
+    end
+  end
+end

data/lib/flexible_accessibility/access_rule.rb

@@ -0,0 +1,4 @@
+module FlexibleAccessibility
+  class AccessRule < ActiveRecord::Base
+  end
+end

data/lib/flexible_accessibility/controller_methods.rb

@@ -7,7 +7,7 @@ module FlexibleAccessibility
         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[:on]) unless valid_arguments[:on].nil?
-        self.instance_variable_set(:@_verifiable_routes, [])
+        self.instance_variable_set(:@_verifiable_routes, []) if self.instance_variable_get(:@_non_verifiable_routes).nil?
       end
 
       # Macro for define actions with authorization
@@ -16,9 +16,10 @@ module FlexibleAccessibility
         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, [])
+        self.instance_variable_set(:@_non_verifiable_routes, []) if self.instance_variable_get(:@_non_verifiable_routes).nil?
+        # TODO: get info from routes
   	  end
-      
+
       private
       # Parse arguments from macro calls
       def parse_and_validate_arguments(args={})
@@ -42,7 +43,8 @@ module FlexibleAccessibility
     
     # Check the url for each link in view to show it
     def has_access?(permission, user)
-      Permission.is_action_permitted_for_user?(permission, user)
+      raise UnknownUserException if user.nil?
+      AccessProvider.is_action_permitted_for_user?(permission, user)
     end
   end
 end
@@ -50,6 +52,6 @@ end
 # Include methods in ActionController::Base
 if defined?(ActionController::Base)
 	ActionController::Base.class_eval do
-	  include FlexibleAccessibility::ControllerMethods	
+	  include FlexibleAccessibility::ControllerMethods
 	end
 end

data/lib/flexible_accessibility/exceptions.rb

@@ -21,11 +21,10 @@ module FlexibleAccessibility
     end
   end
 
-
 	class AccessDeniedException < FlexibleAccessibilityException
     private
     def message
-      I18n.t 'flexible_accessibility.errors.access_denied', :action => @action
+      I18n.t('flexible_accessibility.errors.access_denied', :action => @action)
     end
 
     def default_message
@@ -36,7 +35,7 @@ module FlexibleAccessibility
   class UserNotLoggedInException < FlexibleAccessibilityException
     private
     def message
-      I18n.t 'flexible_accessibility.errors.user_is_not_logged_in'
+      I18n.t('flexible_accessibility.errors.user_is_not_logged_in')
     end
 
     def default_message
@@ -44,6 +43,28 @@ module FlexibleAccessibility
     end
   end
 
+  class NoWayToDetectLoggerUserException < FlexibleAccessibilityException
+    private
+    def message
+      I18n.t('flexible_accessibility.errors.no_way_to_detect_logged_user')
+    end
+
+    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
+
+    def default_message
+      "Probably you have forgot to send a user in has_access?"
+    end
+  end
+
   class ActionsValueException < FlexibleAccessibilityException
     private
     def message

data/lib/flexible_accessibility/filters.rb

@@ -6,7 +6,7 @@ module FlexibleAccessibility
   	  append_before_filter(:check_permission_to_route)
   	  append_before_filter(:check_if_route_is_permitted)
   	end
-	  
+
 	  private
     # Detect current controller and action and return a permission
     def current_resource
@@ -23,11 +23,17 @@ module FlexibleAccessibility
       "#{current_resource}##{current_action}"
     end
 
-  	# We checks access to route and we expected the existing of current_user helper
+    # Expected the existing of current_user helper
+    def logged_user
+      return current_user if defined?(current_user)
+      raise NoWayToDetectLoggerUserException unless defined?(current_user)
+    end
+
+  	# Check access to route and we expected the existing of current_user helper
   	def check_permission_to_route
       if self.class.instance_variable_get(:@_verifiable_routes).include? current_action
-        raise UserNotLoggedInException.new(current_route, nil) if current_user.nil?
-  	    self.class.instance_variable_set(:@_route_permitted, Permission.is_action_permitted_for_user?(current_route, current_user))
+        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))
       elsif self.class.instance_variable_get(:@_non_verifiable_routes).include? current_action
         self.class.instance_variable_set(:@_route_permitted, true)
       else
@@ -35,7 +41,7 @@ module FlexibleAccessibility
   	  end
   	end
 
-  	# We checks @authorized variable state
+  	# Check the @authorized variable state
   	def check_if_route_is_permitted
   	  raise AccessDeniedException.new(current_route, nil) unless self.class.instance_variable_get(:@_route_permitted)
 	  end

data/lib/flexible_accessibility/permission.rb

@@ -16,28 +16,19 @@ module FlexibleAccessibility
     	ApplicationResource.new(self.resource).namespace
     end
 
-  	class << self
-  		# TODO: this function may be recursive because nesting may be existed
-		  def all
-				permissions = []
-				Utils.new.get_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))
-				  end
-				end
-				permissions
-	  	end
-
-		  def is_action_permitted? permission
-		  	self.is_action_permitted_for_user?(permission, current_user)
-		  end
-
-		  def is_action_permitted_for_user? permission, user
-		  	# TODO: Avoid these code, maybe handle a callback included in application
-		  	!AccessRule.where(["permission = ? and user_id = ?", permission, user.id]).empty?
-		  end
-		end
+		# TODO: this function may be recursive because nesting may be existed
+    class << self
+  	  def all
+  			permissions = []
+  			Utils.new.get_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))
+  			  end
+  			end
+  			permissions
+    	end
+    end
   end
 end

data/lib/flexible_accessibility/resource.rb

@@ -20,4 +20,4 @@ module FlexibleAccessibility
 			@namespace == "default"
 		end
   end
-end
+end

data/lib/generators/flexible_accessibility/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/migration'
+
+module FlexibleAccessibility
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_access_rules.rb", "db/migrate/create_access_rules.rb"
+      end
+    end
+  end
+end

data/lib/generators/flexible_accessibility/install/templates/create_access_rules.rb

@@ -0,0 +1,15 @@
+class CreateAccessRules < ActiveRecord::Migration
+  def self.up
+    create_table :access_rules do |t|
+      t.string  :permission
+      t.integer :owner    
+      t.timestamps
+
+      t.index [:owner], :name => "access_rules_index_on_owner"
+    end
+  end
+
+  def self.down
+    drop_table :access_rules
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: flexible_accessibility
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sergey Awanesov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -87,16 +87,21 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - flexible_accessibility.gemspec
 - init.rb
 - lib/flexible_accessibility.rb
+- lib/flexible_accessibility/access_provider.rb
+- lib/flexible_accessibility/access_rule.rb
 - lib/flexible_accessibility/controller_methods.rb
 - lib/flexible_accessibility/exceptions.rb
 - lib/flexible_accessibility/filters.rb
 - lib/flexible_accessibility/permission.rb
 - lib/flexible_accessibility/resource.rb
 - lib/flexible_accessibility/utils.rb
+- lib/generators/flexible_accessibility/install/install_generator.rb
+- lib/generators/flexible_accessibility/install/templates/create_access_rules.rb
 - test/helper.rb
 - test/test_flexible_accessibility.rb
 homepage: http://github.com/mochnatiy/flexible_accessibility