Module: Grape::DSL::Parameters
- Extended by:
- ActiveSupport::Concern
- Included in:
- Validations::ParamsScope
- Defined in:
- lib/grape/dsl/parameters.rb
Overview
Defines DSL methods, meant to be applied to a ParamsScope, which define and describe the parameters accepted by an endpoint, or all endpoints within a namespace.
Instance Method Summary collapse
-
#all_or_none_of(*attrs) ⇒ Object
Require that either all given params are present, or none are.
-
#at_least_one_of(*attrs) ⇒ Object
Require at least one of the given parameters to be present.
-
#declared_param?(param) ⇒ Boolean
Test for whether a certain parameter has been defined in this params block yet.
-
#exactly_one_of(*attrs) ⇒ Object
Require exactly one of the given parameters to be present.
-
#given(*attrs) { ... } ⇒ Object
Define a block of validations which should be applied if and only if the given parameter is present.
- #map_params(params, element) ⇒ Object
-
#mutually_exclusive(*attrs) ⇒ Object
Disallow the given parameters to be present in the same request.
-
#optional(*attrs, &block) ⇒ Object
Allow, but don’t require, one or more parameters for the current endpoint.
-
#params(params) ⇒ Object
private
Hash of parameters relevant for the current scope.
-
#requires(*attrs, &block) ⇒ Object
(also: #group)
Require one or more parameters for the current endpoint.
-
#use(*names) ⇒ Object
(also: #use_scope, #includes)
Include reusable params rules among current.
-
#with(*attrs, &block) ⇒ Object
Define common settings for one or more parameters.
Instance Method Details
#all_or_none_of(*attrs) ⇒ Object
Require that either all given params are present, or none are.
166 167 168 |
# File 'lib/grape/dsl/parameters.rb', line 166 def all_or_none_of(*attrs) validates(attrs, all_or_none_of: { value: true, message: (attrs) }) end |
#at_least_one_of(*attrs) ⇒ Object
Require at least one of the given parameters to be present.
160 161 162 |
# File 'lib/grape/dsl/parameters.rb', line 160 def at_least_one_of(*attrs) validates(attrs, at_least_one_of: { value: true, message: (attrs) }) end |
#declared_param?(param) ⇒ Boolean
Test for whether a certain parameter has been defined in this params block yet.
188 189 190 191 192 |
# File 'lib/grape/dsl/parameters.rb', line 188 def declared_param?(param) # @declared_params also includes hashes of options and such, but those # won't be flattened out. @declared_params.flatten.include?(param) end |
#exactly_one_of(*attrs) ⇒ Object
Require exactly one of the given parameters to be present.
154 155 156 |
# File 'lib/grape/dsl/parameters.rb', line 154 def exactly_one_of(*attrs) validates(attrs, exactly_one_of: { value: true, message: (attrs) }) end |
#given(*attrs) { ... } ⇒ Object
Define a block of validations which should be applied if and only if the given parameter is present. The parameters are not nested.
177 178 179 180 181 182 183 |
# File 'lib/grape/dsl/parameters.rb', line 177 def given(*attrs, &block) attrs.each do |attr| proxy_attr = attr.is_a?(Hash) ? attr.keys[0] : attr raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr) end new_lateral_scope(dependent_on: attrs, &block) end |
#map_params(params, element) ⇒ Object
196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/grape/dsl/parameters.rb', line 196 def map_params(params, element) if params.is_a?(Array) params.map do |el| map_params(el, element) end elsif params.is_a?(Hash) params[element] || {} else {} end end |
#mutually_exclusive(*attrs) ⇒ Object
Disallow the given parameters to be present in the same request.
148 149 150 |
# File 'lib/grape/dsl/parameters.rb', line 148 def mutually_exclusive(*attrs) validates(attrs, mutual_exclusion: { value: true, message: (attrs) }) end |
#optional(*attrs, &block) ⇒ Object
Allow, but don’t require, one or more parameters for the current
endpoint.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/grape/dsl/parameters.rb', line 117 def optional(*attrs, &block) orig_attrs = attrs.clone opts = attrs..clone type = opts[:type] opts = @group.merge(opts) if @group # check type for optional parameter group if attrs && block_given? raise Grape::Exceptions::MissingGroupTypeError.new if type.nil? raise Grape::Exceptions::UnsupportedGroupTypeError.new unless Grape::Validations::Types.group?(type) end if opts[:using] require_optional_fields(attrs.first, opts) else validate_attributes(attrs, opts, &block) block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs) end end |
#params(params) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns hash of parameters relevant for the current scope.
211 212 213 214 215 |
# File 'lib/grape/dsl/parameters.rb', line 211 def params(params) params = @parent.params(params) if @parent params = map_params(params, @element) if @element params end |
#requires(*attrs, &block) ⇒ Object Also known as: group
Require one or more parameters for the current endpoint.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/grape/dsl/parameters.rb', line 97 def requires(*attrs, &block) orig_attrs = attrs.clone opts = attrs..clone opts[:presence] = { value: true, message: opts[:message] } opts = @group.merge(opts) if @group if opts[:using] require_required_and_optional_fields(attrs.first, opts) else validate_attributes(attrs, opts, &block) block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs) end end |
#use(*names) ⇒ Object Also known as: use_scope, includes
Include reusable params rules among current. You can define reusable params with helpers method.
32 33 34 35 36 37 38 39 40 41 |
# File 'lib/grape/dsl/parameters.rb', line 32 def use(*names) named_params = @api.namespace_stackable_with_hash(:named_params) || {} = names. names.each do |name| params_block = named_params.fetch(name) do raise "Params :#{name} not found!" end instance_exec(, ¶ms_block) end end |
#with(*attrs, &block) ⇒ Object
Define common settings for one or more parameters
142 143 144 |
# File 'lib/grape/dsl/parameters.rb', line 142 def with(*attrs, &block) new_group_scope(attrs.clone, &block) end |