granted 0.1.0 → 0.2.0

data/README.markdown

@@ -1,27 +1,23 @@
+# Dead easy rails permissions [![Gem Version](https://badge.fury.io/rb/granted.png)](http://badge.fury.io/rb/granted) [![Build Status](https://travis-ci.org/jayniz/granted.png?branch=master)](https://travis-ci.org/jayniz/granted)
+
+Installation is as easy as 1,2,3:
+<table>
+  <tr>
+    <td align="center"><h1>1.</h1>Add to Gemfile:<pre>gem 'granted'
+    </pre></td>
+    <td align="center"><h1>2.</h1>Add to Rakefile: <pre>require 'granted/tasks'
+    </pre></td>
+    <td align="center"><h1>3.</h1>Create grants migration: <pre align="left">rake granted:create_migration
+rake db:migrate</pre></td>
+  </tr>
+</table>
+
 This gem lets you define arbitrary permissions on a per object level (as opposed to roles).
 They are implemented purely as active record associations and hence easy to understand.
 Check out this readme on how to grant read/write permissions on individual documents to
 individual users. This is a [moviepilot.com](http://moviepilot.com) project licensed
-[MIT](LICENSE.txt).
-
-[![Build Status](https://travis-ci.org/jayniz/granted.png?branch=master)](https://travis-ci.org/jayniz/granted)
-
-# Quickstart
-
-Install with bundler:
-
-    gem 'granted'
+[MIT](LICENSE.txt). And now, code:
 
-Add to Rakefile:
-
-    require 'granted/tasks'
-
-Create the migration for the grants table:
-
-    rake granted:create_migration
-    rake db:migrate
-
-And then:
 
 ```ruby
 # Let's grant a user access to a document
@@ -39,6 +35,10 @@ user.readable_documents.count
 # Let's count all documents a user has any access to
 user.all_documents.count
 
+# List the rights a user has to a certain document
+user.grants_for(document)
+=> [:read, :write]
+
 # Define the things we took for granted (scuse me) above
 class Document
   include Granted::ForGranted
@@ -95,8 +95,9 @@ class User < ActiveRecord::Base
   has_many :readable_documents,  source: :subject, source_type: 'Document', through: :read_grants
   has_many :all_documents,       source: :subject, source_type: 'Document', through: :grants, uniq: true
 
-  attr_accessible :writeable_documents_attributes, :readable_documents_attributes
-  accepts_nested_attributes_for :writeable_documents, :readable_documents
+  # It does not do this yet, but hopefully soon :)
+  # attr_accessible :writeable_documents_attributes, :readable_documents_attributes
+  # accepts_nested_attributes_for :writeable_documents, :readable_documents
 end
 ```
 
@@ -146,7 +147,7 @@ my_document.revoke(:read).from(my_user)
 
 # Clever: even weird grammatic yields identic results
 my_user.on(my_document).revoke(:read)
-my_document.revoke(:read).from(:my_user)
+my_document.from(:my_user).revoke(:read)
 
 # This is what the grant/revoke methods do:
 Granted::Granter.new.grant(:read).on(my_document).to(my_user)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/granted.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "granted"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jannis Hermanns"]
-  s.date = "2013-08-06"
+  s.date = "2013-08-08"
   s.description = "Takes care of defining what actions one model is allowed to do with another model."
   s.email = "jannis@gmail.com"
   s.extra_rdoc_files = [

data/lib/granted/granter.rb

@@ -6,7 +6,7 @@ module Granted
     def to(grantee)
       accept(grantee: grantee)
     end
-    
+
     def from(grantee)
       accept(grantee: grantee)
     end

data/lib/granted/modules/grantee.rb

@@ -14,5 +14,21 @@ module Granted
                         .rights(rights)
                         .to(self)
       end
+
+      def grants_for(subject)
+        grants.subject(subject).map do |g|
+          grant_class_name_to_symbol(g.type)
+        end.sort
+      end
+
+      private
+
+      def grant_class_name_to_symbol(c)
+        # A class name could be Granted::ReadGrant
+        # and we want to make :read out of it
+        c.underscore[8..-1]  # Remove granted/ prefix
+         .chomp('_grant')    # Remove trailing _grant
+         .to_sym
+      end
   end
 end

data/spec/models/grant_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper.rb'
 
 describe Granted::Grant do
+
   before(:all) do
     @alfred  = User.create name: 'Alfred'
     @bruce   = User.create name: 'Bruce'
@@ -10,105 +11,118 @@ describe Granted::Grant do
     Granted::WriteGrant.create! grantee: @alfred, subject: @alfreds
   end
 
-  context "using a grantee as the starting point" do
-    it "lists Alfred's document as one of his writeable documents" do
-      @alfred.writeable_documents.count.should == 1
-    end
-
-    it "Alfred has no readable documents" do
-      @alfred.readable_documents.count.should == 0
-    end
-
-    it "Bruce has no documents at all" do
-      @bruce.all_documents.count.should == 0
-    end
-
-    it "grant read access on Alfred's document to Bruce" do
-      Granted::Grant.destroy_all
-      expect{
-        @bruce.grant(:read).on(@alfreds)
-      }.to change(@bruce.readable_documents, :count).from(0).to(1)
-    end
-
-    it "grant all access on Alfred's document to Bruce" do
-      Granted::Grant.destroy_all
-      expect{
-        @bruce.grant(:read, :write, :destroy).on(@alfreds)
-      }.to change(Grant, :count).from(0).to(3)
-    end
-
-    it "revoke write access on Alfred's document from Alfred" do
-      expect{
-        @alfred.revoke(:write).on(@alfreds)
-      }.to change(@alfred.writeable_documents, :count).from(1).to(0)
+  describe "granting/revoking rights" do
+    describe "using a grantee as the starting point" do
+      it "lists Alfred's document as one of his writeable documents" do
+        @alfred.writeable_documents.count.should == 1
+      end
+
+      it "Alfred has no readable documents" do
+        @alfred.readable_documents.count.should == 0
+      end
+
+      it "Bruce has no documents at all" do
+        @bruce.all_documents.count.should == 0
+      end
+
+      it "grant read access on Alfred's document to Bruce" do
+        Granted::Grant.destroy_all
+        expect{
+          @bruce.grant(:read).on(@alfreds)
+        }.to change(@bruce.readable_documents, :count).from(0).to(1)
+      end
+
+      it "grant all access on Alfred's document to Bruce" do
+        Granted::Grant.destroy_all
+        expect{
+          @bruce.grant(:read, :write, :destroy).on(@alfreds)
+        }.to change(Grant, :count).from(0).to(3)
+      end
+
+      it "revoke write access on Alfred's document from Alfred" do
+        expect{
+          @alfred.revoke(:write).on(@alfreds)
+        }.to change(@alfred.writeable_documents, :count).from(1).to(0)
+      end
+
+      it "returns Alfred only once even though he has multiple rights" do
+        Granted::DestroyGrant.create(subject: @alfreds, grantee: @alfred)
+        @alfred.grants.count.should == 2
+        @alfred.all_documents.count.should == 1
+      end
     end
 
-    it "returns Alfred only once even though he has multiple rights" do
-      Granted::DestroyGrant.create(subject: @alfreds, grantee: @alfred)
-      @alfred.grants.count.should == 2
-      @alfred.all_documents.count.should == 1
+    describe "using a subject as the starting point" do
+      it "lists Alfred's document as one of his writeable documents" do
+        @alfreds.write_users.count.should == 1
+      end
+
+      it "grant read access on Alfred's document to Bruce" do
+        Granted::Grant.destroy_all
+        expect{
+          @alfreds.grant(:read).to(@bruce)
+        }.to change(@alfreds.read_users, :count).from(0).to(1)
+      end
+
+      it "grant all access on Alfred's document to Bruce" do
+        Granted::Grant.destroy_all
+        expect{
+          @alfreds.grant(:read, :write, :destroy).to(@bruce)
+        }.to change(Grant, :count).from(0).to(3)
+      end
+
+      it "revoke write access on Alfred's document from Alfred" do
+        expect{
+          @alfreds.revoke(:write).from(@alfred)
+        }.to change(@alfreds.write_users, :count).from(1).to(0)
+      end
+
+      it "returns Alfreds only once even though he has multiple rights" do
+        Granted::DestroyGrant.create(subject: @alfreds, grantee: @alfred)
+        @alfreds.grants.count.should == 2
+        @alfreds.all_users.count.should == 1
+      end
     end
-  end
 
-  context "using a subject as the starting point" do
-    it "lists Alfred's document as one of his writeable documents" do
-      @alfreds.write_users.count.should == 1
+    describe "granting/revoking rights: rails association style" do
+      it "adds a grant via subject's <<" do
+        expect{
+          @bruces.read_users << @alfred
+          @bruces.save!
+        }.to change(@alfred.readable_documents, :count).from(0).to(1)
+      end
+
+      it "adds a grant via grantee's <<" do
+        expect{
+          @alfred.readable_documents << @bruces
+          @alfred.save!
+        }.to change(@bruces.read_users, :count).by(1)
+      end
     end
 
-    it "grant read access on Alfred's document to Bruce" do
-      Granted::Grant.destroy_all
-      expect{
-        @alfreds.grant(:read).to(@bruce)
-      }.to change(@alfreds.read_users, :count).from(0).to(1)
-    end
-
-    it "grant all access on Alfred's document to Bruce" do
-      Granted::Grant.destroy_all
-      expect{
-        @alfreds.grant(:read, :write, :destroy).to(@bruce)
-      }.to change(Grant, :count).from(0).to(3)
-    end
+    describe "removing grant objects" do
+     it "when subject is deleted" do
+       expect{
+         @alfreds.destroy
+       }.to change(Grant, :count).by(-1)
+     end
 
-    it "revoke write access on Alfred's document from Alfred" do
+     it "when grantee is deleted" do
       expect{
-        @alfreds.revoke(:write).from(@alfred)
-      }.to change(@alfreds.write_users, :count).from(1).to(0)
-    end
-
-    it "returns Alfreds only once even though he has multiple rights" do
-      Granted::DestroyGrant.create(subject: @alfreds, grantee: @alfred)
-      @alfreds.grants.count.should == 2
-      @alfreds.all_users.count.should == 1
+        @alfred.destroy
+      }.to change(Grant, :count).by(-1)
+     end
     end
   end
 
-  context "granting/revoking rights: rails association style" do
-    it "adds a grant via subject's <<" do
-      expect{
-        @bruces.read_users << @alfred
-        @bruces.save!
-      }.to change(@alfred.readable_documents, :count).from(0).to(1)
+  describe "reading grants" do
+    it "alfred should have write grants to his document" do
+      @alfred.grants_for(@alfreds).should == [:write]
     end
 
-    it "adds a grant via grantee's <<" do
-      expect{
-        @alfred.readable_documents << @bruces
-        @alfred.save!
-      }.to change(@bruces.read_users, :count).by(1)
+    it "alfread should have all grants for his document" do
+      @alfred.grant(:destroy, :read).on(@alfreds)
+      @alfred.grants_for(@alfreds).should == [:destroy, :read, :write]
     end
   end
-
-  context "removing grant objects" do
-   it "when subject is deleted" do
-     expect{
-       @alfreds.destroy
-     }.to change(Grant, :count).by(-1)
-   end
-
-   it "when grantee is deleted" do
-    expect{
-      @alfred.destroy
-    }.to change(Grant, :count).by(-1)
-   end
-  end
 end

metadata

@@ -2,14 +2,14 @@
 name: granted
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -338,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 3452521829699155962
+      hash: -1869263062967453258
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement