Class: ApiBlueprint

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

Constant Summary collapse

VERSION = 
"0.1.0"

Instance Method Summary collapse

Constructor Details

#initialize(output) ⇒ ApiBlueprint

Returns a new instance of ApiBlueprint.



8
9
10
11
12
 
# File 'lib/api_blueprint.rb', line 8

def initialize(output)
  super
  @passed_examples = {}
  @group_level = 0
end

Instance Method Details

#example_passed(passed) ⇒ Object 



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

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],
            examples: {
              description => {
                request: {
                  parameters: JSON.pretty_generate(request.parameters.except(*request.path_parameters.keys.map(&:to_s))),
                  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 



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

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

#stop(notification) ⇒ Object 



58
59
60
61
62
 
# File 'lib/api_blueprint.rb', line 58

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