loggable_activity 0.1.56 → 0.1.59

data/lib/loggable_activity/services/payloads_builder.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  module Services
+    # This class is responsible for building payloads used in loggable activities.
+    class PayloadsBuilder < BasePayloadsBuilder
+      # Builds payloads for the loggable activity and returns an array of payload objects.
+      #
+      # Example call:
+      # payloads = ::LoggableActivity::Services::PayloadsBuilder.new(record, initial_payloads).build
+      #
+      # Returns an Array of ::LoggableActivity::Payload instances, each representing a payload
+      # for the loggable activity. For example:
+      # [
+      #   #<::LoggableActivity::Payload:0x0000000109658718 @encryption_key="key1", @record=#<MockRecord:0x0000000105000000 @name="Record1">, @encrypted_record_name="Encrypted Name1", @encrypted_attrs={...}, @related_to_activity_as="primary_payload", @data_owner=true, @route="route1">,
+      #   #<::LoggableActivity::Payload:0x0000000109658720 @encryption_key="key2", @record=#<MockRecord:0x0000000105000001 @name="Record2">, @encrypted_record_name="Encrypted Name2", @encrypted_attrs={...}, @related_to_activity_as="has_one_payload", @data_owner=true, @route="route2">
+      # ]
+      #
+      def build
+        build_primary_payload
+        build_relations_payloads
+        @payloads
+      end
+
+      private
+
+      # Builds the primary payload.
+      def build_primary_payload
+        options = { related_to_activity_as: 'primary_payload', current_payload: true, data_owner: true }
+        build_encrypted_payload(@record, options)
+      end
+
+      # Builds the relations payloads.
+      def build_relations_payloads
+        @relations.each do |relation_config|
+          build_relation_payload(relation_config)
+        end
+      end
+
+      # Builds payloads for relations definded in the configuration.
+      #
+      # @param relation_config [Hash] The configuration of the relation.
+      def build_relation_payload(relation_config)
+        relation_config.each_key do |key|
+          case key
+          when 'belongs_to'
+            build_belongs_to_payload(relation_config)
+          when 'has_one'
+            build_has_one_payload(relation_config)
+          when 'has_many'
+            build_has_many_payloads(relation_config)
+          end
+        end
+      end
+
+      # Builds payloads for has_many relations.
+      def build_has_many_payloads(relation_config)
+        relation = (relation_config['has_many']).to_s
+        records = @record.send(relation)
+        data_owner = relation_config['data_owner']
+        options = { related_to_activity_as: 'has_many_payload', current_payload: true, data_owner: }
+        records.each do |record|
+          record.disable_hooks = true
+          build_encrypted_payload(record, options)
+        end
+      end
+
+      # Builds the payload for a has_one relation.
+      def build_has_one_payload(relation_config)
+        relation = (relation_config['has_one']).to_s
+        record = @record.send(relation)
+        return if record.nil?
+
+        data_owner = relation_config['data_owner']
+        options =
+          { related_to_activity_as: 'has_one_payload', current_payload: true, data_owner: }
+
+        build_encrypted_payload(record, options)
+      end
+
+      def build_belongs_to_payload(relation_config)
+        relation = (relation_config['belongs_to']).to_s
+        record = @record.send(relation)
+        return if record.nil?
+
+        data_owner = relation_config['data_owner']
+
+        if data_owner
+          encryption_key = encryption_key_for_record(@record)
+          DataOwner.create!(record:, encryption_key:)
+        end
+        options = { related_to_activity_as: 'belongs_to_payload', current_payload: true, data_owner: }
+
+        build_encrypted_payload(record, options)
+      end
+    end
+  end
+end

