decidim-initiatives 0.30.2 → 0.31.0.rc1

data/lib/decidim/initiatives/engine.rb

@@ -22,6 +22,7 @@ module Decidim
 
         resources :create_initiative do
           collection do
+            get :load_initiative_draft
             get :select_initiative_type
             put :select_initiative_type, to: "create_initiative#store_initiative_type"
             get :fill_data
@@ -60,6 +61,7 @@ module Decidim
             get :authorization_create_modal, to: "authorization_create_modals#show"
             get :print, to: "initiatives#print", as: "print"
             get :send_to_technical_validation, to: "initiatives#send_to_technical_validation"
+            delete :discard, to: "initiatives#discard"
           end
 
           resource :initiative_vote, only: [:create, :destroy]
@@ -99,6 +101,15 @@ module Decidim
         Decidim.icons.register(name: "forbid-line", icon: "forbid-line", category: "system", description: "", engine: :initiatives)
       end
 
+      initializer "decidim_initiatives.stats" do
+        Decidim.stats.register :initiatives_count,
+                               priority: StatsRegistry::HIGH_PRIORITY,
+                               icon_name: "lightbulb-flash-line",
+                               tooltip_key: "initiatives_count_tooltip" do |organization, _start_at, _end_at|
+          Decidim::Initiative.where(organization:).public_spaces.count
+        end
+      end
+
       initializer "decidim_initiatives.content_blocks" do
         Decidim::Initiatives::ContentBlocks::RegistryManager.register!
       end
@@ -118,20 +129,12 @@ module Decidim
         Decidim::Gamification.register_badge(:initiatives) do |badge|
           badge.levels = [1, 5, 15, 30, 50]
 
-          badge.valid_for = [:user, :user_group]
+          badge.valid_for = [:user]
 
           badge.reset = lambda { |model|
-            case model
-            when User
-              Decidim::Initiative.where(
-                author: model,
-                user_group: nil
-              ).published.count
-            when UserGroup
-              Decidim::Initiative.where(
-                user_group: model
-              ).published.count
-            end
+            Decidim::Initiative.where(
+              author: model
+            ).published.count
           }
         end
       end
@@ -140,7 +143,7 @@ module Decidim
         Decidim::Api::QueryType.include QueryExtensions
       end
 
-      initializer "decidim_initiatives.webpacker.assets_path" do
+      initializer "decidim_initiatives.shakapacker.assets_path" do
         Decidim.register_assets_path File.expand_path("app/packs", root)
       end
 
@@ -149,7 +152,7 @@ module Decidim
         # We need to make sure we call `Preview.all` before requiring our
         # previews, otherwise any previews the app attempts to add need to be
         # manually required.
-        if Rails.env.development? || Rails.env.test?
+        if Rails.env.local?
           ActionMailer::Preview.all
 
           Dir[root.join("spec/mailers/previews/**/*_preview.rb")].each do |file|

data/lib/decidim/initiatives/participatory_space.rb

@@ -32,7 +32,21 @@ Decidim.register_participatory_space(:initiatives) do |participatory_space|
 
   participatory_space.register_resource(:initiatives_type) do |resource|
     resource.model_class_name = "Decidim::InitiativesType"
-    resource.actions = %w(vote create)
+    resource.actions = %w(create)
+  end
+
+  participatory_space.register_stat :followers_count,
+                                    priority: Decidim::StatsRegistry::MEDIUM_PRIORITY,
+                                    icon_name: "user-follow-line",
+                                    tooltip_key: "followers_count_tooltip" do
+    Decidim::Initiatives::InitiativesStatsFollowersCount.for(participatory_space)
+  end
+
+  participatory_space.register_stat :participants_count,
+                                    priority: Decidim::StatsRegistry::MEDIUM_PRIORITY,
+                                    icon_name: "user-line",
+                                    tooltip_key: "participants_count_tooltip" do
+    Decidim::Initiatives::InitiativesStatsParticipantsCount.for(participatory_space)
   end
 
   participatory_space.model_class_name = "Decidim::Initiative"

data/lib/decidim/initiatives/seeds.rb

@@ -9,7 +9,7 @@ module Decidim
       def call
         create_content_block!
 
-        3.times do |_n|
+        number_of_records.times do |_n|
           type = create_initiative_type!
 
           organization.top_scopes.each do |scope|
