gdpr_admin 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b019a3a76e13bb0a29a264a2f14aa9979c8a4cf2ef3163014f72f727856d07ca
-  data.tar.gz: 735b7ac163d0b9a7579f0bb9c26bde48ca2dc5e00996175a31aaa597dae94597
+  metadata.gz: 9b5cc14d1e0f88e99bec3ccd100795cc1985ef86fa559fbdd2639bdd5bef1ee4
+  data.tar.gz: 5c07836dec53a6265e3fcd6516f910a22b6834234bea5f39890030ba394d0e5c
 SHA512:
-  metadata.gz: 14e0c4a02403085c3c1fd5f7b29625f0b8194ab41a374e0f58213aa59f27e5b7e8a4d9477cbb53975fcd331af9d20516cfd3a37ffa6cc6007579ddd72bbba5a7
-  data.tar.gz: 63d3e8710805b8f339da69a4e93deb501d6bc7734eb21f542c3ca15683114e6c8b57e73d762a2e77294c9b3522e3eb35e5aa79d960a9bf5d6c6ce68081124c4e
+  metadata.gz: f4552232540bf1153c32e15ccc1ec0ed5f5a399649bd5618ded36476881124d2496a1f345deec8f5baf98ecba1ff4e0161743ca905abae45761024d9c68432e0
+  data.tar.gz: 8169ff0b5040484ceac0084601246d19d875e222509ec2f1a2dab055822d79db13b999c6a96468167cf39adfe5cc26b0aff60b9c046bbcc31422177e2ca66684

data/README.md

@@ -6,12 +6,17 @@
 
 [![Build Status](https://github.com/Colex/gdpr_admin/actions/workflows/build.yml/badge.svg)](https://github.com/Colex/gdpr_admin/actions/workflows/build.yml)
 [![Code Climate](https://codeclimate.com/github/Colex/gdpr_admin.svg)](https://codeclimate.com/github/Colex/gdpr_admin)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/00740133ef1f97181ed6/test_coverage)](https://codeclimate.com/github/Colex/gdpr_admin/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/gdpr_admin.svg)](http://badge.fury.io/rb/gdpr_admin)
 
 Rails engine for processing GDPR processes. GDPR Admin offers a simple interface for defining strategies for automating the process of data access and data removal as required by data privacy regulations like GDPR.
 
 GDPR Admin uses simple Ruby classes, so you're free to code your Data Policies as you see fit. A swiss knife of
-helper methods are available to make the processes even simpler.
+helper methods are available to make the processes even simpler. The focus of the gem is to easily implement:
+
+- [Right of access](https://ico.org.uk/for-organisations/guide-to-data-protection/guide-to-the-general-data-protection-regulation-gdpr/individual-rights/right-of-access/): export a subject's data on request;
+- [Right to erasure](https://ico.org.uk/for-organisations/guide-to-data-protection/guide-to-the-general-data-protection-regulation-gdpr/individual-rights/right-to-erasure/): remove a subject's personal data on request;
+- [Storage limitation](https://ico.org.uk/for-organisations/guide-to-data-protection/guide-to-the-general-data-protection-regulation-gdpr/principles/storage-limitation/): hold data for as long as required (data retention policies and offboarding tenants);
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -67,6 +72,26 @@ GdprAdmin::Request.create!(
 
 Creating a request will automatically enqueue the request to be processed in 4 hours - this gives time to cancel an accidental request. You can configure this grace period as desired.
 
+### Scope Helpers
+Helpers to be used within the `#scope` method.
+
+#### `scope_by_date`
+
+```ruby
+scope_by_date(scope, field = :updated_at)
+```
+
+Automatically scopes the data using the `updated_at` column to match the GDPR Request. You can use a different column by providing
+a second argument.
+
+```ruby
+class ContactDataPolicy < GdprAdmin::ApplicationDataPolicy
+  def scope
+    scope_by_date(Contact)
+  end
+end
+```
+
 ### Anonymization Helpers
 A set of helper methods are available to make the anonymization even simpler. These are not mandatory, but can help you
 keep your code cleaner and, better, write less code.
@@ -155,9 +180,9 @@ You can define a repeating job with `sidekiq-cron`:
 
 ```ruby
 Sidekiq::Cron::Job.create(
-  class: SyncOrganizationsContactsJob.to_s,
+  class: 'GdprAdmin::DataRetentionPoliciesRunnerJob',
   cron: '0 2 * * *',
-  name: 'Sync Organization Contacts',
+  name: 'Run Data Retention Policies',
   queue: 'cron',
   active_job: true,
 )

data/lib/gdpr_admin/application_data_policy.rb

@@ -3,6 +3,7 @@
 module GdprAdmin
   class ApplicationDataPolicy
     include Helpers::EraseHelper
+    include Helpers::ScopeHelper
 
     def initialize(request)
       @request = request

data/lib/gdpr_admin/helpers/scope_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GdprAdmin
+  module Helpers
+    module ScopeHelper
+      def scope_by_date(scope, field = :updated_at)
+        scope.where(field => ...request.data_older_than)
+      end
+    end
+  end
+end

data/lib/gdpr_admin/version.rb

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

data/lib/gdpr_admin.rb

@@ -7,6 +7,7 @@ require 'gdpr_admin/error'
 require 'gdpr_admin/invalid_status_error'
 require 'gdpr_admin/skip_data_policy_error'
 require 'gdpr_admin/helpers/erase_helper'
+require 'gdpr_admin/helpers/scope_helper'
 require 'gdpr_admin/application_data_policy'
 require 'gdpr_admin/paper_trail/version_data_policy'
 require 'gdpr_admin/tenant_adapters/acts_as_tenant_adapter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdpr_admin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Colex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,6 +168,7 @@ files:
 - lib/gdpr_admin/helpers/erase_helper.rb
 - lib/gdpr_admin/helpers/field_anonymizer_helper.rb
 - lib/gdpr_admin/helpers/paper_trail_helper.rb
+- lib/gdpr_admin/helpers/scope_helper.rb
 - lib/gdpr_admin/invalid_status_error.rb
 - lib/gdpr_admin/paper_trail/version_data_policy.rb
 - lib/gdpr_admin/skip_data_policy_error.rb