data/lib/loggable_activity/services/update_payloads_builder.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  module Services
+    # This service class builds update payloads when an instance of a model is updated.
+    class UpdatePayloadsBuilder < BasePayloadsBuilder
+      # Builds payloads for a ::LoggableActivity::Activity.
+      def build
+        build_primary_update_payload
+        build_relations_update_payloads
+        @payloads
+      end
+
+      private
+
+      # Builds the primary payload.
+      def build_primary_update_payload
+        previous_values, current_values = saved_changes(@record)
+        previous_values = previous_values.slice(*@loggable_attrs)
+        current_values = current_values.slice(*@loggable_attrs)
+        options = { related_to_activity_as: 'primary_update_payload', current_payload: true, data_owner: true }
+
+        build_encrypted_update_payload(
+          @record,
+          current_values,
+          previous_values,
+          options
+        )
+      end
+
+      # Build the payloads for the relations of the record.
+      # only relations included in the configuration, will be logged.
+      def build_relations_update_payloads
+        @relations.each do |relation_config|
+          build_relation_update_payload(relation_config)
+        end
+      end
+
+      def build_relation_update_payload(relation_config)
+        relation_config.each_key do |key|
+          case key
+          when 'belongs_to'
+            build_belongs_to_update_payload(relation_config)
+          when 'has_one'
+            build_has_one_update_payload(relation_config)
+          when 'has_many'
+            build_has_many_update_payloads(relation_config)
+          end
+        end
+      end
+
+      # Builds the update payload for a belongs_to relation.
+      def build_belongs_to_update_payload(relation_config)
+        relation_id = "#{relation_config['belongs_to']}_id"
+        model_class_name = relation_config['model']
+        model_class = model_class_name.constantize
+        data_owner = relation_config['data_owner']
+
+        model_ids = saved_changes(@record).map { |hash| hash[relation_id] }
+
+        model_ids.each_with_index do |id, index|
+          record = id ? model_class.find_by(id:) : nil
+          next unless record
+
+          options =
+            { related_to_activity_as: 'belongs_to_update_payload', current_payload: index == 1, data_owner: }
+
+          build_encrypted_payload(record, options)
+        end
+      end
+
+      # Builds payloads for has_many relations.
+      def build_has_many_update_payloads(relation_config)
+        relation = (relation_config['has_many']).to_s
+        records = @record.send(relation)
+        return nil if records.empty?
+
+        records.each do |record|
+          if record.persisted? && record.changes_to_save.any?
+            build_has_many_update_payload(relation_config, record)
+          elsif record.persisted? && record.saved_changes.any?
+            # "no changes to save"
+          else
+            build_has_many_create_payload(relation_config, record)
+          end
+        end
+      end
+
+      def build_has_many_update_payload(relation_config, record)
+        record.disable_hooks = true
+        previous_values, current_values = changes_to_save(record)
+        loggable_attrs = relation_config['loggable_attrs']
+        return if previous_values == current_values
+
+        previous_values = previous_values.slice(*loggable_attrs)
+        data_owner = relation_config['data_owner']
+        options = { related_to_activity_as: 'has_many_update_payload', current_payload: true, data_owner: }
+
+        build_encrypted_update_payload(
+          record,
+          current_values,
+          previous_values,
+          options
+        )
+      end
+
+      def build_has_many_create_payload(relation_config, record)
+        record.disable_hooks = true
+        data_owner = relation_config['data_owner']
+        options =
+          { related_to_activity_as: 'has_many_create_payload', current_payload: true, data_owner: }
+        build_encrypted_payload(record, options)
+      end
+
+      # Builds the update payload for a has_one relation.
+      def build_has_one_update_payload(relation_config)
+        relation = (relation_config['has_one']).to_s
+        record = @record.send(relation)
+        return nil if record.nil?
+
+        previous_values, current_values = changes_to_save(record)
+        loggable_attrs = record.class.loggable_attrs
+        return if previous_values == current_values
+
+        previous_values = previous_values.slice(*loggable_attrs)
+        current_values = current_values.slice(*loggable_attrs)
+        data_owner = relation_config['data_owner']
+        options = { related_to_activity_as: 'has_one_update_payload', current_payload: true, data_owner: }
+
+        build_encrypted_update_payload(
+          record,
+          current_values,
+          previous_values,
+          options
+        )
+      end
+
+      # Returns the encrypted attributes for the update payload.
+      def encrypted_update_attrs(current_values, previous_values, encryption_key)
+        changes = []
+
+        previous_values.each do |key, from_value|
+          from = ::LoggableActivity::Encryption.encrypt(from_value, encryption_key)
+          to_value = current_values[key]
+          to = ::LoggableActivity::Encryption.encrypt(to_value, encryption_key)
+          changes << { key => { from:, to: } }
+        end
+        { changes: }
+      end
+
+      # Builds the encrypted update payload for a record.
+      def build_encrypted_update_payload(record, current_values, previous_values, options = {})
+        encryption_key = ::LoggableActivity::EncryptionKey.for_record(record)
+
+        encrypted_attrs = encrypted_update_attrs(
+          current_values,
+          previous_values,
+          encryption_key.secret_key
+        )
+
+        build_payload(
+          record,
+          encryption_key,
+          encrypted_attrs,
+          options
+        )
+      end
+    end
+  end
+end

data/lib/loggable_activity/version.rb

@@ -3,5 +3,5 @@
 # Version of the gem
 module LoggableActivity
   # Version
-  VERSION = '0.1.56'
+  VERSION = '0.1.59'
 end

data/lib/loggable_activity.rb

@@ -5,11 +5,11 @@ require_relative 'loggable_activity/activity'
 require_relative 'loggable_activity/configuration'
 require_relative 'loggable_activity/encryption'
 require_relative 'loggable_activity/encryption_key'
+require_relative 'loggable_activity/data_owner'
 require_relative 'loggable_activity/hooks'
 require_relative 'loggable_activity/payload'
-require_relative 'loggable_activity/payloads_builder'
-require_relative 'loggable_activity/update_payloads_builder'
-
-module LoggableActivity
-  class Error < StandardError; end
-end
+require_relative 'loggable_activity/error'
+require_relative 'loggable_activity/services/base_payloads_builder'
+require_relative 'loggable_activity/services/payloads_builder'
+require_relative 'loggable_activity/services/update_payloads_builder'
+require_relative 'loggable_activity/services/destroy_payloads_builder'

data/lib/schemas/config_schema.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "type": "object",
+  "properties": {
+    "current_user_model_name": {
+      "type": "string"
+    },
+    "fetch_current_user_name_from": {
+      "type": "string"
+    }
+  },
+  "patternProperties": {
+    "^(?!current_user_model_name$|fetch_current_user_name_from$)[A-Za-z0-9_:]+$": {
+      "type": "object",
+      "properties": {
+        "data_owner": {
+          "type": "boolean"
+        },
+        "fetch_record_name_from": {
+          "type": "string"
+        },
+        "loggable_attrs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "auto_log": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "create",
+              "update",
+              "destroy"
+            ]
+          }
+        },
+        "route": {
+          "type": "string",
+          "minLength": 1
+        },
+        "relations": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "has_many": {
+                "type": "string"
+              },
+              "has_one": {
+                "type": "string"
+              },
+              "belongs_to": {
+                "type": "string"
+              },
+              "model": {
+                "type": "string"
+              },
+              "loggable_attrs": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "route": {
+                "type": "string",
+                "minLength": 1
+              },
+              "fetch_record_name_from": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "model"
+            ]
+          }
+        }
+      },
+      "required": [
+        "loggable_attrs"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "current_user_model_name",
+    "fetch_current_user_name_from"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.56
+  version: 0.1.59
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.1.3
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -149,20 +169,26 @@ files:
 - CONSIDERTIONS.md
 - GETTING-STARTED.md
 - LICENSE.txt
+- PAYLOAD_EXAMPLE.md
 - README.md
 - ROADMAP.md
 - Rakefile
 - docs/LoggableActivity.html
 - docs/LoggableActivity/Activity.html
 - docs/LoggableActivity/Configuration.html
+- docs/LoggableActivity/ConfigurationError.html
+- docs/LoggableActivity/DataOwner.html
 - docs/LoggableActivity/Encryption.html
 - docs/LoggableActivity/EncryptionError.html
 - docs/LoggableActivity/EncryptionKey.html
 - docs/LoggableActivity/Error.html
 - docs/LoggableActivity/Hooks.html
 - docs/LoggableActivity/Payload.html
-- docs/LoggableActivity/PayloadsBuilder.html
-- docs/LoggableActivity/UpdatePayloadsBuilder.html
+- docs/LoggableActivity/Services.html
+- docs/LoggableActivity/Services/BasePayloadsBuilder.html
+- docs/LoggableActivity/Services/DestroyPayloadsBuilder.html
+- docs/LoggableActivity/Services/PayloadsBuilder.html
+- docs/LoggableActivity/Services/UpdatePayloadsBuilder.html
 - docs/created.rid
 - docs/css/fonts.css
 - docs/css/rdoc.css
@@ -211,44 +237,29 @@ files:
 - lib/generators/.DS_Store
 - lib/generators/loggable_activity/.DS_Store
 - lib/generators/loggable_activity/install_generator.rb
-- lib/generators/loggable_activity/install_templates_generator.rb
 - lib/generators/loggable_activity/templates/.DS_Store
 - lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb
 - lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml
 - lib/generators/loggable_activity/templates/config/loggable_activity.yaml
 - lib/generators/loggable_activity/templates/create_loggable_activities.rb
 - lib/generators/loggable_activity/templates/current_user.rb
-- lib/generators/loggable_activity/templates/helpers/activity_helper.rb
-- lib/generators/loggable_activity/templates/helpers/router.rb
-- lib/generators/loggable_activity/templates/helpers/routes_helper.rb
 - lib/generators/loggable_activity/templates/loggable_activity.en.yaml
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.slim
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.erb
-- lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.slim
 - lib/loggable_activity.rb
 - lib/loggable_activity/.DS_Store
 - lib/loggable_activity/activity.rb
 - lib/loggable_activity/configuration.rb
+- lib/loggable_activity/data_owner.rb
 - lib/loggable_activity/encryption.rb
 - lib/loggable_activity/encryption_key.rb
+- lib/loggable_activity/error.rb
 - lib/loggable_activity/hooks.rb
 - lib/loggable_activity/payload.rb
-- lib/loggable_activity/payloads_builder.rb
-- lib/loggable_activity/update_payloads_builder.rb
+- lib/loggable_activity/services/base_payloads_builder.rb
+- lib/loggable_activity/services/destroy_payloads_builder.rb
+- lib/loggable_activity/services/payloads_builder.rb
+- lib/loggable_activity/services/update_payloads_builder.rb
 - lib/loggable_activity/version.rb
+- lib/schemas/config_schema.json
 - pkg/loggable_activity-0.1.35.gem
 - sig/loggable_activity.rbs
 homepage: https://loggableactivity-efe7b931c886.herokuapp.com/