decidim-direct_verifications 1.0.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d0c77bd7a23a324cffa17539eedb6d2fd8bfbcfafe08f0b77cbc75035d59262
-  data.tar.gz: 8d0f5a889569f909f2b8d6dafaf59959c7b7523ba2e9d5659dbe319b201de993
+  metadata.gz: d7a348b9504d3371592edd997c1af5847b05b3fa060a155de266c13ad3385b1c
+  data.tar.gz: 6d21de70c4ae4b1d40b2ab27514f90cdeccbaaf309eae82f0eb9671f1b597355
 SHA512:
-  metadata.gz: d15873f3e2da17204d2de7e5b880288c5c4643414ae0eb847a646588855c4e2def9b641235ffb0231afabddba618524ede04baec25366af6efda6c4f88d87b9d
-  data.tar.gz: 1ccce49b7915f7d6fc67ec7ed057dfcbf5d2a061ffc5bc624832462afe1d9bc0382f39f2efe3e4b309c7533e0846161711a443155fe5fae7c0bc57d3ecf31ed4
+  metadata.gz: efa9e4d88b715b7a1255bdf2890e0f9f0f34b52b2cf3f02cc211954eec9b53b43c75a3373a456c7d71a23ba9920f6b3c9ec47f5fe3476cfc23564b7c4897159e
+  data.tar.gz: 2825c1c7d5bb1230c242a019288d76fd4d42ae69770fa5cbe5f91a9492c4de0c96a7e36dc012195cd65f0301243792a6dd5f9ea7a8584b995b174de9a5ada695

data/README.md

@@ -55,6 +55,28 @@ Decidim::DirectVerifications.configure do |config|
 end
 ```
 
+### Direct managements of user's authorizations
+
+This plugin also provides a place for admins to see and manage (if configured) existing verifications for any user.
+Admins can go to the "Participants" admin page and see a new management button, when clicked it shows a modal window with all the authorizations that this user has granted as well as the missing ones. If Direct Verfication is configured to manage that verification (through the `manage_workflows` config var) it can be granted or revoke just by clicking a button.
+
+![Participants mods](examples/participants.png)
+
+![Participants modal management](examples/authorization-modal.png)
+
+This behavior can be disabled by disabling in a initializer the config var `participants_modal`.
+
+**`config/initializers/decidim_verifications.rb`:**
+
+```ruby
+# frozen_string_literal: true
+
+Decidim::DirectVerifications.configure do |config|
+  # Disable participants direct verifications management
+  config.participants_modal = false
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -73,6 +95,8 @@ Depending on your Decidim version, you might want to specify the version to ensu
 
 | Direct Verifications version | Compatible Decidim versions |
 |---|---|
+| 1.2 | >= 0.25.x |
+| 1.1 | >= 0.25.x |
 | 1.0 | >= 0.23.x |
 | 0.22.x | 0.22.x |
 

data/app/commands/decidim/direct_verifications/verification/create_import.rb

@@ -17,13 +17,14 @@ module Decidim
 
           case action
           when :register
-            register_users_async
+            register_users_async(remove_file: true)
+          when :authorize
+            authorize_users_async(remove_file: true)
           when :register_and_authorize
             register_users_async
-            file.rewind
-            authorize_users_async
+            authorize_users_async(remove_file: true)
           when :revoke
-            revoke_users_async
+            revoke_users_async(remove_file: true)
           end
 
           broadcast(:ok)
@@ -33,16 +34,24 @@ module Decidim
 
         attr_reader :form, :file, :organization, :user, :action
 
-        def register_users_async
-          RegisterUsersJob.perform_later(file.read, organization, user, form.authorization_handler)
+        def register_users_async(options = {})
+          RegisterUsersJob.perform_later(blob.id, organization, user, form.authorization_handler, options)
+        end
+
+        def revoke_users_async(options = {})
+          RevokeUsersJob.perform_later(blob.id, organization, user, form.authorization_handler, options)
+        end
+
+        def authorize_users_async(options = {})
+          AuthorizeUsersJob.perform_later(blob.id, organization, user, form.authorization_handler, options)
         end
 
-        def revoke_users_async
-          RevokeUsersJob.perform_later(file.read, organization, user, form.authorization_handler)
+        def blob
+          @blob ||= ActiveStorage::Blob.create_and_upload!(io: file, filename: secure_name)
         end
 
-        def authorize_users_async
-          AuthorizeUsersJob.perform_later(file.read, organization, user, form.authorization_handler)
+        def secure_name
+          @secure_name ||= "#{SecureRandom.uuid}#{File.extname(file.tempfile)}"
         end
       end
     end

data/app/controllers/concerns/decidim/direct_verifications/admin/needs_verification_snippets.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module DirectVerifications
+    module Admin
+      module NeedsVerificationSnippets
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :snippets
+        end
+
+        def snippets
+          return @snippets if @snippets
+
+          @snippets = Decidim::Snippets.new
+          return @snippets if Decidim::DirectVerifications.participants_modal.blank?
+
+          @snippets.add(:direct_verifications, "<script>DirectVerificationsConfig = #{direct_verifications_config.to_json}</script>")
+          @snippets.add(:direct_verifications, ActionController::Base.helpers.javascript_pack_tag("decidim_direct_verifications_participants"))
+          @snippets.add(:head, @snippets.for(:direct_verifications))
+
+          @snippets
+        end
+
+        def direct_verifications_config
+          {
+            buttonTitle: I18n.t("decidim.direct_verifications.participants.modal.button_title", locale: detect_current_locale),
+            modalTitle: I18n.t("decidim.direct_verifications.participants.modal.modal_title", locale: detect_current_locale),
+            closeModalLabel: I18n.t("decidim.direct_verifications.participants.modal.close_modal_label", locale: detect_current_locale),
+            statsLabel: I18n.t("decidim.direct_verifications.verification.admin.index.stats", locale: detect_current_locale),
+            userVerificationsPath: Decidim::DirectVerifications::Verification::AdminEngine.routes.url_helpers.user_authorization_path("-ID-"),
+            statsPath: Decidim::DirectVerifications::Verification::AdminEngine.routes.url_helpers.stats_path,
+            verifications: direct_verifications_verifications
+          }
+        end
+
+        def direct_verifications_verifications
+          @direct_verifications_verifications ||= Decidim::Authorization.where(name: current_organization.available_authorizations)
+                                                                        .where.not(granted_at: nil)
+                                                                        .where(decidim_user_id: filtered_collection).map do |auth|
+            {
+              id: auth.id,
+              userId: auth.decidim_user_id,
+              name: auth.name,
+              title: I18n.t("decidim.authorization_handlers.#{auth.name}.name", locale: detect_current_locale, default: auth.name),
+              createdAt: auth.created_at,
+              updatedAt: auth.updated_at
+            }
+          end
+        end
+
+        def detect_current_locale
+          params[:locale] || session[:user_locale] || locale
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/direct_verifications/verification/admin/application_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      module Admin
+        class ApplicationController < Decidim::Admin::ApplicationController
+          def permission_class_chain
+            [::Decidim::DirectVerifications::Admin::Permissions] + super
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/direct_verifications/verification/admin/authorizations_controller.rb

@@ -4,12 +4,14 @@ module Decidim
   module DirectVerifications
     module Verification
       module Admin
-        class AuthorizationsController < Decidim::Admin::ApplicationController
+        class AuthorizationsController < ApplicationController
           layout "decidim/admin/users"
 
           def index
             enforce_permission_to :index, :authorization
             @authorizations = collection.includes(:user)
+                                        .page(params[:page])
+                                        .per(15)
           end
 
           def destroy

data/app/controllers/decidim/direct_verifications/verification/admin/direct_verifications_controller.rb

@@ -4,7 +4,7 @@ module Decidim
   module DirectVerifications
     module Verification
       module Admin
-        class DirectVerificationsController < Decidim::Admin::ApplicationController
+        class DirectVerificationsController < ApplicationController
           include NeedsPermission
           helper_method :workflows, :current_authorization_handler
 

data/app/controllers/decidim/direct_verifications/verification/admin/imports_controller.rb

@@ -4,7 +4,7 @@ module Decidim
   module DirectVerifications
     module Verification
       module Admin
-        class ImportsController < Decidim::Admin::ApplicationController
+        class ImportsController < ApplicationController
           layout "decidim/admin/users"
           helper_method :workflows, :current_authorization_handler
 

data/app/controllers/decidim/direct_verifications/verification/admin/stats_controller.rb

@@ -4,10 +4,10 @@ module Decidim
   module DirectVerifications
     module Verification
       module Admin
-        class StatsController < Decidim::Admin::ApplicationController
+        class StatsController < ApplicationController
           include NeedsPermission
 
-          layout "decidim/admin/users"
+          layout -> { request.xhr? ? false : "decidim/admin/users" }
 
           def index
             enforce_permission_to :index, :authorization

data/app/controllers/decidim/direct_verifications/verification/admin/user_authorizations_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      module Admin
+        class UserAuthorizationsController < ApplicationController
+          include NeedsPermission
+          layout false
+
+          helper_method :user, :authorizations, :authorization_for, :managed?
+
+          def show
+            enforce_permission_to :index, :authorization
+          end
+
+          def update
+            enforce_permission_to :create, :direct_authorization, name: params[:name]
+            handler = OpenStruct.new(handler_name: params[:name], user: user, unique_id: nil, metadata: {})
+            if Decidim::Authorization.create_or_update_from(handler)
+              flash[:notice] = t(".success", name: auth_name)
+            else
+              flash[:alert] = t(".error", name: auth_name)
+            end
+            redirect_to decidim_admin.officializations_path
+          end
+
+          def destroy
+            enforce_permission_to :destroy, :direct_authorization, name: params[:name]
+            begin
+              authorization_for(params[:name]).destroy!
+              flash[:notice] = t(".success", name: auth_name)
+            rescue StandardError => e
+              flash[:alert] = t(".error", name: auth_name, error: e.message)
+            end
+            redirect_to decidim_admin.officializations_path
+          end
+
+          private
+
+          def user
+            @user ||= Decidim::User.find_by(id: params[:id])
+          end
+
+          def authorizations
+            @authorizations ||= Decidim::Authorization.where(decidim_user_id: user.id)
+          end
+
+          def authorization_for(name)
+            authorizations.find_by(name: name)
+          end
+
+          def managed?(name)
+            Decidim::DirectVerifications.manage_workflows.include? name
+          end
+
+          def auth_name
+            t("decidim.authorization_handlers.#{params[:name]}.name", default: params[:name])
+          end
+        end
+      end
+    end
+  end
+end

data/app/jobs/decidim/direct_verifications/authorize_users_job.rb

@@ -8,7 +8,9 @@ module Decidim
       class NullSession; end
 
       def process_users
+        Rails.logger.info "AuthorizeUsersJob: Authorizing #{emails.count} emails"
         emails.each do |email, data|
+          Rails.logger.debug "AuthorizeUsersJob: Authorizing #{email}"
           AuthorizeUser.new(
             email,
             data,

data/app/jobs/decidim/direct_verifications/base_import_job.rb

@@ -10,20 +10,32 @@ module Decidim
     class BaseImportJob < ApplicationJob
       queue_as :default
 
-      def perform(userslist, organization, current_user, authorization_handler)
-        @emails = Parsers::MetadataParser.new(userslist).to_h
+      def perform(blob_id, organization, current_user, authorization_handler, options = {})
+        @blob = ActiveStorage::Blob.find(blob_id)
         @organization = organization
         @current_user = current_user
-        @instrumenter = Instrumenter.new(current_user)
         @authorization_handler = authorization_handler
 
-        process_users
-        send_email_notification
+        begin
+          @emails = Parsers::MetadataParser.new(userslist).to_h
+          @instrumenter = Instrumenter.new(current_user)
+
+          Rails.logger.info "BaseImportJob: Processing file #{@blob.filename}"
+          process_users
+          send_email_notification
+        rescue StandardError => e
+          Rails.logger.error "BaseImportJob Error: #{e.message} #{e.backtrace.filter { |f| f =~ /direct_verifications/ }}"
+        end
+        remove_file! if options.fetch(:remove_file, false)
       end
 
       private
 
-      attr_reader :emails, :organization, :current_user, :instrumenter, :authorization_handler
+      attr_reader :blob, :emails, :organization, :current_user, :instrumenter, :authorization_handler
+
+      def userslist
+        @userslist ||= blob.download.force_encoding("UTF-8")
+      end
 
       def send_email_notification
         ImportMailer.finished_processing(
@@ -33,6 +45,10 @@ module Decidim
           authorization_handler
         ).deliver_now
       end
+
+      def remove_file!
+        blob.purge
+      end
     end
   end
 end

data/app/jobs/decidim/direct_verifications/register_users_job.rb

@@ -6,6 +6,7 @@ module Decidim
   module DirectVerifications
     class RegisterUsersJob < BaseImportJob
       def process_users
+        Rails.logger.info "RegisterUsersJob: Registering #{emails.count} emails"
         emails.each do |email, data|
           RegisterUser.new(email, data, organization, current_user, instrumenter).call
         end

data/app/jobs/decidim/direct_verifications/revoke_users_job.rb

@@ -4,6 +4,7 @@ module Decidim
   module DirectVerifications
     class RevokeUsersJob < BaseImportJob
       def process_users
+        Rails.logger.info "RevokeUsersJob: Revoking #{emails.count} emails"
         emails.each do |email, _name|
           RevokeUser.new(email, organization, instrumenter, authorization_handler).call
         end

data/app/packs/entrypoints/decidim_direct_verifications.js

@@ -0,0 +1,4 @@
+import "src/decidim/direct_verifications/admin/checkboxes.js"
+
+// CSS
+import "entrypoints/decidim_direct_verifications.scss";

data/app/packs/entrypoints/decidim_direct_verifications.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/direct_verifications/admin/authorizations";

data/app/packs/entrypoints/decidim_direct_verifications_participants.js

@@ -0,0 +1 @@
+import "src/decidim/direct_verifications/admin/participants.js"

data/app/packs/src/decidim/direct_verifications/admin/checkboxes.js

@@ -0,0 +1,5 @@
+$(() => {
+  $('[type="checkbox"]#register').change(function () {
+    $(this).closest("label").find(".callout").toggleClass("hide", !$(this).prop("checked"))
+  })
+})

data/app/packs/src/decidim/direct_verifications/admin/participants.js

@@ -0,0 +1,88 @@
+class VerificationUI {
+  constructor($table, config) {
+    this.$table = $table;
+    this.svgPath = $table.find("use[href]:first").attr("href").split("#")[0];
+    this.icon = "icon-key";
+    this.config = config;
+    this.$table.on("click", ".show-verifications-modal", (e) => this.toggleModal(e));
+    this.addModal();
+  }
+
+  addModal() {
+    this.$modal = $(`<div class="reveal" id="show-verifications-modal" data-reveal>
+  <div class="reveal__header">
+    <h3 class="reveal__title">${this.config.modalTitle}</h3>
+    <button class="close-button" data-close aria-label="${this.config.closeModalLabel}"
+      type="button">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+
+  <div class="row">
+    <div class="columns medium-4 medium-centered modal-body">
+    </div>
+  </div>
+</div>`);
+    this.$table.after(this.$modal);
+    this.$title = $("#user-groups .card-title:first");
+    this.$modalBody = this.$modal.find(".modal-body");
+    this.reveal = new Foundation.Reveal(this.$modal);
+  }
+
+  drawButtons() {
+    this.$table.find("tbody tr").each((idx, tr) => {
+      const $lastTd = $(tr).find("td:last");
+
+      $lastTd.prepend(`<a class="action-icon action-icon action-icon show-verifications-modal" title="${this.config.buttonTitle}" href="#open-show-verifications-modal"><span class="has-tip ${this.getTrStatus(tr)}"><svg aria-label="${this.config.buttonTitle}" role="img" class="icon--ban icon">
+        <title>${this.config.buttonTitle}</title>
+        <use href="${this.svgPath}#${this.icon}"></use>
+        </svg></span></a>`);
+    });
+  }
+
+  addStatsTitle() {
+    // Add upper link to verification stats
+    const $a = $(`<a class="button tiny button--title" href="${this.config.statsPath}">${this.config.statsLabel}</a>`);
+    $a.on("click", (e) => {
+      e.preventDefault();
+      this.loadUrl($a.attr("href"), true);
+    });
+    this.$title.append($a);
+  }
+
+  getTrStatus(tr) {
+    return this.getUserVerifications($(tr).data("user-id")).length
+      ? "alert"
+      : "";
+  }
+
+  getVerification(id) {
+    return this.config.verifications.find((auth) => auth.id == id);
+  }
+
+  getUserVerifications(userId) {
+    return this.config.verifications.filter((auth) => auth.userId == userId);
+  }
+
+  toggleModal(e) {
+    const userId = $(e.target).closest("tr").data("user-id");
+    this.loadUrl(this.config.userVerificationsPath.replace("-ID-", userId));
+  }
+
+  loadUrl(url, large = false) {
+    this.$modal.removeClass("large");
+    if (large) {
+      this.$modal.addClass("large");
+    }
+    this.$modalBody.html('<span class="loading-spinner"></span>');
+    this.$modalBody.load(url);
+    this.$modal.foundation("toggle");
+  }
+}
+
+$(() => {
+  const ui = new VerificationUI($("#user-groups table.table-list"), DirectVerificationsConfig);
+  // Draw the icon buttons for checking verification statuses
+  ui.drawButtons();
+  ui.addStatsTitle();
+});

data/app/{assets/stylesheets/decidim/direct_verifications → packs/stylesheets/decidim/direct_verifications/admin}/authorizations.scss

@@ -1,4 +1,4 @@
-@import "decidim/admin/utils/settings";
+@import "stylesheets/decidim/admin/utils/settings";
 
 $code-color: $black;
 $code-font-family: $font-family-monospace;

data/app/permissions/decidim/direct_verifications/admin/permissions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action if permission_action.scope != :admin
+          return permission_action unless user
+          return permission_action unless user.admin?
+
+          toggle_allow(Decidim::DirectVerifications.manage_workflows.map(&:to_s).include?(context.fetch(:name).to_s)) if permission_action.subject == :direct_authorization
+
+          permission_action
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/direct_verifications/verification/admin/authorizations/index.html.erb

@@ -1,4 +1,4 @@
-<%= stylesheet_link_tag "decidim/direct_verifications/authorizations" %>
+<%= stylesheet_pack_tag "decidim_direct_verifications" %>
 
 <div class="card">
   <div class="card-divider">
@@ -37,6 +37,7 @@
           <% end %>
         </tbody>
       </table>
+      <%= paginate @authorizations, theme: "decidim" %>
     </div>
   </div>
 </div>

data/app/views/decidim/direct_verifications/verification/admin/direct_verifications/index.html.erb

@@ -42,4 +42,4 @@
   </div>
 </div>
 
-<%= javascript_include_tag "decidim/direct_verifications/verification/admin/direct_verifications_admin" %>
+<%= javascript_pack_tag "decidim_direct_verifications" %>

data/app/views/decidim/direct_verifications/verification/admin/imports/new.html.erb

@@ -47,4 +47,4 @@
   </div>
 </div>
 
-<%= javascript_include_tag "decidim/direct_verifications/verification/admin/direct_verifications_admin" %>
+<%= javascript_pack_tag "decidim_direct_verifications" %>

data/app/views/decidim/direct_verifications/verification/admin/stats/index.html.erb

@@ -2,7 +2,9 @@
   <div class="card-divider">
     <h2 class="card-title">
       <%= t("admin.index.stats", scope: "decidim.direct_verifications.verification") %>
-      <%= link_to t("admin.index.title", scope: "decidim.direct_verifications.verification"), direct_verifications_path, class: "button tiny button--title" %>
+      <% unless request.xhr? %>
+        <%= link_to t("admin.index.title", scope: "decidim.direct_verifications.verification"), direct_verifications_path, class: "button tiny button--title" %>
+      <% end %>
     </h2>
   </div>
   <div class="card-section">

data/app/views/decidim/direct_verifications/verification/admin/user_authorizations/show.html.erb

@@ -0,0 +1,27 @@
+<strong><%= user.name %>:</strong>
+<table class="table-list">
+  <tbody>
+<% current_organization.available_authorizations.each do |name| %>
+  <% authorization = authorization_for(name) %>
+  <tr>
+    <td><%= I18n.t("decidim.authorization_handlers.#{name}.name", default: name) %></td>
+    <td>
+      <% if authorization&.granted? %>
+        <span class="label success"><%= t ".granted" %></span>
+      <% else %>
+        <span class="label alert"><%= t ".not_granted" %></span>
+      <% end %>
+    </td>
+    <td class="table-list__actions">
+      <% if managed?(name) %>
+        <% if authorization&.granted? %>
+          <%= icon_link_to "circle-x", user_authorization_path(user, name: name), t(".revoke"), method: :delete, role: "img", aria_label: t(".revoke") %>
+        <% else %>
+          <%= icon_link_to "circle-check", user_authorization_path(user, name: name), t(".grant"), method: :patch, role: "img", aria_label: t(".grant") %>
+        <% end %>
+      <% end %>
+    </td>
+  </tr>
+<% end %>
+  </tbody>
+</table>

data/config/assets.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is located at `config/assets.rb` of your module.
+
+# Define the base path of your module. Please note that `Rails.root` may not be
+# used because we are not inside the Rails environment when this file is loaded.
+base_path = File.expand_path("..", __dir__)
+
+# Register an additional load path for webpack. All the assets within these
+# directories will be available for inclusion within the Decidim assets. For
+# example, if you have `app/packs/src/decidim/foo.js`, you can include that file
+# in your JavaScript entrypoints (or other JavaScript files within Decidim)
+# using `import "src/decidim/foo"` after you have registered the additional path
+# as follows.
+Decidim::Webpacker.register_path("#{base_path}/app/packs")
+
+# Register the entrypoints for your module. These entrypoints can be included
+# within your application using `javascript_pack_tag` and if you include any
+# SCSS files within the entrypoints, they become available for inclusion using
+# `stylesheet_pack_tag`.
+Decidim::Webpacker.register_entrypoints(
+  decidim_direct_verifications: "#{base_path}/app/packs/entrypoints/decidim_direct_verifications.js",
+  decidim_direct_verifications_participants: "#{base_path}/app/packs/entrypoints/decidim_direct_verifications_participants.js",
+  decidim_direct_verifications_css: "#{base_path}/app/packs/entrypoints/decidim_direct_verifications.scss"
+)