loggable_activity 0.5.4 → 0.5.7

data/lib/loggable_activity/services/base_payloads_builder.rb

@@ -6,9 +6,10 @@ module LoggableActivity
     # Other service modules related to the loggable activity will inherit from this module.
     class BasePayloadsBuilder
       # Initializes the PayloadsBuilder with a record and an initial collection of payloads,
-      def initialize(record, payloads)
+      def initialize(record, payloads, params = {})
         @record = record
         @payloads = payloads
+        @params = params
         @loggable_attrs = record.class.loggable_attrs
         @public_attrs = record.class.public_attrs
         # @relation_config = record.relation_config

data/lib/loggable_activity/services/custom_payloads_builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  module Services
+    # This service class builds custom payloads.
+    class CustomPayloadsBuilder < BasePayloadsBuilder
+      # Builds a custom payloads for a ::LoggableActivity::Activity.
+      def build
+        encryption_key = encryption_key_for_record(@record)
+        @secret_key = encryption_key&.secret_key
+        encrypted_attrs = build_custom_payloads(@params)
+
+        payload = ::LoggableActivity::Payload.new(
+          encryption_key:,
+          record: @record,
+          encrypted_record_name:,
+          encrypted_attrs:,
+          related_to_activity_as: 'custom_payload',
+          route: @record.class.route,
+          current_payload: true,
+          data_owner: @record,
+          public_attrs: {}
+        )
+
+        unless payload.valid?
+          error_message = "Payload validation failed: #{payload.errors.full_messages.join(', ')}"
+          raise LoggableActivity::Error, error_message
+        end
+
+        @payloads << payload
+      end
+
+      private
+
+      def encrypted_record_name
+        return encrypt_attr(@params[:display_name], @secret_key) if @params[:display_name]
+
+        encrypt_record_name_for_record(@record, @secret_key)
+      end
+
+      def build_custom_payloads(params)
+        params.transform_values do |value|
+          case value
+          when Hash
+            build_custom_payloads(value)
+          when Array
+            value.map { |v| v.is_a?(Hash) ? build_custom_payloads(v) : encrypt_attr(v, @secret_key) }
+          else
+            encrypt_attr(value, @secret_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/loggable_activity/version.rb

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

data/lib/loggable_activity.rb

@@ -12,10 +12,11 @@ require 'loggable_activity/payload'
 require 'loggable_activity/error'
 require 'loggable_activity/sanitizer'
 require 'loggable_activity/services/base_payloads_builder'
+require 'loggable_activity/services/custom_payloads_builder'
 require 'loggable_activity/services/payloads_builder'
 require 'loggable_activity/services/update_payloads_builder'
 require 'loggable_activity/services/destroy_payloads_builder'
-require 'loggable_activity/concerns/current_user'
+require 'loggable_activity/concerns/current_actor'
 require 'kaminari'
 
 # LoggableActivity
@@ -48,6 +49,8 @@ require 'kaminari'
 #
 # This module is designed to be both powerful and easy to integrate, providing a solid foundation for activity logging.
 module LoggableActivity
-  mattr_accessor :actor_class
+  mattr_accessor :actor_model_name
+  mattr_accessor :fetch_actor_name_from
   mattr_accessor :config_file_path
+  mattr_accessor :task_for_sanitization
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.7
 platform: ruby
 authors:
 - Max Groenlund
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-14 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,114 +118,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.3
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.2
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.4.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.4.3
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.60'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.60.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.60'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.60.2
 description: |2
       LoggableActivity is a powerful gem for Ruby on Rails that provides seamless user activity logging
       prepared for GDPR compliance and supporting record relations. It allows you to effortlessly
@@ -245,6 +137,7 @@ files:
 - CHANGELOG.md
 - CHEAT_SHEET.md
 - CODE_OF_CONDUCT.md
+- GETTING-STARTED.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -281,6 +174,117 @@ files:
 - config/initializers/kaminari_config.rb
 - config/routes.rb
 - db/migrate/20240702092648_create_loggable_activity_tables.rb
+- docker-compose.yml
+- docs/CHANGELOG_md.html
+- docs/CHEAT_SHEET_md.html
+- docs/CODE_OF_CONDUCT_md.html
+- docs/CreateLoggableActivities.html
+- docs/CreateLoggableActivityTables.html
+- docs/GETTING-STARTED_md.html
+- docs/Gemfile.html
+- docs/Gemfile_lock.html
+- docs/LoggableActivity.html
+- docs/LoggableActivity/ActivitiesController.html
+- docs/LoggableActivity/ActivitiesHelper.html
+- docs/LoggableActivity/Activity.html
+- docs/LoggableActivity/ApplicationController.html
+- docs/LoggableActivity/ApplicationHelper.html
+- docs/LoggableActivity/ApplicationJob.html
+- docs/LoggableActivity/ApplicationMailer.html
+- docs/LoggableActivity/ApplicationRecord.html
+- docs/LoggableActivity/Configuration.html
+- docs/LoggableActivity/ConfigurationError.html
+- docs/LoggableActivity/CurrentActor.html
+- docs/LoggableActivity/DataOwner.html
+- docs/LoggableActivity/Encryption.html
+- docs/LoggableActivity/EncryptionError.html
+- docs/LoggableActivity/EncryptionKey.html
+- docs/LoggableActivity/Engine.html
+- docs/LoggableActivity/Error.html
+- docs/LoggableActivity/Generators.html
+- docs/LoggableActivity/Generators/InstallGenerator.html
+- docs/LoggableActivity/Hooks.html
+- docs/LoggableActivity/Payload.html
+- docs/LoggableActivity/Sanitizer.html
+- docs/LoggableActivity/Services.html
+- docs/LoggableActivity/Services/BasePayloadsBuilder.html
+- docs/LoggableActivity/Services/CustomPayloadsBuilder.html
+- docs/LoggableActivity/Services/DestroyPayloadsBuilder.html
+- docs/LoggableActivity/Services/PayloadsBuilder.html
+- docs/LoggableActivity/Services/UpdatePayloadsBuilder.html
+- docs/MIT-LICENSE.html
+- docs/Object.html
+- docs/README_md.html
+- docs/Rakefile.html
+- docs/app/assets/config/loggable_activity_manifest_js.html
+- docs/app/assets/javascripts/loggable_activity/application_js.html
+- docs/app/assets/stylesheets/loggable_activity/activities_scss.html
+- docs/app/assets/stylesheets/loggable_activity/application_scss.html
+- docs/app/views/layouts/loggable_activity/application_html_slim.html
+- docs/app/views/loggable_activity/activities/_activities_html_slim.html
+- docs/created.rid
+- docs/css/fonts.css
+- docs/css/rdoc.css
+- docs/fonts/Lato-Light.ttf
+- docs/fonts/Lato-LightItalic.ttf
+- docs/fonts/Lato-Regular.ttf
+- docs/fonts/Lato-RegularItalic.ttf
+- docs/fonts/SourceCodePro-Bold.ttf
+- docs/fonts/SourceCodePro-Regular.ttf
+- docs/git-org/HEAD.html
+- docs/git-org/config.html
+- docs/git-org/description.html
+- docs/git-org/hooks/applypatch-msg_sample.html
+- docs/git-org/hooks/commit-msg_sample.html
+- docs/git-org/hooks/fsmonitor-watchman_sample.html
+- docs/git-org/hooks/post-update_sample.html
+- docs/git-org/hooks/pre-applypatch_sample.html
+- docs/git-org/hooks/pre-commit_sample.html
+- docs/git-org/hooks/pre-merge-commit_sample.html
+- docs/git-org/hooks/pre-push_sample.html
+- docs/git-org/hooks/pre-rebase_sample.html
+- docs/git-org/hooks/pre-receive_sample.html
+- docs/git-org/hooks/prepare-commit-msg_sample.html
+- docs/git-org/hooks/push-to-checkout_sample.html
+- docs/git-org/hooks/update_sample.html
+- docs/git-org/info/exclude.html
+- docs/images/add.png
+- docs/images/arrow_up.png
+- docs/images/brick.png
+- docs/images/brick_link.png
+- docs/images/bug.png
+- docs/images/bullet_black.png
+- docs/images/bullet_toggle_minus.png
+- docs/images/bullet_toggle_plus.png
+- docs/images/date.png
+- docs/images/delete.png
+- docs/images/find.png
+- docs/images/loadingAnimation.gif
+- docs/images/macFFBgHack.png
+- docs/images/package.png
+- docs/images/page_green.png
+- docs/images/page_white_text.png
+- docs/images/page_white_width.png
+- docs/images/plugin.png
+- docs/images/ruby.png
+- docs/images/tag_blue.png
+- docs/images/tag_green.png
+- docs/images/transparent.png
+- docs/images/wrench.png
+- docs/images/wrench_orange.png
+- docs/images/zoom.png
+- docs/index.html
+- docs/js/darkfish.js
+- docs/js/navigation.js
+- docs/js/navigation.js.gz
+- docs/js/search.js
+- docs/js/search_index.js
+- docs/js/search_index.js.gz
+- docs/js/searcher.js
+- docs/js/searcher.js.gz
+- docs/lib/loggable_activity/config_schema_json.html
+- docs/lib/tasks/loggable_activity_tasks_rake.html
+- docs/table_of_contents.html
 - git-org/HEAD
 - git-org/config
 - git-org/description
@@ -298,10 +302,15 @@ files:
 - git-org/hooks/push-to-checkout.sample
 - git-org/hooks/update.sample
 - git-org/info/exclude
+- lib/generators/loggable_activity/install/install_generator.rb
+- lib/generators/loggable_activity/install/templates/create_loggable_activities.rb
+- lib/generators/loggable_activity/install/templates/loggable_activity.en.yml
+- lib/generators/loggable_activity/install/templates/loggable_activity.rb
+- lib/generators/loggable_activity/install/templates/loggable_activity.yml
 - lib/loggable_activity.rb
 - lib/loggable_activity/.DS_Store
 - lib/loggable_activity/activity.rb
-- lib/loggable_activity/concerns/current_user.rb
+- lib/loggable_activity/concerns/current_actor.rb
 - lib/loggable_activity/config_schema.json
 - lib/loggable_activity/configuration.rb
 - lib/loggable_activity/data_owner.rb
@@ -313,6 +322,7 @@ files:
 - lib/loggable_activity/payload.rb
 - lib/loggable_activity/sanitizer.rb
 - lib/loggable_activity/services/base_payloads_builder.rb
+- lib/loggable_activity/services/custom_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

data/lib/loggable_activity/concerns/current_user.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module LoggableActivity
-  # Stores current user in a thread variable so is can be accessed from the LoggableActivity::Hook model
-  module CurrentUser
-    extend ActiveSupport::Concern
-
-    included do
-      before_action :set_current_user
-      after_action :clear_current_user
-    end
-
-    private
-
-    def set_current_user
-      # return if request.path == "/users/sign_out"
-      return unless current_user
-
-      Thread.current[:current_user] = current_user
-    end
-
-    def clear_current_user
-      Thread.current[:current_user] = nil
-    end
-  end
-end