0.0
No commit activity in last 3 years
No release in over 3 years
A Sinatra plugin that allows encoding requests and responses using Apache Avro
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 10.0
~> 3.2.0

Runtime

~> 0.2.0
 Project Readme

Sinatra::Avro

A Sinatra plugin that allows encoding requests and responses using Apache Avro.

Installation

Add this line to your application's Gemfile:

gem 'sinatra-avro'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sinatra-avro

Usage

Add an Avro schema to e.g. schemas/person.avsc:

{
  "name": "person",
  "type": "record",
  "fields": [
    { "name": "name", "type": "string" },
    { "name": "age", "type": "long" }
  ]
}

You can now respond with Avro encoded data:

get '/' do
  # Will use the schema defined by `./schemas/person.avsc`.
  avro({ "name" => "Jane", "age" => 42 }, schema_name: "person")
end

You can configure which directory to look up schema files from using

set :avro_schema_dir, "some/other/dir"

Contributing

  1. Fork it ( https://github.com/[my-github-username]/sinatra-avro/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