lesli 5.0.0

data/app/models/concerns/account_engines.rb

@@ -0,0 +1,249 @@
+=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 AccountEngines
+    extend ActiveSupport::Concern
+
+
+    # initialize engines for new accounts
+    def initialize_engines
+
+        if defined? CloudDispatcher
+            if self.dispatcher.blank?
+                self.dispatcher = CloudDispatcher::Account.new
+                self.dispatcher.account = self
+                self.dispatcher.save!
+            end
+        end
+
+        if defined? CloudKb
+            if self.kb.blank?
+                self.kb = CloudKb::Account.new
+                self.kb.account = self
+                self.kb.save!
+            end
+        end
+
+        if defined? CloudOne
+            if self.one.blank?
+                self.one = CloudOne::Account.new
+                self.one.account = self
+                self.one.save!
+            end
+        end
+
+        if defined? CloudTeam
+            if self.team.blank?
+                self.team = CloudTeam::Account.new
+                self.team.account = self
+                self.team.save!
+            end
+        end
+
+        if defined? CloudBell
+            if self.bell.blank?
+                self.bell = CloudBell::Account.new
+                self.bell.account = self
+                self.bell.save!
+            end
+        end
+
+        if defined? CloudDriver
+            if self.driver.blank?
+                self.driver = CloudDriver::Account.new
+                self.driver.account = self
+                self.driver.save!
+            end
+        end
+
+        if defined? CloudFocus
+            if self.focus.blank?
+                self.focus = CloudFocus::Account.new
+                self.focus.account = self
+                self.focus.save!
+            end
+        end
+
+        if defined? CloudHelp
+            if self.help.blank?
+                self.help = CloudHelp::Account.new
+                self.help.account = self
+                self.help.save!
+            end
+        end
+
+        if defined? CloudMailer
+            if self.mailer.blank?
+                self.mailer = CloudMailer::Account.new
+                self.mailer.account = self
+                self.mailer.save!
+            end
+        end
+
+        if defined? CloudText
+            if self.text.blank?
+                self.text = CloudText::Account.new
+                self.text.account = self
+                self.text.save!
+            end
+        end
+
+        if defined? CloudTalk
+            if self.talk.blank?
+                self.talk = CloudTalk::Account.new
+                self.talk.account = self
+                self.talk.save!
+            end
+        end
+
+        if defined? CloudStorage
+            if self.storage.blank?
+                self.storage = CloudStorage::Account.new
+                self.storage.account = self
+                self.storage.save!
+            end
+        end
+
+        if defined? CloudBooks
+            if self.books.blank?
+                self.books = CloudBooks::Account.new
+                self.books.account = self
+                self.books.save!
+            end
+        end
+
+        if defined? CloudHouse
+            if self.house.blank?
+                self.house = CloudHouse::Account.new
+                self.house.account = self
+                self.house.save!
+            end
+        end
+
+        if defined? CloudAudit
+            if self.audit.blank?
+                self.audit = CloudAudit::Account.new
+                self.audit.account = self
+                self.audit.save!
+            end
+        end
+
+        if defined? CloudThings
+            if self.things.blank?
+                self.things = CloudThings::Account.new
+                self.things.account = self
+                self.things.save!
+            end
+        end
+
+        if defined? CloudProposal
+            if self.proposal.blank?
+                self.proposal = CloudProposal::Account.new
+                self.proposal.account = self
+                self.proposal.save!
+            end
+        end
+
+        if defined? CloudRealty
+            if self.realty.blank?
+                self.realty = CloudRealty::Account.new
+                self.realty.account = self
+                self.realty.save!
+            end
+        end
+
+        if defined? CloudLesli
+            if self.lesli.blank?
+                self.lesli = CloudLesli::Account.new
+                self.lesli.account = self
+                self.lesli.save!
+            end
+        end
+
+        if defined? CloudShared
+            if self.shared.blank?
+                self.shared = CloudShared::Account.new
+                self.shared.account = self
+                self.shared.save!
+            end
+        end
+
+        if defined? CloudPortal
+            if self.portal.blank?
+                self.portal = CloudPortal::Account.new
+                self.portal.account = self
+                self.portal.save!
+            end
+        end
+
+        if defined? CloudWork
+            if self.work.blank?
+                self.work = CloudWork::Account.new
+                self.work.account = self
+                self.work.save!
+            end
+        end
+
+        if defined? CloudWord
+            if self.word.blank?
+                self.word = CloudWord::Account.new
+                self.word.account = self
+                self.word.save!
+            end
+        end
+
+        if defined? CloudSocial
+            if self.social.blank?
+                self.social = CloudSocial::Account.new
+                self.social.account = self
+                self.social.save!
+            end
+        end
+
+        if defined? CloudScraper
+            if self.scraper.blank?
+                self.scraper = CloudScraper::Account.new
+                self.scraper.account = self
+                self.scraper.save!
+            end
+        end
+
+        if defined? CloudTime
+            if self.time.blank?
+                self.time = CloudTime::Account.new
+                self.time.account = self
+                self.time.save!
+            end
+        end
+
+    end
+end

