decidim-meetings 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39894c2619566b1e6edb7066ce232d67992977b8
-  data.tar.gz: 0c22115192bbebce486f62ed52c472ac2c4ba62e
+  metadata.gz: 9e7160d0be17585b556a03804913803d2ed3b9e7
+  data.tar.gz: 1f8c5494980d01e5d646f6a84730334939039713
 SHA512:
-  metadata.gz: 2f43e4fed756141d8f16df5c851bfd4aa2d98aef0f4c7634f013a53a4e840ce1d72b4de2cb704c5186c02eec2dceaa0b76b59c61c08e75e13ba1bc347e33a486
-  data.tar.gz: 101f5948eb1989143a00d37783cdfa5f816cfb0bbb1ed08d902a772e33c09856c8260fed76e6e3d924aa10584a415ff01940c3e19d236cba45810915f3c6f90c
+  metadata.gz: 125da4f22f176a4bbe38ada17bb653f4547932942e489c3f62d0f3daaea9138f8190fb06a70ad9bd9d294b01d29479ee3d52652961e9a906fa5702b21d70f942
+  data.tar.gz: 7b607173e486d993930b11678f1515b2125d6d0a49c0079ac5ca9297f013fd52d4792dc944ad3411424e814836ad0a0cecb8b88ef847be5e3490af16043d37de

data/app/assets/config/admin/decidim_meetings_manifest.js

@@ -0,0 +1 @@
+//= link decidim/meetings/admin/registrations_form.js

data/app/assets/images/decidim/meetings/icon.svg

@@ -1 +1,5 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36.02 36.02"><path d="M693.07,543.84a18,18,0,1,1,18-18A18,18,0,0,1,693.07,543.84Zm0-34a16,16,0,1,0,16,16A16,16,0,0,0,693.07,509.83Z" transform="translate(-675.07 -507.83)"/><path d="M693.07,526.93a4.1,4.1,0,1,1,4.1-4.1A4.1,4.1,0,0,1,693.07,526.93Zm0-6.19a2.1,2.1,0,1,0,2.1,2.1A2.1,2.1,0,0,0,693.07,520.74Z" transform="translate(-675.07 -507.83)"/><path d="M693.07,536.65a1,1,0,0,1-.67-0.26c-0.29-.26-7.11-6.5-7.11-14a7.78,7.78,0,0,1,15.57,0c0,7.46-6.82,13.71-7.11,14A1,1,0,0,1,693.07,536.65Zm0-20a5.79,5.79,0,0,0-5.78,5.78c0,5.29,4.13,10.11,5.78,11.82,1.65-1.72,5.78-6.54,5.78-11.82A5.79,5.79,0,0,0,693.07,516.64Z" transform="translate(-675.07 -507.83)"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36.02 36.02">
+  <path d="M693.07,543.84a18,18,0,1,1,18-18A18,18,0,0,1,693.07,543.84Zm0-34a16,16,0,1,0,16,16A16,16,0,0,0,693.07,509.83Z" transform="translate(-675.07 -507.83)"/>
+  <path d="M693.07,526.93a4.1,4.1,0,1,1,4.1-4.1A4.1,4.1,0,0,1,693.07,526.93Zm0-6.19a2.1,2.1,0,1,0,2.1,2.1A2.1,2.1,0,0,0,693.07,520.74Z" transform="translate(-675.07 -507.83)"/>
+  <path d="M693.07,536.65a1,1,0,0,1-.67-0.26c-0.29-.26-7.11-6.5-7.11-14a7.78,7.78,0,0,1,15.57,0c0,7.46-6.82,13.71-7.11,14A1,1,0,0,1,693.07,536.65Zm0-20a5.79,5.79,0,0,0-5.78,5.78c0,5.29,4.13,10.11,5.78,11.82,1.65-1.72,5.78-6.54,5.78-11.82A5.79,5.79,0,0,0,693.07,516.64Z" transform="translate(-675.07 -507.83)"/>
+</svg>

data/app/assets/javascripts/decidim/meetings/admin/registrations_form.js.es6

