lockdown 1.2.2 → 1.3.0

data/lib/lockdown/frameworks/rails.rb

@@ -34,7 +34,7 @@ module Lockdown
 
           klass.helper_method :authorized?
 
-          klass.hide_action(:set_current_user, :configure_lockdown, :check_request_authorization)
+          klass.hide_action(:set_current_user, :configure_lockdown, :check_request_authorization, :check_model_authorization)
 
           klass.before_filter do |c|
             c.set_current_user

data/lib/lockdown/permission.rb

@@ -98,10 +98,12 @@ module Lockdown
     #       equals(:id)
     #
     def initialize(name_symbol)
-      @name         = name_symbol
-      @controllers  = {}
-      @models       = {}
-      @current_context = Lockdown::RootContext.new(name_symbol)
+      @name             = name_symbol
+      @controllers      = {}
+      @models           = {}
+      @current_context  = Lockdown::RootContext.new(name_symbol)
+      @public_access    = false
+      @protected_access = false
     end
 
     def with_controller(name_symbol)

data/lib/lockdown/rspec_helper.rb

@@ -0,0 +1,100 @@
+module Lockdown
+  module RspecHelper
+    def login_admin
+      login_user(:admin)
+    end
+
+    def login_with_groups(*user_group_symbols)
+      access_rights = Lockdown::System.standard_authorized_user_rights
+      user_group_symbols.each do |ugs|
+        access_rights << Lockdown::System.access_rights_for_user_group(ugs)
+      end
+      controller.session[:access_rights] = access_rights.flatten
+    end
+
+    alias login_with_group login_with_groups 
+
+    def login_standard
+      login_user
+    end
+
+    def public_user
+      setup_public_user
+    end
+
+
+    private
+
+    def login_user(user_type = :standard)
+      initialize_user(user_type)
+
+      create_user_session
+
+      controller.stub!(:current_user).and_return(@current_user)
+    end
+
+    def setup_public_user
+      controller.session[:access_rights] = Lockdown::System.public_access
+    end
+
+    def all_actions(hash = {})
+      methods = controller.send :action_methods
+
+      if excepts = hash.delete(:except)
+        methods.reject!{|m| excepts.include?(m.to_sym)}
+      end
+
+      Lockdown::System.paths_for(controller.controller_name,methods.to_a).sort
+    end
+
+    def only_actions(*actions)
+      Lockdown::System.paths_for(controller.controller_name,actions).sort
+    end
+
+    def allowed_actions
+      if rights = controller.session[:access_rights]
+        if rights == :all
+          all_actions
+        else
+          name = controller.controller_name
+          rights.collect{|r| r if r =~ /^#{name}\// || r == name}.compact.sort
+        end
+      else
+        []
+      end
+    end
+
+    def initialize_user(user_type)
+      @current_user = mock_user
+
+      if user_type == :admin
+        set_user_group(Lockdown.administrator_group_symbol)
+      end
+    end
+
+    # You may want to override this method
+    def mock_user
+      mock  :user, 
+            :first_name => 'John',
+            :last_name  => 'Smith',
+            :password   => "mysecret",
+            :password_confirmation   => "mysecret"
+    end
+
+    def create_user_session
+      controller.send :add_lockdown_session_values, @current_user
+    end
+
+    # Lockdown.convert_reference_name converts :users to "Users" 
+    def set_user_group(sym)
+      user_group = mock_user_group
+      user_group.stub!(:name).and_return( Lockdown.convert_reference_name(sym) )
+      @current_user.stub!(Lockdown.user_groups_hbtm_reference).and_return([user_group])
+    end
+
+    # You may want to override this method
+    def mock_user_group
+      mock_model(UserGroup)
+    end
+  end
+end

data/lib/lockdown/rules.rb

@@ -30,19 +30,10 @@ module Lockdown
         :successful_login_path => "/",
         :subdirectory => nil,
         :skip_db_sync_in => ["test"],
-        :link_separator => ' | '
+        :link_separator => ' | ',
+        :user_group_model => "UserGroup",
+        :user_model => "User" 
       }
-
-      begin
-        @options[:user_group_model] = "UserGroup"
-      rescue NameError 
-      end
-
-      begin
-        @options[:user_model] = "User" 
-      rescue NameError 
-      end
-      
     end
 
     #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,9 +53,9 @@ module Lockdown
     #
     def set_public_access(*perms)
       perms.each do |perm_symbol|
-        perm = permission_objects.find{|name, pobj| pobj.name == perm_symbol}
+        perm = find_permission_object(perm_symbol)
         if perm
