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
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
describe Grape::Validations::DefaultValidator do
|
|
4
|
-
|
|
5
|
-
module ValidationsSpec
|
|
6
|
-
module DefaultValidatorSpec
|
|
7
|
-
class API < Grape::API
|
|
8
|
-
default_format :json
|
|
9
|
-
|
|
10
|
-
params do
|
|
11
|
-
optional :id
|
|
12
|
-
optional :type, :default => 'default-type'
|
|
13
|
-
end
|
|
14
|
-
get '/' do
|
|
15
|
-
{ :id => params[:id], :type => params[:type] }
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
params do
|
|
19
|
-
optional :type1, :default => 'default-type1'
|
|
20
|
-
optional :type2, :default => 'default-type2'
|
|
21
|
-
end
|
|
22
|
-
get '/user' do
|
|
23
|
-
{ :type1 => params[:type1], :type2 => params[:type2] }
|
|
24
|
-
end
|
|
25
|
-
|
|
26
|
-
params do
|
|
27
|
-
requires :id
|
|
28
|
-
optional :type1, :default => 'default-type1'
|
|
29
|
-
optional :type2, :default => 'default-type2'
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
get '/message' do
|
|
33
|
-
{ :id => params[:id], :type1 => params[:type1], :type2 => params[:type2] }
|
|
34
|
-
end
|
|
35
|
-
end
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
|
|
39
|
-
def app
|
|
40
|
-
ValidationsSpec::DefaultValidatorSpec::API
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
it 'set default value for optional param' do
|
|
44
|
-
get("/")
|
|
45
|
-
last_response.status.should == 200
|
|
46
|
-
last_response.body.should == { :id => nil, :type => 'default-type' }.to_json
|
|
47
|
-
end
|
|
48
|
-
|
|
49
|
-
it 'set default values for optional params' do
|
|
50
|
-
get("/user")
|
|
51
|
-
last_response.status.should == 200
|
|
52
|
-
last_response.body.should == { :type1 => 'default-type1', :type2 => 'default-type2' }.to_json
|
|
53
|
-
end
|
|
54
|
-
|
|
55
|
-
it 'set default values for missing params in the request' do
|
|
56
|
-
get("/user?type2=value2")
|
|
57
|
-
last_response.status.should == 200
|
|
58
|
-
last_response.body.should == { :type1 => 'default-type1', :type2 => 'value2' }.to_json
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
it 'set default values for optional params and allow to use required fields in the same time' do
|
|
62
|
-
get("/message?id=1")
|
|
63
|
-
last_response.status.should == 200
|
|
64
|
-
last_response.body.should == { :id => '1', :type1 => 'default-type1', :type2 => 'default-type2' }.to_json
|
|
65
|
-
end
|
|
66
|
-
end
|
|
67
|
-
|
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
describe Grape::Validations::PresenceValidator do
|
|
4
|
-
|
|
5
|
-
module ValidationsSpec
|
|
6
|
-
module PresenceValidatorSpec
|
|
7
|
-
class API < Grape::API
|
|
8
|
-
default_format :json
|
|
9
|
-
|
|
10
|
-
resource :bacons do
|
|
11
|
-
get do
|
|
12
|
-
"All the bacon"
|
|
13
|
-
end
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
params do
|
|
17
|
-
requires :id, :regexp => /^[0-9]+$/
|
|
18
|
-
end
|
|
19
|
-
post do
|
|
20
|
-
{ :ret => params[:id] }
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
params do
|
|
24
|
-
requires :name, :company
|
|
25
|
-
end
|
|
26
|
-
get do
|
|
27
|
-
"Hello"
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
params do
|
|
31
|
-
group :user do
|
|
32
|
-
requires :first_name, :last_name
|
|
33
|
-
end
|
|
34
|
-
end
|
|
35
|
-
get '/nested' do
|
|
36
|
-
"Nested"
|
|
37
|
-
end
|
|
38
|
-
|
|
39
|
-
params do
|
|
40
|
-
group :admin do
|
|
41
|
-
requires :admin_name
|
|
42
|
-
group :super do
|
|
43
|
-
group :user do
|
|
44
|
-
requires :first_name, :last_name
|
|
45
|
-
end
|
|
46
|
-
end
|
|
47
|
-
end
|
|
48
|
-
end
|
|
49
|
-
get '/nested_triple' do
|
|
50
|
-
"Nested triple"
|
|
51
|
-
end
|
|
52
|
-
end
|
|
53
|
-
end
|
|
54
|
-
end
|
|
55
|
-
|
|
56
|
-
def app
|
|
57
|
-
ValidationsSpec::PresenceValidatorSpec::API
|
|
58
|
-
end
|
|
59
|
-
|
|
60
|
-
it 'does not validate for any params' do
|
|
61
|
-
get("/bacons")
|
|
62
|
-
last_response.status.should == 200
|
|
63
|
-
last_response.body.should == "All the bacon".to_json
|
|
64
|
-
end
|
|
65
|
-
|
|
66
|
-
it 'validates id' do
|
|
67
|
-
post '/'
|
|
68
|
-
last_response.status.should == 400
|
|
69
|
-
last_response.body.should == '{"error":"missing parameter: id"}'
|
|
70
|
-
|
|
71
|
-
io = StringIO.new('{"id" : "a56b"}')
|
|
72
|
-
post '/', {}, 'rack.input' => io,
|
|
73
|
-
'CONTENT_TYPE' => 'application/json',
|
|
74
|
-
'CONTENT_LENGTH' => io.length
|
|
75
|
-
last_response.body.should == '{"error":"invalid parameter: id"}'
|
|
76
|
-
last_response.status.should == 400
|
|
77
|
-
|
|
78
|
-
io = StringIO.new('{"id" : 56}')
|
|
79
|
-
post '/', {}, 'rack.input' => io,
|
|
80
|
-
'CONTENT_TYPE' => 'application/json',
|
|
81
|
-
'CONTENT_LENGTH' => io.length
|
|
82
|
-
last_response.body.should == '{"ret":56}'
|
|
83
|
-
last_response.status.should == 201
|
|
84
|
-
end
|
|
85
|
-
|
|
86
|
-
it 'validates name, company' do
|
|
87
|
-
get('/')
|
|
88
|
-
last_response.status.should == 400
|
|
89
|
-
last_response.body.should == '{"error":"missing parameter: name"}'
|
|
90
|
-
|
|
91
|
-
get('/', :name => "Bob")
|
|
92
|
-
last_response.status.should == 400
|
|
93
|
-
last_response.body.should == '{"error":"missing parameter: company"}'
|
|
94
|
-
|
|
95
|
-
get('/', :name => "Bob", :company => "TestCorp")
|
|
96
|
-
last_response.status.should == 200
|
|
97
|
-
last_response.body.should == "Hello".to_json
|
|
98
|
-
end
|
|
99
|
-
|
|
100
|
-
it 'validates nested parameters' do
|
|
101
|
-
get('/nested')
|
|
102
|
-
last_response.status.should == 400
|
|
103
|
-
last_response.body.should == '{"error":"missing parameter: user[first_name]"}'
|
|
104
|
-
|
|
105
|
-
get('/nested', :user => {:first_name => "Billy"})
|
|
106
|
-
last_response.status.should == 400
|
|
107
|
-
last_response.body.should == '{"error":"missing parameter: user[last_name]"}'
|
|
108
|
-
|
|
109
|
-
get('/nested', :user => {:first_name => "Billy", :last_name => "Bob"})
|
|
110
|
-
last_response.status.should == 200
|
|
111
|
-
last_response.body.should == "Nested".to_json
|
|
112
|
-
end
|
|
113
|
-
|
|
114
|
-
it 'validates triple nested parameters' do
|
|
115
|
-
get('/nested_triple')
|
|
116
|
-
last_response.status.should == 400
|
|
117
|
-
last_response.body.should == '{"error":"missing parameter: admin[admin_name]"}'
|
|
118
|
-
|
|
119
|
-
get('/nested_triple', :user => {:first_name => "Billy"})
|
|
120
|
-
last_response.status.should == 400
|
|
121
|
-
last_response.body.should == '{"error":"missing parameter: admin[admin_name]"}'
|
|
122
|
-
|
|
123
|
-
get('/nested_triple', :admin => {:super => {:first_name => "Billy"}})
|
|
124
|
-
last_response.status.should == 400
|
|
125
|
-
last_response.body.should == '{"error":"missing parameter: admin[admin_name]"}'
|
|
126
|
-
|
|
127
|
-
get('/nested_triple', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}})
|
|
128
|
-
last_response.status.should == 400
|
|
129
|
-
last_response.body.should == '{"error":"missing parameter: admin[admin_name]"}'
|
|
130
|
-
|
|
131
|
-
get('/nested_triple', :admin => {:super => {:user => {:first_name => "Billy"}}})
|
|
132
|
-
last_response.status.should == 400
|
|
133
|
-
last_response.body.should == '{"error":"missing parameter: admin[admin_name]"}'
|
|
134
|
-
|
|
135
|
-
get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy"}}})
|
|
136
|
-
last_response.status.should == 400
|
|
137
|
-
last_response.body.should == '{"error":"missing parameter: admin[super][user][last_name]"}'
|
|
138
|
-
|
|
139
|
-
get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}}})
|
|
140
|
-
last_response.status.should == 200
|
|
141
|
-
last_response.body.should == "Nested triple".to_json
|
|
142
|
-
end
|
|
143
|
-
|
|
144
|
-
end
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
describe Grape::Validations::RegexpValidator do
|
|
4
|
-
module ValidationsSpec
|
|
5
|
-
module RegexpValidatorSpec
|
|
6
|
-
class API < Grape::API
|
|
7
|
-
default_format :json
|
|
8
|
-
|
|
9
|
-
params do
|
|
10
|
-
requires :name, :regexp => /^[a-z]+$/
|
|
11
|
-
end
|
|
12
|
-
get do
|
|
13
|
-
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
def app
|
|
20
|
-
ValidationsSpec::RegexpValidatorSpec::API
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
it 'refuses invalid input' do
|
|
24
|
-
get '/', :name => "invalid name"
|
|
25
|
-
last_response.status.should == 400
|
|
26
|
-
end
|
|
27
|
-
|
|
28
|
-
it 'accepts valid input' do
|
|
29
|
-
get '/', :name => "bob"
|
|
30
|
-
last_response.status.should == 200
|
|
31
|
-
end
|
|
32
|
-
|
|
33
|
-
end
|
|
@@ -1,217 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
describe Grape::Validations do
|
|
4
|
-
subject { Class.new(Grape::API) }
|
|
5
|
-
def app; subject end
|
|
6
|
-
|
|
7
|
-
describe 'params' do
|
|
8
|
-
context 'optional' do
|
|
9
|
-
it 'validates when params is present' do
|
|
10
|
-
subject.params { optional :a_number, :regexp => /^[0-9]+$/ }
|
|
11
|
-
subject.get '/optional' do 'optional works!'; end
|
|
12
|
-
|
|
13
|
-
get '/optional', { :a_number => 'string' }
|
|
14
|
-
last_response.status.should == 400
|
|
15
|
-
last_response.body.should == 'invalid parameter: a_number'
|
|
16
|
-
|
|
17
|
-
get '/optional', { :a_number => 45 }
|
|
18
|
-
last_response.status.should == 200
|
|
19
|
-
last_response.body.should == 'optional works!'
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
it "doesn't validate when param not present" do
|
|
23
|
-
subject.params { optional :a_number, :regexp => /^[0-9]+$/ }
|
|
24
|
-
subject.get '/optional' do 'optional works!'; end
|
|
25
|
-
|
|
26
|
-
get '/optional'
|
|
27
|
-
last_response.status.should == 200
|
|
28
|
-
last_response.body.should == 'optional works!'
|
|
29
|
-
end
|
|
30
|
-
|
|
31
|
-
it 'adds to declared parameters' do
|
|
32
|
-
subject.params { optional :some_param }
|
|
33
|
-
subject.settings[:declared_params].should == [:some_param]
|
|
34
|
-
end
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
context 'required' do
|
|
38
|
-
before do
|
|
39
|
-
subject.params { requires :key }
|
|
40
|
-
subject.get '/required' do 'required works'; end
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
it 'errors when param not present' do
|
|
44
|
-
get '/required'
|
|
45
|
-
last_response.status.should == 400
|
|
46
|
-
last_response.body.should == 'missing parameter: key'
|
|
47
|
-
end
|
|
48
|
-
|
|
49
|
-
it "doesn't throw a missing param when param is present" do
|
|
50
|
-
get '/required', { :key => 'cool' }
|
|
51
|
-
last_response.status.should == 200
|
|
52
|
-
last_response.body.should == 'required works'
|
|
53
|
-
end
|
|
54
|
-
|
|
55
|
-
it 'adds to declared parameters' do
|
|
56
|
-
subject.params { requires :some_param }
|
|
57
|
-
subject.settings[:declared_params].should == [:some_param]
|
|
58
|
-
end
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
context 'group' do
|
|
62
|
-
before do
|
|
63
|
-
subject.params {
|
|
64
|
-
group :items do
|
|
65
|
-
requires :key
|
|
66
|
-
end
|
|
67
|
-
}
|
|
68
|
-
subject.get '/required' do 'required works'; end
|
|
69
|
-
end
|
|
70
|
-
|
|
71
|
-
it 'errors when param not present' do
|
|
72
|
-
get '/required'
|
|
73
|
-
last_response.status.should == 400
|
|
74
|
-
last_response.body.should == 'missing parameter: items[key]'
|
|
75
|
-
end
|
|
76
|
-
|
|
77
|
-
it "doesn't throw a missing param when param is present" do
|
|
78
|
-
get '/required', { :items => [:key => 'hello', :key => 'world'] }
|
|
79
|
-
last_response.status.should == 200
|
|
80
|
-
last_response.body.should == 'required works'
|
|
81
|
-
end
|
|
82
|
-
|
|
83
|
-
it 'adds to declared parameters' do
|
|
84
|
-
subject.params {
|
|
85
|
-
group :items do
|
|
86
|
-
requires :key
|
|
87
|
-
end
|
|
88
|
-
}
|
|
89
|
-
subject.settings[:declared_params].should == [:items => [:key]]
|
|
90
|
-
end
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
context 'custom validation' do
|
|
94
|
-
module CustomValidations
|
|
95
|
-
class Customvalidator < Grape::Validations::Validator
|
|
96
|
-
def validate_param!(attr_name, params)
|
|
97
|
-
unless params[attr_name] == 'im custom'
|
|
98
|
-
throw :error, :status => 400, :message => "#{attr_name}: is not custom!"
|
|
99
|
-
end
|
|
100
|
-
end
|
|
101
|
-
end
|
|
102
|
-
end
|
|
103
|
-
|
|
104
|
-
context 'when using optional with a custom validator' do
|
|
105
|
-
before do
|
|
106
|
-
subject.params { optional :custom, :customvalidator => true }
|
|
107
|
-
subject.get '/optional_custom' do 'optional with custom works!'; end
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
it 'validates when param is present' do
|
|
111
|
-
get '/optional_custom', { :custom => 'im custom' }
|
|
112
|
-
last_response.status.should == 200
|
|
113
|
-
last_response.body.should == 'optional with custom works!'
|
|
114
|
-
|
|
115
|
-
get '/optional_custom', { :custom => 'im wrong' }
|
|
116
|
-
last_response.status.should == 400
|
|
117
|
-
last_response.body.should == 'custom: is not custom!'
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
it "skips validation when parameter isn't present" do
|
|
121
|
-
get '/optional_custom'
|
|
122
|
-
last_response.status.should == 200
|
|
123
|
-
last_response.body.should == 'optional with custom works!'
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
it 'validates with custom validator when param present and incorrect type' do
|
|
127
|
-
subject.params { optional :custom, :type => String, :customvalidator => true }
|
|
128
|
-
|
|
129
|
-
get '/optional_custom', { :custom => 123 }
|
|
130
|
-
last_response.status.should == 400
|
|
131
|
-
last_response.body.should == 'custom: is not custom!'
|
|
132
|
-
end
|
|
133
|
-
end
|
|
134
|
-
|
|
135
|
-
context 'when using requires with a custom validator' do
|
|
136
|
-
before do
|
|
137
|
-
subject.params { requires :custom, :customvalidator => true }
|
|
138
|
-
subject.get '/required_custom' do 'required with custom works!'; end
|
|
139
|
-
end
|
|
140
|
-
|
|
141
|
-
it 'validates when param is present' do
|
|
142
|
-
get '/required_custom', { :custom => 'im wrong, validate me' }
|
|
143
|
-
last_response.status.should == 400
|
|
144
|
-
last_response.body.should == 'custom: is not custom!'
|
|
145
|
-
|
|
146
|
-
get '/required_custom', { :custom => 'im custom' }
|
|
147
|
-
last_response.status.should == 200
|
|
148
|
-
last_response.body.should == 'required with custom works!'
|
|
149
|
-
end
|
|
150
|
-
|
|
151
|
-
it 'validates when param is not present' do
|
|
152
|
-
get '/required_custom'
|
|
153
|
-
last_response.status.should == 400
|
|
154
|
-
last_response.body.should == 'missing parameter: custom'
|
|
155
|
-
end
|
|
156
|
-
|
|
157
|
-
context 'nested namespaces' do
|
|
158
|
-
before do
|
|
159
|
-
subject.params { requires :custom, :customvalidator => true }
|
|
160
|
-
subject.namespace 'nested' do
|
|
161
|
-
get 'one' do 'validation failed' end
|
|
162
|
-
namespace 'nested' do
|
|
163
|
-
get 'two' do 'validation failed' end
|
|
164
|
-
end
|
|
165
|
-
end
|
|
166
|
-
subject.namespace 'peer' do
|
|
167
|
-
get 'one' do 'no validation required' end
|
|
168
|
-
namespace 'nested' do
|
|
169
|
-
get 'two' do 'no validation required' end
|
|
170
|
-
end
|
|
171
|
-
end
|
|
172
|
-
|
|
173
|
-
subject.namespace 'unrelated' do
|
|
174
|
-
params{ requires :name }
|
|
175
|
-
get 'one' do 'validation required'; end
|
|
176
|
-
|
|
177
|
-
namespace 'double' do
|
|
178
|
-
get 'two' do 'no validation required' end
|
|
179
|
-
end
|
|
180
|
-
end
|
|
181
|
-
end
|
|
182
|
-
|
|
183
|
-
specify 'the parent namespace uses the validator' do
|
|
184
|
-
get '/nested/one', { :custom => 'im wrong, validate me'}
|
|
185
|
-
last_response.status.should == 400
|
|
186
|
-
last_response.body.should == 'custom: is not custom!'
|
|
187
|
-
end
|
|
188
|
-
|
|
189
|
-
specify 'the nested namesapce inherits the custom validator' do
|
|
190
|
-
get '/nested/nested/two', { :custom => 'im wrong, validate me'}
|
|
191
|
-
last_response.status.should == 400
|
|
192
|
-
last_response.body.should == 'custom: is not custom!'
|
|
193
|
-
end
|
|
194
|
-
|
|
195
|
-
specify 'peer namesapces does not have the validator' do
|
|
196
|
-
get '/peer/one', { :custom => 'im not validated' }
|
|
197
|
-
last_response.status.should == 200
|
|
198
|
-
last_response.body.should == 'no validation required'
|
|
199
|
-
end
|
|
200
|
-
|
|
201
|
-
specify 'namespaces nested in peers should also not have the validator' do
|
|
202
|
-
get '/peer/nested/two', { :custom => 'im not validated' }
|
|
203
|
-
last_response.status.should == 200
|
|
204
|
-
last_response.body.should == 'no validation required'
|
|
205
|
-
end
|
|
206
|
-
|
|
207
|
-
specify 'when nested, specifying a route should clear out the validations for deeper nested params' do
|
|
208
|
-
get '/unrelated/one'
|
|
209
|
-
last_response.status.should == 400
|
|
210
|
-
get '/unrelated/double/two'
|
|
211
|
-
last_response.status.should == 200
|
|
212
|
-
end
|
|
213
|
-
end
|
|
214
|
-
end
|
|
215
|
-
end # end custom validation
|
|
216
|
-
end
|
|
217
|
-
end
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
shared_examples_for 'versioning' do
|
|
2
|
-
it 'sets the API version' do
|
|
3
|
-
subject.format :txt
|
|
4
|
-
subject.version 'v1', macro_options
|
|
5
|
-
subject.get :hello do
|
|
6
|
-
"Version: #{request.env['api.version']}"
|
|
7
|
-
end
|
|
8
|
-
versioned_get '/hello', 'v1', macro_options
|
|
9
|
-
last_response.body.should eql "Version: v1"
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
it 'adds the prefix before the API version' do
|
|
13
|
-
subject.format :txt
|
|
14
|
-
subject.prefix 'api'
|
|
15
|
-
subject.version 'v1', macro_options
|
|
16
|
-
subject.get :hello do
|
|
17
|
-
"Version: #{request.env['api.version']}"
|
|
18
|
-
end
|
|
19
|
-
versioned_get '/hello', 'v1', macro_options.merge(:prefix => 'api')
|
|
20
|
-
last_response.body.should eql "Version: v1"
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
it 'is able to specify version as a nesting' do
|
|
24
|
-
subject.version 'v2', macro_options
|
|
25
|
-
subject.get '/awesome' do
|
|
26
|
-
"Radical"
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
subject.version 'v1', macro_options do
|
|
30
|
-
get '/legacy' do
|
|
31
|
-
"Totally"
|
|
32
|
-
end
|
|
33
|
-
end
|
|
34
|
-
|
|
35
|
-
versioned_get '/awesome', 'v1', macro_options
|
|
36
|
-
last_response.status.should eql 404
|
|
37
|
-
|
|
38
|
-
versioned_get '/awesome', 'v2', macro_options
|
|
39
|
-
last_response.status.should eql 200
|
|
40
|
-
versioned_get '/legacy', 'v1', macro_options
|
|
41
|
-
last_response.status.should eql 200
|
|
42
|
-
versioned_get '/legacy', 'v2', macro_options
|
|
43
|
-
last_response.status.should eql 404
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
it 'is able to specify multiple versions' do
|
|
47
|
-
subject.version 'v1', 'v2', macro_options
|
|
48
|
-
subject.get 'awesome' do
|
|
49
|
-
"I exist"
|
|
50
|
-
end
|
|
51
|
-
|
|
52
|
-
versioned_get '/awesome', 'v1', macro_options
|
|
53
|
-
last_response.status.should eql 200
|
|
54
|
-
versioned_get '/awesome', 'v2', macro_options
|
|
55
|
-
last_response.status.should eql 200
|
|
56
|
-
versioned_get '/awesome', 'v3', macro_options
|
|
57
|
-
last_response.status.should eql 404
|
|
58
|
-
end
|
|
59
|
-
|
|
60
|
-
context 'with different versions for the same endpoint' do
|
|
61
|
-
context 'without a prefix' do
|
|
62
|
-
it 'allows the same endpoint to be implemented' do
|
|
63
|
-
subject.format :txt
|
|
64
|
-
subject.version 'v2', macro_options
|
|
65
|
-
subject.get 'version' do
|
|
66
|
-
request.env['api.version']
|
|
67
|
-
end
|
|
68
|
-
|
|
69
|
-
subject.version 'v1', macro_options do
|
|
70
|
-
get 'version' do
|
|
71
|
-
"version " + request.env['api.version']
|
|
72
|
-
end
|
|
73
|
-
end
|
|
74
|
-
|
|
75
|
-
versioned_get '/version', 'v2', macro_options
|
|
76
|
-
last_response.status.should == 200
|
|
77
|
-
last_response.body.should == 'v2'
|
|
78
|
-
versioned_get '/version', 'v1', macro_options
|
|
79
|
-
last_response.status.should == 200
|
|
80
|
-
last_response.body.should == 'version v1'
|
|
81
|
-
end
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
context 'with a prefix' do
|
|
85
|
-
it 'allows the same endpoint to be implemented' do
|
|
86
|
-
subject.format :txt
|
|
87
|
-
subject.prefix 'api'
|
|
88
|
-
subject.version 'v2', macro_options
|
|
89
|
-
subject.get 'version' do
|
|
90
|
-
request.env['api.version']
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
subject.version 'v1', macro_options do
|
|
94
|
-
get 'version' do
|
|
95
|
-
"version " + request.env['api.version']
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
|
|
99
|
-
versioned_get '/version', 'v1', macro_options.merge(:prefix => subject.prefix)
|
|
100
|
-
last_response.status.should == 200
|
|
101
|
-
last_response.body.should == 'version v1'
|
|
102
|
-
|
|
103
|
-
versioned_get '/version', 'v2', macro_options.merge(:prefix => subject.prefix)
|
|
104
|
-
last_response.status.should == 200
|
|
105
|
-
last_response.body.should == 'v2'
|
|
106
|
-
end
|
|
107
|
-
end
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
it 'does not overwrite version parameter with API version' do
|
|
111
|
-
subject.format :txt
|
|
112
|
-
subject.version 'v1', macro_options
|
|
113
|
-
subject.params { requires :version }
|
|
114
|
-
subject.get :api_version_with_version_param do
|
|
115
|
-
params[:version]
|
|
116
|
-
end
|
|
117
|
-
versioned_get '/api_version_with_version_param?version=1', 'v1', macro_options
|
|
118
|
-
last_response.body.should eql '1'
|
|
119
|
-
end
|
|
120
|
-
|
|
121
|
-
end
|
data/spec/spec_helper.rb
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
|
2
|
-
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
|
3
|
-
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
|
|
4
|
-
|
|
5
|
-
require 'grape'
|
|
6
|
-
|
|
7
|
-
# require 'grape-entity'
|
|
8
|
-
|
|
9
|
-
require 'rubygems'
|
|
10
|
-
require 'bundler'
|
|
11
|
-
Bundler.setup :default, :test
|
|
12
|
-
|
|
13
|
-
require 'rack/test'
|
|
14
|
-
require 'pry'
|
|
15
|
-
require 'base64'
|
|
16
|
-
require 'cookiejar'
|
|
17
|
-
require 'json'
|
|
18
|
-
|
|
19
|
-
Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
|
|
20
|
-
require file
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
RSpec.configure do |config|
|
|
24
|
-
config.include Rack::Test::Methods
|
|
25
|
-
end
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# Versioning
|
|
2
|
-
|
|
3
|
-
# Returns the path with options[:version] prefixed if options[:using] is :path.
|
|
4
|
-
# Returns normal path otherwise.
|
|
5
|
-
def versioned_path(options = {})
|
|
6
|
-
case options[:using]
|
|
7
|
-
when :path
|
|
8
|
-
File.join('/', options[:prefix] || '', options[:version], options[:path])
|
|
9
|
-
when :param
|
|
10
|
-
File.join('/', options[:prefix] || '', options[:path])
|
|
11
|
-
when :header
|
|
12
|
-
File.join('/', options[:prefix] || '', options[:path])
|
|
13
|
-
when :accept_version_header
|
|
14
|
-
File.join('/', options[:prefix] || '', options[:path])
|
|
15
|
-
else
|
|
16
|
-
raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
|
|
17
|
-
end
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
def versioned_headers(options)
|
|
21
|
-
case options[:using]
|
|
22
|
-
when :path
|
|
23
|
-
{} # no-op
|
|
24
|
-
when :param
|
|
25
|
-
{} # no-op
|
|
26
|
-
when :header
|
|
27
|
-
{
|
|
28
|
-
'HTTP_ACCEPT' => "application/vnd.#{options[:vendor]}-#{options[:version]}+#{options[:format]}"
|
|
29
|
-
}
|
|
30
|
-
when :accept_version_header
|
|
31
|
-
{
|
|
32
|
-
'HTTP_ACCEPT_VERSION' => "#{options[:version]}"
|
|
33
|
-
}
|
|
34
|
-
else
|
|
35
|
-
raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
|
|
39
|
-
def versioned_get(path, version_name, version_options = {})
|
|
40
|
-
path = versioned_path(version_options.merge(:version => version_name, :path => path))
|
|
41
|
-
headers = versioned_headers(version_options.merge(:version => version_name))
|
|
42
|
-
params = {}
|
|
43
|
-
if version_options[:using] == :param
|
|
44
|
-
params = { version_options[:parameter] => version_name }
|
|
45
|
-
end
|
|
46
|
-
get path, params, headers
|
|
47
|
-
end
|
|
48
|
-
|