request_params_validation 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c0456b98e781cc72ec716aa4d06f18d32ba7cf26c97ba4bba193b995593ad8
-  data.tar.gz: 57e4e359a5f42f050db45b92355dd150de80bcd4698016ba8936dad4aabc6178
+  metadata.gz: c20b8745b806808c41cbc90ec9eea641bd2bf4530621225d68fcf5678367da59
+  data.tar.gz: 567570643a25a91a22cdbfde4ae416a26e32c83b27447be9210cd3309747043c
 SHA512:
-  metadata.gz: 1999797dee6855a5520933f665117d72acdd69d9014a14f87e1c88dea54dedac009a38c49b9dc11dac834cf026d4db1d0c695e9b7b95dbe461a4de5daebad27d
-  data.tar.gz: 4e9ba6145463b777212b7cde7b99346a61a5921e7dfb196818d65dd99dca74f96dae3009bf16d42d6de2320d366fa176055534e537fb1021b6f556e9b4e36e89
+  metadata.gz: cd6e167c9a3edc7dbc52306405d66aa370aa73cfe90c225bfb90d6dbd4a6750a26448adf3a4d25d9ffe7443c26681a0c190efa7bad9a0f99b436f99b07cfaf8d
+  data.tar.gz: e27ef25b9b6969f089fd78bd6f7b1b12efd43f90dd7fa4c97ee40c080c828e2483bbe987bffe456704b29b8bfac829c23a7503537c99ea63f016a25d53e7b09c

data/README.md

@@ -401,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.
 
@@ -444,6 +444,18 @@ 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`.
+
 ---
 ### NOTE
 
@@ -509,7 +521,7 @@ the table below:
 | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 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 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`                                                                                                                                                                                   |

data/lib/request_params_validation.rb

@@ -344,3 +344,13 @@ module RequestParamsValidation
     end
   end
 end
+
+# given some optional param validate another one if the given is present
+# same_as option for example for password confirmation
+# Parameters can be defined as mutually_exclusive, ensuring that they aren't present at the same time in a request.
+# https://github.com/ruby-grape/grape#allow_blank
+
+
+# Warning: Never define mutually exclusive sets with any required params. Two mutually exclusive required params will mean params are never valid, thus making the endpoint useless. One required param mutually exclusive with an optional param will mean the latter is never valid.
+
+# Grape returns all validation and coercion errors found by default. To skip all subsequent validation checks when a specific param is found invalid, use fail_fast: true.

data/lib/request_params_validation/definitions/param.rb

@@ -3,7 +3,7 @@ require 'request_params_validation/params'
 module RequestParamsValidation
   module Definitions
     class Param
-      attr_reader :key, :required, :allow_blank, :type, :transform, :decimal_precision,
+      attr_reader :key, :required, :allow_blank, :type, :rename_as, :transform, :decimal_precision,
                   :inclusion, :length, :value, :format, :custom_validation, :elements
 
       def initialize(options, &block)
@@ -11,6 +11,7 @@ module RequestParamsValidation
         @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]
@@ -73,6 +74,14 @@ module RequestParamsValidation
         !!@custom_validation
       end
 
+      def rename?
+        !!@rename_as
+      end
+
+      def transform?
+        !!@transform
+      end
+
       private
 
       def build_inclusion_option(inclusion)

data/lib/request_params_validation/params.rb

@@ -26,8 +26,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 +42,7 @@ module RequestParamsValidation
       return params if definition.empty?
 
       params_keys = definition.map do |param_definition|
-        key = param_definition.key
+        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/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

data/lib/request_params_validation/version.rb

@@ -1,3 +1,3 @@
 module RequestParamsValidation
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_params_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Felipe Fava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails