No release in over 3 years
Low commit activity in last 3 years
Ruby utility for obfuscating strings, with no dependencies.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0
~> 3.0
 Project Readme

StringObfuscator CircleCI

Ruby utility for obfuscating strings, with no dependencies.

Example usage - obfuscating by length from the right:

StringObfuscator.obfuscate("Hello? It's me, Danilo", length: 6, from: :right)
=> "Hello? It's me, ******"

Example usage - obfuscating by percent, custom obfuscation character:

StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 50, obfuscation_character: "#")
=> "########### me, Danilo"

Example usage - custom obfuscation value:

StringObfuscator.obfuscate("Hello? It's me, Danilo", percent: 20, obfuscation_value: "[obfuscated]")
=> "[obfuscated]? It's me, Danilo"

Example usage - min obfuscated length:

StringObfuscator.obfuscate("Hello world", percent: 25, min_obfuscated_length: 8)
=> "********rld"

Installation

Add this line to your application's Gemfile:

gem 'string-obfuscator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install string-obfuscator

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wealthsimple/string-obfuscator.