toku 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a28d71264c08bd9a4e7fb28ba09b15c31ba48a57
+  data.tar.gz: 2818fa86da6e86ce6763dbda685e02d46288036e
+SHA512:
+  metadata.gz: 5e7c7968f76acccab091e5909fac96205e69cbaefc2dcdd735a56d5dd47987027e1e0f086ed550e862a80628e214ea80198b26d429fb36cc81c5cd9026dbec4e
+  data.tar.gz: ba307d99a54bf305eac18232f14f2f7fa3f80b67e5466f287e7d89c8d0c2f9a2bd83b4c6692cac4f3536cdf861ef343a5f1b74e025cafb6a885301e62bfb1fd7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.pryrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pascal.lamouric@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in toku.gemspec
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'pg_tester'
+  gem 'pry-byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pascal Lamouric
+
+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,62 @@
+# Toku
+
+Toku (which comes from 'Tokumei' 匿名 in Japanese) is a gem originally designed to anonymize a database in order to feed a another database with same columns but with filtered row contents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toku'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toku
+
+## Usage
+
+```ruby
+Toku::Anonymizer.new(<path_to_config_file>).run(source_db, destination_db)
+```
+
+Users can define custom filters by implementing a `Toku::ColumnFilter` subclass like so:
+
+```ruby
+module Toku
+  class NewFilter < Toku::ColumnFilter
+    def initialize(**options)
+    end
+
+    def call(_)
+      _
+    end
+  end
+end
+```
+
+Which can be then referenced in the config file using the key of the mapping hash.
+
+## Config file specification
+
+TODO
+
+## 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]/toku. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "toku"
+
+# 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

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/toku.rb

@@ -0,0 +1,75 @@
+require "toku/version"
+Dir[File.dirname(__FILE__) + "/toku/**/*.rb"].each { |file| require file }
+
+module Toku
+  class Anonymizer
+
+    attr_accessor :column_filters
+    attr_accessor :row_filters
+
+    # A few default filters mappings
+    COLUMN_FILTER_MAP = {
+      none: Toku::ColumnFilter::Passthrough,
+      faker_last_name: Toku::ColumnFilter::FakerLastName,
+      faker_first_name: Toku::ColumnFilter::FakerFirstName,
+      faker_email: Toku::ColumnFilter::FakerEmail
+    }
+
+    ROW_FILTER_MAP = {
+      drop: Toku::RowFilter::Drop
+    }
+
+    # @param [String] config_file_path path of config file
+    def initialize(config_file_path, column_filters = {}, row_filters = {})
+      @config = YAML.load(File.read(config_file_path))
+      self.column_filters = column_filters.merge(COLUMN_FILTER_MAP)
+      self.row_filters = row_filters.merge(ROW_FILTER_MAP)
+    end
+
+    # @param [String] uri_db_source URI of the DB to be anonimized
+    # @param [String] uri_db_destination URI of the destination DB
+    def run(uri_db_source, uri_db_destination)
+      source_db = Sequel.connect(uri_db_source)
+      destination_db = Sequel.connect(uri_db_destination)
+
+      raise Toku::SchemaMismatchError unless source_schema_included?(source_db, destination_db)
+
+      source_db.extension(:pg_streaming)
+
+      source_db.tables.each do |table|
+        if @config[table.to_s]['columns'].count < source_db.from(table).columns.count
+          raise Toku::ColumnFilterMissingError
+        end
+
+        row_enumerator = source_db[table].stream.to_enum
+
+        @config[table.to_s]['rows'].each do |f|
+          row_filter = self.row_filters[f.keys.first.to_sym]
+          if f.is_a? String
+            options = nil
+          elsif f.is_a? Hash
+            options = f.values.first
+          end
+
+          row_enumerator = row_filter.new(options).call(row_enumerator)
+        end
+
+        row_enumerator = row_enumerator.map { |row| transform(row, table) }
+        destination_db.copy_into(table, data: row_enumerator, format: :csv)
+      end
+    end
+
+    # @return [String]
+    def transform(row, name)
+      row.map do |k, v|
+        self.column_filters[@config[name.to_s]['columns'][k.to_s].first.to_sym].new.call(v)
+      end.join(',')
+    end
+
+    def source_schema_included?(source_db, destination_db)
+      source_db.tables.all? do |table|
+        source_db.schema(table) == destination_db.schema(table)
+      end
+    end
+  end
+end

