loggable_activity 0.1.36

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9e732145f0c4b463a0db97b8551841222d966031d54a067dad138bf98c8c816
+  data.tar.gz: 566d8116f055d33d2215aee961680fe0b6d40180bb017cb9a30ae34b283cd6c4
+SHA512:
+  metadata.gz: 8c510effb9e4655f7225d4b8b22dec05ccd0caa9eb94668ca3d31f371feab7ddd2594b1a2106585e9e915e7fe03b08d8e856183502765d236f73f51a94f2fa77
+  data.tar.gz: 8e798121e6f6c1813e7cbdad45ea1f6bf71893140449eb4599aa200a8117768eb1fa03ef89a1f2400bd9f43c9d45e254c648144ce6e6cfb4d2b3ecefedeeb2ee

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  # TargetRubyVersion: '3.0.1'
+  NewCops: enable
+  Exclude:
+    - 'db/schema.rb'
+    - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    # - lib/loggable_activity/hooks.rb
+Metrics/AbcSize:
+  Exclude:
+    - lib/loggable_activity/encryption.rb
+    - lib/loggable_activity/update_payloads_builder.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.35] - 2024-02-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at max@synthmax.dk. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONSIDERTIONS.md

@@ -0,0 +1,129 @@
+# Considerations, Work in progress.
+This document is stored here and might deleted<br/>
+<br/>
+It should be easy to configure and use the *LoggablActivity* without having to collect and format data all over the system.<br/>
+It should also be possible to delete a data owner and then all data related to that data owner should be inaccessible.  
+
+
+### Protection of data that belongs to a data owner
+One way to protect data in a field is to encrypt it, when requested it can then be decrypted.<br/>
+If the data is required permanently deleted all there is to do is to throw away the key.<br/>
+Another way is to delete the content in all fields for a given data owner on request.<br/>
+
+### Composition of data in a log entry
+Lets consider an example with a user, the user has som personal information directly on the users DB Record.
+The user also has a relation to an address and the user might have a couple relations to other users, friends family members etc.<br/> 
+All this is created from one form and when it is submitted we want to log it. 
+One way of do it is to collect all the data from the DB and pack it into a json payload and submit it to the log, but then we have no control of<br/>
+What data is confidential and who it belongs to. So instead lets make some configurations for how data are handled.
+<br/>*Example*
+```
+┌──────────────────────┐      ┌──────────────────────┐
+│         User         │  ┌──▶│       Address        │
+├──────────────────────┤  │   ├──────────────────────┤
+│name: String          │  │   │street: String        │
+├──────────────────────┤  │   ├──────────────────────┤
+│date_of_birth: Date   │  │   │city: String          │
+├──────────────────────┤  │   └──────────────────────┘
+│address_id: Reference │──┘                           
+├──────────────────────┤                              
+│system_task_uuid: UUID│                              
+└──────────────────────┘                              
+            ┼                                         
+            │                                         
+           ╱│╲                                        
+┌──────────────────────┐                              
+│       Friend         │                              
+├──────────────────────┤                              
+│user_a_id: Reference  │                              
+├──────────────────────┤                              
+│user_b_id: Reference  │                              
+└──────────────────────┘    
+```
+Then a payload could look like this
+```
+
+{
+  user: {
+    name: Sting
+    date_of_birth "October 2, 1951"
+    address: {
+      street: "some street",
+      city: "London"
+    },
+    friend: [
+      user: {
+        name: "Bob"
+        date_of_birth: "September 01, 1991
+      }
+    ]
+  }
+}
+```
+But what about Bob, he is in the system and want to have control of his own data.<br/> 
+To achieve this we need to organize the way we store log entries so owners can be identified even within a payload.
+```
+        ┌────────────────────────┐
+        │        Activity        │
+        ├────────────────────────┤
+        │key: String             │
+        ├────────────────────────┤
+        │who_did_it_type: String │
+        ├────────────────────────┤
+        │who_did_it_id: UUID     │
+        ├────────────────────────┤
+        │time: DateTime          │
+        └────────────────────────┘
+                    ┼            
+                    │            
+                    │            
+                   ╱│╲           
+        ┌────────────────────────┐
+        │        Payload         │
+        ├────────────────────────┤
+        │data: Json              │
+        ├────────────────────────┤
+        │record_id: UUID         │
+        ├────────────────────────┤
+        │record_type: String     │
+        └────────────────────────┘
+```
+So now we can control access to Bobs data in the Logging DB
+
+### example of how a `Loggable::Activity` is formatted for the view 
+```
+activity = Loggable::Activity.lastest.last
+activity.attrs ==>
+
+payloads: [
+  primary: {
+    name: "User",
+    changes: {
+      attrs: {
+        first_name: {
+          from: "Bob",
+          to: "Rob"
+        }
+      }
+    }
+  }
+  relations: [
+    name: "Demo::Address
+    changes: {
+      street: {
+        from: "5th Avenue",
+        to: "Broadway"
+      } 
+    }
+  ]
+]
+
+
+```
+
+
+
+
+
+
+

