Project

desponders

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A stack of light-weight responders tailored to JSON APIs
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.3
>= 0
~> 2.14.0

Runtime

< 5, >= 3.2
 Project Readme

Build Status Code Climate

Desponders

A stack of light-weight responders tailored to JSON APIs.

Installation

Add this line to your application's Gemfile:

gem 'desponders', '~> 0.2.0'

Usage

Create a ActionController::Responder subclass and include the responders that you would like to use:

class CustomResponder < ActionController::Responder
  include Desponders::ErrorResponder
  include Desponders::RESTResponder
  include Desponders::PaginatedResponder
  include Desponders::HTTPCacheResponder
end

Include the responder in any controllers serving API requests:

class ApplicationController < ActionController::Base
  self.responder = CustomResponder
end

PaginatedResponder

The PaginatedResponder automatically applies pagination to every multi resource GET request. In order for pagination to work your resources must respond to a paginate method that accepts page and per_page options.

Thanks

The implementation of Desponders is based on the fanstastic work of Jose Valim and his contributions to Responders within Rails, as well as Plataformatec's Responders gem.

Contributing

  1. Fork it
  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 new Pull Request