Project

rails_eu_gdpr

0.0
No release in over 3 years
Low commit activity in last 3 years
rails_eu_gdprrobotex82/rails_eu_gdprHomepageDocumentationSource CodeBug TrackerWiki
Simple EU GDPR (DSGVO) compliance for rails applications.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,914
Stars
0
Forks
0
Watchers
3
 Releases
Current version
0.0.4
Total releases
1
First release
2018-06-11
Latest release
2018-06-11
 Pull Requests
Open Pull Requests
37
Closed Pull Requests
30
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-09-18
Reverse Dependencies
0

 Dependencies

Development

sqlite3
>= 0

Runtime

awesome_print
>= 0
cookies_eu
>= 0
rails
>= 3.2.0
 Project Readme

EuGdpr

Short description and motivation.

Installation

Add it to your gemfile:

gem 'rails_eu_gdpr'

Install your bundle:

$ bundle install

Install the initializer:

$ rails g eu_gdpr:install

Usage

Displaying the eu cookie banner

# app/assets/javascripts/application.js
//= require eu_gdpr

# app/assets/javascripts/application.js
/*
 *= require eu_gdpr
 */

# app/controllers/application_controller.rb
view_helper EuGdpr::ApplicationViewHelper, as: :eu_gdpr_helper

# app/views/layouts/application.html.erb
<%= eu_gdpr_helper(self).render_cookie_consent_banner %>

Displaying the eu cookie banner anywhere

# i.e. app/views/some_view.html.haml
<%= eu_gdpr_helper(self).render_cookie_preferences %>

Configuring the eu cookie banner

You can configure different levels of cookies in the initializer. The defaults are as follows:

# config/initializers/eu_gdpr.rb
config.cookies = ->(cookie_store = ::EuGdpr::CookieStore.new({})) {[
  ::EuGdpr::Cookie.new(identifier: :basic,        adjustable: false, default: true,  cookie_store: cookie_store),
  ::EuGdpr::Cookie.new(identifier: :analytics,    adjustable: true,  default: true,  cookie_store: cookie_store),
  ::EuGdpr::Cookie.new(identifier: :marketing,    adjustable: true,  default: true,  cookie_store: cookie_store),
  ::EuGdpr::Cookie.new(identifier: :social_media, adjustable: true,  default: false, cookie_store: cookie_store)
]}

Adding partials depeding on accepted cookies

Example:

!!! 5
%html{lang: 'de'}
  %head
    - eu_gdpr_helper(self).cookie_preferences.accepted_cookies.each do |c|
      = render "shared/partials/cookies/#{c.identifier}/head"
  %body
    - eu_gdpr_helper(self).cookie_preferences.accepted_cookies.each do |c|
      = render "shared/partials/cookies/#{c.identifier}/body"

Registering personal data

    EuGdpr.personal_data(Ecm::UserArea::User, log_removals: true, forget_with: :anonymization) do |u|
      u.attribute(:email, anonymize_with: :scrambler)
      u.attribute(:firstname, anonymize_with: :scrambler)
      u.attribute(:lastname, anonymize_with: :scrambler)
      u.attribute(:last_ip, anonymize_with: :nullifier)
      u.association(:posts) do |p|
        p.attribute(:title)
        p.attribute(:body)
        p.association(:gallery) do |g|
          g.attribute(:name)
          g.association(:pictures) do |p|
            p.attribute(:title)
            p.attribute(:asset) { |r| r.base64_encoded_asset }
          end
        end
      end
    end
    EuGdpr.personal_data(Ecm::Contact::ContactRequest, log_removals: true, forget_with: :deletion) do |r|
      r.attribute(:firstname)
      r.attribute(:lastname)
      r.attribute(:title)
      r.attribute(:body)
    end

How do I show the structure of registered personal data?

- EuGdpr.personal_data.each do |pd|
  %h2= pd.root
  = ap(pd.to_hash.as_json).html_safe

Features

  • Checks for SSL in production
  • Adds sensible attribute log filtering (customizable)
  • EU Cookie Message

Installation

Add this line to your application's Gemfile:

gem 'rails_eu_gdpr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rails_eu_gdpr

Add the initializer:

$ rails g rails_eu_gdpr:install

Upgrading to 0.0.3

Remove config.privacy_policy_defaults from config/initializers/eu_gdpr.rb as this options is not needed anymore.

Contributing

Contribution directions go here.

Development

Bundling for all rails version with appraisals

$> bundle exec appraisal install

Running specs

$> bundle exec appraisal rails-5-2 rspec -f d

Running the dummy app

spec/dummy-5_2 $> BUNDLE_GEMFILE=../../gemfiles/rails_5_2.gemfile rails console

Running stuff in the dummy app

spec/dummy-6_0 $> BUNDLE_GEMFILE=../../gemfiles/rails_6_0.gemfile rails webpacker:install

License

The gem is available as open source under the terms of the MIT License.

TODO

  • Personal Data Export
  • Right to Forget
  • Add cookie consent levels (i.e.required, marketing, etc.)

Unsorted notes

Model::Gdpr::PersonalDataConcern#gdpr_forget! Model::Gdpr::PersonalDataConcern#gdpr_export(format: :json)

Gdpr::Anonymizer::Base Gdpr::Anonymizer::Scrambler Gdpr::Anonymizer::Nullifier