loggable_activity 0.1.38b → 0.1.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a53175944ae66c68b08cbf7428105a6f73fc0160f7680f556be20113dc2451e
-  data.tar.gz: dbf2b2d5052f0849b726315da160fb4eeafe496ddbcfd99bbc515b8198bf3df8
+  metadata.gz: 911d7c56855fc43463aed3ce4e1347a148566b5b892da0edac0f7c73fe4bac53
+  data.tar.gz: ac53eb01110f9e2d36e5c2c17fcbf4f54f7f3255364180edf5f55fc93a3829c7
 SHA512:
-  metadata.gz: 65cb36b2ebb17b01d95cd8b5fe13aaff456b524f11671e8e5191bb4e101e09d2170dab5682218e179a9db1df241e24d8830788f49cc5d0a1d25d51842beeb5ac
-  data.tar.gz: 9c2f41c649aeaa812ad58bbecfd584de56bcbe37398359129323055cebeae9c64a16798bd89688d26c3a0392d02fb89539b0ed9c8eca9a5c4a8e684fbb5f6b75
+  metadata.gz: 4919f94678c3d182c30c1ba22cbee0ca98c77b0caeb90f5dc126ec51ade2be51ccc28e8f75bd83a1fb396779692706d2f8c9c9466736d1493e17daf0278de2a7
+  data.tar.gz: c70e5e713082f1650598c88ca11ab9002c21324d6e801eb34f044f20b9a133058376b6563d3acb9dc27c64bb1c304d16c9ec73bf69c820efe6860c877d401de8

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 - nothing so far
+## [0.1.39] - 2024-02-12
+- Updated README.md and GETTING-STARTED.md 
 ## [0.1.38] - 2024-02-12
 - Removed dependency on awesome print
 ## [0.1.35] - 2024-02-11

data/GETTING-STARTED.md

@@ -3,7 +3,7 @@ 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.
+2 An authorization system where there is a current user available.
 
 ## Demo Application
 You can download a demo application from<br/>
@@ -12,18 +12,20 @@ You can download a demo application from<br/>
 ## 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
+- `User` (example)<br>
+This is the name of the model you are configuring, as you can see there is alos a `Demo::Address` in the configuration file below, So if you have a model named `Demo::Club` you have to create at tag for that and fill in the other tags under that.
 - 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
+Used to display something human to identify a given log entry, in this example the  **User** model has a method named `full_name`
 
 - loggable_attrs:<br/>
-This are the fields in the database you HAS to define
+This are the attributes on a model and reflect the fields in  the database you HAS to define, what fields to log.
 
 - 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.
+Note there is no hook for `Show` in Rails so you would have to log that manually like this `log(:show)`, more about that later.
 
 - relations:<br/>
-If a model has `belongs_to` and `has_one` relations you can log them as well<br>
+If a model has `belongs_to` and `has_one` relations you can log them automatically as well<br>
 <br/>
 *Example confuguration for logging of the user model*
 ```
@@ -65,7 +67,7 @@ class ApplicationController < ActionController::Base
   include LoggableActivity::CurrentUser
 ```
 
-Now when you create a model like this:
+Now if you create a model like this:
 ```
 $ rails c
 $ User.create(first_name: 'John', last_name: 'Doe')
@@ -73,8 +75,6 @@ $ 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
+puts activity = Loggable::Activity.last
+puts activity.attrs
 ```

data/README.md

@@ -1,4 +1,5 @@
 # Loggable Activity 🌟
+Secure protect data and log how it is handled
 - 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.
@@ -7,26 +8,28 @@
 ### What it is not
 - An error logging system
 - A paper trails system with rollback.
+- A backup system
 
 ### Applications
 Most organizations needs to keep a log of how users interact with data stored in the DB
 - Finance
 - Healthcare
-- Sales
-- Organizations
+- Sales and Support
 
 *Super simplified example from the healthcare.*
 - Each patient has a journal, that is updated on a regular basis.
-- Supervisor needs to follow the journal.
+- Supervisor needs to follow the journal, how was it updated, who read it.
 - Security personnel needs to know how the journal is handled, who did what when.
-- Patients has the right to their journal.
+- Patients has the right to know how their journal is handled and that the log is deleted.
 
 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)
-
+<br/>
+👉 Want to play around with an online version: [Show Demo](https://loggableactivity-efe7b931c886.herokuapp.com/)
+<br/>
 We value each contribution and believe in the power of community. Looking forward to seeing you there!
 
 

data/ROADMAP.md

@@ -1,8 +1,11 @@
 # 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
+### 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
+
 
 ### Open Source
 More eyes and brains on the project wil make it mature and better.
@@ -14,6 +17,7 @@ More eyes and brains on the project wil make it mature and better.
 - RFC for protocol
 - Commercial potentials, business models.
 - Explainers
-- Hosting of example project.
-- Homepage.
-- Documentation
+- Documentation RDoc
+- Rest API 
+- GraphQL API
+- Integration with other languages, node, elixir...

data/lib/loggable_activity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.38b'
+  VERSION = '0.1.39'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.38b
+  version: 0.1.39
 platform: ruby
 authors:
 - "Max \nGroenlund"
@@ -75,11 +75,11 @@ files:
 - loggable_activity-0.1.34.gem
 - pkg/loggable_activity-0.1.35.gem
 - sig/loggable_activity.rbs
-homepage: https://github.com/maxgronlund/LoggableActivity/
+homepage: https://loggableactivity-efe7b931c886.herokuapp.com/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/maxgronlund/LoggableActivity/
+  homepage_uri: https://loggableactivity-efe7b931c886.herokuapp.com/
   source_code_uri: https://github.com/maxgronlund/LoggableActivity
   changelog_uri: https://github.com/maxgronlund/LoggableActivity/CHANGELOG.md
   rubygems_mfa_required: 'true'