rails-gdpr-export 1.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0db6f0772529c9ff00bc550f978c2a1130e3a0c26bee3ed7ae885d2edb03ac4
-  data.tar.gz: 7e759a11d04018a00cb3873560ecda0a93999e60a1fcaa1113bfd04b2a5c3ba3
+  metadata.gz: 515a04ae4fb4dd29c34348f8bd828d42d7c3513b508d6b5b1ad8838345486a72
+  data.tar.gz: 74f1a74077474a84843b4e20aa4d4740b3ea7c88b339dca8e47b62c7dc75cb11
 SHA512:
-  metadata.gz: e09269397d19fd581611e99566fd6e3e6e37bef7c9c1a0e3c5c706151913a0c3d37bea7a27e655acc7f37d0dc1bbcc5762453a441b5c3653c867b5b425205b21
-  data.tar.gz: 87f8158262f3a001f0dbb5fc5fb16c71278a19bff6226f89a16fd5704e0c4fd408055d8bfc6d6db6c6a90c8e9fcf484d1fa2d8838eab5cbcf727322bd39c085b
+  metadata.gz: 10783ce78e34b5133a026578e1df08446f1b33d65f3c9f67ce878e6b904c340dcde63ede49deee486771b092acc7d122d15f198171ed2758cec3c0a3fc78ee22
+  data.tar.gz: d8eb588eeb5c2e9b0ace0a79b1a2eb970a6d8cbc8a0d4acd6cd3a8b2e9f8a5d751df32670aa373b01a1a7a17e2dd061495cb42381661f87b25c98b6900a354c9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-gdpr-export (1.0.2)
+    rails-gdpr-export (2.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,43 +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>
-  join:           <an association>}
+ { 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,
-                  {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"}}
+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` (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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require "gdpr_exporter/version"
-require 'csv'
+require "csv"
+require "set"
 
 module GdprExporter
     # Stores all the classes that have been tagged for gdpr collection
-  @@klasses = []
+  @@klasses = Set[]
 
   def self.get_klasses
     @@klasses
@@ -18,7 +19,7 @@ module GdprExporter
   # Collects data through all the tagged models and generates a csv
   # formatted output
   def self.export(user_id)
-    CSV.generate do |csv|
+    CSV.generate(force_quotes: true) do |csv|
       get_klasses.each do |klass|
         rows = klass.gdpr_query(user_id)
         klass.gdpr_export(rows, csv)
@@ -57,11 +58,11 @@ module GdprExporter
       end
 
       unless hash_params.class == Hash
-        raise "Gdpr fields collection error: last argument must be a hash!"
+        raise ArgumentError.new("Gdpr fields collection error: last argument must be a hash!")
       end
 
       unless hash_params.key?(:user_id)
-        raise "Gdpr fields collection error: the field aliasing user_id is not declared for '#{self}'!"
+        raise ArgumentError.new("Gdpr fields collection error: the field aliasing user_id is not declared for '#{self}'!")
       end
 
       # Adds the eigen class to the set of classes eligible for gdpr data collection.
@@ -91,12 +92,29 @@ 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|
-        if hash_params[:join]
-          self.select(query_fields).where(user_id_field => _user_id).
-            joins(hash_params[:join])
-        else
-          self.select(query_fields).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.
+        if hash_params[:joins]
+          result = hash_params[:joins].inject(result) do | query, assoc |
+            query.send(:joins, assoc)
+          end
         end
+
+        result
       end
 
       # Adds a method to export to csv to the eigenclass.
@@ -105,11 +123,28 @@ module GdprExporter
 
         csv << (hash_params[:table_name] ? [hash_params[:table_name]] :
                   [self.to_s])
+
+        if hash_params[:desc]
+          csv << ['Description:', hash_params[:desc]]
+        end
+
         csv << csv_headers
         rows.each do |r|
-          csv << query_fields.map{ |f| r.send(f) }
+          csv << query_fields.map do |f|
+            f_splitted = f.to_s.split(' ')
+            if (f_splitted.size == 2)
+              # field f is coming from an assoc, i.e. field has been defined
+              # as "<tablename> <field>" in gdpr_collect then to get its value
+              # do r.<tablename>.<field>
+              f_splitted.inject(r) { |result, method| result.send(method) }
+            elsif (f_splitted.size > 2)
+              raise ArgumentError.new("Field #{f} is made of more than 2 words!?")
+            else
+              # No association involved, simply retrieve the field value.
+              r.send(f)
+            end
+          end
         end
-        csv << ['Comment:', hash_params[:desc]] if hash_params[:desc]
         csv << []
       end
     end

data/lib/gdpr_exporter/version.rb

@@ -1,5 +1,5 @@
 module Exts
   module Gdpr
-    VERSION = "1.0.2"
+    VERSION = "2.0.4"
   end
 end

data/rails-gdpr-export.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chrislain Razafimahefa"]
   spec.email         = ["razafima@gmail.com"]
 
-  spec.summary       = %q{A gem to export personal data in compliance with GDPR.}
+  spec.summary       = %q{A rails gem to export personal data in compliance with GDPR.}
   spec.homepage      = "https://github.com/epfl-exts/rails-gdpr-export"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-gdpr-export
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Chrislain Razafimahefa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: A gem to export personal data in compliance with GDPR.
+summary: A rails gem to export personal data in compliance with GDPR.
 test_files: []