jpbuilder
A small extension to the excellent jbuilder library that outputs JSONP using a specified callback.
Installation
Add this line to your application's Gemfile:
gem 'jpbuilder'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jpbuilder
Usage
Install in your gem file and then just create templates with the extension
.jpbuilder
and use the normal Jbuilder DSL. The template will use the
callback as specified in the "callback" url parameter. If none is provided then
the regular JSON format will be returned.
Setting a default callback
You can set a global callback to be used in the absence of a callback listed in
the params
hash, by setting the JPbuilderHandler.default_callback
variable
in an initializer:
# config/initializers/jpbuilder.rb
JPbuilderHandler.default_callback = "myJsCallback"
To disable the auto callback simply set JPbuilderHandler.default_callback
to
null
or ""
.
# config/initializers/jpbuilder.rb
JPbuilderHandler.default_callback = nil
Note: nil
is the default value.
TODO
- Find a decent way to test.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request