mtwtfss_yaml_db_anonymizer 0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njg2MWU3ZjNhY2RmYTJhZThiMTBhNTkyYzA0YjYzMDUxNjM3MzE0Ng==
+  data.tar.gz: !binary |-
+    YTE0OThlOWM2Yjg0ZDJiMGQ0ZGZhMDAwODk5Mjk3NzQzOGQ5NGEyMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGFkMTUyOTk0Y2NiMDU4M2ExZWU0ZjFkOWE1YzRkNzg1YjZiOWYwNWFiZWNi
+    NzJhOTVjMmM2M2Q1ZGUxYzAxY2ZkNDFjZTE1Y2NmYjU1MzBmZGQ3ODU4YTAx
+    N2VmZTM2MDNlNTBlNDMwY2YzYmQ3OWUwNjkwOGQ2N2Q5ZTY0ODg=
+  data.tar.gz: !binary |-
+    MjIyMzQ5ZGJjZGU5YTk5Nzg4ODk3NDA2YmY3MjNkMWQ0YzlkZGFlY2RmOGQ4
+    Yjc1NTY1ZTliYTVjZDcxOTcxYWQ2OGE4ZGE5MTlkM2I5NGI4MzJmNTcxYTA5
+    YmY5ZmQ4NzUxYThkZDI5OTMwYTg3OTNjNjAyMjYwYTFkMmJkOTM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color -f documentation --drb

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-head
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mtwtfss_yaml_db_anonymizer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+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,58 @@
+# MtwtfssYamlDb::Anonymizer
+
+Dumps anonymized database contents to a YAML file. This is useful if you want to develop Rails applications with near-live data from your server. Based on [yaml_db](https://github.com/ludicast/yaml_db).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mtwtfss_yaml_db_anonymizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mtwtfss_yaml_db_anonymizer
+
+## Usage
+
+* Specify the database fields to anonymize, e.g. in
+   `config/initializers/mtwtfss_yaml_db_anonymizer.rb`:
+
+```ruby
+MtwtfssYamlDb::Anonymizer.define do
+  table :users do
+    remove :encrypted_password
+    replace :name, with: 'John Doe'
+    replace :phone, with: ->(phone) { phone.to_s[0..-3] + '***' }
+  end
+
+  table :logs do
+    truncate
+  end
+end
+```
+
+* Run `rake db:data:dump_anonymized` on your server. This creates an anonymized dump in `db/data.yml`
+
+* Copy `db/data.yml` to your local machine
+
+* Run `rake db:data:load` on your local machine.
+
+## Todo
+
+* Provide capistrano integration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT License.

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mtwtfss_yaml_db/anonymizer.rb

@@ -0,0 +1,51 @@
+require 'yaml_db'
+require 'mtwtfss_yaml_db/anonymizer/railtie'
+
+module MtwtfssYamlDb
+  module Anonymizer
+    autoload :Dump,    'mtwtfss_yaml_db/anonymizer/dump'
+    autoload :Helper,  'mtwtfss_yaml_db/anonymizer/helper'
+    autoload :VERSION, 'mtwtfss_yaml_db/anonymizer/version'
+
+    class << self
+      attr_accessor :definition
+
+      def define(*args, &block)
+        self.definition = {}
+        class_eval &block
+      end
+
+      def table(table_name, &block)
+        @table_name = table_name.to_s
+        self.definition[@table_name] = {}
+        class_eval &block
+      end
+
+      def truncate
+        self.definition[@table_name] = :truncate
+      end
+
+      def remove(column_name)
+        self.definition[@table_name][column_name.to_s] = nil
+      end
+
+      def remove_row_if(column_name, opts={})
+        self.definition[@table_name][column_name.to_s] = opts[:condition]
+      end
+
+      def replace(column_name, opts={})
+        self.definition[@table_name][column_name.to_s] = opts[:with]
+      end
+
+      def anonymize(table, column, value)
+        return value unless self.definition.key?(table.to_s) and self.definition[table.to_s].key?(column.to_s)
+        block_or_value = self.definition[table.to_s][column.to_s]
+        if block_or_value.is_a?(Proc)
+          block_or_value.arity == 1 ? block_or_value.call(value) : block_or_value.call
+        else
+          block_or_value
+        end
+      end
+    end
+  end
+end

data/lib/mtwtfss_yaml_db/anonymizer/dump.rb

@@ -0,0 +1,45 @@
+module MtwtfssYamlDb
+  module Anonymizer
+    class Dump < ::YamlDb::Dump
+
+      def self.dump_table_records(io, table)
+        return super(io, table) unless Anonymizer.definition.is_a? Hash
+        return if Anonymizer.definition[table.to_s] == :truncate
+
+        table_record_header(io)
+
+        column_names = table_column_names(table)
+
+        each_table_page(table) do |records|
+          rows = SerializationHelper::Utils.unhash_records(records, column_names)
+          records_anonymized = records.map do |record|
+            # FIXME Why isn't there a map_with_index?
+            record_anonymized = []
+            record.each_with_index do |value, i|
+              if Anonymizer.anonymize(table, column_names[i], value) == 'REMOVE_ROW'
+                record_anonymized = 'REMOVE_ROW'
+                break
+              else
+                record_anonymized << Anonymizer.anonymize(table, column_names[i], value)
+              end
+            end
+            record_anonymized
+          end
+          records_anonymized.delete_if { |record| record == 'REMOVE_ROW' }
+          io.write(YamlDb::Utils.chunk_records(records_anonymized))
+        end
+      end
+
+      def self.dump_table_columns(io, table)
+        super(io, table) unless Anonymizer.definition.is_a?(Hash) && Anonymizer.definition[table.to_s] == :truncate
+      end
+
+      def self.tables
+        ActiveRecord::Base.connection.tables
+      end
+
+    end
+
+  end
+end
+

data/lib/mtwtfss_yaml_db/anonymizer/helper.rb

@@ -0,0 +1,19 @@
+module MtwtfssYamlDb
+  module Anonymizer
+    module Helper
+      class << self
+        def dumper
+          MtwtfssYamlDb::Anonymizer::Dump
+        end
+
+        def loader
+          YamlDb::Load
+        end
+
+        def extension
+          "yml"
+        end
+      end
+    end
+  end
+end

data/lib/mtwtfss_yaml_db/anonymizer/railtie.rb

@@ -0,0 +1,9 @@
+module MtwtfssYamlDb
+  module Anonymizer
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load File.join(File.dirname(__FILE__), '..', '..', 'tasks', 'mtwtfss_yaml_db_anonymizer.rake')
+      end
+    end
+  end
+end

data/lib/mtwtfss_yaml_db/anonymizer/version.rb

@@ -0,0 +1,5 @@
+module MtwtfssYamlDb
+  module Anonymizer
+    VERSION = "0.7"
+  end
+end

data/lib/mtwtfss_yaml_db_anonymizer.rb

@@ -0,0 +1 @@
+require 'mtwtfss_yaml_db/anonymizer'

data/lib/tasks/mtwtfss_yaml_db_anonymizer.rake

@@ -0,0 +1,19 @@
+namespace :db do
+  namespace :data do
+    desc 'Dump anonymized database contents to db/data.yml'
+    task :dump_anonymized => :environment do
+      format_class = ENV['class'] || "MtwtfssYamlDb::Helper"
+      filter = ENV['filter_tables']
+
+      SerializationHelper::Base.new(MtwtfssYamlDb::Anonymizer::Helper, filter).dump File.join(Rails.root, 'db', 'data.yml')
+    end
+
+    task :dump_anonymized_dir => :environment do
+      format_class = ENV['class'] || "MtwtfssYamlDb::Helper"
+      dir = ENV['dir'] || "#{Time.now.to_s.gsub(/ /, '_')}"
+      filter = ENV['filter_tables']
+
+      SerializationHelper::Base.new(MtwtfssYamlDb::Anonymizer::Helper, filter).dump_to_dir "#{Rails.root}/db/#{dir}"
+    end
+  end
+end

data/mtwtfss_yaml_db_anonymizer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mtwtfss_yaml_db/anonymizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas Hollstegge"]
+  gem.description   = %q{Dumps anonymized database contents to .yml files}
+  gem.summary       = %q{A database dumper with anonymization}
+  gem.homepage      = "https://github.com/mtwtfss/yaml_db_anonymizer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mtwtfss_yaml_db_anonymizer"
+  gem.require_paths = ["lib"]
+  gem.version       = MtwtfssYamlDb::Anonymizer::VERSION
+
+  gem.add_dependency 'mtwtfss_yaml_db'
+
+  gem.add_development_dependency 'rspec', '~> 2.11.0'
+  gem.add_development_dependency 'rails', '~> 3.2'
+  gem.add_development_dependency 'guard-rspec', '~> 1.1.0'
+  gem.add_development_dependency 'guard-spork', '~> 1.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+  require 'rspec'
+  require 'bundler/setup'
+
+end
+
+Spork.each_run do
+  require 'mtwtfss_yaml_db_anonymizer'
+
+end
+

data/spec/yaml_db/anonymizer_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe MtwtfssYamlDb::Anonymizer do
+  context 'definition' do
+    before do
+      MtwtfssYamlDb::Anonymizer.define do
+        table :mytable do
+          remove :a
+          replace :b, with: 0
+          replace :c, with: lambda { |val| "Anonymized #{val}" }
+          replace :d, with: lambda { "Anonymized value" }
+        end
+      end
+    end
+
+    it "should anonymize" do
+      MtwtfssYamlDb::Anonymizer.anonymize(:mytable, :a, "foo").should == nil
+    end
+
+    it "should anonymize with simple values" do
+      MtwtfssYamlDb::Anonymizer.anonymize(:mytable, :b, "foo").should == 0
+    end
+
+    it "should anonymize with blocks" do
+      MtwtfssYamlDb::Anonymizer.anonymize(:mytable, :c, "bar").should == "Anonymized bar"
+    end
+
+    it "should anonymize with blocks" do
+      MtwtfssYamlDb::Anonymizer.anonymize(:mytable, :d, "bar").should == "Anonymized value"
+    end
+  end
+
+  context 'export' do
+    before do
+      # Taken from yaml_db specs
+      silence_warnings { ActiveRecord::Base = mock('ActiveRecord::Base').as_null_object }
+      ActiveRecord::Base.stub(:connection).and_return(stub('connection').as_null_object)
+      ActiveRecord::Base.connection.stub!(:tables).and_return([ 'mytable', 'schema_info', 'schema_migrations' ])
+      ActiveRecord::Base.connection.stub!(:columns).with('mytable').and_return([ mock('a',:name => 'a', :type => :string), mock('b', :name => 'b', :type => :string) ])
+      ActiveRecord::Base.connection.stub!(:select_one).and_return({"count"=>"2"})
+      ActiveRecord::Base.connection.stub!(:select_all).and_return([ { 'a' => 1, 'b' => 2 }, { 'a' => 3, 'b' => 4 } ])
+      MtwtfssYamlDb::Utils.stub!(:quote_table).with('mytable').and_return('mytable')
+    end
+
+    before(:each) do
+      # Taken from yaml_db specs
+      File.stub!(:new).with('dump.yml', 'w').and_return(StringIO.new)
+      @io = StringIO.new
+    end
+
+    context 'tables' do
+      it 'dumps rails schema tables' do
+        MtwtfssYamlDb::Anonymizer::Dump.tables.should == %w(mytable schema_info schema_migrations)
+      end
+    end
+
+    context 'truncated' do
+      before do
+        MtwtfssYamlDb::Anonymizer.define do
+          table :mytable do
+            truncate
+          end
+        end
+      end
+
+      it 'should not export headers for truncated tables' do
+        MtwtfssYamlDb::Anonymizer::Dump.dump_table_columns(@io, 'mytable')
+        @io.rewind
+        @io.read.should == ""
+      end
+
+      it 'should not export records for truncated tables' do
+        MtwtfssYamlDb::Anonymizer::Dump.dump_table_records(@io, 'mytable')
+        @io.rewind
+        @io.read.should == ""
+      end
+    end
+
+    context 'anonymized' do
+      before do
+        MtwtfssYamlDb::Anonymizer.define do
+          table :mytable do
+            replace 'a', with: 0
+          end
+        end
+      end
+
+      it 'should anonymize the dump with the given schema' do
+        MtwtfssYamlDb::Anonymizer::Dump.dump_table_records(@io, 'mytable')
+        @io.rewind
+        @io.read.should == <<EOYAML
+  records: 
+  - - 0
+    - 2
+  - - 0
+    - 4
+EOYAML
+      end
+    end
+  end
+
+  context 'fallback' do
+    let(:io)    { double('io') }
+    let(:table) { double('table') }
+
+    before do
+      MtwtfssYamlDb::Anonymizer.definition = nil
+    end
+
+    it 'falls back to MtwtfssYamlDb::Dump.dump_table_records if definition is missing' do
+      MtwtfssYamlDb::Dump.should_receive(:dump_table_records).with(io, table)
+      MtwtfssYamlDb::Anonymizer::Dump.dump_table_records(io, table)
+    end
+
+    it 'falls back to MtwtfssYamlDb::Dump.dump_table_columns if definition is missing' do
+      MtwtfssYamlDb::Dump.should_receive(:dump_table_columns).with(io, table)
+      MtwtfssYamlDb::Anonymizer::Dump.dump_table_columns(io, table)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mtwtfss_yaml_db_anonymizer
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- Thomas Hollstegge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mtwtfss_yaml_db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Dumps anonymized database contents to .yml files
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mtwtfss_yaml_db/anonymizer.rb
+- lib/mtwtfss_yaml_db/anonymizer/dump.rb
+- lib/mtwtfss_yaml_db/anonymizer/helper.rb
+- lib/mtwtfss_yaml_db/anonymizer/railtie.rb
+- lib/mtwtfss_yaml_db/anonymizer/version.rb
+- lib/mtwtfss_yaml_db_anonymizer.rb
+- lib/tasks/mtwtfss_yaml_db_anonymizer.rake
+- mtwtfss_yaml_db_anonymizer.gemspec
+- spec/spec_helper.rb
+- spec/yaml_db/anonymizer_spec.rb
+homepage: https://github.com/mtwtfss/yaml_db_anonymizer
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A database dumper with anonymization
+test_files:
+- spec/spec_helper.rb
+- spec/yaml_db/anonymizer_spec.rb
+has_rdoc: