obfuscator 0.0.1

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem "activerecord"
+gem "faker"
+
+group :test do
+  gem "rspec"
+  gem "sqlite3"
+  gem "pry"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Bryan Woods
+
+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,71 @@
+# Obfuscator
+
+Working from a production database dump can often be helpful for
+debugging strange errors and edge cases, but having potentially
+sensitive user data on a development machine is a dangerous liability.
+
+Obfuscator provides a clean, friendly API for obfuscating sensitive
+columns in your Ruby on Rails application's models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'obfuscator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install obfuscator
+
+## Usage
+
+As a Ruby program:
+
+```ruby
+# Without a format, Obfuscator will fill all of the given columns
+# with dummy data based on the column's SQL type
+Obfuscator.scrub! "Message" do
+  # Would generate dummy sentences, paragraphs, and timestamps accordingly
+  overwrite :title, :body, :created_at
+end
+
+# Currently any format from Faker::Internet
+# (https://github.com/stympy/faker/blob/master/lib/faker/internet.rb)
+# should work for when the generated data needs to be in a specific format
+Obfuscator.scrub! "User" do
+  overwrite :login do
+    format :user_name
+  end
+end
+
+Obfuscator.scrub! "Subscriber" do
+  overwrite :email_address do
+    format :email
+  end
+end
+```
+
+Or as a Rake task (TODO: Not finished yet):
+
+    rake obfuscator:scrub["User", ["login","email"]]
+
+## 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
+
+## TODO
+
+* Get Rake task fully working
+* Move away from iterating through all records and calling
+  update_attributes. Better: finding in batches. Best: Generating a
+  giant update_all.
+* Definite jankiness with the Dsl (especially that you can't pass
+  multiple overwrite/format blocks in one parent block currently)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/obfuscator/dsl.rb

@@ -0,0 +1,47 @@
+module Obfuscator
+  module Dsl
+    module ClassMethods
+      def scrub!(model, &block)
+        instance_eval(&block)
+
+        obfuscator = Obfuscator::Generic.new
+
+        obfuscator.scrub!(model, columns)
+      end
+
+      def overwrite(*columns, &block)
+        if block_given?
+          @columns = columns
+
+          return instance_eval(&block)
+        end
+
+        if columns.length == 1
+          @columns.push(columns.first)
+        else
+          @columns.push(columns)
+        end
+      end
+
+      def columns
+        if @columns.is_a?(Array)
+          @columns.flatten.uniq
+        else
+          @columns
+        end
+      end
+
+      def format(format)
+        @columns = { columns.first => format }
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.module_eval do
+        @columns = []
+      end
+    end
+  end
+end

data/lib/obfuscator/generic.rb

@@ -0,0 +1,85 @@
+module Obfuscator
+  class Generic
+    class UnkownObfuscationTypeError < StandardError; end
+
+    attr_accessor :model, :columns
+
+    def scrub!(model_name = "User", columns = [])
+      @model = model_name.singularize.constantize
+
+      if columns.is_a?(Hash)
+        store_types_from_column_values(columns)
+        @columns = columns.keys
+      else
+        @columns = columns
+      end
+
+      return unless @columns.any? and @columns.map!(&:to_s)
+
+      scrub_all_records!
+    end
+
+    private
+
+    def model_columns_contain_given?
+      (@model.columns_hash.keys | @columns).any?
+    end
+
+    def store_types_from_column_values(columns)
+      columns.each do |key, value|
+        instance_variable_set("@#{key}_type", value)
+      end
+    end
+
+    def columns_with_obfuscated_values_hash
+      result_hash = {}
+
+      @columns.each do |column|
+        type = instance_variable_get("@#{column}_type")
+
+        if type.present?
+          if Faker::Internet.respond_to?(type)
+            result_hash[column] = Faker::Internet.send(type)
+            @result = result_hash
+          else
+            raise UnkownObfuscationTypeError.new("[#{type}] is an unknown type")
+          end
+        else
+          derive_value_from_type(@model.columns_hash[column].type)
+
+          @result = Hash[@columns.map { |key| [key, @value] }]
+        end
+      end
+
+      @result
+    end
+
+    def derive_value_from_type(sql_type)
+      default = Faker::Lorem.sentence
+
+      case sql_type
+      when :string
+        @value = default
+      when :text
+        @value = Faker::Lorem.paragraph
+      when :integer
+        @value = Obfuscator::Utilities.random_number(10)
+      when :boolean
+        @value = Obfuscator::Utilities.random_boolean
+      when :datetime
+        @value = Obfuscator::Utilities.random_date
+      else
+        @value = default
+      end
+    end
+
+    def scrub_all_records!
+      @model.all.each do |m|
+        attributes = model_columns_contain_given? ?
+          columns_with_obfuscated_values_hash : {}
+
+        m.update_attributes(attributes)
+      end
+    end
+  end
+end

data/lib/obfuscator/railtie.rb

@@ -0,0 +1,9 @@
+module Obfuscator
+  class Railtie < Rails::Railtie
+    railtie_name :obfuscator
+
+    rake_tasks do
+      load "tasks/obfuscator.rake"
+    end
+  end
+end

data/lib/obfuscator/utilities.rb

@@ -0,0 +1,19 @@
+module Obfuscator
+  class Utilities
+    class << self
+      def random_number(limit)
+        rand(limit)
+      end
+
+      def random_boolean
+        [true, false].sample
+      end
+
+      def random_date
+        month, day, year = rand(12) + 1, rand(28) + 1, (1980..2012).to_a.sample
+
+        Date.parse("#{day}/#{month}/#{year}")
+      end
+    end
+  end
+end

data/lib/obfuscator/version.rb

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

data/lib/obfuscator.rb

@@ -0,0 +1,9 @@
+require "obfuscator/version"
+require "obfuscator/utilities"
+require "obfuscator/generic"
+require "obfuscator/dsl"
+require "obfuscator/railtie" if defined?(Rails)
+
+module Obfuscator
+  include Dsl
+end

data/lib/tasks/obfuscator.rake

@@ -0,0 +1,12 @@
+namespace :obfuscator do
+  desc "Scrub sensitive data in provided model's columns"
+
+  task :scrub, [:model, :columns] => :environment do |task, arguments|
+    model   = arguments[:model]
+    columns = arguments[:columns]
+
+    obfuscator = Obfuscator::Generic.new
+
+    obfuscator.scrub!(model, columns)
+  end
+end

data/obfuscator.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/obfuscator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryan Woods"]
+  gem.email         = ["bryanwoods4e@gmail.com"]
+  gem.description   = "A clean, friendly API for obfuscating slightly sensitive data from a Rails application"
+  gem.summary       = "Obfuscate provides an easy way to quickly overwrite slightly sensitive data from a Rails application for debugging or developing off a database dump"
+  gem.homepage      = "http://github.com/bryanwoods/obfuscator"
+  gem.licenses      = ["MIT"]
+
+  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          = "obfuscator"
+  gem.require_paths = ["lib"]
+  gem.version       = Obfuscator::VERSION
+  gem.add_dependency "activerecord"
+  gem.add_dependency "faker"
+end

data/spec/obfuscator/dsl_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Obfuscator::Dsl do
+  before(:each) do
+    Obfuscator::Dsl.instance_variable_set(:@columns, [])
+
+    User.create!(
+      login: "login",
+      email: "email@example.com",
+      password: "pword",
+      birthdate: 20.years.ago
+    )
+
+    User.create!(
+      login: "login2",
+      email: "email2@example.com",
+      password: "pword"
+    )
+  end
+
+  describe ".scrub!" do
+    it "Scrubs the model with the columns given in a block" do
+      Obfuscator::Generic.any_instance.should_receive(:scrub!).
+        with("User", [:login, :email])
+
+      Obfuscator.scrub!("User") do
+        overwrite :login
+        overwrite :email
+      end
+    end
+  end
+
+  describe ".overwrite" do
+    context "given one column" do
+      it "stores the given column in an array" do
+        Obfuscator.overwrite(:login)
+        Obfuscator.overwrite(:email)
+        Obfuscator.overwrite(:birth_date)
+
+        Obfuscator.send(:columns).should == [:login, :email, :birth_date]
+      end
+
+      context "given more than one column" do
+        it "stores the given columns in an array" do
+          Obfuscator.overwrite(:login, :email, :birth_date)
+
+          Obfuscator.send(:columns).should == [:login, :email, :birth_date]
+        end
+      end
+    end
+  end
+
+  describe ".format" do
+    it "sets the type of the column to the given format" do
+      Obfuscator::Generic.any_instance.should_receive(:scrub!).
+        with("User", { login: :user_name })
+
+      Obfuscator.scrub!("User") do
+        overwrite :login do
+          format :user_name
+        end
+      end
+    end
+  end
+end

data/spec/obfuscator/generic_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe Obfuscator::Generic do
+  before(:each) do
+    User.create!(
+      login: "login",
+      email: "email@example.com",
+      password: "pword",
+      birthdate: 20.years.ago
+    )
+
+    User.create!(
+      login: "login2",
+      email: "email2@example.com",
+      password: "pword"
+    )
+  end
+
+  let(:obfuscator) { Obfuscator::Generic.new }
+  let(:first_user) { User.first }
+  let(:last_user)  { User.last }
+
+  describe ".scrub!" do
+    context "given a model" do
+      it "assigns @model to the given model name" do
+        obfuscator.scrub!("Person")
+        obfuscator.model.should == Person
+      end
+    end
+
+    context "not given a model" do
+      it "defaults to 'User'" do
+        obfuscator.scrub!
+        obfuscator.model.should == User
+      end
+    end
+
+    context "given an array of columns" do
+      it "updates the given columns for each record" do
+        first_user.login.should == "login"
+        last_user.login.should == "login2"
+
+        obfuscator.scrub!("User", [:login])
+
+        first_user.reload.login.should_not == "login"
+        last_user.reload.login.should_not == "login2"
+      end
+
+      it "obfuscates the given columns with dummy data" do
+        Faker::Lorem.should_receive(:sentence).any_number_of_times.
+          and_return("The quick brown fox")
+
+        obfuscator.scrub!("User", [:email])
+
+        first_user.reload.email.should == "The quick brown fox"
+      end
+
+      context "given a text column" do
+        let(:paragraph) do
+          "A slightly long section of text, one that would perhaps be too
+          long to be stored as a string and might therefore be better stored
+          as a text blizzle bluzzle."
+        end
+
+        it "obfuscates the column with a dummy paragraph" do
+          Faker::Lorem.should_receive(:paragraph).any_number_of_times.
+            and_return(paragraph)
+
+          obfuscator.scrub!("User", [:bio])
+
+          last_user.reload.bio.should == paragraph
+        end
+      end
+
+      context "given an integer column" do
+        it "obfuscates the column with a dummy number" do
+          Obfuscator::Utilities.should_receive(:random_number).
+            any_number_of_times.with(10)
+
+          obfuscator.scrub!("User", [:id])
+        end
+      end
+
+      context "given a boolean column" do
+        let!(:person) { Person.create!(good_looking: true) }
+
+        it "obfuscates the column with a random true or false" do
+          Obfuscator::Utilities.should_receive(:random_boolean).
+            and_return(false)
+
+          obfuscator.scrub!("Person", [:good_looking])
+
+          person.reload.good_looking.should be_false
+        end
+      end
+
+      context "given a datetime column" do
+        it "obfuscates the column with a random date" do
+          Obfuscator::Utilities.stub(:random_date).any_number_of_times.
+            and_return(1.year.ago.beginning_of_day)
+
+          obfuscator.scrub!("User", [:birthdate])
+
+          first_user.reload.birthdate.should == 1.year.ago.beginning_of_day
+        end
+      end
+
+      context "given a string column" do
+        context "not given a type parameter" do
+          it "obfuscates the column with a dummy sentence" do
+            Faker::Lorem.should_receive(:sentence).any_number_of_times.
+              and_return("The quick brown fox")
+
+            obfuscator.scrub!("User", [:login])
+
+            first_user.reload.login.should == "The quick brown fox"
+          end
+
+          it "generates unique dummy sentences" do
+            obfuscator.scrub!("User", [:login])
+
+            first_user.reload.login.should_not == last_user.reload.login
+          end
+        end
+
+        context "given a type parameter" do
+          context "given valid type parameters" do
+            it "generates a plausible user_name" do
+              Faker::Internet.should_receive(:user_name).
+                any_number_of_times.
+                and_return("bryanawesome")
+
+              Faker::Internet.should_receive(:email).
+                any_number_of_times.
+                and_return("bryanawesome@example.com")
+
+              obfuscator.scrub!("User", { login: :user_name, email: :email })
+            end
+
+            context "given an invalid type parameter" do
+              it "raises an UnkownObfuscationTypeError" do
+                expect { obfuscator.scrub!("User", { login: :invalid_type }) }.
+                  to raise_error(
+                    Obfuscator::Generic::UnkownObfuscationTypeError
+                  )
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context "not given an array of columns" do
+      it "returns nil" do
+        obfuscator.scrub!("User").should be_nil
+      end
+    end
+  end
+end

data/spec/obfuscator/utilities_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Obfuscator::Utilities do
+  describe ".random_number" do
+    it "returns a random number" do
+      0.upto(9).to_a.should include(Obfuscator::Utilities.random_number(10))
+    end
+  end
+
+  describe ".random_boolean" do
+    it "randomly returns true or false" do
+      [true, false].should include(Obfuscator::Utilities.random_boolean)
+    end
+  end
+
+  describe ".random_date" do
+    it "returns a random date" do
+      Obfuscator::Utilities.random_date.should be_kind_of(Date)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'sqlite3'
+require 'active_record'
+require 'faker'
+require 'pry'
+
+require 'obfuscator'
+
+RSpec.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.string :email
+    t.string :login
+    t.string :password
+    t.text   :bio
+    t.datetime :birthdate
+  end
+
+  create_table :people, force: true do |t|
+    t.string :email
+    t.string :login
+    t.string :password
+    t.boolean :good_looking
+  end
+end
+
+class User < ActiveRecord::Base; end
+class Person < ActiveRecord::Base; end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: obfuscator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70183958259900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183958259900
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &70183958259480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183958259480
+description: A clean, friendly API for obfuscating slightly sensitive data from a
+  Rails application
+email:
+- bryanwoods4e@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/obfuscator.rb
+- lib/obfuscator/dsl.rb
+- lib/obfuscator/generic.rb
+- lib/obfuscator/railtie.rb
+- lib/obfuscator/utilities.rb
+- lib/obfuscator/version.rb
+- lib/tasks/obfuscator.rake
+- obfuscator.gemspec
+- spec/obfuscator/dsl_spec.rb
+- spec/obfuscator/generic_spec.rb
+- spec/obfuscator/utilities_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/bryanwoods/obfuscator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Obfuscate provides an easy way to quickly overwrite slightly sensitive data
+  from a Rails application for debugging or developing off a database dump
+test_files:
+- spec/obfuscator/dsl_spec.rb
+- spec/obfuscator/generic_spec.rb
+- spec/obfuscator/utilities_spec.rb
+- spec/spec_helper.rb