ez-permissions 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2561daddeb0d81e3d7916f64a0d334eeb181cc1bc1244fbfd96090abb6d0b5a3
-  data.tar.gz: 648bd08668a2def0f908fa5be6125fbce12d186a760f1c2e51bc87b1e935041d
+  metadata.gz: e66c7c3aaf11e53f4f1049546d344eef5ef7ef0c4ab2af0ffb8940d11a64afa1
+  data.tar.gz: 6833c0293e997dd7d6f9f82d1c7794f1197f5167012254260b1d0f763e0bc32c
 SHA512:
-  metadata.gz: a43ee4b3d8416de6d87e2dec796528698a3dc51e44e1b4357153f59081033ebdf8525fb9acf9c4b3263df7a745292ba9a7095a93dd119624f7844c18a5e4d3cf
-  data.tar.gz: f945fff2beff8c9543e8e6d1fa8742c8e8dc5259d055b82b31930010be0e1f37a2d0196af9b57855e7c786b3a87406b5d5b532a28039abf68726f5abe19e76e9
+  metadata.gz: d99a291847509881c4d11c804fd1b92a9bfc62da9f28d4f802bfcc0d3b61fcd15dc6da4ad980ef6b2ee861b9c28806b09e194b7160b4e74a65a5d54716758977
+  data.tar.gz: c20c12f67b68b8bac4f88402eeff521d06eb6e731c2811385ab20d64d9dc2f334003acc03ab512daf61cce6adcaef37ef8e58678747aff3e449e1518c3559e30

data/README.md

@@ -191,6 +191,28 @@ Permissions.can?(user, :create, :users) => # true
 Permissions.can?(user, :create, :users, scoped: project) => # false
 ```
 
+### Caching user permissions
+
+If in one HTTP request (e.g. navigation menu rendering) you don't want to hit the database with dozens of queries, you can cache all user permission in a hash
+
+```ruby
+user_permissions =  Permissions.model_permissions_map(user)
+user_permissions # => #<Ez::Permissions::API::Authorize::ModelPermissions...
+
+# You can fetch permissions as a hash
+user_permissions.permissions_map # => { :read_users => true}
+
+# and the in your code just fetch by the key:
+if user_permissions.permissions_map[:read_users]
+  # execute authrorized code
+end
+
+# or user #can? and #authorize! helper methods
+user_permissions.can?(:read, :users) # => true
+user_permissions.can?(:create, :users) # => false
+user_permissions.authorize!(:create, :users) # => raise Ez::Permissions::NotAuthorized
+```
+
 ### Testing
 EzPermissions ships with bunch of RSpec helper methods that helps mock permission.
 For large test suite (more than 5000 specs) it saves up to 30% of test runs time.

data/lib/ez/permissions/api/authorize.rb

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
 
+require_relative 'authorize/model_permissions'
+
 module Ez
   module Permissions
     module API
       module Authorize
+        def model_permissions(model)
+          ModelPermissions.new(
+            model.permissions.each_with_object({}) do |permission, acum|
+              acum["#{permission.action}_#{permission.resource}".to_sym] = true
+            end
+          )
+        end
+
         def authorize!(model, *actions, resource, scoped: nil, &block)
           authorize(model, *actions, resource, scoped: scoped, raise_exception: true, &block)
         end

data/lib/ez/permissions/api/authorize/model_permissions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ez
+  module Permissions
+    module API
+      module Authorize
+        class ModelPermissions
+          attr_reader :permissions_map
+
+          def initialize(permissions_map)
+            @permissions_map = permissions_map
+          end
+
+          def can?(action_name, resource_name)
+            permissions_map[to_key(action_name, resource_name)] == true
+          end
+
+          def authorize!(action_name, resource_name)
+            permissions_map.fetch(to_key(action_name, resource_name))
+          rescue KeyError => ex
+            raise Ez::Permissions::NotAuthorizedError
+          end
+
+          private
+
+          def to_key(action_name, resource_name)
+            "#{action_name}_#{resource_name}".to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ez/permissions/version.rb

@@ -2,6 +2,6 @@
 
 module Ez
   module Permissions
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ez-permissions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
@@ -176,6 +176,7 @@ files:
 - lib/ez/permissions.rb
 - lib/ez/permissions/api.rb
 - lib/ez/permissions/api/authorize.rb
+- lib/ez/permissions/api/authorize/model_permissions.rb
 - lib/ez/permissions/api/models.rb
 - lib/ez/permissions/api/permissions.rb
 - lib/ez/permissions/api/roles.rb