lesli_help 0.1.0

data/lib/vue/apps/tickets/new.vue

@@ -0,0 +1,92 @@
+<script setup>
+/*
+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
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// · 
+*/
+
+
+// · import vue tools
+import { onMounted, inject } from "vue"
+import { useRouter } from "vue-router"
+
+
+// . 
+const url = inject("url")
+
+
+// . import components
+import formTicket from "./components/form.vue"
+
+
+// · import lesli stores
+import { useTickets } from "LesliHelp/stores/tickets"
+
+
+// · initialize/inject plugins
+const router = useRouter()
+
+
+// · implement stores
+const storeTickets = useTickets()
+
+
+//·
+const translations = {
+    lesli: {
+        shared: i18n.t("lesli.shared")
+    },
+    tickets: i18n.t("lesli_help.tickets"),
+}
+
+
+//·
+const props = defineProps({
+    appMountPath: {
+        type: String,
+        required: false,
+        default: "help/tickets",
+    }
+})
+
+
+// · initializing
+storeTickets.getOptions()
+
+</script>
+<template>
+    <lesli-application-container>
+        <lesli-header :title="translations.tickets.view_new_ticket_title">
+            <lesli-button :to="url.root(props.appMountPath)" icon="list">
+                {{ translations.lesli.shared.button_list }}
+            </lesli-button>
+        </lesli-header>
+        <form-ticket editable></form-ticket>
+
+    </lesli-application-container>
+</template>

data/lib/vue/apps/tickets/show.vue

@@ -0,0 +1,177 @@
+<script setup>
+/*
+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
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// · 
+*/
+
+
+// · import vue tools
+import { onMounted, computed, inject } from "vue"
+import { useRouter, useRoute } from "vue-router"
+
+
+// . import components
+import formTicket from "./components/form.vue"
+// import slaInfo from './components/sla-info.vue'
+// import internalComments from './components/internal-comments.vue'
+// import assignments from './components/assignments.vue'
+
+
+//import ComponentDiscussions from "Lesli/cloudobjects/components/discussion.vue"
+//import ComponentFiles from "Lesli/cloudobjects/components/file.vue"
+//import ComponentWorkflowStatusDropdown from "Lesli/shared/workflows/components/workflow-status-dropdown.vue"
+//import ComponentActions from "Lesli/cloudobjects/components/action.vue"
+
+
+// · import lesli stores
+import { useTickets } from "LesliHelp/stores/tickets"
+
+
+// · initialize/inject plugins
+const route = useRoute()
+const router = useRouter()
+const url = inject("url")
+
+
+// · implement stores
+const storeTickets = useTickets()
+
+
+//·
+const translations = {
+    tickets: i18n.t("lesli_help.tickets"),
+    lesli: {
+        shared: i18n.t("lesli.shared")
+    },
+
+
+    main: I18n.t('help.tickets'),
+    sla: I18n.t('help.slas'),
+    core: {
+        shared: I18n.t('core.shared')
+    },
+    shared: I18n.t('help.shared')
+}
+
+
+//·
+const props = defineProps({
+    editable: {
+        type: Boolean,
+        required: false,
+        default: false,
+    },
+    appMountPath: {
+        type: String,
+        required: false,
+        default: "help/tickets",
+    }
+})
+
+
+//· 
+onMounted(() => {
+    storeTickets.fetchTicket(route.params.id)
+})
+
+
+//· 
+const onUpdatedStatus = () => {
+    storeTickets.fetchTicket(route.params.id)
+}
+
+
+//·
+const onDelete = () => {
+    storeTickets.deleteTicket().then(()=>{
+        router.push(url.root(`${props.appMountPath}`).s)
+    })
+}
+
+</script>
+<template>
+    <lesli-application-container>
+        <lesli-header :title="`${storeTickets.ticket.subject} (${storeTickets.ticket.status || 'open'})`">
+            <lesli-button-link :to="url.help('tickets/:id/edit', route.params.id)" warning icon="edit">
+                {{ translations.lesli.shared.button_edit }}
+            </lesli-button-link>
+            <lesli-link :to="url.root(props.appMountPath)" icon="list">
+                {{ translations.lesli.shared.button_list }}
+            </lesli-link>
+            <lesli-button danger @click="onDelete" icon="delete">
+                {{ translations.lesli.shared.button_delete }}
+            </lesli-button>
+        </lesli-header>
+
+        <lesli-tabs v-model="tab">
+
+            <lesli-tab-item :title="translations.tickets.tab_general_information" icon="info" paddingless>
+                <form-ticket :path="props.appMountPath" :editable="props.editable"></form-ticket>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.tickets.tab_assignments" icon="group">
+                <assignments></assignments>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.lesli.shared.view_discussions" icon="forum">
+                <component-discussions 
+                    cloud-module="help" 
+                    cloud-object="tickets" 
+                    :cloud-object-id="storeTickets.ticket.id"
+                    :onlyDiscussions="false">
+                </component-discussions>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.lesli.shared.view_files" icon="attach_file">
+                <component-files
+                    cloud-module="help" 
+                    cloud-object="tickets"
+                    :cloud-object-id="storeTickets.ticket.id"
+                    :accepted-files="['images', 'documents', 'plaintext']">
+                </component-files>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.main.view_tab_title_histories" icon="comment">
+                <internal-comments></internal-comments>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.lesli.shared.view_quick_actions" icon="playlist_add_check">
+                <component-actions
+                    cloud-module="help" 
+                    cloud-object="tickets"
+                    :cloud-object-id="storeTickets.ticket.id">
+                </component-actions>
+            </lesli-tab-item>
+
+            <lesli-tab-item :title="translations.main.view_tab_title_sla" icon="article" v-if="storeTickets.ticket.sla">
+                <sla-info></sla-info>
+            </lesli-tab-item>
+        </lesli-tabs>
+    </lesli-application-container>
+</template>

