lesli 5.0.0

data/app/controllers/users/sessions_controller.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+=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 Framework.
+
+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
+
+class Users::SessionsController < Devise::SessionsController
+
+    # Creates a new session for the user and allows them access to the platform
+    def create
+
+        # search for a existing user 
+        user = Lesli::User.find_for_database_authentication(email: sign_in_params[:email])
+
+        # respond with a no valid credentials generic error if not valid user found
+        unless user
+            # Lesli::Account::Activity.log("core", "/session/create", "session_creation_failed", "no_valid_email", {
+            #     email: (sign_in_params[:email] || "")
+            # }) 
+            return respond_with_error(I18n.t("core.users/sessions.invalid_credentials"))
+        end
+
+        # save a invalid credentials log for the requested user
+        log = user.logs.new({ title: "session_creation_atempt" })
+
+        # check password validation
+        unless user.valid_password?(sign_in_params[:password])
+
+            # save a invalid credentials log for the requested user
+            log.update({
+                title: "session_creation_failed",
+                description: "invalid_credentials"
+            })
+
+            # respond with a no valid credentials generic error if not valid user found
+            return respond_with_error(I18n.t("core.users/sessions.invalid_credentials"))
+
+        end
+
+        # check if user meet requirements to create a new session
+        Lesli::UsersValidator.new(user).valid? do |valid, failures|
+
+            # if user do not meet requirements to login
+            unless valid
+
+                log.update({
+                    title: "session_creation_failed",
+                    description: failures.join(", ")
+                })
+
+                # return and respond with the reasons user is not able to login
+                return respond_with_error(failures.join(", "))
+
+            end
+
+        end
+
+
+        # remember the user (not enabled by default)
+        # remember_me(user) if sign_in_params[:remember_me] == '1'
+
+
+        # create a new session for the user
+        current_session = Lesli::User::SessionService.new(user).create(get_user_agent, request.remote_ip)
+
+        # make session id globally available
+        session[:user_session_id] = current_session[:id]
+
+        # create a new multi factor authentication service instance for the current user 
+        #mfa_service = User::MfaService.new(user, log)
+
+        # generate a new mfa for the current session (if enabled)
+        #mfa_service.generate do |success|
+            # mfa was successfully generated, return the user to the mfa page
+            # return respond_with_successful({ default_path: "mfa" }) if success
+        #end 
+
+        # do a user login
+        sign_in(:user, user)
+
+        # respond successful and send the path user should go
+        #respond_with_successful({ default_path: user.has_role_with_default_path?() })
+        respond_with_successful({ default_path: "/" })
+
+        log_user_agent()
+
+    end
+
+    private 
+
+    # @return [Parameters] Allowed parameters for the discussion
+    # @description Sanitizes the parameters received from an HTTP call to only allow the specified ones.
+    #     Allowed params are _:email_, _:password_.
+    # @example
+    #     supose params contains {
+    #         "user": {
+    #             "id": 5,
+    #             "email": "john.smith@email.com",
+    #             "password": "my_password_123"
+    #         }
+    #     }
+    #     allowed_params = sign_in_params
+    #     puts allowed_params
+    #     will remove the _id_ field and only print {
+    #         "user": {
+    #             "email": "john.smith@email.com",
+    #             "password": "my_password_123"
+    #         }
+    #     }
+    def sign_in_params
+        params.fetch(:user, {}).permit(:email, :password)
+    end
+
+end

data/app/controllers/users/unlocks_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Users::UnlocksController < Devise::UnlocksController
+  # GET /resource/unlock/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/unlock
+  # def create
+  #   super
+  # end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after sending unlock password instructions
+  # def after_sending_unlock_instructions_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after unlocking the resource
+  # def after_unlock_path_for(resource)
+  #   super(resource)
+  # end
+end

data/app/helpers/lesli/assets_helper.rb

@@ -0,0 +1,92 @@
+=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 Framework.
+
+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.dev
+@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// ·
+=end
+
+module Lesli
+    module AssetsHelper
+        # Return a string path to load the template stylesheet
+        # by default we always return the latest version of the template
+        # lesli_application_stylesheet_path()               -> stylesheet from main app
+        # lesli_application_stylesheet_path(:lesli)         -> stylesheet from Lesli
+        # lesli_application_stylesheet_path(:engine) (TODO) -> stylesheet from engine current
+        # lesli_application_stylesheet_path(:cloud_driver)  -> stylesheet from engine specific
+        def lesli_application_stylesheet_path(engine = nil)
+            return "#{engine}/templates/application" if engine
+
+            "#{lesli_engine(:code)}/application"
+        end
+
+        # Return a string path to load the main engine stylesheet
+        def application_stylesheet_engine_path
+            cloud_module = lesli_engine(:code)
+            return "administration/application" if is_lesli_administration?
+            return "onboardings/application" if is_lesli_onboarding?
+
+            "#{cloud_module}/application"
+        end
+
+        # Return a string path to load the main javascript app of the engine
+        def lesli_application_javascript_path
+            # get the namespace to load specific javascript file
+            # for engine or specific javascript file for core controller
+            path_segments = controller_path.split("/")
+            cloud_module = path_segments.shift
+
+            return "onboardings/application" if is_lesli_onboarding?
+
+            "#{cloud_module}/application"
+        end
+
+        def javascript_googlemaps_sdk
+            "<script type=\"application/javascript\" src=\"https://maps.googleapis.com/maps/api/js?key=#{Rails.application.credentials.dig(
+                :providers, :google, :maps_sdk_token
+            )}\"></script>".html_safe
+        end
+
+        def javascript_apple_mapkit_js
+            token = Rails.application.credentials.dig(:providers, :apple, :mapkit_token)
+
+            "<script type=\"application/javascript\" src=\"https://cdn.apple-mapkit.com/mk/5.45.0/mapkit.js\"></script>
+            <script type=\"application/javascript\">
+                const ampkt = \"#{token}\"
+            </script>".html_safe
+        end
+
+        def favicon
+            icon_path = customization_instance_logo_url(logo: "favicon")
+            "
+            <link href=\"#{icon_path}\" rel=\"alternate icon\">
+            <link href=\"#{icon_path}\" rel=\"icon\" type=\"image/svg+xml\">
+            <link href=\"#{icon_path}\" rel=\"mask-icon\" color=\"#ff8a01\">
+            ".html_safe
+        end
+    end
+end

