support for CSV and multiple columns

.gitignore

@@ -18,3 +18,7 @@ spec/decidim_dummy_app
 
 # default development application
 development_app
+
+.byebug_history
+.ruby-version
+tags

Gemfile.lock

@@ -109,10 +109,9 @@ GEM
       cells (>= 4.1.6, < 5.0.0)
     charlock_holmes (0.7.7)
     childprocess (3.0.0)
-    codecov (0.1.16)
+    codecov (0.2.11)
       json
       simplecov
-      url
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     coffee-rails (5.0.0)
@@ -428,7 +427,7 @@ GEM
       thor (>= 0.14, < 2.0)
     jquery-tmpl-rails (1.1.0)
       rails (>= 3.1.0)
-    json (2.3.0)
+    json (2.3.1)
     jwt (2.2.1)
     kaminari (1.2.0)
       activesupport (>= 4.1.0)
@@ -708,7 +707,6 @@ GEM
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.6.1)
-    url (0.3.2)
     valid_email2 (2.3.1)
       activemodel (>= 3.2)
       mail (~> 2.5)
@@ -757,7 +755,7 @@ DEPENDENCIES
   web-console (~> 3.5)
 
 RUBY VERSION
-   ruby 2.6.3p62
+   ruby 2.6.6p146
 
 BUNDLED WITH
    2.1.4

README.md

@@ -37,6 +37,21 @@ 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 called `config/initializers/decidim_direct_verifications.rb` with the following contents
+
+```rb
+Rails.application.config.direct_verifications_parser = :metadata
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

app/commands/decidim/direct_verifications/verification/base_parser.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      # Abstract class all concrete parsers should inherit from. They are expected to implement
+      # #header, #lines, and #parse_data methods.
+      class BaseParser
+        EMAIL_REGEXP = /([A-Z0-9+._-]+@[A-Z0-9._-]+\.[A-Z0-9_-]+)\b/i.freeze
+
+        def initialize(txt)
+          @txt = txt
+          @emails = {}
+        end
+
+        def to_h
+          lines.each do |line|
+            EMAIL_REGEXP.match(line) do |match|
+              email = normalize(match[0])
+              emails[email] = parse_data(email, line, header)
+            end
+          end
+
+          emails
+        end
+
+        private
+
+        attr_reader :txt, :emails
+
+        def normalize(value)
+          value.to_s.downcase
+        end
+      end
+    end
+  end
+end

app/commands/decidim/direct_verifications/verification/metadata_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      class MetadataParser < BaseParser
+        def header
+          header_row = lines[0].chomp
+          column_names = tokenize(header_row)
+          column_names.map(&:to_sym).map(&:downcase)
+        end
+
+        def lines
+          @lines ||= StringIO.new(txt).readlines
+        end
+
+        def parse_data(email, line, header)
+          tokens = tokenize(line)
+
+          hash = {}
+          header.each_with_index do |column, index|
+            value = tokens[index].strip
+            next if value.include?(email)
+
+            hash[column] = value
+          end
+          hash
+        end
+
+        private
+
+        def tokenize(line)
+          CSV.parse(line)[0]
+        end
+      end
+    end
+  end
+end

app/commands/decidim/direct_verifications/verification/name_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DirectVerifications
+    module Verification
+      class NameParser < BaseParser
+        LINE_DELIMITER = /[\r\n;,]/.freeze
+        NON_ALPHA_CHARS = /[^[:print:]]|[\"\$\<\>\|\\]/.freeze
+
+        def header
+          nil
+        end
+
+        def lines
+          txt.split(LINE_DELIMITER)
+        end
+
+        def parse_data(email, line, _header)
+          name = parse_name(email, line)
+          name = strip_non_alpha_chars(name)
+          name.presence || fallback_name(email)
+        end
+
+        private
+
+        def strip_non_alpha_chars(str)
+          (str.presence || "").gsub(NON_ALPHA_CHARS, "").strip
+        end
+
+        def parse_name(email, line)
+          line.split(email).first
+        end
+
+        def fallback_name(email)
+          email.split("@").first
+        end
+      end
+    end
+  end
+end

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

@@ -20,11 +20,14 @@ def create
 
             @userlist = params[:userlist]
             @workflows = workflows
+
             processor = UserProcessor.new(current_organization, current_user)
-            processor.emails = extract_emails_to_hash @userlist
+            processor.emails = parser_class.new(@userlist).to_h
             processor.authorization_handler = authorization_handler(params[:authorization_handler])
+
             stats = UserStats.new(current_organization)
             stats.authorization_handler = processor.authorization_handler
+
             if params[:register]
               processor.register_users
               flash[:warning] = t(".registered", count: processor.emails.count,
@@ -52,21 +55,18 @@ def create
                                         registered: stats.registered)
               render(action: :index) && return
             end
+
             redirect_to direct_verifications_path
           end
 
           private
 
-          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
+          def parser_class
+            if Rails.configuration.direct_verifications_parser == :metadata
+              MetadataParser
+            else
+              NameParser
             end
-            emails
           end
 
           def authorization_handler(authorization_handler)

lib/decidim/direct_verifications/user_processor.rb

@@ -12,17 +12,19 @@ def initialize(organization, current_user)
         @emails = {}
       end
 
-      attr_reader :organization, :current_user, :errors, :processed, :emails
-      attr_accessor :authorization_handler
-
-      def emails=(email_list)
-        @emails = email_list.map { |k, v| [k.to_s.downcase, v.presence || k.split("@").first] }.to_h
-      end
+      attr_reader :organization, :current_user, :errors, :processed
+      attr_accessor :authorization_handler, :emails
 
       def register_users
-        @emails.each do |email, name|
+        emails.each do |email, data|
           next if find_user(email)
 
+          name = if data.is_a?(Hash)
+                   data[:name]
+                 else
+                   data
+                 end
+
           form = register_form(email, name)
           begin
             InviteUser.call(form) do
@@ -41,9 +43,11 @@ def register_users
       end
 
       def authorize_users
-        @emails.each do |email, _name|
+        emails.each do |email, data|
           if (u = find_user(email))
             auth = authorization(u)
+            auth.metadata = data
+
             next unless !auth.granted? || auth.expired?
 
             Verification::ConfirmUserAuthorization.call(auth, authorize_form(u)) do
@@ -61,7 +65,7 @@ def authorize_users
       end
 
       def revoke_users
-        @emails.each do |email, _name|
+        emails.each do |email, _name|
           if (u = find_user(email))
             auth = authorization(u)
             next unless auth.granted?
@@ -87,14 +91,18 @@ def find_user(email)
       end
 
       def register_form(email, name)
-        OpenStruct.new(name: name.presence || email.split("@").first,
+        OpenStruct.new(name: name.presence || fallback_name(email),
                        email: email.downcase,
                        organization: organization,
                        admin: false,
                        invited_by: current_user,
                        invitation_instructions: "direct_invite")
       end
 
+      def fallback_name(email)
+        email.split("@").first
+      end
+
       def authorization(user)
         Authorization.find_or_initialize_by(
           user: user,

lib/decidim/direct_verifications/verification/engine.rb

@@ -6,6 +6,8 @@ module Verification
       class Engine < ::Rails::Engine
         isolate_namespace Decidim::DirectVerifications::Verification
 
+        config.direct_verifications_parser = :name
+
         paths["db/migrate"] = nil
         paths["lib/tasks"] = nil