forked from Apipie/apipie-rails
/
application.rb
339 lines (287 loc) · 11.1 KB
/
application.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
require 'apipie/static_dispatcher'
require 'yaml'
require 'digest/md5'
require 'json'
module Apipie
class Application
# we need engine just for serving static assets
class Engine < Rails::Engine
initializer "static assets" do |app|
app.middleware.use ::Apipie::StaticDispatcher, "#{root}/app/public", Apipie.configuration.doc_base_url
end
end
attr_reader :resource_descriptions
def initialize
super
init_env
end
def available_versions
@resource_descriptions.keys.sort
end
def set_resource_id(controller, resource_id)
@controller_to_resource_id[controller] = resource_id
end
# create new method api description
def define_method_description(controller, method_name, dsl_data)
return if ignored?(controller, method_name)
ret_method_description = nil
versions = dsl_data[:api_versions] || []
versions = controller_versions(controller) if versions.empty?
versions.each do |version|
resource_name_with_version = "#{version}##{get_resource_name(controller)}"
resource_description = get_resource_description(resource_name_with_version)
if resource_description.nil?
resource_description = define_resource_description(controller, version)
end
method_description = Apipie::MethodDescription.new(method_name, resource_description, dsl_data)
# we create separate method description for each version in
# case the method belongs to more versions. We return just one
# becuase the version doesn't matter for the purpose it's used
# (to wrap the original version with validators)
ret_method_description ||= method_description
resource_description.add_method_description(method_description)
end
return ret_method_description
end
# create new resource api description
def define_resource_description(controller, version, dsl_data = nil)
return if ignored?(controller)
resource_name = get_resource_name(controller)
resource_description = @resource_descriptions[version][resource_name]
if resource_description
# we already defined the description somewhere (probably in
# some method. Updating just meta data from dsl
resource_description.update_from_dsl_data(dsl_data) if dsl_data
else
resource_description = Apipie::ResourceDescription.new(controller, resource_name, dsl_data, version)
Apipie.debug("@resource_descriptions[#{version}][#{resource_name}] = #{resource_description}")
@resource_descriptions[version][resource_name] ||= resource_description
end
return resource_description
end
# recursively searches what versions has the controller specified in
# resource_description? It's used to derivate the default value of
# versions for methods.
def controller_versions(controller)
ret = @controller_versions[controller]
return ret unless ret.empty?
if controller == ActionController::Base || controller.nil?
return [Apipie.configuration.default_version]
else
return controller_versions(controller.superclass)
end
end
def set_controller_versions(controller, versions)
@controller_versions[controller] = versions
end
def add_param_group(controller, name, &block)
key = "#{controller.name}##{name}"
@param_groups[key] = block
end
def get_param_group(controller, name)
key = "#{controller.name}##{name}"
if @param_groups.has_key?(key)
return @param_groups[key]
else
raise "param group #{key} not defined"
end
end
# get api for given method
#
# There are two ways how this method can be used:
# 1) Specify both parameters
# resource_name:
# controller class - UsersController
# string with resource name (plural) and version - "v1#users"
# method_name: name of the method (string or symbol)
#
# 2) Specify only first parameter:
# resource_name: string containing both resource and method name joined
# with '#' symbol.
# - "users#create" get default version
# - "v2#users#create" get specific version
def get_method_description(resource_name, method_name = nil)
if resource_name.is_a?(String)
crumbs = resource_name.split('#')
if method_name.nil?
method_name = crumbs.pop
end
resource_name = crumbs.join("#")
resource_description = get_resource_description(resource_name)
elsif resource_name.respond_to? :apipie_resource_descriptions
resource_description = get_resource_description(resource_name)
else
raise ArgumentError.new("Resource #{resource_name} does not exists.")
end
unless resource_description.nil?
resource_description.method_description(method_name.to_sym)
end
end
alias :[] :get_method_description
# options:
# => "users"
# => "v2#users"
# => V2::UsersController
def get_resource_description(resource, version = nil)
if resource.is_a?(String)
crumbs = resource.split('#')
if crumbs.size == 2
version = crumbs.first
end
version ||= Apipie.configuration.default_version
if @resource_descriptions.has_key?(version)
return @resource_descriptions[version][crumbs.last]
end
else
resource_name = get_resource_name(resource)
if version
resource_name = "#{version}##{resource_name}"
end
if resource_name.nil?
return nil
end
resource_description = get_resource_description(resource_name)
if resource_description && resource_description.controller == resource
return resource_description
end
end
end
# get all versions of resource description
def get_resource_descriptions(resource)
available_versions.map do |version|
get_resource_description(resource, version)
end.compact
end
# get all versions of method description
def get_method_descriptions(resource, method)
get_resource_descriptions(resource).map do |resource_description|
resource_description.method_description(method.to_sym)
end.compact
end
def remove_method_description(resource, versions, method_name)
versions.each do |version|
resource = get_resource_name(resource)
if resource_description = get_resource_description("#{version}##{resource}")
resource_description.remove_method_description(method_name)
end
end
end
# initialize variables for gathering dsl data
def init_env
@resource_descriptions = HashWithIndifferentAccess.new { |h, version| h[version] = {} }
@controller_to_resource_id = {}
@param_groups = {}
# what versions does the controller belong in (specified by resource_description)?
@controller_versions = Hash.new { |h, controller| h[controller] = [] }
end
def recorded_examples
return @recorded_examples if @recorded_examples
@recorded_examples = Apipie::Extractor::Writer.load_recorded_examples
end
def reload_examples
@recorded_examples = nil
end
def to_json(version, resource_name, method_name)
return unless resource_descriptions.has_key?(version)
_resources = if resource_name.blank?
# take just resources which have some methods because
# we dont want to show eg ApplicationController as resource
resource_descriptions[version].inject({}) do |result, (k,v)|
result[k] = v.to_json unless v._methods.blank?
result
end
else
[@resource_descriptions[version][resource_name].to_json(method_name)]
end
url_args = Apipie.configuration.version_in_url ? version : ''
{
:docs => {
:name => Apipie.configuration.app_name,
:info => Apipie.app_info(version),
:copyright => Apipie.configuration.copyright,
:doc_url => Apipie.full_url(url_args),
:api_url => Apipie.api_base_url(version),
:resources => _resources
}
}
end
def api_controllers_paths
Dir.glob(Apipie.configuration.api_controllers_matcher)
end
def reload_documentation
rails_mark_classes_for_reload
init_env
reload_examples
api_controllers_paths.each do |f|
load_controller_from_file f
end
@checksum = compute_checksum if Apipie.configuration.update_checksum
end
def compute_checksum
all_docs = Apipie.available_versions.inject({}) do |all, version|
all.update(version => Apipie.to_json(version))
end
Digest::MD5.hexdigest(JSON.dump(all_docs))
end
def checksum
@checksum ||= compute_checksum
end
# Is there a reason to interpret the DSL for this run?
# with specific setting for some environment there is no reason the dsl
# should be interpreted (e.g. no validations and doc from cache)
def active_dsl?
Apipie.configuration.validate? || ! Apipie.configuration.use_cache? || Apipie.configuration.force_dsl?
end
def get_resource_name(klass)
if klass.class == String
klass
elsif @controller_to_resource_id.has_key?(klass)
@controller_to_resource_id[klass]
elsif Apipie.configuration.namespaced_resources? && klass.respond_to?(:controller_path)
return nil if klass == ActionController::Base
path = klass.controller_path
path.gsub(version_prefix(klass), "").gsub("/", "-")
elsif klass.respond_to?(:controller_name)
return nil if klass == ActionController::Base
klass.controller_name
else
raise "Apipie: Can not resolve resource #{klass} name."
end
end
private
def version_prefix(klass)
version = controller_versions(klass).first
base_url = get_base_url(version)
return "/" if base_url.nil?
base_url[1..-1] + "/"
end
def get_base_url(version)
Apipie.configuration.api_base_url[version]
end
def get_resource_version(resource_description)
if resource_description.respond_to? :_version
resource_description._version
else
Apipie.configuration.default_version
end
end
def load_controller_from_file(controller_file)
controller_class_name = controller_file.gsub(/\A.*\/app\/controllers\//,"").gsub(/\.\w*\Z/,"").camelize
controller_class_name.constantize
end
def ignored?(controller, method = nil)
ignored = Apipie.configuration.ignored
return true if ignored.include?(controller.name)
return true if ignored.include?("#{controller.name}##{method}")
end
# Since Rails 3.2, the classes are reloaded only on file change.
# We need to reload all the controller classes to rebuild the
# docs, therefore we just force to reload all the code. This
# happens only when reload_controllers is set to true and only
# when showing the documentation.
def rails_mark_classes_for_reload
ActiveSupport::DescendantsTracker.clear
ActiveSupport::Dependencies.clear
end
end
end