scrubber 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+spec/test.db

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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.rdoc

@@ -0,0 +1,22 @@
+= scrubber
+
+Scrubber.perform do
+  scrub_table :users, :unless => proc {|user| user.email =~ /mydomain.com/i } do |user|
+    user.scrub :email, :set_to => "user[:id]@example.com"
+    user.scrub :credit_card_number, :set_to => ""
+  end
+end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "scrubber"
+    gem.summary = %Q{A DSL for scrubbing private data}
+    gem.description = %Q{Obfuscate your private data using a simple dsl}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/scrubber"
+    gem.authors = ["Dan Pickett"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scrubber #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/scrubber.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+
+[
+  'field_transform',
+  'job',
+  'worker'
+].each do |file|
+  require "scrubber/#{file}"
+end
+
+module Scrubber
+  def self.perform(&block)
+    worker = Scrubber::Worker.new
+    yield(worker)
+    worker.perform
+  end
+end

data/lib/scrubber/field_transform.rb

@@ -0,0 +1,28 @@
+module Scrubber
+  class FieldTransform
+    attr_reader :field, :set_to
+    def initialize(field, options = {})
+      @field = field.to_s
+      unless options.has_key?(:set_to)
+        raise "Please specify what you'd like to change the field #{field} to with a :set_to"
+      end
+      @set_to = options[:set_to]
+    end
+
+    def perform_on(record)
+      val = nil
+      if @set_to.is_a?(String)
+        val = interpolate_string_for(record)
+      else
+        val = @set_to
+      end
+
+      record.send("#{@field}=", val)
+    end
+
+    private
+    def interpolate_string_for(record)
+      @set_to.gsub(/\[\:([^\]]*)\]/){|s| record.send(s.gsub(/\[|\]|\:/, '')) }
+    end
+  end
+end

data/lib/scrubber/job.rb

@@ -0,0 +1,55 @@
+module Scrubber
+  class Job
+    attr_reader :table_name, :conditional_proc, :conditional_proc_type, :field_transforms
+    def initialize(table_name, options = {})
+      @table_name = table_name.to_s 
+      unless options.empty?
+        @conditional_proc_type = options.has_key?(:unless) ? :unless : :if
+        @conditional_proc      = options[:unless]
+        @field_transforms      = []
+      end
+    end
+
+    def scrub(field, options)
+      @field_transforms << Scrubber::FieldTransform.new(field, options) 
+    end
+
+    def perform
+      #turn off timestamps (we want to preserve original timestamps)
+      prior_setting = record_activerecord_timestamps(false)
+      table_class.find_in_batches do |batch|
+        batch.each do |record|
+          if self.conditional_proc_type == :unless
+            unless @conditional_proc.call(record)
+              perform_scrubs_for(record)
+            end
+          elsif self.conditional_proc_type == :if
+            if @conditional_proc.call(record)
+              perform_scrubs_for(record)
+            end
+          else
+            perform_scrubs_for(record)
+          end
+        end
+      end
+      #restore timestamping to prior state
+      record_activerecord_timestamps(prior_setting)
+    end
+
+    private
+    def perform_scrubs_for(record)
+      @field_transforms.each {|t| t.perform_on(record) }
+      record.save!
+    end
+
+    def table_class
+      @table_class ||= Kernel.const_get(@table_name.classify)
+    end
+
+    def record_activerecord_timestamps(shall_record)
+      prior_setting = table_class.record_timestamps
+      table_class.record_timestamps = shall_record
+      prior_setting
+    end
+  end
+end

data/lib/scrubber/worker.rb

