loggable_activity 0.1.54 → 0.1.55

data/lib/loggable_activity/activity.rb

@@ -18,117 +18,57 @@ module LoggableActivity
     validates :action, presence: true
     validate :must_have_at_least_one_payload
 
-    # Returns a list of attributes of the activity includig the indliced relations.
-    # The included relations are devined in the 'config/loggable_activity.yaml' file.
-    # The attributes are packed in a way that they can be used to display the activity in the UI.
+    # 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.
     #
-    # Example:
+    # Each hash in the array contains:
+    # - :record_type: The class name of the record.
+    # - :payload_type: A descriptor of the payload's role (e.g., 'primary_payload' or 'current_association').
+    # - :attrs: A hash of the record's attributes.
+    #
+    # Example usage:
     #   @activity.attrs
     #
-    # Returns:
+    # Sample return value:
     #   [
-    #     {
-    #       record_class: "User",
-    #       payload_type: "primary_payload",
-    #       attrs: {
-    #         "first_name" => "David",
-    #         "last_name" => "Bowie",
-    #         "age" => "69",
-    #         "email" => "david@example.com",
-    #         "user_type" => "Patient"
-    #       }
-    #     },
-    #     {
-    #       record_class: "Demo::UserProfile",
-    #       payload_type: "current_association",
-    #       attrs: {
-    #         "sex" => "Male",
-    #         "religion" => "Agnostic"
-    #       }
-    #     },
-    #     {
-    #       record_class: "Demo::Address",
-    #       payload_type: "current_association",
-    #       attrs: {
-    #         "street" => "Eiffel Tower",
-    #         "city" => "Paris",
-    #         "country" => "France",
-    #         "postal_code" => "75007"
-    #       }
-    #     },
-    #     {
-    #       record_class: "Demo::Club",
-    #       payload_type: "current_association",
-    #       attrs: {
-    #         "name" => "Mystic Fusion Lounge"
-    #       }
-    #     }
-    #  ]
-    #
+    #     { record_type: MODEL_NAME, payload_type: "primary_payload", attrs: { "KEY" => "VALUE", ... } },
+    #     { record_type: MODEL_NAME, payload_type: "current_association", attrs: { "KEY" => "VALUE", ... } },
+    #     ...
+    #   ]
     def attrs
       ordered_payloads.map do |payload|
         {
-          record_class: payload.record_type,
+          record_type: payload.record_type,
+          record_id: payload.record_id,
           payload_type: payload.payload_type,
-          attrs: payload.attrs
+          attrs: payload.attrs,
+          path: payload.payload_route
         }
       end
     end
 
-    # Returns the attributes of an upddate activity.
+    # Returns a hash describing the attributes of an update activity, including updated attributes for a record and any updated related attributes.
     #
     # Example:
     #   @activity.update_activity_attrs
     #
-    # Returns:
+    # The return value is structured as follows:
+    # - :update_attrs contains the attributes of the record being updated, detailing changes from previous to new values.
+    # - :updated_relations_attrs is an array of hashes, each representing an updated related record. Each hash details the previous and current attributes of the relation.
+    #
+    # Example Return Structure:
     #   {
-    #     # Update attributes for Demo::Club
     #     update_attrs: {
-    #       record_class: "Demo::Club",
-    #       attrs: [
-    #         {
-    #           "name" => {
-    #             # Previous name
-    #             from: "Electric Oasis Club",
-    #             # New name
-    #             to: "Electric Oasis Club nr 5"
-    #           }
-    #         }
-    #       ]
+    #       record_class: "CLASS.NAME",
+    #       attrs: [{ "KEY" => { from: "OLD_VALUE", to: "NEW_VALUE" } }]
     #     },
-    #     # Updated relations attributes
     #     updated_relations_attrs: [
     #       {
-    #         record_class: "Demo::Address",
-    #         previous_attrs: {
-    #           # Record class
-    #           record_class: "Demo::Address",
-    #           # Previous association payload type
-    #           payload_type: "previous_association",
-    #           # Previous attributes for Demo::Address
-    #           attrs: {
-    #             "street" => "Ice Hotel, Marknadsvägen 63",
-    #             "city" => "Jukkasjärvi",
-    #             "country" => "Sweden",
-    #             "postal_code" => "981 91"
-    #           }
-    #         },
-    #         current_attrs: {
-    #           record_class: "Demo::Address",
-    #           # Current association payload type
-    #           payload_type: "current_association",
-    #           # Current attributes for Demo::Address
-    #           attrs: {
-    #             "street" => "The Palace of Versailles",
-    #             "city" => "Versailles",
-    #             "country" => "France",
-    #             "postal_code" => "78000"
-    #           }
-    #         }
+    #         record_class: "CLASS.NAME",
+    #         previous_attrs: { attrs: { "KEY" => "VALUE", ... } },
+    #         current_attrs: { attrs: { "KEY" => "VALUE", ... } }
     #       }
     #     ]
     #   }
-    #
     def update_activity_attrs
       {
         update_attrs:,
@@ -143,13 +83,7 @@ module LoggableActivity
     #   @activity.primary_payload_attrs
     #
     # Returns:
-    #   {
-    #       "first_name" => "David",
-    #       "last_name" => "Bowie",
-    #             "age" => "69",
-    #           "email" => "david@example.com",
-    #       "user_type" => "Patient"
-    #   }
+    #   { "KEY_A" => "VALUE_A", "KEY_B" => "VALUE_B", ... }
     #
     def primary_payload_attrs
       primary_payload ? primary_payload.attrs : {}
@@ -164,16 +98,10 @@ module LoggableActivity
     # Returns:
     #   [
     #     {
-    #       record_class: "Demo::Address",
-    #       # Current association payload type
-    #       payload_type: "current_association",
-    #       # Current attributes for Demo::Address
-    #       attrs: {
-    #         "street" => "The Palace of Versailles",
-    #         "city" => "Versailles",
-    #         "country" => "France",
-    #         "postal_code" => "78000"
-    #       }
+    #       record_type: CLASS.NAME,
+    #       record_id: INTEGER,
+    #       payload_type: ENUM 
+    #       attrs: { "KEY_A" => "VALUE_A", "KEY_B" => "VALUE_B", ... }
     #     }
     #   ]
     def relations_attrs
@@ -195,6 +123,19 @@ module LoggableActivity
       LoggableActivity::Encryption.decrypt(encrypted_record_display_name, record_key)
     end
 
+    # Returns the path for the activity.
+    #
+    # Example:
+    #
+    #   @activity.path
+    #
+    # Returns:
+    #   "/path/to/activity"
+    #
+    def path
+      primary_payload&.route
+    end
+
     # Returns the display name for a actor. what method to use if defined in '/config/loggable_activity.yaml'
     #
     # Example:
@@ -235,6 +176,7 @@ module LoggableActivity
 
     private
 
+    # Returns the attributes for the update+payload.
     def update_attrs
       update_payload_attrs = attrs.find { |p| p[:payload_type] == 'update_payload' }
       return nil unless update_payload_attrs
@@ -243,42 +185,49 @@ module LoggableActivity
       update_payload_attrs
     end
 
+    # Returns the primary payload.
     def primary_payload
       ordered_payloads.find { |p| p.payload_type == 'primary_payload' }
     end
 
+    # Returns the attributes for the updated relations.
     def updated_relations_attrs
-      grouped_associations = attrs.group_by { |p| p[:record_class] }
+      grouped_associations = attrs.group_by { |p| p[:record_type] }
 
-      grouped_associations.map do |record_class, payloads|
+      grouped_associations.map do |record_type, payloads|
         previous_attrs = payloads.find { |p| p[:payload_type] == 'previous_association' }
         current_attrs = payloads.find { |p| p[:payload_type] == 'current_association' }
         next if previous_attrs.nil? && current_attrs.nil?
 
-        { record_class:, previous_attrs:, current_attrs: }
+        { record_type:, previous_attrs:, current_attrs: }
       end.compact
     end
 
+    # Returns the previous association attributes.
     def previous_associations_attrs
       attrs.select { |p| p[:payload_type] == 'previous_association' }
     end
 
+    # Returns payloads sorted by :payload_type.
     def ordered_payloads
       payloads.order(:payload_type)
     end
 
+    # Returns the key for the logged record.
     def record_key
       return nil if record.nil?
 
       LoggableActivity::EncryptionKey.for_record(record)&.key
     end
 
+    # Returns the key for the actor.
     def actor_key
       return nil if actor.nil?
 
       LoggableActivity::EncryptionKey.for_record(actor)&.key
     end
 
+    # Validates that the activity has at least one payload.
     def must_have_at_least_one_payload
       errors.add(:payloads, 'must have at least one payload') if payloads.empty?
     end

data/lib/loggable_activity/configuration.rb

@@ -3,6 +3,7 @@
 module LoggableActivity
   # This class is used to load the configuration file located at config/loggable_activity.yml
   class Configuration
+    # Loads the configuration file
     def self.load_config_file(config_file_path)
       @config_data = YAML.load_file(config_file_path)
     end

data/lib/loggable_activity/encryption.rb

@@ -23,7 +23,7 @@ module LoggableActivity
       return nil if data.nil? || encoded_key.nil?
 
       encryption_key = Base64.decode64(encoded_key)
-      raise EncryptionError, "Encryption failed: Invalid encryption key length #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
+      raise EncryptionError, "Encryption failed: Invalid encoded_key length #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').encrypt
       cipher.key = encryption_key
@@ -48,7 +48,7 @@ module LoggableActivity
       return '' if data.nil? || encoded_key.nil?
 
       encryption_key = Base64.decode64(encoded_key)
-      raise EncryptionError, 'Decryption failed: Invalid encryption key length' unless encryption_key.bytesize == 32
+      raise EncryptionError, "Decryption failed: Invalid encoded_key length: #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
 
       cipher = OpenSSL::Cipher.new('AES-256-CBC').decrypt
       cipher.key = encryption_key
@@ -60,8 +60,12 @@ module LoggableActivity
       decrypted_data.force_encoding('UTF-8')
     rescue OpenSSL::Cipher::CipherError => e
       raise EncryptionError, "Decryption failed: #{e.message}"
+    rescue EncryptionError => e
+      puts e.message
+      '*** DECRYPTION FAILED ***'
     end
 
+    # Returns true if the given value is blank
     def self.blank?(value)
       value.respond_to?(:empty?) ? value.empty? : !value
     end

data/lib/loggable_activity/encryption_key.rb

@@ -65,6 +65,8 @@ module LoggableActivity
     #  }
     #
     def self.for_record(record, parent_key = nil)
+      return nil if record.nil?
+
       encryption_key = find_by(record:)
       return encryption_key if encryption_key
 

data/lib/loggable_activity/hooks.rb

@@ -26,6 +26,7 @@ module LoggableActivity
       self.auto_log = config&.fetch('auto_log', []) || []
       self.actor_display_name = config&.fetch('actor_display_name', nil)
       self.record_display_name = config&.fetch('record_display_name', nil)
+      self.route = config&.fetch('route', nil)
 
       after_create :log_create_activity
       after_update :log_update_activity
@@ -62,18 +63,22 @@ module LoggableActivity
 
     private
 
+    # Logs an activity for the current action.
     def log_activity
       create_activity(build_payloads)
     end
 
+    # Logs an activity for the update action.
     def log_update
       create_activity(build_update_payloads)
     end
 
+    # Logs an activity for the destroy action.
     def log_destroy
       create_activity(build_destroy_payload)
     end
 
+    # Creates an activity with the specified payloads.
     def create_activity(payloads)
       return if nothing_to_log?(payloads)
 
@@ -87,30 +92,37 @@ module LoggableActivity
       )
     end
 
+    # Returns true if there are no payloads to log.
     def nothing_to_log?(payloads)
       payloads.empty?
     end
 
+    # Logs a custom activity.
     def log_custom_activity(activity); end
 
+    # Logs an update activity automatically if configured.
     def log_update_activity
       log(:update) if self.class.auto_log.include?('update')
     end
 
+    # Logs a create activity automatically if configured.
     def log_create_activity
       log(:create) if self.class.auto_log.include?('create')
     end
 
+    # Logs a destroy activity automatically if configured.
     def log_destroy_activity
       LoggableActivity::EncryptionKey.for_record(self)&.mark_as_deleted
       log(:destroy) if self.class.auto_log.include?('destroy')
     end
 
+    # Returns the encrypted name of the actor.
     def encrypted_actor_name
       actor_display_name = @actor.send(actor_display_name_field)
       LoggableActivity::Encryption.encrypt(actor_display_name, actor_encryption_key)
     end
 
+    # Returns the encrypted name of the record.
     def encrypted_record_name
       display_name =
         if self.class.record_display_name.nil?
@@ -121,34 +133,41 @@ module LoggableActivity
       LoggableActivity::Encryption.encrypt(display_name, primary_encryption_key)
     end
 
+    # Returns the action key for the current action.
     def action_key
       @action_key ||= self.class.base_action + ".#{@action}"
     end
 
+    # Returns the primary encryption key for the activity
     def primary_encryption_key
       @primary_encryption_key ||=
         LoggableActivity::EncryptionKey.for_record(self)&.key
     end
 
+    # Returns true if the primary encryption key is deleted.
     def primary_encryption_key_deleted?
       primary_encryption_key.nil?
     end
 
+    # Returns the encryption key for the actor.
     def actor_encryption_key
       LoggableActivity::EncryptionKey.for_record(@actor)&.key
     end
 
+    # Returns the display name of the actor.
     def actor_display_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
-      attr_accessor :loggable_attrs, :relations, :auto_log, :actor_display_name, :record_display_name
+      attr_accessor :loggable_attrs, :relations, :auto_log, :actor_display_name, :record_display_name, :route
 
+      # Convert the model name and name space in to 'base_action'.
       def base_action
         name.downcase.gsub('::', '/')
       end

data/lib/loggable_activity/payload.rb

@@ -50,6 +50,13 @@ module LoggableActivity
       end
     end
 
+    # Returns the route for the payload.
+    def payload_route
+      return nil if payload_encryption_key.nil?
+
+      route
+    end
+
     private
 
     # Retrieves the encryption key for the payload.

data/lib/loggable_activity/payloads_builder.rb

@@ -40,7 +40,8 @@ module LoggableActivity
         record: @record,
         payload_type: 'primary_payload',
         encrypted_attrs:,
-        data_owner: true
+        data_owner: true,
+        route: self.class.route
       )
     end
 
@@ -52,7 +53,8 @@ module LoggableActivity
         record: @record,
         payload_type: 'primary_payload',
         encrypted_attrs:,
-        data_owner: true
+        data_owner: true,
+        route: nil
       )
     end
 
@@ -108,7 +110,8 @@ module LoggableActivity
         record: associated_record,
         encrypted_attrs:,
         payload_type: 'current_association',
-        data_owner: relation_config['data_owner']
+        data_owner: relation_config['data_owner'],
+        route: relation_config['route']
       )
     end
 

data/lib/loggable_activity/update_payloads_builder.rb

@@ -18,6 +18,7 @@ module LoggableActivity
 
     private
 
+    # Fetch the previous and current values of the primary record.
     def primary_update_attrs
       previous_values = saved_changes.transform_values(&:first)
       current_values = saved_changes.transform_values(&:last)
@@ -25,6 +26,7 @@ module LoggableActivity
       [previous_values, current_values]
     end
 
+    # Builds the primary update payload.
     def build_primary_update_payload(previous_values, current_values)
       return if previous_values == current_values
 
@@ -32,10 +34,12 @@ module LoggableActivity
       @update_payloads << LoggableActivity::Payload.new(
         record: @record,
         payload_type: 'update_payload',
-        encrypted_attrs: encrypted_update_attrs
+        encrypted_attrs: encrypted_update_attrs,
+        route: self.class.route
       )
     end
 
+    # Returns the encrypted attributes for the update payload.
     def encrypted_update_attrs(previous_values, current_values)
       changes = []
       changed_attrs = previous_values.slice(*self.class.loggable_attrs)
@@ -48,6 +52,7 @@ module LoggableActivity
       { changes: }
     end
 
+    # Builds update payloads for relations.
     def build_update_relation_payloads(relation_config)
       relation_config.each_key do |key|
         case key
@@ -61,6 +66,7 @@ module LoggableActivity
       end
     end
 
+    # Builds the update payload for a has_many relation.
     def build_relation_update_for_has_many(relation_config)
       # NOTE: This method is not implemented yet.
       # It requires that there is a form where it is possible to change
@@ -68,13 +74,15 @@ module LoggableActivity
       # puts relation_config['has_many']
     end
 
+    # Builds the update payload for a has_one relation.
     def build_relation_update_for_has_one(relation_config)
       # NOTE: This method is not implemented yet.
       # It requires that there is a form where it is possible to change
       # the related records. This is not implemented yet. in the Demo app
-      # puts relation_config['has_many']
+      # puts relation_config['has_one']
     end
 
+    # Builds the update payload for a belongs_to relation.
     def build_relation_update_for_belongs_to(relation_config)
       relation_id = "#{relation_config['belongs_to']}_id"
       model_class_name = relation_config['model']
@@ -91,25 +99,27 @@ module LoggableActivity
 
         payload_type = index.zero? ? 'previous_association' : 'current_association'
         build_relation_update_payload(
-          relation_record.attributes,
-          relation_config['loggable_attrs'],
+          relation_config,
           relation_record,
           payload_type
         )
       end
     end
 
-    def build_relation_update_payload(_attrs, loggable_attrs, record, payload_type)
+    # Builds the update payload for a relation.
+    def build_relation_update_payload(relation_config, record, payload_type)
       encryption_key = LoggableActivity::EncryptionKey.for_record(record)&.key
-      encrypted_attrs = relation_encrypted_attrs(record.attributes, loggable_attrs, encryption_key)
+      encrypted_attrs = relation_encrypted_attrs(record.attributes, relation_config['loggable_attrs'], encryption_key)
 
       @update_payloads << LoggableActivity::Payload.new(
         record:,
         encrypted_attrs:,
-        payload_type:
+        payload_type:,
+        route: relation_config['route']
       )
     end
 
+    # Returns the encrypted attributes for a relation.
     def relation_encrypted_attrs(attrs, loggable_attrs, encryption_key)
       encrypt_attrs(attrs, loggable_attrs, encryption_key)
     end

data/lib/loggable_activity/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Version of the gem
 module LoggableActivity
-  VERSION = '0.1.54'
+  # Version
+  VERSION = '0.1.55'
 end

data/lib/loggable_activity.rb

@@ -12,5 +12,4 @@ require_relative 'loggable_activity/update_payloads_builder'
 
 module LoggableActivity
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.54
+  version: 0.1.55
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord