decidim-notify 0.3

data/app/commands/decidim/notify/delete_note.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    class DeleteNote < Rectify::Command
+      # Public: Initializes the command.
+      #
+      def initialize(id)
+        @id = id
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        note = Note.for(current_component).find(@id)
+        note.destroy!
+
+        broadcast(:ok)
+      rescue ActiveRecord::ActiveRecordError => e
+        broadcast(:invalid, e.message)
+      end
+    end
+  end
+end

data/app/commands/decidim/notify/update_chapter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    class UpdateChapter < Admin::UpdateChapter
+      # Public: Initializes the command.
+      #
+      # form - A config form
+      def initialize(form)
+        @form = form
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        begin
+          @chapter = Chapter.find(form.id)
+
+          unset_actives
+          update_chapter!
+
+          broadcast(:ok, @chapter)
+        rescue ActiveRecord::ActiveRecordError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/notify/update_note.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    class UpdateNote < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A config form
+      def initialize(form)
+        @form = form
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        begin
+          note = Note.find(form.id)
+          note.author = Author.find_by(code: form.code, component: current_component)&.user
+          note.body = form.body
+          note.creator = current_user unless note.creator
+          note.chapter = create_chapter
+          note.save!
+
+          broadcast(:ok, note, @new_chapter)
+        rescue ActiveRecord::ActiveRecordError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+
+      private
+
+      attr_reader :form
+
+      def create_chapter
+        return nil if form.chapter.blank?
+
+        chapter = Chapter.find_or_initialize_by(title: form.chapter, component: current_component)
+        @new_chapter = chapter unless chapter.id
+        chapter.title = form.chapter
+        chapter.save!
+        chapter
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/notify/broadcasts.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Notify
+    module Broadcasts
+      extend ActiveSupport::Concern
+
+      included do
+        def broadcast_create_note(note)
+          html = render_to_string(partial: "decidim/notify/conversations/note", locals: { note: note })
+          Decidim::Notify.server.broadcast("notify-notes-#{current_component.id}", create: html, chapterId: note.chapter&.id)
+        end
+
+        def broadcast_update_note(note)
+          html = render_to_string(partial: "decidim/notify/conversations/note", locals: { note: note })
+          Decidim::Notify.server.broadcast("notify-notes-#{current_component.id}", id: note.id, update: html, chapterId: note.chapter&.id)
+        end
+
+        def broadcast_destroy_note(id)
+          Decidim::Notify.server.broadcast("notify-notes-#{current_component.id}", destroy: id)
+        end
+
+        def broadcast_participants(participants)
+          view1 = render_to_string(partial: "decidim/notify/conversations/participant", collection: participants.select(&:admin))
+          view2 = render_to_string(partial: "decidim/notify/conversations/participant", collection: participants.reject(&:admin))
+          Decidim::Notify.server.broadcast("notify-participants-#{current_component.id}", noteTakers: view1, participants: view2)
+        end
+
+        def broadcast_create_chapter(chapter)
+          data = {
+            id: chapter.id,
+            title: chapter.title,
+            create: render_to_string(partial: "decidim/notify/conversations/chapter",
+                                     locals: { chapter: OpenStruct.new(title: chapter.title, id: chapter.id, component: chapter.component) })
+          }
+          Decidim::Notify.server.broadcast("notify-chapters-#{current_component.id}", data)
+        end
+
+        def broadcast_update_chapter(chapter)
+          data = {
+            id: chapter.id,
+            active: chapter.active,
+            update: chapter.title
+          }
+          Decidim::Notify.server.broadcast("notify-chapters-#{current_component.id}", data)
+        end
+
+        def broadcast_destroy_chapter(id)
+          Decidim::Notify.server.broadcast("notify-chapters-#{current_component.id}", destroy: id)
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/notify/needs_ajax_rescue.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Notify
+    module NeedsAjaxRescue
+      extend ActiveSupport::Concern
+
+      included do
+        class ::Decidim::ActionForbidden < StandardError
+        end
+
+        rescue_from ::Decidim::ActionForbidden, with: :user_has_no_permission
+
+        # Overrides original user permissions handling to take into account ajax
+        def user_has_no_permission
+          return super unless request.xhr?
+
+          render plain: t("actions.unauthorized", scope: "decidim.core"), status: :forbidden
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/admin/application_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+        def permission_class_chain
+          [::Decidim::Notify::Admin::Permissions] + super
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/admin/chapters_controller.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    module Admin
+      class ChaptersController < Admin::ApplicationController
+        include Broadcasts
+
+        helper_method :chapters
+
+        def new
+          enforce_permission_to :create, :chapter
+          @form = form(ChapterForm).instance
+        end
+
+        def create
+          enforce_permission_to :create, :chapter
+
+          @form = form(ChapterForm).from_params(params)
+
+          CreateChapter.call(@form) do
+            on(:ok) do |chapter|
+              flash[:notice] = I18n.t("chapters.create.success", scope: "decidim.notify.admin")
+
+              broadcast_create_chapter chapter
+              redirect_to EngineRouter.admin_proxy(current_component).chapters_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("chapters.create.error", scope: "decidim.notify.admin")
+              render :new
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :chapter, chapter: current_chapter
+          @form = form(ChapterForm).from_model(current_chapter)
+        end
+
+        def update
+          enforce_permission_to :update, :chapter, chapter: current_chapter
+          @form = form(ChapterForm).from_params(params)
+
+          UpdateChapter.call(@form, current_chapter) do
+            on(:ok) do
+              flash[:notice] = I18n.t("chapters.update.success", scope: "decidim.notify.admin")
+
+              broadcast_update_chapter current_chapter
+              redirect_to EngineRouter.admin_proxy(current_component).chapters_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("chapters.update.error", scope: "decidim.notify.admin")
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :chapter, chapter: current_chapter
+
+          DestroyChapter.call(current_chapter) do
+            on(:ok) do
+              flash[:notice] = I18n.t("chapters.destroy.success", scope: "decidim.notify.admin")
+
+              broadcast_destroy_chapter params[:id]
+              redirect_to EngineRouter.admin_proxy(current_component).chapters_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("chapters.destroy.error", scope: "decidim.notify.admin")
+              redirect_to EngineRouter.admin_proxy(current_component).chapters_path
+            end
+          end
+        end
+
+        private
+
+        def chapters
+          Chapter.for(current_component)
+        end
+
+        def current_chapter
+          @current_chapter ||= Chapter.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/admin/conversations_controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    module Admin
+      class ConversationsController < Admin::ApplicationController
+        include NeedsAjaxRescue
+        include Broadcasts
+
+        def index
+          enforce_permission_to :index, :config
+
+          @users = Author.for(current_component).map { |user| OpenStruct.new(text: format_user_name(user), id: user.decidim_user_id) }
+          @note_takers = Author.for(current_component).note_takers.map { |user| OpenStruct.new(text: format_user_name(user), id: user.decidim_user_id) }
+          @form = form(NotifyConfigForm).from_params(current_component.attributes["settings"]["global"])
+        end
+
+        def create
+          enforce_permission_to :update, :config
+
+          @form = form(NotifyConfigForm).from_params(params)
+          UpdateConfig.call(@form) do
+            on(:ok) do |participants|
+              flash[:notice] = I18n.t("decidim.notify.admin.conversations.success")
+              broadcast_participants participants
+            end
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("decidim.notify.admin.conversations.error", message: message)
+            end
+          end
+          redirect_to EngineRouter.admin_proxy(current_component).conversations_path
+        end
+
+        def users
+          enforce_permission_to :update, :config
+
+          respond_to do |format|
+            format.json do
+              if (term = params[:term].to_s).present?
+                query = current_organization.users.order(name: :asc)
+                query = query.where("name ILIKE :term OR nickname ILIKE :term OR email ILIKE :term", term: "%#{term}%")
+
+                render json: query.all.collect { |u| { id: u.id, text: format_user_name(u) } }
+              else
+                render json: []
+              end
+            end
+          end
+        end
+
+        private
+
+        def format_user_name(user)
+          text = "#{user.name} (@#{user.nickname})"
+          text = "<b>#{user.code}</b> - #{text}" if defined? user.code
+          text
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/application_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+      def permission_class_chain
+        [::Decidim::Notify::Permissions] + super
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/chapters_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    class ChaptersController < Decidim::Notify::ApplicationController
+      include FormFactory
+      include NeedsAjaxRescue
+      include Broadcasts
+
+      def update
+        enforce_permission_to :create, :chapter
+
+        @form = form(ChapterForm).from_params(params)
+        UpdateChapter.call(@form) do
+          on(:ok) do |chapter, _old_title|
+            broadcast_update_chapter chapter
+
+            render json: { message: "✔" }
+          end
+          on(:invalid) do |message|
+            render json: { message: t("update.error", scope: "decidim.notify.chapter", message: message) }, status: :unprocessable_entity
+          end
+        end
+      end
+
+      def destroy
+        enforce_permission_to :destroy, :chapter
+
+        DeleteChapter.call(params[:id]) do
+          on(:ok) do
+            broadcast_destroy_chapter params[:id]
+            render json: { message: "✔" }
+          end
+          on(:invalid) do |message|
+            render json: { message: t("destroy.error", scope: "decidim.notify.chapter", message: message) }, status: :unprocessable_entity
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/notify/conversations_controller.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    class ConversationsController < Decidim::Notify::ApplicationController
+      include FormFactory
+      include NeedsAjaxRescue
+      include Broadcasts
+
+      helper_method :chapters, :active_chapter
+
+      def index
+        return render :private unless allowed_to? :index, :notes
+
+        @unclassified = Chapter.new(notes: unclassified_notes)
+        @participants = Author.for(current_component).participants
+        @note_takers = Author.for(current_component).note_takers
+        @form = form(NoteForm).instance
+      end
+
+      def create
+        enforce_permission_to :create, :notes
+
+        @form = form(NoteForm).from_params(params)
+        CreateNote.call(@form) do
+          on(:ok) do |note, new_chapter|
+            broadcast_create_chapter new_chapter if new_chapter
+            broadcast_create_note note
+
+            render json: { message: "✔" }
+          end
+          on(:invalid) do |message|
+            render json: { message: I18n.t("decidim.notify.conversations.create.error", message: message) }, status: :unprocessable_entity
+          end
+        end
+      end
+
+      def update
+        enforce_permission_to :update, :notes
+
+        @form = form(NoteForm).from_params(params)
+        UpdateNote.call(@form) do
+          on(:ok) do |note, new_chapter|
+            broadcast_create_chapter new_chapter if new_chapter
+            broadcast_update_note note
+
+            render json: { message: "✔" }
+          end
+          on(:invalid) do |message|
+            render json: { message: I18n.t("decidim.notify.conversations.update.error", message: message) }, status: :unprocessable_entity
+          end
+        end
+      end
+
+      def destroy
+        enforce_permission_to :destroy, :notes
+
+        DeleteNote.call(params[:id]) do
+          on(:ok) do
+            broadcast_destroy_note params[:id]
+            render json: { message: "✔" }
+          end
+          on(:invalid) do |message|
+            render json: { message: I18n.t("decidim.notify.conversations.destroy.error", message: message) }, status: :unprocessable_entity
+          end
+        end
+      end
+
+      def users
+        enforce_permission_to :create, :notes
+
+        respond_to do |format|
+          format.json do
+            if (term = params[:term].to_s).present?
+              query = Author.for(current_component).joins(:user)
+              query = query.where("decidim_notify_authors.code=:code OR decidim_users.name ILIKE :term OR decidim_users.nickname ILIKE :term", code: term.to_i, term: "%#{term}%")
+
+              render json: query.all.collect { |u| { id: u.code, name: u.name, avatar: u&.avatar_url, nickname: u.nickname, text: format_user_name(u) } }
+            else
+              render json: []
+            end
+          end
+        end
+      end
+
+      private
+
+      def chapters
+        @chapters ||= Chapter.for(current_component).all
+      end
+
+      def active_chapter
+        chapters.find(&:active)
+      end
+
+      def unclassified_notes
+        @unclassified_notes ||= Note.for(current_component).unclassified
+      end
+
+      def format_user_name(user)
+        "#{user.name} (@#{user.nickname})"
+      end
+    end
+  end
+end