decidim-cdtb 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 515d740942f3089a3cb906fab890191dc4b19f97c98ccff17fac5aac2aa83d9e
-  data.tar.gz: 557fa8a269b25d0ac8b15c522d16072600c0b5a0d39fee2250cf9c80299486ab
+  metadata.gz: 7ea237b7898bc194b0f63514d1f699d5cd1cf649ac7dd7433de19d9319541474
+  data.tar.gz: be9a6f3251d35022b933524b3227edac2186a1c338a4025f6d73eb5495633e61
 SHA512:
-  metadata.gz: 519c7234a2cff3adba2732e07e4fb9c2aa111fb0803ac8cac8180a9683c501676bb2f0aa96059f1a5cedd063db98471f70e1321d33be0e8db4a9947341df3b6a
-  data.tar.gz: be0c056d4b91a543a528628b4f820fd06a7913899c12f3fa4e5db646ddbd1599970fcba41d67d583472b53abe2eef447e8b0d4aede8d83222617e3f3d80f9df8
+  metadata.gz: 3999c77a44817f3c0b3bc6b97663a47f3dade93f896958cdce06298bd9695d734cdd82859315607ecc3fcd990efd6e567e2e63d6e0141f5c3d256bc44d6b91ef
+  data.tar.gz: 513123ffe284a654f47666d8a0e355b29cb3dd011a30bab73cdef0348776f45cd44dab8c8c9f23f5e962fb5f00a5dc9acb9d68a70ced7b39335cfc225ce56839

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.1.7] - 2024-04-22 (Emocions de colors)
+
+- Fix remove users task and add the reporter user mailer to arguments
+
+## [0.1.6] - 2024-04-11 (Malifetes ben fetes)
+
+- Add remover users task
+
+## [0.1.5] - 2024-02-08 (Pastissos voladors de colors)
+
+- Fix homepage in rubygems.org
+- Add organization id and name in spam csv
+
 ## [0.1.4] - 2024-01-30 (Peus grans com gegants)
 
 - Add users spam detector task

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decidim-cdtb (0.1.4)
+    decidim-cdtb (0.1.7)
       decidim (>= 0.26.2)
       rails (>= 6)
       ruby-progressbar

data/README.md

@@ -36,17 +36,6 @@ bin/rake cdtb:org_by_host_like[vila]
 host: localhost, time_zone: Madrid, locales: ca + [ca, es, oc], available authorizations: [postal_letter, members_picker_authorization_handler]
 ```
 
-### Fix nicknames
-
-In a previous version than Decidim v0.25 a validation to the `Decidim::User.nickname` was added with a migration to fix existing nicknames. But the migration was only taking into acocunt managed (impersonated) users.
-
-This task iterates (with `find_each`) over all non managed users and nicknamizes the nickname.
-
-To execute the task run:
-
-```
-bin/rake cdtb:fix_nicknames
-```
 
 ### Anonymize production dump
 
@@ -98,6 +87,36 @@ Decidim::Cdtb.configure do |config|
 end
 ```
 
+### Users
+
+Tasks related with users.
+
+### Fix nicknames
+
+In a previous version than Decidim v0.25 a validation to the `Decidim::User.nickname` was added with a migration to fix existing nicknames. But the migration was only taking into account managed (impersonated) users.
+
+This task iterates (with `find_each`) over all non managed users and nicknamizes the nickname.
+
+To execute the task run:
+
+```
+bin/rake cdtb:users:fix_nicknames
+```
+
+#### Remove users
+
+You can delete users through a CSV with the user ID and a reporter user mailer. The purpose is to be able to eliminate potentially spammy users.
+
+This task reports and hide the user's comments, blocks the user, and finally deletes the user.
+
+The CSV will have a header and one column with the user ID.
+
+To execute the task run:
+
+```
+bundle exec rake cdtb:users:remove[spam_users.csv, reporter_user@example.org]
+```
+
 ### Upgrades:
 
 #### Upgrade modules

data/decidim-cdtb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "CodiTramuntana's Decidim Toolbelt (cdtb)."
   spec.description = "A gem to help managing Decidim applications."
