gdpr_admin 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b5cc14d1e0f88e99bec3ccd100795cc1985ef86fa559fbdd2639bdd5bef1ee4
-  data.tar.gz: 5c07836dec53a6265e3fcd6516f910a22b6834234bea5f39890030ba394d0e5c
+  metadata.gz: 9b1d58ff60fa19dc3b0a1fb067ae2ed0dfc96e8798257989534a39e8600ef878
+  data.tar.gz: b199dc1a90a1fab64a6b98bcde51dc656a8943f12381dcdbc275e51147997c92
 SHA512:
-  metadata.gz: f4552232540bf1153c32e15ccc1ec0ed5f5a399649bd5618ded36476881124d2496a1f345deec8f5baf98ecba1ff4e0161743ca905abae45761024d9c68432e0
-  data.tar.gz: 8169ff0b5040484ceac0084601246d19d875e222509ec2f1a2dab055822d79db13b999c6a96468167cf39adfe5cc26b0aff60b9c046bbcc31422177e2ca66684
+  metadata.gz: b7813fc861f53e6d280369e403e9ece16484dfc433e2005b6c6eac739f91694d06169fcf0b60a3b1d1e32f65dcc45a44a8dee5446e89a35b90391070a42c0c96
+  data.tar.gz: 02a363b0a84f217aceeb3e19e2d0f53b09d7f5030e3dbf16abae8c92a8dc52cca9138c3fca55b6ce1014f639a915914e910c45e7538d5f24ecf79c005a3abb14

data/README.md

@@ -35,6 +35,11 @@ Or install it yourself as:
 $ gem install gdpr_admin
 ```
 
+Then install the migrations:
+```bash
+$ rails gdpr_admin:install:migrations
+```
+
 ## Usage
 
 Create your data policies file within `app/gdpr` _(configurable)_ and inherit from `GdprAdmin::ApplicationDataPolicy`.
@@ -138,6 +143,41 @@ same anonymized value. _(note: different values may also yield the same value)_
 
 To use the built-in anonymizer functions, you need to install the gem `faker`.
 
+## Data Policy Hooks
+For advanced use cases, you may install hooks that are run at different stages of the data policy process.
+
+### `before_process`
+Will be run before the policy is executed. Calling `skip_data_policy!` will raise `GdprAdmin::SkipDataPolicyError` and
+stop the execution of the data policy.
+
+```ruby
+class ContactDataPolicy < GdprAdmin::ApplicationDataPolicy
+  before_process :skip_internal_contacts!
+
+  private
+
+  def skip_internal_contacts!
+    skip_data_policy! if contact.email =~ /.*@company\.com/
+  end
+end
+```
+
+### `before_process_record`
+Called before processing a record (either erasing or exporting). Calling `skip_record!` will raise `GdprAdmin::SkipRecordError` and
+skip processing that particular record.
+
+```ruby
+class UserDataPolicy < GdprAdmin::ApplicationDataPolicy
+  before_process :skip_super_admins!
+
+  private
+
+  def skip_super_admins!(user)
+    skip_record! if user.role == 'super_admin'
+  end
+end
+```
+
 ## GDPR Request
 A GDPR Request (`GdprAdmin::Request`) represents a request to remove a subject's data, tenant's data, or export subject data.
 

data/app/models/gdpr_admin/request.rb

@@ -35,7 +35,7 @@ module GdprAdmin
       GdprAdmin.load_data_policies
       with_lock { processing! }
       with_lock do
-        GdprAdmin.config.tenant_adapter.with_tenant(tenant) { process_policies }
+        process_policies
         completed!
       end
     rescue StandardError
@@ -63,13 +63,7 @@ module GdprAdmin
 
     def process_policies
       ApplicationDataPolicy.descendants.each do |policy_class|
-        policy = policy_class.new(self)
-        policy.scope.find_each do |record|
-          policy.export(record) if export?
-          policy.erase(record) if erase?
-        end
-      rescue SkipDataPolicyError
-        next
+        policy_class.process(self)
       end
     end
 

data/lib/gdpr_admin/application_data_policy.rb

@@ -2,15 +2,34 @@
 
 module GdprAdmin
   class ApplicationDataPolicy
+    include Helpers::DataPolicyHelper
     include Helpers::EraseHelper
     include Helpers::ScopeHelper
 
+    class << self
+      attr_reader :before_process_hooks, :before_process_record_hooks
+
+      def before_process(method)
+        @before_process_hooks ||= []
+        @before_process_hooks << method
+      end
+
+      def before_process_record(method)
+        @before_process_record_hooks ||= []
+        @before_process_record_hooks << method
+      end
+
+      def process(request)
+        new(request).process
+      end
+    end
+
     def initialize(request)
       @request = request
     end
 
     def scope
-      raise SkipDataPolicyError
+      skip_data_policy!
     end
 
     def export(_record)
@@ -21,8 +40,49 @@ module GdprAdmin
       raise NotImplementedError
     end
 
+    def process
+      GdprAdmin.config.tenant_adapter.with_tenant(request.tenant) do
+        run_preprocessors
+        scope.find_each do |record|
+          process_record(record)
+        end
+      rescue SkipDataPolicyError
+        nil
+      end
+    end
+
     protected
 
     attr_reader :request
+
+    def process_record(record)
+      run_record_preprocessors(record)
+      export(record) if request.export?
+      erase(record) if request.erase?
+    rescue SkipRecordError
+      nil
+    end
+
+    def run_preprocessors
+      before_process_hooks = self.class.before_process_hooks || []
+      before_process_hooks.each do |hook|
+        call_hook(hook)
+      end
+    end
+
+    def run_record_preprocessors(record)
+      before_process_record_hooks = self.class.before_process_record_hooks || []
+      before_process_record_hooks.each do |hook|
+        call_hook(hook, record)
+      end
+    end
+
+    def call_hook(hook, value = nil)
+      hook = method(hook) unless hook.respond_to?(:call)
+
+      arity = hook.arity
+      args = [value].take(arity).reverse
+      instance_exec(*args, &hook)
+    end
   end
 end

data/lib/gdpr_admin/helpers/data_policy_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GdprAdmin
+  module Helpers
+    module DataPolicyHelper
+      def skip_data_policy!
+        raise SkipDataPolicyError
+      end
+
+      def skip_record!
+        raise SkipRecordError
+      end
+    end
+  end
+end

data/lib/gdpr_admin/paper_trail/version_data_policy.rb

@@ -9,13 +9,7 @@ module GdprAdmin
 
       def erase(version, item_fields = nil)
         item_fields ||= infer_item_fields(version)
-        return if item_fields.nil?
-
-        base_changes = {
-          object: anonymize_version_object(version, item_fields),
-          object_changes: anonymize_version_object_changes(version, item_fields),
-        }.compact
-        erase_fields(version, fields, base_changes)
+        erase_fields(version, fields, base_changes(version, item_fields))
       end
 
       def fields
@@ -24,6 +18,15 @@ module GdprAdmin
 
       private
 
+      def base_changes(version, item_fields)
+        return {} if item_fields.blank?
+
+        {
+          object: anonymize_version_object(version, item_fields),
+          object_changes: anonymize_version_object_changes(version, item_fields),
+        }.compact
+      end
+
       def infer_item_fields(version)
         infer_data_policy_class(version)&.new(request)&.try(:fields)
       end

data/lib/gdpr_admin/skip_record_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GdprAdmin
+  class SkipRecordError < StandardError; end
+end

data/lib/gdpr_admin/version.rb

@@ -2,6 +2,6 @@
 
 # :nocov:
 module GdprAdmin
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end
 # :nocov:

data/lib/gdpr_admin.rb

@@ -6,6 +6,8 @@ require 'gdpr_admin/configuration'
 require 'gdpr_admin/error'
 require 'gdpr_admin/invalid_status_error'
 require 'gdpr_admin/skip_data_policy_error'
+require 'gdpr_admin/skip_record_error'
+require 'gdpr_admin/helpers/data_policy_helper'
 require 'gdpr_admin/helpers/erase_helper'
 require 'gdpr_admin/helpers/scope_helper'
 require 'gdpr_admin/application_data_policy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdpr_admin
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Colex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -165,6 +165,7 @@ files:
 - lib/gdpr_admin/configuration.rb
 - lib/gdpr_admin/engine.rb
 - lib/gdpr_admin/error.rb
+- lib/gdpr_admin/helpers/data_policy_helper.rb
 - lib/gdpr_admin/helpers/erase_helper.rb
 - lib/gdpr_admin/helpers/field_anonymizer_helper.rb
 - lib/gdpr_admin/helpers/paper_trail_helper.rb
@@ -172,6 +173,7 @@ files:
 - lib/gdpr_admin/invalid_status_error.rb
 - lib/gdpr_admin/paper_trail/version_data_policy.rb
 - lib/gdpr_admin/skip_data_policy_error.rb
+- lib/gdpr_admin/skip_record_error.rb
 - lib/gdpr_admin/tenant_adapters/acts_as_tenant_adapter.rb
 - lib/gdpr_admin/version.rb
 - lib/tasks/gdpr_admin_tasks.rake