decidim-cleaner 1.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9fd35840bd986218c10726232aa523b811331ec05cb78d6ae52b0352e434862
-  data.tar.gz: 2edf1e583c38516e4d7eefd51f4116cb883e4f823643c605df4f40ae4718684f
+  metadata.gz: 7667514845e0dddc19580aa0762d5218b93e1a24b75e5053856c8d1b7d748e0e
+  data.tar.gz: e39fbda595e2082802936da1a446b6e9a943d6dbb3c611dd2d67539c2a72e700
 SHA512:
-  metadata.gz: e0c59579a5fe21080c697d6553b2983b21f242d62687c7fb7e700e86c5a01617762cdd8019a0b9258719d1534f5be29a00faa0580208ae92c31dc6fedb6d536f
-  data.tar.gz: aca024679460c2a7fd0896e426c3b2de5f6aee923595b572bdfae1f2cb419090ae5a5dba6d898d4e38a744b67a0caff17b2ed2eb583bd883156cad4c063df912
+  metadata.gz: 334ed4a155cbafd585244e53d6e080145c046894411ef9bec85d9fab00d9d9e89f8a7fc75b30c8eeef761a913183a3474543108b1e5ff6bbb624ab9a0dfbdad0
+  data.tar.gz: 76f39a3e96f7a152efc8420c2b352825f3d544826a7dac395f1f7d2025e82b3e81412b6b6144d93342f0c799c825a1f52c89548761362a45aa2306e511e56ca9

data/README.md

@@ -22,6 +22,24 @@ bundle exec rails decidim_cleaner:install:migrations
 bundle exec rails db:migrate
 ```
 
+You can then modify the default values of the cleaner in your .ENV with the following variables:
+
+```bash
+# Delay until a user is considered inactive and receive a warning email (in days)
+DECIDIM_CLEANER_INACTIVE_USERS_MAIL=
+
+# Delay until a user is deleted after receiving an email (in days)
+DECIDIM_CLEANER_DELETE_INACTIVE_USERS=
+
+# Delay until an admin log is deleted (in days)
+DECIDIM_CLEANER_DELETE_ADMIN_LOGS=
+```
+
+### Sidekiq Scheduler
+[Further documentation](https://github.com/sidekiq-scheduler/sidekiq-scheduler)
+
+**Sidekiq scheduler uses a 6 columns format**
+
 You can then add to your 'config/sidekiq.yml' file:
 
 ```yaml
