grape 0.1.1 → 2.4.0
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 +1167 -0
- data/CONTRIBUTING.md +156 -0
- data/LICENSE +1 -1
- data/README.md +4192 -0
- data/UPGRADING.md +1697 -0
- data/grape.gemspec +28 -105
- data/grape.png +0 -0
- data/lib/grape/api/helpers.rb +9 -0
- data/lib/grape/api/instance.rb +247 -0
- data/lib/grape/api.rb +158 -194
- data/lib/grape/content_types.rb +31 -0
- data/lib/grape/cookies.rb +50 -0
- data/lib/grape/dry_types.rb +10 -0
- data/lib/grape/dsl/api.rb +17 -0
- data/lib/grape/dsl/callbacks.rb +69 -0
- data/lib/grape/dsl/configuration.rb +15 -0
- data/lib/grape/dsl/desc.rb +124 -0
- data/lib/grape/dsl/headers.rb +21 -0
- data/lib/grape/dsl/helpers.rb +108 -0
- data/lib/grape/dsl/inside_route.rb +454 -0
- data/lib/grape/dsl/logger.rb +22 -0
- data/lib/grape/dsl/middleware.rb +54 -0
- data/lib/grape/dsl/parameters.rb +266 -0
- data/lib/grape/dsl/request_response.rb +171 -0
- data/lib/grape/dsl/routing.rb +248 -0
- data/lib/grape/dsl/settings.rb +179 -0
- data/lib/grape/dsl/validations.rb +57 -0
- data/lib/grape/endpoint.rb +398 -68
- data/lib/grape/env.rb +20 -0
- data/lib/grape/error_formatter/base.rb +68 -0
- data/lib/grape/error_formatter/json.rb +28 -0
- data/lib/grape/error_formatter/serializable_hash.rb +7 -0
- data/lib/grape/error_formatter/txt.rb +21 -0
- data/lib/grape/error_formatter/xml.rb +11 -0
- data/lib/grape/error_formatter.rb +15 -0
- data/lib/grape/exceptions/base.rb +76 -0
- data/lib/grape/exceptions/conflicting_types.rb +11 -0
- data/lib/grape/exceptions/empty_message_body.rb +11 -0
- 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 +11 -0
- data/lib/grape/exceptions/invalid_message_body.rb +11 -0
- data/lib/grape/exceptions/invalid_parameters.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 +11 -0
- data/lib/grape/exceptions/invalid_with_option_for_represent.rb +11 -0
- data/lib/grape/exceptions/method_not_allowed.rb +11 -0
- data/lib/grape/exceptions/missing_group_type.rb +13 -0
- data/lib/grape/exceptions/missing_mime_type.rb +11 -0
- data/lib/grape/exceptions/missing_option.rb +11 -0
- data/lib/grape/exceptions/missing_vendor_option.rb +11 -0
- data/lib/grape/exceptions/too_deep_parameters.rb +11 -0
- data/lib/grape/exceptions/too_many_multipart_files.rb +11 -0
- data/lib/grape/exceptions/unknown_auth_strategy.rb +11 -0
- data/lib/grape/exceptions/unknown_options.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 +11 -0
- data/lib/grape/exceptions/unsupported_group_type.rb +13 -0
- data/lib/grape/exceptions/validation.rb +25 -0
- data/lib/grape/exceptions/validation_array_errors.rb +14 -0
- data/lib/grape/exceptions/validation_errors.rb +53 -0
- data/lib/grape/extensions/active_support/hash_with_indifferent_access.rb +24 -0
- data/lib/grape/extensions/hash.rb +27 -0
- data/lib/grape/extensions/hashie/mash.rb +24 -0
- data/lib/grape/formatter/base.rb +16 -0
- data/lib/grape/formatter/json.rb +13 -0
- data/lib/grape/formatter/serializable_hash.rb +39 -0
- data/lib/grape/formatter/txt.rb +11 -0
- data/lib/grape/formatter/xml.rb +13 -0
- data/lib/grape/formatter.rb +17 -0
- data/lib/grape/json.rb +10 -0
- data/lib/grape/locale/en.yml +59 -0
- data/lib/grape/middleware/auth/base.rb +23 -0
- data/lib/grape/middleware/auth/dsl.rb +39 -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 +89 -18
- data/lib/grape/middleware/error.rb +129 -10
- data/lib/grape/middleware/filter.rb +19 -0
- data/lib/grape/middleware/formatter.rb +124 -82
- data/lib/grape/middleware/globals.rb +14 -0
- data/lib/grape/middleware/stack.rb +109 -0
- data/lib/grape/middleware/versioner/accept_version_header.rb +38 -0
- data/lib/grape/middleware/versioner/base.rb +74 -0
- data/lib/grape/middleware/versioner/header.rb +127 -0
- data/lib/grape/middleware/versioner/param.rb +32 -0
- data/lib/grape/middleware/versioner/path.rb +40 -0
- data/lib/grape/middleware/versioner.rb +21 -21
- data/lib/grape/namespace.rb +46 -0
- data/lib/grape/params_builder/base.rb +18 -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 +32 -0
- data/lib/grape/parser/base.rb +16 -0
- data/lib/grape/parser/json.rb +14 -0
- data/lib/grape/parser/xml.rb +14 -0
- 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 +190 -0
- data/lib/grape/router/base_route.rb +39 -0
- data/lib/grape/router/greedy_route.rb +20 -0
- data/lib/grape/router/pattern.rb +81 -0
- data/lib/grape/router/route.rb +62 -0
- data/lib/grape/router.rb +190 -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/types/invalid_value.rb +8 -0
- data/lib/grape/util/base_inheritable.rb +43 -0
- data/lib/grape/util/cache.rb +17 -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 +100 -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/strict_hash_configuration.rb +108 -0
- data/lib/grape/validations/attributes_doc.rb +60 -0
- data/lib/grape/validations/attributes_iterator.rb +62 -0
- data/lib/grape/validations/contract_scope.rb +34 -0
- data/lib/grape/validations/multiple_attributes_iterator.rb +13 -0
- data/lib/grape/validations/params_scope.rb +538 -0
- data/lib/grape/validations/single_attribute_iterator.rb +26 -0
- data/lib/grape/validations/types/array_coercer.rb +61 -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 +66 -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 +73 -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 +213 -0
- data/lib/grape/validations/validator_factory.rb +15 -0
- data/lib/grape/validations/validators/all_or_none_of_validator.rb +16 -0
- data/lib/grape/validations/validators/allow_blank_validator.rb +20 -0
- data/lib/grape/validations/validators/as_validator.rb +14 -0
- data/lib/grape/validations/validators/at_least_one_of_validator.rb +15 -0
- data/lib/grape/validations/validators/base.rb +88 -0
- data/lib/grape/validations/validators/coerce_validator.rb +75 -0
- data/lib/grape/validations/validators/contract_scope_validator.rb +41 -0
- data/lib/grape/validations/validators/default_validator.rb +37 -0
- data/lib/grape/validations/validators/exactly_one_of_validator.rb +17 -0
- data/lib/grape/validations/validators/except_values_validator.rb +24 -0
- data/lib/grape/validations/validators/length_validator.rb +49 -0
- data/lib/grape/validations/validators/multiple_params_base.rb +34 -0
- data/lib/grape/validations/validators/mutual_exclusion_validator.rb +16 -0
- data/lib/grape/validations/validators/presence_validator.rb +15 -0
- data/lib/grape/validations/validators/regexp_validator.rb +16 -0
- data/lib/grape/validations/validators/same_as_validator.rb +29 -0
- data/lib/grape/validations/validators/values_validator.rb +60 -0
- data/lib/grape/validations.rb +21 -0
- data/lib/grape/version.rb +6 -0
- data/lib/grape/xml.rb +10 -0
- data/lib/grape.rb +81 -17
- metadata +250 -192
- data/.document +0 -5
- data/.gitignore +0 -23
- data/.rspec +0 -2
- data/.rvmrc +0 -1
- data/Gemfile +0 -21
- data/Gemfile.lock +0 -58
- data/README.markdown +0 -75
- data/Rakefile +0 -70
- data/VERSION +0 -1
- data/autotest/discover.rb +0 -1
- data/lib/grape/middleware/auth/basic.rb +0 -30
- data/lib/grape/middleware/auth/oauth2.rb +0 -55
- data/lib/grape/middleware/prefixer.rb +0 -21
- data/lib/grape/middleware_stack.rb +0 -35
- data/spec/grape/api_spec.rb +0 -343
- data/spec/grape/endpoint_spec.rb +0 -104
- data/spec/grape/middleware/auth/basic_spec.rb +0 -31
- data/spec/grape/middleware/auth/oauth2_spec.rb +0 -88
- data/spec/grape/middleware/base_spec.rb +0 -63
- data/spec/grape/middleware/error_spec.rb +0 -49
- data/spec/grape/middleware/formatter_spec.rb +0 -87
- data/spec/grape/middleware/prefixer_spec.rb +0 -30
- data/spec/grape/middleware/versioner_spec.rb +0 -40
- data/spec/grape/middleware_stack_spec.rb +0 -47
- data/spec/grape_spec.rb +0 -1
- data/spec/spec_helper.rb +0 -20
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Validations
|
|
5
|
+
module Validators
|
|
6
|
+
class PresenceValidator < Base
|
|
7
|
+
def validate_param!(attr_name, params)
|
|
8
|
+
return if params.try(:key?, attr_name)
|
|
9
|
+
|
|
10
|
+
raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:presence))
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Validations
|
|
5
|
+
module Validators
|
|
6
|
+
class RegexpValidator < Base
|
|
7
|
+
def validate_param!(attr_name, params)
|
|
8
|
+
return unless params.try(:key?, attr_name)
|
|
9
|
+
return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.scrub.match?((options_key?(:value) ? @option[:value] : @option)) }
|
|
10
|
+
|
|
11
|
+
raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Validations
|
|
5
|
+
module Validators
|
|
6
|
+
class SameAsValidator < Base
|
|
7
|
+
def validate_param!(attr_name, params)
|
|
8
|
+
confirmation = options_key?(:value) ? @option[:value] : @option
|
|
9
|
+
return if params[attr_name] == params[confirmation]
|
|
10
|
+
|
|
11
|
+
raise Grape::Exceptions::Validation.new(
|
|
12
|
+
params: [@scope.full_name(attr_name)],
|
|
13
|
+
message: build_message
|
|
14
|
+
)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
private
|
|
18
|
+
|
|
19
|
+
def build_message
|
|
20
|
+
if options_key?(:message)
|
|
21
|
+
@option[:message]
|
|
22
|
+
else
|
|
23
|
+
format I18n.t(:same_as, scope: 'grape.errors.messages'), parameter: @option
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Validations
|
|
5
|
+
module Validators
|
|
6
|
+
class ValuesValidator < Base
|
|
7
|
+
def initialize(attrs, options, required, scope, opts)
|
|
8
|
+
@values = options.is_a?(Hash) ? options[:value] : options
|
|
9
|
+
super
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
def validate_param!(attr_name, params)
|
|
13
|
+
return unless params.is_a?(Hash)
|
|
14
|
+
|
|
15
|
+
val = params[attr_name]
|
|
16
|
+
|
|
17
|
+
return if val.nil? && !required_for_root_scope?
|
|
18
|
+
|
|
19
|
+
val = val.scrub if val.respond_to?(:scrub)
|
|
20
|
+
|
|
21
|
+
# don't forget that +false.blank?+ is true
|
|
22
|
+
return if val != false && val.blank? && @allow_blank
|
|
23
|
+
|
|
24
|
+
return if check_values?(val, attr_name)
|
|
25
|
+
|
|
26
|
+
raise Grape::Exceptions::Validation.new(
|
|
27
|
+
params: [@scope.full_name(attr_name)],
|
|
28
|
+
message: message(:values)
|
|
29
|
+
)
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
private
|
|
33
|
+
|
|
34
|
+
def check_values?(val, attr_name)
|
|
35
|
+
values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
|
|
36
|
+
return true if values.nil?
|
|
37
|
+
|
|
38
|
+
param_array = val.nil? ? [nil] : Array.wrap(val)
|
|
39
|
+
return param_array.all? { |param| values.include?(param) } unless values.is_a?(Proc)
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
param_array.all? { |param| values.call(param) }
|
|
43
|
+
rescue StandardError => e
|
|
44
|
+
warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
|
|
45
|
+
false
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def required_for_root_scope?
|
|
50
|
+
return false unless @required
|
|
51
|
+
|
|
52
|
+
scope = @scope
|
|
53
|
+
scope = scope.parent while scope.lateral?
|
|
54
|
+
|
|
55
|
+
scope.root?
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
module Validations
|
|
5
|
+
extend Grape::Util::Registry
|
|
6
|
+
|
|
7
|
+
module_function
|
|
8
|
+
|
|
9
|
+
def require_validator(short_name)
|
|
10
|
+
raise Grape::Exceptions::UnknownValidator, short_name unless registry.key?(short_name)
|
|
11
|
+
|
|
12
|
+
registry[short_name]
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def build_short_name(klass)
|
|
16
|
+
return if klass.name.blank?
|
|
17
|
+
|
|
18
|
+
klass.name.demodulize.underscore.delete_suffix('_validator')
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
data/lib/grape/xml.rb
ADDED
data/lib/grape.rb
CHANGED
|
@@ -1,22 +1,86 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'logger'
|
|
4
|
+
require 'active_support'
|
|
5
|
+
require 'active_support/concern'
|
|
6
|
+
require 'active_support/configurable'
|
|
7
|
+
require 'active_support/version'
|
|
8
|
+
require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
|
|
9
|
+
require 'active_support/core_ext/array/conversions'
|
|
10
|
+
require 'active_support/core_ext/array/extract_options'
|
|
11
|
+
require 'active_support/core_ext/array/wrap'
|
|
12
|
+
require 'active_support/core_ext/enumerable'
|
|
13
|
+
require 'active_support/core_ext/hash/conversions'
|
|
14
|
+
require 'active_support/core_ext/hash/deep_merge'
|
|
15
|
+
require 'active_support/core_ext/hash/except'
|
|
16
|
+
require 'active_support/core_ext/hash/indifferent_access'
|
|
17
|
+
require 'active_support/core_ext/hash/keys'
|
|
18
|
+
require 'active_support/core_ext/hash/reverse_merge'
|
|
19
|
+
require 'active_support/core_ext/hash/slice'
|
|
20
|
+
require 'active_support/core_ext/module/delegation'
|
|
21
|
+
require 'active_support/core_ext/object/blank'
|
|
22
|
+
require 'active_support/core_ext/object/deep_dup'
|
|
23
|
+
require 'active_support/core_ext/object/try'
|
|
24
|
+
require 'active_support/core_ext/object/duplicable'
|
|
25
|
+
require 'active_support/core_ext/string/output_safety'
|
|
26
|
+
require 'active_support/core_ext/string/exclude'
|
|
27
|
+
require 'active_support/deprecation'
|
|
28
|
+
require 'active_support/inflector'
|
|
29
|
+
require 'active_support/ordered_options'
|
|
30
|
+
require 'active_support/notifications'
|
|
31
|
+
|
|
32
|
+
require 'English'
|
|
33
|
+
require 'bigdecimal'
|
|
34
|
+
require 'date'
|
|
35
|
+
require 'dry-types'
|
|
36
|
+
require 'forwardable'
|
|
37
|
+
require 'json'
|
|
38
|
+
require 'mustermann/grape'
|
|
39
|
+
require 'pathname'
|
|
1
40
|
require 'rack'
|
|
41
|
+
require 'rack/auth/basic'
|
|
2
42
|
require 'rack/builder'
|
|
43
|
+
require 'rack/head'
|
|
44
|
+
require 'set'
|
|
45
|
+
require 'singleton'
|
|
46
|
+
require 'zeitwerk'
|
|
47
|
+
|
|
48
|
+
loader = Zeitwerk::Loader.for_gem
|
|
49
|
+
loader.inflector.inflect(
|
|
50
|
+
'api' => 'API',
|
|
51
|
+
'dsl' => 'DSL'
|
|
52
|
+
)
|
|
53
|
+
railtie = "#{__dir__}/grape/railtie.rb"
|
|
54
|
+
loader.do_not_eager_load(railtie)
|
|
55
|
+
loader.setup
|
|
56
|
+
|
|
57
|
+
I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
|
|
3
58
|
|
|
4
59
|
module Grape
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
60
|
+
include ActiveSupport::Configurable
|
|
61
|
+
|
|
62
|
+
HTTP_SUPPORTED_METHODS = [
|
|
63
|
+
Rack::GET,
|
|
64
|
+
Rack::POST,
|
|
65
|
+
Rack::PUT,
|
|
66
|
+
Rack::PATCH,
|
|
67
|
+
Rack::DELETE,
|
|
68
|
+
Rack::HEAD,
|
|
69
|
+
Rack::OPTIONS
|
|
70
|
+
].freeze
|
|
71
|
+
|
|
72
|
+
def self.deprecator
|
|
73
|
+
@deprecator ||= ActiveSupport::Deprecation.new('2.0', 'Grape')
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
configure do |config|
|
|
77
|
+
config.param_builder = :hash_with_indifferent_access
|
|
78
|
+
config.lint = false
|
|
79
|
+
config.compile_methods!
|
|
21
80
|
end
|
|
22
|
-
end
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# https://api.rubyonrails.org/classes/ActiveSupport/Deprecation.html
|
|
84
|
+
# adding Grape.deprecator to Rails App if any
|
|
85
|
+
require 'grape/railtie' if defined?(Rails::Railtie) && ActiveSupport.gem_version >= Gem::Version.new('7.1')
|
|
86
|
+
loader.eager_load
|