rails-gdpr-export 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7c5a2c6c437886d8ba018efc65665bc7ab380df9b35008ec6363f4f300f803
-  data.tar.gz: d21fe4cc0b9601fda5577783c801182ec5d6f86a91c53790fecfeca21e5a9cc1
+  metadata.gz: d7e1487f84e939c9a7f248b70048d67246411119b2cca9fff7ead592c5ad12d1
+  data.tar.gz: c816136d3d5b279b9eef06b2143a6828c43f13a63c47b8e1f1cd6517d8544e32
 SHA512:
-  metadata.gz: 8d29e71898e8a438dda05641a8ebeaa151ce0b47855155404847270c3e373585a696e609bf949529752e42ceb6fd9ba825fd52cb7e84d6c6dc8667d4f790b3ea
-  data.tar.gz: 888a99343f67590dc13caba81f3006efdea18f582456db44abcf1e33859600b4035eec51970d3f265a10ef662e913eefdfa144dd4c580bada643691c09667f4e
+  metadata.gz: 5e53185e5aa0345dcfb9d81e711e36745c488e52f32e0622107a90b73ea7b792b455f839bba674655dd321bebae21613537247eff7bec5d62633ed6676201321
+  data.tar.gz: 2245352470f640050e5acdcde427a3d309af53f4087b4c4eefd5a46eb936c2cd95ada734839967161d2d817bdc9cdc397ca607c9d3f36468a4ce618a26db7b02

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-gdpr-export (2.0.2)
+    rails-gdpr-export (2.0.3)
 
 GEM
   remote: https://rubygems.org/
@@ -32,4 +32,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.16.5

data/README.md

@@ -24,47 +24,55 @@ This gem allows you to specify fields that you want to retrieve from your models
 
 ### Initialization
 
-To initialize the gem usage, loads the GdprExporter module into activerecord classes. Do this at initialization time through an initializer. E.g. create a initializers/gdpr.rb file and add the following:
-
-```ruby
-ActiveRecord::Base.send :include, GdprExporter
-```
+First start by importing `gdpr_exporter` into your application, i.e., add `require "gdpr_exporter"` to your `Application.rb` file.
 
 ### Data collection
 
-In order to specify the fields you want to return to the user you need to call `gdpr_collect`.
+In order to specify the fields you want to collect you need to call `gdpr_collect`.
 The call target is a rails model and its arguments are:
 * a set of simple fields, i.e. fields that will be output as is,
 * followed by a hash of params:
+
 ```ruby
- {user_id:        <the field in the model used as alias for the user_id field>
-  renamed_fields: {<field_from_db> => <field_name_in_output>}
-  table_name:     <the new table name in output>
-  description:    <a comment>
-  joins:           [<an array of associations>]}
+ { user_id:        <the field in the model used as alias for the user_id field>
+   renamed_fields: { <field_from_db> => <field_name_in_output> }
+   table_name:     <the new table name in output>
+   description:    <a comment>
+   joins:          [<an array of associations>] }
 ```
+
 When `joins` is specified, the fields of an association should be defined as `<association_name> <field_name>`.
 
+For `user_id`, you can also use a string with a chain of associations. For instance, if my model is indirectly linked to user through an `belongs_to: :account` association, you can specify `user_id: "account user_id"`. Currently, the gem support only to levels of nested associations.
+
 #### Example
 
+Suppose you have a `User` model, then in its class you should `include Gdprexporter` and call `gdpr_collect`.
+And you should do something similar for all other models you are interested in in your application.
+
 ```ruby
-User.gdpr_collect :email, :last_sign_in_at, :type, :forward_mailbox,
-                  "program title",
-                  {user_id: :id,
-                   renamed_fields: {sign_in_count: "sign in count",
-                                    current_sign_in_at: "time of current sign in",
-                                    chosen_program_id: "chosen program",
-                                    current_sign_in_ip: "current IP address",
-                                    last_sign_in_ip: "previously used IP address"},
-                   joins:          [:program]}
+class User
+    include GdprExporter
+
+    gdpr_collect :email, :last_sign_in_at, :type, :forward_mailbox,
+        "program title",
+        { user_id: :id,
+          renamed_fields: { sign_in_count: "sign in count",
+                            current_sign_in_at: "time of current sign in",
+                            chosen_program_id: "chosen program",
+                            current_sign_in_ip: "current IP address",
+                            last_sign_in_ip: "previously used IP address" },
+          joins:          [:program] }
+end
 ```
 
-From your `User` model, you want to retrieve the values of the fields `email, last_sign_in_at,
+Here from your `User` model, you want to retrieve the values of the fields `email, last_sign_in_at,
 type, forward_mailbox`, in addition to the fields `sign_in_count, current_sign_in_at, chosen_program_id, current_sign_in_ip, last_sign_in_ip`. However for the latter you want their csv header to be renamed. And the field representing the user in the `User` model is `id`.
-`User` has also an association with `program` and you want to value of its field `title`.
+`User` has also an association with `program` and you want to value of its field `title` (hence the presence of `"program title"` in the list of fields).
 
 ### Data export
-Finally, call `GdprExporter.export(<user_id>)` to return a csv formatted output of all the fields you specified previously.
+
+Finally, call `GdprExporter.export(<user_id>)` (from a controller in your application) to return a csv formatted output of all the fields you specified previously.
 
 
 ## Contributing

data/lib/gdpr_exporter.rb

@@ -91,7 +91,19 @@ module GdprExporter
       # Adds the class method 'gdpr_query' to the eigenclass.
       # It will execute the query.
       self.define_singleton_method(:gdpr_query) do |_user_id|
-        result = self.where(user_id_field => _user_id)
+        decomposed_user_id_field = user_id_field.to_s.split(" ")
+        result = case
+                 when decomposed_user_id_field.size == 3
+                   self
+                     .includes(decomposed_user_id_field.first.to_sym => decomposed_user_id_field.second.to_sym)
+                     .where(decomposed_user_id_field.second.pluralize.to_sym => { decomposed_user_id_field.last.to_sym => _user_id })
+                 when decomposed_user_id_field.size == 2
+                   self
+                     .includes(decomposed_user_id_field.first.to_sym)
+                     .where(decomposed_user_id_field.first.pluralize.to_sym => { decomposed_user_id_field.last.to_sym => _user_id })
+                 else
+                   self.where(user_id_field => _user_id)
+                 end
 
         # When there are multiple joins defined, just keep calling 'joins'
         # for each association.

data/lib/gdpr_exporter/version.rb

@@ -1,5 +1,5 @@
 module Exts
   module Gdpr
-    VERSION = "2.0.2"
+    VERSION = "2.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-gdpr-export
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Chrislain Razafimahefa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A rails gem to export personal data in compliance with GDPR.