@@ -36,6 +54,15 @@ You can then add to your 'config/sidekiq.yml' file:
     queue: scheduled
 ```
 
+### Cronjob
+```
+# Warns and deletes inactive users
+0 9 * * * cd /home/user/decidim_application && RAILS_ENV=production bundle exec rake decidim_cleaner:clean_inactive_users
+
+# Deletes old admin logs
+0 9 * * * cd /home/user/decidim_application && RAILS_ENV=production bundle exec rake decidim_cleaner:clean_admin_logs
+```
+
 ## Available tasks
 
 - [ ] **Delete inactive users**

data/app/commands/decidim/cleaner/admin/update_organization_cleaner.rb

@@ -5,7 +5,7 @@ module Decidim
     module Admin
       # A command with all the business logic for updating the current
       # organization cleaner.
-      class UpdateOrganizationCleaner < Decidim::Command
+      class UpdateOrganizationCleaner < Rectify::Command
         # Public: Initializes the command.
         #
         # organization - The Organization that will be updated.

data/app/helpers/decidim/cleaner/delays_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Cleaner
+    module DelaysHelper
+      def email_inactive_after(organization)
+        organization.delete_inactive_users_email_after || Decidim::Cleaner.delete_inactive_users_email_after
+      end
+
+      def delete_inactive_after(organization)
+        organization.delete_inactive_users_after || Decidim::Cleaner.delete_inactive_users_after
+      end
+    end
+  end
+end

data/app/jobs/decidim/cleaner/clean_admin_logs_job.rb

@@ -10,10 +10,16 @@ module Decidim
           next unless organization.delete_admin_logs?
 
           Decidim::ActionLog.where(organization: organization)
-                            .where("created_at < ?", Time.zone.now - (organization.delete_admin_logs_after || 365).days)
+                            .where("created_at < ?", delete_admin_logs_before_date(organization))
                             .delete_all
         end
       end
+
+      private
+
+      def delete_admin_logs_before_date(organization)
+        Time.zone.now - (organization.delete_admin_logs_after || Decidim::Cleaner.delete_admin_logs_after).days
+      end
     end
   end
 end

data/app/jobs/decidim/cleaner/clean_inactive_users_job.rb

@@ -10,25 +10,32 @@ module Decidim
           next unless organization.delete_inactive_users?
 
           send_warning(Decidim::User.where(organization: organization)
-                                    .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days)
-                                    .where("last_sign_in_at > ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days - 1.day))
+                                    .not_deleted
+                                    .where.not(email: "")
+                                    .where("last_sign_in_at < ?", email_inactive_before_date(organization)))
           delete_user_and_send_email(Decidim::User.where(organization: organization)
-                                                  .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_after || 390).days))
+                                                  .not_deleted
+                                                  .where.not(email: "")
+                                                  .where("warning_date < ?", delete_inactive_before_date(organization)))
         end
       end
 
       def send_warning(users)
         users.find_each do |user|
-          next if user.deleted?
+          next if user.warning_date.present?
 
-          InactiveUsersMailer.warning_inactive(user).deliver_now
+          user.update!(warning_date: Time.zone.now) if InactiveUsersMailer.warning_inactive(user).deliver_now
           Rails.logger.info "Inactive warning sent to #{user.email}"
         end
       end
 
       def delete_user_and_send_email(users)
         users.find_each do |user|
-          next if user.deleted?
+          if user.last_sign_in_at > user.warning_date
+            user.update!(warning_date: nil)
+            Rails.logger.info "User with id #{user.id} has logged in again, warning date reset"
+            next
+          end
 
           InactiveUsersMailer.warning_deletion(user).deliver_now
           Rails.logger.info "Deletion warning sent to #{user.email}"
@@ -37,6 +44,16 @@ module Decidim
           Rails.logger.info "User with id #{user.id} destroyed"
         end
       end
+
+      private
+
+      def email_inactive_before_date(organization)
+        Time.zone.now - (organization.delete_inactive_users_email_after || Decidim::Cleaner.delete_inactive_users_email_after).days
+      end
+
+      def delete_inactive_before_date(organization)
+        Time.zone.now - (organization.delete_inactive_users_after || Decidim::Cleaner.delete_inactive_users_after).days
+      end
     end
   end
 end

data/app/mailers/decidim/cleaner/inactive_users_mailer.rb

@@ -5,6 +5,7 @@ module Decidim
     # A custom mailer for Decidim so we can notify users
     # when their account was blocked
     class InactiveUsersMailer < Decidim::ApplicationMailer
+      helper Decidim::Cleaner::DelaysHelper
       def warning_inactive(user)
         with_user(user) do
           @user = user

data/app/views/decidim/cleaner/inactive_users_mailer/warning_deletion.html.erb

@@ -1,6 +1,6 @@
 <p class="email-greeting"><%= t ".hello" %></p>
 
-<p class="email-instructions"><%= t(".body_1", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host), days: @organization.delete_inactive_users_after||390).html_safe %></p>
+<p class="email-instructions"><%= t(".body_1", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host), days: email_inactive_after(@organization) + delete_inactive_after(@organization)).html_safe %></p>
 
 <p class="email-instructions"><%= t ".body_2" %></p>
 

data/app/views/decidim/cleaner/inactive_users_mailer/warning_inactive.html.erb

@@ -1,7 +1,7 @@
 <p class="email-greeting"><%= t ".hello" %></p>
 
-<p class="email-instructions"><%= t ".body_1", organization_name: h(@organization.name), days: @organization.delete_inactive_users_email_after %></p>
+<p class="email-instructions"><%= t ".body_1", organization_name: h(@organization.name), days: email_inactive_after(@organization) %></p>
 
-<p class="email-instructions"><%= t(".body_2", remaining_days: (@organization.delete_inactive_users_after||390) - (@organization.delete_inactive_users_email_after||365), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>
+<p class="email-instructions"><%= t(".body_2", remaining_days: delete_inactive_after(@organization), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>
 
 <p class="email-closing"><%= t(".greetings", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>

data/config/locales/en.yml

@@ -6,7 +6,8 @@ en:
         delete_admin_logs: Enable admin logs deletion
         delete_admin_logs_after: Delete admin logs after (days, default 365)
         delete_inactive_users: Enable inactive users deletion
-        delete_inactive_users_after: Delete inactive users after (days, default 390)
+        delete_inactive_users_after: Delete inactive users x days after the mail(days,
+          default 30)
         delete_inactive_users_email_after: Send email to inactive users before deletion
           (days, default 365)
   decidim:

data/config/locales/fr.yml

@@ -7,8 +7,8 @@ fr:
         delete_admin_logs_after: Supprimer l'historique d'administration après (jours,
           par défaut 365)
         delete_inactive_users: Activer la suppression des utilisateurs inactifs
-        delete_inactive_users_after: Supprimer les utilisateurs inactifs après (jours,
-          par défaut 390)
+        delete_inactive_users_after: Supprimer les utilisateurs inactifs au bout de
+          x jours après le courriel (jours, par défaut 30)
         delete_inactive_users_email_after: Envoyer un courriel aux utilisateurs inactifs
           avant la suppression (jours, par défaut 365)
   decidim:

data/db/migrate/20230106105014_add_delete_admin_logs_to_organization.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddDeleteAdminLogsToOrganization < ActiveRecord::Migration[6.1]
+class AddDeleteAdminLogsToOrganization < ActiveRecord::Migration[5.2]
   def change
     add_column :decidim_organizations, :delete_admin_logs, :boolean, default: false, null: false
     add_column :decidim_organizations, :delete_admin_logs_after, :integer

data/db/migrate/20230110150032_add_delete_inactive_users_to_organization.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddDeleteInactiveUsersToOrganization < ActiveRecord::Migration[6.1]
+class AddDeleteInactiveUsersToOrganization < ActiveRecord::Migration[5.2]
   def change
     add_column :decidim_organizations, :delete_inactive_users, :boolean, default: false, null: false
     add_column :decidim_organizations, :delete_inactive_users_email_after, :integer

data/db/migrate/20230328094652_add_warning_date_to_users.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddWarningDateToUsers < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_users, :warning_date, :datetime
+  end
+end

data/lib/decidim/cleaner/version.rb

@@ -5,11 +5,11 @@ module Decidim
   # This holds the decidim-meetings version.
   module Cleaner
     def self.version
-      "1.0.1"
+      "2.1.0"
     end
 
-    def self.decidim_version
-      "0.26"
+    def self.compatible_decidim_version
+      "0.26.0"
     end
   end
 end

data/lib/decidim/cleaner.rb

@@ -7,5 +7,18 @@ require "decidim/cleaner/admin_engine"
 module Decidim
   # This namespace holds the logic of the `Cleaner` module.
   module Cleaner
+    include ActiveSupport::Configurable
+
+    config_accessor :delete_admin_logs_after do
+      ENV.fetch("DECIDIM_CLEANER_DELETE_ADMIN_LOGS", "365").to_i
+    end
+
+    config_accessor :delete_inactive_users_after do
+      ENV.fetch("DECIDIM_CLEANER_DELETE_INACTIVE_USERS", "30").to_i
+    end
+
+    config_accessor :delete_inactive_users_email_after do
+      ENV.fetch("DECIDIM_CLEANER_INACTIVE_USERS_MAIL", "365").to_i
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-cleaner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Quentinchampenois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: 0.26.0
 description: Clean outdated data in Decidim's database.
 email:
 - 26109239+Quentinchampenois@users.noreply.github.com
@@ -38,6 +38,7 @@ files:
 - app/controllers/decidim/cleaner/admin/application_controller.rb
 - app/controllers/decidim/cleaner/admin/organization_cleaner_controller.rb
 - app/forms/decidim/cleaner/admin/organization_cleaner_form.rb
+- app/helpers/decidim/cleaner/delays_helper.rb
 - app/jobs/decidim/cleaner/clean_admin_logs_job.rb
 - app/jobs/decidim/cleaner/clean_inactive_users_job.rb
 - app/mailers/decidim/cleaner/inactive_users_mailer.rb
@@ -52,6 +53,7 @@ files:
 - config/routes.rb
 - db/migrate/20230106105014_add_delete_admin_logs_to_organization.rb
 - db/migrate/20230110150032_add_delete_inactive_users_to_organization.rb
+- db/migrate/20230328094652_add_warning_date_to_users.rb
 - lib/decidim/cleaner.rb
 - lib/decidim/cleaner/admin.rb
 - lib/decidim/cleaner/admin_engine.rb