decidim-direct_verifications 0.22 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3a36032cc453d0d386579125ace610fbc73e85a975196b56ae84c3f10a2296
-  data.tar.gz: d20c11a81153e2c9fe79b0663d5b9cd7f077133714d8cf25a872ee1f70ca6741
+  metadata.gz: e42a469a3e54d28a703c6565abdb73aa70d33c540882e8737c0e92592d18d238
+  data.tar.gz: 1c2ff4b72713ad26ba30b350efbcc31840fa42aac1f171faa32f0b1b64596d22
 SHA512:
-  metadata.gz: b3201103a89ca52e19fbd493018e45727d81d3b7d626eca0a5735253bc4ee21b5fc3260038cca70c405aed30f4556c807ae35b3b1ec00bc6157acc3f0c16cc33
-  data.tar.gz: 170a4e48d8ecadd8abc262626669ed9b8820d85804a0a48350c1ea2a2dc7f2de4a87f6833f71ff23fe1b880ba817b81f8f4823059824bfcce9703d9b45720631
+  metadata.gz: 1514cdfd920925b28b1d89e4c615a4ce0a97ceca4a85fcffab0706e6b740e0ae11541c04ce77a992da7aa21ef6b289795abf8cd3ccb950f7c1613531b3f57460
+  data.tar.gz: 618916a01ea8ac5fb19188e1b10d15c56a40ed6648da422d5d48c16a93feb8a2ff1f5507ac88f62a08c0651a704fb5c2a5efa502d887b2df07b6eb1bca8f66a4

data/README.md

@@ -1,8 +1,10 @@
 # Decidim::DirectVerifications
 
