walruz-rails 0.0.10 → 0.0.11

data/README.rdoc

@@ -1,6 +1,6 @@
 = walruz-rails
 
-Simple but Powerful authorization features for Ruby on Rails.
+Walruz[http://rdoc.info/projects/noomii/walruz]: Simple yet Powerful Policy Composition Authorization Framework
 
 walruz-rails is a Walruz extension that allows you to integrate easily the Walruz authorization framework with Ruby on Rails.
 
@@ -11,6 +11,29 @@ For more information about the functionality of walruz please check the walruz w
 * It provides generators to setup easily your authorization policies
 * It provides filters for ActionController that enhances the invocations for verification of authorizations
 
+== INSTALL
+
+Installation can be done in two ways, either as a gem configuring the dependency in environment.rb
+
+  config.gem 'walruz-rails'
+  
+or as a plugin through script/plugin install
+
+  $ script/plugin install git://github.com/noomii/walruz-rails.git
+
+Afterwards execute the generator to enable walruz on your project: 
+
+  $ script/generate walruz
+  
+This will generate the policies structure on the lib/ folder, and also it will add an initializer that setups your models for Walruz (config/initializers/walruz_intializer.rb).
+
+If you want to generate new policies, you may do so executing:
+
+  $ script/generate walruz_policy policy_name
+  
+
+All policies will be stored on the `lib/walruz/policies` folder. To organize your policies you may use the `lib/walruz/policies` file.
+
 
 == HOW TO USE THE FILTERS
 
@@ -34,28 +57,10 @@ All this invocations will get translated to:
 
 The result of this invocation will be on a controller method called `policy_params`.
 
-== INSTALL
-
-Installation can be done in two ways, either as a gem configuring the dependency in environment.rb
-
-  config.gem 'walruz-rails'
-  
-or as a plugin through script/plugin install
-
-  $ script/plugin install git://github.com/noomii/walruz-rails.git
-
-Afterwards execute the generator to enable walruz on your project: 
-
-  $ script/generate walruz
-  
-This will generate the policies structure on the lib/ folder, and also it will add an initializer that setups your models for Walruz (config/initializers/walruz_intializer.rb).
+== Links
 
-If you want to generate new policies, you may do so executing:
-
-  $ script/generate walruz_policy policy_name
-  
-
-All policies will be stored on the `lib/walruz/policies` folder. To organize your policies you may use the `lib/walruz/policies` file.
+"Walruz on Github"[http://github.com/noomii/walruz]
+"Walruz Documentation"[http://rdoc.info/projects/noomii/walruz]
 
 == Copyright
 

data/lib/walruz/controller_mixin.rb

@@ -1,6 +1,6 @@
 module Walruz
   module ControllerMixin
-    
+
     def self.included(base)
       base.class_eval do
         include InstanceMethods
@@ -8,32 +8,36 @@ module Walruz
         helper_method(:policy_params)
       end
     end
-    
+
     module InstanceMethods
-      
+
       def set_policy_params!(params)
         @_policy_params = params
       end
-      
+
       def policy_params
         @_policy_params
       end
-      
+
     end
-    
+
     module ClassMethods
-      
+
+      #
+      # Creates a before filter that will check if the actor returned by the
+      # method `current_user` can execute the given action on the given
+      # subject.
+      #
       #
-      # Returns a before filter that will check if the actor returned by the method `current_user` can execute the 
-      # given action on the given subject.
-      # 
       # Requirements:
-      #   - The controller must have a method called `current_user` that returns the authenticated user
+      #   - The controller must have a method called `current_user` that
+      #     returns the authenticated user
       #
       # Parameters:
-      #   - action:  Symbol that represents the action wich will be executed on the subject
-      #   - subject: Symbol that indicates an instance variable or method on the controller that
-      #              returns the subject
+      #   - action:  Symbol that represents the action wich will be executed
+      #              on the subject
+      #   - subject: Symbol that indicates an instance variable or method on
+      #              the controller that returns the subject
       #
       # Returns:
       #   A proc that will be executed as a before_filter method
@@ -41,9 +45,12 @@ module Walruz
       # Example:
       #
       #   class UserController < ActionController::Base
-      #     
-      #     before_filter check_authorization!(:create, :user), :only => [:new, :create]
-      #     before_filter check_authorization!(:destroy, :complicated_method_that_returns_a_user), :only => :destroy
+      #
+      #     before_filter check_authorization!(:create, :user),
+      #                   :only => [:new, :create]
+      #     before_filter check_authorization!(:destroy,
+      #                   :complicated_method_that_returns_a_user),
+      #                   :only => :destroy
       #
       #     def complicated_method_that_returns_a_user
       #       # some complex logic here
@@ -54,43 +61,107 @@ module Walruz
       def check_authorization!(action, subject)
         lambda do |controller|
           # we get the subject
-          subject_instance = if controller.instance_variable_defined?("@%s" % subject)
+          subject_instance =
+                    if controller.instance_variable_defined?("@%s" % subject)
                       controller.instance_variable_get("@%s" % subject)
                     elsif controller.respond_to?(subject)
                       controller.send(subject)
                     else
-                      error_message = "There is neither an instance variable @%s nor a instance method %s on the %s instance context" % [subject, subject, controller.class.name]
+                      error_message = "There is neither an instance variable \
+                      @%s nor a instance method %s on the %s instance\
+                      context" % [subject, subject, controller.class.name]
                       raise ArgumentError.new(error_message)
                     end
-          params = Walruz.authorize!(controller.send(:current_user), action, subject_instance)
+          params = Walruz.authorize!(controller.send(:current_user),
+                                     action,
+                                     subject_instance)
           controller.set_policy_params!(params)
         end
       end
-      
-      
+
+      #
+      # Creates a before filter that will check the policy represented
+      # by the given symbol, using `current_user` as the actor 
+      #
       #
-      # Generates dynamically all the before filters needed for authorizations on a CRUD model.
-      # 
       # Requirements:
-      #  - The controller must have a method called `current_user` that returns the authenticated user
-      #  - The subject must implement the four actions (:create, :read, :update, :destroy) or have a :default action
-      #  
+      #   - The controller must have a method called `current_user` that
+      #     returns the authenticated user
+      #
       # Parameters:
-      #   - subject: Symbol that indicates an instance variable or method on the controller that
-      #              returns the subject
+      #   - policy_label: Symbol that represents the policy wich will be 
+      #                   executed on the subject
+      #
+      #   - subject: Symbol that indicates an instance variable or method on
+      #              the controller that returns the subject
+      #
+      # Returns:
+      #   A proc that will be executed as a before_filter method
+      #
+      # Example:
+      #
+      #   class UserController < ActionController::Base
+      #
+      #     before_filter check_policy!(:is_admin, :user),
+      #                   :only => [:new, :create]
+      #     before_filter check_policy!(:can_read_posts,
+      #                   :complicated_method_that_returns_a_user),
+      #                   :only => :destroy
+      #
+      #     def complicated_method_that_returns_a_user
+      #       # some complex logic here
+      #       return user
+      #     end
+      #   end
+      #
+      def check_policy!(policy_label, subject = nil)
+        lambda do |controller|
+          subject_instance = nil
+          if subject
+            subject_instance =
+              if controller.instance_variable_defined?("@%s" % subject)
+                controller.instance_variable_get("@%s" % subject)
+              elsif controller.respond_to?(:"#{subject}")
+                controller.send(:"#{subject}")
+              end
+          end
+          params = Walruz.satisfies!(controller.send(:current_user),
+                                     policy_label,
+                                     subject_instance)
+          controller.set_policy_params!(params)
+        end
+      end
+
+      #
+      # Generates dynamically all the before filters needed for authorizations
+      # on a CRUD model.
+      #
+      # Requirements:
+      #  - The controller must have a method called `current_user` that returns
+      #    the authenticated user
+      #  - The subject must implement the four actions (:create, :read,
+      #    :update, :destroy) or have a :default action
+      #
+      # Parameters:
+      #   - subject: Symbol that indicates an instance variable or method on
+      #              the controller that returns the subject
       #
       # Example:
       #
       #   class CommentController < ActionController::Base
-      #     
+      #
       #     before_check_crud_authorizations_on :@comment
       #
       #     # This would be the same as:
-      #     # before_filter check_authorization!(:create, :@comment),  :only => [:new, :create]
-      #     # before_filter check_authorization!(:read, :@comment),    :only => :show
-      #     # before_filter check_authorization!(:update, :@comment),  :only => [:edit, :update]
-      #     # before_filter check_authorization!(:destroy, :@comment), :only => :destroy
-      #   
+      #     # before_filter check_authorization!(:create, :@comment),
+      #                     :only => [:new, :create]
+      #     # before_filter check_authorization!(:read, :@comment),
+      #                     :only => :show
+      #     # before_filter check_authorization!(:update, :@comment),
+      #                     :only => [:edit, :update]
+      #     # before_filter check_authorization!(:destroy, :@comment),
+      #                     :only => :destroy
+      #
       #   end
       #
       def before_check_crud_authorizations_on(subject)
@@ -100,11 +171,12 @@ module Walruz
           [:update, ['edit', 'update']],
           [:destroy, 'destroy']
         ].each do |(actor_action, actions)|
-          before_filter(check_authorization!(actor_action, subject), :only => actions)
+          before_filter(check_authorization!(actor_action, subject),
+                        :only => actions)
         end
       end
-      
+
     end
-    
+
   end
 end

data/spec/scenario.rb

@@ -55,7 +55,16 @@ class Colaboration
   JOHN_GEORGE = self.new(Beatle::PAUL, Beatle::GEORGE)
 end
 
+class IsJohnLennon < Walruz::Policy
+
+  def authorized?(actor, _)
+    actor == Beatle::JOHN
+  end
+
+end
+
 class SubjectIsActorPolicy < Walruz::Policy
+  set_policy_label :actor_is_subject
   
   def authorized?(actor, subject)
     actor == subject
@@ -63,18 +72,6 @@ class SubjectIsActorPolicy < Walruz::Policy
   
 end
 
-# class AuthorPolicy < Walruz::Policy
-#   
-#   def authorized?(beatle, song)
-#     if song.author == beatle
-#       [true, { :owner => beatle }]
-#     else
-#       false
-#     end
-#   end
-#   
-# end
-
 AuthorPolicy = SubjectIsActorPolicy.for_subject(:author) do |authorized, params, actor, subject|
   params.merge!(:owner => actor) if authorized
 end
@@ -146,14 +143,29 @@ class Application < ActionController::Base
 end
 
 class SongsController < Application
-  before_filter :assign_song
+  
+  before_filter :assign_song, :only => :sings
   before_filter check_authorization!(:sing, :song), :only => :sings
+
+  before_filter :assign_singer, :only => :is
+  before_filter check_policy!(:actor_is_subject, :singer), :only => :is
+
+  before_filter check_policy!(:is_john_lennon), :only => :hi_to_john
   
   def sings
     text_to_render = '%s is singing %s' % [current_user.name,
                                           @song.name]
     render :text => text_to_render
   end
+
+  def is
+    text_to_render = '%s is really %s' % [current_user.name, @singer.name]
+    render :text => text_to_render
+  end
+
+  def hi_to_john
+    render :text => 'Hey John, I thought you were dead already!'
+  end
   
   protected
   
@@ -164,6 +176,14 @@ class SongsController < Application
               nil
             end
   end
+
+  def assign_singer
+    @singer = if params[:singer] == 'John'
+      Beatle::JOHN
+    else
+      nil
+    end
+  end
   
 end
 
@@ -244,4 +264,5 @@ end
 ##### End of scenario
 
 ActionController::Routing::Routes.reload!
-ActionController::Routing::Routes.draw { |map| map.connect '/:controller/:action' }
+ActionController::Routing::Routes.
+  draw { |map| map.connect '/:controller/:action' }

data/spec/spec_helper.rb

@@ -3,14 +3,17 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 begin
   require 'rubygems'
+  require 'bundler/setup'
+  Bundler.require(:default, :test)
   require 'action_controller'
   require 'action_controller/test_process'
   require 'active_record'
   require 'initializer'
-  require 'spec'
-  require 'walruz'
 
-  RAILS_ROOT = File.dirname(__FILE__) + '/../tmp'
+  tmp_dir = File.dirname(__FILE__) + '/../tmp'
+  Dir.mkdir(tmp_dir) unless File.exist?(tmp_dir)
+  RAILS_ROOT = tmp_dir
+
   module Rails
     
     def self.configuration

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: walruz-rails
 version: !ruby/object:Gem::Version 
-  version: 0.0.10
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -9,10 +15,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 -08:00
+date: 2011-07-12 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 0
+        - 10
+        version: 0.0.10
+  name: walruz
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  name: rails
+  version_requirements: *id003
+  prerelease: false
 description: 
 email: roman@noomii.com
 executables: []
@@ -111,35 +162,44 @@ files:
 - rails_generators/walruz_policy_generator.rb
 - LICENSE
 - README.rdoc
+- spec/spec_helper.rb
+- spec/scenario.rb
+- spec/controller_mixin_spec.rb
 has_rdoc: true
 homepage: http://github.com/noomii/walruz-rails
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: walruz-rails
-rubygems_version: 1.3.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Gem for easy integration between walruz and the Ruby on Rails framework
 test_files: 
-- spec/controller_mixin_spec.rb
-- spec/scenario.rb
 - spec/spec_helper.rb
+- spec/scenario.rb
+- spec/controller_mixin_spec.rb