https://github.com/dasch/sinatra-avro

A Sinatra plugin that allows encoding requests and responses using Avro
https://github.com/dasch/sinatra-avro

Last synced: about 19 hours ago
JSON representation

A Sinatra plugin that allows encoding requests and responses using Avro

• Host: GitHub
• URL: https://github.com/dasch/sinatra-avro
• Owner: dasch
• License: mit
• Created: 2015-02-27T23:24:20.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-15T10:56:30.000Z (over 9 years ago)
• Last Synced: 2024-04-24T18:11:04.956Z (8 months ago)
• Language: Ruby
• Size: 176 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this 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:

```ruby

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`:

```json

{

  "name": "person",

  "type": "record",

  "fields": [

    { "name": "name", "type": "string" },

    { "name": "age", "type": "long" }

  ]

}

```

You can now respond with Avro encoded data:

```ruby

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

```ruby

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