-![[CI] Test](https://github.com/Platoniq/decidim-verifications-direct_verifications/workflows/%5BCI%5D%20Test/badge.svg)
+[![Test](https://github.com/Platoniq/decidim-verifications-direct_verifications/actions/workflows/test.yml/badge.svg)](https://github.com/Platoniq/decidim-verifications-direct_verifications/actions/workflows/test.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2195deb4de6c6354a6bc/maintainability)](https://codeclimate.com/github/Platoniq/decidim-verifications-direct_verifications/maintainability)
-[![codecov](https://codecov.io/gh/Platoniq/decidim-verifications-direct_verifications/branch/master/graph/badge.svg?token=FR1zkV71S2)](https://codecov.io/gh/Platoniq/decidim-verifications-direct_verifications)
+[![codecov](https://codecov.io/gh/Platoniq/decidim-verifications-direct_verifications/branch/main/graph/badge.svg?token=FR1zkV71S2)](https://codecov.io/gh/Platoniq/decidim-verifications-direct_verifications)
+
+
 
 A [Decidim](https://github.com/decidim/decidim) that provides a verification method called `Direct verification`. Works only on the admin side, final users do not intervene in the verification process.
 
@@ -36,6 +38,23 @@ With the detected list of emails admin have different options available:
 3. Revoke the authorization for the list of users using any verification method available.
 4. Check the status of the users in order to know if they are verified or registered.
 
+### Metadata mode
+
+This mode provides extra capabilities over the default processing:
+
+* Reads CSV format with header (copy and paste it from your spreadsheet)
+* Stores all columns except the email as authorization metadata
+
+This enables querying the authorization metadata however fits you best.
+
+To enable it create a new initializer, for instance `config/initializers/decidim_direct_verifications.rb` with the following contents
+
+```ruby
+Decidim::DirectVerifications.configure do |config|
+  config.input_parser = :metadata_parser
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -50,6 +69,14 @@ And then execute:
 bundle
 ```
 
+Depending on your Decidim version, you might want to specify the version to ensure compatibility:
+
+| Direct Verifications version | Compatible Decidim versions |
+|---|---|
+| 1.1 | >= 0.25.x |
+| 1.0 | >= 0.23.x |
+| 0.22.x | 0.22.x |
+
 ## Using additional verification methods
 
 You can manage other verification methods (or workflow) a part from `Direct verification`. You need to configure it in a new file in the `config/initializers` folder.
@@ -70,7 +97,10 @@ end
 
 # We need to tell the plugin to handle this method in addition to the default "Direct verification". Any registered workflow is valid.
 Decidim::DirectVerifications.configure do |config|
-  config.manage_workflows = %w(direct_verifications_managers)
+  config.manage_workflows = %w(direct_verifications direct_verifications_managers)
+
+  # change the to the metadata_parser if you want it
+  # config.input_parser = :metadata_parser
 end
 
 ```

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      class CreateImport < Rectify::Command
+        def initialize(form)
+          @form = form
+          @file = form.file
+          @organization = form.organization
+          @user = form.user
+          @action = form.action
+        end
+
+        def call
+          return broadcast(:invalid) unless form.valid?
+
+          case action
+          when :register
+            register_users_async(remove_file: true)
+          when :authorize
+            authorize_users_async(remove_file: true)
+          when :register_and_authorize
+            register_users_async
+            authorize_users_async(remove_file: true)
+          when :revoke
+            revoke_users_async(remove_file: true)
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form, :file, :organization, :user, :action
+
+        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 blob
+          @blob ||= ActiveStorage::Blob.create_and_upload!(io: file, filename: secure_name)
+        end
+
+        def secure_name
+          @secure_name ||= "#{SecureRandom.uuid}#{File.extname(file.tempfile)}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      module Admin
+        class AuthorizationsController < Decidim::Admin::ApplicationController
+          layout "decidim/admin/users"
+
+          def index
+            enforce_permission_to :index, :authorization
+            @authorizations = collection.includes(:user)
+                                        .page(params[:page])
+                                        .per(15)
+          end
+
+          def destroy
+            if authorization.destroy
+              flash[:notice] = "successfully"
+              redirect_to authorizations_path
+            end
+          end
+
+          private
+
+          def collection
+            # Decidim::Verifications::Authorizations Query
+            Decidim::Verifications::Authorizations.new(
+              organization: current_organization,
+              name: "direct_verifications",
+              granted: true
+            ).query
+          end
+
+          def authorization
+            @authorization ||= collection.find_by(id: params[:id])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,30 +17,40 @@ module Decidim
           def create
             enforce_permission_to :create, :authorization
 
-            @userslist = params[:userlist]
-            @processor = UserProcessor.new(current_organization, current_user, session)
-            @processor.emails = extract_emails_to_hash @userslist
+            @userslist = params[:userslist]
+
+            @processor = UserProcessor.new(current_organization, current_user, session, instrumenter)
+            @processor.emails = parser_class.new(@userslist).to_h
             @processor.authorization_handler = current_authorization_handler
+
             @stats = UserStats.new(current_organization)
             @stats.authorization_handler = @processor.authorization_handler
+
             register_users
             authorize_users
             revoke_users
 
             render(action: :index) && return if show_users_info
 
+            redirect_to direct_verifications_path
+          rescue InputParserError => e
+            flash[:error] = e.message
             redirect_to direct_verifications_path
           end
 
           private
 
+          def instrumenter
+            @instrumenter ||= Instrumenter.new(current_user)
+          end
+
           def register_users
             return unless params[:register]
 
             @processor.register_users
             flash[:warning] = t(".registered", count: @processor.emails.count,
-                                               registered: @processor.processed[:registered].count,
-                                               errors: @processor.errors[:registered].count)
+                                               registered: instrumenter.processed_count(:registered),
+                                               errors: instrumenter.errors_count(:registered))
           end
 
           def authorize_users
@@ -49,8 +59,8 @@ module Decidim
             @processor.authorize_users
             flash[:notice] = t(".authorized", handler: t("#{@processor.authorization_handler}.name", scope: "decidim.authorization_handlers"),
                                               count: @processor.emails.count,
-                                              authorized: @processor.processed[:authorized].count,
-                                              errors: @processor.errors[:authorized].count)
+                                              authorized: instrumenter.processed_count(:authorized),
+                                              errors: instrumenter.errors_count(:authorized))
           end
 
           def revoke_users
@@ -59,12 +69,12 @@ module Decidim
             @processor.revoke_users
             flash[:notice] = t(".revoked", handler: t("#{@processor.authorization_handler}.name", scope: "decidim.authorization_handlers"),
                                            count: @processor.emails.count,
-                                           revoked: @processor.processed[:revoked].count,
-                                           errors: @processor.errors[:revoked].count)
+                                           revoked: instrumenter.processed_count(:revoked),
+                                           errors: instrumenter.errors_count(:revoked))
           end
 
           def show_users_info
-            return if params[:authorize]
+            return if params[:authorize].in? %w(in out)
 
             @stats.emails = @processor.emails.keys
             flash.now[:info] = t(".info", handler: t("#{@processor.authorization_handler}.name", scope: "decidim.authorization_handlers"),
@@ -75,16 +85,8 @@ module Decidim
             true
           end
 
-          def extract_emails_to_hash(txt)
-            reg = /([A-Z0-9+._-]+@[A-Z0-9._-]+\.[A-Z0-9_-]+)\b/i
-            emails = {}
-            txt.split(/[\r\n;,]/).each do |line|
-              reg.match line do |m|
-                n = line.split(m[0]).first
-                emails[m[0]] = (n.presence || "").gsub(/[^[:print:]]|[\"\$\<\>\|\\]/, "").strip
-              end
-            end
-            emails
+          def parser_class
+            Decidim::DirectVerifications.find_parser_class(Decidim::DirectVerifications.input_parser)
           end
 
           def authorization_handler(authorization_handler)

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      module Admin
+        class ImportsController < Decidim::Admin::ApplicationController
+          layout "decidim/admin/users"
+          helper_method :workflows, :current_authorization_handler
+
+          def new
+            enforce_permission_to :create, :authorization
+            @form = form(CreateImportForm).instance
+          end
+
+          def create
+            enforce_permission_to :create, :authorization
+
+            defaults = { organization: current_organization, user: current_user }
+            form = form(CreateImportForm).from_params(params.merge(defaults))
+
+            CreateImport.call(form) do
+              on(:ok) do
+                flash[:notice] = t(".success")
+              end
+
+              on(:invalid) do
+                flash[:alert] = t(".error")
+              end
+            end
+
+            redirect_to new_import_path
+          end
+
+          def workflows
+            workflows = configured_workflows & current_organization.available_authorizations.map.to_a
+            workflows.map do |workflow|
+              [t("#{workflow}.name", scope: "decidim.authorization_handlers"), workflow]
+            end
+          end
+
+          def configured_workflows
+            return Decidim::DirectVerifications.config.manage_workflows if Decidim::DirectVerifications.config
+
+            ["direct_verifications"]
+          end
+
+          def current_authorization_handler
+            params[:authorization_handler]
+          end
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/direct_verifications/registration_form.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    class RegistrationForm < OpenStruct
+    end
+  end
+end

data/app/forms/decidim/direct_verifications/verification/create_import_form.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      class CreateImportForm < Form
+        ACTIONS = {
+          "in" => :authorize,
+          "out" => :revoke,
+          "check" => :check
+        }.freeze
+
+        attribute :file
+        attribute :organization, Decidim::Organization
+        attribute :user, Decidim::User
+        attribute :authorize, String
+        attribute :register, Boolean
+        attribute :authorization_handler, String
+
+        validates :file, :organization, :user, :authorize, :authorization_handler, presence: true
+        validates :authorize, inclusion: { in: ACTIONS.keys }
+
+        validate :available_authorization_handler
+
+        def available_authorization_handler
+          return if authorization_handler.in?(organization.available_authorizations)
+
+          errors.add(:authorization_handler, :inclusion)
+        end
+
+        def action
+          if register && authorize == "in"
+            :register_and_authorize
+          elsif register
+            :register
+          else
+            ACTIONS[authorize]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "decidim/direct_verifications/instrumenter"
+
+module Decidim
+  module DirectVerifications
+    class AuthorizeUsersJob < BaseImportJob
+      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,
+            session,
+            organization,
+            instrumenter,
+            authorization_handler
+          ).call
+        end
+      end
+
+      def type
+        :authorized
+      end
+
+      private
+
+      def session
+        NullSession.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "decidim/direct_verifications/instrumenter"
+
+module Decidim
+  module DirectVerifications
+    # This class implements the logic to import the user entries and sending an email notification
+    # with the result. The specifics to process the entries are meant to be implemented by
+    # subclasses which must implement the `#process_users` and `#type` methods.
+    class BaseImportJob < ApplicationJob
+      queue_as :default
+
+      def perform(blob_id, organization, current_user, authorization_handler, options = {})
+        @blob = ActiveStorage::Blob.find(blob_id)
+        @organization = organization
+        @current_user = current_user
+        @authorization_handler = authorization_handler
+
+        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 :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(
+          current_user,
+          instrumenter,
+          type,
+          authorization_handler
+        ).deliver_now
+      end
+
+      def remove_file!
+        blob.purge
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "decidim/direct_verifications/instrumenter"
+
+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
+      end
+
+      def type
+        :registered
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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
+      end
+
+      def type
+        :revoked
+      end
+    end
+  end
+end

data/app/mailers/decidim/direct_verifications/import_mailer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    class ImportMailer < Decidim::Admin::ApplicationMailer
+      include LocalisedMailer
+
+      layout "decidim/mailer"
+
+      I18N_SCOPE = "decidim.direct_verifications.verification.admin.imports.mailer"
+
+      def finished_processing(user, instrumenter, type, handler)
+        @stats = Stats.from(instrumenter, type)
+        @organization = user.organization
+        @i18n_key = "#{I18N_SCOPE}.#{type}"
+        @handler = handler
+
+        with_user(user) do
+          mail(
+            to: user.email,
+            subject: I18n.t("#{I18N_SCOPE}.subject")
+          )
+        end
+      end
+    end
+  end
+end

data/app/mailers/decidim/direct_verifications/stats.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    class Stats
+      attr_reader :count, :successful, :errors
+
+      def self.from(instrumenter, type)
+        new(
+          count: instrumenter.emails_count(type),
+          successful: instrumenter.processed_count(type),
+          errors: instrumenter.errors_count(type)
+        )
+      end
+
+      def initialize(count:, successful:, errors:)
+        @count = count
+        @successful = successful
+        @errors = errors
+      end
+    end
+  end
+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/src/decidim/direct_verifications/admin/checkboxes.js

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

data/app/packs/stylesheets/decidim/direct_verifications/admin/authorizations.scss

@@ -0,0 +1,17 @@
+@import "stylesheets/decidim/admin/utils/settings";
+
+$code-color: $black;
+$code-font-family: $font-family-monospace;
+$code-font-weight: $global-weight-normal;
+$code-background: $light-gray;
+$code-border: 1px solid $medium-gray;
+$code-padding: rem-calc(2 5 1);
+
+.code {
+  background: $code-background;
+  color: $code-color;
+  font-family: $code-font-family;
+  font-weight: $code-font-weight;
+  border: $code-border;
+  padding: $code-padding;
+}

data/app/views/decidim/direct_verifications/import_mailer/finished_processing.html.erb

@@ -0,0 +1,7 @@
+<p><%= t(
+  @i18n_key,
+  count: @stats.count,
+  successful: @stats.successful,
+  errors: @stats.errors,
+  handler: @handler
+) %></p>

data/app/views/decidim/direct_verifications/import_mailer/finished_processing.text.erb

@@ -0,0 +1,7 @@
+<%= t(
+  @i18n_key,
+  count: @stats.count,
+  successful: @stats.successful,
+  errors: @stats.errors,
+  handler: @handler
+) %>

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

@@ -0,0 +1,43 @@
+<%= stylesheet_pack_tag "decidim_direct_verifications" %>
+
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= t(".title") %>
+      <%= link_to t("admin.index.stats", scope: "decidim.direct_verifications.verification"), stats_path, class: "button tiny button--title" %>
+      <%= link_to t(".new_import"), direct_verifications_path, class: "button tiny button--title" %>
+    </h2>
+  </div>
+  <div class="card-section">
+    <div class="table-scroll">
+      <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t(".name") %></th>
+            <th><%= t(".metadata") %></th>
+            <th><%= t(".user_name") %></th>
+            <th><%= t(".created_at") %></th>
+            <th>&nbsp;</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @authorizations.each do |authorization| %>
+            <tr data-authorization-id="<%= authorization.id %>">
+              <td><%= authorization.name %></td>
+              <td class="metadata">
+                <span class="code"><%= authorization.metadata %></span>
+              </td>
+              <td><%= authorization.user.name %></td>
+              <td><%= authorization.created_at %></td>
+
+              <td class="table-list__actions">
+                <%= icon_link_to "circle-x", authorization_path(authorization), t("actions.destroy", scope: "decidim.admin"), class: "action-icon--remove", method: :delete, data: { confirm: t("actions.confirm_destroy", scope: "decidim.admin") } %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+      <%= paginate @authorizations, theme: "decidim" %>
+    </div>
+  </div>
+</div>