-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
model_documentor.rb
363 lines (290 loc) · 9.52 KB
/
model_documentor.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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
require 'nokogiri'
module Documentor
def documentation(rules)
docs = rules['documentation'] || ''
docs = docs.gsub(/<!--.*?-->/m, '')
docs = docs.gsub(/<examples?>.+?<\/examples?>/m, '')
docs = docs.gsub(/<\/?note>/m, '')
docs = docs.gsub(/\{(\S+)\}/, '`{\1}`')
docs = docs.gsub(/\s+/, ' ').strip
docs == '' ? nil : docs
end
end
class ModelDocumentor
include Documentor
attr_reader :lines
def initialize(klass, api)
@lines = []
@lines << ''
@lines << <<-DOCS.strip
Constructs a service interface object. Each API operation is exposed as a
function on service.
### Sending a Request Using #{klass}
```javascript
var #{klass.downcase} = new AWS.#{klass}();
#{klass.downcase}.#{find_example_operation(api)}(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
```
### Locking the API Version
In order to ensure that the #{klass} object uses this specific API, you can
construct the object by passing the `apiVersion` option to the constructor:
```javascript
var #{klass.downcase} = new AWS.#{klass}({apiVersion: '#{api['apiVersion']}'});
```
You can also set the API version globally in `AWS.config.apiVersions` using
the **#{klass.downcase}** service identifier:
```javascript
AWS.config.apiVersions = {
#{klass.downcase}: '#{api['apiVersion']}',
// other service API versions
};
var #{klass.downcase} = new AWS.#{klass}();
```
@!method constructor(options = {})
Constructs a service object. This object has one method for each
API operation.
@example Constructing a #{klass} object
var #{klass.downcase} = new AWS.#{klass}({apiVersion: '#{api['apiVersion']}'});
@option options [String] endpoint The endpoint URI to send requests
to. The default endpoint is built from the configured `region`.
The endpoint should be a string like `'https://s3.amazonaws.com'`.
@option (see AWS.Config.constructor)
@!attribute endpoint
@return [AWS.Endpoint] an Endpoint object representing the endpoint URL
for service requests.
DOCS
end
def find_example_operation(api)
list = api['operations'].keys.grep(/describe|list|get/)
list = api['operations'].keys if list.size == 0
list.first
end
end
class MethodDocumentor
include Documentor
attr_reader :lines
def initialize(operation, api, klass)
desc = documentation(operation)
desc ||= "Calls the #{method_name(operation, false)} API operation."
desc = desc.gsub(/^\s+/, '').strip
@lines = [desc, '']
## @param tags
@lines << "@param params [Object]"
@lines += shapes(operation['input']).map {|line| " " + line }
## @example tag
@lines << "@example Calling the #{method_name(operation)} operation"
@lines << generate_example(klass, method_name(operation),
operation['input']).split("\n").map {|line| " " + line }
@lines << ""
## @callback tag
@lines << "@callback callback function(err, data)"
@lines << " Called when a response from the service is returned. If a"
@lines << " callback is not supplied, you must call {AWS.Request.send}"
@lines << " on the returned request object to initiate the request."
@lines << " @param err [Error] the error object returned from the request."
@lines << " Set to `null` if the request is successful."
@lines << " @param data [Object] the de-serialized data returned from"
@lines << " the request. Set to `null` if a request error occurs."
output = shapes(operation['output'])
output = output.map {|line| " " + line }
if output.size > 0
@lines << " The `data` object has the following properties:"
@lines << ""
@lines += output
end
## @return tag
@lines << "@return [AWS.Request] a handle to the operation request for"
@lines << " subsequent event callback registration."
if operation['documentation_url']
@lines << "@see #{operation['documentation_url']}"
@lines << " #{api['serviceAbbreviation']} Documentation for #{operation['name']}"
end
end
def method_name(operation, downcased = true)
name = operation['name']
name = name.sub(/\d{4}_\d{2}_\d{2}$/, '')
downcased ? name[0].downcase + name[1..-1] : name
end
def shapes(rules)
if rules and rules['members']
rules['members'].map do |name, member_rules|
ShapeDocumentor.new(member_rules, :name => name).lines
end.flatten
else
[]
end
end
def generate_example(klass, name, input)
ExampleShapeVisitor.new.example(klass, name, input)
end
end
class ExampleShapeVisitor
def initialize(required_only = false)
@required_only = required_only
end
def example(klass, name, input)
lines = []
params = traverse(input)
params_var = ""
if params.strip.length > 0
lines << "var params = " + params + ";"
params_var = "params, "
end
lines << "#{klass.downcase}.#{name}(#{params_var}function(err, data) {"
lines << " if (err) console.log(err, err.stack); // an error occurred"
lines << " else console.log(data); // successful response"
lines << "}"
lines.join("\n")
end
def traverse(node)
if (meth = "visit_" + (node['type'] || 'string')) && respond_to?(meth)
return send(meth, node)
end
""
end
def visit_structure(node)
lines = ["{" + (node['required'] ? " // required" : "")]
node['members'].sort_by {|n, v| [v['required'] ? -1 : 1, n] }.each do |key, value|
next if @required_only && !value['required']
lines << " #{key}: " + indent(traverse(value), false) + "," +
(value['required'] && !%w(list map structure).include?(value['type']) ?
" // required" : "")
end
lines << "}"
lines.join("\n")
end
def visit_list(node)
lines = ["[" + (node['required'] ? " // required" : "")]
lines << indent(traverse(node['members'])) + ","
lines << " // ... more items ..."
lines << "]"
lines.join("\n")
end
def visit_map(node)
lines = ["{" + (node['required'] ? " // required" : "")]
lines << indent("someKey: " + traverse(node['members'])) + ","
lines << " // anotherKey: ..."
lines << "}"
lines.join("\n")
end
def visit_string(node)
value = node['enum'] ? node['enum'].join(' | ') : 'STRING_VALUE'
"'#{value}'"
end
def visit_integer(node)
"0"
end
alias visit_long visit_integer
def visit_float(node)
"0.0"
end
alias visit_double visit_float
alias visit_bigdecimal visit_float
def visit_boolean(node)
"true || false"
end
def visit_base64(node)
"'BASE64_ENCODED_STRING'"
end
def visit_binary(node)
"new Buffer('...') || streamObject || 'STRING_VALUE'"
end
def visit_timestamp(node)
"new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789"
end
def indent(text, first_line = true, n = 2)
text = text.split(/\r?\n/).map {|l| "#{' ' * n}#{l}" }.join("\n")
text = text.sub(/\A\s+/, '') if !first_line
text
end
end
class ShapeDocumentor
include Documentor
attr_reader :name
attr_reader :rules
attr_reader :lines
attr_reader :nested_lines
attr_reader :prefix
attr_reader :type
def initialize(rules, options = {})
@rules = rules
@name = options[:name]
@prefix = options[:prefix] || ''
@type =
case rules['type']
when 'structure' then 'map'
when 'list' then 'Array'
when 'map' then 'map'
when 'string', nil then 'String'
when 'integer' then 'Integer'
when 'long' then 'Integer'
when 'float' then 'Float'
when 'double' then 'Float'
when 'bigdecimal' then 'Float'
when 'boolean' then 'Boolean'
when 'base64' then 'Base64 Encoded String'
when 'binary' then 'Buffer'
when 'timestamp' then 'Date'
else raise "unhandled type: #{rules['type']}"
end
# TODO : update this format description once we add streaming uploads
@type = 'String' if streaming?
@lines = []
@nested_lines = []
if structure?
rules['members'].each_pair do |name, member_rules|
@nested_lines += child_shape(member_rules, :name => name).lines
end
end
if list?
child = child_shape(rules['members'] || {}, :prefix => prefix)
@type << "<#{child.type}>"
@nested_lines += child.nested_lines
end
if map?
# sanity check, I don't think this should ever raise, but if it
# does we will have to document the key shape
key_child = child_shape(rules['keys'] || {}, :prefix => prefix)
raise "unhandled map key type" if key_child.type != 'String'
child = child_shape(rules['members'] || {}, :prefix => prefix)
@type << "<#{child.type}>"
@nested_lines += child.nested_lines
end
@lines = ["#{prefix}* `#{name}` #{description}"]
@lines += @nested_lines
if rules['enum']
@lines << "#{prefix} Possible values include:"
@lines += rules['enum'].map{|v| "#{prefix} * `#{v.inspect}`" }
end
end
def streaming?
rules['payload'] and rules['type'] == 'blob'
end
def structure?
rules['type'] == 'structure'
end
def list?
rules['type'] == 'list'
end
def map?
rules['type'] == 'map'
end
def description
text = []
if rules['required']
text << "— **required** — (`#{@type}`)"
else
text << "— (`#{@type}`)"
end
if docs = documentation(rules)
text << " #{docs}"
end
text.join(' ')
end
private
def child_shape(rules, options = {})
ShapeDocumentor.new(rules, { :prefix => prefix + ' ' }.merge(options))
end
end