-  spec.homepage = "http://github.com/CodiTramunana/cdtb"
+  spec.homepage = "https://github.com/CodiTramuntana/decidim-module-cdtb"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.7.5"
 

data/lib/decidim/cdtb/spam/user_spam_detector.rb

@@ -35,11 +35,12 @@ module Decidim
           @num_users
         end
 
+        # rubocop:disable Metrics/AbcSize
         def do_execution(context)
           progress_bar = context[:progress_bar]
-
           CSV.open("spam_users.csv", "w") do |csv|
-            csv_headers = ["ID", "Is suspicious?", "Name", "Email", "Nickname", "Personal URL", "About"]
+            csv_headers = ["ID", "Is suspicious?", "Name", "Email", "Nickname", "Personal URL", "About",
+                           "Organization ID", "Organization Name"]
             csv << csv_headers
 
             @users.find_each do |user|
@@ -50,12 +51,14 @@ module Decidim
                 @num_applied+= 1
               end
 
-              csv << [user.id, suspicious, user.name, user.email, user.nickname, user.personal_url, user.about]
+              csv << [user.id, suspicious, user.name, user.email, user.nickname, user.personal_url, user.about,
+                      user.organization.id, user.organization.name]
 
               progress_bar.increment
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         def end_execution(_ctx)
           if @num_applied.positive?

data/lib/decidim/cdtb/tasks.rb

@@ -3,6 +3,7 @@
 require "decidim/cdtb/tasks_utils"
 require "decidim/cdtb/task"
 require "decidim/cdtb/fixes/nickname_fixer"
+require "decidim/cdtb/users/remover"
 require "decidim/cdtb/multitenants/org_by_host_like"
 require "decidim/cdtb/spam/user_spam_detector"
 require "decidim/cdtb/storage/local_sharding"

data/lib/decidim/cdtb/users/remover.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cdtb
+    module Users
+      # Remove Decidim::User's
+      #
+      class Remover < ::Decidim::Cdtb::Task
+        def initialize(csv_path, reporter_user_email)
+          @csv_path = csv_path
+          @reporter_user_email = reporter_user_email
+          progress_bar = { title: "Decidim::User" }
+          super("USER REMOVER", progress_bar: progress_bar)
+        end
+
+        def prepare_execution(_ctx); end
+
+        def total_items
+          File.open(@csv_path).readlines.size - 1
+        end
+
+        def do_execution(context)
+          progress_bar = context[:progress_bar]
+
+          CSV.foreach(@csv_path, headers: true, col_sep: ",") do |row|
+            user = Decidim::User.find_by(id: row[0])
+            next unless user.present?
+
+            reporter_user = Decidim::User.find_by(email: @reporter_user_email,
+                                                  organization: user.organization)
+            comments = Decidim::Comments::Comment.where(decidim_author_id: user.id)
+            manage_comments(comments, user, reporter_user) unless comments.empty?
+            destroy_user(user) if block_user(user, reporter_user)
+            progress_bar.increment
+          end
+        end
+
+        def end_execution(_ctx)
+          log_task_step("#{@num_applied} users removed")
+        end
+
+        private
+
+        def manage_comments(comments, user, reporter_user)
+          comments.find_each do |comment|
+            report_comment(comment, user, reporter_user)
+          end
+        end
+
+        def block_user(user, reporter_user)
+          params = {
+            user_id: user.id,
+            justification: "Confirmed spam suspicious"
+          }
+
+          form = Decidim::Admin::BlockUserForm.from_params(params).with_context(
+            {
+              current_organization: user.organization,
+              current_user: reporter_user
+            }
+          )
+
+          Decidim::Admin::BlockUser.call(form) do
+            on(:ok) do
+              puts "OK: User #{user.id} blocked"
+              return true
+            end
+
+            on(:invalid) do
+              puts "ERROR: User #{user.id} not blocked"
+              return false
+            end
+          end
+        end
+
+        def destroy_user(user)
+          params = {
+            delete_reason: "Confirmed spam suspicious"
+          }
+
+          form = Decidim::DeleteAccountForm.from_params(params)
+
+          Decidim::DestroyAccount.call(user, form) do
+            on(:ok) do
+              puts "OK: User #{user.id} removed"
+            end
+
+            on(:invalid) do
+              puts "ERROR: User #{user.id} not removed"
+            end
+          end
+        end
+
+        def report_comment(comment, user, reporter_user)
+          params = {
+            reason: "spam",
+            details: "Spam message"
+          }
+
+          form = Decidim::ReportForm.from_params(params).with_context(context_for_report(user, comment, reporter_user))
+          reportable = GlobalID::Locator.locate_signed(comment.to_sgid.to_s)
+
+          Decidim::CreateReport.call(form, reportable, reporter_user) do
+            on(:ok) do
+              puts "OK: Comment #{comment.id} of User #{user.id} reported"
+            end
+
+            on(:invalid) do
+              puts "ERROR: Comment #{comment.id} of User #{user.id} not reported"
+            end
+          end
+        end
+
+        def context_for_report(user, comment, reporter_user)
+          {
+            current_organization: user.organization,
+            current_component: comment.component,
+            current_user: reporter_user,
+            current_participatory_space: comment.participatory_space
+          }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/cdtb/version.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   module Cdtb
-    VERSION = "0.1.4"
+    VERSION = "0.1.7"
     DECIDIM_MIN_VERSION = ">= 0.26.2"
   end
 end

