action_policy-graphiti 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7db91afa6d3c7fbc23e5d0551cb462666a488930e6e3faebe4652da3ffc3d31b
-  data.tar.gz: e23d9222e846dd0c649093e296617ed0114a8377f97d28ee13ab36726d65f22c
+  metadata.gz: 14c1d111ab3637ca0a0473052745648b29d59eae102983f2352aee57cad48b91
+  data.tar.gz: ef0f1e0ba47fbf1091c471dae9a0b6902c9c63cd238f5325c5af19afe82936db
 SHA512:
-  metadata.gz: 5120f1911ee32eca98396110b06c4173114f1bff437f8e51af7f856e35352166bce58f38d129ab7be4f95618e5a15e6b216a7fc4d16cd7fedc4f9dffcbc7b5a4
-  data.tar.gz: f28b0083a0fe65b96983fa7b53d292852a009cb1a56bf34f83cd1e9bf862e33ec4e66027afbe625a81df633b1bf74a1863a083f5c85ed308010268845e9b42f9
+  metadata.gz: 94e2a8414ab817b697a36de4c438e29ed5f9b610b30cf2f551b2598e56e257443a6adabecea6af9d43553376279b024cce266d45ec687b7809157eed9ab7d63a
+  data.tar.gz: 014b16778a53046c51d6851d1e8d8298fbec0840d0dbd6de898441d2f2d71e7fd07b19ae09842de7e7fae0a61462c79c3c736e1ae5e146a6ce7299e815b9184e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.2.0] - 2023-06-28
+
+- Enable authorization shortcuts
+
+## [0.1.0] - 2023-06-23
+
+- Enable explicit policies and actions
+
 ## [0.0.1] - 2023-05-02
 
 - Initial release

data/README.md

@@ -7,12 +7,10 @@ The following features are currently enabled:
 - Authorization of `create`, `update` and `destroy` actions
 - Resource scoping
 
-**This gem is under heavy development, was not yet released (since it is not production ready) so use it at your own risk!**
+**This gem is under heavy development so use it at your own risk!**
 
 ## Installation
 
-**This gem was not yet released and can be installed only via a github link**
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -40,17 +38,44 @@ class TestResource < ApplicationResource
   authorize_action :destroy
 end
 ```
+
+Or certain action shortcuts may be used (pay attention to explicit policies and actions):
+
+```ruby
+class TestResource < ApplicationResource
+  include ActionPolicy::Graphiti::Behaviour
+  
+  authorize_create to: :manage_but_not_destroy?
+  authorize_update with: 'TestExplicitPolicy', to: :manage_but_not_destroy?
+  authorize_destroy
+end
+```
+
+**Note:** current implementation requires you to use policy names (when specifying explicit policies) instead of classes since it is not guaranteed that policy classes are already loaded **before** the resource classes load.
+
 **Note:** current implementation requires you to place `authorize_` directives **after** `before_save` and `before_destroy` hooks (since it is adding authorization checks as hooks and we want them to be called **after** all the regular hooks were completed).
 
-Scoping is done via adding the following class method call: 
+Scoping is done via adding the following class method call (you can specify the explicit policy using `with` argument): 
 ```ruby
 class TestResource < ApplicationResource
   include ActionPolicy::Graphiti::Behaviour
   
-  authorize_scope
+  authorize_scope with: 'TestExplicitPolicy'
+  # or just plain authorize_scope 
 end
 ```
-**Note:** current implementation requires you to place `authorize_scope` call **after** the explicit `base_scope` method (scoping is performed by base scope results modification).
+
+You can also use a handy shortcut (you can also use an explicit `with` argument just as with other `authorize_` class methods) to authorize `create`, `update`, `destroy` methods and also apply scoping:
+```ruby
+class TestResource < ApplicationResource
+  include ActionPolicy::Graphiti::Behaviour
+  
+  authorize_and_scope_all with: 'TestExplicitPolicy'
+  # or just plain authorize_and_scope_all if you want to deduce the policy class 
+end
+```
+
+**Note:** current implementation requires you to place `authorize_scope` (and `authorize_and_scope_all` too) call **after** the explicit `base_scope` method (scoping is performed by base scope results modification).
 
 You can also use authorization context building inside Graphiti resources (just like with Action Policy in controllers):
 ```ruby

data/lib/action_policy/graphiti/behaviour.rb

@@ -12,17 +12,23 @@ module ActionPolicy
         AUTHORIZABLE_ACTIONS = %i[create update destroy].freeze
         IMPLICITLY_AUTHORIZABLE_ACTIONS = %i[index show].freeze
 
-        def authorize_action(action, **arguments)
+        def authorize_action(action, to: nil, with: nil, **arguments)
           if AUTHORIZABLE_ACTIONS.include?(action)
-            rule = "#{action}?".to_sym
-
             callback_and_arguments = callback_and_arguments_for_action(action)
 
             callback = callback_and_arguments[:callback]
             callback_arguments = callback_and_arguments[:arguments]
 
             send(callback, **callback_arguments) do |model|
-              authorize! model, with: ActionPolicy.lookup(self), to: rule, **arguments
+              rule = to || "#{action}?".to_sym
+
+              policy = if with
+                         with.is_a?(String) ? ActiveSupport::Inflector.safe_constantize(with) : with
+                       else
+                         ActionPolicy.lookup(self)
+                       end
+
+              authorize! model, with: policy, to: rule, **arguments
             end
           elsif IMPLICITLY_AUTHORIZABLE_ACTIONS.include?(action)
             raise ArgumentError, "Index and show authorization is done implicitly by scoping"
@@ -46,28 +52,42 @@ module ActionPolicy
           }
         end
 
-        def authorize_create
-          authorize_action(:create)
+        def authorize_create(**arguments)
+          authorize_action(:create, **arguments)
         end
 
-        def authorize_update
-          authorize_action(:update)
+        def authorize_update(**arguments)
+          authorize_action(:update, **arguments)
         end
 
-        def authorize_destroy
-          authorize_action(:destroy)
+        def authorize_destroy(**arguments)
+          authorize_action(:destroy, **arguments)
         end
 
-        def authorize_scope(_scope_name = nil)
+        def authorize_scope(_scope_name = nil, with: nil)
           original_base_scope = instance_method(:base_scope)
 
           define_method(:base_scope) do |*args, &block|
+            policy = if with
+                       with.is_a?(String) ? ActiveSupport::Inflector.safe_constantize(with) : with
+                     else
+                       ActionPolicy.lookup(self)
+                     end
+
             authorized_scope(
               original_base_scope.bind(self).call(*args, &block),
-              with: ActionPolicy.lookup(self)
+              with: policy
             )
           end
         end
+
+        def authorize_and_scope_all(**arguments)
+          authorize_scope(**arguments)
+
+          authorize_create(**arguments)
+          authorize_update(**arguments)
+          authorize_destroy(**arguments)
+        end
       end
 
       def self.included(base)

data/lib/action_policy/graphiti/version.rb

@@ -2,6 +2,6 @@
 
 module ActionPolicy
   module Graphiti
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy-graphiti
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrei Mochalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: action_policy
@@ -70,28 +70,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency