Giter Club home page Giter Club logo

obfuscator's Introduction

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:

# 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
  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

  overwrite :email_address do
    format :email
  end
end

Or as a Rake task:

rake obfuscator:scrub[User] COLUMNS=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

  • Reflect on model validations to ensure generated data is valid
  • Make DSL more flexible about taking both arrays and hashes of columns with options
  • Move away from iterating through batches of records and calling update_attributes by constructing an update_all

obfuscator's People

Contributors

bryanwoods avatar

Stargazers

Valentin avatar Rogério Oliveira avatar  avatar Igor Alexandrov avatar Ian Mouton avatar  avatar

Watchers

Tony Marschall avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.