@@ -0,0 +1,18 @@
+module Scrubber
+  class Worker
+    attr_reader :jobs
+
+    def initialize
+      @jobs = [] 
+    end
+
+    def scrub_table(table_name, options = {})
+      @jobs << Scrubber::Job.new(table_name, options)
+      yield(@jobs.last)
+    end
+
+    def perform
+      @jobs.each{|j| j.perform}
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "scrubbing" do
+  it 'should set the first users email to have an example.com domain' do
+    perform_scrub
+    User.first.email.should =~ /example.com/
+  end
+
+  it 'should not perform scrubbing on a mydomain.com email due to the unless proc' do
+    u = User.create! do |u|
+      u.first_name = "Davie"
+      u.last_name  = "Crocket"
+      u.login      = "racoon"
+      u.email      = "davie@mydomain.com"
+    end
+
+    perform_scrub
+
+    u.reload
+    u.email.should =~ /mydomain.com/
+  end
+
+  def perform_scrub
+    Scrubber.perform do |s|
+      s.scrub_table :users, :unless => proc {|user| user.email =~ /mydomain.com/i } do |user|
+        user.scrub :email, :set_to => "user[:id]@example.com"
+        user.scrub :last_name, :set_to => "blank"
+      end
+    end
+
+  end
+end

data/spec/models.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.string  :first_name
+      t.string  :last_name
+      t.string  :email
+      t.string  :login
+      t.timestamps
+    end
+  end
+end
+
+CreateSchema.suppress_messages { CreateSchema.migrate(:up) }
+
+class User < ActiveRecord::Base
+
+end
+
+User.destroy_all
+
+User.create! do |u|
+  u.first_name = "John"
+  u.last_name  = "Smith"
+  u.email      = "john@acme.com"
+  u.login      = "john"
+end
+
+User.create! do |u|
+  u.first_name = "Jane"
+  u.last_name  = "Doe"
+  u.email      = "jane@acme.com"
+  u.login      = "jane"
+end

data/spec/scrubber/field_transform_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Scrubber::FieldTransform do
+  before(:each) do
+    @field_name = :email
+    @transform  = Scrubber::FieldTransform.new(@field_name, :set_to => nil)
+  end
+
+  it 'should have a field' do
+    @transform.field.should eql(@field_name.to_s)
+  end
+
+  it 'should raise an error if I do not specify a set_to param' do
+    lambda { Scrubber::FieldTransform.new(@field_name) }.should raise_error
+  end
+end

data/spec/scrubber/job_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Scrubber::Job do
+  before(:each) do
+    @table_name = :users
+    @job = Scrubber::Job.new(@table_name, :unless => proc {|user| user.email != "farfig" })
+  end
+
+  it 'should have a table name' do
+    @job.table_name.should eql(@table_name.to_s)
+  end
+
+  it 'should have a conditional proc' do
+    @job.conditional_proc.should_not be_nil
+  end
+
+  it 'should have a conditional proc type of unless' do
+    @job.conditional_proc_type.should eql(:unless)
+  end
+
+  it 'should append to the list of field transforms when I specify a scrub' do
+    @job.scrub(:email, :set_to => nil)
+    @job.field_transforms.size.should eql(1)
+  end
+end

data/spec/scrubber/worker_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Scrubber::Worker do
+  before(:each) do
+    @worker = Scrubber::Worker.new
+    @worker.scrub_table :some_table do |t|
+
+    end
+  end
+
+  it 'should have a job' do
+    @worker.jobs.size.should eql(1)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'scrubber'
+require 'spec'
+require 'spec/autorun'
+
+require 'models'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: scrubber
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Obfuscate your private data using a simple dsl
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/scrubber.rb
+- lib/scrubber/field_transform.rb
+- lib/scrubber/job.rb
+- lib/scrubber/worker.rb
+- spec/integration_spec.rb
+- spec/models.rb
+- spec/scrubber/field_transform_spec.rb
+- spec/scrubber/job_spec.rb
+- spec/scrubber/worker_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/scrubber
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A DSL for scrubbing private data
+test_files: 
+- spec/integration_spec.rb
+- spec/models.rb
+- spec/scrubber/field_transform_spec.rb
+- spec/scrubber/job_spec.rb
+- spec/scrubber/worker_spec.rb
+- spec/spec_helper.rb