rails-gdpr-export 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7071e26a9662f67d80d9c59a8ee5dcb3d896682b63094b8fd37c288f73ebb052
-  data.tar.gz: 0f10a671e075a4fc691b88a99d905434e93ce189b81adc90a7e89a59fac5c1c0
+  metadata.gz: 7dab6bb312d7424d72e84050f79b87ca1fd01a1c68ff14deb3210a33c8c6df7b
+  data.tar.gz: 3d6f9cfc9fc7751d138c332d6e85bccdcb48d80530ee621982f9dc0cd69d3837
 SHA512:
-  metadata.gz: 96fa84ddc1af458eb2e6a545644159c5fae81667cbc032182b70ac6f8fc99d6071f996be7cf3a1f9ad67086e12254849e2c2eb8324d8a54ee15e631d01696cda
-  data.tar.gz: efb60c1bf1fc6e1503d856b5e57ef591d6c9f7e52a1f169a861395469ebcc53ec0c1b171cb0c0498bdc132a7536e5ffe22b90317f99abd271640db3550b15e06
+  metadata.gz: 6c255cfee87d8e55b73e0be2e2ac9150461c9d8e122148e78660945503f6ff914ae48e0a93ad76453852e536b431dc083ead653d669088da5a4560fd24d89a95
+  data.tar.gz: 6cb1209cce21e957771ca83467eb32e016bd1144149c8fe4f21cdc65a8bbccf02e266a6a608a6c3870c71267966f6a40690be06813ef26e72221fe6b4343b9a5

data/Gemfile.lock

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

data/README.md

@@ -32,20 +32,22 @@ ActiveRecord::Base.send :include, GdprExporter
 
 ### Data collection
 
-In order to specify the fields that you want to return to the user you need to call `ruby gdpr_collect`.
-The call target is a rails model and its arguments are as follows:
-* set of simple fields: i.e. fields that will be output as is
-* a hash of params:
- {user_id:        <the field in the model used as alias for the user id>
+In order to specify the fields you want to return to the user 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>}
+```
 
+#### Example
 
 ```ruby
-User.gdpr_collect :email, :last_sign_in_at, :stripe_customer_id,
-                  :type, :forward_mailbox,
+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",
@@ -54,10 +56,11 @@ User.gdpr_collect :email, :last_sign_in_at, :stripe_customer_id,
                                     last_sign_in_ip: "previously used IP address"}}
 ```
 
-```
+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`.
 
 ### Data export
-Call `ruby GdprExporter.export(<user_id>)` and it will return a csv formatted output.
+Finally, call `GdprExporter.export(<user_id>)` to return a csv formatted output of all the fields you specified previously.
 
 
 ## Contributing

data/lib/gdpr_exporter/version.rb

@@ -1,5 +1,5 @@
 module Exts
   module Gdpr
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/gdpr_exporter.rb

@@ -76,9 +76,12 @@ module GdprExporter
       self.class.send :attr_reader, :gdpr_hash_params
 
       # Build the csv header and prepare the fields used for querying
+      #
       user_id_field = hash_params[:user_id]
-      csv_headers = [:user_id].concat @gdpr_simple_fields
-      query_fields = [user_id_field].concat @gdpr_simple_fields
+      # csv_headers = [:user_id].concat @gdpr_simple_fields # Uncomment if user_id needed
+      # query_fields = [user_id_field].concat @gdpr_simple_fields # Uncomment if user_id needed
+      csv_headers = [].concat @gdpr_simple_fields
+      query_fields = [].concat @gdpr_simple_fields
 
       if hash_params[:renamed_fields]
         csv_headers.concat hash_params[:renamed_fields].values

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-gdpr-export
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chrislain Razafimahefa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler