class LoggableActivity::Services::BasePayloadsBuilder

This service class provides the base payloads builder for the loggable activity. Other service modules related to the loggable activity will inherit from this module.

Public Class Methods

new(record, payloads) click to toggle source

Initializes the PayloadsBuilder with a record and an initial collection of payloads,

# File lib/loggable_activity/services/base_payloads_builder.rb, line 9
def initialize(record, payloads)
  @record = record
  @payloads = payloads
  @loggable_attrs = record.class.loggable_attrs
  # @relation_config = record.relation_config
  @relations = record.class.relations
  @auto_log = record.class.auto_log
  # @fetch_record_name_from = record.class.fetch_record_name_from
  @route = record.class.route
end

Private Instance Methods

build_encrypted_payload(record, options = {}) click to toggle source

Build a encrypted payload for a record

# File lib/loggable_activity/services/base_payloads_builder.rb, line 65
def build_encrypted_payload(record, options = {})
  encryption_key = encryption_key_for_record(record)
  return if encryption_key.deleted?

  secret_key = encryption_key.secret_key
  encrypted_attrs = encrypt_attributes(record, secret_key)

  build_payload(
    record,
    encryption_key,
    encrypted_attrs,
    options
  )
  { encryption_key:, encrypted_attrs: }
end

build_payload(record, encryption_key, encrypted_attrs, options = {}) click to toggle source

Builds the payload for a record

# File lib/loggable_activity/services/base_payloads_builder.rb, line 82
def build_payload(record, encryption_key, encrypted_attrs, options = {})
  return if encryption_key.deleted?

  related_to_activity_as = options[:related_to_activity_as]
  current_payload = options[:current_payload]
  data_owner = options[:data_owner]

  secret_key = encryption_key.secret_key
  encrypted_record_name = encrypt_record_name_for_record(record, secret_key)
  payload = ::LoggableActivity::Payload.new(
    encryption_key:,
    record:,
    encrypted_record_name:,
    encrypted_attrs:,
    related_to_activity_as:,
    route: record.class.route,
    current_payload:,
    data_owner:
  )
  unless payload.valid?
    error_message = "Payload validation failed: #{payload.errors.full_messages.join(', ')}"
    raise LoggableActivity::Error, error_message
  end

  @payloads << payload
end

changes_to_save(record) click to toggle source

Fetch the previous and current values for a record.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 28
def changes_to_save(record)
  changes = record.changes_to_save
  previous_values = {}
  current_values = {}

  changes.map do |key, value|
    previous_values[key] = value[0]
    current_values[key] = value[1]
  end
  [previous_values, current_values]
end

encrypt_attr(value, secret_key) click to toggle source

Encrypt a single attribute.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 122
def encrypt_attr(value, secret_key)
  ::LoggableActivity::Encryption.encrypt(value, secret_key)
end

encrypt_attributes(record, secret_key) click to toggle source

Encrypts the attributes for the record.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 110
def encrypt_attributes(record, secret_key)
  encrypt_attrs(record.attributes, record.class.loggable_attrs, secret_key)
end

encrypt_attrs(attrs, loggable_attrs, secret_key) click to toggle source

Encrypt one attributes for only loggable_attrs, configured

# File lib/loggable_activity/services/base_payloads_builder.rb, line 115
def encrypt_attrs(attrs, loggable_attrs, secret_key)
  attrs.slice(*loggable_attrs).transform_values do |value|
    ::LoggableActivity::Encryption.encrypt(value, secret_key)
  end
end

encrypt_record_name_for_record(record, secret_key) click to toggle source

Encrypts the record name for the record. If the record has a fetch_record_name_from the configuration, it will use that method to fetch the record name. Otherwise, it will use the class name and the record id.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 44
def encrypt_record_name_for_record(record, secret_key)
  record_name = fetch_record_name_for_record(record) || "#{record.class.name}##{record.id}"

  ::LoggableActivity::Encryption.encrypt(record_name, secret_key)
end

encryption_key_for_record(record) click to toggle source

Returns the encryption key for the record.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 60
def encryption_key_for_record(record)
  ::LoggableActivity::EncryptionKey.for_record(record)
end

fetch_record_name_for_record(record) click to toggle source

Return the record name for the record. If the record has a fetch_record_name_from the configuration,

# File lib/loggable_activity/services/base_payloads_builder.rb, line 52
def fetch_record_name_for_record(record)
  fetch_from = record.class.fetch_record_name_from
  return nil if fetch_from.nil?

  record.send(fetch_from)
end

saved_changes(record) click to toggle source

Returns saved changes for a record.

# File lib/loggable_activity/services/base_payloads_builder.rb, line 23
def saved_changes(record)
  [record.saved_changes.transform_values(&:first), record.saved_changes.transform_values(&:last)]
end