Zero::ParamsProcessor

# declare aop callback which provided by zpp
before_action :process_params!

# if you defined following spec in your api doc
# `query!` bang method means it's a required param
query! :time, Date, gt: '2018/1/1'.to_date, permit: true

# THEN in your controller action, you will get:
# 1. param validate: require, Date type and range
# 2. value convert: JSON has not Date type, you must
#	   do a convert from String, but it can do it for you:
params[:time] = params[:time].to_date # after some format checkers
# 3. set instance variable: allows you get the param by `@time`
#      instead of `params[:time]`
# 4. permitted: if you defined a lot of params with `permit: true`,
#      you will be allowed to get them by calling `permitted`, like:
Book.create(permitted)

Add this line to your application's Gemfile:

gem 'zero-params_processor'#, github: 'zhandao/zero-params_processor'

And then execute:

$ bundle

before_action { process_params_by :validate!, :convert }
before_action :process_params! # all actions will be called

Action options: %i[ validate! convert set_instance_var set_permitted ]

Check each input parameter based on OpenApi.docs (Zero-Rails_OpenApi's cattr), it will raise ParamsProcessor::ValidationFailed < StandardError if check failed.

Note: If it did not find the corresponding open-api information in OpenApi.docs, the check will be skipped.

Convert each input parameter to the specified type base on OpenApi.docs. For example:

We declare the parameter like this:

query :price, Integer
query :like,  Boolean
query :time,  Date

In case params[:price] == '1', the Converter will make it to be 1 (a Integer).
In case params[:like] == 0, the Converter will make it to be false.
In case params[:time] == '2018/1/1', the Converter will make it to be Date.new(2018, 1, 1).

Let (converted) input parameters to be instance variables of the current controller.

After that, you can access the params value like: @price, @like, @time.

Permit the parameters that having permit: true attribute in OpenApi.docs. Like this:

query :price, Integer, pmt: true

Then, the :price parameter will be permitted.

After this action, you can access all the permitted input via method permitted. Like:

Book.create(permitted)

Note: not_permit: true attribute will lead to a slightly different behavior: All the parameter that are not having not_permit: true will be permitted. For example:

query :price, Integer
query :like, Boolean, npmt: true
query :time, Date

Then, the :price and :time will be permitted.

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zero-params_processor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Zero::ParamsProcessor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.