lesli_shield 1.1.3 → 1.1.5

data/readme.md

@@ -1,14 +1,15 @@
 <div align="center">
-    <img width="100" alt="LesliShield logo" src="./app/assets/images/lesli_shield/shield-logo.svg" />
-    <h3 align="center">Users & Security Management for the Lesli Framework.</h3>
+    <h1 align="center">
+        <img width="100" alt="LesliShield" src="./app/assets/images/lesli_shield/shield-logo.svg" />
+    </h1>
+    <h3 align="center">Authentication and authorization for the Lesli Framework.</h3>
 </div>
 
 <br />
-<hr/>
 
 <div align="center">
-    <a target="_blank" href="https://github.com/LesliTech/LesliShield/actions">
-        <img alt="Tests passing" src="https://img.shields.io/badge/Tests-passing-green?style=for-the-badge&logo=github">
+    <a target="_blank" href="https://github.com/LesliTech/LesliShield/actions/workflows/lesli-ci-tests.yaml">
+        <img alt="LesliShield test status" src="https://img.shields.io/github/actions/workflow/status/LesliTech/LesliShield/lesli-ci-tests.yaml?branch=master&style=for-the-badge&logo=github&label=tests">
     </a>
     <a target="_blank" href="https://rubygems.org/gems/lesli_shield">
         <img alt="Gem Version" src="https://img.shields.io/gem/v/lesli_shield?style=for-the-badge&logo=ruby">
@@ -16,84 +17,148 @@
     <a target="_blank" href="https://codecov.io/github/LesliTech/LesliShield">
         <img alt="Codecov" src="https://img.shields.io/codecov/c/github/LesliTech/LesliShield?style=for-the-badge&logo=codecov">
     </a>
+    <a target="_blank" href="https://sonarcloud.io/project/overview?id=LesliTech_LesliShield">
+        <img alt="Sonar Quality Gate" src="https://img.shields.io/sonar/quality_gate/LesliTech_LesliShield?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=Quality">
+    </a>
 </div>
 
-<hr/>
 <br />
 
 <div align="center">
     <img
         style="width:100%;max-width:800px;border-radius:6px;"
-        alt="Lesli screenshot" src="./docs/images/screenshot.png" />
+        alt="LesliShield security administration"
+        src="./docs/images/screenshot.png" />
 </div>
 
