walruz 0.0.4 → 0.0.5

data/VERSION.yml

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

data/lib/walruz/actor.rb

@@ -19,30 +19,55 @@ module Walruz
     #   It returns a boolean indicating that the actor is authorized to 
     #   access (or not) the subject
     #
-    # Notes:
-    #   Because this method is probably going to be called multiple times on
-    #   a same action, the result of the first invocation is cached, if you 
-    #   want to uncache just pass true as a third parameter.
-    #   
-    # 
     def can?(*args)
       if args.size == 2
-        cached_values_for_can[args] ||= can_without_caching?(*args)
+        (cached_values_for_can[args] ||= can_without_caching(*args))[0]
+      elsif args.size == 3 
+        if args.pop
+          (cached_values_for_can[args] = can_without_caching(*args))[0]
+        else
+          (cached_values_for_can[args] ||= can_without_caching(*args))[0]
+        end
+      else
+        raise ArgumentError.new("wrong number of arguments (%d for 2)" % args.size) 
+      end
+    end
+    
+    
+    #
+    # Allows an actor to check if he can do some action on a given
+    # subject.
+    #
+    # Params: 
+    #   - label: The label of the action
+    #   - subject: The subject which the actor wants to interact with
+    #
+    # Returns:
+    #   Returns a a Hash with parameters given from the policy.
+    #
+    def authorize(*args)
+      if args.size == 2
+        cached_values_for_can[args] ||= can_without_caching(*args)
+        cached_values_for_can[args][0] ? cached_values_for_can[args][1] : nil
       elsif args.size == 3 
         if args.pop
-          cached_values_for_can[args] = can_without_caching?(*args)
+          cached_values_for_can[args] = can_without_caching(*args)[1]
+          cached_values_for_can[args][0] ? cached_values_for_can[args][1] : nil
         else
-          cached_values_for_can[args] ||= can_without_caching?(*args)
+          cached_values_for_can[args] ||= can_without_caching(*args)[1]
+          cached_values_for_can[args][0] ? cached_values_for_can[args][1] : nil
         end
       else
         raise ArgumentError.new("wrong number of arguments (%d for 2)" % args.size) 
       end
     end
     
-    def can_without_caching?(label, subject)
-      subject.can_be?(label, self)[0]
+    # :nodoc:
+    def can_without_caching(label, subject)
+      subject.can_be?(label, self)
     end
     
+    # :nodoc:
     def cached_values_for_can
       @_cached_values_for_can ||= {}
     end
@@ -56,22 +81,20 @@ module Walruz
     #   - subject: The subject which the actor wants to interact with
     #
     # Returns:
-    #   It can return either a Boolean or an Array of the form [Boolean, Hash].
-    #   When is an Array, the second parameter is a Hash with parameters given from
-    #   the policy.
+    #   Returns a a Hash with parameters given from the policy.
     #
     # Raises: 
-    #   Walruz::NotAuthorized error if the actor can't interact with the subject
+    #   Walruz::NotAuthorized error if the actor can't execute the action on the subject
     #    
-    def authorize(label, subject)
+    def authorize!(label, subject)
       result = subject.can_be?(label, self)
       if result[0]
-        cached_values_for_can[[label, subject]] = result[0]
+        cached_values_for_can[[label, subject]] = result
         result[1]
       else
         response_params = result[1]
         error_message = response_params[:error_message] || "You are not authorized to access this content"
-        raise NotAuthorized.new(error_message) 
+        raise NotAuthorized.new(self, subject, label, error_message) 
       end
     end
     

data/lib/walruz.rb

@@ -1,6 +1,23 @@
 module Walruz
 
   class NotAuthorized < Exception
+    
+    attr_reader :actor
+    attr_reader :subject
+    attr_reader :action
+    
+    def initialize(actor, subject, action, error_message = nil)
+      @actor   = actor
+      @subject = subject
+      @action  = action
+      
+      if error_message.nil?
+        super
+      else
+        super(error_message)
+      end
+    end
+    
   end
   
   class AuthorizationActionsNotDefined < Exception

data/spec/scenario.rb

@@ -13,7 +13,7 @@ class Beatle
   end
   
   def sing_the_song(song)
