lesli 5.0.10 → 5.0.12

data/app/controllers/lesli/abouts_controller.rb

@@ -35,28 +35,22 @@ module Lesli
 
         # GET /status
         def show
-            # instance name from builder
-            instance = Lesli.config.instance
-
-            # get installed engines
-            @lesli_engines = Lesli::System.engines.map { |engine, engine_info|
-                {
-                    :name => engine_info[:name],
-                    :code => engine_info[:code],
-                    :path => engine_info[:path],
-                    :version => engine_info[:version],
-                    :build => engine_info[:build]
-                }
-            }
-    
             respond_to do |format|
                 format.html {}
                 format.json { 
                     if Rails.env.production?
-                        respond_with_successful({ :Lesli => "Ruby on Rails SaaS Development Framework."}) 
-                    end
-
-                    if !Rails.env.production?
+                        respond_with_successful({ :Lesli => "Ruby on Rails SaaS Development Framework." }) 
+                    else
+                        # get installed engines
+                        @lesli_engines = Lesli::System.engines.map { |engine, engine_info|
+                            {
+                                :name => engine_info[:name],
+                                :code => engine_info[:code],
+                                :path => engine_info[:path],
+                                :build => engine_info[:build],
+                                :version => engine_info[:version]
+                            }
+                        }
                         respond_with_successful(@lesli_engines) 
                     end
                 }

data/app/controllers/lesli/application_controller.rb

@@ -71,38 +71,38 @@ module Lesli
             #                         })
         end
 
-        # Set the user language based on url configuration or browser/os default language (ready for public pages)
-        def set_locale
-            # language defined in the http header request
-            locale = request.headers["Require-Language"] unless request.headers["Require-Language"].blank?
+        # # Set the user language based on url configuration or browser/os default language (ready for public pages)
+        # def set_locale
+        #     # language defined in the http header request
+        #     locale = request.headers["Require-Language"] unless request.headers["Require-Language"].blank?
 
-            # use locale defined in the url
-            locale = params[:locale] if locale.blank?
+        #     # use locale defined in the url
+        #     locale = params[:locale] if locale.blank?
 
-            # use the language from the browser/os
-            locale = browser_locale if locale.blank?
+        #     # use the language from the browser/os
+        #     locale = browser_locale if locale.blank?
 
-            # use the default locale if no custom locale was found
-            return I18n.locale = I18n.default_locale if locale.blank?
+        #     # use the default locale if no custom locale was found
+        #     return I18n.locale = I18n.default_locale if locale.blank?
 
-            # use default locale if requested language is not supported
-            return I18n.locale = I18n.default_locale unless I18n.available_locales.include?(locale.to_sym)
+        #     # use default locale if requested language is not supported
+        #     return I18n.locale = I18n.default_locale unless I18n.available_locales.include?(locale.to_sym)
 
-            # set the new locale
-            I18n.locale = locale
-        end
+        #     # set the new locale
+        #     I18n.locale = locale
+        # end
 
-        protected
+        # protected
 
-        def browser_locale
-            # get user's preferred language from browser
-            user_browser_locale = request.headers["HTTP_ACCEPT_LANGUAGE"] || request.headers["Accept-Language"] || ""
+        # def browser_locale
+        #     # get user's preferred language from browser
+        #     user_browser_locale = request.headers["HTTP_ACCEPT_LANGUAGE"] || request.headers["Accept-Language"] || ""
 
-            # extract locale from accept language header
-            user_browser_locale.scan(/^[a-z]{2}/).find do |locale|
-                # validate if browser language is in the list of supported languages
-                I18n.available_locales.include?(locale.to_sym)
-            end
-        end
+        #     # extract locale from accept language header
+        #     user_browser_locale.scan(/^[a-z]{2}/).find do |locale|
+        #         # validate if browser language is in the list of supported languages
+        #         I18n.available_locales.include?(locale.to_sym)
+        #     end
+        # end
     end
 end

data/app/controllers/lesli/application_lesli_controller.rb

@@ -42,12 +42,11 @@ module Lesli
 
         before_action :set_path
         before_action :set_locale
