loggable_activity 0.5.4 → 0.5.7

data/lib/generators/loggable_activity/install/install_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This module provides generators for installing and configuring LoggableActivity.
+# It includes generators for creating initializer, migration, and locale files.
+#
+# Example usage:
+#   rails generate loggable_activity:install
+#
+# This will:
+# - Create an initializer file in config/initializers/loggable_activity.rb
+# - Create a migration file in db/migrate/
+# - Create a locale file in config/locales/loggable_activity.en.yml
+#
+# After running the generator, remember to:
+# - Add `mount LoggableActivity::Engine => '/loggable_activity'` to your routes.rb file.
+# - Run `rails db:migrate` to create the necessary database tables.
+# - Include `LoggableActivity::Hook` in the models you want to track.
+# - Update the config/loggable_activity.yaml file with the fields you want to track.
+# - Ensure the locale files are properly set up in config/locales/loggable_activity.en.yml.
+module LoggableActivity
+  module Generators
+    # The InstallGenerator class is responsible for copying the necessary
+    # files to set up LoggableActivity in a Rails application.
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates a LoggableActivity initializer in your application.'
+      def copy_initializer
+        template 'loggable_activity.rb', 'config/initializers/loggable_activity.rb'
+      end
+
+      desc 'Creates a migration file for LoggableActivity in your application.'
+      def copy_migration
+        template 'create_loggable_activities.rb', "db/migrate/#{migration_number}_create_loggable_activities.rb"
+      end
+
+      desc 'Creates a locale file for LoggableActivity in your application.'
+      def copy_locale
+        template 'loggable_activity.en.yml', 'config/locales/loggable_activity.en.yml'
+      end
+
+      # Generates a timestamp to use in the migration filename.
+      #
+      # @return [String] the current UTC time formatted as a timestamp
+      def migration_number
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+      puts ''
+      puts "\e[1m\e[32m* ----------------------------- LoggableActivity ----------------------------- *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* LoggableActivity has been successfully installed.                            *\e[0m"
+      puts "\e[1m\e[32m* Add the following to your routes.rb file.                                    *\e[0m"
+      puts "\e[1m\e[32m* Mount LoggableActivity::Engine => '/loggable_activity'                       *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* $ rails db:migrate to create the tables.                                     *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Add include LoggableActivity::Hook to the models you want to track.          *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Update the config/loggable_activity.yaml file with fields to track.          *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* Locale files are found in config/locale/loggable_activity.en.yaml.           *\e[0m"
+      puts "\e[1m\e[32m*                                                                              *\e[0m"
+      puts "\e[1m\e[32m* ---------------------------------------------------------------------------- *\e[0m"
+      puts ''
+    end
+  end
+end

data/lib/generators/loggable_activity/install/templates/create_loggable_activities.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# This migration creates the necessary tables for LoggableActivity.
+class CreateLoggableActivities < ActiveRecord::Migration[7.1]
+  def change
+    create_table :loggable_activity_encryption_keys do |t|
+      t.references :record, polymorphic: true, null: true, index: true
+      t.string :secret_key
+      t.datetime :delete_at
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_activities do |t|
+      t.string :action
+      t.references :actor, polymorphic: true, null: true
+      t.string :encrypted_actor_name
+      t.references :record, polymorphic: true, null: true
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_payloads do |t|
+      t.references :activity, null: false, foreign_key: { to_table: 'loggable_activity_activities' }
+      t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
+      t.references :record, polymorphic: true, null: true, index: true
+      t.string :encrypted_record_name
+      t.json :encrypted_attrs
+      t.integer :related_to_activity_as, default: 0
+      t.boolean :data_owner, default: false
+      t.string :route
+      t.boolean :current_payload, default: true
+      t.json :public_attrs, default: {}
+
+      t.timestamps
+    end
+
+    create_table :loggable_activity_data_owners do |t|
+      t.references :record, polymorphic: true, null: true, index: true
+      t.references :encryption_key, null: false, foreign_key: { to_table: 'loggable_activity_encryption_keys' }
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+
+# This file was generated when you installed Loggable Activity and is used for internationalization.
+# When a model 'includes LoggableActivity::Hooks' tags for translations are generated.
+# Example:
+# class User < ApplicationRecord
+#   include LoggableActivity::Hooks
+# end
+# This will make the following tags for translations available:
+# - loggable_activity.user.create
+# - loggable_activity.user.show
+# - loggable_activity.user.update
+# - loggable_activity.user.destroy
+# - loggable_activity.user.login
+# - loggable_activity.user.logout
+# 
+en:
+  loggable_activity:
+    activity:
+      actor: Actor
+      action: Action
+      record: Record
+      created_at: Created at
+      deleted: "*** DELETED ***"
+    user:
+      update: A user was updated
+      create: A user was created
+      show: "A user was shown"
+      destroy: A user was deleted
+      sign_up: A user signed up
+      login: A user logged in
+      logout: A user logged out
+      

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# This configuration file is for setting up the LoggableActivity gem in your Rails application.
+
+# Specify the name of the model that represents the actor performing the activities.
+# This should be a string that matches the class name of the model.
+# Example: If your user model is named "User", set it to 'User'.
+LoggableActivity.actor_model_name = 'User'
+
+# Specify the attribute from which to fetch the actor's name.
+# This should be eighter a string representing the attribute name of the actor model
+# or a method that returns the actor's name.
+# Example: If you want to use the user's email as their name, set it to 'email'.
+LoggableActivity.fetch_actor_name_from = 'email'
+
+# Specify the path to the configuration file for LoggableActivity.
+# This file should be a YAML file that contains the necessary configuration for logging activities.
+# The path is set relative to the Rails root directory.
+# Example: The default configuration file path is 'config/loggable_activity.yaml'.
+LoggableActivity.config_file_path = Rails.root.join('config/loggable_activity.yaml')
+
+# Specify whether the sanitazion should be performed by a task or not
+# If set to 'false' the sanitization is performed immediately.
+# If set to 'true' the data is inaccessible, but can be restored.
+# If set to 'true' you have to permanently delete
+# the data by calling 'LoggableActivity::Sanitizer.run' from a task.
+LoggableActivity.task_for_sanitization = false

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.
@@ -135,7 +136,6 @@ module LoggableActivity
       return I18n.t('loggable.activity.deleted') if actor_deleted?
 
       ::LoggableActivity::Encryption.decrypt(encrypted_actor_name, actor_secret_key)
