Class: ApiBlueprint

Inherits:
RSpec::Core::Formatters::BaseFormatter
  • Object
show all
Defined in:
lib/api_blueprint.rb

Instance Method Summary collapse

Constructor Details

#initialize(output) ⇒ ApiBlueprint

Returns a new instance of ApiBlueprint.



12
13
14
15
16
17
 
# File 'lib/api_blueprint.rb', line 12

def initialize(output)
  super
  @passed_examples = {}
  @group_level = 0
  RSpec.configuration.silence_filter_announcements = true
end

Instance Method Details

#example_passed(passed) ⇒ Object 



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

def example_passed(passed)
  metadata = passed.example.metadata

  if metadata[:apidoc] &&
      metadata[:resource_group] &&
      metadata[:resource] &&
      metadata[:action] &&
      metadata[:action_description]

    request = @example_group_instance.request
    response = @example_group_instance.response
    description = description_array_from(passed.example.metadata).reverse.join(' ').gsub(/[\(\)]/, '..')

    @passed_examples.deep_merge!({
      metadata[:resource_group] => {
        metadata[:resource] => {
          metadata[:action] => {
            description: metadata[:action_description],
            parameters: metadata[:action_parameters],
            examples: {
              description => {
                request: {
                  parameters: request.parameters.except(*request.path_parameters.keys.map(&:to_s)).to_json,
                  format: request.format
                },
                source: passed.example.instance_variable_get(:@example_block).source,
                location: metadata[:location],
                response: {
                  status: response.status,
                  body: response.body
                }
              }
            }
          }
        }
      }
    })
  end
  @example_group_instance = nil
end

#example_started(notification) ⇒ Object 



19
20
21
 
# File 'lib/api_blueprint.rb', line 19

def example_started(notification)
  @example_group_instance = notification.example.example_group_instance
end

#stop(notification) ⇒ Object 



64
65
66
67
68
 
# File 'lib/api_blueprint.rb', line 64

def stop(notification)
  @passed_examples.sort_by { |k,v| k }.each do |resource_group_name, resource_group_resources|
    print_resource_group(resource_group_name, resource_group_resources)
  end
end