-    response = authorize(: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)
-    authorize(:sing_with_john, song)
+    authorize!(:sing_with_john, song)
     "Ok John, Let's Play '%s'" % song.name
   end
 

data/spec/walruz/actor_spec.rb

@@ -6,6 +6,10 @@ describe 'Walruz::Actor' do
     Beatle::JOHN.should respond_to(:authorize)
   end
   
+  it "should add an instance method `authorize!` to included classes" do
+    Beatle::JOHN.should respond_to(:authorize!)
+  end
+  
   it "should add an instance method `can?` to included classes" do
     Beatle::JOHN.should respond_to(:can?)
   end
@@ -17,12 +21,37 @@ describe 'Walruz::Actor' do
   
   describe "#authorize" do
     
+    it "should return nil when the actor is not authorized" do
+      Beatle::RINGO.authorize(:sing, Song::ALL_YOU_NEED_IS_LOVE).should be_nil
+    end
+    
+    it "should return the policy parameters when the actor is authorized" do
+      result = Beatle::JOHN.authorize(:sing, Song::ALL_YOU_NEED_IS_LOVE)
+      result.should_not be_nil
+      result.should be_kind_of(Hash)
+      result[:owner].should == Beatle::JOHN
+    end
+    
+  end
+  
+  describe "#authorize!" do
+    
     it "should raise a Walruz::NotAuthorized error when the actor is not authorized" do
       lambda do
         Beatle::RINGO.sing_the_song(Song::ALL_YOU_NEED_IS_LOVE)
       end.should raise_error(Walruz::NotAuthorized)
     end
     
+    it "should raise a Walruz::NotAuthorized error with the information of actor, subject and action when actor is not authorized" do
+      begin
+        Beatle::RINGO.sing_the_song(Song::ALL_YOU_NEED_IS_LOVE)
+      rescue Walruz::NotAuthorized => e
+        e.actor.should == Beatle::RINGO
+        e.subject.should == Song::ALL_YOU_NEED_IS_LOVE
+        e.action == :sing
+      end
+    end
+    
     it "should not raise a Walruz::NotAuthorized error when the actor is authorized" do
       lambda do
         Beatle::JOHN.sing_the_song(Song::ALL_YOU_NEED_IS_LOVE)
@@ -44,20 +73,11 @@ describe 'Walruz::Actor' do
       Beatle::JOHN.can?(:sing, Song::ALL_YOU_NEED_IS_LOVE)
     end
     
-    # @deprecated functionality
-    # WHY: When you execute `can?` you should probably have already executed `authorize`
-    # it "should execute a given block if the condition is true" do
-    #   proc_called = lambda { raise "Is being called" }
-    #   lambda do
-    #     Beatle::JOHN.can?(:sing, Song::ALL_YOU_NEED_IS_LOVE, &proc_called)
-    #   end.should raise_error
-    # end
-    
     it "if a boolean third parameter is received it should not use the cached result" do
-      Beatle::JOHN.stub!(:can_without_caching?).and_return(true)
+      Beatle::JOHN.stub!(:can_without_caching).and_return([true, {}])
       Beatle::JOHN.can?(:sing, Song::ALL_YOU_NEED_IS_LOVE).should be_true
       
-      Beatle::JOHN.stub!(:can_without_caching?).and_return(false)
+      Beatle::JOHN.stub!(:can_without_caching).and_return([false, {}])
       Beatle::JOHN.can?(:sing, Song::ALL_YOU_NEED_IS_LOVE).should be_true
       Beatle::JOHN.can?(:sing, Song::ALL_YOU_NEED_IS_LOVE, true).should be_false
     end

data/spec/walruz/utils_spec.rb

@@ -4,13 +4,13 @@ describe Walruz::Utils do
   
   def check_actor_can_on_subject(label, actor, subject)
     lambda do
-      actor.authorize(label, subject)
+      actor.authorize!(label, subject)
     end.should_not raise_error(Walruz::NotAuthorized)
   end
   
   def check_actor_can_not_on_subject(label, actor, subject)
     lambda do
-      actor.authorize(label, subject)
+      actor.authorize!(label, subject)
     end.should raise_error(Walruz::NotAuthorized)
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: walruz
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-02 00:00:00 -07:00
+date: 2009-07-13 00:00:00 -07:00
 default_executable: 
 dependencies: []