/base45

Ruby gem to decode / encode in base 45

Primary LanguageRubyMIT LicenseMIT

Base45

The Base45 module provides for the encoding (#encode) and decoding (#decode) of binary data using a Base45 representation.

Installation

Add this line to your application's Gemfile:

gem 'base45'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install base45

Usage

Some simple encoding and decoding:

require "base45"

encoded = Base45.encode("The truth is out there")
# => "8UADZCKWE8%EG7D+EDN448%ES44+8DZKE"

decoded = Base45.decode(encoded)
# => "The truth is out there"

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wattswing/base45.

License

The gem is available as open source under the terms of the MIT License.

Resources used