Seaboar is a pure Ruby implementation of a CBOR encoder / decoder. CBOR is Concise Binary Object Representation, a schemaless, efficient alternative to JSON. CBOR is defined by RFC 7049.
Seaboar is a just-for-fun project of the author. If you're looking for a Ruby CBOR implementation for use in production, you're probably in the wrong place. Check out the cbor-ruby project for a much faster and more complete implementation.
Seaboar's design constraints/goals are as follows:
- Pure Ruby (no C or Java extensions)
- No (runtime) dependencies
- Encoding support on-par with common Ruby JSON libraries
Note that 'performance' is not on that list. If you're looking for good performance, you should probably use another implementation. Note also that there are some CBOR features (particularly on the encoding side) that will not be implemented in Seaboar. These include support for encoding to half-width floats, (though decoding them is supported), as well as support for encoding streaming strings, arrays, and hashes (although again, decoding these objects is supported).
Add this line to your application's Gemfile:
gem 'seaboar'
And then execute:
$ bundle
Or install it yourself as:
$ gem install seaboar
TODO: Write usage instructions here
Please read the design constraints above, and make sure your contributions fit within the goals of this project. If so, just follow the standard GitHub procedure for contributing:
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Please ensure any functional or bugfix changes you make are covered by tests.