consul 0.3.0 → 0.4.0

data/spec/shared/consul/power_spec.rb

@@ -0,0 +1,361 @@
+require 'spec_helper'
+
+describe Consul::Power do
+
+  before :each do
+    @user = User.create!
+    @deleted_client = Client.create!(:deleted => true)
+    @client1 = Client.create!
+    @client1_note1 = @client1.notes.create!
+    @client1_note2 = @client1.notes.create!
+    @client2 = Client.create!
+    @client2_note1 = @client2.notes.create!
+    @client2_note2 = @client2.notes.create!
+  end
+
+  describe 'integration scenario' do
+
+    it 'should work with real records' do
+      Client.active.should == [@client1, @client2]
+      @client1.notes.should == [@client1_note1, @client1_note2] 
+    end
+
+  end
+
+  context 'scope powers' do
+
+    it 'should return the registered scope' do
+      @user.power.clients.all.should == [@client1, @client2]
+    end
+
+    it 'should allow to register scopes with arguments' do
+      @user.power.client_notes(@client1).should == [@client1_note1, @client1_note2]
+    end
+
+    describe '#include?' do
+
+      context 'when no record is given' do
+
+        it 'should return true if the power returns a scope (which might or might not match records)' do
+          @user.power.clients?.should be_true
+        end
+
+        it 'should return false if the power returns nil' do
+          @user.role = 'guest'
+          @user.power.clients.should be_nil
+          @user.power.clients?.should be_false
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should return true if the record belongs to the scope' do
+          @user.power.client?(@client1).should be_true
+        end
+
+        it 'should return false if the record does not belong to the scope' do
+          @user.power.client?(@deleted_client).should be_false
+        end
+
+        it 'should only trigger a single query for multiple checks on the same scope' do
+          ActiveRecord::Base.connection.should_receive(:select_values).once.and_return([]) #.and_return(double('connection').as_null_object)
+          @user.power.client?(@client1)
+          @user.power.client?(@deleted_client)
+        end
+
+      end
+
+    end
+
+    describe '#include!' do
+
+      context 'when no record is given' do
+
+        it 'should raise Consul::Powerless when the power returns nil' do
+          @user.role = 'guest'
+          @user.power.clients.should be_nil
+          expect { @user.power.clients! }.to raise_error(Consul::Powerless)
+        end
+
+        it 'should not raise Consul::Powerless when the power returns a scope (which might or might not match records)' do
+          expect { @user.power.clients! }.to_not raise_error
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should raise Consul::Powerless when record belongs is inside the scope' do
+          expect { @user.power.client!(@deleted_client) }.to raise_error(Consul::Powerless)
+        end
+
+        it 'should not raise Consul::Powerless when the record is outside a scope' do
+          expect { @user.power.client!(@client1) }.to_not raise_error
+        end
+
+      end
+
+    end
+
+    describe 'retrieving scope_ids' do
+
+      it 'should return record ids that match the registered scope' do
+        @user.power.client_ids.should == [@client1.id, @client2.id]
+      end
+
+      it 'should cache scope ids' do
+        @user.power.should_receive(:clients).once.and_return(double('scope', :construct_finder_sql => 'SELECT 1').as_null_object)
+        2.times { @user.power.client_ids }
+      end
+
+      it 'should return ids when the scope joins another table (bugfix)' do
+        expect { @user.power.note_ids }.to_not raise_error
+      end
+
+    end
+
+  end
+
+  context 'collection powers' do
+
+    it 'should return the registered collection' do
+      @user.power.key_figures.should == %w[amount working_costs]
+    end
+
+    describe '#include?' do
+
+      context 'when no record is given' do
+
+        it 'should return true if the returns an enumerable (which might or might not be empty)' do
+          @user.power.key_figures?.should be_true
+        end
+
+        it 'should return false if the power returns nil' do
+          @user.role = 'guest'
+          @user.power.key_figures.should be_nil
+          @user.power.key_figures?.should be_false
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should return true if the power contains the given record' do
+          @user.power.key_figure?('amount').should be_true
+        end
+
+        it 'should return false if the power does not contain the given record' do
+          @user.power.key_figure?('xyz').should be_false
+        end
+
+      end
+
+    end
+
+    describe '#include!' do
+
+      context 'when no record is given' do
+
+        it 'should not raise Consul::Powerless if the power returns an enumerable (which might or might not be empty)' do
+          expect { @user.power.key_figures! }.to_not raise_error
+        end
+
+        it 'should raise Consul::Powerless if the power returns nil' do
+          @user.role = 'guest'
+          @user.power.key_figures.should be_nil
+          expect { @user.power.key_figures! }.to raise_error(Consul::Powerless)
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should not raise Consul::Powerless if the power contains the given record' do
+          expect { @user.power.key_figure?('amount') }.to_not raise_error
+        end
+
+        it 'should raise Consul::Powerless if the power does not contain the given record' do
+          expect { @user.power.key_figure!('xyz') }.to raise_error(Consul::Powerless)
+        end
+      end
+
+    end
+
+  end
+
+  context 'boolean powers' do
+
+    it 'should return the registered value' do
+      @user.power.always_true.should == true
+      @user.power.always_false.should == false
+    end
+
+    describe '#include?' do
+
+      context 'when no record is given' do
+
+        it 'should return true when the queried power returns true' do
+          @user.power.always_true?.should be_true
+        end
+
+        it 'should return false when the queried power returns false' do
+          @user.power.always_false?.should be_false
+        end
+
+        it 'should return false when the queried power returns nil' do
+          @user.power.always_nil?.should be_false
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should raise Consul::NoCollection' do
+          expect { @user.power.always_true?('foo') }.to raise_error(Consul::NoCollection)
+        end
+
+      end
+
+    end
+
+    describe '#include!' do
+
+      context 'when no record is given' do
+
+        it 'should not raise Consul::Powerless when the power returns true' do
+          expect { @user.power.always_true! }.to_not raise_error
+        end
+
+        it 'should raise Consul::Powerless when the power returns false' do
+          expect { @user.power.always_false! }.to raise_error(Consul::Powerless)
+        end
+
+        it 'should raise Consul::Powerless when the power returns nil' do
+          expect { @user.power.always_nil! }.to raise_error(Consul::Powerless)
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should raise Consul::NoCollection' do
+          expect { @user.power.always_true!('foo') }.to raise_error(Consul::NoCollection)
+        end
+      end
+
+    end
+
+
+  end
+
+  context 'powers of other types' do
+
+    it 'should return the registered value' do
+      @user.power.api_key.should == 'secret-api-key'
+    end
+
+    describe '#include?' do
+
+      context 'when no record is given' do
+
+        it 'should return true if the power is not nil' do
+          @user.power.api_key?.should be_true
+        end
+
+        it 'should return false if the power is nil' do
+          @user.role = 'guest'
+          @user.power.api_key.should be_nil
+          @user.power.api_key?.should be_false
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should raise Consul::NoCollection' do
+          expect { @user.power.api_key?('foo') }.to raise_error(Consul::NoCollection)
+        end
+
+      end
+
+    end
+
+    describe '#include!' do
+
+      context 'when no record is given' do
+
+        it 'should not raise Consul::Powerless if the power is not nil' do
+          expect { @user.power.api_key! }.to_not raise_error
+        end
+
+        it 'should raise Consul::powerless if the power is nil' do
+          @user.role = 'guest'
+          @user.power.api_key.should be_nil
+          expect { @user.power.api_key! }.to raise_error(Consul::Powerless)
+        end
+
+      end
+
+      context 'with a given record' do
+
+        it 'should raise Consul::NoCollection' do
+          expect { @user.power.api_key!('foo') }.to raise_error(Consul::NoCollection)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '.current' do
+
+    it 'should provide a class method to set and get the current Power' do
+      Power.current = 'current power'
+      Power.current.should == 'current power'
+      Power.current = nil
+      Power.current.should be_nil
+    end
+
+  end
+
+  describe '.with_power' do
+
+    it 'should provide the given power as current power for the duration of the block' do
+      spy = double
+      inner_power = Power.new('inner')
+      Power.current = 'outer power'
+      spy.should_receive(:observe).with(inner_power)
+      Power.with_power(inner_power) do
+        spy.observe(Power.current)
+      end
+      Power.current.should == 'outer power'
+      Power.current = nil # clean up for subsequent specs -- to bad we can't use .with_power :)
+    end
+
+    it 'should restore an existing power even if the block raises an error' do
+      begin
+        inner_power = Power.new('inner')
+        Power.current = 'outer power'
+        Power.with_power(inner_power) do
+          raise ZeroDivisionError
+        end
+      rescue ZeroDivisionError
+        # do nothing
+      end
+      Power.current.should == 'outer power'
+    end
+
+    it 'should call instantiate a new Power if the given argument is not already a power' do
+      spy = double
+      Power.should_receive(:new).with('argument').and_return('instantiated power')
+      spy.should_receive(:observe).with('instantiated power')
+      Power.with_power('argument') do
+        spy.observe(Power.current)
+      end
+    end
+
+  end
+
+end