-          perm[1].set_as_public_access 
+          perm.set_as_public_access 
         else
           msg = "Permission not found: #{perm_symbol}"
           raise InvalidRuleAssigment, msg
@@ -79,9 +70,9 @@ module Lockdown
     #
     def set_protected_access(*perms)
       perms.each do |perm_symbol|
-        perm = permission_objects.find{|name, pobj| pobj.name == perm_symbol}
+        perm = find_permission_object(perm_symbol)
         if perm
-          perm[1].set_as_protected_access 
+          perm.set_as_protected_access 
         else
           msg = "Permission not found: #{perm_symbol}"
           raise InvalidRuleAssigment, msg
@@ -118,13 +109,15 @@ module Lockdown
     alias_method :has_permission?, :permission_exists?
     
     # returns true if the permission is public
-    def public_access?(permmision_symbol)
-      public_access.include?(permmision_symbol)
+    def public_access?(perm_symbol)
+      obj = find_permission_object(perm_symbol)
+      obj.nil? ? false : obj.public_access? 
     end
 
     # returns true if the permission is public
-    def protected_access?(permmision_symbol)
-      protected_access.include?(permmision_symbol)
+    def protected_access?(perm_symbol)
+      obj = find_permission_object(perm_symbol)
+      obj.nil? ? false : obj.protected_access?
     end
 
     # These permissions are assigned by the system 
@@ -180,6 +173,15 @@ module Lockdown
       rights
     end
 
+    # Return array of controller/action for a user group
+    def access_rights_for_user_group(user_group_sym)
+      res = []
+      permissions_for_user_group(user_group_sym).each do |perm|
+        res << access_rights_for_permission(perm)
+      end
+      res.flatten
+    end
+
     # Return array of controller/action for a permission
     def access_rights_for_permission(perm)
       sym = Lockdown.get_symbol(perm)
@@ -278,6 +280,11 @@ module Lockdown
 
     private
 
+    def find_permission_object(perm_symbol)
+      obj = permission_objects.find{|name, pobj| pobj.name == perm_symbol}
+      obj[1] if obj
+    end
+
     def validate_user_groups
       user_groups.each do |user_group, perms|
         perms.each do |perm|

data/lib/lockdown.rb

@@ -1,9 +1,11 @@
-require File.join(File.dirname(__FILE__), "lockdown", "helper")
+$:.unshift File.dirname(__FILE__)
+
+require File.join("lockdown", "helper")
 
 module Lockdown
   extend Lockdown::Helper
 
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 
   # Returns the version string for the library.
   def self.version
@@ -57,12 +59,12 @@ module Lockdown
   end # mixin_resource?
 end # Lockdown
 
-require File.join(File.dirname(__FILE__), "lockdown", "session")
-require File.join(File.dirname(__FILE__), "lockdown", "context")
-require File.join(File.dirname(__FILE__), "lockdown", "permission")
-require File.join(File.dirname(__FILE__), "lockdown", "database")
-require File.join(File.dirname(__FILE__), "lockdown", "rules")
-require File.join(File.dirname(__FILE__), "lockdown", "system")
+require File.join("lockdown", "session")
+require File.join("lockdown", "context")
+require File.join("lockdown", "permission")
+require File.join("lockdown", "database")
+require File.join("lockdown", "rules")
+require File.join("lockdown", "system")
 
 puts "=> Mixing in Lockdown version: #{Lockdown.version} \n"
 

data/spec/lockdown/context_spec.rb

@@ -0,0 +1,191 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Lockdown::Context do
+  before do
+    @name = :my_account
+  end
+
+  describe Lockdown::RootContext do
+    before do
+      @c = Lockdown::RootContext.new(@name)
+    end
+
+    it "should return rootcontext" do
+      @c.to_s.should == "Lockdown::RootContext"
+    end
+
+    it "should allow with_controller" do
+      @c.allows?('with_controller').should == true
+    end
+
+    it "should allow and_controller" do
+      @c.allows?('and_controller').should == true
+    end
+
+    it "should allow to_model" do
+      @c.allows?('to_model').should == true
+    end
+
+    it "should not allow only_methods" do
+      @c.allows?('only_methods').should == false
+    end
+
+    it "should not allow except_methods" do
+      @c.allows?('except_methods').should == false
+    end
+
+    it "should not allow where" do
+      @c.allows?('where').should == false
+    end
+
+    it "should not allow is_in" do
+      @c.allows?('is_in').should == false
+    end
+
+    it "should not allow includes" do
+      @c.allows?('includes').should == false
+    end
+
+    it "should not allow equals" do
+      @c.allows?('equals').should == false
+    end
+  end
+
+  describe Lockdown::ControllerContext do
+    before do
+      @c = Lockdown::ControllerContext.new(@name)
+    end
+
+    it "should return rootcontext" do
+      @c.to_s.should == "Lockdown::ControllerContext"
+    end
+
+    it "should allow with_controller" do
+      @c.allows?('with_controller').should == true
+    end
+
+    it "should allow and_controller" do
+      @c.allows?('and_controller').should == true
+    end
+
+    it "should allow to_model" do
+      @c.allows?('to_model').should == true
+    end
+
+    it "should allow only_methods" do
+      @c.allows?('only_methods').should == true
+    end
+
+    it "should allow except_methods" do
+      @c.allows?('except_methods').should == true
+    end
+
+    it "should not allow where" do
+      @c.allows?('where').should == false
+    end
+
+    it "should not allow is_in" do
+      @c.allows?('is_in').should == false
+    end
+
+    it "should not allow includes" do
+      @c.allows?('includes').should == false
+    end
+
+    it "should not allow equals" do
+      @c.allows?('equals').should == false
+    end
+  end 
+
+  describe Lockdown::ModelContext do
+    before do
+      @c = Lockdown::ModelContext.new(@name)
+    end
+
+    it "should return rootcontext" do
+      @c.to_s.should == "Lockdown::ModelContext"
+    end
+
+    it "should not allow with_controller" do
+      @c.allows?('with_controller').should == false
+    end
+
+    it "should not allow and_controller" do
+      @c.allows?('and_controller').should == false
+    end
+
+    it "should not allow to_model" do
+      @c.allows?('to_model').should == false
+    end
+
+    it "should not allow only_methods" do
+      @c.allows?('only_methods').should == false
+    end
+
+    it "should not allow except_methods" do
+      @c.allows?('except_methods').should == false
+    end
+
+    it "should allow where" do
+      @c.allows?('where').should == true
+    end
+
+    it "should not allow is_in" do
+      @c.allows?('is_in').should == false
+    end
+
+    it "should not allow includes" do
+      @c.allows?('includes').should == false
+    end
+
+    it "should not allow equals" do
+      @c.allows?('equals').should == false
+    end
+  end 
+
+  describe Lockdown::ModelWhereContext do
+    before do
+      @c = Lockdown::ModelWhereContext.new(@name)
+    end
+
+    it "should return rootcontext" do
+      @c.to_s.should == "Lockdown::ModelWhereContext"
+    end
+
+    it "should not allow with_controller" do
+      @c.allows?('with_controller').should == false
+    end
+
+    it "should not allow and_controller" do
+      @c.allows?('and_controller').should == false
+    end
+
+    it "should not allow to_model" do
+      @c.allows?('to_model').should == false
+    end
+
+    it "should not allow only_methods" do
+      @c.allows?('only_methods').should == false
+    end
+
+    it "should not allow except_methods" do
+      @c.allows?('except_methods').should == false
+    end
+
+    it "should not allow where" do
+      @c.allows?('where').should == false
+    end
+
+    it "should allow is_in" do
+      @c.allows?('is_in').should == true
+    end
+
+    it "should allow includes" do
+      @c.allows?('includes').should == true
+    end
+
+    it "should allow equals" do
+      @c.allows?('equals').should == true
+    end
+  end 
+end

data/spec/lockdown/rspec_helper_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+require 'lockdown/rspec_helper'
+
+class TestAController
+  extend Lockdown::Frameworks::Rails::Controller
+  include Lockdown::Frameworks::Rails::Controller::Lock
+end
+
+class RspecEnv
+  include Lockdown::RspecHelper
+end
+
+describe Lockdown::RspecHelper do
+  before do
+    @controller = TestAController.new
+    @controller.stub!(:session).and_return({})
+
+    usr = mock  :user, 
+                :first_name => 'John',
+                :last_name  => 'Smith',
+                :password   => 'mysecret',
+                :password_confirmation  => 'mysecret'
+
+    usr_group = mock :usr_group
+
+    @rspec_env = RspecEnv.new
+    @rspec_env.stub!(:controller).and_return(@controller)
+    @rspec_env.stub!(:mock_user).and_return(usr)
+    @rspec_env.stub!(:mock_user_group).and_return(usr_group)
+  end
+
+  describe "#login_admin" do
+    it "should set access_rights to :all" do 
+      @rspec_env.login_admin
+      @rspec_env.controller.session[:access_rights].should == :all
+    end
+  end
+end

data/spec/lockdown/rules_spec.rb

@@ -32,11 +32,25 @@ describe Lockdown::Rules do
 
     it "should raise and InvalidRuleAssignment if permission does not exist" do
       msg = "Permission not found: user_management"
-      lambda{@rules.set_public_access(:user_management)}.should
+      lambda{@rules.set_public_access(:toy_management)}.should
         raise_error(Lockdown::InvalidRuleAssignment, msg)
     end
   end
 
+  describe "#public_access?" do
+    it "should return true when permission is public" do
+      @rules.set_permission(:home_page)
+      @rules.set_public_access(:home_page)
+      @rules.public_access?(:home_page).should == true
+    end
+
+    it "should return false when permission is not public" do
+      @rules.set_permission(:home_page)
+      @rules.set_protected_access(:home_page)
+      @rules.public_access?(:home_page).should == false
+    end
+  end
+
   describe "#set_protected_access" do
     it "should define the permission as protected" do
       @rules.set_permission(:user_management)
@@ -52,6 +66,20 @@ describe Lockdown::Rules do
     end
   end
 
+  describe "#protected_access?" do
+    it "should return true when permission is protected" do
+      @rules.set_permission(:home_page)
+      @rules.set_protected_access(:home_page)
+      @rules.protected_access?(:home_page).should == true
+    end
+
+    it "should return false when permission is not protected" do
+      @rules.set_permission(:home_page)
+      @rules.set_public_access(:home_page)
+      @rules.protected_access?(:home_page).should == false
+    end
+  end
+
   describe "#get_permissions" do
     it "should return array of permission names as symbols" do
       Lockdown.should_receive(:add_controller_method)
@@ -78,6 +106,25 @@ describe Lockdown::Rules do
     end
   end
 
+  describe "#permission_assigned_automatically?" do
+    it "should return true when permission is public" do
+      @rules.set_permission(:home_page)
+      @rules.set_public_access(:home_page)
+      @rules.permission_assigned_automatically?(:home_page).should == true
+    end
+
+    it "should return true when permission is protected" do
+      @rules.set_permission(:home_page)
+      @rules.set_protected_access(:home_page)
+      @rules.permission_assigned_automatically?(:home_page).should == true
+    end
+
+    it "should return false when permission is not public" do
+      @rules.set_permission(:home_page)
+      @rules.permission_assigned_automatically?(:home_page).should == false
+    end
+  end
+
   describe "#get_user_groups" do
     it "should return array of user group names as symbols" do
       @rules.set_permission(:user_management)

data/spec/lockdown/session_spec.rb

@@ -14,6 +14,19 @@ describe Lockdown::Session do
 
     @controller.stub!(:session).and_return(@session)
   end
+  
+  describe "#logged_in?" do
+    it "should return false withou current_user_id" do
+      @controller.send(:logged_in?).should == false
+    end
+  end
+
+  describe "#current_user_id" do
+    it "should return false withou current_user_id" do
+      @session[:current_user_id] = 2
+      @controller.send(:current_user_id).should == 2
+    end
+  end
 
   describe "#nil_lockdown_values" do
     it "should nil access_rights" do
@@ -86,5 +99,14 @@ describe Lockdown::Session do
   end
 
   describe "#session_access_rights_include?" do
+    it "should return true for posts/index" do
+      @controller.send(:session_access_rights_include?,'posts/index').
+        should == true
+    end
+
+    it "should return false for pages/index" do
+      @controller.send(:session_access_rights_include?,'pages/index').
+        should == false
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lockdown
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors: 
 - Andrew Stone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-16 00:00:00 -04:00
+date: 2009-08-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ files:
 - lib/lockdown/helper.rb
 - lib/lockdown/orms/active_record.rb
 - lib/lockdown/permission.rb
+- lib/lockdown/rspec_helper.rb
 - lib/lockdown/rules.rb
 - lib/lockdown/session.rb
 - lib/lockdown/system.rb
@@ -78,11 +79,13 @@ files:
 - rails_generators/lockdown/templates/db/migrate/create_users.rb
 - rails_generators/lockdown/templates/lib/lockdown/README
 - rails_generators/lockdown/templates/lib/lockdown/init.rb
+- spec/lockdown/context_spec.rb
 - spec/lockdown/database_spec.rb
 - spec/lockdown/frameworks/rails/controller_spec.rb
 - spec/lockdown/frameworks/rails/view_spec.rb
 - spec/lockdown/frameworks/rails_spec.rb
 - spec/lockdown/permission_spec.rb
+- spec/lockdown/rspec_helper_spec.rb
 - spec/lockdown/rules_spec.rb
 - spec/lockdown/session_spec.rb
 - spec/lockdown/system_spec.rb