module Roda::RodaPlugins::Json

  1. lib/roda/plugins/json.rb

The json plugin allows match blocks to return arrays or hashes, and have those arrays or hashes be converted to json which is used as the response body. It also sets the response content type to application/json. So you can take code like:

r.root do
  response['Content-Type'] = 'application/json'
  [1, 2, 3].to_json
end "foo" do
  response['Content-Type'] = 'application/json'

and DRY it up:

plugin :json
r.root do
  [1, 2, 3]
end "foo" do

By default, only arrays and hashes are handled, but you can specifically set the allowed classes to json by adding using the :classes option when loading the plugin:

plugin :json, :classes=>[Array, Hash, Sequel::Model]

By default objects are serialized with to_json, but you can pass in a custom serializer, which can be any object that responds to +call(object)+.

plugin :json, :serializer=>proc{|o| o.to_json(root: true)}

If you need the request information during serialization, such as HTTP headers or query parameters, you can pass in the :include_request option, which will pass in the request object as the second argument when calling the serializer.

plugin :json, :include_request=>true, :serializer=>proc{|o, request| ...}

The default content-type is 'application/json', but you can change that using the :content_type option:

plugin :json, :content_type=>'application/xml'


Public Class

  1. configure


DEFAULT_CONTENT_TYPE = 'application/json'.freeze  
DEFAULT_SERIALIZER = :to_json.to_proc  
OPTS = {}.freeze  

Public Class methods

configure (app, opts=OPTS)

Set the classes to automatically convert to JSON, and the serializer to use.

[show source]
# File lib/roda/plugins/json.rb, line 62
def self.configure(app, opts=OPTS)
  classes = opts[:classes] || [Array, Hash]
  app.opts[:json_result_classes] ||= []
  app.opts[:json_result_classes] += classes

  app.opts[:json_result_serializer] = opts[:serializer] || app.opts[:json_result_serializer] || DEFAULT_SERIALIZER

  app.opts[:json_result_include_request] = opts[:include_request] || app.opts[:json_result_include_request]

  app.opts[:json_result_content_type] = opts[:content_type] || 'application/json'.freeze