forget_that 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4c089033e63cc13c348be8e0fc634dc9270d835b1427faffcfce82f744fce33
-  data.tar.gz: ccf7e04335ecc2af7e89742d0e3046c1d2fa04f063f1a45d74de3dade8526d71
+  metadata.gz: a51c257b09c9d456322846f42227c152fbac8890217b62fa1404667398dc907d
+  data.tar.gz: 2f768756f8589783a0af8a51a06fc9d2c2e416277016274d046ddf0a604c01ae
 SHA512:
-  metadata.gz: 84525558e0101333d1c38b59a79b48230043dafac018c729f4340e34f1f4b7063b2936b72f82d738abcc1db3e054cfbfadae35312a2e0d733b9505768272ef14
-  data.tar.gz: 0c5e4546c6f65dcbc70d02a9179258e4d1cb0f200e8f4b54cb0787d6b2cddfb3d1b4e0d8c7d499de903d2b6c968f056001fded5c8599882d5b590b5894b07cba
+  metadata.gz: 18a2d9593ff168ce6454c613935cf4b47ae73212a8e4d8173b51c0c40098e03478b38e73640b69230cc37cf603cfda15c1cf90c397496c6b40b3f86d6ca195f4
+  data.tar.gz: cf142d7d6073491ca57e654420edd39b9e1049152340b34f955ac83e2d3f2bca98ca42715b5e69bd8cacbaca8633031475306d560dd084c09f00bbc55627c080

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.gem

data/.rubocop.yml

@@ -1,10 +1,12 @@
 Style/Documentation:
   Enabled: false
+
 Style/MixinUsage:
   Exclude:
     - 'bin/setup'
     - 'bin/update'
-Metrics/LineLength:
+
+Layout/LineLength:
   Max: 120
   IgnoredPatterns: ['(\A|\s)#']
 
@@ -74,10 +76,10 @@ Documentation:
 Layout/MultilineHashBraceLayout:
   EnforcedStyle: symmetrical
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
 Metrics/BlockLength:
@@ -103,7 +105,7 @@ Lint/AmbiguousOperator:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.5.0
+  TargetRubyVersion: 2.7.0
   CacheRootDirectory: tmp/test-results
   Exclude:
     - db/**/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    forget_that (0.1.0)
+    forget_that (0.1.1)
       activerecord (>= 5)
       activesupport
       pg
@@ -34,13 +34,16 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2)
+    ast (2.4.0)
     builder (3.2.4)
+    coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crass (1.0.5)
     diff-lcs (1.3)
     erubi (1.9.0)
-    i18n (1.7.0)
+    i18n (1.7.1)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
     loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -49,7 +52,13 @@ GEM
     minitest (5.13.0)
     nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.1)
+      ast (~> 2.4.0)
     pg (1.2.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -64,6 +73,7 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -78,10 +88,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.1)
     thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
     zeitwerk (2.2.2)
 
 PLATFORMS
@@ -90,8 +110,11 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   forget_that!
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.79.0)
+  sqlite3
 
 BUNDLED WITH
-   2.0.2
+   2.1.2

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Vehiculum, Stanislav Pankov
+
+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

@@ -23,8 +23,8 @@ And then execute:
 Before gem could be used, a config in `config/anonymization_config.yml` in must be created:
 
 ```YAML
-config:
-  retention_time:
+config: # config part is only valid for the `call` method which will write in db
+  retention_time: # defines the newest record to be anonymized when `call` is used
     value: 90
     unit: 'days'
 
@@ -100,6 +100,20 @@ schema:
 
 Then gem can be invoked from the rake-task. It is your responsibility to ensure that it never runs on production.
 
+### Non-destructive use
+
+Anonymizers might be used with collection `ActiveRecord::Relation` supplied, not affecting any database.
+
+For example:
+
+```ruby
+anonymizer = ForgetThat::Service.new
+collection = Address.where(created_at: Time.current - 40.days)
+anonymizer.sanitize_collection(collection)
+```
+
+This will return an array of Hashes, corresponding to the records in `collection`. All fields configured to be anonymized, will be anonymized, ids will be stripped, the rest will be provided as is. This method ignores `retention_time`.
+
 ### Custom placeholders
 
 The default placeholders are `random_date`, `hex_string`, `random_phone`, `fake_personal_id_number`, `random_amount`. In some cases this might not be enough or behaviour might not be desireable. In that case you can supply `anonymizers` hash.
@@ -126,6 +140,7 @@ schema:
     name: 'Peter %{foobar}' #results in the "name" column of table "users" filled with "Peter FooBar"
 ```
 
+
 ## 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/Rakefile

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

data/forget_that.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/vehiculum-berlin/forget_that'
-  spec.metadata["changelog_uri"] = 'https://github.com/vehiculum-berlin/forget_that'
+  spec.metadata['changelog_uri'] = 'https://github.com/vehiculum-berlin/forget_that'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'sqlite3'
 
   spec.add_runtime_dependency 'activerecord', '>= 5'
   spec.add_runtime_dependency 'activesupport'

data/lib/forget_that.rb

@@ -6,13 +6,14 @@ require 'forget_that/record'
 
 module ForgetThat
   class InvalidConfigError < StandardError; end
+  class InvalidCollectionError < StandardError; end
 
   class << self
     attr_writer :logger
 
     def logger
       @logger ||= Logger.new($stdout).tap do |log|
-        log.progname = self.name
+        log.progname = name
       end
     end
   end

data/lib/forget_that/service.rb

@@ -20,6 +20,29 @@ module ForgetThat
       end
     end
 
+    def sanitize_collection(collection)
+      raise InvalidConfigError unless valid_anonymizer_set?
+      raise InvalidCollectionError unless valid_records? collection
+
+      table = collection.klass.table_name
+      unsafe_columns = config[table].keys
+      safe_columns = (collection.klass.columns.map(&:name) - unsafe_columns).reject { |e| e == 'id' }
+      safe_data = collection.pluck(*safe_columns).map { |r| r.is_a?(Array) ? r : [r] }
+      safe_data.map do |record|
+        makeshift = {}
+        unsafe_columns.each do |column|
+          makeshift[column] = config[table][column]
+        end
+        makeshift = makeshift
+                    .map { |key, value| [key, value.to_s % generate_anonymized_values] }
+                    .to_h
+        safe_columns
+          .map.with_index { |value, index| [value, record[index]] }
+          .to_h
+          .merge(makeshift)
+      end
+    end
+
     def anonymizers
       {
         random_date: -> { Time.now - [*1..10**4].sample.days },
@@ -63,6 +86,12 @@ module ForgetThat
       end
     end
 
+    def valid_records?(collection)
+      return true if collection.is_a?(ActiveRecord::Relation)
+
+      false
+    end
+
     private
 
     def populate_records_hash(columns)

data/lib/forget_that/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForgetThat
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forget_that
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stan Pankov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console