@@ -19,7 +19,6 @@ module Decidim
 
         Decidim::Initiative.states.keys.each do |state|
           Decidim::Initiative.skip_callback(:save, :after, :notify_state_change, raise: false)
-          Decidim::Initiative.skip_callback(:create, :after, :notify_creation, raise: false)
 
           initiative = create_initiative!(state:)
 

data/lib/decidim/initiatives/signature_workflow_manifest.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+# require "decidim/settings_manifest"
+require "decidim/initiatives/default_signature_authorizer"
+
+module Decidim
+  module Initiatives
+    # This class serves as a DSL to declaratively specify a signature method.
+    #
+    # To define a direct signature method, you need to specify the `form`
+    # attribute as a `Decidim::Form` that will be valid if the signature
+    # process is valid. If no form is provided the application assumes that the
+    # form class is `Decidim::Initiatives::SignatureHandler`
+    #
+    # All the attributes except the name are optional. If no attributes are set
+    # there are default values for them and the signature flow will be direct
+    # without steps and metadata stored in the initiatives_vote
+    #
+    # Signature workflow attributes:
+    # - :form (String) (optional) The name of the form object class responsible
+    #     for collecting and validating the data to create the initiative votes.
+    #     This class should be inherited from
+    #     Decidim::Initiatives::SignatureHandler and can define a set of
+    #     attributes to collect user personal data. If extra attributes are
+    #     defined a collect personal data step will be enabled. This class also
+    #     can define an unique_id to avoid duplicated votes based on the
+    #     personal data and a metadata hash that will be encrypted in the vote
+    #     creation. The class can also collect a hash of metadata that will be
+    #     passed to an authorization handler if defined in the workflow. The
+    #     class is also responsible to define the scopes associated with the
+    #     votes. The main class by default detects the scopes candidates and
+    #     the inherited class can define a signature_scope_id based on the data
+    #     provided by the user.
+    #     (default: "Decidim::Initiatives::SignatureHandler")
+    # - :authorization_handler_form (String) (optional) If this authorization
+    #     handler class name is set the previous form will create and validate
+    #     an instance of it from the params defined in it (by default the
+    #     collected metadata and the user). If the authorization is invalid the
+    #     signature is blocked. (default: nil)
+    # - :save_authorizations (Boolean) (optional) This option allows the
+    #     workflow to save or update if already exist the authorization
+    #     associated to the previous authorization handler. Note that if this
+    #     option is set to false the user will be required to have been
+    #     previously authorized with the method associated to the authorization
+    #     handler. The authorization is searched by the organization, the user
+    #     and the authorization handler name. If this class is not defined,
+    #     class Decidim::Initiatives::DefaultSignatureAuthorizer is used,
+    #     which inherits from Decidim::Verifications::DefaultActionAuthorizer
+    #     and checks the authorization status. (default: true)
+    # - :ephemeral (Boolean) (optional) This option enables the possibility for
+    #     users to sign without prior registration through an ephemeral session.
+    #     To allow ephemeral sessions to be recovered o transferred to regular
+    #     users authorizations must be stored in the process so an
+    #     authorization_handler_form must be defined and the save_authorizations
+    #     option must not be set to false. If those settings are not properly
+    #     configured this option will be ignored and the workflow will not
+    #     allow ephemeral sessions. (default: false)
+    # - :promote_authorization_validation_errors (Boolean) (optional) If set
+    #     to true, errors in the personal data passed to the authorization
+    #     handler form will be displayed next to the corresponding fields
+    #     in the collection of personal data. Note that this option may provide
+    #     information about personal data to the user. (default: false)
+    # - :action_authorizer (String) This is the name of the action authorizer
+    #     class responsible for checking the status of the authorization
+    #     associated to the signature. If this class is not defined, the
+    #     authorization status will be ignored. You can define a handler
+    #     inherited from Decidim::Initiatives::DefaultSignatureAuthorizer which
+    #     inherits from Decidim::Verifications::DefaultActionAuthorizer and
+    #     checks the authorization status with an instance initialized only
+    #     with the authorization (without a component or a resource).
+    #     (default: nil)
+    # - :sms_verification (Boolean) (optional) This option enables an
+    #     additional SMS verification step. It uses by default the sms
+    #     verification flow defined in decidim_verifications and expects the
+    #     user to have previously created an SMS authorization validating
+    #     their phone number. This behaviour can be changed defining the
+    #     following attributes. (default: false)
+    # - :sms_mobile_phone_form_class (String) (optional) The name of the class
+    #     responsible for starting the users phone verification. It uses the
+    #     default form defined in decidim_initiatives.
+    #     (default: "Decidim::Verifications::Sms::MobilePhoneForm")
+    # - :sms_mobile_phone_validator (String) (optional) The name of the command
+    #     class responsible for checking if the mobile phone provided by the
+    #     user has an authorization associated to the sms_mobile_form_class
+    #     and delivering the sms code
+    #     (default: "Decidim::Initiatives::ValidateMobilePhone")
+    # - :sms_code_validator_class (String) (optional) The name of the command
+    #     class responsible for checking if the SMS code provided by the user
+    #     is valid. (default: "Decidim::Initiatives::ValidateSmsCode")
+    #
+    # An example of declaration of a workflow:
+    #
+    # Decidim::Initiatives::Signatures.register_workflow(:dummy_signature_handler) do |workflow|
+    #   workflow.form = "DummySignatureHandler"
+    #   workflow.authorization_handler_form = "DummyAuthorizationHandler"
+    #   workflow.action_authorizer = "DummySignatureHandler::DummySignatureActionAuthorizer"
+    #   workflow.promote_authorization_validation_errors = true
+    #   workflow.sms_verification = true
+    # end
+    #
+    class SignatureWorkflowManifest
+      include ActiveModel::Model
+      include Decidim::AttributeObject::Model
+
+      attribute :name, String
+      attribute :form, String
+      attribute :authorization_handler_form, String, default: nil
+      attribute :action_authorizer, String
+      attribute :save_authorizations, Boolean, default: true
+      attribute :promote_authorization_validation_errors, Boolean, default: false
+      attribute :ephemeral, Boolean, default: false
+      attribute :sms_verification, Boolean, default: false
+      attribute :sms_mobile_phone_form, String, default: nil
+      attribute :sms_mobile_phone_validator, String, default: nil
+      attribute :sms_code_validator, String, default: nil
+
+      validates :name, presence: true
+      validate :ephemeral_configuration
+
+      alias key name
+
+      def fullname
+        I18n.t("#{key}.name", scope: "decidim.signature_workflows", default: name.humanize)
+      end
+
+      def signature_form_class
+        form&.safe_constantize || Decidim::Initiatives::SignatureHandler
+      end
+
+      def action_authorizer_class
+        return if action_authorizer.blank?
+
+        action_authorizer.safe_constantize || DefaultSignatureAuthorizer
+      end
+
+      def authorization_handler_form_class
+        authorization_handler_form&.safe_constantize
+      end
+
+      # If no authorization handler is set or the save_authorizations option
+      # is disabled the workflow will not be able to save the user verification
+      # attributes necessary to recover the user session or transfer their
+      # activities
+      def ephemeral?
+        return if authorization_handler_form_class.blank? || !save_authorizations
+
+        ephemeral
+      end
+
+      def sms_mobile_phone_form_class
+        return unless sms_verification
+
+        sms_mobile_phone_form&.safe_constantize || Decidim::Verifications::Sms::MobilePhoneForm
+      end
+
+      def sms_mobile_phone_validator_class
+        return unless sms_verification
+
+        sms_mobile_phone_validator&.safe_constantize || Decidim::Initiatives::ValidateMobilePhone
+      end
+
+      def sms_code_validator_class
+        return unless sms_verification
+
+        sms_code_validator&.safe_constantize || Decidim::Initiatives::ValidateSmsCode
+      end
+
+      def ephemeral_configuration
+        return unless Rails.env.development?
+        return unless ephemeral
+
+        raise StandardError, "Wrong configuration of ephemeral signature workflow #{fullname}" if !save_authorizations || authorization_handler_form.blank?
+      end
+    end
+  end
+end

data/lib/decidim/initiatives/signatures.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    module Signatures
+      autoload :SignatureWorkflowManifest, "decidim/initiatives/signature_workflow_manifest"
+      include Decidim::HasWorkflows
+
+      def self.workflow_manifest_class = SignatureWorkflowManifest
+    end
+  end
+end

data/lib/decidim/initiatives/test/factories.rb

@@ -84,13 +84,17 @@ FactoryBot.define do
     end
 
     trait :with_user_extra_fields_collection do
-      collect_user_extra_fields { true }
       extra_fields_legal_information { generate_localized_description(:initiatives_type_extra_fields_legal_information, skip_injection:) }
-      document_number_authorization_handler { "dummy_authorization_handler" }
+      document_number_authorization_handler { "dummy_signature_with_personal_data_handler" }
     end
 
     trait :with_sms_code_validation do
-      validate_sms_code_on_votes { true }
+      document_number_authorization_handler { "dummy_signature_with_sms_handler" }
+    end
+
+    trait :with_sms_code_validation_and_user_extra_fields_collection do
+      extra_fields_legal_information { generate_localized_description(:initiatives_type_extra_fields_legal_information, skip_injection:) }
+      document_number_authorization_handler { "dummy_signature_handler" }
     end
 
     trait :child_scope_threshold_enabled do