-      
     end
 
     # Returns a list of activities for a given actor.
@@ -172,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/concerns/current_actor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  # Stores current user in a thread variable so is can be accessed from the LoggableActivity::Hook model
+  module CurrentActor
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_current_actor
+      after_action :clear_current_actor
+    end
+
+    private
+
+    def set_current_actor
+      return unless current_user
+
+      Thread.current[:current_actor] = current_user
+    end
+
+    def clear_current_actor
+      Thread.current[:current_actor] = nil
+    end
+  end
+end

data/lib/loggable_activity/config_schema.json

@@ -1,16 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-06/schema#",
   "type": "object",
-  "properties": {
-    "fetch_actor_name_from": {
-      "type": "string"
-    },
-    "task_for_sanitization": {
-      "type": "boolean"
-    }
-  },
   "patternProperties": {
-    "^(?!fetch_actor_name_from$|task_for_sanitization)[A-Za-z0-9_:]+$": {
+    "^[A-Za-z0-9_:]+$": {
       "type": "object",
       "properties": {
         "data_owner": {
@@ -82,8 +74,5 @@
       ]
     }
   },
-  "additionalProperties": false,
-  "required": [
-    "fetch_actor_name_from"
-  ]
+  "additionalProperties": false
 }

data/lib/loggable_activity/configuration.rb

@@ -51,16 +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 fetch_actor_name_from
-        config_data['fetch_actor_name_from']
-      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/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

@@ -18,17 +18,17 @@ module LoggableActivity
     included do
       config = ::LoggableActivity::Configuration.for_class(name)
 
-      if config.nil?
-        raise LoggableActivity::Error, "Configuration not found for #{name}, Please add it to 'config/loggable_activity.yaml"
-      end
-
+      # if config.nil?
+      #   # logg all attributes by default.
+      #   self.loggable_attrs = attribute_names
+      # end
       # Initializes attributes based on configuration.
-      self.loggable_attrs = config&.fetch('loggable_attrs', []) || []
+      self.loggable_attrs = config&.fetch('loggable_attrs', []) || attribute_names
       self.public_attrs = config&.fetch('public_attrs', []) || []
       self.relations = config&.fetch('relations', []) || []
-      self.auto_log = config&.fetch('auto_log', []) || []
-      self.fetch_record_name_from = config&.fetch('fetch_record_name_from', nil)
+      self.auto_log = config&.fetch('auto_log', []) || %w[create update destroy]
       self.route = config&.fetch('route', nil)
+      self.fetch_record_name_from = config&.fetch('fetch_record_name_from', nil)
 
       after_create :log_create_activity
       after_update :log_update_activity
@@ -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_actor]
       return nil if @actor.nil?
 
       @record = self
@@ -50,14 +50,22 @@ module LoggableActivity
       @payloads = []
 
       case action
-      when :create, :show
-        log_activity
+      when :create
+        log_create
+      when :show
+        log_show
       when :destroy
         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,9 +75,17 @@ module LoggableActivity
 
     private
 
-    # Logs an activity for the current action.
-    def log_activity
-      create_activity(build_payloads)
+    # Logs an activity for the show action.
+    def log_show
+      return nil if just_created?
+      return nil if just_updated?
+
+      log_activity
+    end
+
+    # Logs an activity for the create action.
+    def log_create
+      log_activity
     end
 
     # Logs an activity for the update action.
@@ -82,6 +98,27 @@ module LoggableActivity
       create_activity(build_destroy_payload)
     end
 
+    # Logs an activity for the current action.
+    def log_activity
+      create_activity(build_payloads)
+    end
+
+    def just_created?
+      action = "#{self.class.base_action}.create"
+      activity = LoggableActivity::Activity.where(record: self, actor: @actor).last
+      return false unless activity && activity.action == action && activity.created_at > 5.seconds.ago
+
+      true
+    end
+
+    def just_updated?
+      action = "#{self.class.base_action}.update"
+      activity = LoggableActivity::Activity.where(record: self, actor: @actor).last
+      return false unless activity && activity.action == action && activity.created_at > 5.seconds.ago
+
+      true
+    end
+
     # Creates an activity with the specified payloads.
     def create_activity(payloads)
       return nil if nothing_to_log?(payloads)
@@ -95,6 +132,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 +177,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?
@@ -171,7 +227,7 @@ module LoggableActivity
 
     # Reads the field to feetch the record name from.
     def fetch_actor_name_from
-      ::LoggableActivity::Configuration.fetch_actor_name_from
+      LoggableActivity.fetch_actor_name_from
     end
 
     # Returns the action key for the current action.

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