apipie-rails 0.5.19 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/build.yml +31 -0
- data/.github/workflows/rubocop-challenger.yml +28 -0
- data/.github/workflows/rubocop.yml +18 -0
- data/.gitignore +1 -0
- data/.rubocop.yml +128 -0
- data/.rubocop_todo.yml +2056 -0
- data/.vscode/settings.json +3 -0
- data/CHANGELOG.md +161 -0
- data/Gemfile +20 -0
- data/README.rst +117 -23
- data/Rakefile +0 -5
- data/apipie-rails.gemspec +18 -9
- data/app/controllers/apipie/apipies_controller.rb +14 -29
- data/app/helpers/apipie_helper.rb +1 -1
- data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js +70 -41
- data/app/public/apipie/javascripts/bundled/bootstrap.js +1033 -479
- data/app/public/apipie/javascripts/bundled/jquery.js +5 -5
- data/app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css +9 -12
- data/app/public/apipie/stylesheets/bundled/bootstrap.min.css +9 -689
- data/app/views/apipie/apipies/_deprecation.html.erb +16 -0
- data/app/views/apipie/apipies/_params.html.erb +7 -1
- data/config/locales/en.yml +8 -0
- data/config/locales/ko.yml +31 -0
- data/gemfiles/Gemfile.tools +9 -0
- data/lib/apipie/apipie_module.rb +7 -7
- data/lib/apipie/application.rb +132 -97
- data/lib/apipie/configuration.rb +43 -33
- data/lib/apipie/dsl_definition.rb +44 -33
- data/lib/apipie/error_description.rb +3 -3
- data/lib/apipie/errors.rb +17 -17
- data/lib/apipie/extractor/collector.rb +5 -6
- data/lib/apipie/extractor/recorder.rb +35 -8
- data/lib/apipie/extractor/writer.rb +15 -15
- data/lib/apipie/extractor.rb +6 -9
- data/lib/apipie/generator/config.rb +12 -0
- data/lib/apipie/generator/generator.rb +2 -0
- data/lib/apipie/generator/swagger/computed_interface_id.rb +23 -0
- data/lib/apipie/generator/swagger/config.rb +80 -0
- data/lib/apipie/generator/swagger/context.rb +38 -0
- data/lib/apipie/generator/swagger/method_description/api_decorator.rb +20 -0
- data/lib/apipie/generator/swagger/method_description/api_schema_service.rb +89 -0
- data/lib/apipie/generator/swagger/method_description/decorator.rb +22 -0
- data/lib/apipie/generator/swagger/method_description/parameters_service.rb +139 -0
- data/lib/apipie/generator/swagger/method_description/response_schema_service.rb +46 -0
- data/lib/apipie/generator/swagger/method_description/response_service.rb +58 -0
- data/lib/apipie/generator/swagger/method_description.rb +2 -0
- data/lib/apipie/generator/swagger/operation_id.rb +51 -0
- data/lib/apipie/generator/swagger/param_description/builder.rb +114 -0
- data/lib/apipie/generator/swagger/param_description/composite.rb +119 -0
- data/lib/apipie/generator/swagger/param_description/description.rb +15 -0
- data/lib/apipie/generator/swagger/param_description/in.rb +37 -0
- data/lib/apipie/generator/swagger/param_description/name.rb +18 -0
- data/lib/apipie/generator/swagger/param_description/path_params_composite.rb +61 -0
- data/lib/apipie/generator/swagger/param_description/referenced_composite.rb +36 -0
- data/lib/apipie/generator/swagger/param_description/type.rb +128 -0
- data/lib/apipie/generator/swagger/param_description.rb +18 -0
- data/lib/apipie/generator/swagger/path_decorator.rb +36 -0
- data/lib/apipie/generator/swagger/referenced_definitions.rb +17 -0
- data/lib/apipie/generator/swagger/resource_description_collection.rb +30 -0
- data/lib/apipie/generator/swagger/resource_description_composite.rb +56 -0
- data/lib/apipie/generator/swagger/schema.rb +63 -0
- data/lib/apipie/generator/swagger/swagger.rb +2 -0
- data/lib/apipie/generator/swagger/type.rb +16 -0
- data/lib/apipie/generator/swagger/type_extractor.rb +51 -0
- data/lib/apipie/generator/swagger/warning.rb +74 -0
- data/lib/apipie/generator/swagger/warning_writer.rb +54 -0
- data/lib/apipie/helpers.rb +3 -3
- data/lib/apipie/markup.rb +9 -8
- data/lib/apipie/method_description/api.rb +12 -0
- data/lib/apipie/method_description/apis_service.rb +82 -0
- data/lib/apipie/method_description.rb +12 -56
- data/lib/apipie/param_description/deprecation.rb +24 -0
- data/lib/apipie/param_description.rb +57 -24
- data/lib/apipie/resource_description.rb +42 -14
- data/lib/apipie/response_description.rb +3 -3
- data/lib/apipie/response_description_adapter.rb +12 -10
- data/lib/apipie/routing.rb +1 -1
- data/lib/apipie/rspec/response_validation_helper.rb +3 -3
- data/lib/apipie/static_dispatcher.rb +10 -2
- data/lib/apipie/swagger_generator.rb +28 -691
- data/lib/apipie/validator.rb +41 -11
- data/lib/apipie/version.rb +1 -1
- data/lib/apipie-rails.rb +36 -5
- data/lib/generators/apipie/install/install_generator.rb +1 -1
- data/lib/generators/apipie/views_generator.rb +1 -1
- data/lib/tasks/apipie.rake +37 -32
- data/rel-eng/gem_release.ipynb +41 -9
- data/spec/controllers/api/v2/architectures_controller_spec.rb +10 -3
- data/spec/controllers/api/v2/empty_middle_controller_spec.rb +23 -0
- data/spec/controllers/api/v2/nested/resources_controller_spec.rb +18 -2
- data/spec/controllers/api/v2/sub/footguns_controller_spec.rb +19 -0
- data/spec/controllers/included_param_group_controller_spec.rb +13 -0
- data/spec/{lib/swagger/response_validation_spec.rb → controllers/pets_controller_spec.rb} +26 -32
- data/spec/controllers/users_controller_spec.rb +47 -6
- data/spec/dummy/Rakefile +1 -1
- data/spec/dummy/app/controllers/api/v2/architectures_controller.rb +2 -1
- data/spec/dummy/app/controllers/api/v2/base_controller.rb +6 -0
- data/spec/dummy/app/controllers/api/v2/empty_middle_controller.rb +14 -0
- data/spec/dummy/app/controllers/api/v2/nested/resources_controller.rb +2 -2
- data/spec/dummy/app/controllers/api/v2/sub/footguns_controller.rb +30 -0
- data/spec/dummy/app/controllers/concerns_controller.rb +1 -1
- data/spec/dummy/app/controllers/{concerns/extending_concern.rb → extending_concern.rb} +0 -2
- data/spec/dummy/app/controllers/included_param_group_controller.rb +19 -0
- data/spec/dummy/app/controllers/overridden_concerns_controller.rb +2 -2
- data/spec/dummy/app/controllers/pets_controller.rb +5 -5
- data/spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb +2 -2
- data/spec/dummy/app/controllers/{concerns/sample_controller.rb → sample_controller.rb} +0 -2
- data/spec/dummy/app/controllers/twitter_example_controller.rb +2 -2
- data/spec/dummy/app/controllers/users_controller.rb +17 -5
- data/spec/dummy/app/helpers/random_param_group.rb +8 -0
- data/spec/dummy/components/test_engine/test_engine.gemspec +1 -1
- data/spec/dummy/config/application.rb +2 -5
- data/spec/dummy/config/boot.rb +2 -2
- data/spec/dummy/config/environment.rb +1 -1
- data/spec/dummy/config/environments/development.rb +0 -3
- data/spec/dummy/config/environments/production.rb +0 -3
- data/spec/dummy/config/environments/test.rb +0 -5
- data/spec/dummy/config/initializers/apipie.rb +2 -2
- data/spec/dummy/config/routes.rb +8 -0
- data/spec/dummy/config.ru +1 -1
- data/spec/dummy/script/rails +2 -2
- data/spec/{controllers → lib/apipie}/apipies_controller_spec.rb +95 -23
- data/spec/lib/apipie/application_spec.rb +62 -0
- data/spec/lib/apipie/configuration_spec.rb +38 -0
- data/spec/lib/apipie/extractor/collector_spec.rb +57 -0
- data/spec/lib/apipie/extractor/recorder_spec.rb +77 -0
- data/spec/lib/{extractor → apipie/extractor}/writer_spec.rb +8 -6
- data/spec/lib/{extractor → apipie}/extractor_spec.rb +1 -1
- data/spec/lib/{file_handler_spec.rb → apipie/file_handler_spec.rb} +7 -0
- data/spec/lib/apipie/generator/swagger/config_spec.rb +19 -0
- data/spec/lib/apipie/generator/swagger/context_spec.rb +56 -0
- data/spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb +119 -0
- data/spec/lib/apipie/generator/swagger/method_description/response_schema_service_spec.rb +105 -0
- data/spec/lib/apipie/generator/swagger/operation_id_spec.rb +63 -0
- data/spec/lib/apipie/generator/swagger/param_description/builder_spec.rb +215 -0
- data/spec/lib/apipie/generator/swagger/param_description/composite_spec.rb +95 -0
- data/spec/lib/apipie/generator/swagger/param_description/description_spec.rb +79 -0
- data/spec/lib/apipie/generator/swagger/param_description/in_spec.rb +86 -0
- data/spec/lib/apipie/generator/swagger/param_description/name_spec.rb +81 -0
- data/spec/lib/apipie/generator/swagger/param_description/type_spec.rb +183 -0
- data/spec/lib/apipie/generator/swagger/param_description_spec.rb +28 -0
- data/spec/lib/apipie/generator/swagger/path_decorator_spec.rb +57 -0
- data/spec/lib/apipie/generator/swagger/referenced_definitions_spec.rb +35 -0
- data/spec/lib/apipie/generator/swagger/resource_description_composite_spec.rb +37 -0
- data/spec/lib/apipie/generator/swagger/resource_descriptions_collection_spec.rb +57 -0
- data/spec/lib/apipie/generator/swagger/schema_spec.rb +89 -0
- data/spec/lib/apipie/generator/swagger/type_extractor_spec.rb +38 -0
- data/spec/lib/apipie/generator/swagger/warning_spec.rb +51 -0
- data/spec/lib/apipie/generator/swagger/warning_writer_spec.rb +71 -0
- data/spec/lib/apipie/method_description/apis_service_spec.rb +60 -0
- data/spec/lib/apipie/method_description_spec.rb +133 -0
- data/spec/lib/apipie/no_documented_method_spec.rb +17 -0
- data/spec/lib/apipie/param_description/deprecation_spec.rb +31 -0
- data/spec/lib/{param_description_spec.rb → apipie/param_description_spec.rb} +332 -6
- data/spec/lib/{param_group_spec.rb → apipie/param_group_spec.rb} +6 -5
- data/spec/lib/apipie/resource_description_spec.rb +91 -0
- data/spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb +35 -0
- data/spec/lib/apipie/swagger_generator_spec.rb +94 -0
- data/spec/lib/{validator_spec.rb → apipie/validator_spec.rb} +48 -12
- data/spec/lib/rake_spec.rb +3 -5
- data/spec/lib/swagger/openapi_2_0_schema.json +8 -1
- data/spec/lib/swagger/rake_swagger_spec.rb +30 -10
- data/spec/lib/swagger/swagger_dsl_spec.rb +18 -12
- data/spec/lib/validators/array_validator_spec.rb +1 -1
- data/spec/spec_helper.rb +10 -32
- data/spec/support/custom_bool_validator.rb +17 -0
- data/spec/{controllers → test_engine}/memes_controller_spec.rb +1 -1
- metadata +173 -125
- data/.travis.yml +0 -41
- data/Gemfile +0 -1
- data/Gemfile.rails41 +0 -7
- data/Gemfile.rails42 +0 -14
- data/Gemfile.rails50 +0 -9
- data/Gemfile.rails51 +0 -9
- data/Gemfile.rails60 +0 -10
- data/Gemfile.rails61 +0 -10
- data/spec/lib/application_spec.rb +0 -49
- data/spec/lib/method_description_spec.rb +0 -98
- data/spec/lib/resource_description_spec.rb +0 -48
- /data/spec/lib/{extractor → apipie/extractor/recorder}/middleware_spec.rb +0 -0
data/lib/apipie/configuration.rb
CHANGED
@@ -1,31 +1,45 @@
|
|
1
1
|
module Apipie
|
2
2
|
class Configuration
|
3
|
+
extend Forwardable
|
3
4
|
|
4
5
|
attr_accessor :app_name, :app_info, :copyright, :compress_examples,
|
5
6
|
:markup, :disqus_shortname,
|
6
7
|
:api_base_url, :doc_base_url, :required_by_default, :layout,
|
7
8
|
:default_version, :debug, :version_in_url, :namespaced_resources,
|
8
|
-
:validate, :validate_value, :validate_presence, :validate_key, :authenticate, :doc_path,
|
9
|
+
:validate, :validate_value, :validate_presence, :validate_key, :action_on_non_validated_keys, :authenticate, :doc_path,
|
9
10
|
:show_all_examples, :process_params, :update_checksum, :checksum_path,
|
10
11
|
:link_extension, :record, :languages, :translate, :locale, :default_locale,
|
11
|
-
:persist_show_in_doc, :authorize,
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
12
|
+
:persist_show_in_doc, :authorize, :ignore_allow_blank_false
|
13
|
+
|
14
|
+
def_delegators :swagger, *Apipie::Generator::Swagger::Config.deprecated_methods
|
15
|
+
|
16
|
+
def swagger
|
17
|
+
Apipie::Generator::Swagger::Config.instance
|
18
|
+
end
|
19
|
+
|
20
|
+
def generator
|
21
|
+
Apipie::Generator::Config.instance
|
22
|
+
end
|
23
|
+
|
24
|
+
alias validate? validate
|
25
|
+
alias required_by_default? required_by_default
|
26
|
+
alias namespaced_resources? namespaced_resources
|
23
27
|
|
24
28
|
# matcher to be used in Dir.glob to find controllers to be reloaded e.g.
|
25
29
|
#
|
26
30
|
# "#{Rails.root}/app/controllers/api/*.rb"
|
27
31
|
attr_accessor :api_controllers_matcher
|
28
32
|
|
33
|
+
# An object that responds to a `.call(controller)` method responsible for
|
34
|
+
# matching the correct controller action
|
35
|
+
attr_reader :api_action_matcher
|
36
|
+
|
37
|
+
def api_action_matcher=(callable)
|
38
|
+
raise 'Must implement .call method' unless callable.respond_to?(:call)
|
39
|
+
|
40
|
+
@api_action_matcher = callable
|
41
|
+
end
|
42
|
+
|
29
43
|
# set to true if you want to reload the controllers at each refresh of the
|
30
44
|
# documentation. It requires +:api_controllers_matcher+ to be set to work
|
31
45
|
# properly.
|
@@ -44,35 +58,36 @@ module Apipie
|
|
44
58
|
|
45
59
|
def reload_controllers?
|
46
60
|
@reload_controllers = Rails.env.development? unless defined? @reload_controllers
|
47
|
-
|
61
|
+
|
62
|
+
@reload_controllers && @api_controllers_matcher
|
48
63
|
end
|
49
64
|
|
50
65
|
def validate_value
|
51
|
-
|
66
|
+
validate? && @validate_value
|
52
67
|
end
|
53
|
-
|
68
|
+
alias validate_value? validate_value
|
54
69
|
|
55
70
|
def validate_presence
|
56
|
-
|
71
|
+
validate? && @validate_presence
|
57
72
|
end
|
58
|
-
|
73
|
+
alias validate_presence? validate_presence
|
59
74
|
|
60
75
|
def validate_key
|
61
|
-
|
76
|
+
validate? && @validate_key
|
62
77
|
end
|
63
|
-
|
78
|
+
alias validate_key? validate_key
|
64
79
|
|
65
80
|
def process_value?
|
66
81
|
@process_params
|
67
82
|
end
|
68
83
|
# set to true if you want to use pregenerated documentation cache and avoid
|
69
|
-
# generating the documentation on runtime (
|
84
|
+
# generating the documentation on runtime (useful for production
|
70
85
|
# environment).
|
71
86
|
# You can generate the cache by running
|
72
87
|
#
|
73
88
|
# rake apipie:cache
|
74
89
|
attr_accessor :use_cache
|
75
|
-
|
90
|
+
alias use_cache? use_cache
|
76
91
|
|
77
92
|
attr_writer :cache_dir
|
78
93
|
def cache_dir
|
@@ -98,7 +113,7 @@ module Apipie
|
|
98
113
|
end
|
99
114
|
|
100
115
|
# array of controller names (strings) (might include actions as well)
|
101
|
-
# to be ignored # when
|
116
|
+
# to be ignored # when generating the documentation
|
102
117
|
# e.g. %w[Api::CommentsController Api::PostsController#post]
|
103
118
|
attr_writer :ignored
|
104
119
|
def ignored
|
@@ -146,19 +161,22 @@ module Apipie
|
|
146
161
|
def initialize
|
147
162
|
@markup = Apipie::Markup::RDoc.new
|
148
163
|
@app_name = "Another API"
|
149
|
-
@app_info = HashWithIndifferentAccess.new
|
164
|
+
@app_info = ActiveSupport::HashWithIndifferentAccess.new
|
150
165
|
@copyright = nil
|
151
166
|
@validate = :implicitly
|
152
167
|
@validate_value = true
|
153
168
|
@validate_presence = true
|
154
169
|
@validate_key = false
|
170
|
+
@action_on_non_validated_keys = :raise
|
155
171
|
@required_by_default = false
|
156
|
-
@api_base_url = HashWithIndifferentAccess.new
|
172
|
+
@api_base_url = ActiveSupport::HashWithIndifferentAccess.new
|
173
|
+
@api_action_matcher = proc { |controller| controller.params[:action] }
|
157
174
|
@doc_base_url = "/apipie"
|
158
175
|
@layout = "apipie/apipie"
|
159
176
|
@disqus_shortname = nil
|
160
177
|
@default_version = "1.0"
|
161
178
|
@debug = false
|
179
|
+
@ignore_allow_blank_false = false
|
162
180
|
@version_in_url = true
|
163
181
|
@namespaced_resources = false
|
164
182
|
@doc_path = "doc"
|
@@ -173,14 +191,6 @@ module Apipie
|
|
173
191
|
@translate = lambda { |str, locale| str }
|
174
192
|
@persist_show_in_doc = false
|
175
193
|
@routes_formatter = RoutesFormatter.new
|
176
|
-
@swagger_content_type_input = :form_data # this can be :json or :form_data
|
177
|
-
@swagger_json_input_uses_refs = false
|
178
|
-
@swagger_include_warning_tags = false
|
179
|
-
@swagger_suppress_warnings = false #[105,100,102]
|
180
|
-
@swagger_api_host = "localhost:3000"
|
181
|
-
@swagger_generate_x_computed_id_field = false
|
182
|
-
@swagger_allow_additional_properties_in_response = false
|
183
|
-
@swagger_responses_use_refs = true
|
184
194
|
end
|
185
195
|
end
|
186
196
|
end
|
@@ -51,9 +51,6 @@ module Apipie
|
|
51
51
|
end
|
52
52
|
|
53
53
|
module Resource
|
54
|
-
# by default, the resource id is derived from controller_name
|
55
|
-
# it can be overwritten with.
|
56
|
-
#
|
57
54
|
# resource_id "my_own_resource_id"
|
58
55
|
def resource_id(resource_id)
|
59
56
|
Apipie.set_resource_id(@controller, resource_id)
|
@@ -70,7 +67,7 @@ module Apipie
|
|
70
67
|
def short(short)
|
71
68
|
_apipie_dsl_data[:short_description] = short
|
72
69
|
end
|
73
|
-
alias
|
70
|
+
alias short_description short
|
74
71
|
|
75
72
|
def path(path)
|
76
73
|
_apipie_dsl_data[:path] = path
|
@@ -96,7 +93,7 @@ module Apipie
|
|
96
93
|
# # load paths from routes and don't provide description
|
97
94
|
# api
|
98
95
|
#
|
99
|
-
def api(method, path, desc = nil, options={}) #:doc:
|
96
|
+
def api(method, path, desc = nil, options = {}) #:doc:
|
100
97
|
return unless Apipie.active_dsl?
|
101
98
|
_apipie_dsl_data[:api] = true
|
102
99
|
_apipie_dsl_data[:api_args] << [method, path, desc, options]
|
@@ -105,7 +102,7 @@ module Apipie
|
|
105
102
|
# # load paths from routes
|
106
103
|
# api! "short description",
|
107
104
|
#
|
108
|
-
def api!(desc = nil, options={}) #:doc:
|
105
|
+
def api!(desc = nil, options = {}) #:doc:
|
109
106
|
return unless Apipie.active_dsl?
|
110
107
|
_apipie_dsl_data[:api] = true
|
111
108
|
_apipie_dsl_data[:api_from_routes] = { :desc => desc, :options =>options }
|
@@ -139,20 +136,20 @@ module Apipie
|
|
139
136
|
#
|
140
137
|
# Example:
|
141
138
|
# api :desc => "Show user profile", :path => "/users/", :version => '1.0 - 3.4.2012'
|
142
|
-
# param :id,
|
139
|
+
# param :id, Integer, :desc => "User ID", :required => true
|
143
140
|
# desc <<-EOS
|
144
141
|
# Long description...
|
145
142
|
# EOS
|
146
143
|
def resource_description(options = {}, &block) #:doc:
|
147
144
|
return unless Apipie.active_dsl?
|
148
|
-
raise ArgumentError, "Block expected" unless
|
145
|
+
raise ArgumentError, "Block expected" unless block
|
149
146
|
|
150
147
|
dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
|
151
148
|
versions = dsl_data[:api_versions]
|
149
|
+
Apipie.set_controller_versions(self, versions)
|
152
150
|
@apipie_resource_descriptions = versions.map do |version|
|
153
151
|
Apipie.define_resource_description(self, version, dsl_data)
|
154
152
|
end
|
155
|
-
Apipie.set_controller_versions(self, versions)
|
156
153
|
end
|
157
154
|
end
|
158
155
|
|
@@ -160,7 +157,7 @@ module Apipie
|
|
160
157
|
def api_versions(*versions)
|
161
158
|
_apipie_dsl_data[:api_versions].concat(versions)
|
162
159
|
end
|
163
|
-
alias
|
160
|
+
alias api_version api_versions
|
164
161
|
|
165
162
|
# Describe the next method.
|
166
163
|
#
|
@@ -177,8 +174,8 @@ module Apipie
|
|
177
174
|
end
|
178
175
|
_apipie_dsl_data[:description] = description
|
179
176
|
end
|
180
|
-
alias
|
181
|
-
alias
|
177
|
+
alias description desc
|
178
|
+
alias full_description desc
|
182
179
|
|
183
180
|
# describe next method with document in given path
|
184
181
|
# in convension, these doc located under "#{Rails.root}/doc"
|
@@ -218,7 +215,7 @@ module Apipie
|
|
218
215
|
# puts "hello world"
|
219
216
|
# end
|
220
217
|
#
|
221
|
-
def error(code_or_options, desc=nil, options={}) #:doc:
|
218
|
+
def error(code_or_options, desc = nil, options = {}) #:doc:
|
222
219
|
return unless Apipie.active_dsl?
|
223
220
|
_apipie_dsl_data[:errors] << [code_or_options, desc, options]
|
224
221
|
end
|
@@ -244,16 +241,18 @@ module Apipie
|
|
244
241
|
method_params = self.class._apipie_get_method_params(action_name)
|
245
242
|
|
246
243
|
if Apipie.configuration.validate_presence?
|
247
|
-
|
248
|
-
|
249
|
-
|
244
|
+
Validator::BaseValidator.raise_if_missing_params do |missing|
|
245
|
+
method_params.each_value do |param|
|
246
|
+
# check if required parameters are present
|
247
|
+
missing << param if param.required && !params.key?(param.name)
|
248
|
+
end
|
250
249
|
end
|
251
250
|
end
|
252
251
|
|
253
252
|
if Apipie.configuration.validate_value?
|
254
|
-
method_params.
|
253
|
+
method_params.each_value do |param|
|
255
254
|
# params validations
|
256
|
-
param.validate(params[:"#{param.name}"]) if params.
|
255
|
+
param.validate(params[:"#{param.name}"]) if params.key?(param.name)
|
257
256
|
end
|
258
257
|
end
|
259
258
|
|
@@ -262,21 +261,22 @@ module Apipie
|
|
262
261
|
if Apipie.configuration.validate_key?
|
263
262
|
params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
|
264
263
|
# params allowed
|
265
|
-
|
264
|
+
if method_params.none? {|_,p| p.name.to_s == param.to_s}
|
265
|
+
self.class._apipie_handle_validate_key_error params, param
|
266
|
+
end
|
266
267
|
end
|
267
268
|
end
|
268
269
|
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
end
|
270
|
+
return unless Apipie.configuration.process_value?
|
271
|
+
@api_params ||= {}
|
272
|
+
method_params.each_value do |param|
|
273
|
+
# params processing
|
274
|
+
@api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
|
275
275
|
end
|
276
276
|
end
|
277
277
|
end
|
278
278
|
|
279
|
-
if
|
279
|
+
if Apipie.configuration.validate == :implicitly || Apipie.configuration.validate == true
|
280
280
|
old_method = instance_method(description.method)
|
281
281
|
|
282
282
|
define_method(description.method) do |*args|
|
@@ -286,7 +286,16 @@ module Apipie
|
|
286
286
|
old_method.bind(self).call(*args)
|
287
287
|
end
|
288
288
|
end
|
289
|
+
end
|
290
|
+
end
|
289
291
|
|
292
|
+
def _apipie_handle_validate_key_error params, param
|
293
|
+
case Apipie.configuration.action_on_non_validated_keys
|
294
|
+
when :raise
|
295
|
+
raise UnknownParam, param
|
296
|
+
when :skip
|
297
|
+
params.delete(param)
|
298
|
+
Rails.logger.warn(UnknownParam.new(param).to_s)
|
290
299
|
end
|
291
300
|
end
|
292
301
|
|
@@ -349,7 +358,7 @@ module Apipie
|
|
349
358
|
# Reuses param group for this method. The definition is looked up
|
350
359
|
# in scope of this controller. If the group was defined in
|
351
360
|
# different controller, the second param can be used to specify it.
|
352
|
-
# when using action_aware
|
361
|
+
# when using action_aware params, you can specify :as =>
|
353
362
|
# :create or :update to explicitly say how it should behave
|
354
363
|
def param_group(name, scope_or_options = nil, options = {})
|
355
364
|
if scope_or_options.is_a? Hash
|
@@ -391,7 +400,7 @@ module Apipie
|
|
391
400
|
# render json: {user: {name: "Alfred"}}
|
392
401
|
# end
|
393
402
|
#
|
394
|
-
def returns(pgroup_or_options, desc_or_options=nil, options={}, &block) #:doc:
|
403
|
+
def returns(pgroup_or_options, desc_or_options = nil, options = {}, &block) #:doc:
|
395
404
|
return unless Apipie.active_dsl?
|
396
405
|
|
397
406
|
|
@@ -496,7 +505,7 @@ module Apipie
|
|
496
505
|
end
|
497
506
|
|
498
507
|
def _apipie_update_meta(method_desc, dsl_data)
|
499
|
-
return unless dsl_data[:meta]
|
508
|
+
return unless dsl_data[:meta].is_a?(Hash)
|
500
509
|
|
501
510
|
method_desc.metadata ||= {}
|
502
511
|
method_desc.metadata.merge!(dsl_data[:meta])
|
@@ -514,15 +523,17 @@ module Apipie
|
|
514
523
|
end
|
515
524
|
end
|
516
525
|
# backwards compatibility
|
517
|
-
|
526
|
+
alias apipie_update_params apipie_update_methods
|
518
527
|
|
519
528
|
def _apipie_concern_subst
|
520
|
-
@_apipie_concern_subst ||= {
|
521
|
-
|
529
|
+
@_apipie_concern_subst ||= {
|
530
|
+
controller_path: self.controller_path,
|
531
|
+
resource_id: Apipie.get_resource_id(self)
|
532
|
+
}
|
522
533
|
end
|
523
534
|
|
524
535
|
def _apipie_perform_concern_subst(string)
|
525
|
-
|
536
|
+
_apipie_concern_subst.reduce(string) do |ret, (key, val)|
|
526
537
|
ret.gsub(":#{key}", val)
|
527
538
|
end
|
528
539
|
end
|
@@ -10,7 +10,7 @@ module Apipie
|
|
10
10
|
options)
|
11
11
|
end
|
12
12
|
|
13
|
-
def initialize(code_or_options, desc=nil, options={})
|
13
|
+
def initialize(code_or_options, desc = nil, options = {})
|
14
14
|
if code_or_options.is_a? Hash
|
15
15
|
code_or_options.symbolize_keys!
|
16
16
|
@code = code_or_options[:code]
|
@@ -31,10 +31,10 @@ module Apipie
|
|
31
31
|
end
|
32
32
|
end
|
33
33
|
|
34
|
-
def to_json
|
34
|
+
def to_json(lang)
|
35
35
|
{
|
36
36
|
:code => code,
|
37
|
-
:description => description,
|
37
|
+
:description => Apipie.app.translate(description, lang),
|
38
38
|
:metadata => metadata
|
39
39
|
}
|
40
40
|
end
|
data/lib/apipie/errors.rb
CHANGED
@@ -24,6 +24,20 @@ module Apipie
|
|
24
24
|
end
|
25
25
|
end
|
26
26
|
|
27
|
+
class ParamMultipleMissing < ParamError
|
28
|
+
attr_accessor :params
|
29
|
+
|
30
|
+
def initialize(params)
|
31
|
+
@params = params
|
32
|
+
end
|
33
|
+
|
34
|
+
def to_s
|
35
|
+
params.map do |param|
|
36
|
+
ParamMissing.new(param).to_s
|
37
|
+
end.join("\n")
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
27
41
|
class ParamMissing < DefinedParamError
|
28
42
|
def to_s
|
29
43
|
unless @param.options[:missing_message].nil?
|
@@ -48,7 +62,7 @@ module Apipie
|
|
48
62
|
attr_accessor :value, :error
|
49
63
|
|
50
64
|
def initialize(param, value, error)
|
51
|
-
super
|
65
|
+
super(param)
|
52
66
|
@value = value
|
53
67
|
@error = error
|
54
68
|
end
|
@@ -60,27 +74,13 @@ module Apipie
|
|
60
74
|
|
61
75
|
class ResponseDoesNotMatchSwaggerSchema < Error
|
62
76
|
def initialize(controller_name, method_name, response_code, error_messages, schema, returned_object)
|
63
|
-
|
64
|
-
@method_name = method_name
|
65
|
-
@response_code = response_code
|
66
|
-
@error_messages = error_messages
|
67
|
-
@schema = schema
|
68
|
-
@returned_object = returned_object
|
69
|
-
end
|
70
|
-
|
71
|
-
def to_s
|
72
|
-
"Response does not match swagger schema (#{@controller_name}##{@method_name} #{@response_code}): #{@error_messages}\nSchema: #{JSON(@schema)}\nReturned object: #{@returned_object}"
|
77
|
+
super("Response does not match swagger schema (#{controller_name}##{method_name} #{response_code}): #{error_messages}\nSchema: #{JSON(schema)}\nReturned object: #{returned_object}")
|
73
78
|
end
|
74
79
|
end
|
75
80
|
|
76
81
|
class NoDocumentedMethod < Error
|
77
82
|
def initialize(controller_name, method_name)
|
78
|
-
|
79
|
-
@controller_name = controller_name
|
80
|
-
end
|
81
|
-
|
82
|
-
def to_s
|
83
|
-
"There is no documented method #{@controller_name}##{@method_name}"
|
83
|
+
super("There is no documented method #{controller_name}##{method_name}")
|
84
84
|
end
|
85
85
|
end
|
86
86
|
end
|
@@ -19,21 +19,21 @@ module Apipie
|
|
19
19
|
def ignore_call?(record)
|
20
20
|
return true unless record[:controller]
|
21
21
|
return true if @ignored.include?(record[:controller].name)
|
22
|
-
return true if @ignored.include?("#{Apipie.
|
22
|
+
return true if @ignored.include?("#{Apipie.get_resource_id(record[:controller].name)}##{record[:action]}")
|
23
23
|
return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
|
24
24
|
end
|
25
25
|
|
26
26
|
def handle_record(record)
|
27
|
-
add_to_records(record)
|
28
27
|
if ignore_call?(record)
|
29
28
|
Extractor.logger.info("REST_API: skipping #{record_to_s(record)}")
|
30
29
|
else
|
30
|
+
add_to_records(record)
|
31
31
|
refine_description(record)
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
35
|
def add_to_records(record)
|
36
|
-
key = "#{Apipie.
|
36
|
+
key = "#{Apipie.get_resource_id(record[:controller])}##{record[:action]}"
|
37
37
|
@records[key] << record
|
38
38
|
end
|
39
39
|
|
@@ -89,14 +89,14 @@ module Apipie
|
|
89
89
|
end
|
90
90
|
|
91
91
|
def finalize_descriptions
|
92
|
-
@descriptions.
|
92
|
+
@descriptions.each_value do |desc|
|
93
93
|
add_routes_info(desc)
|
94
94
|
end
|
95
95
|
return @descriptions
|
96
96
|
end
|
97
97
|
|
98
98
|
def add_routes_info(desc)
|
99
|
-
api_prefix = Apipie.api_base_url.sub(
|
99
|
+
api_prefix = Apipie.api_base_url.sub(%r{/$},"")
|
100
100
|
desc[:api] = Apipie::Extractor.apis_from_routes[[desc[:controller].name, desc[:action]]]
|
101
101
|
if desc[:api]
|
102
102
|
desc[:params].each do |name, param|
|
@@ -114,4 +114,3 @@ module Apipie
|
|
114
114
|
end
|
115
115
|
end
|
116
116
|
end
|
117
|
-
|
@@ -9,7 +9,7 @@ module Apipie
|
|
9
9
|
|
10
10
|
def analyse_env(env)
|
11
11
|
@verb = env["REQUEST_METHOD"].to_sym
|
12
|
-
@path = env["PATH_INFO"].sub(
|
12
|
+
@path = env["PATH_INFO"].sub(%r{^/*},"/")
|
13
13
|
@query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
|
14
14
|
@params = Rack::Utils.parse_nested_query(@query)
|
15
15
|
@params.merge!(env["action_dispatch.request.request_parameters"] || {})
|
@@ -24,7 +24,7 @@ module Apipie
|
|
24
24
|
|
25
25
|
def analyse_controller(controller)
|
26
26
|
@controller = controller.class
|
27
|
-
@action = controller
|
27
|
+
@action = Apipie.configuration.api_action_matcher.call(controller)
|
28
28
|
end
|
29
29
|
|
30
30
|
def analyse_response(response)
|
@@ -44,11 +44,13 @@ module Apipie
|
|
44
44
|
@path = request.path
|
45
45
|
@params = request.request_parameters
|
46
46
|
if [:POST, :PUT, :PATCH, :DELETE].include?(@verb)
|
47
|
-
@request_data = @params
|
47
|
+
@request_data = request.content_type == "multipart/form-data" ? reformat_multipart_data(@params) : @params
|
48
48
|
else
|
49
49
|
@query = request.query_string
|
50
50
|
end
|
51
|
-
|
51
|
+
if response.media_type != 'application/pdf'
|
52
|
+
@response_data = parse_data(response.body)
|
53
|
+
end
|
52
54
|
@code = response.code
|
53
55
|
end
|
54
56
|
|
@@ -64,8 +66,14 @@ module Apipie
|
|
64
66
|
lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
|
65
67
|
boundary = "--#{MULTIPART_BOUNDARY}"
|
66
68
|
form.each do |key, attrs|
|
67
|
-
if attrs.is_a?(String)
|
69
|
+
if attrs.is_a?(String) # rubocop:disable Style/CaseLikeIf
|
68
70
|
lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
|
71
|
+
elsif attrs.is_a?(Rack::Test::UploadedFile) || attrs.is_a?(ActionDispatch::Http::UploadedFile)
|
72
|
+
reformat_uploaded_file(boundary, attrs, key, lines)
|
73
|
+
elsif attrs.is_a?(Array)
|
74
|
+
reformat_array(boundary, attrs, key, lines)
|
75
|
+
elsif attrs.is_a?(TrueClass) || attrs.is_a?(FalseClass)
|
76
|
+
reformat_boolean(boundary, attrs, key, lines)
|
69
77
|
else
|
70
78
|
reformat_hash(boundary, attrs, lines)
|
71
79
|
end
|
@@ -82,10 +90,28 @@ module Apipie
|
|
82
90
|
lines << '' << %{... contents of "#{attrs[:name]}" ...}
|
83
91
|
else
|
84
92
|
# Look for subelements that contain a part.
|
85
|
-
attrs.
|
93
|
+
attrs.each_value { |v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
def reformat_boolean(boundary, attrs, key, lines)
|
98
|
+
lines << boundary << content_disposition(key)
|
99
|
+
lines << '' << attrs.to_s
|
100
|
+
end
|
101
|
+
|
102
|
+
def reformat_array(boundary, attrs, key, lines)
|
103
|
+
attrs.each do |item|
|
104
|
+
lines << boundary << content_disposition("#{key}[]")
|
105
|
+
lines << '' << item
|
86
106
|
end
|
87
107
|
end
|
88
108
|
|
109
|
+
def reformat_uploaded_file(boundary, file, key, lines)
|
110
|
+
lines << boundary << %{#{content_disposition(key)}; filename="#{file.original_filename}"}
|
111
|
+
lines << "Content-Length: #{file.size}" << "Content-Type: #{file.content_type}" << "Content-Transfer-Encoding: binary"
|
112
|
+
lines << '' << %{... contents of "#{key}" ...}
|
113
|
+
end
|
114
|
+
|
89
115
|
def content_disposition(name)
|
90
116
|
%{Content-Disposition: form-data; name="#{name}"}
|
91
117
|
end
|
@@ -150,8 +176,8 @@ module Apipie
|
|
150
176
|
end
|
151
177
|
|
152
178
|
module FunctionalTestRecording
|
153
|
-
def process(*
|
154
|
-
ret = super
|
179
|
+
def process(*) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
|
180
|
+
ret = super
|
155
181
|
if Apipie.configuration.record
|
156
182
|
Apipie::Extractor.call_recorder.analyze_functional_test(self)
|
157
183
|
Apipie::Extractor.call_finished
|
@@ -160,6 +186,7 @@ module Apipie
|
|
160
186
|
ensure
|
161
187
|
Apipie::Extractor.clean_call_recorder
|
162
188
|
end
|
189
|
+
ruby2_keywords :process if respond_to?(:ruby2_keywords, true)
|
163
190
|
end
|
164
191
|
end
|
165
192
|
end
|
@@ -80,7 +80,7 @@ module Apipie
|
|
80
80
|
|
81
81
|
def write_docs
|
82
82
|
descriptions = @collector.finalize_descriptions
|
83
|
-
descriptions.
|
83
|
+
descriptions.each_value do |desc|
|
84
84
|
if desc[:api].empty?
|
85
85
|
logger.warn("REST_API: Couldn't find any path for #{desc_to_s(desc)}")
|
86
86
|
next
|
@@ -103,7 +103,7 @@ module Apipie
|
|
103
103
|
call = call.stringify_keys
|
104
104
|
ordered_call = OrderedHash.new
|
105
105
|
%w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
|
106
|
-
next unless call.
|
106
|
+
next unless call.key?(k)
|
107
107
|
ordered_call[k] = case call[k]
|
108
108
|
when ActiveSupport::HashWithIndifferentAccess
|
109
109
|
convert_file_value(call[k]).to_hash
|
@@ -116,9 +116,10 @@ module Apipie
|
|
116
116
|
|
117
117
|
def convert_file_value hash
|
118
118
|
hash.each do |k, v|
|
119
|
-
|
119
|
+
case v
|
120
|
+
when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile
|
120
121
|
hash[k] = "<FILE CONTENT '#{v.original_filename}'>"
|
121
|
-
|
122
|
+
when Hash
|
122
123
|
hash[k] = convert_file_value(v)
|
123
124
|
end
|
124
125
|
end
|
@@ -134,8 +135,8 @@ module Apipie
|
|
134
135
|
old_examples = self.load_recorded_examples
|
135
136
|
merged_examples = []
|
136
137
|
(new_examples.keys + old_examples.keys).uniq.each do |key|
|
137
|
-
if new_examples.
|
138
|
-
if old_examples.
|
138
|
+
if new_examples.key?(key)
|
139
|
+
if old_examples.key?(key)
|
139
140
|
records = deep_merge_examples(new_examples[key], old_examples[key])
|
140
141
|
else
|
141
142
|
records = new_examples[key]
|
@@ -190,7 +191,7 @@ module Apipie
|
|
190
191
|
end
|
191
192
|
|
192
193
|
def load_old_examples
|
193
|
-
if File.
|
194
|
+
if File.exist?(@examples_file)
|
194
195
|
if defined? SafeYAML
|
195
196
|
return YAML.load_file(@examples_file, :safe=>false)
|
196
197
|
else
|
@@ -295,7 +296,7 @@ module Apipie
|
|
295
296
|
end
|
296
297
|
|
297
298
|
def controller_content
|
298
|
-
raise ControllerNotFound.new unless controller_path && File.
|
299
|
+
raise ControllerNotFound.new unless controller_path && File.exist?(controller_path)
|
299
300
|
@controller_content ||= File.read(controller_path)
|
300
301
|
end
|
301
302
|
|
@@ -323,7 +324,7 @@ module Apipie
|
|
323
324
|
desc ||= case @action.to_s
|
324
325
|
when "show", "create", "update", "destroy"
|
325
326
|
name = name.singularize
|
326
|
-
"#{@action.capitalize} #{name =~ /^[aeiou]/ ?
|
327
|
+
"#{@action.capitalize} #{name =~ /^[aeiou]/ ? 'an' : 'a'} #{name}"
|
327
328
|
when "index"
|
328
329
|
"List #{name}"
|
329
330
|
end
|
@@ -407,12 +408,11 @@ module Apipie
|
|
407
408
|
if line =~ /\s*\b(module|class|def)\b /
|
408
409
|
break
|
409
410
|
end
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
end
|
411
|
+
next unless line =~ /do\s*(\|.*?\|)?\s*$/
|
412
|
+
block_level -= 1
|
413
|
+
if block_level == 0
|
414
|
+
added_lines.concat(lines_to_add)
|
415
|
+
lines_to_add = []
|
416
416
|
end
|
417
417
|
end
|
418
418
|
return added_lines.reverse.join
|