Module: SwaggerModel::SwaggerV2

Defined in:
lib/swagger_model.rb

Class Method Summary collapse

Class Method Details

.create_from_json(params) ⇒ Object 



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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/swagger_model.rb', line 327

def self.create_from_json(params)
  response = {}.to_json
  json_string = params[:json_string]
  if !json_string.nil?
    response = JSON.load(json_string)
  else
    json_file_path = params[:json_file_path] || gets
    json = open(json_file_path) do |io|
      JSON.load(io)
    end
    response = json
  end
  response_name = params[:response_name] || gets
  response_model = {}
  response_model[response_name] = {}
  response_model[response_name]['type'] = "object"
  model = {}
  object = parse_object(response, model, response_name)
  properties = object['properties']
  if properties.has_key?('links')
    links = {}
    links['$ref'] = '#/definitions/Links'
    properties['links'] = links
    if response_model['Links'].nil?
      response_model['Links'] = {
        'self' => {
          'type' => "string",
          'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=2&page%5Bsize%5D=20"
        },
        'first' => {
          'type' => "string",
          'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=1&page%5Bsize%5D=20"
        },
        'prev' => {
          'type' => "string",
          'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=1&page%5Bsize%5D=20"
        },
        'next' => {
          'type' => "string",
          'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=3&page%5Bsize%5D=20"
        },
        'last' => {
          'type' => "string",
          'example' => "https://contents.kurashiru.com/api/v1/videos?page%5Bnumber%5D=100&page%5Bsize%5D=20"
        }
      }
    end
  end
  if properties.has_key?('meta')
    meta_name = response_name + 'Meta'
    response_model[meta_name] = properties['meta']
    meta = {}
    meta['$ref'] = '#/definitions/' + meta_name
    properties['meta'] = meta
  end
  response_model[response_name]['properties'] = properties
  if object['required'].size > 0
    response_model[response_name]['required'] = object['required']
  end
  output_path = params[:output_path] || './'
  output_path_responses = File.join(output_path, 'Responses/')
  output_path_models = File.join(output_path, 'Models/')

  FileUtils::mkdir_p output_path_responses
  FileUtils::mkdir_p output_path_models

  File.write(File.join(output_path_responses, "#{response_name}.yaml"), response_model.to_yaml)

  keys = model.keys
  for key in keys do
    File.write(File.join(output_path_models, "#{key}.yaml"), model[key].to_yaml)
  end
end

.date_time_valid?(str) ⇒ Boolean 



193
194
195
196
197
198
199
200
 
# File 'lib/swagger_model.rb', line 193

def self.date_time_valid?(str)
  if (!! Date.parse(str) rescue false)
    date = Date._parse(str)
    !date[:zone].nil? && !date[:hour].nil? && !date[:min].nil? && !date[:sec].nil? && !date[:year].nil? && !date[:mon].nil?
  else
    false
  end
end

.get_property(key, value, model, root_key) ⇒ Object 



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
 
# File 'lib/swagger_model.rb', line 202

def self.get_property(key, value, model, root_key)
  type_class = value.class.to_s
  obj = {}
  case type_class
  when 'Hash'
    if value.has_key?('id') && value.has_key?('type')
      model_name = ActiveSupport::Inflector.classify(value['type'].gsub('-', '_'))
      model[model_name] = {}
      object = parse_object(value, model, model_name)
      properties = object['properties']
      newProperties = {}
      newProperties['type'] = 'object'
      if object['required'].size > 0
          newProperties['required'] = object['required']
      end
      newProperties['properties'] = properties
      model[model_name][model_name] = newProperties
      obj['$ref'] = '#/definitions/' + model_name
    elsif key == 'attributes'
      object = parse_object(value, model, root_key)
      properties = object['properties']
      model_name = root_key + 'Attributes'
      model[root_key][model_name] = {}
      model[root_key][model_name]['type'] = 'object'
      model[root_key][model_name]['properties'] = properties
      if object['required'].size > 0
        model[root_key][model_name]['required'] = object['required']
      end
      obj['$ref'] = '#/definitions/' + model_name
    elsif key == 'relationships'
      object = parse_object(value, model, root_key)
      properties = object['properties']
      model_name = root_key + 'Relationships'
      model[root_key][model_name] = {}
      model[root_key][model_name]['type'] = 'object'
      model[root_key][model_name]['properties'] = properties
      if object['required'].size > 0
        model[root_key][model_name]['required'] = object['required']
      end
      obj['$ref'] = '#/definitions/' + model_name
    else
      object = parse_object(value, model, root_key)
      properties = object['properties']
      obj['type'] = 'object'
      obj['properties'] = properties
      if object['required'].size > 0
        obj['required'] = object['required']
      end
    end
  when 'Array'
    if key == 'included'
      obj['type'] = 'array'
      obj['items'] = {}
      array = parse_array_with_multi_model(value, model, root_key)
      p array
      if array.size < 2
        obj['type'] = 'array'
        obj['items'] = array[0]
      else
        @logger.error("Cannot create model because of 2 or more models included in Array")
        exit
      end
    else
      obj['type'] = 'array'
      obj['items'] = parse_array(value, model, root_key)
    end
  when 'String'
    obj['type'] = 'string'
    obj['example'] = value
    if date_time_valid?(value)
      obj['format'] = 'date-time'
    end
  when 'Fixnum'
    obj['type'] = 'integer'
    obj['example'] = value
  when 'TrueClass', 'FalseClass'
    obj['type'] = 'boolean'
    obj['example'] = value
  when 'Float'
    obj['type'] = 'number'
    obj['format'] = 'float'
    obj['example'] = value
  else
    @logger.warn("Unrecognized Type of `#{key}`. [key: #{key}, root_key: #{root_key}]")
    obj['type'] = ''
    obj['example'] = ''
  end
  obj
end

.parse_array(items, model, root_key) ⇒ Object 



292
293
294
295
296
 
# File 'lib/swagger_model.rb', line 292

def self.parse_array(items, model, root_key)
  m = {}
  value = items.first
  get_property(nil, value, model, root_key)
end

.parse_array_with_multi_model(items, model, root_key) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/swagger_model.rb', line 298

def self.parse_array_with_multi_model(items, model, root_key)
  types = []
  refs = []
  items.each do |value|
    property = get_property(nil, value, model, root_key)
    if !refs.include?(property['$ref'])
      types.push(get_property(nil, value, model, root_key))
      refs.push(property['$ref'])
    end
  end
  types
end

.parse_object(res, model, root_key) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/swagger_model.rb', line 311

def self.parse_object(res, model, root_key)
  keys = res.keys
  m = {}
  required = []
  for key in keys do
    value = res[key]
    m[key] = get_property(key, value, model, root_key)
    if m[key]['type'] != ''
      required.push(key)
    end
  end
  obj = {}
  obj['properties'] = m
  obj['required'] = required
  obj
end