https://github.com/mnc/maskdump
maskdump is a ruby gem to dump database and mask its personal data.
https://github.com/mnc/maskdump
Last synced: 11 months ago
JSON representation
maskdump is a ruby gem to dump database and mask its personal data.
- Host: GitHub
- URL: https://github.com/mnc/maskdump
- Owner: mnc
- License: mit
- Created: 2017-08-16T22:49:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T14:49:30.000Z (over 3 years ago)
- Last Synced: 2023-03-05T15:03:56.516Z (over 3 years ago)
- Language: Ruby
- Homepage:
- Size: 31.3 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# maskdump
*this is develop version*
maskdump provides tools to help you dump data from RDBMS and mask their specified columns.
You can use default masking method for masking data.
For example, tel, email, blackout and so on. Otherwise, you program for custom masking method.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'maskdump'
```
And then execute:
```
$ bundle
```
Or install it yourself as:
```
$ gem install maskdump
```
## Usage
1. define mask target column and database settings
```yml
# tables.yml
---
user: root
host: localhost
port: 3306
db:
name: sample_development
rdbms: mysql
tables:
- name: owners
columns:
- name: phone_number
method: tel # Data Masking Method
- name: users
columns:
- name: mail
method: email # Data Masking Method
```
2. execute maskdump command
```
$ maskdump tables.yml --dist sample -p xxxxx
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/maskdump. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).