+---
+
+<br />
+
+## Introduction
+
+LesliShield is the official authentication and authorization engine for the [Lesli Framework](https://github.com/LesliTech/Lesli).
+
+It centralizes account security, role-based access control, and user onboarding for Lesli applications.
+
 <br />
-<hr/>
+
+## Features
+
+- Authentication and session management
+- Role-based access control
+- Permission and privilege administration
+- Account-scoped security policies
+- User invitations and onboarding
+
 <br />
 
-### Installation
+## Try LesliShield
 
-```ruby
+- [Try the online demo](https://demo.lesli.dev/)
+- [Run the Docker demo](https://github.com/LesliTech/lesli-docker-demo)
 
-# Add LesliShield engine gem
+<br />
+
+## Quick Start
+
+### Requirements
+
+- A Rails application with [Lesli](https://rubygems.org/gems/lesli)
+- SQLite by default, or PostgreSQL when preferred by the host application
+
+### Install LesliShield
+
+Add the engine to the host Rails application and prepare its database:
+
+```shell
 bundle add lesli_shield
+bin/rails db:prepare
+```
+
+### Mount the engine
 
+Applications using Lesli's standard router mount LesliShield automatically at `/shield`:
 
-# Setup & initialize the database
-rake lesli:db:setup
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+    Lesli::Router.mount(self)
+end
+```
 
+If the application does not use the standard Lesli router, mount the engine directly:
 
-# Load LesliShield engine
+```ruby
+# config/routes.rb
 Rails.application.routes.draw do
     mount LesliShield::Engine => "/shield"
 end
 ```
 
-<br />
-<hr />
+Start Rails and visit [http://127.0.0.1:3000/shield](http://127.0.0.1:3000/shield):
+
+```shell
+bin/rails server
+```
+
 <br />
 
-### Development 
+## Development
+
+Clone LesliShield into the host application's `engines` directory:
+
+```shell
+cd RailsApp
+mkdir -p engines
+git clone https://github.com/LesliTech/LesliShield.git engines/LesliShield
+```
+
+Reference the local engine from the host application's `Gemfile`:
 
 ```ruby
-# clone the lesli repo inside your engine folder: RailsApp/engines
-git clone https://github.com/LesliTech/LesliShield.git
+gem "lesli_shield", path: "engines/LesliShield"
+```
 
-# Load LesliShield as a Gem
-gem "lesli", path: "engines/LesliShield"
+Install dependencies, prepare the host database, and start Rails:
 
-# Install the necessary Gems to run LesliShield
+```shell
 bundle install
+bin/rails db:prepare
+bin/rails server
+```
 
-# Setup & initialize the database
-rake lesli:db:setup
+### Tests
 
+From a complete Lesli development workspace, run the engine test suite from the LesliShield directory:
+
+```shell
+cd engines/LesliShield
+bin/rails test
 ```
 
 <br />
-<hr />
-<br />
-
-### Demo
 
-* [online demo](https://demo.lesli.dev/)
-* [docker demo](https://github.com/LesliTech/lesli-docker-demo)
+## Documentation
 
+- [Lesli website](https://www.lesli.dev/)
+- [Documentation](https://www.lesli.dev/engines/shield)
+- [Release notes](https://github.com/LesliTech/LesliShield/releases)
+- [Issue tracker](https://github.com/LesliTech/LesliShield/issues)
+- [Source code](https://github.com/LesliTech/LesliShield)
 
-### Documentation
-* [website](https://www.lesli.dev/)
-* [documentation](https://www.lesli.dev/engines/shield)
+<br />
 
+## Community
 
-### Connect with Lesli
+- [X: @LesliTech](https://x.com/LesliTech)
+- [hello@lesli.tech](mailto:hello@lesli.tech)
+- [https://www.lesli.tech](https://www.lesli.tech)
 
-* [@LesliTech](https://x.com/LesliTech)
-* [hello@lesli.tech](hello@lesli.tech)
-* [https://www.lesli.tech](https://www.lesli.tech)
+<br />
 
+## License
 
-### License
--------
 Copyright (c) 2026, Lesli Technologies, S. A.
 
 This program is free software: you can redistribute it and/or modify
@@ -107,18 +172,16 @@ 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/.
+along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
 
-<hr />
-<br />
-<br />
+The complete license text is available in the [license file](./license).
 
-<div align="center" class="has-text-centered">
-    <img width="200" alt="Lesli logo" src="https://cdn.lesli.tech/lesli/brand/app-logo.svg" />
-    <h3 align="center" class="mt-0">
-        The Open-Source SaaS Development Framework for Ruby on Rails.
-    </h3>
-</div>
+---
 
 <br />
 <br />
+
+<div align="center">
+    <img width="80" alt="Lesli icon" src="https://cdn.lesli.tech/lesli/brand/app-icon.svg" />
+    <h3 align="center">The Open-Source SaaS Development Framework for Ruby on Rails.</h3>
+</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lesli_shield
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - The Lesli Development Team
@@ -43,11 +43,13 @@ files:
 - app/assets/javascripts/lesli_shield/registrations.js
 - app/assets/javascripts/lesli_shield/sessions.js
 - app/assets/stylesheets/lesli_shield/application.css
+- app/assets/stylesheets/lesli_shield/application.tailwind.css
 - app/assets/stylesheets/lesli_shield/confirmations.css
 - app/assets/stylesheets/lesli_shield/devise/oauth.css
 - app/assets/stylesheets/lesli_shield/passwords.css
 - app/assets/stylesheets/lesli_shield/registrations.css
 - app/assets/stylesheets/lesli_shield/sessions.css
+- app/assets/stylesheets/lesli_shield/sessions.tailwind.css
 - app/assets/stylesheets/lesli_shield/users.css
 - app/controllers/lesli_shield/application_controller.rb
 - app/controllers/lesli_shield/dashboards_controller.rb
@@ -163,9 +165,6 @@ files:
 - config/initializers/devise.rb
 - config/locales/translations.en.yml
 - config/locales/translations.es.yml
-- config/locales/translations.fr.yml
-- config/locales/translations.it.yml
-- config/locales/translations.pt.yml
 - config/routes.rb
 - db/migrate/v1/0801000110_create_lesli_shield_accounts.rb
 - db/migrate/v1/0801100210_create_lesli_shield_role_actions.rb

data/config/locales/translations.fr.yml

@@ -1,2 +0,0 @@
----
-:fr: {}

data/config/locales/translations.it.yml

@@ -1,5 +0,0 @@
----
-:it:
-  lesli_shield:
-    devise/sessions:
-      message_not_valid_credentials: ":lesli_shield.devise/sessions.message_not_valid_credentials:"

data/config/locales/translations.pt.yml

@@ -1,2 +0,0 @@
----
-:pt: {}