rails-gdpr-export 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0db6f0772529c9ff00bc550f978c2a1130e3a0c26bee3ed7ae885d2edb03ac4
-  data.tar.gz: 7e759a11d04018a00cb3873560ecda0a93999e60a1fcaa1113bfd04b2a5c3ba3
+  metadata.gz: ad4eb505cc305ad42540e9e9ab33929f59a150efba6b9d06563dc6c740136b45
+  data.tar.gz: fb96f6b4c657d858cddf8ec3e9e79eb197f61b4a6962de4f5a9912093395540d
 SHA512:
-  metadata.gz: e09269397d19fd581611e99566fd6e3e6e37bef7c9c1a0e3c5c706151913a0c3d37bea7a27e655acc7f37d0dc1bbcc5762453a441b5c3653c867b5b425205b21
-  data.tar.gz: 87f8158262f3a001f0dbb5fc5fb16c71278a19bff6226f89a16fd5704e0c4fd408055d8bfc6d6db6c6a90c8e9fcf484d1fa2d8838eab5cbcf727322bd39c085b
+  metadata.gz: 2252ca7bd625c33236d582a49444dd5e8a2362632a3c94f5fdc2dd67482f32092a2a5726d3139f5700cfc8cd27d718001d0bb9035139af6b1e93f6309d89efce
+  data.tar.gz: a31b4ed3fdfff06f7fbc0a99b69054b6024bda5a679c90711b1ec8d3c745f54f2446f86716fc152d4d0ad80a51c54228dd1dbb56a1f496f0a2bdf670fcd77118

data/Gemfile.lock

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

data/README.md

@@ -41,23 +41,27 @@ The call target is a rails model and its arguments are:
   renamed_fields: {<field_from_db> => <field_name_in_output>}
   table_name:     <the new table name in output>
   description:    <a comment>
-  join:           <an association>}
+  joins:           [<an array of associations>]}
 ```
+When `joins` is specified, the fields of an association should be defined as `<association_name> <field_name>`.
 
 #### Example
 
 ```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"}}
+                                    last_sign_in_ip: "previously used IP address"},
+                   joins:          [:program]}
 ```
 
 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`.
 
 ### Data export
 Finally, call `GdprExporter.export(<user_id>)` to return a csv formatted output of all the fields you specified previously.

data/lib/gdpr_exporter.rb

@@ -18,7 +18,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)
@@ -91,12 +91,17 @@ 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)
+        result = self.where(user_id_field => _user_id)
+
+        # 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 +110,26 @@ 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) }
+            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.0"
   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.0
 platform: ruby
 authors:
 - Chrislain Razafimahefa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 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: []