mongoid_roles 0.0.3 → 0.0.4

data/README.textile

@@ -0,0 +1,80 @@
+h1. Mongoid Roles
+
+Role-based authorization system for Rails & Mongoid.
+
+Interface is based on "acl9":https://github.com/be9/acl9.
+
+
+h2. Installation
+
+Add this line to your Gemfile:
+
+@gem 'mongoid_roles'@
+
+h2. Subject model
+
+<pre><code>
+  class User
+    include Mongoid::Document
+    include Mongoid::Roles::Subject
+  end
+</code></pre>
+    
+
+h2. Object model
+
+<pre><code>
+    class Foo
+      include Mongoid::Document
+      include Mongoid::Roles::Object
+    end
+    
+    class Bar
+      include Mongoid::Document
+      include Mongoid::Roles::Object
+    end
+</code></pre>
+
+
+h2. Interface
+
+
+h3. Subject model
+
+A call of @include Mongoid::Roles::Subject@ defines following methods on the model:
+
+@subject.has_role?(role, object = nil)@. Returns @true@ of @false@ (has or has not).
+
+@subject.has_role!(role, object = nil)@. Assigns a @role@ for the @object@ to the @subject@. 
+Does nothing is subject already has such a role.
+
+@subject.has_no_role!(role, object = nil)@. Unassigns a role from the @subject@.
+
+@subject.has_roles_for?(object)@. Does the @subject@ has any roles for @object@? (@true@ of @false@)
+
+@subject.has_role_for?(object)@. Same as @has_roles_for?@.
+
+@subject.roles_for(object)@. Returns an array of @Role@ instances, corresponding to @subject@ 's roles on
+@object@. E.g. @subject.roles_for(object).map(&:name).sort@ will give you role names in alphabetical order.
+
+@subject.has_no_roles_for!(object)@. Unassign any @subject@ 's roles for a given @object@.
+
+@subject.has_no_roles!@. Unassign all roles from @subject@.
+
+
+h3. Object model
+
+A call of @include Mongoid::Roles::Object@ defines following methods on the model:
+
+@object.accepts_role?(role_name, subject)@. An alias for @subject.has_role?(role_name, object)@.
+
+@object.accepts_role!(role_name, subject)@. An alias for @subject.has_role!(role_name, object)@.
+
+@object.accepts_no_role!(role_name, subject)@. An alias for @subject.has_no_role!(role_name, object)@.
+
+@object.accepts_roles_by?(subject)@. An alias for @subject.has_roles_for?(object)@.
+
+@object.accepts_role_by?(subject)@. Same as @accepts_roles_by?@.
+
+@object.accepts_roles_by(subject)@. An alias for @subject.roles_for(object)@.
+

data/lib/mongoid/roles/role.rb

@@ -9,15 +9,17 @@ module Mongoid
       field :auth_object_type,  :type => String
       field :auth_object_id,    :type => String
 
-      scope :find_role_with_object, lambda{|role, object| where(:role => role, :auth_object_type => object.class.name, :auth_object_id => object.id)}
-      scope :find_object,           lambda{|object|       where(:auth_object_type => object.class.name, :auth_object_id => object.id)}
-      # validates_uniqueness_of :name
-  
+      scope :find_object, lambda  {|object| where(:auth_object_type => object.class.name, :auth_object_id => object.id)}
+      scope :find_role,   lambda  {|role, object = nil|  
+        object ?  where(:role => role, :auth_object_type => object.class.name, :auth_object_id => object.id) :
+                  where(:role => role, :auth_object_type => nil, :auth_object_id => nil)
+      }
+      
       class << self
       
         # subject.has_role?(role, object = nil). Returns true of false (has or has not).
-        def has_role? (role, object)
-          find_role_with_object(role,object).count == 1
+        def has_role? (role, object = nil)
+          find_role(role,object).count == 1
         end
        
         # subject.has_role!(role, object = nil). Assigns a role for the object to the subject. 
@@ -25,8 +27,8 @@ module Mongoid
         # IMPELEMENTED IN MongoidRoles::Subject
       
         # subject.has_no_role!(role, object = nil). Unassigns a role from the subject.
-        def has_no_role! (role, object)
-          find_role_with_object(role,object).destroy_all
+        def has_no_role! (role, object = nil)
+          find_role(role,object).destroy_all
         end
       
         # subject.has_roles_for?(object). Does the subject has any roles for object? (true of false)
@@ -55,6 +57,11 @@ module Mongoid
           criteria.destroy_all
         end
 
+        
+        
+        # def find_role(role, object = nil)
+        #   object ? find_role_with_object(role,object) : find_role(role)
+        # end
       end
   
       def auth_object
@@ -64,6 +71,8 @@ module Mongoid
       end
 
       def auth_object=(auth_object)
+        return unless auth_object
+        
         self.auth_object_type = auth_object.class.name
         self.auth_object_id   = auth_object.id
       end

data/lib/mongoid/roles/subject.rb

@@ -34,7 +34,7 @@ module Mongoid
         # find all subjects which has given role for given object
         def with_role role, object
           c = where('roles.auth_object_type' => object.class.name, 'roles.role' => role)
-          c.selector['roles.auth_object_id'] = object.id.to_s # FIX, bo chcemy string a nie objectid...
+          c.selector['roles.auth_object_id'] = object.id.to_s # FIX, we want string instead of object_id...
           return c
         end
 
