grape 1.8.0 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +517 -1
- data/CONTRIBUTING.md +19 -11
- data/README.md +841 -545
- data/UPGRADING.md +1553 -7
- data/grape.gemspec +11 -14
- data/lib/grape/api/instance.rb +77 -160
- data/lib/grape/api.rb +75 -107
- data/lib/grape/content_types.rb +67 -9
- data/lib/grape/cookies.rb +28 -25
- data/lib/grape/declared_params_handler.rb +116 -0
- data/lib/grape/dry_types.rb +48 -6
- data/lib/grape/dsl/callbacks.rb +8 -58
- data/lib/grape/dsl/declared.rb +35 -0
- data/lib/grape/dsl/desc.rb +25 -63
- data/lib/grape/dsl/entity.rb +106 -0
- data/lib/grape/dsl/headers.rb +2 -2
- data/lib/grape/dsl/helpers.rb +83 -64
- data/lib/grape/dsl/inside_route.rb +69 -296
- data/lib/grape/dsl/logger.rb +4 -9
- data/lib/grape/dsl/middleware.rb +22 -40
- data/lib/grape/dsl/parameters.rb +88 -94
- data/lib/grape/dsl/request_response.rb +143 -147
- data/lib/grape/dsl/rescue_options.rb +25 -0
- data/lib/grape/dsl/routing.rb +333 -191
- data/lib/grape/dsl/settings.rb +29 -135
- data/lib/grape/dsl/validations.rb +39 -32
- data/lib/grape/dsl/version_options.rb +23 -0
- data/lib/grape/endpoint/options.rb +25 -0
- data/lib/grape/endpoint.rb +319 -269
- data/lib/grape/{util/env.rb → env.rb} +8 -8
- data/lib/grape/error_formatter/base.rb +57 -21
- data/lib/grape/error_formatter/json.rb +13 -15
- data/lib/grape/error_formatter/serializable_hash.rb +7 -0
- data/lib/grape/error_formatter/txt.rb +12 -18
- data/lib/grape/error_formatter/xml.rb +3 -13
- data/lib/grape/error_formatter.rb +9 -25
- data/lib/grape/exceptions/base.rb +22 -58
- data/lib/grape/exceptions/error_response.rb +48 -0
- data/lib/grape/exceptions/incompatible_option_values.rb +1 -1
- data/lib/grape/exceptions/internal_server_error.rb +16 -0
- data/lib/grape/exceptions/invalid_accept_header.rb +1 -1
- data/lib/grape/exceptions/invalid_formatter.rb +1 -1
- data/lib/grape/exceptions/invalid_message_body.rb +1 -1
- data/lib/grape/exceptions/invalid_version_header.rb +1 -1
- data/lib/grape/exceptions/invalid_versioner_option.rb +1 -1
- data/lib/grape/exceptions/method_not_allowed.rb +1 -1
- data/lib/grape/exceptions/missing_group_type.rb +0 -2
- data/lib/grape/exceptions/missing_mime_type.rb +1 -1
- data/lib/grape/exceptions/request_error.rb +11 -0
- data/lib/grape/exceptions/unknown_auth_strategy.rb +11 -0
- data/lib/grape/exceptions/unknown_error_formatter.rb +11 -0
- data/lib/grape/exceptions/unknown_parameter.rb +1 -1
- data/lib/grape/exceptions/unknown_params_builder.rb +11 -0
- data/lib/grape/exceptions/unknown_validator.rb +1 -1
- data/lib/grape/exceptions/unsupported_group_type.rb +0 -2
- data/lib/grape/exceptions/validation.rb +28 -11
- data/lib/grape/exceptions/validation_array_errors.rb +5 -0
- data/lib/grape/exceptions/validation_errors.rb +22 -26
- data/lib/grape/formatter/base.rb +16 -0
- data/lib/grape/formatter/json.rb +5 -6
- data/lib/grape/formatter/serializable_hash.rb +7 -10
- data/lib/grape/formatter/txt.rb +3 -5
- data/lib/grape/formatter/xml.rb +4 -6
- data/lib/grape/formatter.rb +7 -25
- data/lib/grape/json.rb +46 -0
- data/lib/grape/locale/en.yml +44 -42
- data/lib/grape/middleware/auth/base.rb +11 -33
- data/lib/grape/middleware/auth/dsl.rb +12 -34
- data/lib/grape/middleware/auth/strategies.rb +1 -2
- data/lib/grape/middleware/base.rb +56 -33
- data/lib/grape/middleware/error.rb +290 -91
- data/lib/grape/middleware/formatter.rb +164 -106
- data/lib/grape/middleware/precomputed_content_types.rb +51 -0
- data/lib/grape/middleware/stack.rb +38 -40
- data/lib/grape/middleware/versioner/accept_version_header.rb +6 -33
- data/lib/grape/middleware/versioner/base.rb +66 -0
- data/lib/grape/middleware/versioner/header.rb +44 -129
- data/lib/grape/middleware/versioner/param.rb +4 -25
- data/lib/grape/middleware/versioner/path.rb +48 -25
- data/lib/grape/middleware/versioner.rb +7 -14
- data/lib/grape/mountable.rb +22 -0
- data/lib/grape/namespace.rb +21 -14
- data/lib/grape/params_builder/base.rb +20 -0
- data/lib/grape/params_builder/hash.rb +11 -0
- data/lib/grape/params_builder/hash_with_indifferent_access.rb +11 -0
- data/lib/grape/params_builder/hashie_mash.rb +11 -0
- data/lib/grape/params_builder.rb +15 -0
- data/lib/grape/parser/base.rb +16 -0
- data/lib/grape/parser/json.rb +6 -8
- data/lib/grape/parser/xml.rb +6 -8
- data/lib/grape/parser.rb +5 -23
- data/lib/grape/path.rb +8 -94
- data/lib/grape/precompiled_json.rb +50 -0
- data/lib/grape/railtie.rb +9 -0
- data/lib/grape/request.rb +200 -26
- data/lib/grape/router/base_route.rb +85 -0
- data/lib/grape/router/greedy_route.rb +30 -0
- data/lib/grape/router/mustermann_pattern.rb +44 -0
- data/lib/grape/router/pattern/path.rb +78 -0
- data/lib/grape/router/pattern.rb +77 -35
- data/lib/grape/router/route.rb +79 -60
- data/lib/grape/router.rb +128 -104
- data/lib/grape/serve_stream/file_body.rb +7 -0
- data/lib/grape/serve_stream/sendfile_response.rb +3 -5
- data/lib/grape/serve_stream/stream_response.rb +7 -0
- data/lib/grape/testing.rb +33 -0
- data/lib/grape/util/api_description.rb +67 -0
- data/lib/grape/util/cache.rb +22 -5
- data/lib/grape/util/deep_freeze.rb +34 -0
- data/lib/grape/util/endpoint_configuration.rb +1 -1
- data/lib/grape/util/freeze_on_new.rb +20 -0
- data/lib/grape/util/header.rb +13 -0
- data/lib/grape/util/inheritable_setting.rb +777 -39
- data/lib/grape/util/lazy/base.rb +16 -0
- data/lib/grape/util/lazy/block.rb +22 -0
- data/lib/grape/util/lazy/value.rb +31 -0
- data/lib/grape/util/lazy/value_array.rb +21 -0
- data/lib/grape/util/lazy/value_enumerable.rb +31 -0
- data/lib/grape/util/lazy/value_hash.rb +21 -0
- data/lib/grape/util/media_type.rb +74 -0
- data/lib/grape/util/path_normalizer.rb +37 -0
- data/lib/grape/util/registry.rb +37 -0
- data/lib/grape/util/shadowed_rescue_handlers.rb +49 -0
- data/lib/grape/util/stackable_values.rb +40 -16
- data/lib/grape/util/translation.rb +42 -0
- data/lib/grape/validations/attributes_iterator.rb +61 -28
- data/lib/grape/validations/coerce_options.rb +21 -0
- data/lib/grape/validations/contract_scope.rb +29 -0
- data/lib/grape/validations/multiple_attributes_iterator.rb +1 -1
- data/lib/grape/validations/oneof_collector.rb +35 -0
- data/lib/grape/validations/param_scope_tracker.rb +62 -0
- data/lib/grape/validations/params_documentation.rb +52 -0
- data/lib/grape/validations/params_scope.rb +223 -306
- data/lib/grape/validations/shared_options.rb +19 -0
- data/lib/grape/validations/single_attribute_iterator.rb +6 -4
- data/lib/grape/validations/types/array_coercer.rb +7 -12
- data/lib/grape/validations/types/custom_type_coercer.rb +47 -85
- data/lib/grape/validations/types/custom_type_collection_coercer.rb +1 -1
- data/lib/grape/validations/types/dry_type_coercer.rb +17 -28
- data/lib/grape/validations/types/json.rb +1 -5
- data/lib/grape/validations/types/multiple_type_coercer.rb +5 -3
- data/lib/grape/validations/types/primitive_coercer.rb +14 -35
- data/lib/grape/validations/types/set_coercer.rb +1 -4
- data/lib/grape/validations/types/variant_collection_coercer.rb +16 -3
- data/lib/grape/validations/types.rb +29 -54
- data/lib/grape/validations/validations_spec.rb +164 -0
- data/lib/grape/validations/validators/all_or_none_of_validator.rb +6 -3
- data/lib/grape/validations/validators/allow_blank_validator.rb +10 -5
- data/lib/grape/validations/validators/at_least_one_of_validator.rb +5 -2
- data/lib/grape/validations/validators/base.rb +118 -37
- data/lib/grape/validations/validators/coerce_validator.rb +26 -38
- data/lib/grape/validations/validators/contract_scope_validator.rb +46 -0
- data/lib/grape/validations/validators/default_validator.rb +13 -16
- data/lib/grape/validations/validators/exactly_one_of_validator.rb +10 -3
- data/lib/grape/validations/validators/except_values_validator.rb +15 -5
- data/lib/grape/validations/validators/length_validator.rb +50 -0
- data/lib/grape/validations/validators/multiple_params_base.rb +12 -9
- data/lib/grape/validations/validators/{mutual_exclusion_validator.rb → mutually_exclusive_validator.rb} +4 -2
- data/lib/grape/validations/validators/oneof_validator.rb +51 -0
- data/lib/grape/validations/validators/presence_validator.rb +4 -2
- data/lib/grape/validations/validators/regexp_validator.rb +11 -3
- data/lib/grape/validations/validators/same_as_validator.rb +7 -15
- data/lib/grape/validations/validators/values_validator.rb +36 -65
- data/lib/grape/validations.rb +8 -21
- data/lib/grape/version.rb +1 -2
- data/lib/grape/xml.rb +17 -0
- data/lib/grape.rb +96 -288
- metadata +83 -294
- data/lib/grape/api/helpers.rb +0 -9
- data/lib/grape/dsl/api.rb +0 -19
- data/lib/grape/dsl/configuration.rb +0 -15
- data/lib/grape/eager_load.rb +0 -20
- data/lib/grape/exceptions/empty_message_body.rb +0 -11
- data/lib/grape/exceptions/missing_option.rb +0 -11
- data/lib/grape/exceptions/too_many_multipart_files.rb +0 -11
- data/lib/grape/exceptions/unknown_options.rb +0 -11
- data/lib/grape/extensions/active_support/hash_with_indifferent_access.rb +0 -27
- data/lib/grape/extensions/hash.rb +0 -22
- data/lib/grape/extensions/hashie/mash.rb +0 -26
- data/lib/grape/http/headers.rb +0 -61
- data/lib/grape/middleware/globals.rb +0 -16
- data/lib/grape/middleware/helpers.rb +0 -12
- data/lib/grape/middleware/versioner/parse_media_type_patch.rb +0 -24
- data/lib/grape/router/attribute_translator.rb +0 -63
- data/lib/grape/types/invalid_value.rb +0 -8
- data/lib/grape/util/base_inheritable.rb +0 -43
- data/lib/grape/util/inheritable_values.rb +0 -31
- data/lib/grape/util/json.rb +0 -12
- data/lib/grape/util/lazy_block.rb +0 -27
- data/lib/grape/util/lazy_object.rb +0 -43
- data/lib/grape/util/lazy_value.rb +0 -91
- data/lib/grape/util/registrable.rb +0 -15
- data/lib/grape/util/reverse_stackable_values.rb +0 -20
- data/lib/grape/util/strict_hash_configuration.rb +0 -108
- data/lib/grape/util/xml.rb +0 -10
- data/lib/grape/validations/attributes_doc.rb +0 -58
- data/lib/grape/validations/types/build_coercer.rb +0 -94
- data/lib/grape/validations/validator_factory.rb +0 -15
- data/spec/grape/api/custom_validations_spec.rb +0 -213
- data/spec/grape/api/deeply_included_options_spec.rb +0 -56
- data/spec/grape/api/defines_boolean_in_params_spec.rb +0 -38
- data/spec/grape/api/documentation_spec.rb +0 -59
- data/spec/grape/api/inherited_helpers_spec.rb +0 -114
- data/spec/grape/api/instance_spec.rb +0 -103
- data/spec/grape/api/invalid_format_spec.rb +0 -45
- data/spec/grape/api/namespace_parameters_in_route_spec.rb +0 -38
- data/spec/grape/api/nested_helpers_spec.rb +0 -50
- data/spec/grape/api/optional_parameters_in_route_spec.rb +0 -43
- data/spec/grape/api/parameters_modification_spec.rb +0 -41
- data/spec/grape/api/patch_method_helpers_spec.rb +0 -79
- data/spec/grape/api/recognize_path_spec.rb +0 -21
- data/spec/grape/api/required_parameters_in_route_spec.rb +0 -37
- data/spec/grape/api/required_parameters_with_invalid_method_spec.rb +0 -26
- data/spec/grape/api/routes_with_requirements_spec.rb +0 -59
- data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb +0 -41
- data/spec/grape/api/shared_helpers_spec.rb +0 -36
- data/spec/grape/api_remount_spec.rb +0 -509
- data/spec/grape/api_spec.rb +0 -4356
- data/spec/grape/dsl/callbacks_spec.rb +0 -45
- data/spec/grape/dsl/desc_spec.rb +0 -98
- data/spec/grape/dsl/headers_spec.rb +0 -62
- data/spec/grape/dsl/helpers_spec.rb +0 -100
- data/spec/grape/dsl/inside_route_spec.rb +0 -531
- data/spec/grape/dsl/logger_spec.rb +0 -24
- data/spec/grape/dsl/middleware_spec.rb +0 -60
- data/spec/grape/dsl/parameters_spec.rb +0 -180
- data/spec/grape/dsl/request_response_spec.rb +0 -225
- data/spec/grape/dsl/routing_spec.rb +0 -275
- data/spec/grape/dsl/settings_spec.rb +0 -261
- data/spec/grape/dsl/validations_spec.rb +0 -55
- data/spec/grape/endpoint/declared_spec.rb +0 -846
- data/spec/grape/endpoint_spec.rb +0 -1085
- data/spec/grape/entity_spec.rb +0 -336
- data/spec/grape/exceptions/base_spec.rb +0 -81
- data/spec/grape/exceptions/body_parse_errors_spec.rb +0 -185
- data/spec/grape/exceptions/invalid_accept_header_spec.rb +0 -358
- data/spec/grape/exceptions/invalid_formatter_spec.rb +0 -15
- data/spec/grape/exceptions/invalid_response_spec.rb +0 -11
- data/spec/grape/exceptions/invalid_versioner_option_spec.rb +0 -15
- data/spec/grape/exceptions/missing_group_type_spec.rb +0 -17
- data/spec/grape/exceptions/missing_mime_type_spec.rb +0 -17
- data/spec/grape/exceptions/missing_option_spec.rb +0 -15
- data/spec/grape/exceptions/unknown_options_spec.rb +0 -15
- data/spec/grape/exceptions/unknown_validator_spec.rb +0 -15
- data/spec/grape/exceptions/unsupported_group_type_spec.rb +0 -19
- data/spec/grape/exceptions/validation_errors_spec.rb +0 -92
- data/spec/grape/exceptions/validation_spec.rb +0 -19
- data/spec/grape/extensions/param_builders/hash_spec.rb +0 -83
- data/spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb +0 -105
- data/spec/grape/extensions/param_builders/hashie/mash_spec.rb +0 -79
- data/spec/grape/grape_spec.rb +0 -9
- data/spec/grape/integration/global_namespace_function_spec.rb +0 -29
- data/spec/grape/integration/rack_sendfile_spec.rb +0 -48
- data/spec/grape/integration/rack_spec.rb +0 -51
- data/spec/grape/loading_spec.rb +0 -44
- data/spec/grape/middleware/auth/base_spec.rb +0 -31
- data/spec/grape/middleware/auth/dsl_spec.rb +0 -60
- data/spec/grape/middleware/auth/strategies_spec.rb +0 -120
- data/spec/grape/middleware/base_spec.rb +0 -221
- data/spec/grape/middleware/error_spec.rb +0 -85
- data/spec/grape/middleware/exception_spec.rb +0 -294
- data/spec/grape/middleware/formatter_spec.rb +0 -461
- data/spec/grape/middleware/globals_spec.rb +0 -30
- data/spec/grape/middleware/stack_spec.rb +0 -155
- data/spec/grape/middleware/versioner/accept_version_header_spec.rb +0 -122
- data/spec/grape/middleware/versioner/header_spec.rb +0 -345
- data/spec/grape/middleware/versioner/param_spec.rb +0 -171
- data/spec/grape/middleware/versioner/path_spec.rb +0 -62
- data/spec/grape/middleware/versioner_spec.rb +0 -21
- data/spec/grape/named_api_spec.rb +0 -19
- data/spec/grape/parser_spec.rb +0 -86
- data/spec/grape/path_spec.rb +0 -252
- data/spec/grape/presenters/presenter_spec.rb +0 -71
- data/spec/grape/request_spec.rb +0 -126
- data/spec/grape/util/inheritable_setting_spec.rb +0 -242
- data/spec/grape/util/inheritable_values_spec.rb +0 -79
- data/spec/grape/util/reverse_stackable_values_spec.rb +0 -134
- data/spec/grape/util/stackable_values_spec.rb +0 -128
- data/spec/grape/util/strict_hash_configuration_spec.rb +0 -38
- data/spec/grape/validations/attributes_doc_spec.rb +0 -153
- data/spec/grape/validations/instance_behaivour_spec.rb +0 -43
- data/spec/grape/validations/multiple_attributes_iterator_spec.rb +0 -38
- data/spec/grape/validations/params_scope_spec.rb +0 -1420
- data/spec/grape/validations/single_attribute_iterator_spec.rb +0 -56
- data/spec/grape/validations/types/array_coercer_spec.rb +0 -33
- data/spec/grape/validations/types/primitive_coercer_spec.rb +0 -150
- data/spec/grape/validations/types/set_coercer_spec.rb +0 -32
- data/spec/grape/validations/types_spec.rb +0 -111
- data/spec/grape/validations/validators/all_or_none_spec.rb +0 -162
- data/spec/grape/validations/validators/allow_blank_spec.rb +0 -575
- data/spec/grape/validations/validators/at_least_one_of_spec.rb +0 -205
- data/spec/grape/validations/validators/base_spec.rb +0 -38
- data/spec/grape/validations/validators/coerce_spec.rb +0 -1261
- data/spec/grape/validations/validators/default_spec.rb +0 -463
- data/spec/grape/validations/validators/exactly_one_of_spec.rb +0 -233
- data/spec/grape/validations/validators/except_values_spec.rb +0 -192
- data/spec/grape/validations/validators/mutual_exclusion_spec.rb +0 -214
- data/spec/grape/validations/validators/presence_spec.rb +0 -315
- data/spec/grape/validations/validators/regexp_spec.rb +0 -161
- data/spec/grape/validations/validators/same_as_spec.rb +0 -57
- data/spec/grape/validations/validators/values_spec.rb +0 -733
- data/spec/grape/validations/validators/zh-CN.yml +0 -10
- data/spec/grape/validations_spec.rb +0 -2030
- data/spec/integration/eager_load/eager_load_spec.rb +0 -15
- data/spec/integration/multi_json/json_spec.rb +0 -7
- data/spec/integration/multi_xml/xml_spec.rb +0 -7
- data/spec/shared/deprecated_class_examples.rb +0 -16
- data/spec/shared/versioning_examples.rb +0 -215
- data/spec/spec_helper.rb +0 -52
- data/spec/support/basic_auth_encode_helpers.rb +0 -11
- data/spec/support/chunks.rb +0 -14
- data/spec/support/content_type_helpers.rb +0 -15
- data/spec/support/endpoint_faker.rb +0 -25
- data/spec/support/file_streamer.rb +0 -13
- data/spec/support/integer_helpers.rb +0 -13
- data/spec/support/versioned_helpers.rb +0 -55
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Grape
|
|
4
|
-
module DSL
|
|
5
|
-
module CallbacksSpec
|
|
6
|
-
class Dummy
|
|
7
|
-
include Grape::DSL::Callbacks
|
|
8
|
-
end
|
|
9
|
-
end
|
|
10
|
-
|
|
11
|
-
describe Callbacks do
|
|
12
|
-
subject { Class.new(CallbacksSpec::Dummy) }
|
|
13
|
-
|
|
14
|
-
let(:proc) { -> {} }
|
|
15
|
-
|
|
16
|
-
describe '.before' do
|
|
17
|
-
it 'adds a block to "before"' do
|
|
18
|
-
expect(subject).to receive(:namespace_stackable).with(:befores, proc)
|
|
19
|
-
subject.before(&proc)
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
describe '.before_validation' do
|
|
24
|
-
it 'adds a block to "before_validation"' do
|
|
25
|
-
expect(subject).to receive(:namespace_stackable).with(:before_validations, proc)
|
|
26
|
-
subject.before_validation(&proc)
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
describe '.after_validation' do
|
|
31
|
-
it 'adds a block to "after_validation"' do
|
|
32
|
-
expect(subject).to receive(:namespace_stackable).with(:after_validations, proc)
|
|
33
|
-
subject.after_validation(&proc)
|
|
34
|
-
end
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
describe '.after' do
|
|
38
|
-
it 'adds a block to "after"' do
|
|
39
|
-
expect(subject).to receive(:namespace_stackable).with(:afters, proc)
|
|
40
|
-
subject.after(&proc)
|
|
41
|
-
end
|
|
42
|
-
end
|
|
43
|
-
end
|
|
44
|
-
end
|
|
45
|
-
end
|
data/spec/grape/dsl/desc_spec.rb
DELETED
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
describe Grape::DSL::Desc do
|
|
4
|
-
subject { dummy_class }
|
|
5
|
-
|
|
6
|
-
let(:dummy_class) do
|
|
7
|
-
Class.new do
|
|
8
|
-
extend Grape::DSL::Desc
|
|
9
|
-
end
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
describe '.desc' do
|
|
13
|
-
it 'sets a description' do
|
|
14
|
-
desc_text = 'The description'
|
|
15
|
-
options = { message: 'none' }
|
|
16
|
-
subject.desc desc_text, options
|
|
17
|
-
expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
|
|
18
|
-
expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
|
|
19
|
-
end
|
|
20
|
-
|
|
21
|
-
it 'can be set with a block' do
|
|
22
|
-
expected_options = {
|
|
23
|
-
summary: 'summary',
|
|
24
|
-
description: 'The description',
|
|
25
|
-
detail: 'more details',
|
|
26
|
-
params: { first: :param },
|
|
27
|
-
entity: Object,
|
|
28
|
-
default: { code: 400, message: 'Invalid' },
|
|
29
|
-
http_codes: [[401, 'Unauthorized', 'Entities::Error']],
|
|
30
|
-
named: 'My named route',
|
|
31
|
-
body_name: 'My body name',
|
|
32
|
-
headers: [
|
|
33
|
-
XAuthToken: {
|
|
34
|
-
description: 'Valdates your identity',
|
|
35
|
-
required: true
|
|
36
|
-
},
|
|
37
|
-
XOptionalHeader: {
|
|
38
|
-
description: 'Not really needed',
|
|
39
|
-
required: false
|
|
40
|
-
}
|
|
41
|
-
],
|
|
42
|
-
hidden: false,
|
|
43
|
-
deprecated: false,
|
|
44
|
-
is_array: true,
|
|
45
|
-
nickname: 'nickname',
|
|
46
|
-
produces: %w[array of mime_types],
|
|
47
|
-
consumes: %w[array of mime_types],
|
|
48
|
-
tags: %w[tag1 tag2],
|
|
49
|
-
security: %w[array of security schemes]
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
subject.desc 'The description' do
|
|
53
|
-
summary 'summary'
|
|
54
|
-
detail 'more details'
|
|
55
|
-
params(first: :param)
|
|
56
|
-
success Object
|
|
57
|
-
default code: 400, message: 'Invalid'
|
|
58
|
-
failure [[401, 'Unauthorized', 'Entities::Error']]
|
|
59
|
-
named 'My named route'
|
|
60
|
-
body_name 'My body name'
|
|
61
|
-
headers [
|
|
62
|
-
XAuthToken: {
|
|
63
|
-
description: 'Valdates your identity',
|
|
64
|
-
required: true
|
|
65
|
-
},
|
|
66
|
-
XOptionalHeader: {
|
|
67
|
-
description: 'Not really needed',
|
|
68
|
-
required: false
|
|
69
|
-
}
|
|
70
|
-
]
|
|
71
|
-
hidden false
|
|
72
|
-
deprecated false
|
|
73
|
-
is_array true
|
|
74
|
-
nickname 'nickname'
|
|
75
|
-
produces %w[array of mime_types]
|
|
76
|
-
consumes %w[array of mime_types]
|
|
77
|
-
tags %w[tag1 tag2]
|
|
78
|
-
security %w[array of security schemes]
|
|
79
|
-
end
|
|
80
|
-
|
|
81
|
-
expect(subject.namespace_setting(:description)).to eq(expected_options)
|
|
82
|
-
expect(subject.route_setting(:description)).to eq(expected_options)
|
|
83
|
-
end
|
|
84
|
-
|
|
85
|
-
it 'can be set with options and a block' do
|
|
86
|
-
expect(ActiveSupport::Deprecation).to receive(:warn).with('Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
|
|
87
|
-
|
|
88
|
-
desc_text = 'The description'
|
|
89
|
-
detail_text = 'more details'
|
|
90
|
-
options = { message: 'none' }
|
|
91
|
-
subject.desc desc_text, options do
|
|
92
|
-
detail detail_text
|
|
93
|
-
end
|
|
94
|
-
expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
|
|
95
|
-
expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
end
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Grape
|
|
4
|
-
module DSL
|
|
5
|
-
module HeadersSpec
|
|
6
|
-
class Dummy
|
|
7
|
-
include Grape::DSL::Headers
|
|
8
|
-
end
|
|
9
|
-
end
|
|
10
|
-
describe Headers do
|
|
11
|
-
subject { HeadersSpec::Dummy.new }
|
|
12
|
-
|
|
13
|
-
let(:header_data) do
|
|
14
|
-
{ 'First Key' => 'First Value',
|
|
15
|
-
'Second Key' => 'Second Value' }
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
context 'when headers are set' do
|
|
19
|
-
describe '#header' do
|
|
20
|
-
before do
|
|
21
|
-
header_data.each { |k, v| subject.header(k, v) }
|
|
22
|
-
end
|
|
23
|
-
|
|
24
|
-
describe 'get' do
|
|
25
|
-
it 'returns a specifc value' do
|
|
26
|
-
expect(subject.header['First Key']).to eq 'First Value'
|
|
27
|
-
expect(subject.header['Second Key']).to eq 'Second Value'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
it 'returns all set headers' do
|
|
31
|
-
expect(subject.header).to eq header_data
|
|
32
|
-
expect(subject.headers).to eq header_data
|
|
33
|
-
end
|
|
34
|
-
end
|
|
35
|
-
|
|
36
|
-
describe 'set' do
|
|
37
|
-
it 'returns value' do
|
|
38
|
-
expect(subject.header('Third Key', 'Third Value'))
|
|
39
|
-
expect(subject.header['Third Key']).to eq 'Third Value'
|
|
40
|
-
end
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
describe 'delete' do
|
|
44
|
-
it 'deletes a header key-value pair' do
|
|
45
|
-
expect(subject.header('First Key')).to eq header_data['First Key']
|
|
46
|
-
expect(subject.header).not_to have_key('First Key')
|
|
47
|
-
end
|
|
48
|
-
end
|
|
49
|
-
end
|
|
50
|
-
end
|
|
51
|
-
|
|
52
|
-
context 'when no headers are set' do
|
|
53
|
-
describe '#header' do
|
|
54
|
-
it 'returns nil' do
|
|
55
|
-
expect(subject.header['First Key']).to be_nil
|
|
56
|
-
expect(subject.header('First Key')).to be_nil
|
|
57
|
-
end
|
|
58
|
-
end
|
|
59
|
-
end
|
|
60
|
-
end
|
|
61
|
-
end
|
|
62
|
-
end
|
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Grape
|
|
4
|
-
module DSL
|
|
5
|
-
module HelpersSpec
|
|
6
|
-
class Dummy
|
|
7
|
-
include Grape::DSL::Helpers
|
|
8
|
-
|
|
9
|
-
def self.mods
|
|
10
|
-
namespace_stackable(:helpers)
|
|
11
|
-
end
|
|
12
|
-
|
|
13
|
-
def self.first_mod
|
|
14
|
-
mods.first
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
module BooleanParam
|
|
20
|
-
extend Grape::API::Helpers
|
|
21
|
-
|
|
22
|
-
params :requires_toggle_prm do
|
|
23
|
-
requires :toggle_prm, type: Boolean
|
|
24
|
-
end
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
class Base < Grape::API
|
|
28
|
-
helpers BooleanParam
|
|
29
|
-
end
|
|
30
|
-
|
|
31
|
-
class Child < Base; end
|
|
32
|
-
|
|
33
|
-
describe Helpers do
|
|
34
|
-
subject { Class.new(HelpersSpec::Dummy) }
|
|
35
|
-
|
|
36
|
-
let(:proc) do
|
|
37
|
-
lambda do |*|
|
|
38
|
-
def test
|
|
39
|
-
:test
|
|
40
|
-
end
|
|
41
|
-
end
|
|
42
|
-
end
|
|
43
|
-
|
|
44
|
-
describe '.helpers' do
|
|
45
|
-
it 'adds a module with the given block' do
|
|
46
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original
|
|
47
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original
|
|
48
|
-
subject.helpers(&proc)
|
|
49
|
-
|
|
50
|
-
expect(subject.first_mod.instance_methods).to include(:test)
|
|
51
|
-
end
|
|
52
|
-
|
|
53
|
-
it 'uses provided modules' do
|
|
54
|
-
mod = Module.new
|
|
55
|
-
|
|
56
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.twice
|
|
57
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original
|
|
58
|
-
subject.helpers(mod, &proc)
|
|
59
|
-
|
|
60
|
-
expect(subject.first_mod).to eq mod
|
|
61
|
-
end
|
|
62
|
-
|
|
63
|
-
it 'uses many provided modules' do
|
|
64
|
-
mod = Module.new
|
|
65
|
-
mod2 = Module.new
|
|
66
|
-
mod3 = Module.new
|
|
67
|
-
|
|
68
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.exactly(4).times
|
|
69
|
-
expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original.exactly(3).times
|
|
70
|
-
|
|
71
|
-
subject.helpers(mod, mod2, mod3, &proc)
|
|
72
|
-
|
|
73
|
-
expect(subject.mods).to include(mod)
|
|
74
|
-
expect(subject.mods).to include(mod2)
|
|
75
|
-
expect(subject.mods).to include(mod3)
|
|
76
|
-
end
|
|
77
|
-
|
|
78
|
-
context 'with an external file' do
|
|
79
|
-
it 'sets Boolean as a Grape::API::Boolean' do
|
|
80
|
-
subject.helpers BooleanParam
|
|
81
|
-
expect(subject.first_mod::Boolean).to eq Grape::API::Boolean
|
|
82
|
-
end
|
|
83
|
-
end
|
|
84
|
-
|
|
85
|
-
context 'in child classes' do
|
|
86
|
-
it 'is available' do
|
|
87
|
-
klass = Child
|
|
88
|
-
expect do
|
|
89
|
-
klass.instance_eval do
|
|
90
|
-
params do
|
|
91
|
-
use :requires_toggle_prm
|
|
92
|
-
end
|
|
93
|
-
end
|
|
94
|
-
end.not_to raise_exception
|
|
95
|
-
end
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
end
|
|
99
|
-
end
|
|
100
|
-
end
|