ez-permissions 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e66c7c3aaf11e53f4f1049546d344eef5ef7ef0c4ab2af0ffb8940d11a64afa1
-  data.tar.gz: 6833c0293e997dd7d6f9f82d1c7794f1197f5167012254260b1d0f763e0bc32c
+  metadata.gz: 4b1bba0ec695b54e27b18035b6ca073f1a66810df48707479431fb3f31f0ff8c
+  data.tar.gz: 49278569109b575599eda90fc1afeb57490e368c8ece5442e0fc90a8eb02703b
 SHA512:
-  metadata.gz: d99a291847509881c4d11c804fd1b92a9bfc62da9f28d4f802bfcc0d3b61fcd15dc6da4ad980ef6b2ee861b9c28806b09e194b7160b4e74a65a5d54716758977
-  data.tar.gz: c20c12f67b68b8bac4f88402eeff521d06eb6e731c2811385ab20d64d9dc2f334003acc03ab512daf61cce6adcaef37ef8e58678747aff3e449e1518c3559e30
+  metadata.gz: d80747eeffaac6088373fa9fa56e78ae9351b4b9f2f708a5426344f64067bd4b4c717635482260051fb0d5004725fa535ed98074ee3e934217d9080a5d591c82
+  data.tar.gz: da7e1ced8d532ff27689e6b309858ad501ba3aee88edb35ec76e2af1ee72104b38b33240a6d2d47e93e8fed458434dbeac496ee9773f2601bf478595ffc2b6bd

data/README.md

@@ -7,9 +7,9 @@
 **Ez Permissions** (read as "easy permissions") - one of the [ez-engines](https://github.com/ez-engines) collection that helps easily add permissions interface to your [Rails](http://rubyonrails.org/) application.
 
 - Most advanced RBAC model:
-- Flexible tool with simple DSL and confguration
+- Flexible tool with simple DSL and configuration
 - All in one solution
-- Convetion over configuration principles.
+- Convention over configuration principles.
 - Depends on [ez-core](https://github.com/ez-engines/ez-core)
 
 ## Installation
@@ -36,7 +36,7 @@ Ez::Permissions.configure do |config|
   config.models_roles_table_name = 'my_model_roles'
   config.permissions_roles_table_name = 'my_permissions_roles'
 
-  # Suppress stdoud messages for test environment
+  # Suppress STDOUT messages for test environment
   config.mute_stdout = true if Rails.env.test?
 
   # Define your custom callbacks
@@ -61,7 +61,7 @@ rails generate ez:permissions:migrations
 
 ## DSL
 
-Simple DSL for difinition of permission relationships
+Simple DSL for definition of permission relationships
 ```ruby
 Ez::Permissions::DSL.define do |setup|
   # You need add all resources of your application and possible actions
@@ -72,8 +72,8 @@ Ez::Permissions::DSL.define do |setup|
   setup.add :permissions, actions: %i[crud my_custom_action]
 
   # Actions option are not required. In such case you add all crud actions by default
-  setup.add :users
-  setup.add :projects
+  setup.add :users, group: :accounts # You can group resources
+  setup.add :projects # Resource without a group will get "others" group
 end
 ```
 
@@ -89,7 +89,7 @@ user = User.first
 
 # User model become permission model
 user.roles #=> [application level roles]
-user.assigned_roles #=> [user owned roles, gloabal and scoped]
+user.assigned_roles #=> [user owned roles, global and scoped]
 user.permissions #=> [user available permissions through assigned_roles]
 ```
 
@@ -146,6 +146,10 @@ Permissions.includes_role?(user, :admin)
 # Check if user includes scoped role
 project = Project.first
 Permissions.includes_role?(user, :manager, scoped: project)
+
+# List users with particular role in particular scope
+project = Project.first
+Permissions.list_by_role(:manager, scoped: project)
 ```
 
 ### Permissions
@@ -180,7 +184,7 @@ end
 # otherwise you will get an exception
 Ez::Permissions::NotAuthorized
 
-# Both .authrorize and .authorize! methods can be used without blocks.
+# Both .authorize and .authorize! methods can be used without blocks.
 
 # if you don't want raise exception, just use
 Permissions.authorize(user, :create, :users) { puts 'Yeahh!' } #=> false
@@ -204,7 +208,7 @@ 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
+  # execute authorized code
 end
 
 # or user #can? and #authorize! helper methods
@@ -217,7 +221,7 @@ user_permissions.authorize!(:create, :users) # => raise Ez::Permissions::NotAuth
 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.
 
-Add test helpers tou your rspec config
+Add test helpers to your rspec config
 ```ruby
 require 'ez/permissions/rspec_helpers'
 
@@ -248,7 +252,7 @@ mock_model_role(:worker, user)
 mock_permission(:users, :create)
 ```
 
-### Cleaup redundant permissions
+### Cleanup redundant permissions
 If you changed your permissions DSL and removed redundant resources and actions
 
 ```sh
@@ -256,7 +260,7 @@ rake ez:permissions:outdated # display list of outdated permissions
 rake ez:permissions:cleanup # remove outdated permissions from the DB
 ```
 
-### Kepp it excplicit!
+### Keep it explicit!
 You can wonder, why we just not add authorization methods to user instance, like:
 ```ruby
 user.can?(:something)
@@ -270,7 +274,7 @@ Of course, you can use them as mixins, but it's up to you.
 - User can has role in scope of some resource (Project, Company, Business, etc.)
 - User can has role in global scope (without scope)
 - If user want access data in scope of resource - user must has assigned role scoped for this resource
-- If user want access data in global scope - user must has assigned role wihtout any scoped resorce (global role)
+- If user want access data in global scope - user must has assigned role without any scoped resource (global role)
 - User with global role - can't access scoped resources.
 - User with scoped role - can't access global resources.
 

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

@@ -17,7 +17,7 @@ module Ez
 
           def authorize!(action_name, resource_name)
             permissions_map.fetch(to_key(action_name, resource_name))
-          rescue KeyError => ex
+          rescue KeyError
             raise Ez::Permissions::NotAuthorizedError
           end
 

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

@@ -26,6 +26,15 @@ module Ez
           model_role(role, model, scoped) ? true : false
         end
 
+        def list_by_role(role_name, scoped: nil)
+          role = Ez::Permissions::API.get_role!(role_name)
+
+          Ez::Permissions::ModelRole.where(
+            role:   role,
+            scoped: scoped
+          ).map(&:model)
+        end
+
         private
 
         def model_role(role, model, scoped)

data/lib/ez/permissions/dsl.rb

@@ -42,7 +42,7 @@ module Ez
         return unless seed_to_db(resource)
 
         message(
-          "Resource [#{name}] has been successfully registred with actions: [#{resource.actions.join(', ')}]",
+          "Resource [#{name}] has been successfully registered with actions: [#{resource.actions.join(', ')}]",
           'SUCCESS'
         )
       end

data/lib/ez/permissions/resource.rb

@@ -5,12 +5,14 @@ module Ez
     class Resource
       ACTIONS = %i[create read update delete].freeze
 
-      attr_reader :name, :model, :actions
+      attr_reader :name, :model, :actions, :group, :label
 
       def initialize(name, options = {})
         @name    = name
         @model   = options.fetch(:model, nil)
         @actions = process_actions(options.fetch(:actions, []))
+        @group   = options.fetch(:group, :others)
+        @label   = options.fetch(:label, name.to_s.humanize)
       end
 
       def <=>(other)

data/lib/ez/permissions/version.rb

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

data/lib/tasks/ez/permissions_tasks.rake

@@ -7,8 +7,8 @@ namespace :ez do
       Ez::Permissions::Permission.find_each do |permission|
         next if Ez::Permissions::DSL.resource_action?(permission.resource, permission.action)
 
-        STDOUT.puts "[WARNING] Ez::Permissions: \n"
-        "Permission##{permission.id} [#{permission.resource} -> #{permission.action}] is redundant"
+        STDOUT.puts '[WARNING] Ez::Permissions:'\
+          "Permission##{permission.id} [#{permission.resource} -> #{permission.action}] is redundant"
       end
     end
 
@@ -17,8 +17,8 @@ namespace :ez do
         next if Ez::Permissions::DSL.resource_action?(permission.resource, permission.action)
 
         permission.destroy
-        STDOUT.puts "[WARNING] Ez::Permissions: \n"
-        "Permission##{permission.id} [#{permission.resource} -> #{permission.action}] is removed"
+        STDOUT.puts '[WARNING] Ez::Permissions:'\
+          "Permission##{permission.id} [#{permission.resource} -> #{permission.action}] is removed"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez-permissions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-08 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ez-core
@@ -193,7 +193,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,15 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Easy permissions engine for Rails app.
 test_files: []