zuul 0.1.1 → 0.2.0

data/spec/zuul/configuration_spec.rb

@@ -0,0 +1,254 @@
+require 'spec_helper'
+
+describe "Zuul::Configuration" do
+  before(:each) do
+    @config = Zuul::Configuration.new
+  end
+
+  it "should provide constants defining default attributes and values" do
+    expect { Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES }.to_not raise_exception
+    expect { Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES }.to_not raise_exception
+    expect { Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES }.to_not raise_exception
+    expect { Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS }.to_not raise_exception
+  end
+
+  it "should ensure all defined defaults are accessible attributes" do
+    [Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES, Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS].each do |opts|
+      opts.each do |key,val|
+        @config.should respond_to(key)
+      end
+    end
+  end
+
+  it "should initialize with defaults from the defined constants" do
+    [Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES, Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS].each do |opts|
+      opts.each do |key,val|
+        @config.send(key).should == val
+      end
+    end
+  end
+  
+  describe "PRIMARY_AUTHORIZATION_CLASSES" do
+    it "should define the :subject_class option" do
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES.has_key?(:subject_class).should be_true
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES[:subject_class].should == :user
+    end
+    
+    it "should define the :role_class option" do
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES.has_key?(:role_class).should be_true
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES[:role_class].should == :role
+    end
+    
+    it "should define the :permission_class option" do
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES.has_key?(:permission_class).should be_true
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES[:permission_class].should == :permission
+    end
+  end
+  
+  describe "AUTHORIZATION_JOIN_CLASSES" do
+    it "should define the :role_subject_class option" do
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES.has_key?(:role_subject_class).should be_true
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES[:role_subject_class].should == :role_user
+    end
+    
+    it "should define the :permission_role_class option" do
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES.has_key?(:permission_role_class).should be_true
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES[:permission_role_class].should == :permission_role
+    end
+    
+    it "should define the :permission_subject_class option" do
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES.has_key?(:permission_subject_class).should be_true
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES[:permission_subject_class].should == :permission_user
+    end
+  end
+  
+  describe "DEFAULT_AUTHORIZATION_CLASSES" do
+    it "should combine the PRIMARY_AUTHORIZATION_CLASSES and AUTHORIZATION_JOIN_CLASSES" do
+      [Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES, Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES].each do |classes|
+        classes.each do |key,val|
+          Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES.has_key?(key).should be_true
+          Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES[key].should == val
+        end
+      end
+    end
+  end
+  
+  describe "DEFAULT_CONFIGURATION_OPTIONS" do
+    it "should define the :acl_default option" do
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS.has_key?(:acl_default).should be_true
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS[:acl_default].should == :deny
+    end
+    
+    it "should define the :subject_method option" do
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS.has_key?(:subject_method).should be_true
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS[:subject_method].should == :current_user
+    end
+
+    it "should define the :with_permissions option" do
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS.has_key?(:with_permissions).should be_true
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS[:with_permissions].should == true
+    end
+
+    it "should define the :force_context option" do
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS.has_key?(:force_context).should be_true
+      Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS[:force_context].should == false
+    end
+  end
+
+  describe "#configure" do
+    context "with a hash" do
+      it "should use the hash keys/vals to set instance variables" do
+        @config.configure(:subject_class => :custom_subject, :acl_default => :allow)
+        @config.subject_class.should == :custom_subject
+        @config.acl_default.should == :allow
+      end
+
+      it "should not allow setting instance variables that are not defined as defaults" do
+        @config.configure(:bad_key => :bad_value)
+        @config.should_not respond_to(:bad_key)
+        @config.instance_eval do
+          @bad_key.should == nil
+        end
+      end
+    end
+
+    context "with a block" do
+      it "should allow setting config vars via the passed config object" do
+        @config.configure do |config|
+          config.subject_method = :config_current_user
+        end
+        @config.subject_method.should == :config_current_user
+      end
+
+      it "should allow setting config vars via instance variables" do
+        @config.configure do
+          @subject_method = :ivar_current_user
+        end
+        @config.subject_method.should == :ivar_current_user
+      end
+
+      it "should allow setting config vars via self" do
+        @config.configure do
+          self.subject_method = :self_current_user
+        end
+        @config.subject_method.should == :self_current_user
+      end
+    end
+
+    context "with a hash and a block" do
+      it "should use both the hash and block for configuration" do
+        @config.configure(:subject_class => :custom_subject) do |config|
+          config.role_class = :custom_role
+        end
+        @config.subject_class.should == :custom_subject
+        @config.role_class.should == :custom_role
+      end
+
+      it "should override hash values with values set in the block" do
+        @config.configure(:role_class => :hash_role) do |config|
+          config.role_class = :block_role
+        end
+        @config.role_class.should == :block_role
+      end
+    end
+    
+    it "should redefine the join classes when custom classes are provided" do
+      @config.configure(:subject_class => :soldier, :role_class => :rank, :permission_class => :skill)
+      @config.role_subject_class.should == "RankSoldier"
+      @config.permission_subject_class.should == "SkillSoldier"
+      @config.permission_role_class.should == "RankSkill"
+    end
+
+    it "should not override join classes if they were provided" do
+      @config.configure(:role_subject_class => :special_role_user, :role_class => :rank)
+      @config.role_subject_class.should == :special_role_user
+    end
+  end
+
+  describe "#to_hash" do
+    it "should return a hash with all the configuration keys" do
+      [Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES, Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS].each do |opts|
+        opts.keys.each do |key|
+          @config.to_hash.has_key?(key).should be_true
+        end
+      end
+    end
+
+    it "should populate values with the current configuration values" do
+      [Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES, Zuul::Configuration::DEFAULT_CONFIGURATION_OPTIONS].each do |opts|
+        opts.keys.each do |key|
+          @config.to_hash[key].should == @config.send(key)
+        end
+      end
+    end
+  end
+
+  describe "#classes" do
+    it "should return a ClassStruct" do
+      @config.classes.class.ancestors.should include(Zuul::Configuration::ClassStruct)
+    end
+
+    it "should return a ClassStruct of all the default configuration classes" do
+      Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES.keys.each do |key|
+        @config.classes.should respond_to(key)
+      end
+      @config.classes.keys.each do |key|
+        Zuul::Configuration::DEFAULT_AUTHORIZATION_CLASSES.has_key?(key).should be_true
+      end
+    end
+  end
+
+  describe "#primary_classes" do
+    it "should return a ClassStruct" do
+      @config.classes.class.ancestors.should include(Zuul::Configuration::ClassStruct)
+    end
+
+    it "should return a ClassStruct of all the default configuration classes" do
+      Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES.keys.each do |key|
+        @config.primary_classes.should respond_to(key)
+      end
+      @config.primary_classes.keys.each do |key|
+        Zuul::Configuration::PRIMARY_AUTHORIZATION_CLASSES.has_key?(key).should be_true
+      end
+    end
+  end
+
+  describe "#join_classes" do
+    it "should return a ClassStruct" do
+      @config.join_classes.class.ancestors.should include(Zuul::Configuration::ClassStruct)
+    end
+
+    it "should return a ClassStruct of all the default configuration join classes" do
+      Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES.keys.each do |key|
+        @config.join_classes.should respond_to(key)
+      end
+      @config.join_classes.keys.each do |key|
+        Zuul::Configuration::AUTHORIZATION_JOIN_CLASSES.has_key?(key).should be_true
+      end
+    end
+  end
+
+  describe "Zuul::Configuration::ClassStruct" do
+    it "should inherit from Struct" do
+      Zuul::Configuration::ClassStruct.ancestors.should include(Struct)
+    end
+
+    describe "#keys" do
+      it "should return an array of keys" do
+        Zuul::Configuration::ClassStruct.new(:key1, :key2, :key3).new.keys.should == [:key1, :key2, :key3]
+      end
+    end
+
+    describe "#to_array" do
+      it "should return an array of values" do
+        Zuul::Configuration::ClassStruct.new(:key1, :key2, :key3).new(:val1, :val2, :val3).to_array.should == [:val1, :val2, :val3]
+      end
+    end
+
+    describe "#to_hash" do
+      it "should return a hash of key/value pairs" do
+        Zuul::Configuration::ClassStruct.new(:key1, :key2, :key3).new(:val1, :val2, :val3).to_hash.should == {:key1 => :val1, :key2 => :val2, :key3 => :val3}
+      end
+    end
+  end
+end

data/spec/zuul/context_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe "Zuul::Context" do
+
+  describe "parse" do
+    it "should allow passing nil" do
+      expect { Zuul::Context.parse(nil) }.to_not raise_exception
+    end
+
+    it "should allow passing a class" do
+      expect { Zuul::Context.parse(Context) }.to_not raise_exception
+    end
+
+    it "should allow passing an instance" do
+      context = Context.create(:name => "Test Context")
+      expect { Zuul::Context.parse(context) }.to_not raise_exception
+    end
+    
+    it "should allow passing another context" do
+      expect { Zuul::Context.parse(Zuul::Context.new) }.to_not raise_exception
+    end
+    
+    it "should allow passing a class_name and id" do
+      expect { Zuul::Context.parse('Context', 1) }.to_not raise_exception
+    end
+
+    it "should return an Zuul::Context object with the context broken into it's two parts" do
+      parsed = Zuul::Context.parse(nil)
+      parsed.should be_an_instance_of(Zuul::Context)
+    end
+    
+    it "should return a nil context context for nil" do
+      parsed = Zuul::Context.parse(nil)
+      parsed.class_name.should be_nil
+      parsed.id.should be_nil
+    end
+
+    it "should return a context with class_name set to the class name for class context" do
+      parsed = Zuul::Context.parse(Context)
+      parsed.class_name.should == 'Context'
+      parsed.id.should be_nil
+    end
+    
+    it "should return a context with class_name and id set for an instance context" do
+      context = Context.create(:name => "Test Context")
+      parsed = Zuul::Context.parse(context)
+      parsed.class_name.should == 'Context'
+      parsed.id.should == context.id
+    end
+  end
+
+  describe "#to_context" do
+    it "should return nil for a nil context" do
+      Zuul::Context.new.to_context.should be_nil
+    end
+
+    it "should return the class for a class context" do
+      Zuul::Context.new('Context', nil).to_context.should == Context
+    end
+
+    it "should return the instance for an instance context" do
+      obj = Context.create(:name => "Test Context")
+      context = Zuul::Context.new('Context', obj.id).to_context
+      context.should be_an_instance_of(Context)
+      context.id.should == obj.id
+    end
+  end
+
+  describe "#instance?" do
+    it "should return false for a nil context" do
+      Zuul::Context.new.instance?.should be_false
+    end
+
+    it "should return false for a class context" do
+      Zuul::Context.new('Context', nil).instance?.should be_false
+    end
+
+    it "should return true for an instance context" do
+      obj = Context.create(:name => "Test Context")
+      Zuul::Context.new('Context', obj.id).instance?.should be_true
+    end
+  end
+
+  describe "#class?" do
+    it "should return false for a nil context" do
+      Zuul::Context.new.class?.should be_false
+    end
+
+    it "should return true for a class context" do
+      Zuul::Context.new('Context', nil).class?.should be_true
+    end
+
+    it "should return false for an instance context" do
+      obj = Context.create(:name => "Test Context")
+      Zuul::Context.new('Context', obj.id).class?.should be_false
+    end
+  end
+
+  describe "#nil?" do
+    it "should return true for a nil context" do
+      Zuul::Context.new.nil?.should be_true
+    end
+
+    it "should return false for a class context" do
+      Zuul::Context.new('Context', nil).nil?.should be_false
+    end
+
+    it "should return false for an instance context" do
+      obj = Context.create(:name => "Test Context")
+      Zuul::Context.new('Context', obj.id).nil?.should be_false
+    end
+  end
+
+  describe "#type" do
+    it "should return :nil for a nil context" do
+      Zuul::Context.new.type.should == :nil
+    end
+
+    it "should return :class for a class context" do
+      Zuul::Context.new('Context', nil).type.should == :class
+    end
+
+    it "should return :instance for an instance context" do
+      obj = Context.create(:name => "Test Context")
+      Zuul::Context.new('Context', obj.id).type.should == :instance
+    end
+  end
+end

data/spec/zuul_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Zuul" do
+  it "should possess a readable configuration object" do
+    Zuul.configuration.should be_an_instance_of(Zuul::Configuration)
+  end
+
+  it "should forward calls to configure on to the configuration object" do
+    Zuul.should respond_to(:configure)
+    Zuul.configure do |config|
+      config.should == Zuul.configuration
+    end
+  end
+
+end

metadata

@@ -1,87 +1,198 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zuul
-version: !ruby/object:Gem::Version 
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
-- Wes Gibbs
+authors:
+- Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-11-04 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
-description: A simple authorization solution for Rails apps.
-email: wes@hashrocket.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Flexible, configurable authorization system for ActiveRecord and an access
+  control DSL for ActionController.
+email:
+- mark@markrebec.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+extra_rdoc_files: []
+files:
+- lib/tasks/zuul.rake
+- lib/zuul_viz.rb
+- lib/zuul/action_controller/evaluators.rb
+- lib/zuul/action_controller/dsl.rb
+- lib/zuul/active_record/scope.rb
+- lib/zuul/active_record/role.rb
+- lib/zuul/active_record/permission_role.rb
+- lib/zuul/active_record/context.rb
+- lib/zuul/active_record/permission.rb
+- lib/zuul/active_record/subject.rb
+- lib/zuul/active_record/role_subject.rb
+- lib/zuul/active_record/permission_subject.rb
+- lib/zuul/active_record.rb
+- lib/zuul/railtie.rb
+- lib/zuul/action_controller.rb
+- lib/zuul/configuration.rb
+- lib/zuul/version.rb
+- lib/zuul/context.rb
+- lib/zuul/exceptions.rb
+- lib/zuul/exceptions/undefined_scope.rb
+- lib/zuul/exceptions/access_denied.rb
+- lib/zuul/exceptions/invalid_context.rb
+- lib/generators/zuul/permission_subject_generator.rb
+- lib/generators/zuul/role_subject_generator.rb
+- lib/generators/zuul/subject_generator.rb
+- lib/generators/zuul/role_generator.rb
+- lib/generators/zuul/permission_generator.rb
+- lib/generators/zuul/templates/role_subject_existing.rb
+- lib/generators/zuul/templates/role.rb
+- lib/generators/zuul/templates/permission_role.rb
+- lib/generators/zuul/templates/permission_subject_existing.rb
+- lib/generators/zuul/templates/permission_existing.rb
+- lib/generators/zuul/templates/permission.rb
+- lib/generators/zuul/templates/role_subject.rb
+- lib/generators/zuul/templates/role_existing.rb
+- lib/generators/zuul/templates/permission_role_existing.rb
+- lib/generators/zuul/templates/permission_subject.rb
+- lib/generators/zuul/orm_helpers.rb
+- lib/generators/zuul/permission_role_generator.rb
 - lib/zuul.rb
-- lib/zuul/restrict_access.rb
-- lib/zuul/valid_roles.rb
-- zuul.gemspec
-has_rdoc: true
-homepage: http://github.com/wgibbs/zuul
+- spec/db/schema.rb
+- spec/zuul_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/capture_stdout.rb
+- spec/zuul/configuration_spec.rb
+- spec/zuul/active_record/role_spec.rb
+- spec/zuul/active_record/subject_spec.rb
+- spec/zuul/active_record/scope_spec.rb
+- spec/zuul/active_record/permission_spec.rb
+- spec/zuul/active_record/context_spec.rb
+- spec/zuul/active_record/role_subject_spec.rb
+- spec/zuul/active_record/permission_role_spec.rb
+- spec/zuul/active_record/permission_subject_spec.rb
+- spec/zuul/context_spec.rb
+- spec/zuul/active_record_spec.rb
+homepage: http://github.com/markrebec/zuul
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+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.3.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Simple Rails Authorization
-test_files: 
-- spec/rails_root/app/controllers/application_controller.rb
-- spec/rails_root/app/models/user.rb
-- spec/rails_root/config/boot.rb
-- spec/rails_root/config/database.yml
-- spec/rails_root/config/environment.rb
-- spec/rails_root/config/environments/test.rb
-- spec/rails_root/config/initializers/session_store.rb
-- spec/rails_root/config/routes.rb
-- spec/rails_root/db/test.sqlite3
-- spec/rails_root/log/test.log
-- spec/rails_root/spec/controllers/require_user_spec.rb
-- spec/rails_root/spec/controllers/restrict_access_spec.rb
-- spec/rails_root/spec/models/user_spec.rb
-- spec/rails_root/spec/spec_helper.rb
+summary: Authorizaion and ACL for Activerecord and ActionController.
+test_files:
+- spec/db/schema.rb
+- spec/zuul_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/capture_stdout.rb
+- spec/zuul/configuration_spec.rb
+- spec/zuul/active_record/role_spec.rb
+- spec/zuul/active_record/subject_spec.rb
+- spec/zuul/active_record/scope_spec.rb
+- spec/zuul/active_record/permission_spec.rb
+- spec/zuul/active_record/context_spec.rb
+- spec/zuul/active_record/role_subject_spec.rb
+- spec/zuul/active_record/permission_role_spec.rb
+- spec/zuul/active_record/permission_subject_spec.rb
+- spec/zuul/context_spec.rb
+- spec/zuul/active_record_spec.rb