lesli_vault 0.1.0 → 0.2.0

data/readme.md

@@ -1,19 +1,70 @@
 <p align="center">
-	<img width="100" alt="LesliBabel logo" src="app/assets/images/lesli_vault/vault-logo.svg" />
+	<img width="90" alt="LesliVault logo" src="./app/assets/images/lesli_vault/vault-logo.svg" />
+    <h3 align="center">Security Management Module for the Lesli Framework.</h3>
 </p>
 
-<h3 align="center">LesliVault</h3>
-
 <hr/>
+    <p align="center">
+        <a target="blank" href="https://rubygems.org/gems/lesli_vault">
+            <img src="https://badge.fury.io/rb/lesli_vault.svg" alt="Gem Version" height="24">
+        </a>
+    </p>
+<hr/>
+
+### Quick start
+
+```shell
+# Add LesliAdmin engine
+bundle add lesli_vault
+```
+
+```shell
+# Setup database
+rake lesli:db:setup
+```
+
+```ruby
+# Load LesliAdmin
+Rails.application.routes.draw do
+    mount LesliVault::Engine => "/vault"
+end
+```
+
+
+### Documentation
+* [database](./docs/database.md)
+* [documentation](https://www.lesli.dev/documentation/)
 
-Version 1
 
-### License  
-------
-Software developed in [Guatemala](http://visitguatemala.com/) by [LesliTech](https://www.lesli.tech) distributed under the *General Public License v 3.0* you can read the full license [here](http://www.gnu.org/licenses/gpl-3.0.html)
+### Get in touch
 
-<br>
+* [Website: https://www.lesli.tech](https://www.lesli.tech)
+* [Email: hello@lesli.tech](hello@lesli.tech)
+* [Twitter: @LesliTech](https://twitter.com/LesliTech)
+
+
+### License
+-------
+Copyright (c) 2023, Lesli Technologies, S. A.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see http://www.gnu.org/licenses/.
+
+<hr />
+<br />
 
 <p align="center">
-    <img alt="Lesli logo" width="100" src="./app/assets/images/lesli/brand/app-icon.svg" />
+    <img width="200" alt="Lesli logo" src="https://cdn.lesli.tech/lesli/brand/app-logo.svg" />
+    <h4 align="center">Ruby on Rails SaaS Development Framework.</h4>
 </p>
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lesli_vault
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - The Lesli Development Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
-description: Security management for The Lesli Framework
+description: Security Management Module for the Lesli Framework.
 email:
 - hello@lesli.tech
 executables: []
@@ -49,8 +49,6 @@ files:
 - app/controllers/lesli_vault/role/descriptors_controller.rb
 - app/controllers/lesli_vault/role/privileges_controller.rb
 - app/controllers/lesli_vault/roles_controller.rb
-- app/controllers/lesli_vault/system_controller/actions_controller.rb
-- app/controllers/lesli_vault/system_controllers_controller.rb
 - app/helpers/lesli_vault/application_helper.rb
 - app/helpers/lesli_vault/dashboards_helper.rb
 - app/helpers/lesli_vault/descriptor/activities_helper.rb
@@ -60,8 +58,6 @@ files:
 - app/helpers/lesli_vault/role/descriptors_helper.rb
 - app/helpers/lesli_vault/role/privileges_helper.rb
 - app/helpers/lesli_vault/roles_helper.rb
-- app/helpers/lesli_vault/system_controller/actions_helper.rb
-- app/helpers/lesli_vault/system_controllers_helper.rb
 - app/jobs/lesli_vault/application_job.rb
 - app/mailers/lesli_vault/application_mailer.rb
 - app/models/lesli_vault/application_record.rb
@@ -72,13 +68,8 @@ files:
 - app/models/lesli_vault/role/activity.rb
 - app/models/lesli_vault/role/descriptor.rb
 - app/models/lesli_vault/role/privilege.rb
-- app/models/lesli_vault/system_controller.rb
-- app/models/lesli_vault/system_controller/action.rb
-- app/services/application_lesli_services.rb
-- app/services/descriptor_services.rb
-- app/services/role_services.rb
-- app/services/system_controller_services.rb
-- app/views/layouts/lesli_vault/application.html.erb
+- app/services/lesli_vault/descriptor_service.rb
+- app/services/lesli_vault/role_service.rb
 - app/views/lesli_vault/dashboards/show.html.erb
 - app/views/lesli_vault/descriptor/activities/_form.html.erb
 - app/views/lesli_vault/descriptor/activities/edit.html.erb
@@ -95,6 +86,7 @@ files:
 - app/views/lesli_vault/descriptors/index.html.erb
 - app/views/lesli_vault/descriptors/new.html.erb
 - app/views/lesli_vault/descriptors/show.html.erb
+- app/views/lesli_vault/partials/_engine-navigation.html.erb
 - app/views/lesli_vault/role/activities/_form.html.erb
 - app/views/lesli_vault/role/activities/edit.html.erb
 - app/views/lesli_vault/role/activities/index.html.erb
@@ -114,51 +106,39 @@ files:
 - app/views/lesli_vault/roles/index.html.erb
 - app/views/lesli_vault/roles/new.html.erb
 - app/views/lesli_vault/roles/show.html.erb
-- app/views/lesli_vault/system_controller/actions/_form.html.erb
-- app/views/lesli_vault/system_controller/actions/edit.html.erb
-- app/views/lesli_vault/system_controller/actions/index.html.erb
-- app/views/lesli_vault/system_controller/actions/new.html.erb
-- app/views/lesli_vault/system_controller/actions/show.html.erb
-- app/views/lesli_vault/system_controllers/_form.html.erb
-- app/views/lesli_vault/system_controllers/edit.html.erb
-- app/views/lesli_vault/system_controllers/index.html.erb
-- app/views/lesli_vault/system_controllers/new.html.erb
-- app/views/lesli_vault/system_controllers/show.html.erb
-- app/vue/lesli_vault/application.js
-- app/vue/lesli_vault/apps/descriptors/components/form.vue
-- app/vue/lesli_vault/apps/descriptors/edit.vue
-- app/vue/lesli_vault/apps/descriptors/index.vue
-- app/vue/lesli_vault/apps/descriptors/new.vue
-- app/vue/lesli_vault/apps/descriptors/privileges.vue
-- app/vue/lesli_vault/apps/descriptors/show.vue
-- app/vue/lesli_vault/apps/roles/componentForm.vue
-- app/vue/lesli_vault/apps/roles/componentPrivilegeCustom.vue
-- app/vue/lesli_vault/apps/roles/componentPrivilegeStandard.vue
-- app/vue/lesli_vault/apps/roles/edit.vue
-- app/vue/lesli_vault/apps/roles/index.vue
-- app/vue/lesli_vault/apps/roles/logs.vue
-- app/vue/lesli_vault/apps/roles/new.vue
-- app/vue/lesli_vault/apps/roles/show.vue
-- app/vue/lesli_vault/apps/security/index.vue
-- app/vue/lesli_vault/stores/descriptor.js
-- app/vue/lesli_vault/stores/descriptors.js
-- app/vue/lesli_vault/stores/role.js
-- app/vue/lesli_vault/stores/roles.js
-- app/vue/lesli_vault/stores/systemController.js
 - config/routes.rb
 - lib/lesli_vault.rb
 - lib/lesli_vault/engine.rb
 - lib/lesli_vault/version.rb
 - lib/tasks/lesli_vault_tasks.rake
-- lib/tasks/system/controllers.rake
 - lib/vue/application.js
+- lib/vue/apps/descriptors/components/form.vue
+- lib/vue/apps/descriptors/edit.vue
+- lib/vue/apps/descriptors/index.vue
+- lib/vue/apps/descriptors/new.vue
+- lib/vue/apps/descriptors/privileges.vue
+- lib/vue/apps/descriptors/show.vue
+- lib/vue/apps/roles/componentForm.vue
+- lib/vue/apps/roles/componentPrivilegeCustom.vue
+- lib/vue/apps/roles/componentPrivilegeStandard.vue
+- lib/vue/apps/roles/edit.vue
+- lib/vue/apps/roles/index.vue
+- lib/vue/apps/roles/logs.vue
+- lib/vue/apps/roles/new.vue
+- lib/vue/apps/roles/show.vue
+- lib/vue/stores/descriptor.js
+- lib/vue/stores/descriptors.js
+- lib/vue/stores/role.js
+- lib/vue/stores/roles.js
+- license
 - readme.md
 homepage: https://www.lesli.dev/
-licenses: []
+licenses:
+- GPL-3.0
 metadata:
   homepage_uri: https://www.lesli.dev/
-  source_code_uri: https://github.com/LesliTech/LesliVault
   changelog_uri: https://github.com/LesliTech/LesliVault
+  source_code_uri: https://github.com/LesliTech/LesliVault
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -177,5 +157,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Security management for The Lesli Framework
+summary: Security Management Module for the Lesli Framework.
 test_files: []

data/app/controllers/lesli_vault/system_controller/actions_controller.rb

@@ -1,112 +0,0 @@
-=begin
-
-Lesli
-
-Copyright (c) 2023, Lesli Technologies, S. A.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see http://www.gnu.org/licenses/.
-
-Lesli · Ruby on Rails SaaS development platform.
-
-Made with ♥ by https://www.lesli.tech
-Building a better future, one line of code at a time.
-
-@contact  hello@lesli.tech
-@website  https://www.lesli.tech
-@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
-
-// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
-// · 
-
-=end
-
-module LesliVault
-    class SystemController::ActionsController < ApplicationController
-        before_action :set_system_controllers_action, only: %i[ show update destroy ]
-
-        # GET /system_controllers/actions
-        def index
-            respond_to do |format|
-                format.html {}
-                format.json do
-                    respond_with_successful(SystemControllers::Action.index(current_user, @query))
-                end
-            end
-        end
-
-        # GET /system_controllers/actions/1
-        def show
-            respond_to do |format|
-                format.html {}
-                format.json do
-                    return respond_with_not_found unless @system_controllers_action
-                    return respond_with_successful(@system_controllers_action.show(current_user, @query))
-                end
-            end
-        end
-
-        # GET /system_controllers/actions/new
-        def new
-        end
-
-        # GET /system_controllers/actions/1/edit
-        def edit
-        end
-
-        # POST /system_controllers/actions
-        def create
-            system_controllers_action = SystemControllers::Action.new(system_controllers_action_params)
-            if system_controllers_action.save
-                respond_with_successful(system_controllers_action)
-            else
-                respond_with_error(system_controllers_action.errors.full_messages.to_sentence)
-            end
-        end
-
-        # PATCH/PUT /system_controllers/actions/1
-        def update
-            return respond_with_not_found unless @system_controllers_action
-
-            if @system_controllers_action.update(system_controllers_action_params)
-                respond_with_successful(@system_controllers_action.show(current_user, @query))
-            else
-                respond_with_error(@system_controllers_action.errors.full_messages.to_sentence)
-            end
-        end
-
-        # DELETE /system_controllers/actions/1
-        def destroy
-            return respond_with_not_found unless @system_controllers_action
-
-            if @system_controllers_action.destroy
-                respond_with_successful
-            else
-                respond_with_error(@system_controllers_action.errors.full_messages.to_sentence)
-            end
-        end
-
-        private
-
-        # Use callbacks to share common setup or constraints between actions.
-        def set_system_controllers_action
-            @system_controllers_action = current_user.account.system_controllers_actions.find(class_name, params[:id])
-        end
-
-        # Only allow a list of trusted parameters through.
-        def system_controllers_action_params
-            params.require(:system_controllers_action).permit(:id, :name)
-        end
-
-    end
-end

data/app/controllers/lesli_vault/system_controllers_controller.rb

@@ -1,64 +0,0 @@
-=begin
-
-Lesli
-
-Copyright (c) 2023, Lesli Technologies, S. A.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see http://www.gnu.org/licenses/.
-
-Lesli · Ruby on Rails SaaS development platform.
-
-Made with ♥ by https://www.lesli.tech
-Building a better future, one line of code at a time.
-
-@contact  hello@lesli.tech
-@website  https://www.lesli.tech
-@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
-
-// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
-// · 
-
-=end
-
-module LesliVault
-    class SystemControllersController < ApplicationController
-        before_action :set_system_controller, only: %i[ show update destroy ]
-
-        # GET /system_controllers
-        def index
-            respond_to do |format|
-                format.html {}
-                format.json do
-                    respond_with_successful(SystemControllerServices.new(current_user).index)
-                end
-            end
-        end
-
-        def options 
-            respond_to do |format|
-                format.html {}
-                format.json do
-                    respond_with_successful(SystemControllerServices.new(current_user).options)
-                end
-            end
-        end 
-
-        private
-
-        # Only allow a list of trusted parameters through.
-        def system_controller_params
-            []
-        end
-    end
-end

data/app/helpers/lesli_vault/system_controller/actions_helper.rb

@@ -1,4 +0,0 @@
-module LesliVault
-  module SystemController::ActionsHelper
-  end
-end

data/app/helpers/lesli_vault/system_controllers_helper.rb

@@ -1,4 +0,0 @@
-module LesliVault
-  module SystemControllersHelper
-  end
-end

data/app/models/lesli_vault/system_controller/action.rb

@@ -1,39 +0,0 @@
-=begin
-
-Lesli
-
-Copyright (c) 2023, Lesli Technologies, S. A.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see http://www.gnu.org/licenses/.
-
-Lesli · Ruby on Rails SaaS development platform.
-
-Made with ♥ by https://www.lesli.tech
-Building a better future, one line of code at a time.
-
-@contact  hello@lesli.tech
-@website  https://www.lesli.tech
-@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
-
-// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
-// · 
-
-=end
-module LesliVault
-    class SystemController::Action < ApplicationRecord
-
-        belongs_to :system_controller
-
-    end
-end

data/app/services/application_lesli_services.rb

@@ -1,168 +0,0 @@
-=begin
-
-Lesli
-
-Copyright (c) 2023, Lesli Technologies, S. A.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see http://www.gnu.org/licenses/.
-
-Lesli · Ruby on Rails SaaS development platform.
-
-Made with ♥ by https://www.lesli.tech
-Building a better future, one line of code at a time.
-
-@contact  hello@lesli.tech
-@website  https://www.lesli.tech
-@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
-
-// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
-// · 
-
-=end
-
-# ·  IMPORTANT: THIS SERVICES SHOULD COME FROM LESLI, ONCE IT'S READY
-module LesliVault
-    class ApplicationLesliServices
-
-
-        # Set container attributes to manage the life-cycle of the service
-        @query;
-        @resource;
-        @failures;
-        @current_user;
-
-
-        # Service constructor
-        # current_user is always required to initialize a service object
-        # current user is used to get the data only from the account context
-        def initialize current_user, query={}
-
-            # make the current user globaly available in the service object
-            @current_user = current_user
-
-            # stores the resources from the database as result of the active record queries
-            @resource = nil
-
-            # stores any error found during the life-cycle of the service object
-            @failures = []
-
-            # standard conditions to query the database
-            @query = query
-        end
-
-
-        # Find an specific resource through the main id
-        def find resource = nil
-            # Look for the resource in the database
-            # self.resource = current_user.account.users.find_by_id(id) # example
-
-            # Should always return self
-            self.resource = resource if resource
-            self
-        end
-
-
-        # Standard method to list data from the database
-        def list params=nil
-        end
-
-
-        # Standard method to index data from the database
-        def index params=nil
-        end
-
-
-        # Standard method to show data from the database
-        def show
-        end
-
-
-        # Standard method to create new resource into the database
-        def create resource
-            # Example:
-            # user = current_user.account.users.new(params)
-
-            # if user.save
-            #     self.resource = user
-            # else
-            #     self.error(user.errors.full_messages.to_sentence)
-            # end
-
-            self.resource = resource if resource
-            self
-        end
-
-
-        # Standard method to update resources into the database
-        def update params
-        end
-
-
-        # Standard method to delete data from the database
-        def delete
-        end
-
-
-        # Method to check if the service object has data available
-        # this method ment to be used together and after the find method
-        def found?
-            !self.resource.blank?
-        end
-
-
-        # Check if the service object has errors
-        def successful?
-            self.failures.empty?
-        end
-
-
-        # Get the list of erros
-        def errors
-            self.failures
-        end
-
-
-        # Get the list of erros as single string
-        def errors_as_sentence
-            self.failures.to_sentence
-        end
-
-
-        # Register a new error for the current service object
-        def error error
-            self.failures.push(error)
-        end
-
-
-        # Return the resource as a result
-        def result
-            self.resource
-        end
-
-        private
-
-        attr_reader :current_user
-
-        attr_reader :resource
-        attr_writer :resource
-
-        attr_reader :successful
-        attr_writer :successful
-
-        attr_reader :failures
-        attr_writer :failures
-
-        attr_reader :query
-    end
-end