decidim-core 0.12.2 → 0.13.0.pre1

data/lib/decidim/data_portability_file_reader.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class generates the information needed to be read by DataPortability.
+  # It creates the file_name, file_path, check that the token is valid and generates the token if no exists. Originally
+  # meant for DataPortability functionality and adding user images to this file, but other usage can be found.
+  class DataPortabilityFileReader
+    # Public: Initialize the reader with a user, and token
+    #
+    # user     - The user of data portability to be zipped.
+    # token    - The token to be send by email, and return to controller.
+    def initialize(user, token = nil)
+      @user = user
+      @organization = user.organization
+      @token = token
+    end
+
+    # Returns a String with the filename of the file to be read or generate.
+    def file_name
+      name = ""
+      name += @user.nickname
+      name += "-"
+      name += @organization.name.parameterize
+      name += "-"
+      name += token
+      name + ".zip"
+    end
+
+    # Returns a String with the absolute file_path to be read or generate.
+    def file_path
+      directory_name = Rails.root.join(Decidim::DataPortabilityUploader.new.store_dir)
+      Dir.mkdir(directory_name) unless File.exist?(directory_name)
+      directory_name + file_name
+    end
+
+    def file_path_reader
+      Decidim::DataPortabilityUploader.new.retrieve_from_store!(file_name)
+    end
+
+    # Check if token is present and length equal 10
+    def valid_token?
+      token.present? && token.length == 10
+    end
+
+    # Returns a the token or generate a new one
+    def token
+      @token ||= generate_new_token
+    end
+
+    private
+
+    def generate_new_token
+      SecureRandom.base58(10)
+    end
+  end
+end

data/lib/decidim/data_portability_file_zipper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "zip"
+
+module Decidim
+  # This class performs a task: Creating a Zip file of all DataPortability classes. Originally
+  # meant for DataPortability functionality and adding user images to this file, but other usage can be found.
+  class DataPortabilityFileZipper < Decidim::DataPortabilityFileReader
+    # Public: Initializes the zipper with a user, data, and images to
+    # be zipped.
+    #
+    # user     - The user of data portability to be zipped.
+    # data     - An array of all data to be zipped.
+    # images   - An array of image urls to be inclueded in the zipped file.
+    def initialize(user, data, images, token = nil)
+      super(user, token)
+      @export_data = data
+      @export_images = images
+    end
+
+    # Public: Zips the file.
+    #
+    # Returns a String with the zipped version of the file.
+    def make_zip
+      Zip::OutputStream.open(file_path) do |zos|
+        @export_data.each do |element|
+          filename_file = element.last.filename(element.first.parameterize)
+
+          zos.put_next_entry(filename_file)
+          if element.last.read.presence
+            zos.write element.last.read
+          else
+            zos.write "No data"
+          end
+        end
+      end
+
+      zipfile = Zip::File.open(file_path)
+      @export_images.each do |image_block|
+        next if image_block.last.nil?
+        image_block.last.each do |image|
+          next if image.file.nil?
+          folder_name = image_block.first.parameterize
+          uploader = Decidim::ApplicationUploader.new(image.model, image.mounted_as)
+          uploader.cache!(File.open(image.file.file))
+          uploader.retrieve_from_store!(image.file.filename)
+          my_image_path = File.open(image.file.file)
+          next unless File.exist?(my_image_path)
+          zipfile.add("#{folder_name}/#{image.file.filename}", my_image_path)
+        end
+      end
+      zipfile.close
+    end
+  end
+end

data/lib/decidim/data_portability_serializers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DataPortabilitySerializers
+    autoload :DataPortabilityUserSerializer, "decidim/data_portability_serializers/data_portability_user_serializer"
+    autoload :DataPortabilityUserGroupSerializer, "decidim/data_portability_serializers/data_portability_user_group_serializer"
+    autoload :DataPortabilityConversationSerializer, "decidim/data_portability_serializers/data_portability_conversation_serializer"
+    autoload :DataPortabilityReportSerializer, "decidim/data_portability_serializers/data_portability_report_serializer"
+    autoload :DataPortabilityFollowSerializer, "decidim/data_portability_serializers/data_portability_follow_serializer"
+    autoload :DataPortabilityNotificationSerializer, "decidim/data_portability_serializers/data_portability_notification_serializer"
+    autoload :DataPortabilityIdentitySerializer, "decidim/data_portability_serializers/data_portability_identity_serializer"
+    autoload :DataPortabilityParticipatorySpacePrivateUserSerializer, "decidim/data_portability_serializers/data_portability_participatory_space_private_user_serializer"
+
+    def self.data_entities
+      ["Decidim::Follow", "Decidim::Identity",
+       "Decidim::Messaging::Conversation", "Decidim::Notification",
+       "Decidim::ParticipatorySpacePrivateUser", "Decidim::Report", "Decidim::User", "Decidim::UserGroup"] |
+        Decidim.component_manifests.map(&:data_portable_entities).flatten |
+        Decidim.participatory_space_manifests.map(&:data_portable_entities).flatten |
+        (Decidim::Comments.data_portable_entities.flatten if defined?(Decidim::Comments))
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_conversation_serializer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a Message so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityConversationSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Initializes the serializer with a conversation.
+      def initialize(conversation)
+        @conversation = conversation
+      end
+
+      # Public: Exports a hash with the serialized data for this conversation.
+      def serialize
+        {
+          id: conversation.id,
+          messages: messages,
+          created_at: conversation.created_at,
+          updated_at: conversation.updated_at
+        }
+      end
+
+      private
+
+      attr_reader :conversation
+
+      def messages
+        conversation.messages.map do |message|
+          {
+            message_id: message.id,
+            sender_id: message.sender.id,
+            sender_name: message.sender.name,
+            body: message.body,
+            created_at: message.created_at,
+            updated_at: message.updated_at
+          }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_follow_serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a Follow so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityFollowSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for follow.
+      def serialize
+        {
+          id: resource.id,
+          followable: {
+            id: resource.decidim_followable_id,
+            type: resource.decidim_followable_type
+          },
+          created_at: resource.created_at,
+          updated_at: resource.updated_at
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_identity_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a Identity so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityIdentitySerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for this identities.
+      def serialize
+        {
+          id: resource.id,
+          provider: resource.provider,
+          uid: resource.uid,
+          user: {
+            id: resource.user.id,
+            name: resource.user.name
+          },
+          created_at: resource.created_at,
+          updated_at: resource.updated_at
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_notification_serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a Follow so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityNotificationSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for follow.
+      def serialize
+        {
+          id: resource.id,
+          resource_type: {
+            id: resource.decidim_resource_id,
+            type: resource.decidim_resource_type
+          },
+          event_name: resource.event_name,
+          event_class: resource.event_class,
+          created_at: resource.created_at,
+          updated_at: resource.updated_at,
+          extra: resource.extra
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_participatory_space_private_user_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a User so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityParticipatorySpacePrivateUserSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for this user.
+      def serialize
+        {
+          id: resource.id,
+          privatable_to: {
+            id: resource.privatable_to_id,
+            type: resource.privatable_to_type,
+            title: resource.privatable_to.title,
+            slug: resource.privatable_to.slug
+          },
+          created_at: resource.created_at,
+          updated_at: resource.updated_at
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_report_serializer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a Report so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityReportSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for this conversation.
+      def serialize
+        {
+          id: resource.id,
+          moderation: {
+            id: resource.moderation.id,
+            participatory_space: {
+              id: resource.moderation.decidim_participatory_space_id,
+              type: resource.moderation.decidim_participatory_space_type,
+              title: resource.moderation.participatory_space.title
+            },
+            reportable_element: {
+              id: resource.moderation.decidim_reportable_id,
+              type: resource.moderation.decidim_reportable_type
+            },
+            hidden_at: resource.moderation.hidden_at,
+            created_at: resource.moderation.created_at,
+            updated_at: resource.moderation.updated_at
+          },
+          reason: resource.reason,
+          details: resource.details,
+          created_at: resource.created_at,
+          updated_at: resource.updated_at
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_user_group_serializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a User so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityUserGroupSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for this user.
+      def serialize
+        {
+          id: resource.id,
+          name: resource.name,
+          document_number: resource.document_number,
+          phone: resource.phone,
+          verified_at: resource.verified_at
+        }
+      end
+    end
+  end
+end

data/lib/decidim/data_portability_serializers/data_portability_user_serializer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class serializes a User so can be exported to CSV
+  module DataPortabilitySerializers
+    class DataPortabilityUserSerializer < Decidim::Exporters::Serializer
+      include Decidim::ResourceHelper
+
+      # Public: Exports a hash with the serialized data for this user.
+      def serialize
+        {
+          id: resource.id,
+          email: resource.email,
+          name: resource.name,
+          nickname: resource.nickname,
+          locale: resource.locale,
+          organization: {
+            id: resource.organization.try(:id),
+            name: resource.organization.try(:name)
+          },
+          newsletter_notifications_at: resource.newsletter_notifications_at,
+          email_on_notification: resource.email_on_notification,
+          admin: resource.admin,
+          personal_url: resource.personal_url,
+          about: resource.about,
+          invitation_created_at: resource.invitation_created_at,
+          invitation_sent_at: resource.invitation_sent_at,
+          invitation_accepted_at: resource.invitation_accepted_at,
+          invited_by: {
+            id: resource.invited_by_id,
+            type: resource.invited_by_type
+          },
+          invitations_count: resource.invitations_count,
+          reset_password_sent_at: resource.reset_password_sent_at,
+          remember_created_at: resource.remember_created_at,
+          sign_in_count: resource.sign_in_count,
+          current_sign_in_at: resource.current_sign_in_at,
+          last_sign_in_at: resource.last_sign_in_at,
+          current_sign_in_ip: resource.current_sign_in_ip,
+          last_sign_in_ip: resource.last_sign_in_ip,
+          created_at: resource.created_at,
+          updated_at: resource.updated_at,
+          confirmed_at: resource.confirmed_at,
+          confirmation_sent_at: resource.confirmation_sent_at,
+          unconfirmed_email: resource.unconfirmed_email,
+          delete_reason: resource.delete_reason,
+          deleted_at: resource.deleted_at,
+          managed: resource.managed,
+          officialized_at: resource.officialized_at,
+          officialized_as: resource.officialized_as
+        }
+      end
+    end
+  end
+end

data/lib/decidim/events.rb

@@ -7,5 +7,6 @@ module Decidim
     autoload :NotificationEvent, "decidim/events/notification_event"
     autoload :SimpleEvent, "decidim/events/simple_event"
     autoload :AuthorEvent, "decidim/events/author_event"
+    autoload :CoauthorEvent, "decidim/events/coauthor_event"
   end
 end

data/lib/decidim/events/coauthor_event.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Events
+    # This module is used to be included in event classes inheriting from SimpleEvent
+    # whose resource is coauthorable.
+    #
+    # It adds the following methods related with the creator author: author_name, author_nickname, author_path and author_url to the i18n interpolations.
+    module CoauthorEvent
+      extend ActiveSupport::Concern
+
+      included do
+        i18n_attributes :author_name, :author_nickname, :author_path, :author_url
+
+        def author_nickname
+          author_presenter&.nickname.to_s
+        end
+
+        def author_name
+          author_presenter&.name.to_s
+        end
+
+        def author_path
+          author_presenter&.profile_path.to_s
+        end
+
+        def author_url
+          author_presenter&.profile_url.to_s
+        end
+
+        def author_presenter
+          return unless author
+          @author_presenter ||= Decidim::UserPresenter.new(author)
+        end
+
+        def author
+          resource.creator_author if resource.respond_to?(:creator_author)
+        end
+      end
+    end
+  end
+end