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'

This plugin depends on the custom_block_results plugin, and therefore does not support treating String, FalseClass, or NilClass values as JSON.


Public Class

  1. configure

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
60 def self.configure(app, opts=OPTS)
61   app.plugin :custom_block_results
63   classes = opts[:classes] || [Array, Hash]
64   app.opts[:json_result_classes] ||= []
65   app.opts[:json_result_classes] += classes
66   classes = app.opts[:json_result_classes]
67   classes.uniq!
68   classes.freeze
69   classes.each do |klass|
70     app.opts[:custom_block_results][klass] = :handle_json_block_result
71   end
73   app.opts[:json_result_serializer] = opts[:serializer] || app.opts[:json_result_serializer] || app.opts[:json_serializer] || :to_json.to_proc
75   app.opts[:json_result_include_request] = opts[:include_request] if opts.has_key?(:include_request)
77   app.opts[:json_result_content_type] = opts[:content_type] || 'application/json'.freeze
78 end