data/lib/toku/errors/column_filter_missing_error.rb

@@ -0,0 +1,6 @@
+# When a filter for one column is not specified
+# This is to enforce the fact that no column treatment can be 'inferred'
+module Toku
+  class ColumnFilterMissingError < StandardError
+  end
+end

data/lib/toku/errors/schema_mismatch_error.rb

@@ -0,0 +1,5 @@
+# When the origin and destination table dont have the same schema
+module Toku
+  class SchemaMismatchError < StandardError
+  end
+end

data/lib/toku/filters/column.rb

@@ -0,0 +1,11 @@
+module Toku
+  class ColumnFilter
+    # @param options [Hash{Symbol => Object}] arguments passed to the filter
+    def initialize(**options)
+    end
+
+    def call(input)
+      input
+    end
+  end
+end

data/lib/toku/filters/column/faker_email.rb

@@ -0,0 +1,9 @@
+module Toku
+  class ColumnFilter
+    class FakerEmail < Toku::ColumnFilter
+      def call(_)
+        Faker::Internet.email
+      end
+    end
+  end
+end

data/lib/toku/filters/column/faker_first_name.rb

@@ -0,0 +1,9 @@
+module Toku
+  class ColumnFilter
+    class FakerFirstName < Toku::ColumnFilter
+      def call(_)
+        Faker::Name.first_name
+      end
+    end
+  end
+end

data/lib/toku/filters/column/faker_last_name.rb

@@ -0,0 +1,9 @@
+module Toku
+  class ColumnFilter
+    class FakerLastName < Toku::ColumnFilter
+      def call(_)
+        Faker::Name.last_name
+      end
+    end
+  end
+end

data/lib/toku/filters/column/passthrough.rb

@@ -0,0 +1,9 @@
+module Toku
+  class ColumnFilter
+    class Passthrough < Toku::ColumnFilter
+      def call(_)
+        _.to_s
+      end
+    end
+  end
+end

data/lib/toku/filters/row.rb

@@ -0,0 +1,11 @@
+module Toku
+  class RowFilter
+    # @paramoptions [Hash{Symbol => Object}] arguments passed to the filter
+    def initialize(**options)
+    end
+
+    def call(_)
+      _
+    end
+  end
+end

data/lib/toku/filters/row/drop.rb

@@ -0,0 +1,9 @@
+module Toku
+  class RowFilter
+    class Drop < Toku::RowFilter
+      def call(stream)
+        stream.each { |row| nil }
+      end
+    end
+  end
+end

data/lib/toku/version.rb

@@ -0,0 +1,3 @@
+module Toku
+  VERSION = "0.1.0"
+end

data/toku.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toku"
+  spec.version       = Toku::VERSION
+  spec.authors       = ["PSKL"]
+  spec.email         = ["hello@pascal.cc"]
+
+  spec.summary       = %q{Anonymize a database, fast}
+  spec.description   = %q{Use filters on your database to obfuscate row contents.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'sequel'
+  spec.add_development_dependency 'sequel_pg'
+  spec.add_development_dependency 'faker'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: toku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PSKL
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: sequel_pg
+  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: faker
+  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'
+description: Use filters on your database to obfuscate row contents.
+email:
+- hello@pascal.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/toku.rb
+- lib/toku/errors/column_filter_missing_error.rb
+- lib/toku/errors/schema_mismatch_error.rb
+- lib/toku/filters/column.rb
+- lib/toku/filters/column/faker_email.rb
+- lib/toku/filters/column/faker_first_name.rb
+- lib/toku/filters/column/faker_last_name.rb
+- lib/toku/filters/column/passthrough.rb
+- lib/toku/filters/row.rb
+- lib/toku/filters/row/drop.rb
+- lib/toku/version.rb
+- toku.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Anonymize a database, fast
+test_files: []