Class: GrapeMarkdown::SampleGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/grape-markdown/sample_generator.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource) ⇒ SampleGenerator

Returns a new instance of SampleGenerator.



7
8
9
10
 
# File 'lib/grape-markdown/sample_generator.rb', line 7

def initialize(resource)
  @resource = resource
  @root     = resource.key.singularize
end

Instance Attribute Details

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



3
4
5
 
# File 'lib/grape-markdown/sample_generator.rb', line 3

def resource
  @resource
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



3
4
5
 
# File 'lib/grape-markdown/sample_generator.rb', line 3

def root
  @root
end

Instance Method Details

#request(opts = {}) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/grape-markdown/sample_generator.rb', line 27

def request(opts = {})
  hash = sample

  return unless hash.present?

  json(hash, opts[:pretty])
end

#response(opts = {}) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/grape-markdown/sample_generator.rb', line 35

def response(opts = {})
  hash = sample(true)

  return unless hash.present?

  hash = [hash] if opts[:list]

  json(hash, opts[:pretty])
end

#sample(id = false) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/grape-markdown/sample_generator.rb', line 12

def sample(id = false)
  array = resource.unique_params.map do |param|
    next if param.name == root

    [param.name, param.example]
  end

  hash = Hash[array.compact]

  hash = hash.reverse_merge(id: Configuration.generate_id) if id
  hash = { root => hash } if Configuration.include_root

  hash
end