data/lib/tasks/users.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "decidim/cdtb/tasks"
+
+namespace :cdtb do
+  namespace :users do
+    desc <<~EODESC
+      Fix Decidim::User's nicknames.
+    EODESC
+    task fix_nicknames: [:environment] do
+      fixer= ::Decidim::Cdtb::Fixes::NicknameFixer.new
+      fixer.execute!
+    end
+
+    desc <<~EODESC
+      Remove Decidim::User's by IDs in a CSV.
+    EODESC
+    task :remove, %i[csv_path reporter_user_email] => [:environment] do |_taks, args|
+      service = ::Decidim::Cdtb::Users::Remover.new(args.csv_path, args.reporter_user_email)
+      service.execute!
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-cdtb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Oliver Valls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim
@@ -114,24 +114,25 @@ files:
 - lib/decidim/cdtb/upgrades/install_gem_migrations_step.rb
 - lib/decidim/cdtb/upgrades/upgrade_modules_task.rb
 - lib/decidim/cdtb/upgrades/validate_migrations_task.rb
+- lib/decidim/cdtb/users/remover.rb
 - lib/decidim/cdtb/version.rb
 - lib/generators/cdtb/USAGE
 - lib/generators/cdtb/templates/validate_migrations.yml
 - lib/generators/cdtb/validate_migrations_ci_generator.rb
 - lib/tasks/anonymize.rake
-- lib/tasks/cdtb.rake
 - lib/tasks/multitenants.rake
 - lib/tasks/spam.rake
 - lib/tasks/storage.rake
 - lib/tasks/upgrade.rake
+- lib/tasks/users.rake
 - sig/decidim/cdtb.rbs
-homepage: http://github.com/CodiTramunana/cdtb
+homepage: https://github.com/CodiTramuntana/decidim-module-cdtb
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://github.com/CodiTramunana/cdtb
-  source_code_uri: http://github.com/CodiTramunana/cdtb
-  changelog_uri: http://github.com/CodiTramunana/cdtb/CHANGELOG.md
+  homepage_uri: https://github.com/CodiTramuntana/decidim-module-cdtb
+  source_code_uri: https://github.com/CodiTramuntana/decidim-module-cdtb
+  changelog_uri: https://github.com/CodiTramuntana/decidim-module-cdtb/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/tasks/cdtb.rake

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "decidim/cdtb/tasks"
-
-namespace :cdtb do
-  desc <<~EODESC
-    Fix Decidim::User's nicknames.
-  EODESC
-  task fix_nicknames: [:environment] do
-    fixer= ::Decidim::Cdtb::Fixes::NicknameFixer.new
-    fixer.execute!
-  end
-end