loggable_activity 0.5.0 → 0.5.6

data/lib/generators/loggable_activity/install/templates/loggable_activity.yml

@@ -0,0 +1,103 @@
+Company:
+  fetch_record_name_from: name
+  route: /companies/:id
+  loggable_attrs:
+    - name
+  public_attrs:
+    - name
+  relations:
+    - has_many: :users
+      route: /users/:id
+      model: User
+      loggable_attrs:
+        - first_name
+        - last_name
+  auto_log:
+    - create
+    - update
+    - destroy
+Hat:
+  fetch_record_name_from: color
+  route: /user/:id
+  loggable_attrs:
+    - color
+  auto_log:
+    - create
+    - destroy
+  relations:
+    - belongs_to: :user
+      route: /demo/users/:id
+      model: User
+      loggable_attrs:
+        - first_name
+User:
+  fetch_record_name_from: full_name
+  route: /demo/users/:id
+  loggable_attrs:
+    - first_name
+    - last_name
+    - age
+    - email
+    - user_type
+  auto_log:
+    - create
+    - update
+    - destroy
+  public_attrs:
+    - age
+    - user_type
+  relations:
+    - has_one: :profile
+      route: /demo/users/:id/profile
+      model: Profile
+      loggable_attrs:
+        - bio
+        - phone_number
+      public_attrs:
+        - date_of_birth
+    - has_many: :hats
+      route: /users/:id
+      model: Hat
+      loggable_attrs:
+        - color
+    - belongs_to: :company
+      route: /companies/:id
+      model: Company
+      loggable_attrs:
+        - name
+Profile:
+  fetch_record_name_from: phone_number
+  route: /demo/profiles/:id
+  loggable_attrs:
+    - bio
+    - profile_picture_url
+    - location
+    - date_of_birth
+    - phone_number
+  public_attrs:
+    - date_of_birth
+  # auto_log:
+  #   - create
+  #   - update
+  #   - destroy
+  # relations:
+  #   - belongs_to: :user
+  #     route: /demo/users/:id
+  #     model: User
+  #     loggable_attrs:
+  #       - first_name
+  #       - last_name
+  #       - age
+  #       - email
+  #       - user_type
+#   - belongs_to: :demo_address
+#     route: show_demo_address
+#     model: Demo::Address
+#     loggable_attrs:
+#       - street
+#       - postal_code
+#   - belongs_to: :demo_club
+#     route: show_demo_club
+#     model: Demo::Club
+#     loggable_attrs:
+#       - name

data/lib/loggable_activity/activity.rb

@@ -31,7 +31,8 @@ module LoggableActivity
       'has_many_update_payload' => 'has_many',
       'belongs_to_payload' => 'belongs_to',
       'belongs_to_destroy_payload' => 'belongs_to',
-      'belongs_to_update_payload' => 'belongs_to'
+      'belongs_to_update_payload' => 'belongs_to',
+      'custom_payload' => 'self'
     }.freeze
 
     # Returns an array of hashes, each representing an activity's attributes and its associated relations. The structure and relations to include are specified in 'config/loggable_activity.yaml'. This format is designed for UI display purposes.
@@ -106,7 +107,7 @@ module LoggableActivity
     #   "David Bowie"
     #
     def record_display_name
-      primary_payload.record_display_name
+      primary_payload&.record_display_name
     end
 
     # Returns the path for the activity.
@@ -171,7 +172,7 @@ module LoggableActivity
     #   payload.record_type  # => 'SOMD_MODEL_NAME'
     #
     def primary_payload
-      related_to_activity_as = %w[primary_payload primary_update_payload primary_destroy_payload]
+      related_to_activity_as = %w[primary_payload primary_update_payload primary_destroy_payload custom_payload]
       payloads.detect { |p| related_to_activity_as.include?(p.related_to_activity_as) }
     end
 

data/lib/loggable_activity/config_schema.json

@@ -1,19 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-06/schema#",
   "type": "object",
-  "properties": {
-    "current_user_model_name": {
-      "type": "string"
-    },
-    "current_user_name": {
-      "type": "string"
-    },
-    "task_for_sanitization": {
-      "type": "boolean"
-    }
-  },
   "patternProperties": {
-    "^(?!current_user_model_name$|current_user_name$|task_for_sanitization)[A-Za-z0-9_:]+$": {
+    "^[A-Za-z0-9_:]+$": {
       "type": "object",
       "properties": {
         "data_owner": {
@@ -72,9 +61,6 @@
               "route": {
                 "type": "string",
                 "minLength": 1
-              },
-              "fetch_record_name_from": {
-                "type": "string"
               }
             },
             "required": [
@@ -88,9 +74,5 @@
       ]
     }
   },
-  "additionalProperties": false,
-  "required": [
-    "current_user_model_name",
-    "current_user_name"
-  ]
+  "additionalProperties": false
 }

data/lib/loggable_activity/configuration.rb

@@ -51,21 +51,6 @@ module LoggableActivity
       def for_class(class_name)
         config_data[class_name]
       end
-
-      # Returns the name of the field or method to use for the actor's display name.
-      def current_user_name
-        config_data['current_user_name']
-      end
-
-      # Returns the name of the model to use for the current user.
-      def current_user_model_name
-        config_data['current_user_model_name']
-      end
-
-      # Returns whatever models should be sanitized on delete.
-      def task_for_sanitization
-        config_data['task_for_sanitization']
-      end
     end
   end
 end

data/lib/loggable_activity/encryption.rb

@@ -16,13 +16,11 @@ module LoggableActivity
     #   "SOME_ENCRYPTED_STRING"
     #
     def self.encrypt(data, secret_key)
-      return nil if secret_key.nil?
-      return nil if data.nil?
+      return nil if secret_key.nil? || data.nil?
 
       encryption_key = Base64.decode64(secret_key)
       unless encryption_key.bytesize == 32
-        raise EncryptionError,
-              "Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}"
+        raise EncryptionError, "Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}"
       end
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').encrypt
@@ -39,19 +37,47 @@ module LoggableActivity
     # Decrypts the given data using the given encryption key
     #
     # Example:
-    #   ::LoggableActivity::Encryption.decrypt('SOME_ENCRYPTED_STRING', 'SECRET_KEY')
+    #   ::LoggableActivity::Encryption.decrypt('SOME_ENCRYPTED_DATA', 'SECRET_KEY')
     #
     # Returns:
     #   "my secret data"
     #
     def self.decrypt(data, secret_key)
+      case data
+      when Hash
+        decrypt_hash(data, secret_key)
+      when Array
+        decrypt_array(data, secret_key)
+      else
+        decrypt_data(data, secret_key)
+      end
+    end
+
+    # Decrypts a hash's values using the given encryption key
+    def self.decrypt_hash(data, secret_key)
+      data
+        .transform_values { |value| decrypt(value, secret_key) }
+        .transform_keys(&:to_sym)
+    end
+
+    # Decrypts an array's values using the given encryption key
+    def self.decrypt_array(data, secret_key)
+      data.map { |value| decrypt(value, secret_key) }
+    end
+
+    # Checks if a value is blank
+    def self.blank?(value)
+      value.respond_to?(:empty?) ? value.empty? : !value
+    end
+
+    # Decrypts individual data using the given encryption key
+    def self.decrypt_data(data, secret_key)
       return I18n.t('loggable_activity.activity.deleted') if secret_key.nil?
       return '' if data.blank?
 
       encryption_key = Base64.decode64(secret_key)
       unless encryption_key.bytesize == 32
-        raise EncryptionError,
-              "Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}"
+        raise EncryptionError, "Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}"
       end
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').decrypt
@@ -73,10 +99,5 @@ module LoggableActivity
       Rails.logger.error "ArgumentError Decryption failed: #{e.message}"
       I18n.t('loggable_activity.decryption.failed')
     end
-
-    # Returns true if the given value is blank
-    def self.blank?(value)
-      value.respond_to?(:empty?) ? value.empty? : !value
-    end
   end
 end

data/lib/loggable_activity/encryption_key.rb

@@ -14,7 +14,7 @@ module LoggableActivity
 
     # Prepare the record for deletion
     def mark_as_deleted!
-      LoggableActivity::Configuration.task_for_sanitization ? update(delete_at: DateTime.now + 1.month) : delete
+      LoggableActivity.task_for_sanitization ? update(delete_at: DateTime.now + 1.month) : delete
     end
 
     # check if the encryption key is deleted or it is about to be deleted

data/lib/loggable_activity/engine.rb

@@ -18,10 +18,5 @@ module LoggableActivity
   #
   class Engine < ::Rails::Engine
     isolate_namespace LoggableActivity
-
-    # initializer 'loggable_activity.assets.precompile' do |app|
-    #   app.config.assets.precompile += %w( loggable_activity/application.css )
-    #   app.config.assets.precompile += %w( loggable_activity/bootstrap.css )
-    # end
   end
 end

data/lib/loggable_activity/error.rb

@@ -4,21 +4,21 @@ module LoggableActivity
   # Error class for loggable activity.
   class Error < StandardError
     def initialize(msg = '')
-      super(msg)
+      super
     end
   end
 
   # Error class for encryption.
   class EncryptionError < StandardError
     def initialize(msg = '')
-      super(msg)
+      super
     end
   end
 
   # This class is used to load the configuration file located at config/loggable_activity.yml
   class ConfigurationError < StandardError
     def initialize(msg = '')
-      super(msg)
+      super
     end
   end
 end

data/lib/loggable_activity/hooks.rb

@@ -42,7 +42,7 @@ module LoggableActivity
     #   @param params [Hash] Additional parameters for the activity.
     def log(action, actor: nil, params: {})
       @action = action
-      @actor = actor || Thread.current[:current_user]
+      @actor = actor || Thread.current[:current_user] || created_by_self
       return nil if @actor.nil?
 
       @record = self
@@ -56,8 +56,14 @@ module LoggableActivity
         log_destroy
       when :update
         log_update
+      when :login
+        log_login
+      when :logout
+        log_logout
+      when :sign_up
+        log_sign_up
       else
-        log_custom_activity(action)
+        log_custom_activity
       end
     end
 
@@ -67,6 +73,15 @@ module LoggableActivity
 
     private
 
+    # If the actor is the same as the record, it is created by the actor.
+    # This assumes it is a sign_up action.
+    def created_by_self
+      return unless LoggableActivity.actor_model_name == self.class.name
+
+      @action = :sign_up
+      self
+    end
+
     # Logs an activity for the current action.
     def log_activity
       create_activity(build_payloads)
@@ -95,6 +110,28 @@ module LoggableActivity
       )
     end
 