data/app/helpers/lesli/customization_helper.rb

@@ -0,0 +1,84 @@
+=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 · Your Smart Business Assistant.
+
+Made with ♥ by https://www.lesli.tech
+Building a better future, one line of code at a time.
+
+@contact  hello@lesli.tech
+@website  https://lesli.tech
+@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// ·
+=end
+
+module Lesli
+    module CustomizationHelper
+        # @returns [String] A string representing an HTML import of the logo of the company.
+        # @param mode [String] Either "web" or "pdf". This param decides wether the image_tag will be for a web view, or a pdf view
+        # @param options [Hash] Any valid "image_tag" option you want to add (like width, alt, etc)
+        # @descriptions Generates an image tag link so you can use on your web or pdf HTML. If the custom logo is configured, that path is
+        #     returned. Otherwise, the default lesli logo stored in assets/lesli_instance/brand/ will be used
+        # @example
+        #     # Using this from a erb view.
+        #     <div class="image">
+        #         <%= customization_instance_logo(options: { alt: "#{@company.company_name}", width: "100" })%>
+        #     </div>
+        def customization_instance_logo(tag: false, logo: "app-logo", variant: "light", mode: "web",
+                                        options: { alt: "Logo" })
+            # loading logo from builder assets
+            logo_path = "#{lesli_instance_code}/brand/#{logo}.svg"
+
+            # load favicon as PNG for better compatibility between web browsers
+            logo_path = "#{lesli_instance_code}/brand/#{logo}.png" if logo == "favicon"
+
+            # loading logo from core, only if builder engine was not installed
+            logo_path = "lesli/brand/#{logo}.svg" if lesli_instance_code == "lesli"
+
+            # custom logo from settings
+            logo_path = @lesli[:customization][:logos][logo.to_sym] if @lesli.dig(:customization, :logos, logo.to_sym)
+
+            if mode == "pdf"
+                wicked_pdf_image_tag(logo_path, options)
+            elsif tag
+                image_tag(logo_path, options)
+            else
+                image_url(logo_path, options)
+            end
+        end
+
+        def customization_instance_logo_tag(logo: "app-logo", variant: "light", mode: "web", options: { alt: "Logo" })
+            customization_instance_logo(tag: true, logo: logo, variant: variant, mode: mode, options: options)
+        end
+
+        def customization_instance_logo_url(logo: "app-logo", variant: "light", mode: "web", options: { alt: "Logo" })
+            customization_instance_logo(tag: false, logo: logo, variant: variant, mode: mode, options: options)
+        end
+
+        def default_logos
+            {
+                "app_icon" => "app-icon.svg",
+                "app_logo" => "app-logo.svg",
+                "favicon" => "favicon.png"
+            }
+        end
+    end
+end

data/app/helpers/lesli/general_helper.rb

@@ -0,0 +1,83 @@
+=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 · Your Smart Business Assistant.
+
+Made with ♥ by https://www.lesli.tech
+Building a better future, one line of code at a time.
+
+@contact  hello@lesli.tech
+@website  https://lesli.tech
+@license  GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// ·
+
+=end
+
+module Lesli
+    module GeneralHelper
+        # build a url path to change locales
+        def language_url(locale)
+            "/language?locale=#{locale}"
+        end
+
+        # return flag code according to locale code
+        def language_flag(locale)
+            locale = "gb" if locale.to_s == "en"
+            locale
+        end
+
+        # return the name of the language
+        def language_name(locale)
+            Rails.application.config.lesli.dig(:configuration, :locales_available, locale.to_sym) || "undefined"
+        end
+
+        # print a custom icon for lesli
+        def lesli_svg(name)
+            content_tag("svg", width: "64px", height: "64px") do
+                "<use xlink:href='##{name}'></use>".html_safe
+            end
+        end
+
+        # return a string with a css class to identify the body
+        # example: builder engine-controller action
+        def application_body_class
+            [lesli_instance_code, controller_path.gsub("/", "-"), action_name].join(" ")
+        end
+
+        # build the text for the html document title
+        # this helper works only for rails pages, for vue apps the title must be handled with JS
+        def website_title
+            return @application_html_title if @application_html_title
+
+            title = controller_path.gsub("cloud", "").gsub("_", "")
+            name = @account.dig(:company, :name)
+            "#{title} - #{name}"
+        end
+
+        # build description using custom data from controller or engine gem description
+        def website_meta_description
+            # if want to get description from gem you can use:
+            # Gem::Specification.find_by_name(engine_name).description
+            # Gem::Specification.find_by_name(engine_name).summary
+            @application_html_description || ""
+        end
+    end
+end