@@ -268,10 +272,6 @@ FactoryBot.define do
     end
     initiative { create(:initiative, skip_injection:) }
     author { create(:user, :confirmed, organization: initiative.organization, skip_injection:) }
-    decidim_user_group_id { create(:user_group, skip_injection:).id }
-    after(:create) do |support, evaluator|
-      create(:user_group_membership, user: support.author, user_group: Decidim::UserGroup.find(support.decidim_user_group_id), skip_injection: evaluator.skip_injection)
-    end
   end
 
   factory :initiatives_committee_member, class: "Decidim::InitiativesCommitteeMember" do

data/lib/decidim/initiatives/test/initiatives_signatures_test_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    module InitiativesSignaturesTestHelpers
+      def fill_signature_date(date)
+        [date.year, date.month, date.day].each_with_index do |value, i|
+          within "select[name='dummy_signature_handler[date_of_birth(#{i + 1}i)]']" do
+            find("option[value='#{value}']").select_option
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Decidim::Initiatives::InitiativesSignaturesTestHelpers, type: :system
+end

data/lib/decidim/initiatives/validatable_authorizations.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    # Concern to search for authorizations or try to create them and
+    # validate their status. If the authorization cannot be created and the
+    # workflow sets save_authorizations to false a new invalid authorization is
+    # used. This validation is not performed if no action_authorizer class name
+    # is set in the workflow.
+    module ValidatableAuthorizations
+      extend ActiveSupport::Concern
+
+      included do
+        validate :valid_authorization
+
+        delegate :action_authorizer, :save_authorizations, :action_authorizer_class, to: :workflow_manifest
+
+        def authorization_status
+          return unless authorization && action_authorizer_class
+
+          @authorization_status ||= action_authorizer_class.new(authorization, {}).authorize
+        end
+
+        def authorization
+          return unless user && authorization_handler_form_class
+
+          persisted_authorization = authorization_query.first
+          @authorization ||= if persisted_authorization.present? && persisted_authorization.unique_id == authorization_handler.unique_id
+                               persisted_authorization
+                             elsif save_authorizations
+                               create_authorization
+                             else
+                               new_authorization
+                             end
+        end
+
+        private
+
+        def valid_authorization
+          return if authorization_status.blank?
+          return if authorization_status.first == :ok
+
+          errors.add(:base, I18n.t("invalid_authorization", scope: "decidim.initiatives.initiative_signatures.fill_personal_data"))
+        end
+
+        def create_authorization
+          Decidim::Verifications::AuthorizeUser.call(authorization_handler, initiative.organization) do
+            on(:transferred) do |transfer|
+              self.transfer_status = transfer
+            end
+
+            on(:transfer_user) do |authorized_user|
+              self.user = authorized_user
+              self.transfer_status = :transfer_user
+            end
+
+            on(:invalid) do
+              return Decidim::Authorization.new
+            end
+          end
+
+          authorization_query.first
+        end
+
+        def authorization_query
+          Verifications::Authorizations.new(**authorization_params)
+        end
+
+        def new_authorization
+          Decidim::Authorization.new(created_at: Time.current, **authorization_params)
+        end
+
+        def authorization_params
+          {
+            organization: initiative.organization,
+            user:,
+            name: authorization_handler_form_class.handler_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/initiatives/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-initiatives version.
   module Initiatives
     def self.version
-      "0.30.2"
+      "0.31.0.rc1"
     end
   end
 end

data/lib/decidim/initiatives.rb

@@ -5,6 +5,7 @@ require "decidim/initiatives/api"
 require "decidim/initiatives/engine"
 require "decidim/initiatives/admin_engine"
 require "decidim/initiatives/participatory_space"
+require "decidim/initiatives/signatures"
 
 module Decidim
   module Exporters
@@ -14,79 +15,89 @@ module Decidim
   # Base module for the initiatives engine.
   module Initiatives
     autoload :ApplicationFormPDF, "decidim/initiatives/application_form_pdf"
+    autoload :ValidatableAuthorizations, "decidim/initiatives/validatable_authorizations"
 
     include ActiveSupport::Configurable
 
     # Public setting that defines whether creation is allowed to any validated
     # user or not. Defaults to true.
     config_accessor :creation_enabled do
-      true
+      Decidim::Env.new("INITIATIVES_CREATION_ENABLED", "auto").present?
     end
 
     # Minimum number of committee members required to pass the initiative to
     # technical validation phase. Only applies to initiatives created by
     # individuals.
     config_accessor :minimum_committee_members do
-      2
+      Decidim::Env.new("INITIATIVES_MINIMUM_COMMITTEE_MEMBERS", 2).to_i
     end
 
     # Number of days available to collect supports after an initiative has been
     # published.
     config_accessor :default_signature_time_period_length do
-      120
+      Decidim::Env.new("INITIATIVES_DEFAULT_SIGNATURE_TIME_PERIOD_LENGTH", 120).to_i
     end
 
     # Components enabled for a new initiative
     config_accessor :default_components do
-      [:pages, :meetings, :blogs]
+      Decidim::Env.new("INITIATIVES_DEFAULT_COMPONENTS", "pages, meetings, blogs").to_array
     end
 
     # Notifies when the given percentage of supports is reached for an
     # initiative.
     config_accessor :first_notification_percentage do
-      33
+      Decidim::Env.new("INITIATIVES_FIRST_NOTIFICATION_PERCENTAGE", 33).to_i
     end
 
     # Notifies when the given percentage of supports is reached for an
     # initiative.
     config_accessor :second_notification_percentage do
-      66
+      Decidim::Env.new("INITIATIVES_SECOND_NOTIFICATION_PERCENTAGE", 66).to_i
     end
 
     # Sets the expiration time for the statistic data.
     config_accessor :stats_cache_expiration_time do
-      5.minutes
+      Decidim::Env.new("INITIATIVES_STATS_CACHE_EXPIRATION_TIME", 5).to_i.minutes
     end
 
     # Maximum amount of time in validating state.
     # After this time the initiative will be moved to
     # discarded state.
     config_accessor :max_time_in_validating_state do
-      60.days
+      Decidim::Env.new("INITIATIVES_MAX_TIME_IN_VALIDATING_STATE", 60).to_i.days
     end
 
     # Print functionality enabled. Allows the user to get
     # a printed version of the initiative from the administration
     # panel.
     config_accessor :print_enabled do
-      false
+      Decidim::Env.new("INITIATIVES_PRINT_ENABLED", "auto").to_s == "true"
     end
 
     # Set a service to generate a timestamp on each vote. The
     # attribute is the name of a class whose instances are
     # initialized with a string containing the data to be
     # timestamped and respond to a timestamp method
-    config_accessor :timestamp_service
+    config_accessor :timestamp_service do
+      Decidim::Env.new("DECIDIM_TIMESTAMP_SERVICE", nil).value
+    end
 
     # Set a service to add a signature to pdf of signatures.
     # The attribute is the name of a class whose instances are
     # initialized with the document to be signed and respond to a
     # signed_pdf method with the signature added
-    config_accessor :pdf_signature_service
+    config_accessor :pdf_signature_service do
+      Decidim::Env.new("DECIDIM_PDF_SIGNATURE_SERVICE", nil).value
+    end
 
     # This flag allows creating authorizations to unauthorized users.
     config_accessor :do_not_require_authorization do
-      false
+      Decidim::Env.new("INITIATIVES_DO_NOT_REQUIRE_AUTHORIZATION").present?
+    end
+
+    # Encryption secret to use with signatures metadata
+    config_accessor :signature_handler_encryption_secret do
+      Decidim::Env.new("INITIATIVES_SIGNATURE_HANDLER_ENCRYPTION_SECRET", "personal user metadata").to_s
     end
   end
 end