rbac_rls 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ec44866c989046890add9f57eafc781f16a3774e54858a5f4996498fa2e96cb
-  data.tar.gz: 1f349e1e5e4011768758345c95349984b0910d33f1652245225217fd7133a83f
+  metadata.gz: 27a062559ce3ed39a8354ebde354c8d7977d14e9b1d9863e982987019bf7be4d
+  data.tar.gz: 3e7a744ca0cac8908a708685a3c198b0ec8d1608100445ad9712f30c15a5c228
 SHA512:
-  metadata.gz: 86ab0f00de6b4291edbdc4bfb3a8b18a9430af2bd9b3043de979731c9209314be6ba05ac5f8d58f10242957c67947203addc5c8c96d428c9960618af105e8043
-  data.tar.gz: 43438f64d3cc5ba86face84828579bc9556e5e81cf0731f0c2aba6edc04abf0cb7f877340934c1e4c86cf5c50055a184e1c6e2b4736801ec1148df60f7b2d1f6
+  metadata.gz: 27559ee87603c01c7aed6426dfaefb81ee7ffdc3c36aa59116da0195c8e6555b7cce360173e5be35331ebbedbbb8d338758d53ccefda29f6a6b82ce1646887f2
+  data.tar.gz: 6a2fd3df7b7ed6447acc1c8c99925f51bf71a3ad1bbca8d06196ae075c3cfd0de797104f428a1b860da5cbe723b5bf27ca0fa59f72bbc0ee86051d3782b3a8db

data/README.md

@@ -1,66 +1,121 @@
 # RbacRls
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+Esta biblioteca tem por finalidade prover a funcionalidade de controle de acesso granular aos
+dados, contribuindo para a segurança através de verificações de acesso a informação. Este
+modelo tem como base os conceitos do recurso de controle de acesso RBAC(Role-Based
+Access Control ) aplicados juntamente aos métodos de RLS(Row-Level Security).
 
-## Installation
-Add this line to your application's Gemfile:
+O framework proposto tem por objetivo facilitar a implantação da funcionalidade
+de segurança, auxiliando o programador na implementação das políticas de restrições no
+banco de dados.
+
+## RLS:
+
+    A segurança em nível de linha permite que você use um contexto de execução para controlar o acesso a 
+    linhas em uma tabela de banco de dados, simplificando o design e a codificação de 
+    segurança da sua aplicação.
+
+## RBAC:
+
+    O controle de acesso baseado em função (RBAC) é um modelo de restrição de que tem como base as funções de usuários
+    individuais em um contexto hierárquico. O RBAC garante que os usuários acessem apenas as informações de que precisam
+    para realizar suas rotina  e os impede de acessar informações que não pertencem a eles.
+
+# Como utilizar esta Gem ?.
+
+### Instalação:
+
+Adicione esta linha no arquivo da sua aplicação Gemfile
 
 ```ruby
 gem "rbac_rls"
 ```
 
-And then execute:
+E então execute o seguinte comando:
+
 ```bash
 $ bundle
 ```
 
-Or install it yourself as:
+Ou Instale você mesmo manualmente com o comando abaixo :
+
 ```bash
 $ gem install rbac_rls
 ```
-And then add in your manifest.js:
-```bash 
+
+Adicione no seu arquivo manifest.js:
+
+```javascript
 //= link rbac_rls/application.css
 //= link rbac_rls/application.js
 ```
-And then add in your application_record.rb and application_controller.rb:
-```bash 
- include ConnectionRls
- include ConnectionRlsUser
+
+##### Adicione no seu arquivo application_record.rb:
+
+```ruby
+#Em application_record.rb
+include ConnectionRlsConcern
 ```
+
+##### Adicione no seu arquivo application_controller.rb:
+
+```ruby
+#Em application_controller.rb" 
+include ConnectionRlsUserConcern
+```
+
 ```bash 
- crie um novo everioniment para rodar as migrations 
- por exemplo: duplique um arquivo de  app/config/environments  configure o deu database.yml com o env 
+    Para fazer o uso desta biblioteca é necessário que a aplicação principal, acesse o banco de dados apartir de um 
+    usuário que não é o dono do banco de dados pois, as regras de Segurança em nivél de linha não podem ser aplicadas a
+    este tipo de usuário do banco de dados.
+Então: apenas para casos onde seja necessario rodar migrates como administrador utilize um novo Environment ou um método 
+diferente de conexão com o banco que não seja como da aplicação principal
+ Por exemplo: 
+ a aplicação por padrão utilizará um usuário "app_user" para suas consultas.
+ para rodar as migrates da aplicação o usuário padrão será "data_base_admin"
+ logo no environment "development" o usuário do banco de dados será :app_user
+ e no  environment "migrations" o usuário do banco de dados será :data_base_admin
  
- exemplo:
-     -----------
-     migrations:
-      <<: *default
-      database: main_app_development
-      username: username
-      password: password
-     -----------
+ Passos para criar um environment :
+ 1º  duplique um arquivo de  app/config/environments
+ 2º  configure o deu database.yml como no exemplo abaixo: 
+     exemplo:
+         -----------
+         migrations:
+          <<: *default
+          database: main_app_development
+          username: username
+          password: password
+         -----------
+  3º para rodar as migrates usando este environment use um comando análogo a "rake db:migrate RAILS_ENV=migrations"
+  
 ```
 
-And then run this command:
+Logo após estes passos, na linha de comando execute:
+
 ```bash
 rake rbac_rls:install:migrations  
 ```
 
-And then run this command:
-```bash
-rake db:migrate  
+##### Adicione na sua aplicação em config/routes.rb
+
+```ruby
+# Em config/routes.rb adicione 
+mount RbacRls::Engine => :rbac_rls
 ```
-And then run this command:
+
+Execute na linha de comando:
+
 ```bash
-yarn  install  
+rake db:migrate
+
+yarn  install    
 ```
 
+### após isso a bibilioteca está instalada, e pode ser acessada em /rbac_rls
 
-## Contributing
-Contribution directions go here.
+[//]: # (## Contributing)
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/concerns/manage_rls_migration_concern.rb

@@ -11,7 +11,7 @@ module ManageRlsMigrationConcern
   end
 
   def down_migrate(file_version = migration_version)
-    return true if system(Settings.down_migrate_command(file_version))
+    return true if system(RbacRls::Settings.down_migrate_command(file_version))
     false
   end
 

data/app/models/rbac_rls/group_permission.rb

@@ -15,7 +15,7 @@ module RbacRls
         migraion_generated = system(cmd.===) if new_record?
         migraion_generated = system(cmd.===) if persisted? and database_changed? and drop_policy()
         if migraion_generated
-          system(Settings.run_migrate_command)
+          system(RbacRls::Settings.run_migrate_command)
           self.migration_version = ActiveRecord::Migrator.current_version
         end
       end

data/app/models/rbac_rls/permission.rb

@@ -44,7 +44,7 @@ class RbacRls::Permission < ApplicationRecord
 
     if RbacRls::Permission.all.map(&:table_name).exclude?(table_name) && migration_version.nil?
       cmd = "rails generate rbac_rls:custom_migration  #{table_name}  #{type_policies.===} #{type_options.===}"
-      if system(cmd) && system(Settings.run_migrate_command)
+      if system(cmd) && system(RbacRls::Settings.run_migrate_command)
         self.migration_version = ActiveRecord::Migrator.current_version
       end
     end

data/lib/rbac_rls/version.rb

@@ -1,3 +1,3 @@
 module RbacRls
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbac_rls
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - FilipeBeserraMaia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails