loggable_activity 0.1.45 → 0.1.47

data/docs/table_of_contents.html

@@ -118,11 +118,36 @@
     —
     <span class="container">LoggableActivity::EncryptionKey</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-action_key">#action_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
   <li class="method">
     <a href="LoggableActivity/Activity.html#method-i-actor_display_name">#actor_display_name</a>
     &mdash;
     <span class="container">LoggableActivity::Activity</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-actor_display_name_field">#actor_display_name_field</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-actor_encryption_key">#actor_encryption_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-actor_key">#actor_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-associated_record_encryption_key">#associated_record_encryption_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/Activity.html#method-i-attrs">#attrs</a>
     &mdash;
@@ -133,36 +158,231 @@
     &mdash;
     <span class="container">LoggableActivity::Payload</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-base_action">#base_action</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-build_destroy_payload">#build_destroy_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-build_payload">#build_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/PayloadsBuilder.html#method-i-build_payloads">#build_payloads</a>
     &mdash;
     <span class="container">LoggableActivity::PayloadsBuilder</span>
 
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-build_primary_payload">#build_primary_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-build_primary_update_payload">#build_primary_update_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-build_relation_payload">#build_relation_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-build_relation_update_for_belongs_to">#build_relation_update_for_belongs_to</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-build_relation_update_payload">#build_relation_update_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-build_update_payloads">#build_update_payloads</a>
     &mdash;
     <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
 
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-build_update_relation_payloads">#build_update_relation_payloads</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-create_activity">#create_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-current_user_model-3F">#current_user_model?</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-decrypt_attr">#decrypt_attr</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-decrypted_attrs">#decrypted_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-decrypted_from_to_attr">#decrypted_from_to_attr</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-decrypted_update_attrs">#decrypted_update_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-deleted_attrs">#deleted_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-encrypt_attr">#encrypt_attr</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/PayloadsBuilder.html#method-i-encrypt_attrs">#encrypt_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::PayloadsBuilder</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-encrypted_actor_name">#encrypted_actor_name</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-encrypted_record_name">#encrypted_record_name</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-encrypted_update_attrs">#encrypted_update_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/Hooks.html#method-i-log">#log</a>
     &mdash;
     <span class="container">LoggableActivity::Hooks</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_activity">#log_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_create_activity">#log_create_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_custom_activity">#log_custom_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_destroy">#log_destroy</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_destroy_activity">#log_destroy_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_update">#log_update</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-log_update_activity">#log_update_activity</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
   <li class="method">
     <a href="LoggableActivity/EncryptionKey.html#method-i-mark_as_deleted">#mark_as_deleted</a>
     &mdash;
     <span class="container">LoggableActivity::EncryptionKey</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-must_have_at_least_one_payload">#must_have_at_least_one_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-nothing_to_log-3F">#nothing_to_log?</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-ordered_payloads">#ordered_payloads</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Payload.html#method-i-payload_encryption_key">#payload_encryption_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Payload</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-previous_associations_attrs">#previous_associations_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-primary_encryption_key">#primary_encryption_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Hooks.html#method-i-primary_encryption_key_deleted-3F">#primary_encryption_key_deleted?</a>
+    &mdash;
+    <span class="container">LoggableActivity::Hooks</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-primary_payload">#primary_payload</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
   <li class="method">
     <a href="LoggableActivity/Activity.html#method-i-primary_payload_attrs">#primary_payload_attrs</a>
     &mdash;
     <span class="container">LoggableActivity::Activity</span>
 
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-primary_update_attrs">#primary_update_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/Activity.html#method-i-record_display_name">#record_display_name</a>
     &mdash;
     <span class="container">LoggableActivity::Activity</span>
 
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-record_key">#record_key</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/UpdatePayloadsBuilder.html#method-i-relation_encrypted_attrs">#relation_encrypted_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::UpdatePayloadsBuilder</span>
+
   <li class="method">
     <a href="LoggableActivity/Activity.html#method-i-relations_attrs">#relations_attrs</a>
     &mdash;
@@ -172,6 +392,16 @@
     <a href="LoggableActivity/Activity.html#method-i-update_activity_attrs">#update_activity_attrs</a>
     &mdash;
     <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-update_attrs">#update_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
+
+  <li class="method">
+    <a href="LoggableActivity/Activity.html#method-i-updated_relations_attrs">#updated_relations_attrs</a>
+    &mdash;
+    <span class="container">LoggableActivity::Activity</span>
 </ul>
 </main>
 

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

@@ -3,7 +3,7 @@
 class CreateLoggableEncryptionKeys < ActiveRecord::Migration[6.1]
   def change
     create_table :loggable_encryption_keys do |t|
-      t.references :parrent_key, foreign_key: { to_table: 'loggable_encryption_keys', on_delete: :nullify }
+      t.references :parent_key, foreign_key: { to_table: 'loggable_encryption_keys', on_delete: :nullify }
       t.string :key
       t.references :record, polymorphic: true, on_delete: :nullify
     end

data/lib/loggable_activity/activity.rb

@@ -260,11 +260,13 @@ module LoggableActivity
 
     def record_key
       return nil if record.nil?
+
       LoggableActivity::EncryptionKey.for_record(record)&.key
     end
 
     def actor_key
       return nil if actor.nil?
+
       LoggableActivity::EncryptionKey.for_record(actor)&.key
     end
 

data/lib/loggable_activity/encryption.rb

@@ -41,7 +41,7 @@ module LoggableActivity
     #   "my secret data"
     #
     def self.decrypt(data, encryption_key)
-      return "" if data.nil?
+      return '' if data.nil?
       return I18n.t('loggable.activity.deleted') if encryption_key.nil?
 
       cipher = OpenSSL::Cipher.new('AES-128-CBC').decrypt

data/lib/loggable_activity/encryption_key.rb

@@ -8,13 +8,13 @@ module LoggableActivity
 
     # Associations
     belongs_to :record, polymorphic: true, optional: true
-    belongs_to :parrent_key, class_name: 'LoggableActivity::EncryptionKey', optional: true,
-                             foreign_key: 'parrent_key_id'
+    belongs_to :parent_key, class_name: 'LoggableActivity::EncryptionKey', optional: true,
+                            foreign_key: 'parent_key_id'
 
     # Marks the encryption key as deleted by updating the key to nil.
     def mark_as_deleted
       update(key: nil)
-      parrent_key.mark_as_deleted if parrent_key.present?
+      parent_key.mark_as_deleted if parent_key.present?
     end
 
     # Returns an encryption key for a record by its type and ID, optionally using a parent key.
@@ -30,7 +30,7 @@ module LoggableActivity
     # Returns:
     #  {
     #    :id => 39,
-    #    :parrent_key_id => 38,
+    #    :parent_key_id => 38,
     #    :key => "a8f4774e7f42eb253045a4db7de7b79e",
     #    :record_type => "User",
     #    :record_id => 1
@@ -56,7 +56,7 @@ module LoggableActivity
     # Returns:
     #  {
     #    :id => 39,
-    #    :parrent_key_id => 38,
+    #    :parent_key_id => 38,
     #    :key => "a8f4774e7f42eb253045a4db7de7b79e",
     #    :record_type => "User",
     #    :record_id => 1
@@ -82,7 +82,7 @@ module LoggableActivity
     # Returns:
     #  {
     #    :id => 39,
-    #    :parrent_key_id => 38,
+    #    :parent_key_id => 38,
     #    :key => "a8f4774e7f42eb253045a4db7de7b79e",
     #    :record_type => "User",
     #    :record_id => 1
@@ -90,7 +90,7 @@ module LoggableActivity
     #
     def self.create_encryption_key(record_type, record_id, parent_key = nil)
       if parent_key
-        create(record_type:, record_id:, key: random_key, parent_key_id: parent_key.id)
+        create(record_type:, record_id:, key: random_key, parent_key:)
       else
         create(record_type:, record_id:, key: random_key)
       end
@@ -107,7 +107,7 @@ module LoggableActivity
     #  "a8f4774e7f42eb253045a4db7de7b79e"
     #
     def self.random_key
-      SecureRandom.hex(16)
+      SecureRandom.hex(32)
     end
   end
 end

data/lib/loggable_activity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.45'
+  VERSION = '0.1.47'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.45
+  version: 0.1.47
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-15 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,26 +50,6 @@ files:
 - README.md
 - ROADMAP.md
 - Rakefile
-- doc/.nojekyll
-- doc/CHANGELOG_md.html
-- doc/CODE_OF_CONDUCT_md.html
-- doc/CONSIDERTIONS_md.html
-- doc/CreateLoggableActivities.html
-- doc/CreateLoggableEncryptionKeys.html
-- doc/CreateLoggablePayloads.html
-- doc/GETTING-STARTED_md.html
-- doc/Gemfile.html
-- doc/Gemfile_lock.html
-- doc/LICENSE_txt.html
-- doc/LoggableActivity/CurrentUser.html
-- doc/LoggableActivity/Generators.html
-- doc/LoggableActivity/Generators/InstallGenerator.html
-- doc/README_md.html
-- doc/ROADMAP_md.html
-- doc/Rakefile.html
-- doc/bin/setup.html
-- doc/notes/CHEAT_SHEET_md.html
-- doc/sig/loggable_activity_rbs.html
 - docs/LoggableActivity.html
 - docs/LoggableActivity/Activity.html
 - docs/LoggableActivity/Configuration.html

data/doc/.nojekyll

@@ -1 +0,0 @@
-- keep

data/doc/CHANGELOG_md.html

@@ -1,125 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta charset="UTF-8">
-
-<title>CHANGELOG - RDoc Documentation</title>
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-  var index_rel_prefix = "./";
-</script>
-
-<script src="./js/navigation.js" defer></script>
-<script src="./js/search.js" defer></script>
-<script src="./js/search_index.js" defer></script>
-<script src="./js/searcher.js" defer></script>
-<script src="./js/darkfish.js" defer></script>
-
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-
-
-<body id="top" role="document" class="file">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-
-  </div>
-
-  
-<div class="nav-section">
-  <h3>Table of Contents</h3>
-
-
-
-  <ul class="link-list" role="directory">
-              <li>      <a href="#label-5BUnreleased-5D">[Unreleased]</a>
-          <li>      <a href="#label-5B0.1.39-5D+-+2024-02-12">[0.1.39] - 2024-02-12</a>
-          <li>      <a href="#label-5B0.1.38-5D+-+2024-02-12">[0.1.38] - 2024-02-12</a>
-          <li>      <a href="#label-5B0.1.35-5D+-+2024-02-11">[0.1.35] - 2024-02-11</a>
-
-  </ul>
-</div>
-
-
-  <div id="project-metadata">
-    
-<div id="fileindex-section" class="nav-section">
-  <h3>Pages</h3>
-
-  <ul class="link-list">
-    <li><a href="./CHANGELOG_md.html">CHANGELOG</a>
-    <li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
-    <li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
-    <li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
-    <li><a href="./Gemfile.html">Gemfile</a>
-    <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
-    <li><a href="./LICENSE_txt.html">LICENSE</a>
-    <li><a href="./README_md.html">README</a>
-    <li><a href="./ROADMAP_md.html">ROADMAP</a>
-    <li><a href="./Rakefile.html">Rakefile</a>
-    <li><a href="./bin/setup.html">setup</a>
-    <li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
-    <li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
-  </ul>
-</div>
-
-  </div>
-</nav>
-
-<main role="main" aria-label="Page CHANGELOG.md">
-
-<h2 id="label-5BUnreleased-5D">[Unreleased]<span><a href="#label-5BUnreleased-5D">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<ul><li>
-<p>nothing so far</p>
-
-<h2 id="label-5B0.1.39-5D+-+2024-02-12">[0.1.39] - 2024-02-12<span><a href="#label-5B0.1.39-5D+-+2024-02-12">&para;</a> <a href="#top">&uarr;</a></span></h2>
-</li><li>
-<p>Updated <a href="README_md.html">README.md</a> and <a href="GETTING-STARTED_md.html">GETTING-STARTED.md</a></p>
-
-<h2 id="label-5B0.1.38-5D+-+2024-02-12">[0.1.38] - 2024-02-12<span><a href="#label-5B0.1.38-5D+-+2024-02-12">&para;</a> <a href="#top">&uarr;</a></span></h2>
-</li><li>
-<p>Removed dependency on awesome print</p>
-
-<h2 id="label-5B0.1.35-5D+-+2024-02-11">[0.1.35] - 2024-02-11<span><a href="#label-5B0.1.35-5D+-+2024-02-11">&para;</a> <a href="#top">&uarr;</a></span></h2>
-</li><li>
-<p>Initial release</p>
-</li></ul>
-
-</main>
-
-
-
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>
-