Skip to content
Use transit format in your Rails application
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

transit-rails

Travis status

Use transit format in your Rails application, with minimal friction.

Works wherever transit-ruby does.

Installation

Add this line to your application's Gemfile:

gem 'transit-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install transit-rails

Usage

In a Rails controller:

def index
  @posts = Post.all
  respond_to do |format|
    format.html
    format.transit { render transit: @posts }
  end
end

The renderer can take a verbose flag, which when true will output transit in the json-verbose format.

def index
  @posts = Post.all
  render transit: @posts, verbose: true
end

You can supply any custom handlers using the handlers option.

def index
  @person = Person.new
  render transit: @person, handlers: { Person => PersonHandler.new }
end

Read more about custom handlers on the transit-ruby README.

Contributing

  1. Fork it ( https://github.com/jgdavey/transit-rails/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
Something went wrong with that request. Please try again.