grape 0.5.0 → 3.2.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 +7 -0
- data/CHANGELOG.md +1223 -164
- data/CONTRIBUTING.md +148 -0
- data/LICENSE +1 -1
- data/README.md +3531 -675
- data/UPGRADING.md +1851 -0
- data/grape.gemspec +26 -32
- data/grape.png +0 -0
- data/lib/grape/api/instance.rb +194 -0
- data/lib/grape/api.rb +110 -485
- data/lib/grape/content_types.rb +28 -0
- data/lib/grape/cookies.rb +32 -25
- data/lib/grape/declared_params_handler.rb +118 -0
- data/lib/grape/dry_types.rb +54 -0
- data/lib/grape/dsl/callbacks.rb +19 -0
- data/lib/grape/dsl/declared.rb +35 -0
- data/lib/grape/dsl/desc.rb +65 -0
- data/lib/grape/dsl/headers.rb +21 -0
- data/lib/grape/dsl/helpers.rb +103 -0
- data/lib/grape/dsl/inside_route.rb +293 -0
- data/lib/grape/dsl/logger.rb +19 -0
- data/lib/grape/dsl/middleware.rb +36 -0
- data/lib/grape/dsl/parameters.rb +239 -0
- data/lib/grape/dsl/request_response.rb +168 -0
- data/lib/grape/dsl/routing.rb +288 -0
- data/lib/grape/dsl/settings.rb +67 -0
- data/lib/grape/dsl/validations.rb +51 -0
- data/lib/grape/endpoint.rb +287 -386
- data/lib/grape/env.rb +20 -0
- data/lib/grape/error_formatter/base.rb +56 -19
- data/lib/grape/error_formatter/json.rb +18 -7
- data/lib/grape/error_formatter/serializable_hash.rb +7 -0
- data/lib/grape/error_formatter/txt.rb +14 -11
- data/lib/grape/error_formatter/xml.rb +5 -11
- data/lib/grape/error_formatter.rb +15 -0
- data/lib/grape/exceptions/base.rb +31 -47
- data/lib/grape/exceptions/incompatible_option_values.rb +11 -0
- data/lib/grape/exceptions/invalid_accept_header.rb +11 -0
- data/lib/grape/exceptions/invalid_formatter.rb +3 -5
- data/lib/grape/exceptions/invalid_message_body.rb +11 -0
- data/lib/grape/exceptions/invalid_response.rb +11 -0
- data/lib/grape/exceptions/invalid_version_header.rb +11 -0
- data/lib/grape/exceptions/invalid_versioner_option.rb +3 -6
- data/lib/grape/exceptions/invalid_with_option_for_represent.rb +3 -7
- data/lib/grape/exceptions/method_not_allowed.rb +11 -0
- data/lib/grape/exceptions/missing_group_type.rb +11 -0
- data/lib/grape/exceptions/missing_mime_type.rb +3 -6
- data/lib/grape/exceptions/missing_vendor_option.rb +3 -5
- data/lib/grape/exceptions/request_error.rb +11 -0
- data/lib/grape/exceptions/unknown_auth_strategy.rb +11 -0
- data/lib/grape/exceptions/unknown_parameter.rb +11 -0
- data/lib/grape/exceptions/unknown_params_builder.rb +11 -0
- data/lib/grape/exceptions/unknown_validator.rb +3 -4
- data/lib/grape/exceptions/unsupported_group_type.rb +11 -0
- data/lib/grape/exceptions/validation.rb +20 -8
- data/lib/grape/exceptions/validation_array_errors.rb +14 -0
- data/lib/grape/exceptions/validation_errors.rb +59 -0
- data/lib/grape/formatter/base.rb +9 -26
- data/lib/grape/formatter/json.rb +6 -7
- data/lib/grape/formatter/serializable_hash.rb +24 -20
- data/lib/grape/formatter/txt.rb +5 -7
- data/lib/grape/formatter/xml.rb +6 -7
- data/lib/grape/formatter.rb +17 -0
- data/lib/grape/json.rb +10 -0
- data/lib/grape/locale/en.yml +47 -20
- data/lib/grape/middleware/auth/base.rb +25 -0
- data/lib/grape/middleware/auth/dsl.rb +38 -0
- data/lib/grape/middleware/auth/strategies.rb +25 -0
- data/lib/grape/middleware/auth/strategy_info.rb +15 -0
- data/lib/grape/middleware/base.rb +73 -19
- data/lib/grape/middleware/error.rb +104 -44
- data/lib/grape/middleware/filter.rb +5 -3
- data/lib/grape/middleware/formatter.rb +115 -105
- data/lib/grape/middleware/globals.rb +14 -0
- data/lib/grape/middleware/stack.rb +110 -0
- data/lib/grape/middleware/versioner/accept_version_header.rb +11 -40
- data/lib/grape/middleware/versioner/base.rb +76 -0
- data/lib/grape/middleware/versioner/header.rb +61 -78
- data/lib/grape/middleware/versioner/param.rb +9 -21
- data/lib/grape/middleware/versioner/path.rb +16 -31
- data/lib/grape/middleware/versioner.rb +10 -15
- data/lib/grape/namespace.rb +39 -10
- 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 +9 -24
- data/lib/grape/parser/json.rb +8 -7
- data/lib/grape/parser/xml.rb +8 -7
- data/lib/grape/parser.rb +15 -0
- data/lib/grape/path.rb +76 -0
- data/lib/grape/presenters/presenter.rb +11 -0
- data/lib/grape/railtie.rb +9 -0
- data/lib/grape/request.rb +182 -0
- data/lib/grape/router/base_route.rb +48 -0
- data/lib/grape/router/greedy_route.rb +26 -0
- data/lib/grape/router/pattern.rb +67 -0
- data/lib/grape/router/route.rb +58 -0
- data/lib/grape/router.rb +167 -0
- data/lib/grape/serve_stream/file_body.rb +36 -0
- data/lib/grape/serve_stream/sendfile_response.rb +21 -0
- data/lib/grape/serve_stream/stream_response.rb +23 -0
- data/lib/grape/util/api_description.rb +58 -0
- data/lib/grape/util/base_inheritable.rb +46 -0
- data/lib/grape/util/cache.rb +18 -0
- data/lib/grape/util/deep_freeze.rb +35 -0
- data/lib/grape/util/endpoint_configuration.rb +8 -0
- data/lib/grape/util/header.rb +13 -0
- data/lib/grape/util/inheritable_setting.rb +107 -0
- data/lib/grape/util/inheritable_values.rb +29 -0
- data/lib/grape/util/lazy/block.rb +29 -0
- data/lib/grape/util/lazy/value.rb +38 -0
- data/lib/grape/util/lazy/value_array.rb +21 -0
- data/lib/grape/util/lazy/value_enumerable.rb +34 -0
- data/lib/grape/util/lazy/value_hash.rb +21 -0
- data/lib/grape/util/media_type.rb +70 -0
- data/lib/grape/util/registry.rb +27 -0
- data/lib/grape/util/reverse_stackable_values.rb +15 -0
- data/lib/grape/util/stackable_values.rb +36 -0
- data/lib/grape/util/translation.rb +42 -0
- data/lib/grape/validations/attributes_iterator.rb +77 -0
- data/lib/grape/validations/contract_scope.rb +28 -0
- data/lib/grape/validations/multiple_attributes_iterator.rb +13 -0
- data/lib/grape/validations/param_scope_tracker.rb +57 -0
- data/lib/grape/validations/params_documentation.rb +50 -0
- data/lib/grape/validations/params_scope.rb +529 -0
- data/lib/grape/validations/single_attribute_iterator.rb +26 -0
- data/lib/grape/validations/types/array_coercer.rb +60 -0
- data/lib/grape/validations/types/custom_type_coercer.rb +164 -0
- data/lib/grape/validations/types/custom_type_collection_coercer.rb +56 -0
- data/lib/grape/validations/types/dry_type_coercer.rb +59 -0
- data/lib/grape/validations/types/file.rb +31 -0
- data/lib/grape/validations/types/invalid_value.rb +17 -0
- data/lib/grape/validations/types/json.rb +71 -0
- data/lib/grape/validations/types/multiple_type_coercer.rb +57 -0
- data/lib/grape/validations/types/primitive_coercer.rb +46 -0
- data/lib/grape/validations/types/set_coercer.rb +35 -0
- data/lib/grape/validations/types/variant_collection_coercer.rb +51 -0
- data/lib/grape/validations/types.rb +198 -0
- data/lib/grape/validations/validators/all_or_none_of_validator.rb +19 -0
- data/lib/grape/validations/validators/allow_blank_validator.rb +25 -0
- data/lib/grape/validations/validators/as_validator.rb +14 -0
- data/lib/grape/validations/validators/at_least_one_of_validator.rb +18 -0
- data/lib/grape/validations/validators/base.rb +158 -0
- data/lib/grape/validations/validators/coerce_validator.rb +55 -0
- data/lib/grape/validations/validators/contract_scope_validator.rb +45 -0
- data/lib/grape/validations/validators/default_validator.rb +31 -0
- data/lib/grape/validations/validators/exactly_one_of_validator.rb +24 -0
- data/lib/grape/validations/validators/except_values_validator.rb +33 -0
- data/lib/grape/validations/validators/length_validator.rb +48 -0
- data/lib/grape/validations/validators/multiple_params_base.rb +34 -0
- data/lib/grape/validations/validators/mutually_exclusive_validator.rb +18 -0
- data/lib/grape/validations/validators/presence_validator.rb +17 -0
- data/lib/grape/validations/validators/regexp_validator.rb +24 -0
- data/lib/grape/validations/validators/same_as_validator.rb +20 -0
- data/lib/grape/validations/validators/values_validator.rb +68 -0
- data/lib/grape/validations.rb +10 -226
- data/lib/grape/version.rb +4 -1
- data/lib/grape/xml.rb +10 -0
- data/lib/grape.rb +79 -77
- metadata +160 -306
- data/.gitignore +0 -38
- data/.rspec +0 -2
- data/.travis.yml +0 -9
- data/.yardopts +0 -2
- data/Gemfile +0 -19
- data/Guardfile +0 -15
- data/Rakefile +0 -64
- data/lib/grape/exceptions/missing_option.rb +0 -13
- data/lib/grape/exceptions/unknown_options.rb +0 -14
- data/lib/grape/http/request.rb +0 -28
- data/lib/grape/middleware/auth/basic.rb +0 -30
- data/lib/grape/middleware/auth/digest.rb +0 -30
- data/lib/grape/middleware/auth/oauth2.rb +0 -72
- data/lib/grape/route.rb +0 -23
- data/lib/grape/util/content_types.rb +0 -17
- data/lib/grape/util/deep_merge.rb +0 -23
- data/lib/grape/util/hash_stack.rb +0 -120
- data/lib/grape/validations/coerce.rb +0 -62
- data/lib/grape/validations/default.rb +0 -24
- data/lib/grape/validations/presence.rb +0 -12
- data/lib/grape/validations/regexp.rb +0 -14
- data/spec/grape/api_spec.rb +0 -2129
- data/spec/grape/endpoint_spec.rb +0 -605
- data/spec/grape/entity_spec.rb +0 -281
- data/spec/grape/exceptions/invalid_formatter_spec.rb +0 -18
- data/spec/grape/exceptions/invalid_versioner_option_spec.rb +0 -18
- data/spec/grape/exceptions/missing_mime_type_spec.rb +0 -24
- data/spec/grape/exceptions/missing_option_spec.rb +0 -18
- data/spec/grape/exceptions/unknown_options_spec.rb +0 -18
- data/spec/grape/exceptions/unknown_validator_spec.rb +0 -18
- data/spec/grape/middleware/auth/basic_spec.rb +0 -31
- data/spec/grape/middleware/auth/digest_spec.rb +0 -47
- data/spec/grape/middleware/auth/oauth2_spec.rb +0 -90
- data/spec/grape/middleware/base_spec.rb +0 -63
- data/spec/grape/middleware/error_spec.rb +0 -49
- data/spec/grape/middleware/exception_spec.rb +0 -164
- data/spec/grape/middleware/formatter_spec.rb +0 -244
- data/spec/grape/middleware/versioner/accept_version_header_spec.rb +0 -121
- data/spec/grape/middleware/versioner/header_spec.rb +0 -277
- data/spec/grape/middleware/versioner/param_spec.rb +0 -58
- data/spec/grape/middleware/versioner/path_spec.rb +0 -44
- data/spec/grape/middleware/versioner_spec.rb +0 -22
- data/spec/grape/util/hash_stack_spec.rb +0 -133
- data/spec/grape/validations/coerce_spec.rb +0 -143
- data/spec/grape/validations/default_spec.rb +0 -67
- data/spec/grape/validations/presence_spec.rb +0 -144
- data/spec/grape/validations/regexp_spec.rb +0 -33
- data/spec/grape/validations/zh-CN.yml +0 -9
- data/spec/grape/validations_spec.rb +0 -217
- data/spec/shared/versioning_examples.rb +0 -121
- data/spec/spec_helper.rb +0 -25
- data/spec/support/basic_auth_encode_helpers.rb +0 -4
- data/spec/support/versioned_helpers.rb +0 -48
data/lib/grape/env.rb
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Env
|
|
5
|
+
API_VERSION = 'api.version'
|
|
6
|
+
API_ENDPOINT = 'api.endpoint'
|
|
7
|
+
API_REQUEST_INPUT = 'api.request.input'
|
|
8
|
+
API_REQUEST_BODY = 'api.request.body'
|
|
9
|
+
API_TYPE = 'api.type'
|
|
10
|
+
API_SUBTYPE = 'api.subtype'
|
|
11
|
+
API_VENDOR = 'api.vendor'
|
|
12
|
+
API_FORMAT = 'api.format'
|
|
13
|
+
|
|
14
|
+
GRAPE_REQUEST = 'grape.request'
|
|
15
|
+
GRAPE_REQUEST_HEADERS = 'grape.request.headers'
|
|
16
|
+
GRAPE_REQUEST_PARAMS = 'grape.request.params'
|
|
17
|
+
GRAPE_ROUTING_ARGS = 'grape.routing_args'
|
|
18
|
+
GRAPE_ALLOWED_METHODS = 'grape.allowed_methods'
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -1,32 +1,69 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
module Grape
|
|
2
4
|
module ErrorFormatter
|
|
3
|
-
|
|
4
|
-
|
|
5
|
+
class Base
|
|
5
6
|
class << self
|
|
7
|
+
def call(message, backtrace, options = {}, env = nil, original_exception = nil)
|
|
8
|
+
merge_backtrace = backtrace.present? && options.dig(:rescue_options, :backtrace)
|
|
9
|
+
merge_original_exception = original_exception && options.dig(:rescue_options, :original_exception)
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}
|
|
11
|
+
wrapped_message = wrap_message(present(message, env))
|
|
12
|
+
if wrapped_message.is_a?(Hash)
|
|
13
|
+
wrapped_message[:backtrace] = backtrace if merge_backtrace
|
|
14
|
+
wrapped_message[:original_exception] = original_exception.inspect if merge_original_exception
|
|
15
|
+
end
|
|
13
16
|
|
|
14
|
-
|
|
15
|
-
FORMATTERS.merge(options[:error_formatters] || {})
|
|
17
|
+
format_structured_message(wrapped_message)
|
|
16
18
|
end
|
|
17
19
|
|
|
18
|
-
def
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
20
|
+
def present(message, env)
|
|
21
|
+
present_options = {}
|
|
22
|
+
presented_message = message
|
|
23
|
+
if presented_message.is_a?(Hash)
|
|
24
|
+
presented_message = presented_message.dup
|
|
25
|
+
present_options[:with] = presented_message.delete(:with)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
presenter = env[Grape::Env::API_ENDPOINT].entity_class_for_obj(presented_message, present_options)
|
|
29
|
+
|
|
30
|
+
unless presenter || env[Grape::Env::GRAPE_ROUTING_ARGS].nil?
|
|
31
|
+
# env['api.endpoint'].route does not work when the error occurs within a middleware
|
|
32
|
+
# the Endpoint does not have a valid env at this moment
|
|
33
|
+
http_codes = env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info].http_codes || []
|
|
34
|
+
|
|
35
|
+
found_code = http_codes.find do |http_code|
|
|
36
|
+
(http_code[0].to_i == env[Grape::Env::API_ENDPOINT].status) && http_code[2].respond_to?(:represent)
|
|
37
|
+
end if env[Grape::Env::API_ENDPOINT].request
|
|
38
|
+
|
|
39
|
+
presenter = found_code[2] if found_code
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
if presenter
|
|
43
|
+
embeds = { env: }
|
|
44
|
+
embeds[:version] = env[Grape::Env::API_VERSION] if env.key?(Grape::Env::API_VERSION)
|
|
45
|
+
presented_message = presenter.represent(presented_message, embeds).serializable_hash
|
|
27
46
|
end
|
|
47
|
+
|
|
48
|
+
presented_message
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def wrap_message(message)
|
|
52
|
+
return message if message.is_a?(Hash)
|
|
53
|
+
|
|
54
|
+
{ message: }
|
|
28
55
|
end
|
|
29
56
|
|
|
57
|
+
def format_structured_message(_structured_message)
|
|
58
|
+
raise NotImplementedError
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
private
|
|
62
|
+
|
|
63
|
+
def inherited(klass)
|
|
64
|
+
super
|
|
65
|
+
ErrorFormatter.register(klass)
|
|
66
|
+
end
|
|
30
67
|
end
|
|
31
68
|
end
|
|
32
69
|
end
|
|
@@ -1,16 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
module Grape
|
|
2
4
|
module ErrorFormatter
|
|
3
|
-
|
|
5
|
+
class Json < Base
|
|
4
6
|
class << self
|
|
7
|
+
def format_structured_message(structured_message)
|
|
8
|
+
::Grape::Json.dump(structured_message)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
private
|
|
5
12
|
|
|
6
|
-
def
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
MultiJson.dump(result)
|
|
13
|
+
def wrap_message(message)
|
|
14
|
+
return message if message.is_a?(Hash)
|
|
15
|
+
return message.as_json if message.is_a?(Exceptions::ValidationErrors)
|
|
16
|
+
|
|
17
|
+
{ error: ensure_utf8(message) }
|
|
12
18
|
end
|
|
13
19
|
|
|
20
|
+
def ensure_utf8(message)
|
|
21
|
+
return message unless message.respond_to? :encode
|
|
22
|
+
|
|
23
|
+
message.encode('UTF-8', invalid: :replace, undef: :replace)
|
|
24
|
+
end
|
|
14
25
|
end
|
|
15
26
|
end
|
|
16
27
|
end
|
|
@@ -1,17 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
module Grape
|
|
2
4
|
module ErrorFormatter
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
result += backtrace.join("\r\n ")
|
|
5
|
+
class Txt < Base
|
|
6
|
+
def self.format_structured_message(structured_message)
|
|
7
|
+
message = structured_message[:message] || Grape::Json.dump(structured_message)
|
|
8
|
+
Array.wrap(message).tap do |final_message|
|
|
9
|
+
if structured_message.key?(:backtrace)
|
|
10
|
+
final_message << 'backtrace:'
|
|
11
|
+
final_message.concat(structured_message[:backtrace])
|
|
11
12
|
end
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
if structured_message.key?(:original_exception)
|
|
14
|
+
final_message << 'original exception:'
|
|
15
|
+
final_message << structured_message[:original_exception]
|
|
16
|
+
end
|
|
17
|
+
end.join("\r\n ")
|
|
15
18
|
end
|
|
16
19
|
end
|
|
17
20
|
end
|
|
@@ -1,16 +1,10 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
module Grape
|
|
2
4
|
module ErrorFormatter
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
def call(message, backtrace, options = {}, env = nil)
|
|
7
|
-
result = message.is_a?(Hash) ? message : { :message => message }
|
|
8
|
-
if (options[:rescue_options] || {})[:backtrace] && backtrace && ! backtrace.empty?
|
|
9
|
-
result = result.merge({ :backtrace => backtrace })
|
|
10
|
-
end
|
|
11
|
-
result.respond_to?(:to_xml) ? result.to_xml(:root => :error) : result.to_s
|
|
12
|
-
end
|
|
13
|
-
|
|
5
|
+
class Xml < Base
|
|
6
|
+
def self.format_structured_message(structured_message)
|
|
7
|
+
structured_message.respond_to?(:to_xml) ? structured_message.to_xml(root: :error) : structured_message.to_s
|
|
14
8
|
end
|
|
15
9
|
end
|
|
16
10
|
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module ErrorFormatter
|
|
5
|
+
extend Grape::Util::Registry
|
|
6
|
+
|
|
7
|
+
module_function
|
|
8
|
+
|
|
9
|
+
def formatter_for(format, error_formatters = nil, default_error_formatter = nil)
|
|
10
|
+
return error_formatters[format] if error_formatters&.key?(format)
|
|
11
|
+
|
|
12
|
+
registry[format] || default_error_formatter || Grape::ErrorFormatter::Txt
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -1,66 +1,50 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
module Grape
|
|
2
4
|
module Exceptions
|
|
3
5
|
class Base < StandardError
|
|
6
|
+
include Grape::Util::Translation
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'
|
|
7
|
-
|
|
8
|
-
attr_reader :status, :message, :headers
|
|
9
|
-
|
|
10
|
-
def initialize(args = {})
|
|
11
|
-
@status = args[:status] || nil
|
|
12
|
-
@message = args[:message] || nil
|
|
13
|
-
@headers = args[:headers] || nil
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
def [](index)
|
|
17
|
-
self.send(index)
|
|
18
|
-
end
|
|
8
|
+
MESSAGE_STEPS = %w[problem summary resolution].to_h { |s| [s, s.capitalize] }.freeze
|
|
19
9
|
|
|
20
|
-
|
|
21
|
-
# TODO: translate attribute first
|
|
22
|
-
# if BASE_ATTRIBUTES_KEY.key respond to a string message, then short_message is returned
|
|
23
|
-
# if BASE_ATTRIBUTES_KEY.key respond to a Hash, means it may have problem , summary and resolution
|
|
24
|
-
def compose_message(key, attributes = {} )
|
|
25
|
-
short_message = translate_message(key, attributes)
|
|
26
|
-
if short_message.is_a? Hash
|
|
27
|
-
@problem = problem(key, attributes)
|
|
28
|
-
@summary = summary(key, attributes)
|
|
29
|
-
@resolution = resolution(key, attributes)
|
|
30
|
-
[ ["Problem", @problem], ["Summary", @summary], ["Resolution", @resolution]].reduce("") do |message, detail_array|
|
|
31
|
-
message << "\n#{detail_array[0]}:\n #{detail_array[1]}" unless detail_array[1].blank?
|
|
32
|
-
message
|
|
33
|
-
end
|
|
34
|
-
else
|
|
35
|
-
short_message
|
|
36
|
-
end
|
|
37
|
-
end
|
|
10
|
+
attr_reader :status, :headers
|
|
38
11
|
|
|
39
|
-
def
|
|
40
|
-
|
|
41
|
-
end
|
|
12
|
+
def initialize(status: nil, message: nil, headers: nil)
|
|
13
|
+
super(message)
|
|
42
14
|
|
|
43
|
-
|
|
44
|
-
|
|
15
|
+
@status = status
|
|
16
|
+
@headers = headers
|
|
45
17
|
end
|
|
46
18
|
|
|
47
|
-
def
|
|
48
|
-
|
|
19
|
+
def [](index)
|
|
20
|
+
__send__ index
|
|
49
21
|
end
|
|
50
22
|
|
|
23
|
+
private
|
|
51
24
|
|
|
52
|
-
def
|
|
53
|
-
|
|
54
|
-
|
|
25
|
+
def compose_message(key, **)
|
|
26
|
+
short_message = translate_message(key, **)
|
|
27
|
+
return short_message unless short_message.is_a?(Hash)
|
|
55
28
|
|
|
56
|
-
|
|
57
|
-
|
|
29
|
+
MESSAGE_STEPS.filter_map do |step, label|
|
|
30
|
+
detail = translate_message(:"#{key}.#{step}", **)
|
|
31
|
+
"\n#{label}:\n #{detail}" if detail.present?
|
|
32
|
+
end.join
|
|
58
33
|
end
|
|
59
34
|
|
|
60
|
-
def
|
|
61
|
-
|
|
35
|
+
def translate_message(translation_key, **)
|
|
36
|
+
case translation_key
|
|
37
|
+
when Symbol
|
|
38
|
+
translate(translation_key, **)
|
|
39
|
+
when Hash
|
|
40
|
+
translation_key => { key:, **opts }
|
|
41
|
+
translate(key, **opts)
|
|
42
|
+
when Proc
|
|
43
|
+
translation_key.call
|
|
44
|
+
else
|
|
45
|
+
translation_key
|
|
46
|
+
end
|
|
62
47
|
end
|
|
63
|
-
|
|
64
48
|
end
|
|
65
49
|
end
|
|
66
50
|
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Exceptions
|
|
5
|
+
class IncompatibleOptionValues < Base
|
|
6
|
+
def initialize(option1, value1, option2, value2)
|
|
7
|
+
super(message: compose_message(:incompatible_option_values, option1:, value1:, option2:, value2:))
|
|
8
|
+
end
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
5
|
class InvalidFormatter < Base
|
|
5
|
-
|
|
6
6
|
def initialize(klass, to_format)
|
|
7
|
-
super(:
|
|
7
|
+
super(message: compose_message(:invalid_formatter, klass:, to_format:))
|
|
8
8
|
end
|
|
9
|
-
|
|
10
9
|
end
|
|
11
|
-
|
|
12
10
|
end
|
|
13
11
|
end
|
|
@@ -1,14 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
|
-
|
|
5
5
|
class InvalidVersionerOption < Base
|
|
6
|
-
|
|
7
6
|
def initialize(strategy)
|
|
8
|
-
super(:
|
|
7
|
+
super(message: compose_message(:invalid_versioner_option, strategy:))
|
|
9
8
|
end
|
|
10
|
-
|
|
11
9
|
end
|
|
12
|
-
|
|
13
10
|
end
|
|
14
11
|
end
|
|
@@ -1,15 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
5
|
class InvalidWithOptionForRepresent < Base
|
|
5
|
-
|
|
6
6
|
def initialize
|
|
7
|
-
super(:
|
|
7
|
+
super(message: compose_message(:invalid_with_option_for_represent))
|
|
8
8
|
end
|
|
9
|
-
|
|
10
9
|
end
|
|
11
|
-
|
|
12
10
|
end
|
|
13
|
-
|
|
14
11
|
end
|
|
15
|
-
|
|
@@ -1,14 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
5
|
class MissingMimeType < Base
|
|
5
|
-
|
|
6
6
|
def initialize(new_format)
|
|
7
|
-
super(:
|
|
7
|
+
super(message: compose_message(:missing_mime_type, new_format:))
|
|
8
8
|
end
|
|
9
|
-
|
|
10
9
|
end
|
|
11
|
-
|
|
12
10
|
end
|
|
13
|
-
|
|
14
11
|
end
|
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
5
|
class MissingVendorOption < Base
|
|
5
|
-
|
|
6
6
|
def initialize
|
|
7
|
-
super(:
|
|
7
|
+
super(message: compose_message(:missing_vendor_option))
|
|
8
8
|
end
|
|
9
|
-
|
|
10
9
|
end
|
|
11
|
-
|
|
12
10
|
end
|
|
13
11
|
end
|
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
2
3
|
module Grape
|
|
3
4
|
module Exceptions
|
|
4
5
|
class UnknownValidator < Base
|
|
5
|
-
|
|
6
6
|
def initialize(validator_type)
|
|
7
|
-
super(:
|
|
7
|
+
super(message: compose_message(:unknown_validator, validator_type:))
|
|
8
8
|
end
|
|
9
|
-
|
|
10
9
|
end
|
|
11
10
|
end
|
|
12
11
|
end
|
|
@@ -1,15 +1,27 @@
|
|
|
1
|
-
|
|
1
|
+
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module Grape
|
|
4
4
|
module Exceptions
|
|
5
|
-
class Validation <
|
|
6
|
-
|
|
5
|
+
class Validation < Base
|
|
6
|
+
attr_reader :params, :message_key
|
|
7
7
|
|
|
8
|
-
def initialize(
|
|
9
|
-
@
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
8
|
+
def initialize(params:, message: nil, status: nil, headers: nil)
|
|
9
|
+
@params = Array(params)
|
|
10
|
+
if message
|
|
11
|
+
@message_key = case message
|
|
12
|
+
when Symbol then message
|
|
13
|
+
when Hash then message[:key]
|
|
14
|
+
end
|
|
15
|
+
message = translate_message(message)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
super(status:, message:, headers:)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Remove all the unnecessary stuff from Grape::Exceptions::Base like status
|
|
22
|
+
# and headers when converting a validation error to json or string
|
|
23
|
+
def as_json(*_args)
|
|
24
|
+
to_s
|
|
13
25
|
end
|
|
14
26
|
end
|
|
15
27
|
end
|