loggable_activity 0.1.59 → 0.2.1c

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2b65fd9476234eb90900437f005f9a84b9e29c1acb514236a8b24346278b17
-  data.tar.gz: ef3113633c4c9b101e119d829213ee00c345af95700d112d800a06232fa442d6
+  metadata.gz: aedc39df0c92354d989c8991ca33392b22b17712b09d029b47e4c3f416a9fea6
+  data.tar.gz: 608619353a94d6488bcc5ab6b1b5e8355598051a8aace932ca7336ef41b04c0e
 SHA512:
-  metadata.gz: ea6c0068987ae337395230e9147b7be7bbbedb10fc488dfad2c901bf5b590a51024333141fa350e7007e8c50ce8a453962770ee4e9cce8b5fb8f9ccc03d8b63a
-  data.tar.gz: 73f5b8a7bca8f87907be31b4e4bc378a0a0caa34fa774c1ba21f2aa39da5733b56827e780be3460ed4415d5f2cb92e03a5a8c47919ac5df6f439cf1ed4331e19
+  metadata.gz: 15de688e047ce77333ce9b0b6cdbbad648c69dc2022f0d42913c0058c9ad0ddcd9397f8b6e143a1201cde0f0f6905e2a729f26d802233009bf6fb21814b78740
+  data.tar.gz: 6d8cb25b837e1fdfaa3ac4cf9e27ab875c681595f0c1e8f3131e8f69d8e35849f06a050ca62235d7214f2a67f139642ba5143e4d4f40d037c5dfee959b5289eb

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,10 @@
 
+## [0.2.1b] - 2024-07-03
+- Repo has moved to organization on github
+
+## [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/GETTING-STARTED.md

@@ -7,7 +7,7 @@ This document should you getting started with `LoggableActivity`
 
 ## Demo Application
 You can download a demo application from<br/>
-[https://github.com/maxgronlund/LoggableActivityDemoApp](https://github.com/maxgronlund/LoggableActivityDemoApp)
+[https://github.com/LoggableActivity/LoggableActivityDemoApp](https://github.com/LoggableActivity/LoggableActivityDemoApp)
 <br/>
 You can try a demo here<br/>
 [https://loggableactivity-efe7b931c886.herokuapp.com/](https://loggableactivity-efe7b931c886.herokuapp.com/)
@@ -114,6 +114,6 @@ Supported relations at the moment is
 
 ## For developers and contributors 
 If you can download and play around with a demo app
-- 1 Down the demo project from [demo project on github](https://github.com/maxgronlund/LoggableActivityDemoApp)
+- 1 Down the demo project from [demo project on github](https://github.com/LoggableActivity/LoggableActivityDemoApp)
 - 2 Update the Gemfile in the demo project so it points to your localhost.
 - 3 you can now build and test you version of the gem `$ gem build loggable_activity.gemspec`

data/README.md

@@ -30,7 +30,7 @@ Beside the journal in the db, an activity log is kept so it is possible to track
 At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/>
 
 ### Getting started
-please read the [GETTING-STARTED.md](https://github.com/maxgronlund/LoggableActivity/blob/main/GETTING-STARTED.md) guide
+please read the [GETTING-STARTED.md](https://github.com/LoggableActivity/LoggableActivity/blob/main/GETTING-STARTED.md) guide
 
 ### Contribute
 👉 Join the Slack channel here: [LoggableActivity Slack Workspace](https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ)

data/ROADMAP.md

@@ -4,7 +4,7 @@ Outline of steps to get the LoggableActivity adapted.
 ### Demo project
 Nothing is better than gain som experience by getting som real world tests and experiences.
 <br/>
-Try the [Live Demo]("https://loggableactivity-efe7b931c886.herokuapp.com/") here or download it from [Github]("https://github.com/maxgronlund/LoggableActivityDemoApp") here
+Try the [Live Demo]("https://loggableactivity-efe7b931c886.herokuapp.com/") here or download it from [Github]("https://github.com/LoggableActivity/LoggableActivityDemoApp") here
 
 
 ### Open Source

data/lib/generators/loggable_activity/install_generator.rb

@@ -80,7 +80,7 @@ module LoggableActivity
 
 
           For more information, please visit:
-          https://github.com/maxgronlund/LoggableActivity/blob/main/GETTING-STARTED.md
+          https://github.com/LoggableActivity/LoggableActivity/blob/main/GETTING-STARTED.md
 
           ------------------------------------------------
         MESSAGE

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

@@ -85,5 +85,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/version.rb

@@ -3,5 +3,5 @@
 # Version of the gem
 module LoggableActivity
   # Version
-  VERSION = '0.1.59'
+  VERSION = '0.2.1c'
 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.59
+  version: 0.2.1c
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-06-28 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
@@ -267,9 +304,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://loggableactivity-efe7b931c886.herokuapp.com/
-  source_code_uri: https://github.com/maxgronlund/LoggableActivity
-  changelog_uri: https://github.com/maxgronlund/LoggableActivity/CHANGELOG.md
-  documentation_uri: https://maxgronlund.github.io/LoggableActivity/
+  source_code_uri: https://github.com/LoggableActivity/LoggableActivity
+  changelog_uri: https://github.com/LoggableActivity/LoggableActivity/CHANGELOG.md
+  documentation_uri: https://LoggableActivity.github.io/LoggableActivity/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -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 .