@@ -0,0 +1,21 @@
+$(() => {
+  const $form = $('.edit_meeting_registrations');
+
+  if ($form.length > 0) {
+    const $registrationsEnabled = $form.find('#meeting_registrations_enabled');
+    const $availableSlots = $form.find('#meeting_available_slots');
+
+    const toggleDisabledFields = () => {
+      const enabled = $registrationsEnabled.prop('checked');
+      $availableSlots.attr('disabled', !enabled);
+
+      $form.find('.editor-container').each((idx, node) => {
+        const quill = Quill.find(node);
+        quill.enable(enabled);
+      })
+    };
+
+    $registrationsEnabled.on('change', toggleDisabledFields);
+    toggleDisabledFields();
+  }
+});

data/app/commands/decidim/meetings/admin/close_meeting.rb

@@ -19,7 +19,7 @@ module Decidim
         #
         # Broadcasts :ok if successful, :invalid otherwise.
         def call
-          return broadcast(:invalid) if @form.invalid?
+          return broadcast(:invalid) if form.invalid?
 
           transaction do
             close_meeting
@@ -31,22 +31,30 @@ module Decidim
 
         private
 
+        attr_reader :form, :meeting
+
         def close_meeting
-          @meeting.update_attributes!(
-            closing_report: @form.closing_report,
-            attendees_count: @form.attendees_count,
-            contributions_count: @form.contributions_count,
-            attending_organizations: @form.attending_organizations,
-            closed_at: @form.closed_at
+          meeting.update_attributes!(
+            closing_report: form.closing_report,
+            attendees_count: form.attendees_count,
+            contributions_count: form.contributions_count,
+            attending_organizations: form.attending_organizations,
+            closed_at: form.closed_at
+          )
+          Decidim::EventsManager.publish(
+            event: "decidim.events.meetings.meeting_closed",
+            event_class: Decidim::Meetings::CloseMeetingEvent,
+            resource: meeting,
+            recipient_ids: meeting.followers.pluck(:id)
           )
         end
 
         def proposals
-          @meeting.sibling_scope(:proposals).where(id: @form.proposal_ids)
+          meeting.sibling_scope(:proposals).where(id: @form.proposal_ids)
         end
 
         def link_proposals
-          @meeting.link_resources(proposals, "proposals_from_meeting")
+          meeting.link_resources(proposals, "proposals_from_meeting")
         end
       end
     end

data/app/commands/decidim/meetings/admin/create_meeting.rb

@@ -16,7 +16,11 @@ module Decidim
         def call
           return broadcast(:invalid) if @form.invalid?
 
-          create_meeting!
+          transaction do
+            create_meeting!
+            schedule_upcoming_meeting_notification
+          end
+
           broadcast(:ok, @meeting)
         end
 
@@ -38,6 +42,14 @@ module Decidim
             feature: @form.current_feature
           )
         end
+
+        def schedule_upcoming_meeting_notification
+          checksum = Decidim::Meetings::UpcomingMeetingNotificationJob.generate_checksum(@meeting)
+
+          Decidim::Meetings::UpcomingMeetingNotificationJob
+            .set(wait_until: @meeting.start_time - 2.days)
+            .perform_later(@meeting.id, checksum)
+        end
       end
     end
   end

data/app/commands/decidim/meetings/admin/update_meeting.rb

@@ -19,38 +19,64 @@ module Decidim
         #
         # Broadcasts :ok if successful, :invalid otherwise.
         def call
-          return broadcast(:invalid) if @form.invalid?
+          return broadcast(:invalid) if form.invalid?
 
-          update_meeting!
-          broadcast(:ok, @meeting)
+          transaction do
+            update_meeting!
+            send_notification if should_notify_followers?
+            schedule_upcoming_meeting_notification if start_time_changed?
+          end
+
+          broadcast(:ok, meeting)
         end
 
         private
 
+        attr_reader :form, :meeting
+
         def update_meeting!