data/GETTING-STARTED.md

@@ -0,0 +1,80 @@
+# Getting started 
+This document should you getting started with `LoggableActivity`
+
+## Prerequisite
+1 A running Rails Application<br/>
+2 An authorization system where there is a current available.
+
+## Demo Application
+You can download a demo application from<br/>
+[https://github.com/maxgronlund/LoggableActivityDemoApp](https://github.com/maxgronlund/LoggableActivityDemoApp)
+
+## Configuration
+First you have to create a configuration file named `loggable_activity.yml` and locate it in the config folder.<br/>
+It has the following tags
+- record_display_name: <br>
+You CAN define a method on the **User** model called full name, this will be a part of the json payload related to the **User** model
+
+- loggable_attrs:<br/>
+This are the fields in the database you HAS to define
+
+- auto_log:<br/>
+This are the actions that will be logged automatically, although you can log manually at any time.
+Note there is no hook for `Show` in Rails so you would have to log that manually like this `log(:how)`, more about that later.
+
+- relations:<br/>
+If a model has `belongs_to` and `has_one` relations you can log them as well<br>
+<br/>
+*Example confuguration for logging of the user model*
+```
+User: 
+  record_display_name: full_name
+  loggable_attrs: 
+    - first_name
+    - last_name 
+  auto_log:
+    - create
+    - update
+    - destroy
+  relations:
+    - belongs_to: :demo_address
+      model: Demo::Address
+      loggable_attrs:
+        - street
+        - city
+Demo::Address: 
+  record_display_name: full_address
+  actor_display_name: email
+  loggable_attrs:
+    - street
+    - city
+    - country
+    - postal_code
+```
+Then you HAVE TO to add `LogggableActivity::Hooks` to the `User Model` like this
+
+```
+class User < ApplicationRecord
+  include LoggableActivity::Hooks
+  ...
+```
+
+And finally you have to add this to the `ApplicationController`
+```
+class ApplicationController < ActionController::Base
+  include LoggableActivity::CurrentUser
+```
+
+Now when you create a model like this:
+```
+$ rails c
+$ User.create(first_name: 'John', last_name: 'Doe')
+```
+
+Then an `LoggableActivity::Activity` is created. You can inspect it from the terminal like this.
+```
+puts activity = Loggable::Activity.all.latest.first
+puts activity.activity_type
+puts activity.payloads
+puts activity.payload_attrs
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Max Groenlund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Loggable Activity 🌟
+- Keep an activity log of how data in the db are handled.
+- Protect and secure the privacy of data stored in Activity Logs
+- Prepare for General Data Protection Regulation (GDPR) compliance.
+- Handles activities that involves more than one table in the DB.
+
+### What it is not
+- An error logging system
+- A paper trails system with rollback.
+
+### Applications
+Most organizations needs to keep a log of how users interact with data stored in the DB
+- Finance
+- Healthcare
+- Sales
+- Organizations
+
+*Super simplified example from the healthcare.*
+- Each patient has a journal, that is updated on a regular basis.
+- Supervisor needs to follow the journal.
+- Security personnel needs to know how the journal is handled, who did what when.
+- Patients has the right to their journal.
+
+Beside the journal in the db, an activity log is kept so it is possible to track how the journal is used.<br/>
+At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/>
+
+
+👉 Join the Slack channel here: [LoggableActivity Slack Workspace](https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ)
+
+We value each contribution and believe in the power of community. Looking forward to seeing you there!
+
+

data/ROADMAP.md

@@ -0,0 +1,19 @@
+# Roadmap
+Outline of steps to get the LoggableActivity adapted.
+
+### RD project
+Nothing is better than gain som experience by getting som real world tests and experiences
+
+### Open Source
+More eyes and brains on the project wil make it mature and better.
+
+### Investigations
+- Does there exists a protocol for activity logging
+- Will a bigger company like platformatec sponsor the project
+- Legal approval, official, medical approval.
+- RFC for protocol
+- Commercial potentials, business models.
+- Explainers
+- Hosting of example project.
+- Homepage.
+- Documentation

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/loggable_activity/install_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+require 'rails/generators/named_base'
+
+module LoggableActivity
+  module Generators
+    class InstallGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      FILE_NAMES = %w[activity payload encryption_key].freeze
+      TIME = Time.now
+
+      def create_migration
+        time = Time.now.utc
+        FILE_NAMES.each_with_index do |file_name, index|
+          timestamp = (time + index.minutes).strftime('%Y%m%d%H%M%S')
+          migration_file_name = "create_loggable_#{file_name.pluralize}.rb"
+          destination = File.join('db', 'migrate', "#{timestamp}_#{migration_file_name}")
+          template migration_file_name, destination
+        end
+      end
+
+      def create_model_file
+        template 'loggable_activity.en.yml', 'config/locales/loggable_activity.en.yml'
+        template "current_user.rb", 'app/controllers/concerns/loggable_activity/current_user.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateLoggableActivities < ActiveRecord::Migration[6.1]
+  def change
+    create_table :loggable_activities do |t|
+      t.string :action
+      t.references :actor, polymorphic: true, null: true
+      t.string :encrypted_actor_display_name
+      t.string :encrypted_record_display_name
+      t.references :record, polymorphic: true, null: true
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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.string :key
+      t.references :record, polymorphic: true, on_delete: :nullify
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateLoggablePayloads < ActiveRecord::Migration[6.1]
+  def change
+    create_table :loggable_payloads do |t|
+      t.references :record, polymorphic: true, null: true
+      t.json :encrypted_attrs
+      t.integer :payload_type, default: 0
+      t.boolean :data_owner, default: false
+      t.references :activity, foreign_key: { to_table: 'loggable_activities', class_name: 'LoggableActivity::Activity' }
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Stores current user in a thread variable so that is can be accessed from the 'models/conserns/loggable/activities.rb' file.
+module LoggableActivity
+  module CurrentUser
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_current_user
+      after_action :clear_current_user
+    end
+
+    private
+
+    def set_current_user
+      # return if request.path == "/users/sign_out"
+      return unless current_user
+
+      Thread.current[:current_user] = current_user
+    end
+
+    def clear_current_user
+      Thread.current[:current_user] = nil
+    end
+  end
+end

data/lib/generators/loggable_activity/templates/loggable_activity.en.yml

@@ -0,0 +1,36 @@
+en:
+  loggable:
+    activity:
+      deleted: "***** DELETED *****"
+      demo/address:
+        update: An address was updated
+        create: An address was created
+        show: An address was shown
+        destroy: An address was deleted
+      demo/club:
+        update: A club was updated
+        create: A club was created
+        show: A club was shown
+        destroy: A club was deleted
+      demo/journal:
+        update: A journal was updated
+        create: A journal was created
+        show: A journal was shown
+        destroy: A journal was deleted
+      demo/product:
+        update: A product was updated
+        create: A product was created
+        show: A product was shown
+        destroy: A product was deleted
+      user:
+        update: A user was updated
+        create: A user was created
+        show: "A user was shown"
+        destroy: A user was deleted
+      models:
+        Demo::Address: Address
+        Demo::UserProfile: Profile
+        Demo::Club: Club
+        Demo::Journal: Journal
+        Demo/Product: Product
+        User: User