data/spec/{controllers → shared/controllers}/cakes_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe CakesController do
+describe CakesController, :type => :controller do
 
   describe '#show' do
     it 'should get the power :cakes' do

data/spec/{controllers → shared/controllers}/dashboards_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe DashboardsController do
+describe DashboardsController, :type => :controller do
 
   it "should not raise an error if the checked power is given" do
     expect { get :show }.to_not raise_error

data/spec/{controllers → shared/controllers}/risks_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe RisksController do
+describe RisksController, :type => :controller do
 
   it "should raise an error it includes Consul::Controller but forgets to define current_power do ... end" do
     expect { put :show, :id => '1' }.to raise_error(Consul::UnreachablePower)

data/spec/{controllers → shared/controllers}/songs_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe SongsController do
+describe SongsController, :type => :controller do
 
   it 'should allow to skip a required power check' do
     expect { get :show, :id => '1' }.to_not raise_error

data/spec/shared/controllers/users_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe UsersController, :type => :controller do
+
+  it "should raise an error if the checked power is not given" do
+    expect { get :update, :id => '1' }.to raise_error(Consul::Powerless)
+  end
+
+  it 'should allow to map actions to another power using the :map option' do
+    expect { get :show, :id => '1' }.to_not raise_error
+  end
+
+
+  describe '.power_name_for_action' do
+
+    it 'should return the name of the power for the given action (feature request from devolute)' do
+      UsersController.power_name_for_action(:show).should == :always_true
+      UsersController.power_name_for_action('show').should == :always_true
+      UsersController.power_name_for_action(:update).should == :always_false
+      UsersController.power_name_for_action('update').should == :always_false
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: consul
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-04 00:00:00 +02:00
+date: 2012-08-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: memoizer
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -30,10 +30,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rails
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,81 +44,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: assignable_values
+  type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
-  name: rails
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
-  name: rspec
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
-  name: rspec-rails
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: shoulda-matchers
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: sqlite3
-  version_requirements: *id007
 description: A scope-based authorization solution for Ruby on Rails.
 email: henning.koch@makandra.de
 executables: []
@@ -129,7 +56,6 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- Gemfile
 - README.md
 - Rakefile
 - consul.gemspec
@@ -140,43 +66,44 @@ files:
 - lib/consul/power.rb
 - lib/consul/spec/matchers.rb
 - lib/consul/version.rb
-- spec/app_root/app/controllers/application_controller.rb
-- spec/app_root/app/controllers/cakes_controller.rb
-- spec/app_root/app/controllers/dashboards_controller.rb
-- spec/app_root/app/controllers/risks_controller.rb
-- spec/app_root/app/controllers/songs_controller.rb
-- spec/app_root/app/controllers/users_controller.rb
-- spec/app_root/app/models/client.rb
-- spec/app_root/app/models/note.rb
-- spec/app_root/app/models/power.rb
-- spec/app_root/app/models/user.rb
-- spec/app_root/config/boot.rb
-- spec/app_root/config/database.yml
-- spec/app_root/config/environment.rb
-- spec/app_root/config/environments/in_memory.rb
-- spec/app_root/config/environments/mysql.rb
-- spec/app_root/config/environments/postgresql.rb
-- spec/app_root/config/environments/sqlite.rb
-- spec/app_root/config/environments/sqlite3.rb
-- spec/app_root/config/routes.rb
-- spec/app_root/db/migrate/001_create_users.rb
-- spec/app_root/db/migrate/002_create_clients.rb
-- spec/app_root/db/migrate/003_create_notes.rb
-- spec/app_root/lib/console_with_fixtures.rb
-- spec/app_root/log/.gitignore
-- spec/app_root/script/console
-- spec/consul/active_record_spec.rb
-- spec/consul/power_spec.rb
-- spec/controllers/cakes_controller_spec.rb
-- spec/controllers/dashboards_controller_spec.rb
-- spec/controllers/risks_controller_spec.rb
-- spec/controllers/songs_controller_spec.rb
-- spec/controllers/users_controller_spec.rb
-- spec/rcov.opts
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/support/spec.opts
-- spec/support/spec_candy.rb
+- spec/rails-2.3/Gemfile
+- spec/rails-2.3/Rakefile
+- spec/rails-2.3/app_root/app/controllers/application_controller.rb
+- spec/rails-2.3/app_root/app/controllers/cakes_controller.rb
+- spec/rails-2.3/app_root/app/controllers/dashboards_controller.rb
+- spec/rails-2.3/app_root/app/controllers/risks_controller.rb
+- spec/rails-2.3/app_root/app/controllers/songs_controller.rb
+- spec/rails-2.3/app_root/app/controllers/users_controller.rb
+- spec/rails-2.3/app_root/app/models/client.rb
+- spec/rails-2.3/app_root/app/models/note.rb
+- spec/rails-2.3/app_root/app/models/power.rb
+- spec/rails-2.3/app_root/app/models/user.rb
+- spec/rails-2.3/app_root/config/boot.rb
+- spec/rails-2.3/app_root/config/database.yml
+- spec/rails-2.3/app_root/config/environment.rb
+- spec/rails-2.3/app_root/config/environments/in_memory.rb
+- spec/rails-2.3/app_root/config/environments/mysql.rb
+- spec/rails-2.3/app_root/config/environments/postgresql.rb
+- spec/rails-2.3/app_root/config/environments/sqlite.rb
+- spec/rails-2.3/app_root/config/environments/sqlite3.rb
+- spec/rails-2.3/app_root/config/preinitializer.rb
+- spec/rails-2.3/app_root/config/routes.rb
+- spec/rails-2.3/app_root/db/migrate/001_create_users.rb
+- spec/rails-2.3/app_root/db/migrate/002_create_clients.rb
+- spec/rails-2.3/app_root/db/migrate/003_create_notes.rb
+- spec/rails-2.3/app_root/lib/console_with_fixtures.rb
+- spec/rails-2.3/app_root/log/.gitignore
+- spec/rails-2.3/app_root/script/console
+- spec/rails-2.3/rcov.opts
+- spec/rails-2.3/spec.opts
+- spec/rails-2.3/spec_helper.rb
+- spec/shared/consul/active_record_spec.rb
+- spec/shared/consul/power_spec.rb
+- spec/shared/controllers/cakes_controller_spec.rb
+- spec/shared/controllers/dashboards_controller_spec.rb
+- spec/shared/controllers/risks_controller_spec.rb
+- spec/shared/controllers/songs_controller_spec.rb
+- spec/shared/controllers/users_controller_spec.rb
 has_rdoc: true
 homepage: https://github.com/makandra/consul
 licenses: []