rspec-api-blueprint-formatter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6dfeb563d5f0d7faae44cb720d625abfa25d91e
+  data.tar.gz: b9ffaabf36aeae46b20de087661323963c692ae0
+SHA512:
+  metadata.gz: 1f96c797447ae5f70ef8999a630c9e61f4dd0fb6f8911c85927340c3b7fe987a65709739e6ce696740d1e3ada62147fb7aa8a6da981b4d6b402a513db3d002b4
+  data.tar.gz: 26d68c0902c8a2c74cc78f88636d777ec76f68c3dfc3100b72f9954efc47dedba1f728d8b1ca05982eeeea2045a2a0086b521b25892e9759d9cf1dc0920bdd5d

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_blueprint_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api_blueprint.rb

@@ -0,0 +1,130 @@
+require 'rspec'
+require 'rspec/core/formatters/base_text_formatter'
+
+class ApiBlueprint < RSpec::Core::Formatters::BaseTextFormatter
+  VERSION = "0.1.0"
+  RSpec::Core::Formatters.register self, :example_passed, :example_started, :stop
+
+  def initialize(output)
+    super
+    @passed_examples = {}
+    @group_level = 0
+  end
+
+  def example_started(notification)
+    @example_group_instance = notification.example.example_group_instance
+  end
+
+  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: 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
+
+  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
+
+  private
+
+  def print_resource_group(resource_group_name, resource_group_resources)
+    output.puts "# Group #{resource_group_name}"
+    resource_group_resources.each &method(:print_resource)
+  end
+
+  def print_resource(resource_name, actions)
+    unless resource_name =~ /^[^\[\]]*\[\/[^\]]+\]/
+      raise "resoure: '#{resource_name}' is invalid. :resource needs to be specified according to https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#resource-section"
+    end
+    output.puts "# #{resource_name}"
+
+    http_verbs = actions.keys.map {|action| action.scan(/\[([A-Z]+)\]/).flatten[0] }
+
+    unless http_verbs.length == http_verbs.uniq.length
+      raise "Action HTTP verbs are not unique #{actions.keys.inspect} for resource: '#{resource_name}'"
+    end
+
+    actions.each &method(:print_action)
+  end
+
+  def print_action(action_name, action_meta_data)
+    output.puts "## #{action_name}\n" \
+                "\n" \
+                "#{action_meta_data[:description]}\n" \
+                "\n" \
+
+    action_meta_data[:examples].each &method(:print_example)
+  end
+
+  def print_example(example_description, example_metadata)
+    output.puts "+ Request #{example_description}\n" \
+      "\n" \
+      "        #{example_metadata[:request][:parameters]}\n" \
+      "        \n" \
+      "        Location: #{example_metadata[:location]}\n" \
+      "        Source code:\n" \
+      "        \n" \
+      "#{indent_lines(8, example_metadata[:source])}\n" \
+      "\n"
+
+    output.puts "+ Response #{example_metadata[:response][:status]} (#{example_metadata[:request][:format]})\n" \
+      "\n" \
+      "        #{example_metadata[:response][:body]}\n" \
+      "\n"
+  end
+
+  # To include the descriptions of all the contexts that are below the action
+  # group, but not including resource/resource_group descriptions
+  def description_array_from(example_metadata)
+    parent = example_metadata[:parent_example_group] if example_metadata.key?(:parent_example_group)
+    parent ||= example_metadata[:example_group] if example_metadata.key?(:example_group)
+    if parent[:action].nil?
+      []
+    else
+      [example_metadata[:description]] + description_array_from(parent)
+    end
+  end
+
+  def indent_lines(number_of_spaces, string)
+    string
+      .split("\n")
+      .map { |a| a.prepend(' ' * number_of_spaces) }
+      .join("\n")
+  end
+end

data/spec/rspec/api/blueprint/formatter_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ApiBlueprint do
+  it 'has a version number' do
+    expect(ApiBlueprint::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'api_blueprint'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rspec-api-blueprint-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nam Chu Hoai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Use your Rspec tests to build your API documentation
+email:
+- nambrot@googlemail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- lib/api_blueprint.rb
+- spec/rspec/api/blueprint/formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nambrot/rspec-api-blueprint-formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Use your Rspec tests to build your API documentation
+test_files:
+- spec/rspec/api/blueprint/formatter_spec.rb
+- spec/spec_helper.rb