-        before_action :authorize_request
-        before_action :authorize_privileges
-        before_action :set_helpers_for_request
-        before_action :set_customization
-
-        after_action  :log_requests
+        before_action :authorize_request if defined?(LesliShield)
+        before_action :authorize_privilege if defined?(LesliSecurity)
+        before_action :set_customizer
+        before_action :set_requester
+        after_action  :log_requests if defined?(LesliAudit)
 
         layout "lesli/layouts/application-lesli"
 

data/app/controllers/lesli/interfaces/application/authorization.rb

@@ -68,7 +68,7 @@ module Lesli
                 # Check if current_user has privileges to complete this request
                 # allowed core methods:
                 #   [:index, :create, :update, :destroy, :new, :show, :edit, :options, :search, :resources]
-                def authorize_privileges
+                def authorize_privilege
 
                     # check if user has access to the requested controller
                     # this search is over all the privileges for all the roles of the user

data/app/controllers/lesli/interfaces/application/customization.rb

@@ -4,7 +4,7 @@ module Lesli
             module Customization
 
                 # set customization only for lesli_cloud instance
-                def set_customization
+                def set_customizer
 =begin
                     # @account is only for html and pdf requests
                     return unless request.format.html? || request.format.pdf?

data/app/controllers/lesli/interfaces/application/requester.rb

@@ -65,11 +65,11 @@ module Lesli
                 end
 
                 # Set default query params for:
-                def set_helpers_for_request
+                def set_requester
                     @query = {
                         search: params[:search] || nil,
                         pagination: {
-                            perPage: (params[:perPage] ? params[:perPage].to_i : 10),
+                            perPage: (params[:perPage] ? params[:perPage].to_i : 12),
                             page: (params[:page] ? params[:page].to_i : 1)
                         },
                         order: {

data/app/controllers/lesli/interfaces/application/responder.rb

@@ -52,14 +52,14 @@ module Lesli
                 #            to make this work properly
                 def respond_with_pagination(records, payload = nil)
                     respond_with_http(200, {
-                                          pagination: {
-                                              page: records.current_page,
-                                              pages: records.total_pages,
-                                              total: records.total_count,
-                                              results: records.length
-                                          },
-                                          records: payload || records
-                                      })
+                        pagination: {
+                            page: records.current_page,
+                            pages: records.total_pages,
+                            total: records.total_count,
+                            results: records.length
+                        },
+                        records: payload || records
+                    })
                 end
 
                 # JSON not found response

data/app/controllers/lesli/interfaces/controllers/actions.rb

@@ -0,0 +1,250 @@
+=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 Interfaces
+        module Controllers
+            module Actions
+
+                # @return [Json] Json that contains a list of all actions related to a *cloud_object*
+                # @description Retrieves and returns all actions associated to a *cloud_object*. The id of the 
+                #     *cloud_object* is within the *params* attribute. If the child class provides a block, the function is
+                #     yielded sending the actions as parameters. The block given *must* return the HTTP response
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     this.http.get(`127.0.0.1/help/tickets/${ticket_id}/actions`);
+                def index
+                    set_cloud_object()
+                    action_model = action_model() # If there is a custom action model, it must be returned in this method
+                    cloud_object_model = action_model.cloud_object_model
+                    
+                    @actions = action_model.index(current_user, @cloud_object)
+                    if block_given?
+                        yield(@actions)
+                    else
+                        respond_with_successful(@actions)
+                    end
+                end
+
+                # @return [JSON] The json information about the selected action
+                # @description Retrieves and returns the information about the action. The id of the 
+                #     *cloud_object* and the id of the *action* are within the *params* attribute. If a block
+                #     is provided, the execution will be yielded sending the action as first parameter
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     let action_id = 5;
+                #     this.http.get(`127.0.0.1/help/tickets/${ticket_id}/actions/${action_id}`);
+                def show
+                    set_action
+                    return respond_with_not_found unless @action
+
+                    if block_given?
+                        yield(@action)
+                    else
+                        return respond_with_successful(@action)
+                    end
+                end
+
+                # @controller_action_param :content [String] The commented message
+                # @controller_action_param :actions_id [Integer] The id of a actions that this message responds to
+                # @return [Json] Json that contains wheter the creation of the action was successful or not. 
+                #     If it is not successful, it returs an error message
+                # @description Creates a new action associated to a *cloud_object* and notifies all users subscribed to this event. 
+                #     The id of the *cloud_object* is within the *params* attribute
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     let data = {
+                #         ticket_action: {
+                #             content: "This is a comment on a ticket!"
+                #         }
+                #     };
+                #     this.http.post(`127.0.0.1/help/tickets/${ticket_id}/actions`, data);
+                def create
+                    action_model = action_model() # If there is a custom action model, it must be returned in this method
+                    cloud_object_model = action_model.cloud_object_model
+
+                    set_cloud_object
+                    new_action_params = action_params.merge(
+                        user_creator: current_user
+                    )
+
+                    action = @cloud_object.actions.new(new_action_params)
+                    if action.save
+                        if block_given?
+                            yield(cloud_object, action)
+                        else
+                            respond_with_successful(action.show(current_user))
+                        end
+                    else
+                        respond_with_error(action.errors.full_messages)
+                    end
+                end
+
+                # @controller_action_param :content [String] The content of the action
+                # @controller_action_param :actions_id [Integer] The id of a actions that this message responds to
+                # @return [Json] Json that contains wheter the update of the action was successful or not. 
+                #     If it is not successful, it returs an error message
+                # @description Updates the action based on the id of the *cloud_object* and its own id.
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     let action_id = 22;
+                #     data = {
+                #         action: {
+                #             content: "This is the new content of the action"
+                #         }
+                #     };
+                #     this.http.patch(`127.0.0.1/help/tickets/${ticket_id}/actions/${action_id}`, data);
+                def update
+                    set_action
+                    return respond_with_not_found unless @action
+                    return respond_with_unauthorized unless @action.is_editable_by?(current_user)
+
+                    if @action.update(action_params)
+                        respond_with_successful(@action.show(current_user))
+                    else
+                        respond_with_error(@action.errors.full_messages.to_sentence)
+                    end
+                end
+
+                # @return [Json] A response that contains wheter the action was deleted or not.
+                #     If it is not successful, it returns an error message
+                # @description Deletes a action from the database based on the id of the *cloud_object* and its own id.
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     let action_id = 22;
+                #     this.http.delete(`127.0.0.1/help/tickets/${ticket_id}/actions/${action_id}`);
+                def destroy
+                    set_action
+                    return respond_with_not_found unless @action
+                    
+                    if @action.destroy
+                        respond_with_successful
+                    else
+                        respond_with_error(@action.errors.full_messages.to_sentence)
+                    end
+                end
+
+                protected
+
+                # @return [Parameters] Allowed parameters for the action
+                # @description Sanitizes the parameters received from an HTTP call to only allow the specified ones.
+                #     Allowed params are _:content_, _:actions_id_.
+                # @example
+                #     # supose params contains {
+                #     #    "ticket_action": {
+                #     #        "id": 5,
+                #     #        "content": "This is a message!",
+                #     #        "cloud_help_ticket_actions_id": 4
+                #     #    }
+                #     #}
+                #     action_params = action_params
+                #     puts action_params
+                #     # will remove the _id_ field and only print {
+                #     #    "ticket_action": {
+                #     #        "content": "This is a message!",
+                #     #        "cloud_help_ticket_actions_id": 4
+                #     #    }
+                #     #}
+                def action_params
+                    action_model = action_model() # If there is a custom action model, it must be returned in this method
+                    cloud_object_model = action_model.cloud_object_model
+
+                    params.require(
+                        "#{cloud_object_model.name.demodulize.underscore}_action".to_sym
+                    ).permit(
+                        :instructions,
+                        :complete,
+                        :group,
+                        "#{action_model.table_name}_id".to_sym
+                    )
+                end
+
+                # @return [void]
+                # @descriptions Sets the variable @cloud_object based on the paremeters send in the URL. If no,
+                #     cloud_object is found or it is not within the current_user's account, nil is used instead
+                # @example
+                #     # Imagine you are inside CloudFocus::Task::ActionsController
+                #     puts @cloud_object # will display nil
+                #     set_cloud_object
+                #     puts @cloud_object # Will display an instance of CloudFocus::Task
+                def set_cloud_object
+                    action_model = action_model() # If there is a custom action model, it must be returned in this method
+                    cloud_object_model = action_model.cloud_object_model
+                    account_model = cloud_object_model.reflect_on_association(:account).klass
+
+                    @cloud_object = cloud_object_model.find_by(
+                        id: params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym],
+                        "#{account_model.table_name}_id".to_sym => current_user.account.id
+                    )
+                end
+
+                # @return [void]
+                # @description Sets the variable @action. The variable contains the action 
+                #     to be updated based on the id of the *cloud_object* and the id of the *action*
+                # @example
+                #     #suppose params[:ticket_id] = 1
+                #     #suppose params[:id] = 44
+                #     puts @action # will display nil
+                #     set_action
+                #     puts @action # will display an instance of CloudHelp:Ticket::Action
+                def set_action
+                    action_model = action_model() # If there is a custom action model, it must be returned in this method
+                    cloud_object_model = action_model.cloud_object_model
+                    account_model = cloud_object_model.reflect_on_association(:account).klass
+
+                    @action = action_model.joins(:cloud_object).where(
+                        "#{cloud_object_model.table_name}.id = #{params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym]}",
+                        "#{cloud_object_model.table_name}.#{account_model.table_name}_id = #{current_user.account.id}"
+                    ).find_by(
+                        id: params[:id]
+                    )
+                end
+
+                # @return [CloudObject::Action] The action model that the controller will handle
+                # @descriptions Constantizes and returns the action model associated to this controller. This method
+                #      can be overrided by the implementation in the child controller
+                # @example
+                #     # Suppose you are inside CloudHelp::Ticket::ActionsController
+                #     puts action_model().new
+                #     # This will display a new instance of CloudHelp::Ticket::Action
+                def action_model
+                    self.class.name.gsub("Controller","").singularize.constantize
+                end
+            end
+        end
+    end
+end