+    def log_login
+      create_activity(build_payloads)
+    end
+
+    def log_logout
+      create_activity(build_payloads)
+    end
+
+    def log_sign_up
+      create_activity(build_payloads)
+    end
+
+    # Logs a custom activity.
+    def log_custom_activity
+      create_activity(build_custom_payload)
+    end
+
+    def build_custom_payload
+      ::LoggableActivity::Services::CustomPayloadsBuilder
+        .new(self, @payloads, @params).build
+    end
+
     # Builds update payloads for the current action.
     def build_update_payloads
       ::LoggableActivity::Services::UpdatePayloadsBuilder
@@ -118,9 +155,6 @@ module LoggableActivity
       @payloads.empty?
     end
 
-    # Logs a custom activity.
-    def log_custom_activity(activity); end
-
     # Logs an update activity automatically if configured.
     def log_update_activity
       return unless hooks_enabled?
@@ -165,13 +199,13 @@ module LoggableActivity
 
     # Returns the encrypted name of the actor.
     def encrypted_actor_name
-      name = @actor.send(current_user_name)
+      name = @actor.send(fetch_actor_name_from)
       ::LoggableActivity::Encryption.encrypt(name, actor_secret_key)
     end
 
     # Reads the field to feetch the record name from.
-    def current_user_name
-      ::LoggableActivity::Configuration.current_user_name
+    def fetch_actor_name_from
+      LoggableActivity.fetch_actor_name_from
     end
 
     # Returns the action key for the current action.
@@ -194,16 +228,6 @@ module LoggableActivity
       encryption_key_for_record(@actor)&.secret_key
     end
 
-    # Returns the display name of the actor.
-    def actor__name_field
-      Rails.application.config.loggable_activity.actor_display_name || "id: #{@actor.id}, class: #{@actor.class.name}"
-    end
-
-    # Returns the model name of the current user.
-    def current_user_model?
-      Rails.application.config.loggable_activity.current_user_model_name == self.class.name
-    end
-
     class_methods do
       # The loggable_attrs attribute is used read the configuration for the model that included LoggableActivity::Hooks.
       attr_accessor :loggable_attrs, :relations, :auto_log, :fetch_record_name_from, :route, :public_attrs

data/lib/loggable_activity/payload.rb

@@ -22,6 +22,7 @@ module LoggableActivity
       has_one_payload
       belongs_to_update_payload
       has_many_create_payload
+      custom_payload
     ].freeze
 
     # Enumeration for different updatepayload types
@@ -47,7 +48,8 @@ module LoggableActivity
       belongs_to_update_payload: 9,
       belongs_to_destroy_payload: 10,
       has_one_destroy_payload: 11,
-      has_many_destroy_payload: 12
+      has_many_destroy_payload: 12,
+      custom_payload: 13
     }
 
     # Returns the decrypted attrs.
@@ -62,14 +64,14 @@ module LoggableActivity
     #
     def attrs
       return deleted_attrs if record.nil?
-  
+
       case related_to_activity_as
       when *DECRYPT_ATTRS_TYPES
-        decrypted_attrs.merge(public_attrs: public_attrs)
+        decrypted_attrs.merge(public_attrs:)
       when *DECRYPT_UPDATE_ATTRS_TYPES
         decrypted_update_attrs + public_attrs['changes']
       else
-        { public_attrs: public_attrs }
+        { public_attrs: }
       end
     end
 

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/services/payloads_builder.rb

@@ -57,7 +57,7 @@ module LoggableActivity
       def build_has_many_payloads(relation_config)
         relation = (relation_config['has_many']).to_s
         records = @record.send(relation)
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
         options = { related_to_activity_as: 'has_many_payload', current_payload: true, data_owner: }
         records.each do |record|
           record.disable_hooks!
@@ -73,7 +73,7 @@ module LoggableActivity
 
         record.disable_hooks!
 
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
         options =
           {
             related_to_activity_as: 'has_one_payload',
@@ -90,7 +90,7 @@ module LoggableActivity
         record = @record.send(relation)
         return if record.nil?
 
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
 
         if data_owner
           encryption_key = encryption_key_for_record(@record)

data/lib/loggable_activity/services/update_payloads_builder.rb

@@ -56,7 +56,7 @@ module LoggableActivity
         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']
+        data_owner = relation_config['data_owner'] || false
 
         model_ids = saved_changes(@record).map { |hash| hash[relation_id] }
 
@@ -101,7 +101,7 @@ module LoggableActivity
         )
 
         previous_values = previous_values.slice(*loggable_attrs)
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
         options = { related_to_activity_as: 'has_many_update_payload', current_payload: true, data_owner: }
 
         build_encrypted_update_payload(
@@ -115,7 +115,7 @@ module LoggableActivity
 
       def build_has_many_create_payload(relation_config, record)
         record.disable_hooks = true
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
         options =
           { related_to_activity_as: 'has_many_create_payload', current_payload: true, data_owner: }
         build_encrypted_payload(record, options)
@@ -138,7 +138,7 @@ module LoggableActivity
 
         previous_values = previous_values.slice(*loggable_attrs)
         current_values = current_values.slice(*loggable_attrs)
-        data_owner = relation_config['data_owner']
+        data_owner = relation_config['data_owner'] || false
         options = { related_to_activity_as: 'has_one_update_payload', current_payload: true, data_owner: }
 
         build_encrypted_update_payload(

data/lib/loggable_activity/version.rb

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

data/lib/loggable_activity.rb

@@ -12,6 +12,7 @@ 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'
@@ -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