caber 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32626bb698069dab3797b3fe532bce89def4fc6a91c0662e030b93df58c7b0c4
-  data.tar.gz: 999efb197f1567376feb709b6d2e77d83d2d4d0f79e42ecdae8c7e2429997f9d
+  metadata.gz: 3e3022bcc88c31576a8e8f204063bb1cb3a3a2365cee60f5d5d8769779821719
+  data.tar.gz: 9509f57e488c365e11cba921957db94d0f518e476f5457f56c8f12a39c160f54
 SHA512:
-  metadata.gz: 67c2028ca5dd0aead722b9ea20961c41e2fe8fe6733c4b68b732f08f4292b32b568ac7f3b6e49d0f30168b01cc7c78ff457f319410c7e504856640c57800c605
-  data.tar.gz: 868d630bf81d19a45b9ff058cdac098ccb6115f985e1a9c0426e30243ed6b36e8dbf2b16b3da1a68e889906d2b571cf1aed9beac62ed9ce4940f6ee638cec7a9
+  metadata.gz: 6c3fb313ae9125c1bf96a857be7abc2b8c2dead1aa4a8e1c9347d08c3e3b2dbe634e6919dac1ccafb673e97002855d0b1ded604fc77d64e4da1b0055b8ba744e
+  data.tar.gz: bb2d952b4fe708bc50194f167bf11cd01fdfdaf5d02a64a50a9c2cd8d3d8f66d0980d84f1c1922f54237cf216bd958788edbbe0b447f7229381c6bf211ed9f52

data/README.md

@@ -1,6 +1,11 @@
 # Caber
 
-A simple ReBAC / Zanzibar gem for Rails apps.
+![Gem Downloads (for latest version)](https://img.shields.io/gem/dtv/caber)
+![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/rubygems/caber)
+![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/rubygems/caber)
+
+
+A simple [ReBAC](https://en.wikipedia.org/wiki/Relationship-based_access_control) / [Zanzibar](https://research.google/pubs/zanzibar-googles-consistent-global-authorization-system/) backend plugin for Rails apps. Allows you to easily specify permission relationships between pairs of objects, e.g. granting edit permission on a document to a specific user, like in Google Docs.
 
 ## Installation
 
@@ -114,6 +119,57 @@ document.revoke_permission("viewer", user)
 document.revoke_all_permissions(user)
 ```
 
+### Finding objects
+
+You can get lists of objects that a user has some permission on:
+
+```
+Document.granted_to "viewer", user
+# => All the documents that user has "viewer" permission on
+```
+
+## Usage with other gems
+
+### Pundit
+
+Caber makes for nice clear [Pundit](https://github.com/varvet/pundit) policies:
+
+```
+class DocumentPolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    def resolve
+      scope.granted_to(["viewer", "editor", "owner"], user)
+    end
+  end
+
+  def update?
+    record.grants_permission_to? ["editor", "owner"], user
+  end
+end
+```
+
+### Rolify
+
+Caber doesn't include groups specifically, but you can integrate it easily with a role management gem like [Rolify](https://github.com/RolifyCommunity/rolify) pretty easily. Make your Role class a subject, and you can grant permissions to roles:
+
+```
+class Document < ApplicationRecord
+  include Caber::Object
+  can_grant_permissions_to Role
+end
+
+class Role < ApplicationRecord
+  include Caber::Subject
+  can_have_permissions_on Document
+
+  scopify
+end
+
+document.grant_permission_to "editor", Role.find_by(name: "editor")
+
+User.with_role(document.permitted_roles.with_permission("editor"))
+# => all users with a role that can edit the document
+```
 
 ## Development
 
@@ -123,11 +179,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/manyfold3d/caber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Code of Conduct
-
-Everyone interacting in the Caber project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/manyfold3d/caber/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/manyfold3d/caber. This project is intended to be a safe, welcoming space for collaboration; everyone interacting in the Caber project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/manyfold3d/caber/blob/master/CODE_OF_CONDUCT.md).
 
 ## Acknowledgements
 
@@ -135,3 +187,5 @@ This gem was created as part of [Manyfold](https://manyfold.app), with funding f
 
 [<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
 [<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/entrust)
+
+Name: `"ReBAC".downcase.reverse`

data/app/models/concerns/caber/object.rb

@@ -8,6 +8,13 @@ module Caber::Object
     def self.can_grant_permissions_to(model)
       has_many :"permitted_#{model.name.pluralize.parameterize}", through: :caber_relations, source: :subject, source_type: model.name
     end
+
+    scope :granted_to, ->(permission, subject) {
+                         includes(:caber_relations).where(
+                           "caber_relations.subject": subject,
+                           "caber_relations.permission": permission
+                         )
+                       }
   end
 
   def grant_permission_to(permission, subject)

data/lib/caber/version.rb

@@ -1,3 +1,3 @@
 module Caber
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caber
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - James Smith