lesli 5.0.13 → 5.0.14

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

@@ -1,234 +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 · 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 Subscribers
-
-                # @return [Json] Json that contains a list of all subscribers related to a *cloud_object*
-                # @description Retrieves and returns all subscribers associated to a *cloud_object*. 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;
-                #     this.http.get(`127.0.0.1/help/tickets/${ticket_id}/subscribers`);
-                def index
-                    subscriber_model = subscriber_model() # If there is a custom subscriber model, it must be returned in this method
-                    cloud_object_model = subscriber_model.cloud_object_model
-                    @cloud_object = cloud_object_model.find_by(id: params["#{cloud_object_model.name.demodulize.underscore}_id".to_sym])
-                    return respond_with_not_found unless @cloud_object
-
-
-                    target_user = current_user.account.users.find_by(id: params[:users_id]) if params[:users_id]
-                    target_user = current_user unless target_user       
-
-                    actions = subscriber_model.subscription_actions(
-                        @cloud_object,
-                        target_user
-                    )
-                    respond_with_successful(actions)
-                end
-
-                # @controller_action_param :action [String] A string that represent a valid action present in the *Subscriber* model
-                # @controller_action_param :notification_type [String] A string that represents a valid notification_type
-                #     present in the *Subscriber* model
-                # @return [Json] Json that contains wheter the creation of the subscriber was successful or not. 
-                #     If it is not successful, it returs an error message
-                # @description Creates a new subscriber associated to a *cloud_object* using *current_user* as the subscriber. 
-                #     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 = {
-                #         subscriber: {
-                #             notification_type: "web",
-                #             action: "ticket_closed"
-                #         }
-                #     };
-                #     this.http.post(`127.0.0.1/help/tickets/${ticket_id}/subscribers`, data);
-                def create
-                    subscriber_model = subscriber_model() # If there is a custom subscriber model, it must be returned in this method
-                    cloud_object_model = subscriber_model.cloud_object_model
-
-                    target_user = current_user.account.users.find_by(id: params[:users_id]) if params[:users_id]
-                    target_user = current_user unless target_user   
-
-                    set_cloud_object
-                    new_subscriber_params = subscriber_params.merge(
-                        user_creator: target_user,
-                        cloud_object: @cloud_object
-                    )
-                    cloud_object_subscriber = subscriber_model.new(new_subscriber_params)
-
-                    if cloud_object_subscriber.save
-                        respond_with_successful(cloud_object_subscriber)
-                    else
-                        respond_with_error(cloud_object_subscriber.errors.full_messages.to_sentence)
-                    end
-                end
-
-                # @controller_action_param :action [String] A string that represent a valid action present in the *Subscriber* model
-                # @controller_action_param :notification_type [String] A string that represents a valid notification_type
-                # @return [Json] Json that contains wheter the update of the subscriber was successful or not. 
-                #     If it is not successful, it returs an error message
-                # @description Updates the subscriber 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 subscriber_id = 22;
-                #     data = {
-                #         subscriber: {
-                #             notification_type: "email"
-                #         }
-                #     };
-                #     this.http.patch(`127.0.0.1/help/tickets/${ticket_id}/subscribers/${subscriber_id}`, data);
-                def update
-                    set_subscriber
-                    return respond_with_not_found unless @subscriber
-
-                    if @subscriber.update(subscriber_params)
-                        respond_with_successful
-                    else
-                        respond_with_error(@subscriber.errors.full_messages.to_sentence)
-                    end
-                end
-
-                # @return [Json] A response that contains wheter the subscriber was deleted or not.
-                #     If it is not successful, it returns an error message
-                # @description Deletes a subscriber 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 subscriber_id = 22;
-                #     this.http.delete(`127.0.0.1/help/tickets/${ticket_id}/subscribers/${subscriber_id}`);
-                def destroy
-                    set_subscriber
-                    return respond_with_not_found unless @subscriber
-                    
-                    if @subscriber.destroy
-                        respond_with_successful
-                    else
-                        respond_with_error(@subscriber.errors.full_messages.to_sentence)
-                    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::DiscussionsController
-                #     puts @cloud_object # will display nil
-                #     set_cloud_object
-                #     puts @cloud_object # Will display an instance of CloudFocus::Task
-                def set_cloud_object
-                    subscriber_model = subscriber_model() # If there is a custom subscriber model, it must be returned in this method
-                    cloud_object_model = subscriber_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 @subscriber. The variable contains the subscription 
-                #     to be updated based on the id of the *cloud_object* and the id of the *subscriber*
-                # @example
-                #     #suppose params[:ticket_id] = 1
-                #     #suppose params[:id] = 44
-                #     puts @subscriber # will display nil
-                #     set_subscriber
-                #     puts @subscriber # will display an instance of CloudHelp:Ticket::Subscriber
-                def set_subscriber
-                    subscriber_model = subscriber_model() # If there is a custom subscriber model, it must be returned in this method
-                    cloud_object_model = subscriber_model.cloud_object_model
-                    account_model = cloud_object_model.reflect_on_association(:account).klass
-
-                    @subscriber = subscriber_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 subscriber
-                # @description Sanitizes the parameters received from an HTTP call to only allow the specified ones.
-                #     Allowed params are _:action_, _:notification_type_.
-                # @example
-                #     # supose params contains {
-                #     #    "subscriber": {
-                #     #        "id": 5,
-                #     #        "action": "ticket_created",
-                #     #        "notification_type": "email",
-                #     #        "random_param": 5
-                #     #    }
-                #     #}
-                #     subscriber_params = subscriber_params
-                #     puts subscriber_params
-                #     # will remove the _id_ and _random_param_ fields and only print {
-                #     #    "subscriber": {
-                #     #        "action": "ticket_created",
-                #     #        "notification_type": "email"
-                #     #    }
-                #     #}
-                def subscriber_params
-                    subscriber_model = subscriber_model() # If there is a custom subscriber model, it must be returned in this method
-                    cloud_object_model = subscriber_model.cloud_object_model
-
-                    params.require(
-                        "#{cloud_object_model.name.demodulize.underscore}_subscriber".to_sym
-                    ).permit(
-                        :action,
-                        :notification_type
-                    )
-                end
-
-                # @return [CloudObject::Subscriber] The subscriber model that the controller will handle
-                # @descriptions Constantizes and returns the subscriber model associated to this controller. This method
-                #      can be overrided by the implementation in the child controller
-                # @example
-                #     # Suppose you are inside CloudHelp::Ticket::SubscriberController
-                #     puts subscriber_model().new
-                #     # This will display a new instance of CloudHelp::Ticket::Discussion
-                def subscriber_model
-                    self.class.name.gsub("Controller","").singularize.constantize
-                end
-            end
-        end
-    end
-end
-

data/app/lib/lesli/system.rb

@@ -1,110 +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 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
-
-module Lesli
-    class System
-        ENGINES = {}
-
-        # engine("LesliAdmin")
-        # engine("LesliAdmin", "name")
-        def self.engine(engine, property=nil)
-
-            engine = engine.camelize
-
-            engines() if ENGINES.empty?
-
-            # the Root engine represents the host Rails app
-            engine = "Root" unless LESLI_ENGINES.include?(engine)
-
-            # return specific property if requested
-            return ENGINES[engine][property.to_sym] unless property.blank?
-
-            # return the engine info
-            return ENGINES[engine]
-        end
-
-        def self.engines 
-
-            return ENGINES unless ENGINES.empty?
-
-            # due we do not know the engine mounted path we have to look up for it every
-            # time we load the html view so we can use the dynamic route from the main rails app
-            # we use this in the url plugin 
-            LESLI_ENGINES.each do |engine|
-                next unless Object.const_defined?(engine)
-                engine_instance = "#{engine}".constantize
-                ENGINES[engine] = {
-                    :code => engine.underscore, 
-                    :name => lesli_engine_name(engine), 
-                    :path => engine_instance::Engine.routes.find_script_name({}),
-                    :version => engine_instance::VERSION,
-                    :build => engine_instance::BUILD,
-                    :dir => Gem::Specification.find_by_name(engine.underscore).gem_dir
-                }
-            end 
-
-            ENGINES["Root"] = {
-                :code => "root", 
-                :name => "Root", 
-                :path => "/",
-                :version => "1.0.0",
-                :build => "0000000",
-                :dir => Rails.root.to_s
-            }
-
-            ENGINES
-        end
-
-        private 
-
-        # Prints the name of the engine
-        def self.lesli_engine_name engine
-            name = engine.camelcase
-            return "Lesli" if name == "Lesli"
-            name.sub("Lesli", "")
-        end
-
-        LESLI_ENGINES = [
-            "Lesli", 
-            "LesliBell", 
-            "LesliAdmin", 
-            "LesliBabel", 
-            "LesliAudit", 
-            "LesliShield", 
-            "LesliLetter",
-            "LesliSupport",
-            "LesliSecurity",
-            "LesliCalendar",
-            "LesliDashboard"
-        ]
-    end
-end

data/app/models/lesli/cloud_object/action.rb

@@ -1,70 +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 · 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
-class CloudObject::Action < ApplicationLesliRecord
-    self.abstract_class = true
-
-    belongs_to :user_creator, class_name: "::User", foreign_key: "users_id"
-
-    # @return [Class] The class of the association 'belongs_to'
-    # @description All actions belong to a *cloud_object*. This method returns the specific class of
-    #     that cloud_object.
-    # @example
-    #     puts DeutscheLeibrenten::Project::File.cloud_object_model.new # This will display an instance of DeutscheLeibrenten::Project
-    def self.cloud_object_model
-        self.reflect_on_association(:cloud_object).klass
-    end
-
-    def self.index(curren_user, cloud_object)
-        action_groups = {}
-        cloud_object.actions.order(group: :asc).map do |action|
-            action_attributes = action.attributes.merge({
-                "user_creator_name" => action.user_creator.full_name,
-                "created_at_text" => LC::Date.to_string(action.created_at)
-            })
-            action_groups[action.group] = [] unless action_groups[action.group]
-            
-            action_groups[action.group].push(action_attributes)
-        end
-
-        action_groups
-    end
-
-    def show(current_user)
-        attributes.merge({
-            "user_creator_name" => user_creator.full_name,
-            "created_at_text" => LC::Date.to_string(created_at)
-        })
-    end
-end
-end