loggable_activity 0.1.58 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3443b88743e80e04335aeb6b192af90e69d6e79c22906784d8fde0efc303371e
-  data.tar.gz: 010db4535422917b8c7595e60d61e15a309c70456a95dfc4809bc6bcd382119e
+  metadata.gz: c639f2566d6a3dd820a7657b9b8bb398e5a861347ae1bc7d7474724c6c344b4c
+  data.tar.gz: 8551b4aab8f630be997b6af7b8372d7efd84221824bbacb25bb6c444f6c83978
 SHA512:
-  metadata.gz: 503bc1adc73fb22312c8ae21b2a68dfd12e4f452687bd0b3be947a73a2a5aa06e4c643461b5c6f768915cd09c00117ec5020028bb91c30bcc9e618226d8efeda
-  data.tar.gz: b6f50f7877b2164f8b58267c87a1a2b0ede19f85d9c05a9cd32cb7b1188405f738704fd0e17907ed521f51db0893a40a4102e48e6b8b998ecd422143cf1f546c
+  metadata.gz: 03422fe2e2d154f894da7a0eab5fac78f1048b6e6d3d4addbf1fa0bd66d9a674913ca666a4a4e743cbaf95ff5edbfb8711641596330b370d5d29d3e0922f4af6
+  data.tar.gz: '08de4b66e4aba0d210be64f83eb78b51fcb6c351d3340e9f1dfba334194d5c6a705daeefe6f66aae8a7cc8409a94b1ba4ec33d222a957e549b0811629f6ebfcb'

data/.vscode/commands.json

@@ -0,0 +1,26 @@
+{
+  "commands": [
+    {
+      "command": "terminals.runTerminalByName",
+      "arguments": [
+        "Test"
+      ],
+      "text": "$(run)",
+      "alignment": "right",
+      "priority": 300,
+      "tooltip": "Run test for current line",
+      "filterFileRegex": ".*_spec\\.rb"
+    },
+    {
+      "command": "terminals.runTerminalByName",
+      "arguments": [
+        "Test file"
+      ],
+      "text": "$(run-all)",
+      "alignment": "right",
+      "priority": 290,
+      "tooltip": "Run test for current file",
+      "filterFileRegex": ".*_spec\\.rb"
+    }
+  ]
+}

data/.vscode/terminals.json

@@ -0,0 +1,31 @@
+{
+  "autorun": false,
+  "terminals": [
+    {
+      "name": "Test",
+      "focus": true,
+      "execute": true,
+      "onlySingle": true,
+      "icon": "run",
+      "commands": [
+        "dir=[file] && test_path=${${(s:/spec/:)dir}[1]} && file=\"spec/\"${${(s:/spec/:)dir}[2]}",
+        "echo \"$dir\\n$test_path\\n$file:[lineNumber]\"",
+        "cd $test_path",
+        "rspec $file:[lineNumber]"
+      ]
+    },
+    {
+      "name": "Test file",
+      "focus": true,
+      "execute": true,
+      "onlySingle": true,
+      "icon": "run-all",
+      "commands": [
+        "dir=[file] && test_path=${${(s:/spec/:)dir}[1]} && file=\"spec/\"${${(s:/spec/:)dir}[2]}",
+        "echo \"$dir\\n$test_path\\n$file\"",
+        "cd $test_path",
+        "rspec $file"
+      ]
+    }
+  ]
+}

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 
+## [0.2.0] - 2024-07-03
+- Keys kan be kept until LoggableActivity::Sanitizer.run is called
+
 ## [0.1.58] - 2024-03-21
 ### Breaking change
 - All presentations generators are removed

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

@@ -30,6 +30,7 @@ class CreateLoggableActivities < ActiveRecord::Migration[7.1]
     create_table :loggable_encryption_keys do |t|
       t.references :record, polymorphic: true, null: true, index: true
       t.string :secret_key
+      t.datetime :delete_at
     end
   end
 end

data/lib/loggable_activity/activity.rb

@@ -18,6 +18,23 @@ module LoggableActivity
     validates :action, presence: true
     validate :must_have_at_least_one_payload
 
+    RELATION_TYPES = {
+      'primary_payload' => 'self',
+      'primary_update_payload' => 'self',
+      'primary_destroy_payload' => 'self',
+      'has_one_payload' => 'has_one',
+      'has_one_create_payload' => 'has_one',
+      'has_one_update_payload' => 'has_one',
+      'has_one_destroy_payload' => 'has_one',
+      'has_many_payload' => 'has_many',
+      'has_many_create_payload' => 'has_many',
+      'has_many_destroy_payload' => 'has_many',
+      'has_many_update_payload' => 'has_many',
+      'belongs_to_payload' => 'belongs_to',
+      'belongs_to_destroy_payload' => 'belongs_to',
+      'belongs_to_update_payload' => 'belongs_to'
+    }
+
     # 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.
     #
     # Each hash in the array contains:
@@ -48,7 +65,7 @@ module LoggableActivity
     def payloads_attrs
       ordered_payloads.map do |payload|
         {
-          related_to_activity_as: payload.related_to_activity_as,
+          relation: RELATION_TYPES[payload.related_to_activity_as],
           record_type: payload.record_type,
           record_id: payload.deleted? ? nil : payload.record_id,
           attrs: payload.attrs,

data/lib/loggable_activity/configuration.rb

@@ -2,6 +2,7 @@
 
 require 'json-schema'
 require 'json'
+require 'awesome_print'
 
 module LoggableActivity
   # This class is used to load the configuration file located at config/loggable_activity.yml
@@ -85,5 +86,10 @@ module LoggableActivity
     def self.current_user_model_name
       @config_data['current_user_model_name']
     end
+
+    # Returns whatever models should be sanitized on delete.
+    def self.task_for_sanitization
+      @config_data['task_for_sanitization']
+    end
   end
 end

data/lib/loggable_activity/encryption_key.rb

@@ -14,16 +14,28 @@ module LoggableActivity
     # 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.
+    # Prepare the record for deletion 
     def mark_as_deleted!
-      update(secret_key: nil)
+      LoggableActivity::Configuration.task_for_sanitization ? update(delete_at: DateTime.now + 1.month) : delete
     end
 
-    # check if the encryption key is deleted
+    # check if the encryption key is deleted or it is about to be deleted
     def deleted?
-      secret_key.nil?
+      secret_key.nil? || delete_at.present?
     end
 
+    # Delete the encryption key by updating the key to nil.
+    def delete
+      update(secret_key: nil, delete_at: nil) 
+    end
+
+    # Restores the encryption key by updating the delete_at field to nil.
+    def restore!
+      update(delete_at: nil) if delete_at &&  DateTime.now < delete_at
+    end
+
+
+
     # Returns an encryption key for a record by its type and ID, optionally using a parent key.
     #
     #  @param record_type [String] The type of the record.

data/lib/loggable_activity/hooks.rb

@@ -206,6 +206,7 @@ module LoggableActivity
       def base_action
         name.downcase.gsub('::', '/')
       end
+
     end
   end
 end

data/lib/loggable_activity/sanitizer.rb

@@ -0,0 +1,9 @@
+module LoggableActivity
+  module Sanitizer
+    def self.run 
+      ::LoggableActivity::EncryptionKey.where('delete_at < ?', DateTime.now).find_in_batches do |batch|
+        batch.each(&:delete)
+      end
+    end
+  end
+end

data/lib/loggable_activity/services/update_payloads_builder.rb

@@ -16,7 +16,8 @@ module LoggableActivity
       # Builds the primary payload.
       def build_primary_update_payload
         previous_values, current_values = saved_changes(@record)
-        previous_values.slice(*@loggable_attrs)
+        previous_values = previous_values.slice(*@loggable_attrs)
+        current_values = current_values.slice(*@loggable_attrs)
         options = { related_to_activity_as: 'primary_update_payload', current_payload: true, data_owner: true }
 
         build_encrypted_update_payload(
@@ -122,6 +123,7 @@ module LoggableActivity
         return if previous_values == current_values
 
         previous_values = previous_values.slice(*loggable_attrs)
+        current_values = current_values.slice(*loggable_attrs)
         data_owner = relation_config['data_owner']
         options = { related_to_activity_as: 'has_one_update_payload', current_payload: true, data_owner: }
 

data/lib/loggable_activity/version.rb

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

data/lib/loggable_activity.rb

@@ -9,6 +9,7 @@ require_relative 'loggable_activity/data_owner'
 require_relative 'loggable_activity/hooks'
 require_relative 'loggable_activity/payload'
 require_relative 'loggable_activity/error'
+require_relative 'loggable_activity/sanitizer'
 require_relative 'loggable_activity/services/base_payloads_builder'
 require_relative 'loggable_activity/services/payloads_builder'
 require_relative 'loggable_activity/services/update_payloads_builder'

data/lib/schemas/config_schema.json

@@ -7,10 +7,13 @@
     },
     "fetch_current_user_name_from": {
       "type": "string"
+    },
+    "task_for_sanitization": {
+      "type": "boolean"
     }
   },
   "patternProperties": {
-    "^(?!current_user_model_name$|fetch_current_user_name_from$)[A-Za-z0-9_:]+$": {
+    "^(?!current_user_model_name$|fetch_current_user_name_from$|task_for_sanitization)[A-Za-z0-9_:]+$": {
       "type": "object",
       "properties": {
         "data_owner": {
@@ -19,6 +22,9 @@
         "fetch_record_name_from": {
           "type": "string"
         },
+        "task_for_sanitization": {
+          "type": "boolean"
+        },
         "loggable_attrs": {
           "type": "array",
           "items": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.58
+  version: 0.2.1
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -92,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +198,8 @@ files:
 - ".rspec"
 - ".rspec_status"
 - ".rubocop.yml"
+- ".vscode/commands.json"
+- ".vscode/terminals.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONSIDERTIONS.md
@@ -254,6 +290,7 @@ files:
 - lib/loggable_activity/error.rb
 - lib/loggable_activity/hooks.rb
 - lib/loggable_activity/payload.rb
+- lib/loggable_activity/sanitizer.rb
 - lib/loggable_activity/services/base_payloads_builder.rb
 - lib/loggable_activity/services/destroy_payloads_builder.rb
 - lib/loggable_activity/services/payloads_builder.rb
@@ -286,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: Activity Logger with relations, prepared for GDPR Compliance and .