decidim-action_delegator 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d669c45c0467b359830db39ef5ad435bc1a3f0a3f7f2663f74dac3ad6d3fab
-  data.tar.gz: 5011d0f2b42b00b28c69d38f91b15686f8072d29daf27dd1768102c01ff72e0b
+  metadata.gz: 72ece5d4d1d3c253b4fd99f8372ba014ca14446be9f96119c87879ca8c94be6f
+  data.tar.gz: 8b1fb12a9a22f2bd035deb01273b3a73da14a916d4b250ddccf174d79f4b1f48
 SHA512:
-  metadata.gz: 82cb39a4606b7618df911928ced137624d41f03bb7cef98001ec55a2774a10bd0dac9ae79ce37a3dac6d88d36c98c1063009e050b77092f3707a8f9e24146bed
-  data.tar.gz: ac71746dc2894a410fc8d982196136074df69e9e2e3f4730be89622eae60a828fd13a153bb974875cec698b95065f8f0e464a90beec3084064e7a7617557dbc3
+  metadata.gz: f29fbeaeb138c6c2b527b465d40146356f7dfa395ed04bcfc80df697738c94f82589a625ab455a6d11e1810975ef7648b078256684b33863e625866c8a20dd64
+  data.tar.gz: 4119061790bd135c90c14932ab33b939b8f05b05dd07c1c32ca6140f68727da2e4fd43e52308ec4b8cb8b947d00e34350181467664d024e3163098062af9fe88

data/README.md

@@ -1,23 +1,24 @@
 # Decidim::ActionDelegator
 
-[![Test](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/test.yml/badge.svg)](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/test.yml)
+[![[CI] Lint](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/lint.yml/badge.svg)](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/lint.yml)
+[![[CI] Test](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/test.yml/badge.svg)](https://github.com/coopdevs/decidim-module-action_delegator/actions/workflows/test.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/6ec3c39e8dc2075808e1/maintainability)](https://codeclimate.com/github/coopdevs/decidim-module-action_delegator/maintainability)
 [![Codecov](https://codecov.io/gh/coopdevs/decidim-module-action_delegator/branch/master/graph/badge.svg)](https://codecov.io/gh/coopdevs/decidim-module-action_delegator)
+[![Gem Version](https://badge.fury.io/rb/decidim-action_delegator.svg)](https://badge.fury.io/rb/decidim-action_delegator)
 
-
-A tool for Decidim that provides extended functionalities for cooperatives.
+A tool for Decidim that provides extended functionalities for cooperatives or any other type of organization that need to vote with weighted-vote results and/or vote-delegation.
 
 Combines a CSV-like verification method with impersonation capabilities that allow users to delegate some actions to others.
 
 Admin can set limits to the number of delegation per users an other characteristics.
 
-Initially, only votes can be delegated.
+Initially, only votes on consultations can be delegated.
 
 ## Dependencies
 
-* [decidim-consultations](https://github.com/decidim/decidim/tree/master/decidim-consultations) >= v0.24.0
-* [decidim-admin](https://github.com/decidim/decidim/tree/master/decidim-admin) >= v0.24.0
-* [decidim-core](https://github.com/decidim/decidim/tree/master/decidim-core) >= v0.24.0
+* [decidim-consultations](https://github.com/decidim/decidim/tree/master/decidim-consultations) >= v0.26.0
+* [decidim-admin](https://github.com/decidim/decidim/tree/master/decidim-admin) >= v0.26.0
+* [decidim-core](https://github.com/decidim/decidim/tree/master/decidim-core) >= v0.26.0
 
 ## Installation
 
@@ -27,6 +28,12 @@ Add this line to your application's Gemfile:
 gem "decidim-action_delegator"
 ```
 
+Or, if you want to stay up to date with the latest changes use this line instead:
+
+```ruby
+gem 'decidim-action_delegator', git: "https://github.com/coopdevs/decidim-module-action_delegator"
+```
+
 And then execute:
 
 ```bash
@@ -35,43 +42,71 @@ bundle exec rails decidim_action_delegator:install:migrations
 bundle exec rails db:migrate
 ```
 
-Depending on your Decidim version, choose the corresponding version to ensure compatibility:
+> **IMPORTANT:** 
+>
+> If you are upgrading from a previous version, you need to run the migrations again and import all membership types/weights into the built-in census by executing in your production server:
+>
+> ```bash
+> RAILS_ENV=production bundle exec rails decidim_action_delegator:import_direct_verifications
+> ```
+>
+> *It is safe to run the previous command multiple times, no content will be imported twice.*
+
+
+Depending on your Decidim version, you can choose the corresponding version to ensure compatibility:
 
 | Version | Compatible Decidim versions |
 |---|---|
+| 0.7.x | 0.26.x |
+| 0.6.x | 0.26.x |
+| 0.5 | 0.25.x |
 | 0.4 | 0.24.x |
 | 0.3 | 0.24.x |
 | 0.2 | 0.23.x |
 | 0.1 | 0.22.0 |
 
-> *Heads up!*  [Consultations module will be deprecated in the near future.](https://github.com/decidim/decidim/issues/7097)
+*Heads up!*  [Consultations module will be deprecated in the near future.](https://github.com/decidim/decidim/issues/7097)
 
 ## Usage
 
 ActionDelegator does not provides new Components or Participatory Spaces but enhances some functionalities in them.
 
+Currently it is designed to work with the Consultations module.
+
+- On one side, provides a custom verification method that allows admins to ensure only those in specific census (that can be uploaded via CSV) are able to vote. This census can be different for each consultation. This is optional and doesn't affect weighted voting or delegations.
+
+- On the other, each set of census can work with a different set of weights and delegation.
+
+![](docs/settings.png)
+
 ### Extended consultation results
 
 This gem modifies the consultation's results page adding two extra columns
-`Membership type` and `Membership weight`. This requires a Decidim verification
-that creates `decidim_authorizations` records which include the following JSON
-structure in the `metadata` column:
+`Membership type` and `Membership weight`. This is based on the census uploaded for each consultation and the weights assigned to each participant.
 
-```json
-"{ membership_type: '', membership_weight: '' }"
-```
+### Authorization verfifier and SMS gateway setup
+
+The integrated authorization method is called "Delegations verifier". If included in each question of a consultation, it will check if the user is authorized and present in the census before letting him vote.
+
+It can be used in 3 modes:
 
-See https://github.com/Platoniq/decidim-verifications-direct_verifications/pull/2
-as an example of such verification.
+1. **Email only**: This means that the participants list for each consultation setting relies on the email only. No SMS gateway integration is needed. The user is verified if the email is found in the census.
+2. **Email and phone**: This means that the participants list for each consultation setting relies on the email and the phone number. An SMS gateway integration is needed. The user is verified if the email is found in the census and then sending a verification code to the phone number that the user cannot edit.
+3. **Phone only**: This means that the participants list for each consultation setting relies on the phone number only. An SMS gateway integration is needed. The user is verified by a form where a phone number must be introduced. The user can edit the phone number and the verification code is sent to the new phone number if that phone number is found in the participant's list. This method is useful to avoid to relay on keeping track of email changes for user's database.
 
-### SMS gateway setup
 
-In order to use this new sms gateway you need to configure your application. In config/initializers/decidim.rb set:
+In order to use this new sms gateway you need to configure your application. It can work on two modes,
+
+The first is to use the same built-in SMS gateway used in Decidim: In `config/initializers/decidim.rb` set:
 
 ```ruby
 config.sms_gateway_service = 'Decidim::ActionDelegator::SmsGateway'
-
 ```
+
+> Note that if you use this method you will be able to use the built-in SMS verification method in Decidim.
+
+The other is to use a gateway service specific only for this plugin, this allows you to separate gateways or prevent decidim to allow admins to use the built in SMS verification method. This comes preinstalled and only requires you to setup some ENV variables.
+
 #### Som Connexió
 
 You can use Som Connexió as SMS provider which uses [this SOAP API](https://websms.masmovil.com/api_php/smsvirtual.wsdl). Reach out to Som Connexió to sign up first.
@@ -94,6 +129,16 @@ TWILIO_AUTH_TOKEN # Token from your Twilio account
 SMS_SENDER # Twilio's phone number. You need to purchase one there with SMS capability.
 ```
 
+#### Custom SMS gateways
+
+It is also possible to use your own Sms Gateway. In an new initializer (ie `config/initializers/action_delegator.rb`) set:
+
+```ruby
+Decidim::ActionDelegator.configure do |config|
+  config.sms_gateway_service = 'YourOwnSmsGateway'
+end
+```
+
 ### Track delegated votes and unvotes
 
 Votes and revocations done on behalf of other members are tracked through the
@@ -123,7 +168,7 @@ that matter.
 
 ## Contributing
 
-See [Decidim](https://github.com/decidim/decidim).
+Bug reports and pull requests are welcome on GitHub at https://github.com/coopdevs/decidim-module-action_delegator.
 
 ### Developing
 
@@ -150,16 +195,30 @@ order to create the dummy test app database.
 Then to test how the module works in Decidim, start the development server:
 
 ```bash
-cd development_app
-DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bin/rails s
 ```
 
+Note that `bin/rails` is a convenient wrapper around the command `cd development_app; bundle exec rails`.
+
 In case you are using [rbenv](https://github.com/rbenv/rbenv) and have the
 [rbenv-vars](https://github.com/rbenv/rbenv-vars) plugin installed for it, you
 can add the environment variables to the root directory of the project in a file
 named `.rbenv-vars`. If these are defined for the environment, you can omit
 defining these in the commands shown above.
 
+#### Webpacker notes
+
+As latests versions of Decidim, this repository uses Webpacker for Rails. This means that compilation
+of assets is required everytime a Javascript or CSS file is modified. Usually, this happens
+automatically, but in some cases (specially when actively changes that type of files) you want to 
+speed up the process. 
+
+To do that, start in a separate terminal than the one with `bin/rails s`, and BEFORE it, the following command:
+
+```bash
+bin/webpack-dev-server
+```
+
 #### Code Styling
 
 Please follow the code styling defined by the different linters that ensure we
@@ -178,21 +237,26 @@ bundle exec rubocop
 To ease up following the style guide, you should install the plugin to your
 favorite editor, such as:
 
-- Atom - [linter-rubocop](https://atom.io/packages/linter-rubocop)
 - Sublime Text - [Sublime RuboCop](https://github.com/pderichs/sublime_rubocop)
 - Visual Studio Code - [Rubocop for Visual Studio Code](https://github.com/misogi/vscode-ruby-rubocop)
 
+#### Non-Ruby Code Styling
+
+There are other linters for Javascript and CSS. These run using NPM packages. You can
+run the following commands:
+
+1. `npm run lint`: Runs the linter for Javascript files.
+2. `npm run lint-fix`: Automatically fix issues for Javascript files (if possible).
+3. `npm run stylelint`: Runs the linter for SCSS files.
+4. `npm run stylelint-fix`: Automatically fix issues for SCSS files (if possible).
+
 ### Testing
 
 To run the tests run the following in the gem development path:
 
 ```bash
 bundle
-DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake decidim:generate_external_test_app
-cd spec/decidim_dummy_app
-bundle exec rails decidim_action_delegator:install:migrations
-RAILS_ENV=test bundle exec rails db:migrate
-cd -
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
 DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec
 ```
 
@@ -207,13 +271,15 @@ commands shown above.
 
 ### Test code coverage
 
-If you want to generate the code coverage report for the tests, you can use
-the `SIMPLECOV=1` environment variable in the rspec command as follows:
+Running tests automatically generates a code coverage report. To generate the complete report run all the tests using this command:
 
 ```bash
-SIMPLECOV=1 bundle exec rspec
+bundle exec rspec
 ```
 
+This will generate a folder named `coverage` in the project root which contains
+the code coverage report.
+
 ### Localization
 
 If you would like to see this module in your own language, you can help with its
@@ -221,9 +287,6 @@ translation at Crowdin:
 
 https://crowdin.com/project/decidim-action-delegator-vote
 
-This will generate a folder named `coverage` in the project root which contains
-the code coverage report.
-
 ## License
 
 This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/app/commands/{decidim → concerns/decidim}/action_delegator/consultations/vote_question_override.rb

@@ -27,7 +27,15 @@ module Decidim
             @delegation ||= Decidim::ActionDelegator::GranteeDelegations.for(
               form.context.current_question.consultation,
               form.context.current_user
-            ).find_by(id: form.decidim_consultations_delegation_id)
+            ).find_by(id: delegation_id)
+          end
+
+          def delegation
+            @delegation ||= Decidim::ActionDelegator::Delegation.find_by(id: delegation_id)
+          end
+
+          def delegation_id
+            @delegation_id ||= form.decidim_consultations_delegation_id
           end
         end
       end

data/app/commands/decidim/action_delegator/admin/create_delegation.rb

@@ -54,7 +54,11 @@ module Decidim
         end
 
         def create_delegation
-          @delegation = Delegation.create(form.attributes.merge(setting: current_setting))
+          @delegation = Delegation.create(
+            granter: form.granter,
+            grantee: form.grantee,
+            setting: current_setting
+          )
         end
       end
     end

data/app/commands/decidim/action_delegator/admin/create_participant.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class CreateParticipant < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_participant
+
+          broadcast(:ok, participant)
+        end
+
+        private
+
+        attr_reader :form, :participant
+
+        def create_participant
+          @participant = Participant.create!(email: form.email,
+                                             phone: form.phone,
+                                             decidim_action_delegator_ponderation_id: form.decidim_action_delegator_ponderation_id,
+                                             setting: form.setting)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/create_ponderation.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class CreatePonderation < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_ponderation
+
+          broadcast(:ok, ponderation)
+        end
+
+        private
+
+        attr_reader :form, :ponderation
+
+        def create_ponderation
+          @ponderation = Ponderation.create!(name: form.name, weight: form.weight, setting: form.setting)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/create_setting.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class CreateSetting < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form, copy_from_setting)
+          @form = form
+          @copy_from_setting = copy_from_setting
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_setting
+
+          broadcast(:ok, setting)
+        end
+
+        private
+
+        attr_reader :form, :setting
+
+        def create_setting
+          selected = @copy_from_setting || Setting.new(ponderations: [], participants: [])
+
+          created_setting = Setting.new(
+            max_grants: form.max_grants,
+            authorization_method: form.authorization_method,
+            decidim_consultation_id: form.decidim_consultation_id,
+            ponderations: selected.ponderations.map(&:dup),
+            participants: selected.participants.map(&:dup)
+          )
+
+          @setting = created_setting.save!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/fix_resource_permissions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class FixResourcePermissions < Rectify::Command
+        def initialize(resources)
+          @resources = resources
+          @errors = []
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if resources.blank?
+
+          update_permissions
+
+          return broadcast(:invalid) if errors.any?
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :resources, :errors
+
+        def update_permissions
+          resources.each do |resource|
+            resource.resource_manifest.actions.each do |action|
+              resource_permission ||= resource.resource_permission || resource.build_resource_permission
+              next unless resource_permission.permissions.dig(action, "authorization_handlers", "delegations_verifier").nil?
+
+              resource_permission.permissions.deep_merge!({ action => { "authorization_handlers" => { "delegations_verifier" => {} } } })
+              @errors << resource unless resource_permission.save
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/update_participant.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class UpdateParticipant < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form, participant)
+          @form = form
+          @participant = participant
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_participant
+
+          broadcast(:ok, participant)
+        end
+
+        private
+
+        attr_reader :form, :participant
+
+        def update_participant
+          participant.email = form.email
+          participant.phone = form.phone
+          participant.decidim_action_delegator_ponderation_id = form.decidim_action_delegator_ponderation_id
+          participant.save!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/update_ponderation.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class UpdatePonderation < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form, ponderation)
+          @form = form
+          @ponderation = ponderation
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_ponderation
+
+          broadcast(:ok, ponderation)
+        end
+
+        private
+
+        attr_reader :form, :ponderation
+
+        def update_ponderation
+          ponderation.name = form.name
+          ponderation.weight = form.weight
+          ponderation.save!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/action_delegator/admin/update_setting.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Admin
+      class UpdateSetting < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        def initialize(form, setting, copy_from_setting)
+          @form = form
+          @setting = setting
+          @copy_from_setting = copy_from_setting
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_setting
+
+          broadcast(:ok, setting)
+        end
+
+        private
+
+        attr_reader :form, :setting, :copy_from_setting
+
+        def update_setting
+          setting.assign_attributes(
+            max_grants: form.max_grants,
+            decidim_consultation_id: form.decidim_consultation_id,
+            authorization_method: form.authorization_method
+          )
+
+          if copy_from_setting.present?
+            new_participants = copy_from_setting.participants.reject do |participant|
+              existing_participants.any? { |p| p.email == participant.email || p.phone == participant.phone }
+            end
+            setting.participants += new_participants.map(&:dup)
+
+            new_ponderations = copy_from_setting.ponderations.reject do |ponderation|
+              existing_ponderations.any? { |p| p.name == ponderation.name }
+            end
+            setting.ponderations += new_ponderations.map(&:dup)
+          end
+
+          setting.save!
+        end
+
+        def existing_participants
+          @existing_participants ||= setting.participants.to_a
+        end
+
+        def existing_ponderations
+          @existing_ponderations ||= setting.ponderations.to_a
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/action_delegator/consultations/consultations_controller_override.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Consultations
+      module ConsultationsControllerOverride
+        extend ActiveSupport::Concern
+        include ::Decidim::ActionDelegator::NeedsConsultationStyles
+
+        included do
+          helper ::Decidim::ActionDelegator::DelegationHelper
+        end
+      end
+    end
+  end
+end

data/app/controllers/{decidim → concerns/decidim}/action_delegator/consultations/question_multiple_votes_controller_override.rb

@@ -7,9 +7,10 @@ module Decidim
         extend ActiveSupport::Concern
 
         included do
+          helper ::Decidim::ActionDelegator::DelegationHelper
           helper_method :delegation
           before_action do
-            session[:delegation_id] = params[:delegation] if params[:delegation]
+            session[:delegation_id] = delegation.id if delegation
           end
 
           private

data/app/controllers/{decidim → concerns/decidim}/action_delegator/consultations/question_votes_controller_override.rb

@@ -7,6 +7,8 @@ module Decidim
         extend ActiveSupport::Concern
 
         included do
+          helper ::Decidim::ActionDelegator::DelegationHelper
+
           def destroy
             enforce_permission_to_unvote
 

data/app/controllers/concerns/decidim/action_delegator/consultations/questions_controller_override.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Consultations
+      module QuestionsControllerOverride
+        extend ActiveSupport::Concern
+        include ::Decidim::ActionDelegator::NeedsConsultationStyles
+
+        included do
+          helper ::Decidim::ActionDelegator::DelegationHelper
+        end
+      end
+    end
+  end
+end