@@ -42,8 +42,12 @@ module Mongoid
   
       # Assigns a role for the object to the subject. 
       # Does nothing is subject already has such a role.
-      def has_role! (role, object = nil)
-        roles.find_or_create_by(:role => role, :auth_object => object)
+      def has_role! (role, auth_object = nil)
+        # p roles.find(:role => role, :auth_object => auth_object).first
+        auth_object ?
+          roles.find_or_create_by(:role => role, :auth_object_id => auth_object.id.to_s, :auth_object_type => auth_object.class.name) :
+          roles.find_or_create_by(:role => role, :auth_object_id => nil, :auth_object_type => nil)
+          
       end
     end
   end

data/lib/mongoid/roles/version.rb

@@ -1,3 +1,3 @@
 module MongoidRoles
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/mongoid_roles.gemspec

@@ -12,11 +12,12 @@ Gem::Specification.new do |s|
   s.summary     = %q{Mongoid Roles}
   s.description = %q{Mongoid Roles}
 
-  s.rubyforge_project = "mongoid_roles"
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'mongoid', '2.0.0.rc.7'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
 end

data/spec/models/project.rb

@@ -0,0 +1,6 @@
+class Project
+  include Mongoid::Document
+  include Mongoid::Roles::Object
+  
+  field :name
+end

data/spec/models/user.rb

@@ -0,0 +1,6 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Roles::Subject
+  
+  field :name
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rails/all'
+require 'mongoid'
+require 'bundler/setup'
+
+require 'mongoid_roles'
+require 'models/user'
+require 'models/project'
+
+Mongoid.configure do |config|
+  host = "localhost"
+  config.master = Mongo::Connection.new.db('mongoid_roles_test')
+  config.persist_in_safe_mode = false
+end
+
+RSpec.configure do |config|
+end

data/spec/subject_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Mongoid::Roles::Subject do
+  before(:each) do
+    @bob = User.new
+    @proj = Project.new
+  end
+  
+  context 'has_role!' do  
+    it 'should set role' do
+      @bob.has_role?(:manager, @proj).should be_false
+      @bob.has_role!(:manager, @proj)
+      @bob.has_role?(:manager, @proj).should be_true
+      
+      @bob.has_role?(:manager).should be_false
+      @bob.has_role!(:manager)
+      @bob.has_role?(:manager).should be_true
+    end
+  end
+  
+  context 'has_no_roles!' do
+    it 'should remove all roles' do
+      @bob.has_role!(:manager)
+      @bob.has_role!(:manager, @proj)
+      @bob.roles.count.should == 2
+      
+      @bob.has_no_roles!
+      @bob.roles.count.should == 0
+    end
+  end
+  
+  context 'has_no_role!' do
+    it 'should remove particular role' do
+      @bob.has_role!(:manager)
+      @bob.has_role!(:manager, @proj)
+    
+      @bob.has_role?(:manager).should be_true
+      @bob.has_no_role!(:manager)
+      @bob.has_role?(:manager).should be_false
+    
+      @bob.has_role?(:manager, @proj).should be_true
+      @bob.has_no_role!(:manager, @proj)
+      @bob.has_role?(:manager, @proj).should be_false
+    end
+  end
+  
+  context 'has_roles_for?' do
+    it 'should check if role exists for object' do      
+      @bob.has_roles_for?(@proj).should be_false
+      @bob.has_role!(:manager, @proj)
+      @bob.has_roles_for?(@proj).should be_true
+    end
+  end
+  
+  context 'has_role_for?' do
+    it 'should do the same as has_roles_for?' do
+      @bob.has_roles_for?(@proj).should be_false
+      @bob.has_role!(:manager, @proj)
+      @bob.has_roles_for?(@proj).should be_true
+    end
+  end
+  
+  context 'roles_for' do
+    it 'should return all roles for object' do
+      proj2 = Project.new
+      
+      @bob.has_role!(:manager, @proj)
+      @bob.has_role!(:leader, @proj)
+      @bob.has_role!(:manager, proj2)
+      
+      @bob.roles_for(@proj).count.should == 2
+    end
+  end
+  
+  context 'has_no_roles_for!' do
+    it 'should remove roles for object' do 
+      proj2 = Project.new
+      
+      @bob.has_role!(:manager, @proj)
+      @bob.has_role!(:leader, @proj)
+      @bob.has_role!(:manager, proj2)
+      
+      @bob.has_no_roles_for!(@proj)
+      
+      @bob.roles.count.should == 1
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: mongoid_roles
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Michal Wychowaniec
@@ -10,10 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 +01:00
+date: 2011-03-21 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.7
+  type: :development
+  version_requirements: *id003
 description: Mongoid Roles
 email: 
 - michal.wychowaniec@gmail.com
@@ -26,7 +58,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README.md
+- README.textile
 - Rakefile
 - lib/mongoid/roles.rb
 - lib/mongoid/roles/object.rb
@@ -35,6 +67,10 @@ files:
 - lib/mongoid/roles/version.rb
 - lib/mongoid_roles.rb
 - mongoid_roles.gemspec
+- spec/models/project.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/subject_spec.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -58,10 +94,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: mongoid_roles
+rubyforge_project: 
 rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Mongoid Roles
-test_files: []
-
+test_files: 
+- spec/models/project.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/subject_spec.rb

data/README.md

@@ -1,4 +0,0 @@
-Mongoid Roles
-=============
-
-Roles system for mongoid with interface based on [acl9](https://github.com/be9/acl9).