https://github.com/ruby/base64
Support for encoding and decoding binary data using a Base64 representation
https://github.com/ruby/base64
ruby
Last synced: 8 months ago
JSON representation
Support for encoding and decoding binary data using a Base64 representation
- Host: GitHub
- URL: https://github.com/ruby/base64
- Owner: ruby
- License: other
- Created: 2020-05-22T10:28:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T05:52:24.000Z (9 months ago)
- Last Synced: 2025-03-31T15:18:38.071Z (9 months ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 72.3 KB
- Stars: 23
- Watchers: 33
- Forks: 22
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Base64
The Base64 module provides for the encoding (`#encode64`, `#strict_encode64`,
`#urlsafe_encode64`) and decoding (`#decode64`, `#strict_decode64`,
`#urlsafe_decode64`) of binary data using a Base64 representation.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'base64'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install base64
## Usage
A simple encoding and decoding.
```ruby
require "base64"
enc = Base64.encode64('Send reinforcements')
# -> "U2VuZCByZWluZm9yY2VtZW50cw==\n"
plain = Base64.decode64(enc)
# -> "Send reinforcements"
```
The purpose of using base64 to encode data is that it translates any
binary data into purely printable characters.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ruby/base64.