zero-params_processor 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ec687b8215056d4e4197b1c0a2e11425e00460d84c6e204b93f756f4ece1b4e
+  data.tar.gz: a494c7786f8390b2f254c6b9bffffe6d303447aa859d390c1a25beb18052dc20
+SHA512:
+  metadata.gz: a0e1025443eee3ba5a337dd7107c7621c716679cd790f7944ac25f1d6f3ad8ce1979debd97d4cae212bbbc61aac6e42f6e7b2e4cc86844364e66565d93b126d6
+  data.tar.gz: c50e9d5f36bccb010b1b23eea0557523df285a40fbcb9bd24accc2057fe67efa3308e924d480cba011979c4e57f36fccd8aef842076927222402728892f6e4b8

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,91 @@
+# This is the configuration used to check the rubocop source code.
+
+#require: rbocop/cop/internal_affairs
+
+AllCops:
+  # Include common Ruby source files.
+  Exclude:
+    - 'spec/**/*'
+    - 'zero-params_processor.gemspec'
+    - 'Gemfile'
+    - 'bin/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 5.1
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 1200
+
+Metrics/ClassLength:
+  Max: 1200
+
+Metrics/MethodLength:
+  Max: 1200
+
+Metrics/ModuleLength:
+  Max: 1200
+
+Metrics/BlockLength:
+  Max: 1200
+
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceInsideBrackets:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Lint/UnneededSplatExpansion:
+  Enabled: false
+
+#Style/StringLiterals:
+#  Enabled: true
+#  EnforcedStyle: double_quotes
+
+
+
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# False positives
+Layout/EmptyLineBetweenDefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler
+env:
+  global:
+    - CC_TEST_REPORTER_ID=5f2477af6b38bd4db35abe49930cbae98e867cb3163b2da1a465176b2f0a361c
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zero-params_processor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,157 @@
+PATH
+  remote: .
+  specs:
+    zero-params_processor (0.4.0)
+      activesupport (>= 3)
+      multi_json
+      rails (>= 3)
+      zero-rails_openapi (>= 1.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    zero-rails_openapi (1.5.2)
+      activesupport (>= 3)
+      rails (>= 3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+  zero-params_processor!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 zhandao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Zero::ParamsProcessor
+
+[![Build Status](https://travis-ci.org/zhandao/zero-params_processor.svg?branch=test)](https://travis-ci.org/zhandao/zero-params_processor)
+[![Maintainability](https://api.codeclimate.com/v1/badges/4d2fd3c04abf75a1158b/maintainability)](https://codeclimate.com/github/zhandao/zero-params_processor/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/4d2fd3c04abf75a1158b/test_coverage)](https://codeclimate.com/github/zhandao/zero-params_processor/test_coverage)
+
+```ruby
+# 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)
+```
+
+## ONLY FOR the RAILS app that using Zero-Rails_OpenApi, like [Zero-Rails](https://github.com/zhandao/zero-rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zero-params_processor'#, github: 'zhandao/zero-params_processor'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+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 ]
+
+### validate!
+
+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
+
+Convert each input parameter to the specified type base on `OpenApi.docs`. For example:
+
+We declare the parameter like this:
+```ruby
+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)`.  
+
+### set_instance_var
+
+Let (converted) input parameters to be instance variables of the current controller.
+
+After that, you can access the params value like: `@price`, `@like`, `@time`.
+
+### set_permitted
+
+Permit the parameters that having `permit: true` attribute in `OpenApi.docs`. Like this:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+query :price, Integer
+query :like, Boolean, npmt: true
+query :time, Date
+```
+
+Then, the :price and :time will be permitted.
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+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](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Zero::ParamsProcessor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zero-params_processor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'zero/params_processor'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/params_processor.rb

@@ -0,0 +1,90 @@
+require 'params_processor/version'
+require 'params_processor/validate'
+require 'params_processor/type_convert'
+
+module ParamsProcessor
+  private
+
+  def process_params_by(*actions)
+    return if params_doc.blank?
+    pdocs = params_doc.map do |doc|
+      param_doc = ParamDoc.new(doc) # TODO: performance
+      _validate_param!(param_doc)  if actions.index(:validate!)
+      _convert_param(param_doc)    if actions.index(:convert)
+      _set_instance_var(param_doc) if actions.index(:set_instance_var)
+      param_doc
+    end
+    _set_permitted(pdocs) if actions.index(:set_permitted)
+  end
+
+  def process_params!
+    actions = Config.actions || %i[ validate! convert set_instance_var set_permitted ]
+    process_params_by *actions
+  end
+
+  def _validate_param!(param_doc)
+    input = param_doc.in == 'header' ? request.headers[param_doc.name.to_s] : params[param_doc.name.to_sym]
+    error_class = "#{controller_name.camelize}Error".constantize rescue nil
+    Validate.(input, based_on: param_doc, raise: error_class)
+  end
+
+  def _convert_param(param_doc)
+    name = param_doc.name.to_sym
+    params[name] = param_doc.dft if params[name].nil? && !param_doc.dft.nil?
+    return if params[name].nil?
+
+    params[name] = TypeConvert.(params[name], based_on: param_doc)
+    # mapping param key
+    params[param_doc.as] = params.delete(name) if param_doc.as.present?
+  end
+
+  def _set_instance_var(param_doc)
+    key = param_doc.real_name
+    return if (value = params[key]).nil?
+
+    instance_variable_set("@#{key}", value)
+    _permit_hash_and_array(value) if param_doc.permit?
+    _auto_find_by_id(key, value) if @route_path.match?(/\{#{key}\}/) # e.g. "/examples/{id}"
+  end
+
+  # If params[:data] == [{..}, {..}], each `{..}` in the array
+  #   is an instance of ActionController::Parameters.
+  # So, if :data is allowed to permit, it's values should also permit.
+  def _permit_hash_and_array(value)
+    value.map!(&:permit!) if value.is_a?(Array) && value.first.is_a?(ActionController::Parameters)
+  end
+
+  def _auto_find_by_id(key, value)
+    whos_id = (key.to_sym == :id ? controller_name : key.to_s.sub('_id', '')).singularize
+    model = whos_id.camelize.constantize rescue return
+    model_instance = model.find_by(id: value) || self.class.error_cls.not_found! # TODO HACK
+    instance_variable_set("@#{whos_id}", model_instance)
+  end
+
+  def _set_permitted(params_docs)
+    exist_not_permit = params_docs.map(&:not_permit?).any?(&:present?)
+    keys = params_docs.map { |p| p.doced_permit? ? p.real_name : nil }.compact
+    keys = exist_not_permit ? params_docs.map(&:real_name) - keys : keys
+    @permitted = params.permit(*keys)
+    # @permitted = params.slice(*keys).to_unsafe_h
+  end
+
+  def permitted; @permitted end
+
+  # TODO: performance
+  def params_doc
+    current_api = OpenApi.routes_index[self.class.controller_path]
+    return [ ] unless current_api
+
+    DocConverter.docs ||= DocConverter.new(OpenApi.docs)
+    @route_path = OpenApi::Generator.find_path_httpverb_by(self.class.controller_path, action_name).first
+    path_doc = DocConverter.docs[current_api][:paths][@route_path]
+    # nil check is for skipping this before_action when the action is not doced.
+    path_doc&.[](request.method.downcase)&.[](:parameters) || [ ]
+  end
+
+
+  class ValidationFailed < StandardError
+    def info; { code: 400, msg: "#{Config.prefix}".concat(message), http_status: :bad_request }; end
+  end
+end

data/lib/params_processor/config.rb

@@ -0,0 +1,61 @@
+require 'active_support/all'
+
+module ParamsProcessor
+  module Config
+    cattr_accessor :actions do
+      nil
+    end
+
+    cattr_accessor :strict_check do
+      false
+    end
+
+    cattr_accessor :prefix do
+      'parameter'
+    end
+
+    cattr_accessor :production_msg do
+      # 'validation failed'
+    end
+
+    cattr_accessor :not_passed do
+      'is required'
+    end
+
+    cattr_accessor :is_blank do
+      'should not be blank'
+    end
+
+    cattr_accessor :wrong_type do
+      'must be'
+    end
+
+    cattr_accessor :wrong_size do
+      'length must be(in)'
+    end
+
+    cattr_accessor :is_not_entity do
+      'must be'
+    end
+
+    cattr_accessor :not_in_allowable_values do
+      'must in'
+    end
+
+    cattr_accessor :not_match_pattern do
+      'must match'
+    end
+
+    cattr_accessor :out_of_range do
+      'is out of range'
+    end
+
+    cattr_accessor :wrong_combined_type do
+      'must be'
+    end
+
+    cattr_accessor :test do
+      false
+    end
+  end
+end

data/lib/params_processor/doc_converter.rb

@@ -0,0 +1,76 @@
+require 'active_support/hash_with_indifferent_access'
+
+module ParamsProcessor
+  class DocConverter < HashWithIndifferentAccess
+    cattr_accessor :docs
+
+    def initialize(inhert_hash = { })
+      super(inhert_hash)
+      convert
+    end
+
+    def fill_with_ref(who, ref_to)
+      return unless who.key? '$ref'
+      ref_name = who.delete('$ref').split('/').last
+      who.merge! @api_components.fetch(ref_to).fetch(ref_name)
+    end
+
+    # TODO: refactor
+    def convert
+      return if blank?
+      self.each do |_api, api_doc|
+        @api_components = api_doc[:components]
+        api_doc[:paths].each do |_path, path_doc|
+          path_doc.each do |_method, action_doc|
+            # 将 Reference Obj 填充进来
+            # body ref
+            request_body = action_doc[:requestBody]
+            fill_with_ref request_body, :requestBodies if request_body.present?
+            request_body&.[](:content)&.each do |_media, media_doc|
+              media_doc.each do |mtype, mtype_doc|
+                fill_with_ref mtype_doc, :schemas if mtype == 'schema'
+              end
+            end
+
+            # 将 form-data 提到 parameters，方便统一访问接口
+            # 在 param ref 处理之前上提，使后续可以一并将 properties 中的 schma 进行处理
+            form = action_doc[:requestBody]&.[](:content)&.[]('multipart/form-data')
+            if form.present?
+              required = form[:schema][:required] || [ ]
+              permit = form[:schema][:permit] ? true : false
+              form[:schema][:properties]&.each do |name, prop_schema|
+                (action_doc[:parameters] ||= [ ]) << {
+                    'name' => name,
+                    'in' => 'form',
+                    'required' => required.include?(name),
+                    'schema' => prop_schema.reverse_merge!(permit: permit),
+                }
+              end
+            end
+
+
+            # param ref
+            action_doc[:parameters]&.each do |param|
+              fill_with_ref param, :parameters
+
+              # schema ref
+              # TODO: Support nested scanning
+              fill_with_ref param[:schema], :schemas if param[:schema].present?
+            end
+
+
+            # response ref
+            action_doc[:responses]&.each do |_resp, resp_doc|
+              fill_with_ref resp_doc, :responses
+              resp_doc&.[](:content)&.each do |_media, media_doc|
+                media_doc.each do |_mtype, mtype_doc|
+                  fill_with_ref mtype_doc, :schemas
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/params_processor/param_doc.rb

@@ -0,0 +1,65 @@
+require 'active_support/hash_with_indifferent_access'
+
+module ParamsProcessor
+  class ParamDoc < HashWithIndifferentAccess
+    # Interfaces for directly taking the processed info what we focus on.
+    def range
+      return if (schema.keys & %w[ minimum maximum ]).blank?
+      {
+          min: schema[:minimum] || -Float::INFINITY,
+          max: schema[:maximum] || Float::INFINITY,
+          should_neq_min?: schema[:exclusiveMinimum] || false,
+          should_neq_max?: schema[:exclusiveMaximum] || false
+      }
+    end
+
+    def size
+      return if (schema.keys & %w[ minItems maxItems minLength maxLength ]).blank?
+      size = if type.in? %w[ array object ]
+               [schema[:minItems], schema[:maxItems]]
+             else
+               [schema[:minLength], schema[:maxLength]]
+             end
+      { min: size[0] || 0, max: size[1] || Float::INFINITY }
+    end
+
+    def combined
+      { all_of: all_of, one_of: one_of, any_of: any_of, not: not_be }.keep_if { |_k, v| !v.nil? }
+    end
+
+    def combined?; combined.present? end
+
+    def combined_modes; combined.keys end
+
+    def real_name; as || name end
+
+    def doced_permit?; permit? || not_permit? end
+
+    { # INTERFACE_MAPPING
+      name:        %i[ name              ],
+      required:    %i[ required          ],
+      in:          %i[ in                ],
+      schema:      %i[ schema            ],
+      enum:        %i[ schema enum       ],
+      pattern:     %i[ schema pattern    ],
+      regexp:      %i[ schema pattern    ],
+      type:        %i[ schema type       ],
+      format:      %i[ schema format     ],
+      all_of:      %i[ schema allOf      ],
+      one_of:      %i[ schema oneOf      ],
+      any_of:      %i[ schema anyOf      ],
+      not_be:      %i[ schema not        ],
+      is:          %i[ schema is         ],
+      dft:         %i[ schema default    ],
+      as:          %i[ schema as         ],
+      items:       %i[ schema items      ],
+      props:       %i[ schema properties ],
+      blankable:   %i[ schema blankable  ],
+      permit?:     %i[ schema permit     ],
+      not_permit?: %i[ schema not_permit ],
+    }.each do |method, path|
+      define_method method do self.dig(*path) end
+    end
+    alias required? required
+  end
+end

data/lib/params_processor/type_convert.rb

@@ -0,0 +1,81 @@
+module ParamsProcessor
+  class TypeConvert
+    class << self
+      def call(input, based_on:)
+        @input = input
+        @doc = based_on
+        convert
+      end
+
+      # TODO: 循环和递归转换
+      def convert
+        send(@doc.type || @doc.combined_modes.first) # TODO
+      rescue NoMethodError
+        @input
+      end
+
+      # int32 / int64
+      def integer
+        @input.to_i
+      end
+
+      # float / double
+      def number
+        @input.to_f
+      end
+
+      def boolean
+        @input.to_s.in?(%w[ true 1 ]) ? true : false
+      end
+
+      # date / date-time / base64
+      def string
+        case @doc.format
+        when 'date'      then parse_time(Date)
+        when 'date-time' then parse_time(DateTime)
+        when 'base64'    then @input # Base64.strict_decode64(@input)
+        else @input.to_s
+        end
+      end
+
+      def array
+        @input
+      end
+
+      def object
+        @input
+      end
+
+      # combined TODO
+
+      def all_of
+        doc = ParamDoc.new name: @doc.name, schema: @doc.all_of.reduce({}, :merge)
+        TypeConvert.(@input, based_on: doc)
+      end
+
+      def one_of
+        doc = ParamDoc.new name: @doc.name, schema: @doc.all_of.reduce({}, :merge)
+        TypeConvert.(@input, based_on: doc)
+      end
+
+      def any_of
+        doc = ParamDoc.new name: @doc.name, schema: @doc.all_of.reduce({}, :merge)
+        TypeConvert.(@input, based_on: doc)
+      end
+
+      def not
+        @input
+      end
+
+      # helpers
+
+      def parse_time(cls)
+        if @doc.pattern
+          cls.send(:strptime, @input, @doc.pattern)
+        else
+          cls.send(:parse, @input)
+        end
+      end
+    end
+  end
+end

data/lib/params_processor/validate.rb

@@ -0,0 +1,198 @@
+require 'multi_json'
+require 'params_processor/config'
+require 'params_processor/doc_converter'
+require 'params_processor/param_doc'
+
+module ParamsProcessor
+  class Validate
+    class << self
+      def call(input, based_on:, raise: nil)
+        @error_class = raise
+        input(input).check! based_on
+      end
+
+      def input(input)
+        @input     = input
+        @str_input = input.to_s
+        self
+      end
+
+      def check!(param_doc)
+        @doc = param_doc
+        check (if_is_passed do
+          check if_is_present
+          break if @input.nil?# || (@doc.blankable != false && @input.blank? && @input != false)
+          check_combined_types         if @doc.combined?
+          check type                   if @doc.type
+          check size                   if @doc.size
+          check if_is_entity           if @doc.is
+          check if_in_allowable_values if @doc.enum
+          check if_match_pattern       if @doc.pattern
+          check if_is_in_range         if @doc.range
+          check_each_element           if @doc.type == 'array'
+          check_each_pair              if @doc.type == 'object'
+        end)
+      end
+
+      def if_is_passed(&block)
+        return [:not_passed, ''] if @doc.required && @input.nil?
+        self.instance_eval(&block) unless @input.nil?
+      end
+
+      def if_is_present
+        [:is_blank, ''] if @doc.blankable == false && @input.blank? && @input != false
+      end
+
+      # TODO: combined type
+      def type
+        case @doc.type
+        when 'integer' then @str_input.match?(/^-?\d*$/)
+        when 'boolean' then @str_input.in? %w[ true 1 false 0 ]
+        when 'array'   then @input.is_a? Array
+        when 'object'  then @input.is_a?(ActionController::Parameters) || @input.is_a?(Hash)
+        when 'number'  then _number_type
+        when 'string'  then _string_type
+        else true # TODO
+        end or [:wrong_type, @doc.format.to_s]
+      end
+
+      def _number_type
+        case @doc.format
+        when 'float'  then @str_input.match?(/^[-+]?\d*\.?\d+$/)
+        when 'double' then @str_input.match?(/^[-+]?\d*\.?\d+$/)
+        else true # TODO
+        end or [:wrong_type, @doc.format.to_s]
+      end
+
+      def _string_type
+        # return false unless @input.is_a? String
+        case @doc.format
+        when 'date'      then parse_time!(Date)
+        when 'date-time' then parse_time!(DateTime)
+        when 'base64'    then Base64.strict_decode64(@input)
+        when 'json'      then MultiJson.load(@input)
+        else Config.strict_check ? @input.is_a?(String) : true
+        end
+      rescue ArgumentError, MultiJson::ParseError
+        false
+      end
+
+      def size
+        if @doc.type.in? %w[ array object ]
+          @input.size >= @doc.size[:min] && @input.size <= @doc.size[:max]
+        else
+          @str_input.length >= @doc.size[:min] && @str_input.length <= @doc.size[:max]
+        end or [:wrong_size, @doc.size.values.join('..')]
+      end
+
+      def if_is_entity
+        case @doc.is
+        when 'email'; @str_input.match?(/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]{2,}\z/i)
+        else true # TODO
+        end or [:is_not_entity, @doc.is.to_s]
+      end
+
+      def if_in_allowable_values
+        case @doc.type
+        when 'integer' then @doc.enum.include?(@input.to_i)
+        else @doc.enum.map(&:to_s).include?(@str_input)
+        end or [:not_in_allowable_values, @doc.enum.to_s.delete('\"')]
+      end
+
+      def if_match_pattern
+        unless @str_input.match?(Regexp.new(@doc.pattern))
+          [:not_match_pattern, "/#{@doc.pattern}/"]
+        end
+      end
+
+      def if_is_in_range
+        rg = @doc.range
+        fmt = @doc.format.tr('-', '_').camelize.constantize if @doc.format&.match?('date')
+        min = fmt ? parse_time!(fmt, rg[:min] || '1-1-1') : rg[:min]
+        max = fmt ? parse_time!(fmt, rg[:max] || '9999-12-31') : rg[:max]
+        @input = fmt ? parse_time!(fmt, @input) : @input.to_f
+
+        left_op  = rg[:should_neq_min?] ? :< : :<=
+        right_op = rg[:should_neq_max?] ? :< : :<=
+        is_in_range = min&.send(left_op, @input)
+        is_in_range &= @input.send(right_op, max)
+        [:out_of_range, "#{min} #{left_op} x #{right_op} #{max}"] unless is_in_range
+      end
+
+      def check_combined_types
+        @doc.combined.each do |mode, schemas|
+          results = check_each_schema(schemas)
+
+          case mode
+          when :all_of then results.all?(&:present?)
+          when :one_of then results.count(true) == 1
+          when :any_of then results.include?(true)
+          when :not    then results.all?(&:blank?)
+          end or raise ValidationFailed, " `#{@doc.name.to_sym}` #{Config.wrong_combined_type} #{mode} the specified schemas."
+        end
+      end
+
+      def check_each_schema(schemas)
+        results = [ ]
+        strict_check = Config.strict_check.clone
+        _doc, Config.strict_check = @doc, true
+        schemas.each do |schema|
+          doc = ParamDoc.new name: @doc.name, schema: schema
+          begin
+            Validate.(@input, based_on: doc, raise: @error_class)
+            results << true
+          rescue ValidationFailed
+            results << false
+          end
+        end
+        @doc, Config.strict_check = _doc, strict_check
+        results
+      end
+
+      def check_each_element
+        return if @doc.items.blank?
+
+        _doc, _input = @doc, @input
+        items_doc = ParamDoc.new name: @doc.name, schema: @doc.items
+        @input.each do |input|
+          Validate.(input, based_on: items_doc, raise: @error_class)
+        end
+        @doc, @input = _doc, _input
+      end
+
+      def check_each_pair
+        return if @doc.props.blank?
+
+        _doc = @doc
+        required = (@doc[:schema][:required] || [ ]).map(&:to_s)
+        @doc.props.each do |name, schema|
+          prop_doc = ParamDoc.new name: name, required: required.include?(name), schema: schema
+          _input = @input
+          Validate.(@input[name] || @input[name.to_sym], based_on: prop_doc, raise: @error_class)
+          @input = _input
+        end
+        @doc = _doc
+      end
+
+      def check msg
+        return unless msg.is_a? Array
+        @error_class.send("#{@doc.name}_#{msg.first}!") if @error_class.respond_to? "#{@doc.name}_#{msg.first}!"
+        @error_class.send("#{msg.first}!") if @error_class.respond_to? msg.first
+        raise ValidationFailed, Config.production_msg if Config.production_msg.present?
+
+        test_msg = Config.send(msg.first) if Config.test
+        msg = "#{Config.send(msg.first)}#{' ' + msg.last if msg.last.present?}"
+        msg = " `#{@doc.name.to_sym}` " << msg
+        raise ValidationFailed, test_msg || msg
+      end
+
+      def parse_time!(cls, value = nil)
+        if @doc.pattern
+          cls.send(:strptime, value || @input, @doc.pattern)
+        else
+          cls.send(:parse, value || @input)
+        end
+      end
+    end
+  end
+end

data/lib/params_processor/version.rb

@@ -0,0 +1,3 @@
+module ParamsProcessor
+  VERSION = '0.4.0'
+end

data/zero-params_processor.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'params_processor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zero-params_processor'
+  spec.version       = ParamsProcessor::VERSION
+  spec.authors       = ['zhandao']
+  spec.email         = ['x@skippingcat.com']
+
+  spec.summary       = 'Process parameters base on OpenApi3 JSON documentation'
+  spec.description   = 'Process parameters base on OpenApi3 JSON documentation, such as: ' \
+                       'validation and type conversion'
+  spec.homepage      = 'https://github.com/zhandao/zero-params_processor'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16.a'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'zero-rails_openapi', '>= 1.5.2'
+  spec.add_runtime_dependency 'rails', '>= 3'
+  spec.add_runtime_dependency 'activesupport', '>= 3'
+  spec.add_runtime_dependency 'multi_json'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: zero-params_processor
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zero-rails_openapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Process parameters base on OpenApi3 JSON documentation, such as: validation
+  and type conversion'
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/params_processor.rb
+- lib/params_processor/config.rb
+- lib/params_processor/doc_converter.rb
+- lib/params_processor/param_doc.rb
+- lib/params_processor/type_convert.rb
+- lib/params_processor/validate.rb
+- lib/params_processor/version.rb
+- zero-params_processor.gemspec
+homepage: https://github.com/zhandao/zero-params_processor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Process parameters base on OpenApi3 JSON documentation
+test_files: []