request_params_validation 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ccaf41aab1f3773847d076043efb7c16dcac54d48e525a101791f35f4fc6000
-  data.tar.gz: 55b76ff4f3a8f1d6c433283b9e0962b28bd6dff76298672a0e92f9639019b57e
+  metadata.gz: f2da127cb8628fa7c0221d15f700d3c39f5d82b5d7a30ae124d5c1030737d209
+  data.tar.gz: 7e2b59f422d2a4935780461b996215434141bc69acbb285eca77b2577478964e
 SHA512:
-  metadata.gz: cc0c695d265475d49f9142c1da677dd67341d96332077ab72fda3eaa5857a373609350f8a73df6c6e466795a7d384fd8b542585d58b9f27050770168cd879e4a
-  data.tar.gz: 1f014823715f92ba77b6668753b382bb978ff881a3a228376595174a77aa832a573b3ad5e84cc398842acaf7eb05bbde16b413c3e7b9630135d2937064f4164d
+  metadata.gz: 8db92bdc350444e67d507462febf68db7db4b7455ee968a3a60f9e5f72b69ef82daf07552ba30daa31d59b06adca0d07b40b10016c96fea56117068287d5ab71
+  data.tar.gz: 3365ec2c482c5489763dee97c8363669647113da4ba58b64f6e2979073b2f0689a8bdc8d174fc70ae8151131cd3fa2d31d3aa6a9977648e9684c037736d99204

data/README.md

@@ -1,7 +1,9 @@
 # RequestParamsValidation
 _Request parameters validations, type coercion and filtering for Rails params_
 
+[![Gem Version](https://badge.fury.io/rb/request_params_validation.svg)](https://badge.fury.io/rb/request_params_validation)
 [![CircleCI](https://circleci.com/gh/felipefava/request_params_validation.svg?style=shield&circle-token=a404cb4fd87e219299caeb36e1685ab75d335b84)](https://circleci.com/gh/felipefava/request_params_validation)
+[![Codacy Quality Badge](https://api.codacy.com/project/badge/Grade/6ed6582228bd429a94dfabaa82071455)](https://www.codacy.com/manual/felipefava/request_params_validation?utm_source=github.com&utm_medium=referral&utm_content=felipefava/request_params_validation&utm_campaign=Badge_Grade)
 
 ## Introduction
 Validates the request params outside your controller logic in order to get a clean nice code, and
@@ -93,15 +95,15 @@ and `notify`:
 
 class UsersController < ApplicationController
   def create
-    ...
+    params # will have only the defined parameters
   end
 
   def notify
-    ...
+    params # will have only the defined parameters
   end
 
   def another_action
-    ...
+    params # will have whatever the user sends
   end
 end
 ```
@@ -113,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
@@ -179,15 +181,15 @@ end
 ### Types
 The `type` option specified the type of the parameter. The supported types are:
 
-1. hash
-2. array
-3. string
-4. integer
-5. decimal
-6. boolean
-7. date
-9. datetime
-9. email
+1.  hash
+2.  array
+3.  string
+4.  integer
+5.  decimal
+6.  boolean
+7.  date
+8.  datetime
+9.  email
 
 So if this option is present, the gem will validate that the value of the parameter matches with
 the specified type. And if it does, it will convert the value to the right type. This means that
@@ -282,10 +284,11 @@ will be converter to a Date object like  `Wed, 04 Oct 1995`.
 However, they are cases when you only want to accept a specific format for a date, like
 `"%Y-%m-%e"`. In this cases you have two options.
 
-1. Use the global configuration option `format.date`, so all date types must have the specified
-   format through all the requests. See [here](#configuration) all globals configuration
-   options.
-2. Specify the option `format: "%Y-%m-%e"` locally.
+1.  Use the global configuration option `format.date`, so all date types must have the specified
+    format through all the requests. See [here](#configuration) all globals configuration
+    options.
+
+2.  Specify the option `format: "%Y-%m-%e"` locally.
 
 You can perfectly use both approaches, but the second one will locally override the first one on
 that parameter validation.
@@ -398,8 +401,8 @@ the specified type.
 
 If you want to set a precision value to all `decimal` parameters, you can use the global
 configuration option `format.decimal_precision`. Keep in mind that if you set the `precision`
-option on a parameter, it will locally override the global configuration. See here for all
-globals configuration options.
+option on a parameter, it will locally override the global configuration. See [here](#configuration)
+for all globals configuration options.
 
 This option accepts an integer as value.
 
@@ -441,8 +444,45 @@ some_action.request do |params|
 end
 ```
 
+### Rename Parameters
+You can rename parameters using the `as` option.
+
+```ruby
+some_action.request do |params|
+  params.required :email_address, type: :email, as: :email
+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**
+### NOTE
 
 RequestParamsValidation will start validating the presence of the parameters. Then, if the value is
 not present and the parameter has a default value, it will assign that value and not execute any
@@ -450,8 +490,8 @@ further validation. Otherwise, it will validate the type, convert it to the righ
 continue with the others validations. So, all others validations will be executed with the parameter
 value already converter to the specified type, so keep in mind that at defining the validations.
 
-
 ## Errors & Messages
+
 For default, when a required parameter failed the presence validation, the exception
 `RequestParamsValidation::MissingParameterError` will be raised. If it failed for any of the others
 validations, the raised exception will be `RequestParamsValidation::InvalidParameterValueError`
@@ -502,17 +542,15 @@ an element of an array or not. If you **have specified the `message` option in t
 definition**, then the details will be that value, otherwise it will took a default value from
 the table below:
 
-
-| Failure                   | Default Message                                      |
-| ------------------------- | ---------------------------------------------------- |
-| Missing parameter         | N/A                                                  |
-| Invalid type              | - `Value should be a valid %{param_type}` <br> - `All elements of the array should be a valid %{type}` <br> If has `date` or `datetime` type with specified `format`: <br> &nbsp;&nbsp;&nbsp; - ` with the format %{format}` is added to the message |
-| Invalid inclusion         | - `Value should be in %{include_in}` <br> - `All elements values of the array should have be in %{include_in}` |
-| Invalid length            | - `Length should be greater or equal than %{min}` <br> - `Length should be less or equal than %{max}`  <br> - `Length should be equal to %{min/max}` </br> - `Length should be between %{min} and %{max}` <br> - `All elements of the array should have a length ...` |
-| Invalid value size        | - `Value should be greater or equal than %{min}` <br> - `Value should be less or equal than %{max}` <br> - `Value should be between %{min} and %{max}` <br> - `All elements of the array should have a value ...` |
-| Invalid format            | - `Value format is invalid` <br> - `An element of the array has an invalid format` |
-| Invalid custom validation | N/A                                                  |
-
+| Failure                   | Default Message                                                                                                                                                                                                                                                      |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Missing parameter         | N/A                                                                                                                                                                                                                                                                  |
+| Invalid type              | - `Value should be a valid %{param_type}` <br> - `All elements of the array should be a valid %{type}` <br> If has `date` or `datetime` type with specified `format`: <br> &nbsp;&nbsp;&nbsp; - ` with the format %{format}` is added to the message                 |
+| Invalid inclusion         | - `Value should be in %{include_in}` <br> - `All elements values of the array should be in %{include_in}`                                                                                                                                                            |
+| Invalid length            | - `Length should be greater or equal than %{min}` <br> - `Length should be less or equal than %{max}` <br> - `Length should be equal to %{min/max}` </br> - `Length should be between %{min} and %{max}` <br> - `All elements of the array should have a length ...` |
+| Invalid value size        | - `Value should be greater or equal than %{min}` <br> - `Value should be less or equal than %{max}` <br> - `Value should be between %{min} and %{max}` <br> - `All elements of the array should have a value ...`                                                    |
+| Invalid format            | - `Value format is invalid` <br> - `An element of the array has an invalid format`                                                                                                                                                                                   |
+| Invalid custom validation | N/A                                                                                                                                                                                                                                                                  |                                               |
 
 ### Custom Exceptions
 However, if the above is not enough for your app, and you need to fully customize the exceptions
@@ -537,21 +575,21 @@ please see [here](./examples/initializer.rb).
 ## Future Work
 In the near future the plan is to continue adding features to the gem. Next incoming changes
 could be:
-- Add doc generation from the definitions
-- Add representations for DRY definitions
-- Add more options to the actions definitions
-- Add handler for responses
+-   Add doc generation from the definitions
+-   Add representations for DRY definitions
+-   Add more options to the actions definitions
+-   Add handler for responses
 
 ## Acknowledgments
 This gem is strongly inspired in a Ruby framework named [Angus](https://github.com/moove-it/angus)
 developed by [Moove It](https://moove-it.com/)
 
 ## Contributing
-1. Fork it
-2. Create your feature branch (git checkout -b my-new-feature)
-3. Commit your changes (git commit -am 'Add some feature')
-4. Push to the branch (git push origin my-new-feature)
-5. Create a Pull Request
+1.  Fork it
+2.  Create your feature branch (git checkout -b my-new-feature)
+3.  Commit your changes (git commit -am 'Add some feature')
+4.  Push to the branch (git push origin my-new-feature)
+5.  Create a Pull Request
 
 ## License
 This software is released under the MIT license. See the MIT-LICENSE file for more info.

data/lib/request_params_validation/definitions/param.rb

@@ -1,17 +1,17 @@
 require 'request_params_validation/params'
-require 'request_params_validation/exceptions/definitions_errors'
 
 module RequestParamsValidation
   module Definitions
     class Param
-      attr_reader :key, :required, :allow_blank, :type, :transform, :decimal_precision,
-                  :inclusion, :length, :value, :format, :custom_validation, :elements
+      attr_reader :key, :required, :allow_blank, :type, :rename_as, :transform, :decimal_precision,
+                  :inclusion, :length, :value, :format, :custom_validation, :if_given, :elements
 
       def initialize(options, &block)
         @key         = options[:key]
         @required    = options[:required]
         @allow_blank = options[:allow_blank]
         @type        = options[:type].try(:to_sym)
+        @rename_as   = options[:as].try(:to_sym)
         @default     = options[:default]
 
         @transform          = options[:transform]
@@ -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)
@@ -74,6 +75,26 @@ module RequestParamsValidation
         !!@custom_validation
       end
 
+      def rename?
+        !!@rename_as
+      end
+
+      def transform?
+        !!@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)
@@ -150,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/engine.rb

@@ -6,12 +6,12 @@ module RequestParamsValidation
     isolate_namespace RequestParamsValidation
 
     initializer 'request_params_validation.load_definitions' do
-      RequestParamsValidation::Definitions.load_all
+      Definitions.load_all
     end
 
     initializer 'request_params_validation.add_helpers' do
       ActiveSupport.on_load :action_controller do
-        include RequestParamsValidation::Helpers
+        include Helpers
       end
     end
   end

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
 
@@ -16,8 +18,8 @@ module RequestParamsValidation
     def self.filter!(definition, params)
       extra_keys = [:controller, :action] # Keys added by Rails
 
-      filter_params(definition, params, extra_keys).tap do |params|
-        params.permit! if params.respond_to?(:permit!)
+      filter_params(definition, params, extra_keys).tap do |filtered_params|
+        filtered_params.permit! if filtered_params.respond_to?(:permit!)
       end
     end
 
@@ -26,8 +28,14 @@ module RequestParamsValidation
       value = params[key]
 
       value = Validator.new(param_definition, value).validate_and_coerce
+      value = Converter.apply_transformation(param_definition, value) if param_definition.transform?
 
-      params[key] = value
+      if param_definition.rename?
+        params.delete(key)
+        params[param_definition.rename_as] = value
+      else
+        params[key] = value
+      end
     end
     private_class_method :validate_and_coerce_param
 
@@ -36,7 +44,9 @@ module RequestParamsValidation
       return params if definition.empty?
 
       params_keys = definition.map do |param_definition|
-        key = param_definition.key
+        next if param_definition.skip?(params)
+
+        key = param_definition.rename? ? param_definition.rename_as : param_definition.key
 
         if param_definition.sub_definition
           filter_params(param_definition.sub_definition, params[key])

data/lib/request_params_validation/params/converter.rb

@@ -24,8 +24,6 @@ module RequestParamsValidation
       def self.apply_transformation(param, value)
         transform = param.transform
 
-        return value unless transform
-
         transform.respond_to?(:call) ? transform.call(value) : value.send(transform)
       end
     end

data/lib/request_params_validation/params/types/validations.rb

@@ -12,7 +12,7 @@ module RequestParamsValidation
           false
         end
 
-        def valid_string?(value)
+        def valid_string?(_value)
           true
         end
 

data/lib/request_params_validation/params/validator.rb

@@ -45,7 +45,7 @@ module RequestParamsValidation
         validate_format!            if param.validate_format?
         validate_custom_validation! if param.validate_custom_validation?
 
-        @value = Params::Converter.apply_transformation(param, value)
+        @value
       end
 
       private
@@ -57,7 +57,7 @@ module RequestParamsValidation
       end
 
       def iterate_hash
-        Params::validate!(param.sub_definition, value) # recursion for the sub_definition
+        Params.validate!(param.sub_definition, value) # recursion for the sub_definition
       end
 
       def raise_error(exception_type, options = {})

data/lib/request_params_validation/params/validators/presence.rb

@@ -5,7 +5,7 @@ module RequestParamsValidation
         def validate_presence!
           not_present = param.allow_blank ? value.nil? : value.blank?
 
-          raise_error(:on_missing_parameter) if not_present
+          raise_error(:on_missing_parameter) if not_present && value != false
         end
       end
     end

data/lib/request_params_validation/version.rb

@@ -1,3 +1,3 @@
 module RequestParamsValidation
-  VERSION = '0.1.0'
+  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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Felipe Fava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,7 +60,7 @@ files:
 - lib/request_params_validation/params/validators/type.rb
 - lib/request_params_validation/params/validators/value.rb
 - lib/request_params_validation/version.rb
-homepage: https://github.com/felipefava/request_validation
+homepage: https://github.com/felipefava/request_params_validation
 licenses:
 - MIT
 metadata: {}
@@ -72,16 +72,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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 request params
+summary: Validates rails request params
 test_files: []