walruz-rails 0.0.3 → 0.0.4

data/README.rdoc

@@ -4,13 +4,36 @@ Simple but Powerful authorization features for Ruby on Rails.
 
 walruz-rails is a Walruz extension that allows you to integrate easily the Walruz authorization framework with Ruby on Rails.
 
-For more information about the functionality of walruz please check the "walruz webpage":#
+For more information about the functionality of walruz please check the walruz webpage (http://walruz.rubyforge.org)
 
 == FEATURES
 
 * It provides generators to setup easily your authorization policies
 * It provides filters for ActionController that enhances the invocations for verification of authorizations
 
+
+== HOW TO USE THE FILTERS
+
+walruz-rails provides the check_authorization method, this method will generate a before_filter for the parameters specified to this method:
+
+Example:
+  
+  class UsersController < ApplicationController
+    
+    before_filter :get_user, :except => :index
+    
+    before_filter check_authorization(:create, :user), :only => [:new, :create]
+    before_filter check_authorization(:read, :user), :only => :show
+    before_filter check_authorization(:update, :user), :only => [:edit, :update]
+    before_filter check_authorization(:destroy, :user), :only => [:delete, :destroy]
+  end
+  
+All this invocations will get translated to:
+
+  current_user.authorize(action, subject)
+
+The result of this invocation will be on a controller method called `policy_params`.
+
 == INSTALL
 
 Execute the generator to enable walruz on your project: 

data/lib/walruz/controller_mixin.rb

@@ -59,7 +59,7 @@ module Walruz
                       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 = controller.send(:current_user).can!(action, subject_instance)
+          params = controller.send(:current_user).authorize(action, subject_instance)
           controller.set_policy_params!(params)
         end
       end

data/rails_generators/templates/actor_is_subject_example.rb

@@ -0,0 +1,10 @@
+# This method is pretty useful when used with the `for_subject` method
+# See http://walruz.rubyforge.org/ for more info.
+#
+class Policies::ActorIsSubject < Walruz::Policy
+  
+  def authorized?(actor, subject)
+    actor == subject
+  end
+  
+end

data/rails_generators/templates/policies.rb

@@ -0,0 +1,34 @@
+module Policies
+  extend Walruz::Utils
+  
+  def self.policy(policy_label)
+    Walruz.policies[policy_label]
+  end
+  
+  #
+  # Add an autoload invocation to the policies you implement on the policies
+  # directory. 
+  # Examples:
+  #   autoload :AdminPolicy, 'walruz/policies/admin_policy'
+  #   autoload :FooPolicy, 'walruz/policies/other_policy'
+  
+  
+  #
+  # Then use it on your models:
+  # require 'walruz/policies'
+  #
+  # class ASubject
+  #   check_authorization :create => Policies::AdminPolicy
+  # end
+  #
+  
+  #
+  #
+  # If you want to use combined policies and give them a name you can do so
+  # pretty easily using the `any`, `all` or `negate` helpers
+  #
+  # AdminOrFooPolicy = any(AdminPolicy, FooPolicy)
+  # AdminAndNotFooPolicy = all(AdminPolicy, negate(FooPolicy))
+  #
+  
+end

data/rails_generators/templates/policy.rb

@@ -0,0 +1,10 @@
+module Policies
+  class <%= class_name %> < Walruz::Policy
+    # depends_on OtherPolicy
+    
+    def authorized?(actor, subject)
+      raise NotImplementedError.new("You need to implement policy")
+    end
+    
+  end
+end

data/rails_generators/templates/policy_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+# You need to 
+# require 'walruz/policies'
+# in your spec_helper.rb file
+
+describe Policies::<%= class_name %> do
+  
+  before(:each) do
+    @policy = Policies::<%= class_name %>.new
+  end
+  
+  describe "with valid actor and subject" do
+    
+    before(:each) do
+      # setup valid relationship between actor and subject
+    end
+    
+    it "should return true" do
+      pending
+      # @policy.safe_authorized?(@actor, @subject)[0].should be_true
+    end
+    
+  end
+  
+  describe "with invalid actor and subject" do
+    
+    before(:each) do
+      # setup invalid relationship between actor and subject
+    end
+    
+    it "should return false" do
+      pending
+      # @policy.safe_authorized?(@actor, @subject)[0].should be_false
+    end
+    
+  end
+  
+end

data/rails_generators/templates/policy_test.rb

@@ -0,0 +1,22 @@
+# You need to 
+# require 'walruz/policies'
+# in your spec_helper.rb file
+
+
+class Policies::<%= class_name %>Test < Test::Unit
+  
+  def setup
+    @policy = Policies::<%= class_name %>.new
+  end
+  
+  def test_return_true_with_valid_association_of_actor_and_subject
+    # setup valid association btw actor and subject
+    # assert !@policy.safe_authorized?(actor, subject)[0]
+  end
+  
+  def test_return_false_with_invalid_association_of_actor_and_subject
+    # setup invalid association btw actor and subject
+    # assert @policy.safe_authorized?(actor, subject)[0]
+  end
+  
+end

data/rails_generators/templates/unauthorized.html

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <title>401 unathorized</title>
+  </head>
+  <body>
+    <h1>401 unauthorized</h1>
+  </body>
+</html>

data/rails_generators/templates/walruz_initializer.rb

@@ -0,0 +1,22 @@
+Walruz.setup do |config|
+  
+  # All the models of ActiveRecord can behave as actors and subjects
+  config.actors   = [ActiveRecord::Base]
+  config.subjects = [ActiveRecord::Base]
+  
+  ActionController::Base.class_eval do
+    
+    rescue_from Walruz::NotAuthorized, :with => :unauthorized
+    
+    #
+    # This method will be called when a user is not authorized. By
+    # default it renders an unauthorized template on the public directory
+    # with a HTTP status 401 (not authorized)
+    # This method can be overwritted in childs of ActionController::Base
+    # to have a better handling of unauthorized exceptions
+    def unauthorized(e)
+      render :file => "#{RAILS_ROOT}/public/unauthorized.html", :status => 401
+    end
+    
+  end
+end

data/rails_generators/walruz_generator.rb

@@ -0,0 +1,22 @@
+class WalruzGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      m.directory 'config/initializers'
+      m.file('walruz_initializer.rb', 'config/initializers/walruz_initializer.rb')
+      
+      m.directory 'lib/walruz'
+      m.directory 'lib/walruz/policies'
+      m.file('policies.rb', 'lib/walruz/policies.rb')
+      m.file('actor_is_subject_example.rb', 'lib/walruz/policies/actor_is_subject.rb')
+      
+      m.directory 'public'
+      m.file('unauthorized.html', 'public/unauthorized.html')
+    end
+  end
+  
+  def banner
+    "Usage: #{$0} walruz"
+  end
+  
+end

data/rails_generators/walruz_policy_generator.rb

@@ -0,0 +1,36 @@
+class WalruzPolicyGenerator < Rails::Generator::NamedBase
+  
+  def manifest
+    record do |m|
+      m.class_collisions "#{class_name}Policy"
+      m.directory 'lib/walruz/policies'
+      m.template 'policy.rb', File.join('lib/walruz/policies', class_path, "#{file_name}.rb")
+    
+    
+      if options[:test]
+        # we generate the rSpec stub
+        m.directory 'spec'
+        m.directory 'spec/policies'
+        m.template 'policy_spec.rb', File.join("spec/policies", "#{file_name}_spec.rb")
+      else
+        m.directory 'test'
+        m.directory 'test/policies'
+        m.template 'policy_test.rb', File.join("test/policies", "#{file_name}_test.rb")
+      end
+    
+    end
+  end
+  
+  protected
+  
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on('--spec', 'Add an rSpec test to the spec folder (DEFAULT)') { |v| options[:spec] = true }
+    opt.on('--test', 'Add a Test::Unit file to the test folder') { |v| options[:test] = true }
+  end  
+  
+  def banner
+    "Usage: #{$0} walruz_policy [--spec|--test]"
+  end
+end

data/spec/scenario.rb

@@ -13,7 +13,7 @@ class Beatle
   end
   
   def sing_the_song(song)
-    response = can!(:sing, song)
+    response = authorize(:sing, song)
     case response[:owner]
     when Colaboration
       authors = response[:owner].authors.dup
@@ -26,7 +26,7 @@ class Beatle
   end
   
   def sing_with_john(song)
-    can!(:sing_with_john, song)
+    authorize(:sing_with_john, song)
     "Ok John, Let's Play '%s'" % song.name
   end
 
@@ -75,7 +75,7 @@ end
 #   
 # end
 
-AuthorPolicy = Walruz::Utils.lift_subject(:author, SubjectIsActorPolicy) do |authorized, params, actor, subject|
+AuthorPolicy = SubjectIsActorPolicy.for_subject(:author) do |authorized, params, actor, subject|
   params.merge!(:owner => actor) if authorized
 end
 
@@ -105,8 +105,8 @@ class Song
   include Walruz::Subject
   extend Walruz::Utils
 
-  check_authorizations :sing => orP(AuthorPolicy, AuthorInColaborationPolicy),
-                       :sell => andP(AuthorPolicy, notP(AuthorInColaborationPolicy)),
+  check_authorizations :sing => any(AuthorPolicy, AuthorInColaborationPolicy),
+                       :sell => all(AuthorPolicy, negate(AuthorInColaborationPolicy)),
                        :sing_with_john => ColaboratingWithJohnPolicy
   attr_accessor :name
   attr_accessor :colaboration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: walruz-rails
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-01 00:00:00 -07:00
+date: 2009-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,10 +23,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION.yml
 - examples/rails/README
 - examples/rails/Rakefile
 - examples/rails/app/controllers/application_controller.rb
@@ -102,9 +98,17 @@ files:
 - examples/rails/test/test_helper.rb
 - lib/walruz/controller_mixin.rb
 - lib/walruz_rails.rb
-- spec/controller_mixin_spec.rb
-- spec/scenario.rb
-- spec/spec_helper.rb
+- rails_generators/templates/actor_is_subject_example.rb
+- rails_generators/templates/policies.rb
+- rails_generators/templates/policy.rb
+- rails_generators/templates/policy_spec.rb
+- rails_generators/templates/policy_test.rb
+- rails_generators/templates/unauthorized.html
+- rails_generators/templates/walruz_initializer.rb
+- rails_generators/walruz_generator.rb
+- rails_generators/walruz_policy_generator.rb
+- LICENSE
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/noomii/walruz-rails
 licenses: []
@@ -132,38 +136,8 @@ rubyforge_project: walruz-rails
 rubygems_version: 1.3.3
 signing_key: 
 specification_version: 3
-summary: Gem for easy integration between walruz andthe Ruby on Rails framework
+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
-- examples/rails/app/controllers/application_controller.rb
-- examples/rails/app/helpers/application_helper.rb
-- examples/rails/app/models/beatle.rb
-- examples/rails/app/models/colaboration.rb
-- examples/rails/app/models/song.rb
-- examples/rails/config/boot.rb
-- examples/rails/config/environment.rb
-- examples/rails/config/environments/development.rb
-- examples/rails/config/environments/production.rb
-- examples/rails/config/environments/test.rb
-- examples/rails/config/initializers/backtrace_silencers.rb
-- examples/rails/config/initializers/inflections.rb
-- examples/rails/config/initializers/mime_types.rb
-- examples/rails/config/initializers/new_rails_defaults.rb
-- examples/rails/config/initializers/session_store.rb
-- examples/rails/config/initializers/walruz_initializer.rb
-- examples/rails/config/routes.rb
-- examples/rails/db/migrate/20090604201506_create_beatles.rb
-- examples/rails/db/migrate/20090604201512_create_songs.rb
-- examples/rails/db/migrate/20090604201527_create_colaborations.rb
-- examples/rails/db/schema.rb
-- examples/rails/lib/walruz/policies/author_policy.rb
-- examples/rails/lib/walruz/policies/colaboration_policy.rb
-- examples/rails/lib/walruz/policies.rb
-- examples/rails/spec/models/beatle_spec.rb
-- examples/rails/spec/models/colaboration_spec.rb
-- examples/rails/spec/models/song_spec.rb
-- examples/rails/spec/spec_helper.rb
-- examples/rails/test/performance/browsing_test.rb
-- examples/rails/test/test_helper.rb

data/Rakefile

@@ -1,49 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "walruz-rails"
-    gem.summary = %Q{Gem for easy integration between walruz andthe Ruby on Rails framework}
-    gem.email = "roman@noomii.com"
-    gem.homepage = "http://github.com/noomii/walruz-rails"
-    gem.authors = ["Roman Gonzalez"]
-    gem.rubyforge_project = "walruz-rails"
-
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "walruz-rails #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 0
-:minor: 0
-:patch: 3