database_anonymizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70d1aa4ae504021382a9c6745510718ef87bf21e
+  data.tar.gz: 331fb255934633a0ecab771d463302f59bb85ed0
+SHA512:
+  metadata.gz: 7f1a06f5ac4f602eac5603f014c6ec3c6eda063a7ac1296a08f567eeb18b8614763050c5290238449a12e36a4b068ac4258bfb31f11e43c30b7a08e32a767c61
+  data.tar.gz: 3fb405c32fe52613f485bcf1f949e7a6857b879284a12a3c452013254c8f8b1443cf40e5f4db3ba2ce5310f5d1cad83ccc030bf54419f2f6e8fe6894eb5a051b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Shingo Kawamura
+
+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,77 @@
+# DatabaseAnonymizer
+A database anonymizer for Rails 4+
+
+## Installation
+
+Put this line in your Gemfile:
+
+```ruby
+gem 'database_anonymizer'
+```
+
+Then bundle:
+
+```sh
+$ bundle
+```
+
+Create `config/database_anonymizer/whitelist.yml` by:
+
+```sh
+$ bin/rails generate database_anonymizer:install
+```
+
+Then, only string or text type column table structures are created.
+
+## Usage
+
+See below sample `config/database_anonymizer/whitelist.yml` file.
+
+```yml
+'User':
+# name:
+  email:
+    anonymized_by: User.anonymize_email
+# address:
+# tel:
+  remarks:
+    anonymized_by: nil
+# comment:
+```
+
+### Asteriskize
+if a column is commented out,
+the column will be replaced by asterisks.
+
+Default asterisks size is 8.
+
+If `validate_length_of` is present, the number of asterisks size may not be 8.
+For details, see the method `asterisk_length` at `lib/database_anonymizer/metamorphosis.rb`.
+
+### Anonymize
+If a column needs a specific anonymizer,
+remove `#`, and add `anonymized_by: Model.anonymize_method`.
+You have to define your own anonymize method.
+
+### Do Nothing
+If a column don't need to be asteriskized or anonymized,
+remove `#`, and add `anonymized_by: nil`.
+
+### Run rake task
+
+Finally, run below rake task:
+
+```sh
+$ RAILS_ENV=TARGET_ENV bin/rake database_anonymizer:execute
+```
+
+## Specification
+If `RAILS_ENV` is production,`bin/rake database_anonymizer:execute` fails.
+
+## Contributing
+
+1. Fork it ( https://github.com/blp1526/database_anonymizer/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/lib/database_anonymizer/engine.rb

@@ -0,0 +1,5 @@
+module DatabaseAnonymizer
+  class Engine < ::Rails::Engine
+    isolate_namespace DatabaseAnonymizer
+  end
+end

data/lib/database_anonymizer/metamorphosis.rb

@@ -0,0 +1,113 @@
+module DatabaseAnonymizer
+  class Metamorphosis
+    DEFAULT_ASTERISK_LENGTH = 8
+
+    attr_reader :model
+
+    def self.prepare_for_rake
+      Rails.application.eager_load!
+      ActiveRecord::Base.clear_cache!
+    end
+
+    def self.whitelist_path
+      File.join(Rails.root, 'config', 'database_anonymizer', 'whitelist.yml')
+    end
+
+    def self.whitelist
+      YAML.load_file(whitelist_path).respond_to?(:deep_symbolize_keys) ? YAML.load_file(whitelist_path).deep_symbolize_keys : {}
+    end
+
+    def self.table_existing_active_record_inheritors
+      ActiveRecord::Base.descendants.reject do |d|
+        !d.superclass.eql?(ActiveRecord::Base) || d.eql?(ActiveRecord::SchemaMigration) || !d.table_exists?
+      end
+    end
+
+    def self.targets
+      table_existing_active_record_inheritors.map { |model| new(model) }
+    end
+
+    def self.execute
+      asteriskize
+      anonymize
+    end
+
+    def self.asteriskize
+      case ActiveRecord::Base.configurations[Rails.env]['adapter']
+      when 'mysql2'
+        targets.each(&:mysql_asteriskize)
+      else
+        targets.each(&:general_asteriskize)
+      end
+    end
+
+    def self.anonymize
+      fail DangerousRailsEnvError if Rails.env == 'production'
+      whitelist.keys.each do |model_name|
+        whitelist[model_name].each do |column, details|
+          anonymize_log(model_name, column) { eval(details[:anonymized_by]) }
+        end
+      end
+    end
+
+    def self.anonymize_log(model_name, column)
+      ActiveRecord::Migration.say_with_time "anonymize for #{model_name}##{column} start..." do
+        yield
+        puts "-- anonymize for #{model_name}##{column} completed!"
+      end
+    end
+
+    def initialize(model)
+      @model = model
+    end
+
+    def string_or_text_column_names
+      model.columns.select { |column| [:string, :text].include?(column.type) }.map { |c| c.name.to_sym }
+    end
+
+    def unwhitelist_column_names
+      string_or_text_column_names.select { |column_name| self.class.whitelist[model.to_s.to_sym].try!(:[], column_name).nil? }
+    end
+
+    def length_validator(column_name)
+      model.validators_on(column_name).find { |validator| validator.class.eql?(ActiveModel::Validations::LengthValidator) }
+    end
+
+    def asterisk_length(column_length_validator)
+      length = DEFAULT_ASTERISK_LENGTH
+      return length unless column_length_validator
+      length = column_length_validator.options[:minimum] if column_length_validator.options[:minimum]
+      if column_length_validator.options[:maximum] && length > column_length_validator.options[:maximum]
+        length = column_length_validator.options[:maximum]
+      end
+      length
+    end
+
+    def mysql_update_query(column_name)
+      # NOTE: If a column name is same as MySQL reserved words, backquote is needed.
+      "UPDATE #{model.table_name} SET `#{column_name}`='#{'*' * asterisk_length(length_validator(column_name))}' WHERE `#{column_name}` LIKE '%_%'"
+    end
+
+    def mysql_asteriskize
+      fail DangerousRailsEnvError if Rails.env == 'production'
+      unwhitelist_column_names.each do |column_name|
+        ActiveRecord::Base.connection.execute(mysql_update_query(column_name))
+      end
+    end
+
+    def general_asteriskize
+      fail DangerousRailsEnvError if Rails.env == 'production'
+      model.unscoped.find_each { |instance| instance.update!(asteriskize_params(instance)) }
+    end
+
+    private
+
+      def asteriskize_params(instance)
+        unwhitelist_column_names.each_with_object({}) do |column_name, obj|
+          obj[column_name] = ('*' * asterisk_length(length_validator(column_name))) if instance.__send__(column_name)
+        end
+      end
+  end
+end
+
+class DangerousRailsEnvError < StandardError; end

data/lib/database_anonymizer/version.rb

@@ -0,0 +1,3 @@
+module DatabaseAnonymizer
+  VERSION = "0.0.1"
+end

data/lib/database_anonymizer.rb

@@ -0,0 +1,5 @@
+require 'database_anonymizer/engine'
+require 'database_anonymizer/metamorphosis'
+
+module DatabaseAnonymizer
+end

data/lib/generators/database_anonymizer/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    install database_anonymizer file
+
+Example:
+    rails generate database_anonymizer:install
+
+    This will create:
+        config/database_anonymizer/whitelist.yml

data/lib/generators/database_anonymizer/install/install_generator.rb

@@ -0,0 +1,9 @@
+require 'database_anonymizer/metamorphosis'
+
+class DatabaseAnonymizer::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    template 'whitelist.yml.erb', File.join('config', 'database_anonymizer', 'whitelist.yml')
+  end
+end

data/lib/generators/database_anonymizer/install/templates/whitelist.yml.erb

@@ -0,0 +1,7 @@
+<% DatabaseAnonymizer::Metamorphosis.prepare_for_rake -%>
+<% DatabaseAnonymizer::Metamorphosis.targets.each do |target| -%>
+<%= "# '#{target.model.name}':" %>
+<% target.string_or_text_column_names.each do |column_name| -%>
+  <%= "# #{column_name}:" %>
+  <%- end %>
+<% end -%>

data/lib/tasks/database_anonymizer_tasks.rake

@@ -0,0 +1,13 @@
+require 'database_anonymizer/metamorphosis'
+
+namespace :database_anonymizer do
+  desc 'anonymize records'
+  task execute: :environment do
+    ActiveRecord::Migration.say_with_time 'database_anonymizer:execute start...' do
+      DatabaseAnonymizer::Metamorphosis.prepare_for_rake
+      DatabaseAnonymizer::Metamorphosis.execute
+      puts 'database_anonymizer:execute finished!'
+      puts 'total time'
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: database_anonymizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shingo Kawamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  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: rspec-rails
+  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: factory_girl_rails
+  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: A database anonymizer for Rails 4+
+email:
+- blp1526@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/database_anonymizer.rb
+- lib/database_anonymizer/engine.rb
+- lib/database_anonymizer/metamorphosis.rb
+- lib/database_anonymizer/version.rb
+- lib/generators/database_anonymizer/install/USAGE
+- lib/generators/database_anonymizer/install/install_generator.rb
+- lib/generators/database_anonymizer/install/templates/whitelist.yml.erb
+- lib/tasks/database_anonymizer_tasks.rake
+homepage: https://github.com/blp1526/database_anonymizer
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A database anonymizer for Rails 4+
+test_files: []