rails-acu 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: addca3a90dcfe917856a671ff499f15acf1e7c38
-  data.tar.gz: 9d3eaf5dc3196adb7e1cf99d53ca363caace2ddc
+  metadata.gz: edbbd908c54348250acdd6dee3aa62b88dfb7129
+  data.tar.gz: e9f71d527b9f688669270c5c7a81df819aedc3af
 SHA512:
-  metadata.gz: '069d76042fbf8fd75a26e36e8da8fb3e05d477af281e5e9a457afeea10a1c0e4a61b0f4cd781997e9d675ba851b3ec19f202a052103751c3c0df13aba30b63e9'
-  data.tar.gz: 3eb795d9641a9c1f37cec2a3687731baf009fb5268b96a200cb7e061400d728ef8dc8b2203b723b6aff7be6ebb38059d09c8d7ab9d881b2549fcb5c832d5b734
+  metadata.gz: ce4b049791e6de8c5285658c5a4334ff26e4d3c20a39e7431ef95f21d4137f338b5cb3eca45de3a49a6f62f12757644a8710fe60f4f21dacd6d05de0d46bad10
+  data.tar.gz: 5359d87f2f690d8e802882b301f575fd466364268663de0bdff90560b20e5c47bd285d1e511cc13a12aaaf962946dbb33b22e08aa8321a06a3805ec0f69aa9d5

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    rails-acu (1.3.0)
+    rails-acu (2.0.0)
       rails (~> 5.0.0, >= 5.0.0)
 
 GEM

data/README.md

@@ -25,7 +25,7 @@ $ gem install rails-acu
 Then install it in you app using:
 
 ```bash
-rails generate acu:install
+$ rails generate acu:install
 ```
 
 ## Usage
@@ -87,17 +87,17 @@ We want to grant access to everyone for all of _home_ controller actions in _def
 By default only `:admin` can access to the _admin_ namespace, but we made an exception for 2 actions in the `Admin::ContactController` which everyone can `send_message` to the admin and only clients can ask for `support`.<br />
 If you back trace it in the above example you can easily find this scenario in the rules, plain and simple.
 
-### Entities' arguments
-Occasionally there is some situation that you need to pass the some argument in the entities to be able to determine the entity (i.e you cannot get it from `session`, `global variables/function` or directly from `database`) for such situations you can pass the arguments in one of the **base controller**'s `before_action`s as below:
+### Gaurding the requests
+For gaurding you application using ACU, you to need to call it in `before_action` callbacks (preferably in you **base controller**). And also occasionally there is some situation that you need to pass the some argument in the entities to be able to determine the entity (i.e you cannot get it from `session`, `global variables/function` or directly from `database`) for such situations you can pass the arguments as you are calling `Acu::Monitor.gaurd` in your `before_action` as below:
 
 ```ruby
 class ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
 
-  before_action { Acu::Monitor.by user: some_way_to_fetch_it }
+  before_action { Acu::Monitor.gaurd by: { user: some_way_to_fetch_it } }
 end
 ```
-The method `Acu::Monitor.by` accepts with a hashed list of agruments, please note that the keys should be identical to the entities' `args` argument.
+The method `Acu::Monitor.gaurd` accepts a hashed list of agruments named `by`, please note that the keys should be identical to the entities' `args` argument.
 
 ### Some handy helpers
 Although you can define a binary allow/deny access rule in the `acu_rules.rb` file but there will be some gray area that neither you can allow _full access_ to the resource nor _no access_.<br />
@@ -166,11 +166,11 @@ Here are the list of APIs that didn't mentioned above:
 | API | Arguments | Alias | Description |
 | ----- | :-------: | :------: | ---- |
 | `Acu::Configs.get` | `name` | N/A | Get the value of the `name`ed config |
-| `Acu::Monitor.by` | `kwargs` | N/A | Set the arguments demaned by blocks in `whois` |
+| `Acu::Monitor.args` | `kwargs` | N/A | Set the arguments demaned by blocks in `whois` |
 | `Acu::Monitor.clear_cache` | None | N/A | Clears the ACU's rule matching cache |
-| `Acu::Monitor.clear_args` | None | N/A | Clears the argument set by `Acu::Monitor.by` |
+| `Acu::Monitor.clear_args` | None | N/A | Clears the argument set by `Acu::Monitor.args` and `Acu::Monitor.gaurd` |
 | `Acu::Monitor.valid_for?` | `entity` | `acu_is?` | Check if the current request is come from the entity or not |
-| `Acu::Monitor.gaurd` | None | N/A | Validates the current request, this is called automatically just before Rails start calling the _action_ |
+| `Acu::Monitor.gaurd` | `by` | N/A | Validates the current request, considering the arguments demaned by blocks in `whois` |
 | `Acu::Rules.define` | `&block` | N/A | Get a block of rules, **Note** that there could be mutliple `Acu::Rules.define` in your project, the rules will all merge together as a one, so you can have mutliple `acu_rule*.rb` file in your `config/initialize` and they will merge together |
 | `Acu::Rules.reset` | None | N/A | Resets everything in the `Acu::Rules` |
 | `Acu::Rule.lock` | None | N/A | Freezes the rules, you can set it at the _end of the last_ `acu_rule*.rb` file. |

data/lib/acu/monitor.rb

@@ -11,7 +11,7 @@ module Acu
       protected :new
       attr_reader :kwargs
 
-      def by kwargs
+      def args kwargs
         @kwargs = @kwargs.merge(kwargs)
       end
 
@@ -19,7 +19,10 @@ module Acu
         @kwargs = { }
       end
 
-      def gaurd
+      def gaurd by: { }
+        # assign the args in class scope
+        args by
+
         # fetch the request & process it
         _info = process Acu::Listeners.data[:request]
 

data/lib/acu/version.rb

@@ -1,3 +1,3 @@
 module Acu
-  VERSION = '1.3.0'
+  VERSION = '2.0.0'
 end

data/lib/rails-acu.rb

@@ -1,5 +1,6 @@
 require 'rails'
 require 'active_support'
+require_relative 'acu/helpers/helpers'
 
 module Acu
 
@@ -9,7 +10,7 @@ module Acu
     files.each { |f| eval "#{command} :#{f.humanize.to_sym}, '#{under}#{f}'" }
   end
 
-  register 'engine', 'rules', 'monitor', 'listeners', 'injectors', 'configs', 'errors'
+  register 'engine', 'rules', 'monitor', 'listeners', 'configs', 'errors'
 
   # Default way to set up Acu. Run rails generate devise_install to create
   # a fresh initializer with all configuration values.
@@ -21,6 +22,4 @@ module Acu
   include Errors
   # include listeners
   include Listeners
-  # include Injector operations
-  include Injectors
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,4 +1,4 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
-  before_action { Acu::Monitor.by user: current_user }
+  before_action { Acu::Monitor.gaurd by: { user: current_user } }
 end

data/spec/dummy/spec/controllers/admin/manage_controller_spec.rb

@@ -56,15 +56,15 @@ RSpec.describe Admin::ManageController, type: :controller do
         end
       end
     end
-    Acu::Monitor.by c: :admin
+    Acu::Monitor.args c: :admin
     get :index
     expect(`tail -n 1 #{Acu::Configs.get :audit_log_file}`).to match /access GRANTED to.*action="index".*as `:admin`/
-    Acu::Monitor.by c: :client
+    Acu::Monitor.args c: :client
     expect {get :index}.to raise_error(Acu::Errors::AccessDenied)
     expect(`tail -n 1 #{Acu::Configs.get :audit_log_file}`).to match /access DENIED to.*action="index".*\[autherized by :allow_by_default\]/
 
     [:client, :admin].each do |cc|
-      Acu::Monitor.by c: cc
+      Acu::Monitor.args c: cc
       get :show
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-acu
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Dariush Hasanpour
@@ -51,7 +51,6 @@ files:
 - lib/acu/engine.rb
 - lib/acu/errors.rb
 - lib/acu/helpers/helpers.rb
-- lib/acu/injectors.rb
 - lib/acu/listeners.rb
 - lib/acu/monitor.rb
 - lib/acu/rules.rb

data/lib/acu/injectors.rb

@@ -1,15 +0,0 @@
-require_relative 'helpers/helpers'
-
-module Acu
-  module Injectors
-    class << self
-
-      ActiveSupport::Notifications.subscribe "start_processing.action_controller" do |**args|
-        eval(args[:controller]).class_eval do
-          before_action { Monitor::gaurd }
-        end
-      end
-
-    end
-  end
-end