cannie 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb9f9ff798ce6036fb378e643d66ab7a6cc678e8
-  data.tar.gz: 4ae746f74792940b996abfd21842078b8fe794a7
+  metadata.gz: 9fbbd16e6ac148de444fe153765a6dc094dc24e9
+  data.tar.gz: cb1002198639bb6ae623277915b5cc903147c88d
 SHA512:
-  metadata.gz: f7ce6ab4dfdfecca9c648bba8b28d19b8438cc15dc956098567853e54bf9d4cf4a8efece057537f6e30838a2db73d4014e2621fafaf55aa92ee12f975fc68a50
-  data.tar.gz: 65bd5926da7baf5da5f5329ce4a2c466dbf38236d55bfc0b64ba351abd37971604f3603d21a935e2bc3e93a5cbcc7d72e90230087d62bd70c179c4d3d1a8f335
+  metadata.gz: 87b47746d61b5604032cc51f2f11720893628a1b6019274d9ab870f41d875d76bd13119105fdfecc154020ecae50d2ada46792853aa4366f147903de97c53445
+  data.tar.gz: ae87022d66e48972f60f9fa31adef1a5e00e4e7324ab312fe32162375051f6ab8a6f78441a77251676740d78a2d3629ab47ee44b945fed372a7963beeb88dd2c

data/README.md

@@ -55,6 +55,38 @@ To be sure that permissions checking is handled in each action of your controlle
       #...
     end
 
+It's also possible to set a condition by specifying `:if` or `:unless` options for `check_permissions` call:
+
+    class PostsController < ApplicationController
+      check_permissions if: :some_method
+
+      #...
+    end
+
+or
+
+    class PostsController < ApplicationController
+      check_permissions if: ->(controller) { controller.some_method }
+
+      #...
+    end
+
+or
+
+    class PostsController < ApplicationController
+      check_permissions unless: some_method
+
+      #...
+    end
+
+or
+
+    class PostsController < ApplicationController
+      check_permissions unless: ->(controller) { controller.some_method }
+
+      #...
+    end
+
 To skip checking permissions for controller, add `skip_check_permissions` method call:
 
     class PagesController < ApplicationController
@@ -74,6 +106,43 @@ Checking of permissions on per-action basis is done by calling `permit!` method
       end
     end
 
+It is possible to check permissions for resource actions. Currently collection and entry name is taken from resource controller name (some_namespace/entries_controller => @entries/@entry instance variables).
+To add this behavior add `permit_resource_actions` instead of `check_permissions` with no need to write custom `permit!` calls in each resource action:
+
+    class EntriesController < ApplicationController
+      permit_resource_actions
+
+      def index
+        @entries = Entry.all
+      end
+
+      def show
+        @entry = Entry.find(params[:id])
+      end
+    end
+
+For now only standard resource actions supported: `index`, `show`, `new`, `create`, `edit`, `update`, `destroy`.
+To define `Permissions` properly, use this mapping of action names to permissions:
+ - :index => :list
+ - :show => :read
+ - :new or :create => :create
+ - :edit or :update => :update
+ - :destroy => :destroy
+
+ Sample `Permissions` class to deal with all resource actions for `EntriesController`:
+
+    class Permissions
+      include Cannie::Permissions
+
+      def initialize(user)
+        allow :list, on: Entry    # index action
+        allow :read, on: Entry    # show action
+        allow :create, on: Entry  # new & create actions
+        allow :update, on: Entry  # edit & update actions
+        allow :destroy, on: Entry # destroy action
+      end
+    end
+
 ### Handling of unpermitted access
 
 If user is not permitted for appropriate action, `Cannie::ActionForbidden` exception will be raised.

data/lib/cannie/controller_extensions.rb

@@ -7,6 +7,16 @@ module Cannie
       helper_method :can?, :current_permissions
     end
 
+    RESOURCE_ACTIONS = {
+      index:   :list,
+      show:    :read,
+      new:     :create,
+      create:  :create,
+      edit:    :update,
+      update:  :update,
+      destroy: :destroy
+    }
+
     module ClassMethods
       # Method is used to be sure, that permissions checking is handled for each action inside controller.
       #
@@ -37,6 +47,23 @@ module Cannie
           controller.instance_variable_set(:@_permitted, true)
         end
       end
+
+      # Permit resource actions [index, show, new, create, edit, update, destroy] in controller
+      #
+      #
+      def permit_resource_actions(options={})
+        after_action(options.slice(:only, :except)) do |controller|
+          begin
+            next if controller.permitted?
+            next if options[:if] && !controller.instance_eval(&options[:if])
+            next if options[:unless] && controller.instance_eval(&options[:unless])
+            controller.permit! RESOURCE_ACTIONS.with_indifferent_access[action_name], on: controller.subject_for_action
+          rescue Cannie::ActionForbidden
+            self.response_body = nil
+            raise
+          end
+        end
+      end
     end
 
     # Checks whether passed action is permitted for passed subject
@@ -80,6 +107,14 @@ module Cannie
       @current_permissions ||= ::Permissions.new(current_user)
     end
 
+    def subject_for_action
+      return unless RESOURCE_ACTIONS.with_indifferent_access.keys.include?(action_name)
+      entry_name = controller_name.classify.demodulize.downcase
+      collection_name = entry_name.pluralize
+      variable_name = action_name == 'index' ? collection_name : entry_name
+      instance_variable_get(:"@#{variable_name}")
+    end
+
     private
     attr_reader :_permitted
   end

data/lib/cannie/version.rb

@@ -1,3 +1,3 @@
 module Cannie
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/spec/cannie/controller_extensions_spec.rb

@@ -4,6 +4,17 @@ describe Cannie::ControllerExtensions do
   let(:klass) {
     Class.new(ActionController::Base) do
       def action; end
+      def index
+        @entries = [1,2,3,4,5]
+        render text: @entries.to_s
+      end
+
+      %i(show new create edit update destroy).each do |action|
+        define_method action do
+          @entry = 123
+          render text: @entry.to_s
+        end
+      end
     end
   }
 
@@ -21,6 +32,17 @@ describe Cannie::ControllerExtensions do
     end
   end
 
+  let(:resource_permissions) do
+    Class.new do
+      include Cannie::Permissions
+
+      def initialize
+        allow :list, on: Array
+        %i(read create update destroy).each{ |v| allow v, on: Fixnum }
+      end
+    end
+  end
+
   describe '.check_permissions' do
     describe 'without conditions' do
       before { klass.check_permissions }
@@ -72,6 +94,37 @@ describe Cannie::ControllerExtensions do
     end
   end
 
+  describe 'permit_resource_actions' do
+    before do
+      klass.permit_resource_actions
+      subject.stub(:controller_name).and_return('test/entries')
+      subject.stub(:current_permissions).and_return resource_permissions.new
+    end
+
+    it 'calls permit! for index with valid params' do
+      expect(subject).to receive(:permit!).with(Cannie::ControllerExtensions::RESOURCE_ACTIONS[:index], on: [1,2,3,4,5])
+      subject.dispatch(:index, ActionDispatch::TestRequest.new)
+    end
+
+    it 'calls permit! for show with valid params' do
+      expect(subject).to receive(:permit!).with(Cannie::ControllerExtensions::RESOURCE_ACTIONS[:show], on: 123)
+      subject.dispatch(:show, ActionDispatch::TestRequest.new)
+    end
+
+    %i(index show).each do |action|
+      it "permits #{action} action" do
+        subject.dispatch(action, ActionDispatch::TestRequest.new)
+        expect(subject.permitted?).to be_true
+      end
+    end
+
+    it 'raises Cannie::ActionForbidden error up the stack' do
+      expect(subject).to receive(:index).and_raise(Cannie::ActionForbidden)
+      expect { subject.dispatch(:index, ActionDispatch::TestRequest.new) }.to raise_error(Cannie::ActionForbidden)
+      expect(subject.response_body).to be_nil
+    end
+  end
+
   describe '#can?' do
     it 'raises SubjectNotSetError if value of :on param is nil' do
       expect { subject.can? :action }.to raise_error(Cannie::SubjectNotSetError)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cannie
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - hck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler