zero-params_processor 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ec687b8215056d4e4197b1c0a2e11425e00460d84c6e204b93f756f4ece1b4e
-  data.tar.gz: a494c7786f8390b2f254c6b9bffffe6d303447aa859d390c1a25beb18052dc20
+  metadata.gz: 6af3afb1c845aebdf43201ba56f36de36be89e14b0708ae574a108070f650088
+  data.tar.gz: 84420bb307c78be64a6951134fed5c5984ada904253268cedcff32f8be0818c0
 SHA512:
-  metadata.gz: a0e1025443eee3ba5a337dd7107c7621c716679cd790f7944ac25f1d6f3ad8ce1979debd97d4cae212bbbc61aac6e42f6e7b2e4cc86844364e66565d93b126d6
-  data.tar.gz: c50e9d5f36bccb010b1b23eea0557523df285a40fbcb9bd24accc2057fe67efa3308e924d480cba011979c4e57f36fccd8aef842076927222402728892f6e4b8
+  metadata.gz: 1e3e9190fab8af960cf6fd430875d3555df90c47b8c7779268f49a120f6806f6bd1d9643d4b43048f1dfa9b7b4681e1ee72b2be3b8d2f150ba497a024891468b
+  data.tar.gz: 602f1c9906ca11618cb2a5dfd544a33b127add743d6ffd05a8ed197de8da539869e7f446bd396c32796860c67bb149052c74c31d99a3e06b8b15de7dd3a450ab

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 .idea/*
+Gemfile.lock

data/.travis.yml

@@ -3,9 +3,6 @@ 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

data/lib/params_processor.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
+require 'open_api/router'
+
 require 'params_processor/version'
 require 'params_processor/validate'
 require 'params_processor/type_convert'
 
 module ParamsProcessor
+  cattr_accessor :docs
+
   private
 
   def process_params_by(*actions)
@@ -12,6 +18,7 @@ module ParamsProcessor
       _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)
+      _group_params(param_doc)     if param_doc.group
       param_doc
     end
     _set_permitted(pdocs) if actions.index(:set_permitted)
@@ -24,7 +31,7 @@ module ParamsProcessor
 
   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
+    error_class = "Error::#{controller_name.camelize}".constantize rescue nil
     Validate.(input, based_on: param_doc, raise: error_class)
   end
 
@@ -39,14 +46,20 @@ module ParamsProcessor
   end
 
   def _set_instance_var(param_doc)
-    key = param_doc.real_name
-    return if (value = params[key]).nil?
+    return if (value = params[(key = param_doc.real_name)]).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
 
+  def _group_params(param_doc)
+    return if (value = params[(key = param_doc.real_name.to_sym)]).nil?
+
+    instance_variable_get("@#{param_doc.group}")&.merge!(key => value) ||
+        instance_variable_set("@#{param_doc.group}", key => value)
+  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.
@@ -57,7 +70,7 @@ module ParamsProcessor
   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
+    model_instance = model.find_by(id: value) || Error::Api.not_found! # TODO HACK
     instance_variable_set("@#{whos_id}", model_instance)
   end
 
@@ -65,26 +78,25 @@ module ParamsProcessor
     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
+    # @permitted = params.permit(*keys) TODO
+    @permitted = params.slice(*keys).to_unsafe_h.symbolize_keys
   end
 
   def permitted; @permitted end
 
   # TODO: performance
   def params_doc
-    current_api = OpenApi.routes_index[self.class.controller_path]
-    return [ ] unless current_api
+    return [ ] unless (current_api = OpenApi.routes_index[self.class.controller_path])
 
-    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]
+    self.docs ||= DocConverter.new(OpenApi.docs)
+    @route_path = OpenApi::Router.find_path_httpverb_by(self.class.controller_path, action_name).first
+    path_doc = 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
+    def info; { code: 400, msg: "#{Config.prefix}" + message, http_status: :bad_request }; end
   end
 end

data/lib/params_processor/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/all'
 
 module ParamsProcessor

data/lib/params_processor/doc_converter.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 require 'active_support/hash_with_indifferent_access'
 
 module ParamsProcessor
   class DocConverter < HashWithIndifferentAccess
-    cattr_accessor :docs
-
     def initialize(inhert_hash = { })
       super(inhert_hash)
       convert
@@ -34,7 +34,8 @@ module ParamsProcessor
 
             # 将 form-data 提到 parameters，方便统一访问接口
             # 在 param ref 处理之前上提，使后续可以一并将 properties 中的 schma 进行处理
-            form = action_doc[:requestBody]&.[](:content)&.[]('multipart/form-data')
+            form = action_doc[:requestBody]&.[](:content)
+            form = form['multipart/form-data'] || form['application/json'] if form # TODO
             if form.present?
               required = form[:schema][:required] || [ ]
               permit = form[:schema][:permit] ? true : false

data/lib/params_processor/param_doc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/hash_with_indifferent_access'
 
 module ParamsProcessor
@@ -49,12 +51,13 @@ module ParamsProcessor
       one_of:      %i[ schema oneOf      ],
       any_of:      %i[ schema anyOf      ],
       not_be:      %i[ schema not        ],
-      is:          %i[ schema is         ],
+      is:          %i[ schema is_a       ],
       dft:         %i[ schema default    ],
       as:          %i[ schema as         ],
       items:       %i[ schema items      ],
       props:       %i[ schema properties ],
       blankable:   %i[ schema blankable  ],
+      group:       %i[ schema group      ],
       permit?:     %i[ schema permit     ],
       not_permit?: %i[ schema not_permit ],
     }.each do |method, path|

data/lib/params_processor/type_convert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ParamsProcessor
   class TypeConvert
     class << self
@@ -34,16 +36,19 @@ module ParamsProcessor
         when 'date'      then parse_time(Date)
         when 'date-time' then parse_time(DateTime)
         when 'base64'    then @input # Base64.strict_decode64(@input)
+        when 'binary'    then @input
         else @input.to_s
         end
       end
 
       def array
-        @input
+        return @input unless @input.is_a?(String)
+        @input = MultiJson.load(@input)
       end
 
       def object
-        @input
+        return @input unless @input.is_a?(String)
+        @input = MultiJson.load(@input)
       end
 
       # combined TODO

data/lib/params_processor/validate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'params_processor/config'
 require 'params_processor/doc_converter'
@@ -21,7 +23,7 @@ module ParamsProcessor
         @doc = param_doc
         check (if_is_passed do
           check if_is_present
-          break if @input.nil?# || (@doc.blankable != false && @input.blank? && @input != false)
+          next 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
@@ -48,12 +50,13 @@ module ParamsProcessor
         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 'array'   then @input.is_a?(Array) || (@input.is_a?(String) && @input['['])
+        when 'object'  then @input.is_a?(ActionController::Parameters) || @input.is_a?(Hash) ||
+                            (@input.is_a?(String) && @input['{'] && @input['}'])
         when 'number'  then _number_type
         when 'string'  then _string_type
         else true # TODO
-        end or [:wrong_type, @doc.format.to_s]
+        end or [:wrong_type, (@doc.format || @doc.type).to_s]
       end
 
       def _number_type
@@ -154,6 +157,7 @@ module ParamsProcessor
 
         _doc, _input = @doc, @input
         items_doc = ParamDoc.new name: @doc.name, schema: @doc.items
+        @input = MultiJson.load(@input) if @input.is_a?(String)
         @input.each do |input|
           Validate.(input, based_on: items_doc, raise: @error_class)
         end
@@ -164,11 +168,12 @@ module ParamsProcessor
         return if @doc.props.blank?
 
         _doc = @doc
+        hash = @input.is_a?(String) ? MultiJson.load(@input) : @input
         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)
+          Validate.(hash[name] || hash[name.to_sym], based_on: prop_doc, raise: @error_class)
           @input = _input
         end
         @doc = _doc
@@ -176,13 +181,14 @@ module ParamsProcessor
 
       def check msg
         return unless msg.is_a? Array
+        @error_class.params_error! if @error_class.respond_to? :params_error
         @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
+        msg = " `#{@doc.name.to_sym}` " + msg
         raise ValidationFailed, test_msg || msg
       end
 

data/lib/params_processor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ParamsProcessor
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
 end

data/zero-params_processor.gemspec

@@ -22,12 +22,13 @@ Gem::Specification.new do |spec|
   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 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
 
-  spec.add_runtime_dependency 'zero-rails_openapi', '>= 1.5.2'
+  spec.add_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'

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: zero-params_processor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-18 00:00:00.000000000 Z
+date: 2020-09-20 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
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +135,6 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -169,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Process parameters base on OpenApi3 JSON documentation

data/Gemfile.lock

@@ -1,157 +0,0 @@
-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