data/app/controllers/lesli/interfaces/controllers/activities.rb

@@ -0,0 +1,215 @@
+=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 Interfaces
+        module Controllers
+            module Activities
+
+                # @return [Json] Json that contains a list of all activities related to a *cloud_object*
+                # @description Retrieves and returns all activities associated to a *cloud_object*. The id of the 
+                #     *cloud_object* is within the *params* attribute
+                # @example
+                #     # Executing this controller's activity from javascript's frontend
+                #     let ticket_id = 1;
+                #     this.http.get(`127.0.0.1/help/tickets/${ticket_id}/activities`);
+                def index
+                    activity_model = activity_model() # If there is a custom activity model, it must be returned in this method
+                    cloud_object_model = activity_model.cloud_object_model
+                    translations_module = activity_model.name.split("::")[0].gsub("Cloud", "").underscore
+                    
+                    @activities = activity_model.index(
+                        current_user,
+                        params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym],
+                        @query
+                    )
+
+                    if block_given?
+                        yield(@activities)
+                    else
+                        respond_with_successful(@activities)
+                    end
+                end
+
+                # @return [JSON] The json information about the selected activity
+                # @description Retrieves and returns the information about the activity. The id of the 
+                #     *cloud_object* and the id of the *activity* are within the *params* attribute. If a block
+                #     is provided, the execution will be yielded sending the activity as first parameter
+                # @example
+                #     # Executing this controller's action from javascript's frontend
+                #     let ticket_id = 1;
+                #     let activity_id = 5;
+                #     this.http.get(`127.0.0.1/help/tickets/${ticket_id}/activities/${activity_id}`);
+                def show
+                    set_activity
+                    return respond_with_not_found unless @activity
+
+                    if block_given?
+                        yield(@activity)
+                    else
+                        return respond_with_successful(@activity)
+                    end
+                end
+                
+                # @controller_action_param :description [String] The description of the activity
+                # @controller_action_param :field [String] The field that was changed (if any)
+                # @controller_action_param :value_from [String] The initial field value of the activity (if any)
+                # @controller_action_param :value_to [String] The final field value of the activity (if any)
+                # @controller_action_param :category [String] An enum value, that indicates the type of activity recorded
+                # @return [Json] Json that contains wheter the creation of the activity was successful or not. 
+                #     If it is not successful, it returs an error message
+                # @description Creates a new activity associated to a *cloud_object*. The id of the 
+                #     *cloud_object* is within the *params* attribute
+                # @example
+                #     # Executing this controller's activity from javascript's frontend
+                #     let ticket_id = 1;
+                #     let data = {
+                #         ticket_activity: {
+                #             description: "Created",
+                #             category: "action_create"
+                #         }
+                #     };
+                #     this.http.post(`127.0.0.1/help/tickets/${ticket_id}/activities`, data);
+                def create
+                    activity_model = activity_model() # If there is a custom activity model, it must be returned in this method
+                    cloud_object_model = activity_model.cloud_object_model
+
+                    set_cloud_object
+                    new_activity_params = activity_params.merge(
+                        user_creator: current_user,
+                        cloud_object: @cloud_object
+                    )
+
+                    activity = activity_model.new(new_activity_params)
+                    if activity.save
+                        if block_given?
+                            yield(cloud_object, activity)
+                        else
+                            # Returning the 200 HTTP response
+                            respond_with_successful(activity)
+                        end
+                    else
+                        respond_with_error(activity.errors.full_messages)
+                    end
+                end
+
+                protected
+
+                # @return [void]
+                # @descriptions Sets the variable @cloud_object based on the paremeters send in the URL. If no,
+                #     cloud_object is found or it is not within the current_user's account, nil is used instead
+                # @example
+                #     # Imagine you are inside CloudFocus::Task::ActivitiesController
+                #     puts @cloud_object # will display nil
+                #     set_cloud_object
+                #     puts @cloud_object # Will display an instance of CloudFocus::Task
+                def set_cloud_object
+                    activity_model = activity_model() # If there is a custom activity model, it must be returned in this method
+                    cloud_object_model = activity_model.cloud_object_model
+                    account_model = cloud_object_model.reflect_on_association(:account).klass
+
+                    @cloud_object = cloud_object_model.find_by(
+                        id: params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym],
+                        "#{account_model.table_name}_id".to_sym => current_user.account.id
+                    )
+                end
+
+                # @return [void]
+                # @description Sets the variable @activity. The variable contains the activity 
+                #     to be updated based on the id of the *cloud_object* and the id of the *activity*
+                # @example
+                #     #suppose params[:ticket_id] = 1
+                #     #suppose params[:id] = 44
+                #     puts @activity # will display nil
+                #     set_activity
+                #     puts @activity # will display an instance of CloudHelp:Ticket::Activity
+                def set_activity
+                    activity_model = activity_model() # If there is a custom activity model, it must be returned in this method
+                    cloud_object_model = activity_model.cloud_object_model
+                    account_model = cloud_object_model.reflect_on_association(:account).klass
+
+                    @activity = activity_model.joins(:cloud_object).where(
+                        "#{cloud_object_model.table_name}.id = #{params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym]}",
+                        "#{cloud_object_model.table_name}.#{account_model.table_name}_id = #{current_user.account.id}"
+                    ).find_by(
+                        id: params[:id]
+                    )
+                end
+
+                # @return [Parameters] Allowed parameters for the activity
+                # @description Sanitizes the parameters received from an HTTP call to only allow the specified ones.
+                #     Allowed params are _:description_, _:field_name_, _:value_from_, _:value_toe_, _:category_
+                # @example
+                #     # supose params contains {
+                #     #    "ticket_activity": {
+                #     #        "id": 5,
+                #     #        "description": "User requested this ticket",
+                #     #        "tags": "Important",
+                #     #        "info": "Example"
+                #     #    }
+                #     #}
+                #     activity_params = activity_params
+                #     puts activity_params
+                #     # will remove all unpermitted fields and only print {
+                #     #    "ticket_activity": {
+                #     #        "description": "User requested this ticket"
+                #     #    }
+                #     #}
+                def activity_params
+                    activity_model = activity_model() # If there is a custom activity model, it must be returned in this method
+                    cloud_object_model = activity_model.cloud_object_model
+
+                    params.require(
+                        "#{cloud_object_model.name.demodulize.underscore}_activity".to_sym
+                    ).permit(
+                        :description,
+                        :field_name,
+                        :value_from,
+                        :value_to,
+                        :category
+                    )
+                end
+
+                # @return [CloudObject::Activity] The activity model that the controller will handle
+                # @descriptions Constantizes and returns the activity model associated to this controller. This method
+                #      can be overrided by the implementation in the child controller
+                # @example
+                #     # Suppose you are inside CloudHelp::Ticket::ActivitiesController
+                #     puts activity_model().new
+                #     # This will display a new instance of CloudHelp::Ticket::Activity
+                def activity_model
+                    self.class.name.gsub("Controller","").singularize.constantize
+                end
+            end
+        end
+    end
+end