rails-gdpr-export 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1019761a9443a0a21381bdf2276b0186c198c45d1225f4c751863fc6ac004622
-  data.tar.gz: 1b5136e360723d7c113aea6699d740c828513e06a24f032ced92e39a64ca5a27
+  metadata.gz: 7071e26a9662f67d80d9c59a8ee5dcb3d896682b63094b8fd37c288f73ebb052
+  data.tar.gz: 0f10a671e075a4fc691b88a99d905434e93ce189b81adc90a7e89a59fac5c1c0
 SHA512:
-  metadata.gz: 8943787b8e4ee6eb4e24fcf58d01ff8df090245a7e955c1ccb1f17af2bd3805999ed6de29b9eaf64fdd70a2176504ec1fd2e90910e0cfba687b1abf0b0da99c2
-  data.tar.gz: 6b3818a619645b863ee8ee294ac41417620c8b2daa295dac0e7b22b7a5fedd7cc5479fd710f113478fd6848ba4b6fd2a0728c28fa934764fab03bb54102f1da5
+  metadata.gz: 96fa84ddc1af458eb2e6a545644159c5fae81667cbc032182b70ac6f8fc99d6071f996be7cf3a1f9ad67086e12254849e2c2eb8324d8a54ee15e631d01696cda
+  data.tar.gz: efb60c1bf1fc6e1503d856b5e57ef591d6c9f7e52a1f169a861395469ebcc53ec0c1b171cb0c0498bdc132a7536e5ffe22b90317f99abd271640db3550b15e06

data/Gemfile.lock

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

data/README.md

@@ -20,17 +20,30 @@ Or install it yourself as:
 
 ## Usage
 
-- Add code similar to the above in a initializer file (e.g. initializers/gdpr.rb) to specify the fields you want to retrieve:
+This gem allows you to specify fields that you want to retrieve from your models and to export them in a csv format.
+
+### 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
-require 'exts/gdpr'
+ActiveRecord::Base.send :include, GdprExporter
+```
 
-# Loads the Gdpr module into activerecord classes.
-ActiveRecord::Base.send :include, Exts::Gdpr
+### 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>
+  renamed_fields: {<field_from_db> => <field_name_in_output>}
+  table_name:     <the new table name in output>
+  description:    <a comment>
+  join:           <an association>}
 
-# Defines gdpr data collection throughout the model classes
-#
+
+```ruby
 User.gdpr_collect :email, :last_sign_in_at, :stripe_customer_id,
                   :type, :forward_mailbox,
                   {user_id: :id,
@@ -39,25 +52,13 @@ User.gdpr_collect :email, :last_sign_in_at, :stripe_customer_id,
                                     chosen_program_id: "chosen program",
                                     current_sign_in_ip: "current IP address",
                                     last_sign_in_ip: "previously used IP address"}}
-
-
-Subscription.gdpr_collect  :stripe_id, :stripe_plan_id,
-                           :exmatriculated_at, :current_period_end, :status,
-                           :notified_at, :pause_reason, :pause_error,
-                           :start_at, :initial_start_at, :completed_at,
-                           :amount, :paused_at, :rules_accepted_at,
-                           {user_id: :user_id,
-                            join: :program,
-                            renamed_fields: {title: "program title"}}
 ```
 
-- call Exts::Gdpr.export(<user_id>) and it will return a csv formatted output
-
-## Development
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Data export
+Call `ruby GdprExporter.export(<user_id>)` and it will return a csv formatted output.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/gdpr_exporter.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "gdpr_exporter/version"
+require 'csv'
+
+module GdprExporter
+    # Stores all the classes that have been tagged for gdpr collection
+  @@klasses = []
+
+  def self.get_klasses
+    @@klasses
+  end
+
+  def self.add_klass(klass)
+    @@klasses << klass
+  end
+
+  # Collects data through all the tagged models and generates a csv
+  # formatted output
+  def self.export(user_id)
+    CSV.generate do |csv|
+      get_klasses.each do |klass|
+        rows = klass.gdpr_query(user_id)
+        klass.gdpr_export(rows, csv)
+      end
+    end
+  end
+
+  # Instruments the classes implementing this module with instance and class
+  # methods.
+  def self.included base
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+  end
+
+  module ClassMethods
+    # Declared in each model class with interest in collecting gdpr data.
+    # Instruments the singleton of those classes so that gdpr data can be
+    # collected and exported to csv.
+    #
+    # Arguments are:
+    # - set of simple fields: i.e. fields that will be output as is
+    # - a hash of params:
+    # {renamed_fields: {<field_from_db> => <field_name_in_output>}
+    #  table_name:     <the new table name in output>
+    #  description:    <a comment>
+    #  join:           <an association>}
+    def gdpr_collect(*args)
+      # Params handling
+      if args.class == Hash # when user provides the hash_params only
+        simple_fields, hash_params = [[], args]
+      else
+        simple_fields, hash_params = [args[0..-2], args.last]
+      end
+
+      unless hash_params.class == Hash
+        raise "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}'!"
+      end
+
+      # Adds the eigen class to the set of classes eligible for gdpr data collection.
+      GdprExporter.add_klass(self)
+
+      # Adds instance fields to the eigenclass. They store
+      # all the fields and info we are interested in.
+      @gdpr_simple_fields = simple_fields
+      @gdpr_hash_params = hash_params
+      # Add readers for the instance vars declared above (for testing reasons)
+      self.class.send :attr_reader, :gdpr_simple_fields
+      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
+
+      if hash_params[:renamed_fields]
+        csv_headers.concat hash_params[:renamed_fields].values
+        query_fields.concat hash_params[:renamed_fields].keys
+      end
+
+      # 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)
+        end
+      end
+
+      # Adds a method to export to csv to the eigenclass.
+      self.define_singleton_method(:gdpr_export) do |rows, csv|
+        csv << (hash_params[:table_name] ? [hash_params[:table_name]] :
+                  [self.to_s])
+        csv << csv_headers
+        rows.each do |r|
+          csv << query_fields.map{ |f| r.send(f) }
+        end
+        csv << ['Comment:', hash_params[:desc]] if hash_params[:desc]
+        csv << []
+      end
+    end
+  end
+end

data/lib/{exts/gdpr → gdpr_exporter}/version.rb

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

data/rails-gdpr-export.gemspec

@@ -1,7 +1,7 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "exts/gdpr/version"
+require "gdpr_exporter/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rails-gdpr-export"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-gdpr-export
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Chrislain Razafimahefa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/exts/gdpr.rb
-- lib/exts/gdpr/version.rb
+- lib/gdpr_exporter.rb
+- lib/gdpr_exporter/version.rb
 - rails-gdpr-export.gemspec
 homepage: https://github.com/epfl-exts/rails-gdpr-export
 licenses:

data/lib/exts/gdpr.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require "exts/gdpr/version"
-require 'csv'
-
-module Exts
-  module Gdpr
-    # Stores all the classes that have been tagged for gdpr collection
-    @@klasses = []
-
-    def self.get_klasses
-      @@klasses
-    end
-
-    def self.add_klass(klass)
-      @@klasses << klass
-    end
-
-    # Collects data through all the tagged models and generates a csv
-    # formatted output
-    def self.export(user_id)
-      CSV.generate do |csv|
-        get_klasses.each do |klass|
-          rows = klass.gdpr_query(user_id)
-          klass.gdpr_export(rows, csv)
-        end
-      end
-    end
-
-    # Instruments the classes implementing this module with instance and class
-    # methods.
-    def self.included base
-      base.send :include, InstanceMethods
-      base.extend ClassMethods
-    end
-
-    module InstanceMethods
-    end
-
-    module ClassMethods
-      # Declared in each model class with interest in collecting gdpr data.
-      # Instruments the singleton of those classes so that gdpr data can be
-      # collected and exported to csv.
-      #
-      # Arguments are:
-      # - set of simple fields: i.e. fields that will be output as is
-      # - a hash of params:
-      # {renamed_fields: {<field_from_db> => <field_name_in_output>}
-      #  table_name:     <the new table name in output>
-      #  description:    <a comment>
-      #  join:           <an association>}
-      def gdpr_collect(*args)
-        # Params handling
-        if args.class == Hash # when user provides the hash_params only
-          simple_fields, hash_params = [[], args]
-        else
-          simple_fields, hash_params = [args[0..-2], args.last]
-        end
-
-        unless hash_params.class == Hash
-          raise "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}'!"
-        end
-
-        # Adds the eigen class to the set of classes eligible for gdpr data collection.
-        Gdpr.add_klass(self)
-
-        # Adds instance fields to the eigenclass. They store
-        # all the fields and info we are interested in.
-        @gdpr_simple_fields = simple_fields
-        @gdpr_hash_params = hash_params
-        # Add readers for the instance vars declared above (for testing reasons)
-        self.class.send :attr_reader, :gdpr_simple_fields
-        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
-
-        if hash_params[:renamed_fields]
-          csv_headers.concat hash_params[:renamed_fields].values
-          query_fields.concat hash_params[:renamed_fields].keys
-        end
-
-        # 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)
-          end
-        end
-
-        # Adds a method to export to csv to the eigenclass.
-        self.define_singleton_method(:gdpr_export) do |rows, csv|
-          csv << (hash_params[:table_name] ? [hash_params[:table_name]] :
-                    [self.to_s])
-          csv << csv_headers
-          rows.each do |r|
-            csv << query_fields.map{ |f| r.send(f) }
-          end
-          csv << ['Comment:', hash_params[:desc]] if hash_params[:desc]
-          csv << []
-        end
-      end
-    end
-  end
-end