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 r.is "foo" do response['Content-Type'] = 'application/json' {'a'=>'b'}.to_json end
and DRY it up:
plugin :json r.root do [1, 2, 3] end r.is "foo" do {'a'=>'b'} end
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'
Classes and Modules
Public Class methods
Set the classes to automatically convert to JSON, and the serializer to use.
# File lib/roda/plugins/json.rb 57 def self.configure(app, opts=OPTS) 58 app.plugin :custom_block_results 59 60 classes = opts[:classes] || [Array, Hash] 61 app.opts[:json_result_classes] ||= [] 62 app.opts[:json_result_classes] += classes 63 classes = app.opts[:json_result_classes] 64 classes.uniq! 65 classes.freeze 66 classes.each do |klass| 67 app.opts[:custom_block_results][klass] = :handle_json_block_result 68 end 69 70 app.opts[:json_result_serializer] = opts[:serializer] || app.opts[:json_result_serializer] || app.opts[:json_serializer] || :to_json.to_proc 71 72 app.opts[:json_result_include_request] = opts[:include_request] if opts.has_key?(:include_request) 73 74 app.opts[:json_result_content_type] = opts[:content_type] || 'application/json'.freeze 75 end