data/app/models/concerns/user_activities.rb

@@ -0,0 +1,163 @@
+=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
+
+
+# User Activities methods
+# Methods related to cloudobject/activities and user_logs
+module UserActivities
+    extend ActiveSupport::Concern
+
+
+    # @return [void]
+    # @description Register a new log for the current user
+    # @param description String Details about the process
+    # @param session String Current or active session id
+    def log description, session=nil
+        self.logs.create(session, description)
+    end
+
+    def log_activity_update(current_user, user, old_attributes, new_attributes)
+        old_attributes.except!("id", "users_id", "created_at", "updated_at", "deleted_at")
+        old_attributes.each do |key, value|
+            if value != new_attributes[key]
+                value_from = value
+                value_to = new_attributes[key]
+                value_from = Courier::Core::Date.to_string_datetime(value_from) if value_from.is_a?(Time) || value_from.is_a?(Date)
+                value_to = Courier::Core::Date.to_string_datetime(value_to) if value_to.is_a?(Time) || value_to.is_a?(Date)
+
+                user.activities.create!(
+                    assigned: current_user,
+                    category: "action_update",
+                    field_name: key,
+                    value_from: value_from,
+                    value_to: value_to
+                )
+            end
+        end
+    end    
+
+
+    # Define class methods from given block
+    # This allows to inject class methods to the User model, so we can use:
+    # User.log_activity_create
+    class_methods do 
+
+
+        # @return [void]
+        # @param current_user [::User] The user that created the user
+        # @param [User] The user that was created
+        # @description Creates an activity for this user indicating who created it.
+        # Example
+        #   params = {...}
+        #   user = User.create(params)
+        #   User.log_activity_create(User.find(1), user)
+        def log_activity_create(current_user, user)
+            user.activities.create(
+                assigned: current_user,
+                category: "action_create"
+            )
+        end
+
+
+        # @return [void]
+        # @param current_user [::User] The user that created the user
+        # @param user [User] The User that was created
+        # @param old_attributes[Hash] The data of the record before update
+        # @param new_attributes[Hash] The data of the record after update
+        # @description Creates an activity for this user if someone changed any of this values
+        # Example
+        #   user = User.find(1)
+        #   old_attributes  = user.attributes.merge({detail_attributes: user.detail.attributes})
+        #   user.update(main_employee: User.find(33))
+        #   new_attributes = user.attributes.merge({detail_attributes: user.detail.attributes})
+        #   User.log_activity_update(User.find(1), user, old_attributes, new_attributes)
+        def log_activity_update(current_user, user, old_attributes, new_attributes)
+            old_attributes.except!("id", "users_id", "created_at", "updated_at", "deleted_at")
+            old_attributes.each do |key, value|
+                if value != new_attributes[key]
+                    value_from = value
+                    value_to = new_attributes[key]
+                    value_from = Courier::Core::Date.to_string_datetime(value_from) if value_from.is_a?(Time) || value_from.is_a?(Date)
+                    value_to = Courier::Core::Date.to_string_datetime(value_to) if value_to.is_a?(Time) || value_to.is_a?(Date)
+
+                    user.activities.create(
+                        owner: current_user,
+                        category: "action_update",
+                        field_name: key,
+                        value_from: value_from,
+                        value_to: value_to
+                    )
+                end
+            end
+        end
+
+
+        # @return [void]
+        # @param current_user [::User] The user that created the user
+        # @param user [User] The User that was created
+        # @param user [Role] The Role assigned to the user
+        # @description Creates an activity for this user if someone adds a new role
+        # Example
+        #   user = User.find(1)
+        #   role = User.find(1)
+        #   User.log_activity_create_user_role(current_user, user, role)
+        def log_activity_create_user_role(current_user, user, role)
+            role_name = role.name
+
+            user.activities.create(
+                assigned: current_user,
+                category: "action_create_user_role",
+                value_to: role_name
+            )
+        end
+
+        
+        # @return [void]
+        # @param current_user [::User] The user that created the user
+        # @param user [User] The User that was created
+        # @param user [Role] The Role assigned to the user
+        # @description Creates an activity for this user if someone removes a role
+        # Example
+        #   user = User.find(1)
+        #   role = User.find(1)
+        #   User.log_activity_destroy_user_role(current_user, user, role)
+        def log_activity_destroy_user_role(current_user, user, role)
+            role_name = role.name
+
+            user.activities.create(
+                assigned: current_user,
+                category: "action_destroy_user_role",
+                value_to: role_name
+            )
+        end
+    end
+end

