rspec_api_blueprint 0.0.1

data/.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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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.

data/README.md

@@ -0,0 +1,74 @@
+# 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_api_blueprint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_api_blueprint
+
+## Usage
+
+In your spec_helper.rb file add
+
+    require 'rspec_api_blueprint'
+    
+Write tests using the following convention:
+
+- Top level descriptions are named after the model (plural form) followed by the word “Requests”. For a example model called Arena it would be “Arenas Requests”.
+- Second level descriptions are actions in the form of “VERB path”. For the show action of the Arenas controller it would be “GET /arenas/{id}”.
+
+Example:
+    
+    describe 'Arenas Requests' do
+      describe 'GET /v1/arenas/{id}' do
+        it 'responds with the requested arena' do
+          arena = create :arena, foursquare_id: '5104'
+          get v1_arena_path(arena)
+
+          response.status.should eq(200)
+        end
+      end
+    end
+    
+The output:
+
+    # GET /v1/arenas/{id} 
+
+    + Response 200 (application/json) 
+
+        {
+          "arena": {
+            "id": "4e9dbbc2-830b-41a9-b7db-9987735a0b2a",
+            "name": "Clinton St. Baking Co. & Restaurant",
+            "latitude": 40.721294,
+            "longitude": -73.983994,
+            "foursquare_id": "5104"
+          }
+        }
+        
+        
+## Caveats
+
+401, 403 and 301 statuses are ignored since rspec produces a undesired output.
+
+TODO: Add option to choose ignored statuses.
+    
+## 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

data/Rakefile

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

data/lib/rspec_api_blueprint/version.rb

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

data/lib/rspec_api_blueprint.rb

@@ -0,0 +1,57 @@
+require "rspec_api_blueprint/version"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Dir.glob(File.join(Rails.root, '/docs/', '*')).each do |f|
+      File.delete(f)
+    end
+  end
+
+  config.after(:each, type: :request) do
+    if response
+      example_group = example.metadata[:example_group]
+      example_groups = []
+
+      while example_group
+        example_groups << example_group
+        example_group = example_group[: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 = $1.underscore
+
+      File.open(File.join(Rails.root, "/docs/#{file_name}.txt"), 'a') do |f|
+        # Resource & Action
+        f.write "# #{action}\n\n"
+
+        # Request
+        request_body = request.body.read
+        authorization_header = request.headers['Authorization']
+
+        if request_body.present? || authorization_header.present?
+          f.write "+ Request #{request.content_type}\n\n"
+
+          # Request Headers
+          if authorization_header
+            f.write "+ Headers\n\n".indent(4)
+            f.write "Authorization: #{authorization_header}\n\n".indent(8)
+          end
+
+          # Request Body
+          if request_body.present?
+            f.write "+ Body\n\n".indent(4)
+            f.write "#{JSON.pretty_generate(JSON.parse(request_body))}\n\n".indent(8)
+          end
+        end
+
+        # Response
+        f.write "+ Response #{response.status} #{response.content_type}\n\n"
+
+        if response.body.present?
+          f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n\n".indent(4)
+        end
+      end unless response.status == 401 || response.status == 403 || response.status == 301
+    end
+  end
+end

data/rspec_api_blueprint.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_api_blueprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_api_blueprint"
+  spec.version       = RspecApiBlueprint::VERSION
+  spec.authors       = ["Matteo Depalo"]
+  spec.email         = ["matteodepalo@gmail.com"]
+  spec.description   = %q{Autogeneration of documentation from request specs}
+  spec.summary       = %q{Autogeneration of documentation from request specs}
+  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-rails'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rspec_api_blueprint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matteo Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Autogeneration of documentation from request specs
+email:
+- matteodepalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_api_blueprint.rb
+- lib/rspec_api_blueprint/version.rb
+- rspec_api_blueprint.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1961368386880728741
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1961368386880728741
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Autogeneration of documentation from request specs
+test_files: []