pastore 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18748116f3fc80df20d80cb5a47476750ca7e25fe14d249ce90c80e29939f14a
-  data.tar.gz: f96b3c8969cc3b65e9ec3992bb1b20dba39e3fc271b11523c767b2c4c0e1ba12
+  metadata.gz: 995ad5e50f20279c2e14208bef2a61ead6e26a2e10a0f92c84eec77c24ae5a4d
+  data.tar.gz: 7f34397427f2ab4ef31945dd3b8556750f84aeb080451403cbd91dfe9d467829
 SHA512:
-  metadata.gz: 5e5a985b839f0223e0a52b5e1dc61423fa70a407460d64f02d42a7b1d53a9609d0568acdc918804bb994cb1f93bb763fcbedb415be496a5ef57a7006274666c7
-  data.tar.gz: c2c2d1f2509e854c96b4ffb97369f3f31a6b60363b23db317a1d69b48c0d8a92d2f464af60a9e4ad220aa11ab25ab6d032b358876704842ddc27d9dd8042aac5
+  metadata.gz: 8b79de1d7e1bcefeec13a267a618d6fcdea85fbc291fde42226880f7e74d7f643e416a77dc920ae6625a5b79bf8975891a483baca6fd372a52ca3a0e9693fd93
+  data.tar.gz: 70c787f21ba2dc72871120b33ae433288c1de6e971ac95d37c05f52884055fbcf37669177326893379a869b7ecfac9d695fe0aa04a3d364ea6e5af025112ecf0

data/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "RSpec",
+      "request": "launch",
+      "command": "bundle exec rspec",
+      "script": "${file}:${lineNumber}",
+      "args": [],
+      "askParameters": false
+    },
+    {
+      "type": "rdbg",
+      "name": "Attach with rdbg",
+      "request": "attach"
+    }
+  ]
+}

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-01-26
+## [0.1.0] - 2023-02-13
 
-- Initial release
+- [NEW] Implemented `Pastore::Params` feature for params validation.
+
+## [0.0.4] - 2023-02-02
+
+- [FIX] Correctly inherit default guards strategy from parent class.
+
+## [0.0.3] - 2023-02-02
+
+- [FIX] Correctly handle guards callback inheritance.
+
+## [0.0.2] - 2023-02-01
+
+- [NEW] Added some RSpec tests.
+- [NEW] Setup automated tests.
+
+## [0.0.1] - 2023-01-31
+
+- [NEW] First implementation of `Pastore::Guards` feature.

data/Gemfile

@@ -5,8 +5,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in pastore.gemspec
 gemspec
 
-gem 'faker'
-gem 'rake'
-gem 'rspec-rails'
-gem 'shoulda-matchers'
-gem 'pry'
+group :test do
+  gem 'faker'
+  gem 'pry'
+  gem 'rake'
+  gem 'rspec-rails'
+  gem 'shoulda-matchers'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pastore (0.0.3)
+    pastore (0.1.0)
       rails (>= 4.0)
 
 GEM
@@ -78,6 +78,7 @@ GEM
     crass (1.0.6)
     date (3.3.2)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     erubi (1.11.0)
     faker (3.1.0)
       i18n (>= 1.8.11, < 2)
@@ -96,7 +97,6 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
     minitest (5.17.0)
     net-imap (0.3.2)
       date
