consul 0.2.3 → 0.3.0

data/README.md

@@ -137,6 +137,9 @@ You can now use power scopes to control access:
 
     end
 
+
+### Protect entry into controller actions
+
 To make sure a power is given before every action in a controller:
 
     class NotesController < ApplicationController
@@ -151,6 +154,27 @@ You can also map different powers to different actions:
       power :notes, :map => { [:edit, :update, :destroy] => :changable_notes }
     end
 
+Actions that are not listed in `:map` will get the default action `:notes`.
+
+Note that in moderately complex authorization scenarios you will often find yourself writing a map like this:
+
+    class NotesController < ApplicationController
+      power :notes, :map => {
+        [:edit, :update] => :updatable_notes
+        [:new, :create] => :creatable_notes
+        [:destroy] => :destroyable_notes
+      }
+    end
+
+Because this pattern is so common, there is a shortcut `:crud` to do the same:
+
+    class NotesController < ApplicationController
+      power :crud => :notes
+    end
+
+
+### Auto-mapping a power scope to a controller method
+
 It is often convenient to map a power scope to a private controller method:
 
     class NotesController < ApplicationController
@@ -165,6 +189,9 @@ It is often convenient to map a power scope to a private controller method:
 
 This is especially useful when you are using a RESTful controller library like [resource_controller](https://github.com/jamesgolick/resource_controller). The mapped method is aware of the `:map` option.
 
+
+### How to never forget a power check
+
 You can force yourself to use a `power` check in every controller. This will raise `Consul::UncheckedPower` if you ever forget it:
 
     class ApplicationController < ActionController::Base

data/lib/consul/controller.rb

@@ -51,8 +51,17 @@ module Consul
         skip_power_check filter_options
 
         power_method = options[:power] || :current_power
+
         actions_map = (options[:map] || {})
 
+        if crud_resource = options[:crud]
+          default_power ||= crud_resource
+          actions_map[[:show, :index]] = crud_resource.to_sym
+          actions_map[[:new, :create]] = "creatable_#{crud_resource}".to_sym
+          actions_map[[:edit, :update]] = "updatable_#{crud_resource}".to_sym
+          actions_map[:destroy] = "destroyable_#{crud_resource}".to_sym
+        end
+
         direct_access_method = options[:as]
 
         # Store arguments for testing
@@ -63,14 +72,14 @@ module Consul
         private
 
         define_method :check_power do
-          send(power_method).include!(power_for_action)
+          send(power_method).include!(power_method_for_action)
         end
 
         define_method direct_access_method do
-          send(power_method).send(power_for_action)
+          send(power_method).send(power_method_for_action)
         end if direct_access_method
 
-        define_method :power_for_action do
+        define_method :power_method_for_action do
           key = actions_map.keys.detect do |actions|
             Array(actions).collect(&:to_s).include?(action_name)
           end

data/lib/consul/version.rb

@@ -1,3 +1,3 @@
 module Consul
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/spec/app_root/app/controllers/cakes_controller.rb

@@ -0,0 +1,47 @@
+class CakesController < ApplicationController
+
+  power :crud => :cakes, :as => :end_of_association_chain
+
+  def show
+    notify_spy
+  end
+
+  def index
+    notify_spy
+  end
+
+  def new
+    notify_spy
+  end
+
+  def create
+    notify_spy
+  end
+
+  def edit
+    notify_spy
+  end
+
+  def update
+    notify_spy
+  end
+
+  def destroy
+    notify_spy
+  end
+
+  def custom_action
+    notify_spy
+  end
+
+  private
+
+  def notify_spy
+    observe_end_of_association_chain(end_of_association_chain)
+  end
+
+  def observe_end_of_association_chain(scope)
+    # spy for spec
+  end
+
+end

data/spec/app_root/app/models/power.rb

@@ -29,6 +29,22 @@ class Power
     nil
   end
 
+  power :cakes do
+    :cakes
+  end
+
+  power :updatable_cakes do
+    :updatable_cakes
+  end
+
+  power :creatable_cakes do
+    :creatable_cakes
+  end
+
+  power :destroyable_cakes do
+    :destroyable_cakes
+  end
+
   def assignable_user_roles
     %w[guest admin]
   end

data/spec/app_root/config/routes.rb

@@ -8,4 +8,6 @@ ActionController::Routing::Routes.draw do |map|
 
   map.resources :risks
 
+  map.resources :cakes, :member => { :custom_action => :get }
+
 end

data/spec/controllers/cakes_controller_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe CakesController do
+
+  describe '#show' do
+    it 'should get the power :cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:cakes)
+      get :show, :id => 'id'
+    end
+  end
+
+  describe '#index' do
+    it 'should get the power :cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:cakes)
+      get :index
+    end
+  end
+
+  describe '#new' do
+    it 'should get the power :creatable_cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:creatable_cakes)
+      get :new
+    end
+  end
+
+  describe '#creatable' do
+    it 'should get the power :creatable_cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:creatable_cakes)
+      post :create
+    end
+  end
+
+  describe '#edit' do
+    it 'should get the power :updatable_cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:updatable_cakes)
+      get :edit, :id => 'id'
+    end
+  end
+
+  describe '#update' do
+    it 'should get the power :updatable_cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:updatable_cakes)
+      put :update, :id => 'id'
+    end
+  end
+
+  describe '#destroy' do
+    it 'should get the power :destroyable_cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:destroyable_cakes)
+      delete :destroy, :id => '1'
+    end
+  end
+
+  describe '#custom_action' do
+    it 'should get the power :cakes' do
+      controller.should_receive(:observe_end_of_association_chain).with(:cakes)
+      get :custom_action, :id => '1'
+    end
+  end
+
+end

data/spec/controllers/dashboards_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe DashboardsController do
 

data/spec/controllers/risks_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe RisksController do
 

data/spec/controllers/songs_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe SongsController do
 

data/spec/controllers/users_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe UsersController do
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: consul
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,10 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-05 00:00:00 Z
+date: 2012-07-04 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -27,12 +30,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-  prerelease: false
-  type: :runtime
   name: rails
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -41,12 +44,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
-  prerelease: false
-  type: :runtime
   name: assignable_values
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -56,12 +59,12 @@ dependencies:
         - 2
         - 3
         version: "2.3"
-  requirement: *id003
-  prerelease: false
-  type: :development
   name: rails
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -71,12 +74,12 @@ dependencies:
         - 1
         - 3
         version: "1.3"
-  requirement: *id004
-  prerelease: false
-  type: :development
   name: rspec
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -86,12 +89,12 @@ dependencies:
         - 1
         - 3
         version: "1.3"
-  requirement: *id005
-  prerelease: false
-  type: :development
   name: rspec-rails
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -100,12 +103,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
-  prerelease: false
-  type: :development
   name: shoulda-matchers
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -114,10 +117,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id007
-  prerelease: false
-  type: :development
   name: sqlite3
+  version_requirements: *id007
 description: A scope-based authorization solution for Ruby on Rails.
 email: henning.koch@makandra.de
 executables: []
@@ -140,6 +141,7 @@ files:
 - 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
@@ -165,6 +167,7 @@ files:
 - 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
@@ -174,6 +177,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/spec.opts
 - spec/support/spec_candy.rb
+has_rdoc: true
 homepage: https://github.com/makandra/consul
 licenses: []
 
@@ -203,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.3.9.4
 signing_key: 
 specification_version: 3
 summary: A scope-based authorization solution for Ruby on Rails.