request_params_validation 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f4e626d56a20e8b4c032af6e86dfe8c9e7672b9458bf191484aaae246f3b532
-  data.tar.gz: 40242b2a079e6e97d25bcd3c3550b559db6c16c97ad50946ea637b55005f07e9
+  metadata.gz: f2da127cb8628fa7c0221d15f700d3c39f5d82b5d7a30ae124d5c1030737d209
+  data.tar.gz: 7e2b59f422d2a4935780461b996215434141bc69acbb285eca77b2577478964e
 SHA512:
-  metadata.gz: 6a262fdc8d5246854d13441268288dd149e7e5cfd7c62c37ea38b586ff2c33401c07f556f121567494ae7499f6ae03ad6e3a427d20a6e284555bffd5d587e3ca
-  data.tar.gz: 64bd8e7fc3579bd796a48e660e2b3d227ca2e2a4f0d9a65850df72eb9bdba7346c6fba49af50111a141bcb844fbf93962aa93591f52509665e6b83be5b5c0e08
+  metadata.gz: 8db92bdc350444e67d507462febf68db7db4b7455ee968a3a60f9e5f72b69ef82daf07552ba30daa31d59b06adca0d07b40b10016c96fea56117068287d5ab71
+  data.tar.gz: 3365ec2c482c5489763dee97c8363669647113da4ba58b64f6e2979073b2f0689a8bdc8d174fc70ae8151131cd3fa2d31d3aa6a9977648e9684c037736d99204

data/README.md

@@ -115,7 +115,7 @@ Then, we will need to create the definition for the `users` resource:
 
 RequestParamsValidation.define do |users|
   users.action :create do |create|
-    users.request do |params|
+    create.request do |params|
       params.required :user, type: :hash do |user|
         user.required :first_name, type: :string
         user.required :last_name, type: :string
@@ -456,6 +456,31 @@ end
 This means that in the request params you expect a valid email value in the key `email_address`,
 but in your controller you will access with the key `email`.
 
+### Dependent Parameters
+If you want to receive and validate a parameter only if another one is given, you can use
+the `is_given` option.
+
+```ruby
+some_action.request do |params|
+  params.optional :label, type: :string
+  params.required :description, type: :string, if_given: :label
+  #...
+  params.required :card_type, inclusion: %w(credit_card debit_card)
+  params.required :ccv, if_given: { card_type: lambda { |value| value == 'credit_card' } }
+end
+```
+
+On the example above, the param `description` will be only validated if the param `label` is present.
+RequestParamsValidation will use the method `blank?` to check that. On the other hand, the param
+`ccv` will only be validated if the param `type_card` is equal to the string `credit_card`.
+
+Notice that if the global option `filter_params` is set to `true` (default behaviour), then the
+dependent parameters will be filtered from the `params object` if they haven't beeen validated.
+This way we make sure to only receive those parameters that have been validated against our request
+definitions.
+
+Be aware that if you rename a param, then you should use the new name in the `if_given` option.
+
 ---
 ### NOTE
 

data/lib/request_params_validation/definitions/param.rb

@@ -4,7 +4,7 @@ module RequestParamsValidation
   module Definitions
     class Param
       attr_reader :key, :required, :allow_blank, :type, :rename_as, :transform, :decimal_precision,
-                  :inclusion, :length, :value, :format, :custom_validation, :elements
+                  :inclusion, :length, :value, :format, :custom_validation, :if_given, :elements
 
       def initialize(options, &block)
         @key         = options[:key]
@@ -23,6 +23,7 @@ module RequestParamsValidation
         @value              = build_value_option(options[:value])
         @format             = build_format_option(options[:format])
         @custom_validation  = build_custom_validation_option(options[:validate])
+        @if_given           = build_if_given_option(options[:if_given])
 
         @elements           = build_elements_option(options[:elements], &block)
         @sub_definition     = build_sub_definition(&block)
@@ -82,6 +83,18 @@ module RequestParamsValidation
         !!@transform
       end
 
+      def skip?(request_params)
+        return false unless @if_given
+
+        if_given_param_value = request_params[@if_given.param]
+
+        if @if_given.function
+          !@if_given.function.call(if_given_param_value)
+        else
+          if_given_param_value.blank?
+        end
+      end
+
       private
 
       def build_inclusion_option(inclusion)
@@ -158,6 +171,20 @@ module RequestParamsValidation
         Struct.new(:function, :message).new(function, message)
       end
 
+      def build_if_given_option(if_given)
+        case if_given
+        when String, Symbol
+          param = if_given.to_sym
+        when Hash
+          param = if_given.first.try(:first)
+          function = if_given.first.try(:last)
+        end
+
+        return unless param
+
+        Struct.new(:param, :function).new(param, function)
+      end
+
       def build_elements_option(elements, &block)
         return unless @type == Params::ARRAY_TYPE
 

data/lib/request_params_validation/params.rb

@@ -7,6 +7,8 @@ module RequestParamsValidation
 
     def self.validate!(definition, params)
       definition.each do |param_definition|
+        next if param_definition.skip?(params)
+
         validate_and_coerce_param(param_definition, params)
       end
 
@@ -42,6 +44,8 @@ module RequestParamsValidation
       return params if definition.empty?
 
       params_keys = definition.map do |param_definition|
+        next if param_definition.skip?(params)
+
         key = param_definition.rename? ? param_definition.rename_as : param_definition.key
 
         if param_definition.sub_definition

data/lib/request_params_validation/version.rb

@@ -1,3 +1,3 @@
 module RequestParamsValidation
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_params_validation
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Felipe Fava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Validates rails request params