@@ -108,8 +108,7 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -164,6 +163,12 @@ GEM
     rspec-support (3.12.0)
     shoulda-matchers (5.3.0)
       activesupport (>= 5.2.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     thor (1.2.1)
     timeout (0.3.1)
     tzinfo (2.0.5)
@@ -183,6 +188,7 @@ DEPENDENCIES
   rake
   rspec-rails
   shoulda-matchers
+  simplecov
 
 BUNDLED WITH
    2.3.24

data/README.md

@@ -1,229 +1,44 @@
 # Pastore
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/8f203ba7696c063e9cd2/maintainability)](https://codeclimate.com/github/demetra-it/pastore/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8f203ba7696c063e9cd2/test_coverage)](https://codeclimate.com/github/demetra-it/pastore/test_coverage)
+
 Pastore is a powerful gem for Rails that simplifies the process of validating parameters and controlling access to actions in your controllers.
 With Pastore, you can easily define validations for your parameters, ensuring that they meet specific requirements before being passed to your controller actions.
 Additionally, Pastore allows you to easily control access to your actions, ensuring that only authorized users can access sensitive information.
 With its intuitive interface and robust features, Pastore is a must-have tool for any Rails developer looking to improve the security and reliability of their application.
 
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-    bundle add pastore
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    gem install pastore
-
-## Usage
-
-Pastore gem implements 2 main features: `Guards` and `Validators`. Guards are intended to be used for action access control, while Validators are intended to be used for actions params validation.
-
-### Guards usage
-
-`Guards` feature allows you to define access control logic for actions in Rails controllers. To use the `Guards` you have to include `Pastore::Guards` into your Rails controller.
-
-##### Setup
-
-The best way to start using the `Guards` feature is to add the following code to your `ApplicationController`:
-
-```ruby
-# app/controllers/application_controller.rb
-
-class ApplicationController < ActionController::API
-  include Pastore::Guards
-
-  # Specify the logic for current user's role detection, which will be used to check
-  # if current user is authorized to access a specific action.
-  detect_role do
-    current_user&.role
-  end
-end
-```
-
-In this way all your controllers will inherit the authorization settings from `ApplicationController`. Then in your controller you can do something like this:
-
-```ruby
-class MyController < ApplicationController
-  # By default a :deny strategy is used, so with #permit_role we're going
-  # to specify which roles are allowed to access this action.
-  permit_role :admin, :user, :pm
-  def index
-    # ... action code ...
-  end
-
-  # Without a `permit_role` definition the access to this action will be denied to everyone.
-  def not_allowed_action
-    # ... action code ...
-  end
-end
-```
-
-If you want to use `Guards` only in specific controllers, just include `Pastore::Guards` and define `detect_role` in your controller:
+## Requirements
 
-```ruby
-class CustomController < ApplicationController
-  include Pastore::Guards
+- Ruby >= 2.6
+- Rails >= 5.x
 
-  detect_role do
-    current_user&.role
-  end
+## Installation
 
-  permit_role :admin, :supervisor
-  def index
-    # ... action code ...
-  end
-end
-```
+Install the gem and add to the application's Gemfile by executing:
 
-#### Custom authorization logic
-
-If checking user's role is not enough, you can use the `authorize_with` helper, which will allow you to specify a custom access logic by providing a method name (where custom logic is defined) or a block to use for access verification. As a result your block or method should return `true` if access is granted, or `false` otherwise.
-
-```ruby
-class MyController < ApplicationController
-  # You can override the role detection logic inside a controller if it's necessary by
-  # using the `detect_role` helper.
-  detect_role do
-    current_user&.selected_role
-  end
-
-  # If you want to use a custom/dynamic authorization logic, you can
-  # specify your own implementation in a method.
-  authorize_with :custom_authorization
-  def index
-    # ... action code ...
-  end
-
-  # You can also specify the authorization logic in a block.
-  authorize_with { custom_authorized? }
-  def show
-    # ... action code ...
-  end
-
-  # Allow only users with `admin` role to access this action.
-  permit_role :admin
-  def update
-  end
-
-  private
-
-  # Specify a custom authorization logic (return `true` if successful and `false` when forbidden).
-  def custom_authorization
-    # ... your custom authorization logic here ...
-  end
-end
+```bash
+bundle add pastore
 ```
 
-#### Using `allow` strategy
-
-**!!! WARNING !!!** Be careful when using `allow` strategy, because when enabled it grants access to every action in the controller, which could potentially lead to security issues.
-
-By default `Pastore::Guards` will use `deny` strategy, which means that the access is denied by default, and the only way to access it is through explicit authorization.
-
-Sometimes you might prefer a `allow` strategy instead, in order to allow access to any action within the controller, and manually restrict access to specified actions and roles.
-
-For doing so you can use `use_allow_strategy!`, which changes the default strategy. In this case you should use `deny_role` to disable the access for a specific role or overwrite authorization strategy for specific actions with `authorize_with` helper.
-
-
-
-```ruby
-class MyController < ApplicationController
-  # By default allow access to any action within the controller by any role.
-  use_allow_strategy!
-
-  # In this case we're using the :allow strategy, so if we want to exclude a specific role
-  # we can do it by using #deny_role method.
-  deny_role :user
-  def index
-    # ... action code ...
-  end
-
-  # Check access by using a custom method
-  authorize_with :custom_autorization
-  def restricted_access_action
-    # ... action code ...
-  end
-
-  # Check access by using a block
-  authorize_with { current_user&.role == 'admin' }
-  def restricted_access_action2
-    # ... action code ...
-  end
-
-  private
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-  # Specify a custom authorization logic (return `true` if successful and `false` when forbidden).
-  def custom_autorization
-    # ... custom authorization logic ...
-  end
-end
+```bash
+gem install pastore
 ```
 
-#### Using `skip_guards`
-
-Sometime you may want to disable the `Guards` feature for specific actions. For doing so you can use the `skip_guards` helper, which allows you to specify the list of actions for which guards check have to be disabled. In the example below the access to `index` and `show` actions is granted by `skip_guards` which bypasses the guards check. `skip_guards` have priority over `permit_role`, `deny_role` and `authorize_with`, so using those helpers on actions with disabled guards will have no effect and the access will be granted anyway.
-
-```ruby
-class CustomController < ApplicationController
-  use_deny_strategy!
-  skip_guards :index, :show
+## Usage
 
-  def index
-    # ... action code ...
-  end
+Pastore gem implements 2 main features: `Guards` and `Params`. Guards are intended to be used for action access control, while `Params` are intended to be used for actions params validation.
 
-  authorize_with { false } # this will be ignored because of `skip_guards`
-  def show
-    # ... action code ...
-  end
-end
-```
-
-You can also use `skip_guards` helper with `:except` key, which is useful when you need to disable
-guards for all the actions except a few:
-
-```ruby
-class CustomController < ApplicationController
-  # disable guards for :action_one and :action_two
-  skip_guards except: %i[action_one action_two]
-
-  # Guards DISABLED
-  def index
-    # ... action code ...
-  end
-
-  # Guards ENABLED
-  def action_one
-    # ... action code ...
-  end
-
-  # Guards ENABLED
-  def action_two
-    # ... action code ...
-  end
-
-  # Guards DISABLED
-  def action_three
-    # ... action code ...
-  end
-end
-```
+You can find more about `Params` and `Guards` by following the links below:
 
-#### `Pastore::Guards` features
+* **[Guards docs](./docs/Guards.md)**
+* **[Params docs](./docs/Params.md)**
 
-Below you can find the list of methods implemented by `Pastore::Guards`, that can be used inside
-your Rails Controller.
+## `Pastore::Params` usage
 
-| Method | Description |
-|--------|-------------|
-| `use_deny_strategy!` | Set to `deny` the default authorization strategy, which meands that by default the access to the actions will be denied |
-| `use_allow_strategy!` | Set to `allow` the default authorization strategy, which automatically authorizes the access to all the actions. **!!! WARNING !!!** Be careful when using `allow` strategy, because that way any user can access any action of your controller, including guest users if not filtered before. |
-| `detect_role(&block)` | Allows to specify the logic for user role detection. This block will be automatically called to get current user's role information. |
-| `permit_role(*roles)` | Specifies the roles that are allowed to access the action that follows. |
-| `deny_role(*roles)` | Specifies the roles that are not allowed to access the action that follows. |
-| <code>authorize_with(Symbol\|&block)</code> | Allows to specify a custom authorization logic to use for action access check. Accepts a method name or a block. |
-| <code>skip_guards(*Symbol\|*String, except: *Symbol\|*String)</code> | Allows to disable guards for specific actions. Accepts a list of actions for which to disable guards (e.g. `skip_guards :index, 'show'`), but can be also used to disable guards for all the actions except specified (e.g. `skip_guards except: :index`). |
+`Pastore::Params` is the module that provides the features for params validation in Rails controllers. It allows you to define the params with their data type (`string`, `number`, `boolean`, `date` and `object`), specify which params are mandatory and cannot be blank.
 
 ## Contributing
 

data/docs/Guards.md

@@ -0,0 +1,203 @@
+# `Pastore::Guards`
+
+`Guards` feature allows you to define access control logic for actions in Rails controllers. To use the `Guards` you have to include `Pastore::Guards` into your Rails controller.
+
+## Setup
+
+The best way to start using the `Guards` feature is to add the following code to your `ApplicationController`:
+
+```ruby
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::API
+  include Pastore::Guards
+
+  # Specify the logic for current user's role detection, which will be used to check
+  # if current user is authorized to access a specific action.
+  detect_role do
+    current_user&.role
+  end
+end
+```
+
+In this way all your controllers will inherit the authorization settings from `ApplicationController`. Then in your controller you can do something like this:
+
+```ruby
+class MyController < ApplicationController
+  # By default a :deny strategy is used, so with #permit_role we're going
+  # to specify which roles are allowed to access this action.
+  permit_role :admin, :user, :pm
+  def index
+    # ... action code ...
+  end
+
+  # Without a `permit_role` definition the access to this action will be denied to everyone.
+  def not_allowed_action
+    # ... action code ...
+  end
+end
+```
+
+If you want to use `Guards` only in specific controllers, just include `Pastore::Guards` and define `detect_role` in your controller:
+
+```ruby
+class CustomController < ApplicationController
+  include Pastore::Guards
+
+  detect_role do
+    current_user&.role
+  end
+
+  permit_role :admin, :supervisor
+  def index
+    # ... action code ...
+  end
+end
+```
+
+## Custom authorization logic
+
+If checking user's role is not enough, you can use the `authorize_with` helper, which will allow you to specify a custom access logic by providing a method name (where custom logic is defined) or a block to use for access verification. As a result your block or method should return `true` if access is granted, or `false` otherwise.
+
+```ruby
+class MyController < ApplicationController
+  # You can override the role detection logic inside a controller if it's necessary by
+  # using the `detect_role` helper.
+  detect_role do
+    current_user&.selected_role
+  end
+
+  # If you want to use a custom/dynamic authorization logic, you can
+  # specify your own implementation in a method.
+  authorize_with :custom_authorization
+  def index
+    # ... action code ...
+  end
+
+  # You can also specify the authorization logic in a block.
+  authorize_with { custom_authorized? }
+  def show
+    # ... action code ...
+  end
+
+  # Allow only users with `admin` role to access this action.
+  permit_role :admin
+  def update
+  end
+
+  private
+
+  # Specify a custom authorization logic (return `true` if successful and `false` when forbidden).
+  def custom_authorization
+    # ... your custom authorization logic here ...
+  end
+end
+```
+
+## Using `allow` strategy
+
+**!!! WARNING !!!** Be careful when using `allow` strategy, because when enabled it grants access to every action in the controller, which could potentially lead to security issues.
+
+By default `Pastore::Guards` will use `deny` strategy, which means that the access is denied by default, and the only way to access it is through explicit authorization.
+
+Sometimes you might prefer a `allow` strategy instead, in order to allow access to any action within the controller, and manually restrict access to specified actions and roles.
+
+For doing so you can use `use_allow_strategy!`, which changes the default strategy. In this case you should use `deny_role` to disable the access for a specific role or overwrite authorization strategy for specific actions with `authorize_with` helper.
+
+```ruby
+class MyController < ApplicationController
+  # By default allow access to any action within the controller by any role.
+  use_allow_strategy!
+
+  # In this case we're using the :allow strategy, so if we want to exclude a specific role
+  # we can do it by using #deny_role method.
+  deny_role :user
+  def index
+    # ... action code ...
+  end
+
+  # Check access by using a custom method
+  authorize_with :custom_autorization
+  def restricted_access_action
+    # ... action code ...
+  end
+
+  # Check access by using a block
+  authorize_with { current_user&.role == 'admin' }
+  def restricted_access_action2
+    # ... action code ...
+  end
+
+  private
+
+  # Specify a custom authorization logic (return `true` if successful and `false` when forbidden).
+  def custom_autorization
+    # ... custom authorization logic ...
+  end
+end
+```
+
+## Using `skip_guards`
+
+Sometime you may want to disable the `Guards` feature for specific actions. For doing so you can use the `skip_guards` helper, which allows you to specify the list of actions for which guards check have to be disabled. In the example below the access to `index` and `show` actions is granted by `skip_guards` which bypasses the guards check. `skip_guards` have priority over `permit_role`, `deny_role` and `authorize_with`, so using those helpers on actions with disabled guards will have no effect and the access will be granted anyway.
+
+```ruby
+class CustomController < ApplicationController
+  use_deny_strategy!
+  skip_guards :index, :show
+
+  def index
+    # ... action code ...
+  end
+
+  authorize_with { false } # this will be ignored because of `skip_guards`
+  def show
+    # ... action code ...
+  end
+end
+```
+
+You can also use `skip_guards` helper with `:except` key, which is useful when you need to disable
+guards for all the actions except a few:
+
+```ruby
+class CustomController < ApplicationController
+  # disable guards for :action_one and :action_two
+  skip_guards except: %i[action_one action_two]
+
+  # Guards DISABLED
+  def index
+    # ... action code ...
+  end
+
+  # Guards ENABLED
+  def action_one
+    # ... action code ...
+  end
+
+  # Guards ENABLED
+  def action_two
+    # ... action code ...
+  end
+
+  # Guards DISABLED
+  def action_three
+    # ... action code ...
+  end
+end
+```
+
+## `Pastore::Guards` features
+
+Below you can find the list of methods implemented by `Pastore::Guards`, that can be used inside
+your Rails Controller.
+
+| Method | Description |
+|--------|-------------|
+| `use_deny_strategy!` | Set to `deny` the default authorization strategy, which meands that by default the access to the actions will be denied |
+| `use_allow_strategy!` | Set to `allow` the default authorization strategy, which automatically authorizes the access to all the actions. **!!! WARNING !!!** Be careful when using `allow` strategy, because that way any user can access any action of your controller, including guest users if not filtered before. |
+| `detect_role(&block)` | Allows to specify the logic for user role detection. This block will be automatically called to get current user's role information. |
+| `permit_role(*roles)` | Specifies the roles that are allowed to access the action that follows. |
+| `deny_role(*roles)` | Specifies the roles that are not allowed to access the action that follows. |
+| <code>authorize_with(Symbol\|&block)</code> | Allows to specify a custom authorization logic to use for action access check. Accepts a method name or a block. |
+| <code>skip_guards(*Symbol\|*String, except: *Symbol\|*String)</code> | Allows to disable guards for specific actions. Accepts a list of actions for which to disable guards (e.g. `skip_guards :index, 'show'`), but can be also used to disable guards for all the actions except specified (e.g. `skip_guards except: :index`). |