Base45

A module that can Encode/Decode a string in Base45.

See: https://datatracker.ietf.org/doc/rfc9285/

Usage

Base45::encode(bytes)

Encodes a string in Base45.

Item		Description
@param	[String] bytes	the string to be encoded
@return	[String]	a Base45-encoded string

require 'base45'

Base45::encode("Hello!!")  #=> "%69 VD92EX0"

Base45::decode(b45)

Decodes a Base45-encoded string.

Item		Description
@param	[String] b45	the Base45-encoded string to be decoded
@return	[String]	the decoded bytes, as a string

require 'base45'

Base45::decode("QED8WEX0")  #=> "ietf!"

Contributing

We require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Contributor Code of Conduct

This repository is subject to a Contributor Code of Conduct adapted from the Contributor Covenant, version 3.0, available at https://www.contributor-covenant.org/version/3/0/

Licence

This project is licensed under the ISC licence. See LICENSE for details

Copyright (c) 2022, Matthew Kerwin <matthew@kerwin.net.au>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.