Init Project

Author: nvh0412

.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_api_blueprint.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Hoa-Nguyen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,29 @@
+# Rspec Api Blueprint
+
+Autogeneration of API documentation using the Blueprint format from request specs.
+
+You can find more about Blueprint at http://apiblueprint.org
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec_apib', require: false
+
+Or install it yourself as:
+
+    $ gem install rspecb
+
+## Usage
+
+In your spec_helper.rb file add
+
+    require 'rspec_api_blueprint'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

lib/rspec_apib.rb

@@ -0,0 +1,67 @@
+require "rspec_apib/version"
+require "rspec_apib/string_extensions"
+
+RSpec.configure do |config|
+  config.before(:suite) do |example|
+    api_docs_folder_path = File.join(Dir.pwd, '/api_docs/')
+    Dir.mkdir(api_docs_folder_path) unless Dir.exists?(api_docs_folder_path)
+  end
+
+  config.after(:each, type: :controller) do |example|
+    response ||= last_response
+    request ||= last_request
+
+    if response
+      example_group = example.metadata[:example_group]
+      example_groups = []
+
+      while example_group
+        example_groups << example_group
+        example_group = example_group[:parent_example_group]
+      end
+
+      action = example_groups[-2][:description_args].first if example_groups[-2]
+      example_groups[-1][:description_args].first.match(/(\w+)\sRequests/)
+
+      file_name = 'api'
+      file = File.join(Dir.pwd, "/api_docs/#{file_name}.apib")
+
+      File.open(file, 'a') do |f|
+        # Resource & Action
+        f.write "### #{action}\n\n" if [200, 201].include?(response.status)
+
+        # Request
+        request_body = request.body.read
+        authorization_header = request.env ? request.env['HTTP_EH_AUTH'] : request.headers['HTTP_EH_AUTH']
+
+        if request_body.present? || authorization_header.present?
+          f.write "+ Request (#{request.content_type})\n\n"
+
+          # Request Headers
+          if authorization_header.present?
+            f.write "+ Headers\n".indent(2)
+            f.write "HTTP_EH_AUTH: #{authorization_header}\n".indent(4)
+          end
+
+          f.write "\n"
+
+          # Request Body
+          if request_body.present? && request.content_type == 'application/json'
+            f.write "+ Body\n".indent(2) if authorization_header
+            f.write "#{JSON.pretty_generate(JSON.parse(request_body))}\n".indent(4)
+            f.write "\n"
+          end
+        end if [200, 201].include?(response.status)
+
+        # Response
+        f.write "+ Response #{response.status} (#{response.content_type})\n\n"
+
+        if response.body.present? && response.content_type =~ /application\/json/
+          f.write "+ Body\n".indent(2)
+          f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n".indent(4)
+          f.write "\n"
+        end
+      end
+    end
+  end
+end

lib/rspec_apib/string_extensions.rb

@@ -0,0 +1,14 @@
+unless "".respond_to?(:indent)
+  class String
+    def indent(count, char = ' ')
+      gsub(/([^\n]*)(\n|$)/) do |match|
+        last_iteration = ($1 == "" && $2 == "")
+        line = ""
+        line << (char * count) unless last_iteration
+        line << $1
+        line << $2
+        line
+      end
+    end
+  end
+end

lib/rspec_apib/version.rb

@@ -0,0 +1,3 @@
+module RspecApiB
+  VERSION = "0.0.1"
+end

rspec_apib.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_apib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-apib"
+  spec.version       = RspecApiB::VERSION
+  spec.authors       = ["Hoa Nguyen"]
+  spec.email         = ["nvh0412@gmail.com"]
+  spec.description   = %q{Autogeneration of apib file from rspec}
+  spec.summary       = %q{Autogeneration of apib file from rspec}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'rspec'
+end