walruz 0.0.10 → 0.0.11

data/README.rdoc

@@ -1,4 +1,8 @@
-= Walruz: Simple but Powerful Authorization Framework
+= Walruz: Simple yet Powerful Policy Composition Authorization Framework
+
+== Rails Integration
+
+See walruz-rails[http://github.com/noomii/walruz-rails] gem.
 
 == Basic and Terminology
 
@@ -67,9 +71,13 @@ Actor classes can use several methods to check if the <em>actor</em> instance ca
 
 [<b><tt>can?(action, subject)</tt></b>] Returns boolean that says if the <em>actor</em> can execute or not the action on the <em>subject</em>.
 
-[<b><tt>authorize(action, subject)</tt></b>] In case the <em>actor</em> can execute the action on the <em>subject</em>, it returns the parameters hash from the <em>policy</em>, otherwise it will raise a <tt>Walruz::NotAuthorized</tt>.
+[<b><tt>authorize(action, subject)</tt></b>] In case the <em>actor</em> can execute the action on the <em>subject</em>, it returns the parameters hash from the <em>policy</em>, otherwise it will return <tt>nil</tt>
+
+[<b><tt>authorize!(action, subject)</tt></b>] In case the <em>actor</em> can execute the action on the <em>subject</em>, it returns the parameters hash from the <em>policy</em>, otherwise it will raise a <tt>Walruz::NotAuthorized</tt> error.
 
-[<b><tt>satisfies?(policy_label, subject)</tt></b>] It behaves just like the <tt>can?</tt> method, but instead of giving an action to be executed to the <em>subject</em>, it receives a <em>policy</em> label.
+[<b><tt>satisfies?(policy_label, subject)</tt></b>] It behaves just like the <tt>can?</tt> method, but instead of giving an action to be executed to the <em>subject</em>, it receives a <em>policy label</em> (More on <em>policy labels</em> next).
+
+[<b><tt>satisfies(policy_label, subject)</tt></b>] It behaves just like the <tt>authorize</tt> method, but instead of giving an action to be executed to the <em>subject</em>, it receives a <em>policy label</em> 
 
 In case the given action is not assigned to any <em>policy</em>, a default Policy will be executed (if given), if no default <em>policy</em> is given then a <tt>Walruz::ActionNotFound</tt> exception will be raised.
 
@@ -230,11 +238,11 @@ But as you may see, we are just creating new policies to handle old ones, we are
     check_authorizations :read => PictureReadPolicy
   end
   
-The parameter of <tt>but_for</tt> is the name of the <em>subject's</em> method that will return a new <em>subject</em>, this new <em>subject</em> is then passed through the <em>policy</em>. Pretty neat eh?
+The parameter of <tt>for_subject</tt> is the name of the <em>subject's</em> method that will return a new <em>subject</em>, this new <em>subject</em> is then passed through the <em>policy</em>. Pretty neat eh?
 
 == Returning custom errors
 
-Suppose you want to add an error to the authorization failure that is a more descriptive, you can do so on the <tt>authorized?</tt> method passing a hash with a <tt>:error_message</tt> key on the false return. If you use the <tt>can!</tt> method on the <em>actor</em> model, this will become the <tt>Walruz::NotAuthorized</tt> error message.
+Suppose you want to add an error to the authorization failure that is a more descriptive, you can do so on the <tt>authorized?</tt> method passing a hash with a <tt>:error_message</tt> key on the false return. If you use the <tt>authorize!</tt> method on the <em>actor</em> model, this will become the <tt>Walruz::NotAuthorized</tt> error message.
 
 Example:
   
@@ -257,14 +265,10 @@ You'll notice that once you start implementing policies for your system, you'll
 - If the <em>policy</em> only applies to the <em>actor</em>, the <em>policy</em> class name should start with the Actor word (e.g. <tt>ActorIsAdmin</tt>)
 - You should always have the compositions of policies in just one place in your library folder (e.g. in <tt>policies.rb</tt> file).
 - The result of <em>policy</em> compositions should finish with the word Policy (e.g <tt>UserDeletePolicy = any(ActorIsSubject, ActorIsAdmin)</tt>)
-- Use <tt>PolicyClass.but_for</tt> when you are combining the <em>policy</em> class with other policies, if you are not doing this, consider checking authorizations on parents of the <em>subject</em> instead of the <em>subject</em> (e.g. <tt>current_user.can?(:see_pictures_of, picture.owner)</tt>)
+- Use <tt>PolicyClass.for_subject</tt> when you are combining the <em>policy</em> class with other policies, if you are not doing this, consider checking authorizations on parents of the <em>subject</em> instead of the <em>subject</em> (e.g. <tt>current_user.can?(:see_pictures_of, picture.owner)</tt>)
 
 If you follow this rules, it will be much easier for you to merge policies together in an efficient way.
 
-== Rails Integration
-
-See walruz-rails[http://github.com/noomii/walruz-rails] gem.
-
 == More examples
 
 You may check the project in the examples/ directory for more info; on the rails project, take a look on the <tt>spec/models/beatle_spec.rb</tt> file, it's really illustrating.

data/VERSION.yml

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

data/lib/walruz/core_ext/array.rb

@@ -45,7 +45,7 @@ module Walruz
       #     # this will execute current_user.can?(:read, post) for each element of the array
       #
       def only_authorized_for(actor, opts = {})
-        if opts.respond_to?(:[])
+        unless opts.kind_of?(Symbol)
           only_authorized_with_options(actor, opts)
         else # use the opts 
           only_authorized_on_action(actor, opts)

data/lib/walruz/policy.rb

@@ -163,7 +163,7 @@ module Walruz
     # Returns the label assigned to the policy
     #
     def self.policy_label
-      @policy_label ||= (self.name.empty? ? nil : :"#{self.underscore(self.name)}")
+      @policy_label ||= ((name.nil? || name.empty?) ? nil : :"#{self.underscore(self.name)}")
     end
     
     #

data/spec/walruz/walruz_spec.rb

@@ -34,7 +34,8 @@ describe Walruz do
   describe ".version" do
 
     it "should return a string representing the current version" do
-      version = YAML.load_file(File.dirname(__FILE__) + "/../../VERSION.yml")
+      require 'yaml'
+      version = ::YAML.load_file(File.dirname(__FILE__) + "/../../VERSION.yml")
       Walruz.version.should == "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
     end
 

data/walruz.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{walruz}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roman Gonzalez"]
-  s.date = %q{2010-03-11}
+  s.date = %q{2010-11-15}
   s.description = %q{
       Walruz provides an easy to use DSL to do composition of basic authorization policies to create
     more complex ones, and then register this composed policies on actions performed to the model begin accessed
@@ -55,7 +55,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{walruz}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Walruz is a gem that provides an easy yet powerful way to implement authorization policies in a system, relying on the composition of simple policies to create more complex ones.}
   s.test_files = [
     "spec/scenario.rb",
@@ -74,7 +74,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
@@ -86,3 +86,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end
+

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: walruz
 version: !ruby/object:Gem::Version 
-  version: 0.0.10
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -9,29 +15,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 -08:00
+date: 2010-11-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: "\n      Walruz provides an easy to use DSL to do composition of basic authorization policies to create\n    more complex ones, and then register this composed policies on actions performed to the model begin accessed\n    "
 email: roman@noomi.com
 executables: []
@@ -81,21 +95,27 @@ 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
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Walruz is a gem that provides an easy yet powerful way to implement authorization policies in a system, relying on the composition of simple policies to create more complex ones.