Project

avrocado

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Wraps the avro.jar with a straightforward API for serializing/deserializing
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.8
~> 2.12
~> 10.4.2
~> 3.3.0
~> 0.32
 Project Readme

Avrocado

Build Status Code Climate Coverage Status Gem Version

Wraps the Java avro.jar with a more straightforward API.

Installation

Because this library is a wrapper around the avro.jar it must be run with JRuby. Use the ruby installer (ie. ruby-build) of your choice before continuing.

Add this line to your application's Gemfile:

gem 'avrocado'

And then execute:

$ bundle

Or install it yourself as:

$ gem install avrocado

Usage

Serialize a hash to a byte array:

message = {
  to: 'bill',
  from: 'jim',
  message: 'hello world'
}

bytes = Avrocado::Serializer.serialize(message)

Deserialize an encoded message:

Avrocado::Deserializer.deserialize(bytes)

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/connexio-labs/avrocado/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request