data/app/models/concerns/user_extensions.rb

@@ -0,0 +1,129 @@
+=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
+
+# User extension methods
+# Custom methods that belongs to a instance user
+module UserExtensions
+    extend ActiveSupport::Concern
+
+
+    # @return [void]
+    # @description Register a new notification for the current user
+    # @param subject String Short notification description
+    # @param body String Long notification description
+    # @param url String Link to notified object
+    # @param category String Kind of notification: info, warning, danger, success.
+    def notification subject, body:nil, url:nil, category:"info"
+        Courier::Bell::Notification.new(self, subject, body:body, url:url, category:category)
+    end
+
+
+    # @return [CloudDriver::Calendar]
+    # @description Return the default calendar of the user if source_code is not provided.
+    # If source_code is provided the method return the specified source calendar.
+    def calendar source_code: :lesli
+        return Courier::Driver::Calendar.get_user_calendar(self, source_code: source_code, default: true) if source_code == :lesli
+        Courier::Driver::Calendar.get_user_calendar(self, source_code: source_code)
+    end
+
+
+    # @return [String] The name of this user.
+    # @description Retrieves and returns the name of the user depending on the available information.
+    #     The name can be a full name (first and last names), just the first name, or, in case the information
+    #     is not available, the email. This method currently is available if the the CloudLock engine exists,
+    #     otherwise, it returns *nil*
+    # @example
+    #     my_user = current_user
+    #     puts my_user.name # can print John Doe
+    #     other_user = User.last
+    #     puts other_user.name # can print jane.smith@email.com
+    def full_name
+        self.first_name.blank? ? email : self.first_name + " " + self.last_name.to_s
+    end
+
+
+    # @return [String] The name initials of this user.
+    # @description Retrieves and returns the name initials of the user depending on the available information.
+    # @example
+    #     puts current_user.full_name_initials # would print JD
+    def full_name_initials
+        self.first_name.blank? ? "" : self.first_name[0].upcase + "" + (self.last_name.blank? ? "" : self.last_name[0].upcase)
+    end
+
+
+    # @return [nil]
+    # @description Set the user alias based on the full_name.
+    # @example
+    #     puts current_user.full_name # John Doe
+    #     puts current_user.set_alias # John D.
+    def set_alias
+        if self.alias.blank?
+            self.alias = full_name_initials() 
+            self.save
+        end
+    end
+
+
+    # @return [String]
+    # @description Returns the local configuration for the user if there is no locale the default local
+    # of the platform will be returned
+    # @example
+    #      locale = User.last.locle
+    #      will print something like: :es
+    def locale
+        user_locale = settings.find_by(name: "locale")
+
+        if user_locale
+            return user_locale.value.to_sym
+        end
+
+        # return current locale
+        I18n.locale 
+    end
+
+
+    # @return [void]
+    # @description Returns MFA settings configured by the user
+    # Example
+    #   user_mfa_settings = User.find(2).mfa_settings
+    #   puts user_mfa_settings
+    #       { :mfa_enabled => true, :mfa_method => "email"}
+    def mfa_settings
+        mfa_enabled = self.settings.create_with(:value => false).find_or_create_by(:name => "mfa_enabled")
+        mfa_method = self.settings.create_with(:value => :email).find_or_create_by(:name => "mfa_method")
+        {
+            :enabled => mfa_enabled.nil? ? false : mfa_enabled.value == 't',
+            :method => mfa_method.nil? ? nil : mfa_method.value.to_sym
+        }
+    end
+end