rails-gdpr-export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f339f58d2851865fc9ecbb780ed5561a9f692bc60341325d14b2e18c6378733
+  data.tar.gz: a3f0b834ec32842050baa81fab905d6a75bf6364edaf2583c843a124568dcb01
+SHA512:
+  metadata.gz: 6b3b5df225578771d630115f3a47455b1e72a79d239236fc892c505a34bf390fb567d7fa86a102b09e52aa631f2825c81dfc5c98704fe3b302d90bb1a5cd81f5
+  data.tar.gz: f91fcb3f52b6da7ad6ef2bd75bb2dca3984075fd94f3aa56f8b4bb73b7d54d706659121ecf655002f0a0c726a574e70d944f3e4979bf4b60370a84086ed20177

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-gdpr-export.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rails-gdpr-export (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rails-gdpr-export!
+  rake (< 11.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chrislain Razafimahefa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Rails::Gdpr::Export
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails/gdpr/export`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-gdpr-export'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-gdpr-export
+
+## Usage
+
+- Add the following code in a initializer file (e.g. initializers/gdpr.rb):
+
+```ruby
+require 'exts/gdpr'
+
+# Loads the Gdpr module into activerecord classes.
+ActiveRecord::Base.send :include, Gdpr
+
+
+# Defines gdpr data collection throughout the model classes
+#
+User.gdpr_collect :email, :last_sign_in_at, :stripe_customer_id,
+                  :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"}}
+
+
+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 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.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-gdpr-export.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/gdpr/export"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/exts/gdpr.rb

@@ -0,0 +1,114 @@
+# 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

data/lib/exts/gdpr/version.rb

@@ -0,0 +1,5 @@
+module Exts
+  module Gdpr
+    VERSION = "0.1.0"
+  end
+end

data/rails-gdpr-export.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exts/gdpr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-gdpr-export"
+  spec.version       = Exts::Gdpr::VERSION
+  spec.authors       = ["Chrislain Razafimahefa"]
+  spec.email         = ["razafima@gmail.com"]
+
+  spec.summary       = %q{A gem to export personal data in compliance with GDPR.}
+  spec.homepage      = "https://github.com/epfl-exts/rails-gdpr-export"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "< 11.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rails-gdpr-export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chrislain Razafimahefa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- razafima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/exts/gdpr.rb
+- lib/exts/gdpr/version.rb
+- rails-gdpr-export.gemspec
+homepage: https://github.com/epfl-exts/rails-gdpr-export
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A gem to export personal data in compliance with GDPR.
+test_files: []