-          @meeting.update_attributes!(
-            scope: @form.scope,
-            category: @form.category,
-            title: @form.title,
-            description: @form.description,
-            end_time: @form.end_time,
-            start_time: @form.start_time,
-            address: @form.address,
-            latitude: @form.latitude,
-            longitude: @form.longitude,
-            location: @form.location,
-            location_hints: @form.location_hints
+          meeting.update_attributes!(
+            scope: form.scope,
+            category: form.category,
+            title: form.title,
+            description: form.description,
+            end_time: form.end_time,
+            start_time: form.start_time,
+            address: form.address,
+            latitude: form.latitude,
+            longitude: form.longitude,
+            location: form.location,
+            location_hints: form.location_hints
+          )
+        end
+
+        def send_notification
+          Decidim::EventsManager.publish(
+            event: "decidim.events.meetings.meeting_updated",
+            event_class: Decidim::Meetings::UpdateMeetingEvent,
+            resource: meeting,
+            recipient_ids: meeting.followers.pluck(:id)
           )
         end
 
-        def geocode_meeting
-          result = @meeting.geocode
-          @form.errors.add :address, :invalid unless result
-          result
+        def should_notify_followers?
+          important_attributes.any? { |attr| meeting.previous_changes[attr].present? }
         end
 
-        def update_meeting
-          @meeting.save!
+        def important_attributes
+          %w(start_time end_time address)
+        end
+
+        def start_time_changed?
+          meeting.previous_changes["start_time"].present?
+        end
+
+        def schedule_upcoming_meeting_notification
+          checksum = Decidim::Meetings::UpcomingMeetingNotificationJob.generate_checksum(meeting)
+
+          Decidim::Meetings::UpcomingMeetingNotificationJob
+            .set(wait_until: meeting.start_time - 2.days)
+            .perform_later(meeting.id, checksum)
         end
       end
     end

data/app/commands/decidim/meetings/admin/update_registrations.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    module Admin
+      # This command is executed when the user updates the meeting registrations.
+      class UpdateRegistrations < Rectify::Command
+        # Initializes a UpdateRegistrations Command.
+        #
+        # form - The form from which to get the data.
+        # meeting - The current instance of the meeting to be updated.
+        def initialize(form, meeting)
+          @form = form
+          @meeting = meeting
+        end
+
+        # Updates the meeting if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          meeting.with_lock do
+            return broadcast(:invalid) if form.invalid?
+            update_meeting_registrations
+            send_notification if should_notify_followers?
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form, :meeting
+
+        def update_meeting_registrations
+          meeting.registrations_enabled = form.registrations_enabled
+
+          if form.registrations_enabled
+            meeting.available_slots = form.available_slots
+            meeting.registration_terms = form.registration_terms
+          end
+
+          meeting.save!
+        end
+
+        def send_notification
+          Decidim::EventsManager.publish(
+            event: "decidim.events.meetings.registrations_enabled",
+            event_class: Decidim::Meetings::MeetingRegistrationsEnabledEvent,
+            resource: meeting,
+            recipient_ids: meeting.followers.pluck(:id)
+          )
+        end
+
+        def should_notify_followers?
+          meeting.previous_changes["registrations_enabled"].present? && meeting.registrations_enabled?
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/meetings/join_meeting.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    # This command is executed when the user joins a meeting.
+    class JoinMeeting < Rectify::Command
+      # Initializes a JoinMeeting Command.
+      #
+      # meeting - The current instance of the meeting to be joined.
+      # user - The user joining the meeting.
+      def initialize(meeting, user)
+        @meeting = meeting
+        @user = user
+      end
+
+      # Creates a meeting registration if the meeting has registrations enabled
+      # and there are available slots.
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        meeting.with_lock do
+          return broadcast(:invalid) unless can_join_meeting?
+          create_registration
+          send_email_confirmation
+          send_notification
+        end
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :meeting, :user
+
+      def create_registration
+        Decidim::Meetings::Registration.create!(meeting: meeting, user: user)
+      end
+
+      def can_join_meeting?
+        meeting.registrations_enabled? && meeting.has_available_slots?
+      end
+
+      def send_email_confirmation
+        RegistrationMailer.confirmation(user, meeting).deliver_later
+      end
+
+      def participatory_space_admins
+        @meeting.feature.participatory_space.admins
+      end
+
+      def send_notification
+        return send_notification_over(0.5) if occupied_slots_over?(0.5)
+        return send_notification_over(0.8) if occupied_slots_over?(0.8)
+        send_notification_over(1.0) if occupied_slots_over?(1.0)
+      end
+
+      def send_notification_over(percentage)
+        Decidim::EventsManager.publish(
+          event: "decidim.events.meetings.meeting_registrations_over_percentage",
+          event_class: Decidim::Meetings::MeetingRegistrationsOverPercentageEvent,
+          resource: @meeting,
+          recipient_ids: participatory_space_admins.pluck(:id),
+          extra: {
+            percentage: percentage
+          }
+        )
+      end
+
+      def occupied_slots_over?(percentage)
+        @meeting.remaining_slots == (@meeting.available_slots * (1 - percentage)).round
+      end
+    end
+  end
+end

data/app/commands/decidim/meetings/leave_meeting.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    # This command is executed when the user leaves a meeting.
+    class LeaveMeeting < Rectify::Command
+      # Initializes a LeaveMeeting Command.
+      #
+      # meeting - The current instance of the meeting to be left.
+      # user - The user leaving the meeting.
+      def initialize(meeting, user)
+        @meeting = meeting
+        @user = user
+      end
+
+      # Destroys a meeting registration if the meeting has registrations enabled
+      # and the registration exists.
+      #
+      # Broadcasts :ok if successful, :invalid otherwise.
+      def call
+        @meeting.with_lock do
+          return broadcast(:invalid) unless registration
+          destroy_registration
+        end
+        broadcast(:ok)
+      end
+
+      private
+
+      def registration
+        @registration ||= Decidim::Meetings::Registration.where(meeting: @meeting, user: @user).first
+      end
+
+      def destroy_registration
+        registration.destroy!
+      end
+    end
+  end
+end

data/app/controllers/decidim/meetings/admin/registrations_controller.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    module Admin
+      # This controller allows an admin to manage meeting registrations from a Participatory Process
+      class RegistrationsController < Admin::ApplicationController
+        def edit
+          @form = MeetingRegistrationsForm.from_model(meeting)
+        end
+
+        def update
+          @form = MeetingRegistrationsForm.from_params(params).with_context(current_organization: meeting.organization, meeting: meeting)
+
+          UpdateRegistrations.call(@form, meeting) do
+            on(:ok) do
+              flash[:notice] = I18n.t("registrations.update.success", scope: "decidim.meetings.admin")
+              redirect_to meetings_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("registrations.update.invalid", scope: "decidim.meetings.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def export
+          format = params[:format]
+          export_data = Decidim::Exporters.find_exporter(format).new(meeting.registrations, Decidim::Meetings::RegistrationSerializer).export
+
+          send_data export_data.read, type: "text/#{format}", filename: export_data.filename("registrations")
+        end
+
+        private
+
+        def meeting
+          @meeting ||= Meeting.where(feature: current_feature).find(params[:meeting_id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/meetings/registrations_controller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    # Exposes the registration resource so users can join and leave meetings.
+    class RegistrationsController < Decidim::Meetings::ApplicationController
+      def create
+        authorize! :join, meeting
+
+        JoinMeeting.call(meeting, current_user) do
+          on(:ok) do
+            flash[:notice] = I18n.t("registrations.create.success", scope: "decidim.meetings")
+            redirect_to meeting_path(meeting)
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("registrations.create.invalid", scope: "decidim.meetings")
+            redirect_to meeting_path(meeting)
+          end
+        end
+      end
+
+      def destroy
+        authorize! :leave, meeting
+
+        LeaveMeeting.call(meeting, current_user) do
+          on(:ok) do
+            flash[:notice] = I18n.t("registrations.destroy.success", scope: "decidim.meetings")
+            redirect_to meeting_path(meeting)
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("registrations.destroy.invalid", scope: "decidim.meetings")
+            redirect_to meeting_path(meeting)
+          end
+        end
+      end
+
+      private
+
+      def meeting
+        @meeting ||= Meeting.where(feature: current_feature).find(params[:meeting_id])
+      end
+    end
+  end
+end

data/app/events/decidim/meetings/close_meeting_event.rb

@@ -0,0 +1,30 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Meetings
+    class CloseMeetingEvent < Decidim::Events::BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      def email_subject
+        I18n.t("decidim.meetings.events.close_meeting_event.email_subject", resource_title: resource_title)
+      end
+
+      def email_intro
+        I18n.t("decidim.meetings.events.close_meeting_event.email_intro", resource_title: resource_title)
+      end
+
+      def email_outro
+        I18n.t("decidim.meetings.events.close_meeting_event.email_outro", resource_title: resource_title)
+      end
+
+      def notification_title
+        I18n.t(
+          "decidim.meetings.events.close_meeting_event.notification_title",
+          resource_title: resource_title,
+          resource_path: resource_path
+        ).html_safe
+      end
+    end
+  end
+end

data/app/events/decidim/meetings/meeting_registrations_enabled_event.rb

@@ -0,0 +1,39 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Meetings
+    class MeetingRegistrationsEnabledEvent < Decidim::Events::BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      def email_subject
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_enabled.email_subject",
+          resource_title: resource_title
+        )
+      end
+
+      def email_intro
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_enabled.email_intro",
+          resource_title: resource_title
+        )
+      end
+
+      def email_outro
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_enabled.email_outro",
+          resource_title: resource_title
+        )
+      end
+
+      def notification_title
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_enabled.notification_title",
+          resource_title: resource_title,
+          resource_path: resource_path
+        ).html_safe
+      end
+    end
+  end
+end

data/app/events/decidim/meetings/meeting_registrations_over_percentage_event.rb

@@ -0,0 +1,43 @@
+# frozen-string_literal: true
+
+module Decidim
+  module Meetings
+    class MeetingRegistrationsOverPercentageEvent < Decidim::Events::BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      def email_subject
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_over_percentage.email_subject",
+          resource_title: resource_title,
+          percentage: extra["percentage"] * 100
+        )
+      end
+
+      def email_intro
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_over_percentage.email_intro",
+          resource_title: resource_title,
+          percentage: extra["percentage"] * 100
+        )
+      end
+
+      def email_outro
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_over_percentage.email_outro",
+          resource_title: resource_title,
+          percentage: extra["percentage"] * 100
+        )
+      end
+
+      def notification_title
+        I18n.t(
+          "decidim.meetings.events.meeting_registrations_over_percentage.notification_title",
+          resource_title: resource_title,
+          resource_path: resource_path,
+          percentage: extra["percentage"] * 100
+        ).html_safe
+      end
+    end
+  end
+end

data/app/events/decidim/meetings/upcoming_meeting_event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    class UpcomingMeetingEvent < Decidim::Events::BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      def email_subject
+        I18n.t("decidim.meetings.events.upcoming_meeting_event.email_subject", resource_title: resource_title)
+      end
+
+      def email_intro
+        I18n.t("decidim.meetings.events.upcoming_meeting_event.email_intro", resource_title: resource_title)
+      end
+
+      def email_outro
+        I18n.t("decidim.meetings.events.upcoming_meeting_event.email_outro", resource_title: resource_title)
+      end
+
+      def notification_title
+        I18n.t(
+          "decidim.meetings.events.upcoming_meeting_event.notification_title",
+          resource_title: resource_title,
+          resource_path: resource_path
+        ).html_safe
+      end
+    end
+  end
+end

data/app/events/decidim/meetings/update_meeting_event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Meetings
+    class UpdateMeetingEvent < Decidim::Events::BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      def email_subject
+        I18n.t("decidim.meetings.events.update_meeting_event.email_subject", resource_title: resource_title)
+      end
+
+      def email_intro
+        I18n.t("decidim.meetings.events.update_meeting_event.email_intro", resource_title: resource_title)
+      end
+
+      def email_outro
+        I18n.t("decidim.meetings.events.update_meeting_event.email_outro", resource_title: resource_title)
+      end
+
+      def notification_title
+        I18n.t(
+          "decidim.meetings.events.update_meeting_event.notification_title",
+          resource_title: resource_title,
+          resource_path: resource_path
+        ).html_safe
+      end
+    end
+  end
+end

data/app/forms/decidim/meetings/admin/meeting_form.rb

@@ -38,7 +38,7 @@ module Decidim
         end
 
         def process_scope
-          current_feature.participatory_process.scope
+          current_feature.participatory_space.scope
         end
 
         alias feature current_feature