data/lib/vue/stores/tickets.js

@@ -0,0 +1,275 @@
+/*
+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
+
+// · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
+// · 
+*/
+
+
+// · 
+import { defineStore } from "pinia"
+
+
+// · 
+export const useTickets = defineStore("help.tickets", {
+    state: () => {
+        return {
+            loading: false,
+            ticket: {
+                cloud_help_catalog_ticket_types_id: null,
+                cloud_help_catalog_ticket_categories_id: null,
+                cloud_help_catalog_ticket_sources_id: null,
+                cloud_help_catalog_ticket_priorities_id: null,
+                cloud_help_catalog_ticket_workspaces_id: null,
+                subject: null,
+                description: '',
+                deadline: new Date(),
+                hours_worked: 0,
+                started_at: new Date(),
+                finished_at: new Date()
+            },
+
+            index: { 
+                loading: false,
+                records: [],
+                pagination: { page: 1 }
+            },
+
+
+
+            loading: false,
+            tickets: [],
+            options: {},
+            tags: [],
+            workspaces_options: 0,
+            
+            filters: {
+                cloud_help_catalog_ticket_workspaces_id: null,
+                search_type: 'active',
+                user_type: null,
+                per_page: 10
+            }
+        }
+    },
+    actions: {
+
+
+        // Get all the available tickets
+        getTickets(url=this.url.help("tickets")) {
+            this.index.records = []
+            this.index.loading = true 
+
+            this.http.get(url.paginate(this.index.pagination.page)).then(result => {
+                this.index.records = result.records.map(ticket => {
+                    if (ticket.deadline != null){
+                        ticket.deadline = this.date(ticket.deadline).date()
+                    }
+                    return ticket
+                })
+            }).catch(error => {
+                this.msg.danger(I18n.t("core.shared.messages_danger_internal_error"))
+            }).finally(() => {
+                this.index.loading = false
+            })
+        },
+
+
+        // Create a new ticket
+        postTicket() {
+            return this.http.post(this.url.help('tickets'), {
+                ticket: {
+                    ...this.ticket
+                }
+            })
+        },
+
+
+        /**
+         * @description This action is used to get options for selectors in ticket form
+         */
+        async getOptions(){
+            this.loading = true
+            this.options = {}
+            return this.http.get(this.url.help('tickets/options')).then(result => {
+                this.options.types = result.types.map((type)=> {
+                    return {
+                        label: type.name,
+                        value: type.id
+                    }
+                } )
+
+                this.options.categories = result.categories.map((category)=> {
+                    return {
+                        label: category.name,
+                        value: category.id
+                    }
+                } )
+
+                this.options.priorities = result.priorities.map((priority)=> {
+                    return {
+                        label: priority.name,
+                        value: priority.id
+                    }
+                })
+
+                this.options.workspaces = result.workspaces.map((workspace)=> {
+                    return {
+                        label: workspace.name,
+                        value: workspace.id
+                    }
+                })
+
+                this.workspaces_options = Object.keys(this.options.workspaces).length
+
+            }).catch(error => {
+                this.msg.danger(I18n.t("core.shared.messages_danger_internal_error"))
+            }).finally(() => {
+                this.loading = false
+            })
+            
+        },
+
+        /**
+         * @description This action is used to post a new ticket
+         */
+
+
+        /**
+         * @description This action is used to update a ticket
+         */
+        updateTicket(){
+
+            //Veriy if tags in tickets were selected 
+            let selected_tags = null
+            if (this.tags.length > 0) {
+                selected_tags = this.tags.map(tag => tag.name).join(',')
+            } else{
+                selected_tags = null
+            }
+
+            this.http.put(this.url.help('tickets/:id', this.ticket.id), {
+                ticket: {
+                    ...this.ticket,
+                    tags: selected_tags
+                }
+                
+            }).then(result => {
+                this.msg.success(I18n.t("core.users.messages_success_operation"))
+            }).catch(error => {
+                this.msg.danger(I18n.t("core.shared.messages_danger_internal_error"))
+            })
+        },
+
+        /**
+         * @description This action is used to fetch a ticket.
+         * @param {Integer} id The id of the ticket.
+         */
+        fetchTicket(id){
+
+            this.loading = true
+            this.ticket = {}
+            const url = this.url.help('tickets/:id', id)
+
+            this.http.get(url).then(result => {
+                this.ticket = result
+
+                // Get the list of tags from a ticket and parse to a format used by the input tag component
+                this.tags = []
+                if (this.ticket.tags != null) {
+                    this.ticket.tags.split(',').forEach((tag)=>{
+                        this.tags.push({name: tag})
+                    })
+                }
+
+                this.ticket.deadline= dayjs(this.ticket.deadline).format('YYYY-MM-DD') //Change date format to show in date selector
+
+            }).catch(error => {
+                this.msg.danger(I18n.t("core.shared.messages_danger_internal_error"))
+            }).finally(() => {
+                this.loading = false
+            })
+        },
+
+        /**
+         * @description This action is used to delete a ticket
+         */
+        async deleteTicket(){
+            this.dialog
+                .confirmation({
+                    title: "Delete ticket",
+                    text: "Are you sure you want to delete this ticket?",
+                    confirmText: "yes",
+                    cancelText: "no"
+                })
+                .then(({ isConfirmed }) => {
+                    if (isConfirmed) {
+                        return this.http.delete(this.url.help('tickets/:id', this.ticket.id)).then(result => {
+                            this.msg.success(I18n.t("core.users.messages_success_operation"))
+                        }).catch(error => {
+                            this.msg.danger(I18n.t("core.shared.messages_danger_internal_error"))
+                        })
+                    }
+                })
+        },
+
+        /**
+        * @description This action is used to reload tickets
+        */
+        reloadTickets(){
+            this.tickets = []
+            this.getTickets()
+        },
+
+        /**
+         * @description This action is used to paginate tickets from index
+         * @param {String} page The actual page showing.
+         */
+        paginateIndex(page) {
+            this.pagination.page = page
+            this.getTickets()
+        },
+
+        /**
+         * @description This action is used to sort the list of tickets.
+         * @param {String} column The column to sort the list of tickets
+         * @param {String} direction The direction to sort the list of tickets (asc or desc)
+         */
+        sort(column, direction){
+            this.getTickets(this.url.help('tickets').order(column, direction), false)
+        },
+
+        /**
+         * @description This action is used to fetch with search results.
+         * @param {String} string The string to search for.
+         */
+        search(string) {
+            this.pagination.page = 1
+            this.getTickets(this.url.help('tickets').search(string))
+        }
+    }
+})
+

data/lib/vue/stores/translations.json

@@ -0,0 +1,56 @@
+{
+  "en": {
+    "lesli": {
+      "shared": {
+        "button_add_new": "Add new",
+        "button_delete": "Delete",
+        "button_edit": "Edit",
+        "button_list": "List",
+        "button_reload": "Reload",
+        "button_save": "Save",
+        "view_discussions": "Discussions",
+        "view_files": "Files",
+        "view_quick_actions": "Quick actions"
+      }
+    },
+    "lesli_help": {
+      "tickets": {
+        "column_creator": "Creator",
+        "column_deadline": "Deadline",
+        "column_description": "Description",
+        "column_id": "ID",
+        "column_subject": "Subject",
+        "tab_assignments": "Assignments",
+        "tab_general_information": "General Information",
+        "view_new_ticket_title": "Add new ticket"
+      }
+    }
+  },
+  "es": {
+    "lesli": {
+      "shared": {
+        "button_add_new": "Agregar nuevo",
+        "button_delete": "Eliminar",
+        "button_edit": "Editar",
+        "button_list": "Lista",
+        "button_reload": "Recargar",
+        "button_save": "Guardar",
+        "view_discussions": "Discusiones",
+        "view_files": "Archivos",
+        "view_quick_actions": "Acciones rapidas"
+      }
+    },
+    "lesli_help": {
+      "tickets": {
+        "column_creator": "Creador",
+        "column_deadline": "Fecha limite",
+        "column_description": "Descripcion",
+        "column_id": "ID",
+        "column_subject": "Asunto",
+        "tab_assignments": "Asignaciones",
+        "tab_general_information": "Informacion general",
+        "view_new_ticket_title": "Agregar nuevo ticket"
+      }
+    }
+  }
+}

data/readme.md

@@ -0,0 +1,71 @@
+<p align="center">
+	<img width="90" alt="LesliHelp logo" src="./app/assets/images/lesli_help/help-logo.svg" />
+    <h3 align="center">Support Ticket System for the Lesli Framework</h3>
+</p>
+
+<hr/>
+    <p align="center">
+        <a target="blank" href="https://rubygems.org/gems/lesli_help">
+            <img src="https://badge.fury.io/rb/lesli_help.svg" alt="Gem Version" height="22">
+        </a>
+    </p>
+<hr/>
+
+### Quick start
+
+```shell
+# Add LesliHelp engine
+bundle add lesli_help
+```
+
+```shell
+# Setup database
+rake lesli:db:setup
+```
+
+```ruby
+# Load LesliHelp
+Rails.application.routes.draw do
+    mount LesliHelp::Engine => "/help"
+end
+```
+
+
+### Documentation
+* [website](https://www.lesli.dev/help/)
+* [database](./docs/database.md)
+* [documentation](https://www.lesli.dev/documentation/)
+
+
+### Get in touch with Lesli
+
+* [Website: https://www.lesli.tech](https://www.lesli.tech)
+* [Email: hello@lesli.tech](hello@lesli.tech)
+* [Twitter: @LesliTech](https://twitter.com/LesliTech)
+
+
+### License
+-------
+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/.
+
+<hr />
+<br />
+
+<p align="center">
+    <img width="200" alt="Lesli logo" src="https://cdn.lesli.tech/lesli/brand/app-logo.svg" />
+    <h4 align="center">Ruby on Rails SaaS Development Framework.</h4>
+</p>
+