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/Rakefile
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
require 'rubygems'
|
|
2
|
-
require 'bundler'
|
|
3
|
-
Bundler.setup :default, :test, :development
|
|
4
|
-
|
|
5
|
-
Bundler::GemHelper.install_tasks
|
|
6
|
-
|
|
7
|
-
require 'rspec/core/rake_task'
|
|
8
|
-
RSpec::Core::RakeTask.new(:spec) do |spec|
|
|
9
|
-
spec.pattern = 'spec/**/*_spec.rb'
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
RSpec::Core::RakeTask.new(:rcov) do |spec|
|
|
13
|
-
spec.pattern = 'spec/**/*_spec.rb'
|
|
14
|
-
spec.rcov = true
|
|
15
|
-
end
|
|
16
|
-
|
|
17
|
-
task :spec
|
|
18
|
-
task :default => :spec
|
|
19
|
-
|
|
20
|
-
begin
|
|
21
|
-
require 'yard'
|
|
22
|
-
DOC_FILES = ['lib/**/*.rb', 'README.md']
|
|
23
|
-
|
|
24
|
-
YARD::Rake::YardocTask.new(:doc) do |t|
|
|
25
|
-
t.files = DOC_FILES
|
|
26
|
-
end
|
|
27
|
-
|
|
28
|
-
namespace :doc do
|
|
29
|
-
YARD::Rake::YardocTask.new(:pages) do |t|
|
|
30
|
-
t.files = DOC_FILES
|
|
31
|
-
t.options = ['-o', '../grape.doc/docs']
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
namespace :pages do
|
|
35
|
-
|
|
36
|
-
desc "Check out gh-pages."
|
|
37
|
-
task :checkout do
|
|
38
|
-
dir = File.dirname(__FILE__) + '/../grape.doc'
|
|
39
|
-
unless Dir.exist?(dir)
|
|
40
|
-
Dir.mkdir(dir)
|
|
41
|
-
Dir.chdir(dir) do
|
|
42
|
-
system("git init")
|
|
43
|
-
system("git remote add origin git@github.com:intridea/grape.git")
|
|
44
|
-
system("git pull")
|
|
45
|
-
system("git checkout gh-pages")
|
|
46
|
-
end
|
|
47
|
-
end
|
|
48
|
-
end
|
|
49
|
-
|
|
50
|
-
desc 'Generate and publish YARD docs to GitHub pages.'
|
|
51
|
-
task :publish => ['doc:pages:checkout', 'doc:pages'] do
|
|
52
|
-
Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
|
|
53
|
-
system("git checkout gh-pages")
|
|
54
|
-
system("git add .")
|
|
55
|
-
system("git add -u")
|
|
56
|
-
system("git commit -m 'Generating docs for version #{Grape::VERSION}.'")
|
|
57
|
-
system("git push origin gh-pages")
|
|
58
|
-
end
|
|
59
|
-
end
|
|
60
|
-
end
|
|
61
|
-
end
|
|
62
|
-
rescue LoadError
|
|
63
|
-
puts "You need to install YARD."
|
|
64
|
-
end
|
data/lib/grape/http/request.rb
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
class Request < Rack::Request
|
|
3
|
-
|
|
4
|
-
def params
|
|
5
|
-
@env['grape.request.params'] ||= begin
|
|
6
|
-
params = Hashie::Mash.new(super)
|
|
7
|
-
if env['rack.routing_args']
|
|
8
|
-
args = env['rack.routing_args'].dup
|
|
9
|
-
# preserve version from query string parameters
|
|
10
|
-
args.delete(:version)
|
|
11
|
-
params.deep_merge!(args)
|
|
12
|
-
end
|
|
13
|
-
params
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
|
|
17
|
-
def headers
|
|
18
|
-
@env['grape.request.headers'] ||= @env.dup.inject({}) { |h, (k, v)|
|
|
19
|
-
if k.to_s.start_with? 'HTTP_'
|
|
20
|
-
k = k[5..-1].gsub('_', '-').downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }
|
|
21
|
-
h[k] = v
|
|
22
|
-
end
|
|
23
|
-
h
|
|
24
|
-
}
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
require 'rack/auth/basic'
|
|
2
|
-
|
|
3
|
-
module Grape
|
|
4
|
-
module Middleware
|
|
5
|
-
module Auth
|
|
6
|
-
class Basic < Grape::Middleware::Base
|
|
7
|
-
attr_reader :authenticator
|
|
8
|
-
|
|
9
|
-
def initialize(app, options = {}, &authenticator)
|
|
10
|
-
super(app, options)
|
|
11
|
-
@authenticator = authenticator
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
def basic_request
|
|
15
|
-
Rack::Auth::Basic::Request.new(env)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
def credentials
|
|
19
|
-
basic_request.provided?? basic_request.credentials : [nil, nil]
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
def before
|
|
23
|
-
unless authenticator.call(*credentials)
|
|
24
|
-
throw :error, :status => 401, :message => "API Authorization Failed."
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
end
|
|
30
|
-
end
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
require 'rack/auth/digest/md5'
|
|
2
|
-
|
|
3
|
-
module Grape
|
|
4
|
-
module Middleware
|
|
5
|
-
module Auth
|
|
6
|
-
class Digest < Grape::Middleware::Base
|
|
7
|
-
attr_reader :authenticator
|
|
8
|
-
|
|
9
|
-
def initialize(app, options = {}, &authenticator)
|
|
10
|
-
super(app, options)
|
|
11
|
-
@authenticator = authenticator
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
def digest_request
|
|
15
|
-
Rack::Auth::Digest::Request.new(env)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
def credentials
|
|
19
|
-
digest_request.provided?? digest_request.credentials : [nil, nil]
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
def before
|
|
23
|
-
unless authenticator.call(*credentials)
|
|
24
|
-
throw :error, :status => 401, :message => "API Authorization Failed."
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
end
|
|
30
|
-
end
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
module Grape::Middleware::Auth
|
|
2
|
-
# OAuth 2.0 authorization for Grape APIs.
|
|
3
|
-
class OAuth2 < Grape::Middleware::Base
|
|
4
|
-
def default_options
|
|
5
|
-
{
|
|
6
|
-
:token_class => 'AccessToken',
|
|
7
|
-
:realm => 'OAuth API',
|
|
8
|
-
:parameter => %w(bearer_token oauth_token),
|
|
9
|
-
:accepted_headers => %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
|
|
10
|
-
:header => [/Bearer (.*)/i, /OAuth (.*)/i]
|
|
11
|
-
}
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
def before
|
|
15
|
-
verify_token(token_parameter || token_header)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
def token_parameter
|
|
19
|
-
Array(options[:parameter]).each do |p|
|
|
20
|
-
return request[p] if request[p]
|
|
21
|
-
end
|
|
22
|
-
nil
|
|
23
|
-
end
|
|
24
|
-
|
|
25
|
-
def token_header
|
|
26
|
-
return false unless authorization_header
|
|
27
|
-
Array(options[:header]).each do |regexp|
|
|
28
|
-
if authorization_header =~ regexp
|
|
29
|
-
return $1
|
|
30
|
-
end
|
|
31
|
-
end
|
|
32
|
-
nil
|
|
33
|
-
end
|
|
34
|
-
|
|
35
|
-
def authorization_header
|
|
36
|
-
options[:accepted_headers].each do |head|
|
|
37
|
-
return env[head] if env[head]
|
|
38
|
-
end
|
|
39
|
-
nil
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
def token_class
|
|
43
|
-
@klass ||= eval(options[:token_class])
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
def verify_token(token)
|
|
47
|
-
if token = token_class.verify(token)
|
|
48
|
-
if token.respond_to?(:expired?) && token.expired?
|
|
49
|
-
error_out(401, 'expired_token')
|
|
50
|
-
else
|
|
51
|
-
if !token.respond_to?(:permission_for?) || token.permission_for?(env)
|
|
52
|
-
env['api.token'] = token
|
|
53
|
-
else
|
|
54
|
-
error_out(403, 'insufficient_scope')
|
|
55
|
-
end
|
|
56
|
-
end
|
|
57
|
-
else
|
|
58
|
-
error_out(401, 'invalid_token')
|
|
59
|
-
end
|
|
60
|
-
end
|
|
61
|
-
|
|
62
|
-
def error_out(status, error)
|
|
63
|
-
throw :error,
|
|
64
|
-
:message => error,
|
|
65
|
-
:status => status,
|
|
66
|
-
:headers => {
|
|
67
|
-
'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
|
|
68
|
-
}
|
|
69
|
-
end
|
|
70
|
-
end
|
|
71
|
-
end
|
|
72
|
-
|
data/lib/grape/route.rb
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
|
|
3
|
-
# A compiled route for inspection.
|
|
4
|
-
class Route
|
|
5
|
-
|
|
6
|
-
def initialize(options = {})
|
|
7
|
-
@options = options || {}
|
|
8
|
-
end
|
|
9
|
-
|
|
10
|
-
def method_missing(method_id, *arguments)
|
|
11
|
-
if match = /route_([_a-zA-Z]\w*)/.match(method_id.to_s)
|
|
12
|
-
@options[match.captures.last.to_sym]
|
|
13
|
-
else
|
|
14
|
-
super
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
def to_s
|
|
19
|
-
"version=#{route_version}, method=#{route_method}, path=#{route_path}"
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
end
|
|
23
|
-
end
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
module ContentTypes
|
|
3
|
-
# Content types are listed in order of preference.
|
|
4
|
-
CONTENT_TYPES = ActiveSupport::OrderedHash[
|
|
5
|
-
:xml, 'application/xml',
|
|
6
|
-
:serializable_hash, 'application/json',
|
|
7
|
-
:json, 'application/json',
|
|
8
|
-
:atom, 'application/atom+xml',
|
|
9
|
-
:rss, 'application/rss+xml',
|
|
10
|
-
:txt, 'text/plain',
|
|
11
|
-
]
|
|
12
|
-
|
|
13
|
-
def self.content_types_for(from_settings)
|
|
14
|
-
from_settings || Grape::ContentTypes::CONTENT_TYPES
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
class Hash
|
|
2
|
-
# deep_merge from rails
|
|
3
|
-
# activesupport/lib/active_support/core_ext/hash/deep_merge.rb
|
|
4
|
-
# Returns a new hash with +self+ and +other_hash+ merged recursively.
|
|
5
|
-
#
|
|
6
|
-
# h1 = {:x => {:y => [4,5,6]}, :z => [7,8,9]}
|
|
7
|
-
# h2 = {:x => {:y => [7,8,9]}, :z => "xyz"}
|
|
8
|
-
#
|
|
9
|
-
# h1.deep_merge(h2) #=> { :x => {:y => [7, 8, 9]}, :z => "xyz" }
|
|
10
|
-
# h2.deep_merge(h1) #=> { :x => {:y => [4, 5, 6]}, :z => [7, 8, 9] }
|
|
11
|
-
def deep_merge(other_hash)
|
|
12
|
-
dup.deep_merge!(other_hash)
|
|
13
|
-
end
|
|
14
|
-
|
|
15
|
-
# Same as +deep_merge+, but modifies +self+.
|
|
16
|
-
def deep_merge!(other_hash)
|
|
17
|
-
other_hash.each_pair do |k,v|
|
|
18
|
-
tv = self[k]
|
|
19
|
-
self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
|
|
20
|
-
end
|
|
21
|
-
self
|
|
22
|
-
end
|
|
23
|
-
end
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
module Util
|
|
3
|
-
# HashStack is a stack of hashes. When retrieving a value, keys of the top
|
|
4
|
-
# hash on the stack take precendent over the lower keys.
|
|
5
|
-
class HashStack
|
|
6
|
-
# Unmerged array of hashes to represent the stack.
|
|
7
|
-
# The top of the stack is the last element.
|
|
8
|
-
attr_reader :stack
|
|
9
|
-
|
|
10
|
-
# TODO: handle aggregates
|
|
11
|
-
def initialize
|
|
12
|
-
@stack = [{}]
|
|
13
|
-
end
|
|
14
|
-
|
|
15
|
-
# Returns the top hash on the stack
|
|
16
|
-
def peek
|
|
17
|
-
@stack.last
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
# Add a new hash to the top of the stack.
|
|
21
|
-
#
|
|
22
|
-
# @param hash [Hash] optional hash to be pushed. Defaults to empty hash
|
|
23
|
-
# @return [HashStack]
|
|
24
|
-
def push(hash = {})
|
|
25
|
-
@stack.push(hash)
|
|
26
|
-
self
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
def pop
|
|
30
|
-
@stack.pop
|
|
31
|
-
end
|
|
32
|
-
|
|
33
|
-
# Looks through the stack for the first frame that matches :key
|
|
34
|
-
#
|
|
35
|
-
# @param key [Symbol] key to look for in hash frames
|
|
36
|
-
# @return value of given key after merging the stack
|
|
37
|
-
def get(key)
|
|
38
|
-
(@stack.length - 1).downto(0).each do |i|
|
|
39
|
-
return @stack[i][key] if @stack[i].key? key
|
|
40
|
-
end
|
|
41
|
-
nil
|
|
42
|
-
end
|
|
43
|
-
alias_method :[], :get
|
|
44
|
-
|
|
45
|
-
# Looks through the stack for the first frame that matches :key
|
|
46
|
-
#
|
|
47
|
-
# @param key [Symbol] key to look for in hash frames
|
|
48
|
-
# @return true if key exists, false otherwise
|
|
49
|
-
def has_key?(key)
|
|
50
|
-
(@stack.length - 1).downto(0).each do |i|
|
|
51
|
-
return true if @stack[i].key? key
|
|
52
|
-
end
|
|
53
|
-
false
|
|
54
|
-
end
|
|
55
|
-
|
|
56
|
-
# Replace a value on the top hash of the stack.
|
|
57
|
-
#
|
|
58
|
-
# @param key [Symbol] The key to set.
|
|
59
|
-
# @param value [Object] The value to set.
|
|
60
|
-
def set(key, value)
|
|
61
|
-
peek[key.to_sym] = value
|
|
62
|
-
end
|
|
63
|
-
alias_method :[]=, :set
|
|
64
|
-
|
|
65
|
-
# Replace multiple values on the top hash of the stack.
|
|
66
|
-
#
|
|
67
|
-
# @param hash [Hash] Hash of values to be merged in.
|
|
68
|
-
def update(hash)
|
|
69
|
-
peek.merge!(hash)
|
|
70
|
-
self
|
|
71
|
-
end
|
|
72
|
-
|
|
73
|
-
# Adds addition value into the top hash of the stack
|
|
74
|
-
def imbue(key, value)
|
|
75
|
-
current = peek[key.to_sym]
|
|
76
|
-
if current.is_a?(Array)
|
|
77
|
-
current.concat(value)
|
|
78
|
-
elsif current.is_a?(Hash)
|
|
79
|
-
current.merge!(value)
|
|
80
|
-
else
|
|
81
|
-
set(key, value)
|
|
82
|
-
end
|
|
83
|
-
end
|
|
84
|
-
|
|
85
|
-
# Prepend another HashStack's to self
|
|
86
|
-
def prepend(hash_stack)
|
|
87
|
-
@stack.unshift *hash_stack.stack
|
|
88
|
-
self
|
|
89
|
-
end
|
|
90
|
-
|
|
91
|
-
# Concatenate another HashStack's to self
|
|
92
|
-
def concat(hash_stack)
|
|
93
|
-
@stack.concat hash_stack.stack
|
|
94
|
-
self
|
|
95
|
-
end
|
|
96
|
-
|
|
97
|
-
# Looks through the stack for all instances of a given key and returns
|
|
98
|
-
# them as a flat Array.
|
|
99
|
-
#
|
|
100
|
-
# @param key [Symbol] The key to gather
|
|
101
|
-
# @return [Array]
|
|
102
|
-
def gather(key)
|
|
103
|
-
stack.map{|s| s[key] }.flatten.compact.uniq
|
|
104
|
-
end
|
|
105
|
-
|
|
106
|
-
def to_s
|
|
107
|
-
@stack.to_s
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
def clone
|
|
111
|
-
new_stack = HashStack.new
|
|
112
|
-
stack.each do |frame|
|
|
113
|
-
new_stack.push frame.clone
|
|
114
|
-
end
|
|
115
|
-
new_stack.stack.shift
|
|
116
|
-
new_stack
|
|
117
|
-
end
|
|
118
|
-
end
|
|
119
|
-
end
|
|
120
|
-
end
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
|
|
3
|
-
class API
|
|
4
|
-
Boolean = Virtus::Attribute::Boolean
|
|
5
|
-
end
|
|
6
|
-
|
|
7
|
-
module Validations
|
|
8
|
-
|
|
9
|
-
class CoerceValidator < SingleOptionValidator
|
|
10
|
-
def validate_param!(attr_name, params)
|
|
11
|
-
new_value = coerce_value(@option, params[attr_name])
|
|
12
|
-
if valid_type?(new_value)
|
|
13
|
-
params[attr_name] = new_value
|
|
14
|
-
else
|
|
15
|
-
raise Grape::Exceptions::Validation, :status => 400,
|
|
16
|
-
:param => @scope.full_name(attr_name), :message_key => :coerce
|
|
17
|
-
end
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
class InvalidValue; end
|
|
21
|
-
private
|
|
22
|
-
|
|
23
|
-
def _valid_array_type?(type, values)
|
|
24
|
-
values.all? do |val|
|
|
25
|
-
_valid_single_type?(type, val)
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
def _valid_single_type?(klass, val)
|
|
30
|
-
# allow nil, to ignore when a parameter is absent
|
|
31
|
-
return true if val.nil?
|
|
32
|
-
if klass == Virtus::Attribute::Boolean
|
|
33
|
-
val.is_a?(TrueClass) || val.is_a?(FalseClass)
|
|
34
|
-
elsif klass == Rack::Multipart::UploadedFile
|
|
35
|
-
val.is_a?(Hashie::Mash) && val.key?(:tempfile)
|
|
36
|
-
else
|
|
37
|
-
val.is_a?(klass)
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
|
|
41
|
-
def valid_type?(val)
|
|
42
|
-
if @option.is_a?(Array)
|
|
43
|
-
_valid_array_type?(@option[0], val)
|
|
44
|
-
else
|
|
45
|
-
_valid_single_type?(@option, val)
|
|
46
|
-
end
|
|
47
|
-
end
|
|
48
|
-
|
|
49
|
-
def coerce_value(type, val)
|
|
50
|
-
converter = Virtus::Attribute.build(:a, type)
|
|
51
|
-
converter.coerce(val)
|
|
52
|
-
|
|
53
|
-
# not the prettiest but some invalid coercion can currently trigger
|
|
54
|
-
# errors in Virtus (see coerce_spec.rb)
|
|
55
|
-
rescue
|
|
56
|
-
InvalidValue.new
|
|
57
|
-
end
|
|
58
|
-
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
end
|
|
62
|
-
end
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
module Validations
|
|
3
|
-
class DefaultValidator < Validator
|
|
4
|
-
def initialize(attrs, options, required, scope)
|
|
5
|
-
@default = options
|
|
6
|
-
super
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
def validate_param!(attr_name, params)
|
|
10
|
-
params[attr_name] = @default unless params.has_key?(attr_name)
|
|
11
|
-
end
|
|
12
|
-
|
|
13
|
-
def validate!(params)
|
|
14
|
-
params = AttributesIterator.new(self, @scope, params)
|
|
15
|
-
params.each do |resource_params, attr_name|
|
|
16
|
-
if resource_params[attr_name].nil?
|
|
17
|
-
validate_param!(attr_name, resource_params)
|
|
18
|
-
end
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
end
|
|
23
|
-
end
|
|
24
|
-
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
module Validations
|
|
3
|
-
class PresenceValidator < Validator
|
|
4
|
-
def validate_param!(attr_name, params)
|
|
5
|
-
unless params.has_key?(attr_name)
|
|
6
|
-
raise Grape::Exceptions::Validation, :status => 400,
|
|
7
|
-
:param => @scope.full_name(attr_name), :message_key => :presence
|
|
8
|
-
end
|
|
9
|
-
end
|
|
10
|
-
end
|
|
11
|
-
end
|
|
12
|
-
end
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
module Grape
|
|
2
|
-
module Validations
|
|
3
|
-
|
|
4
|
-
class RegexpValidator < SingleOptionValidator
|
|
5
|
-
def validate_param!(attr_name, params)
|
|
6
|
-
if params[attr_name] && !( params[attr_name].to_s =~ @option )
|
|
7
|
-
raise Grape::Exceptions::Validation, :status => 400,
|
|
8
|
-
:param => @scope.full_name(attr_name), :message_key => :regexp
|
|
9
|
-
end
|
|
10
|
-
end
|
|
11
|
-
end
|
|
12
|
-
|
|
13
|
-
end
|
|
14
|
-
end
|