reqres_rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fff2afe79f68435c6b2427a0956a13b7fcc745df
+  data.tar.gz: 8e5a3cc6f86c39a9298fd32eb95d3ab3173736db
+SHA512:
+  metadata.gz: 2e2d2c9c66a38dc962c9e99e7bcbfda25851ce1de6fc9481289708e14fb11edf5180c49ee1458b8ddd541230fd13d71853ee29ee6b6a8e0acb33eb68b9c1c7f2
+  data.tar.gz: 38831de650a0ace22d13ccbcfa96b19ba9694d1c80f12954c6974be12d6e4dfd224538a042dd52ffd487ce87d227afe51385189c594c2eaa0e3fd7f3d4e36286

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 rilian
+
+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,39 @@
+# ReqresRspec
+
+Gem generates API documentation from your integration tests written with `rspec`. No additional DSL needed. Beside covering rspec tests, documentation may be extended with API controller action comments win `yardoc` style. Documentation is generated in JSON, YAML, HTML, PDF formats.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reqres_rspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reqres_rspec
+
+## Usage
+
+### Sample controller action
+
+TODO: Write usage instructions here
+
+### Sample rspec test
+
+TODO: Write usage instructions here
+
+### Generates documentation example
+
+TODO: Write usage instructions here
+
+## 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/reqres_rspec.rb

@@ -0,0 +1,41 @@
+# to enable mattr_accessor
+require "active_support/core_ext/module/attribute_accessors"
+
+require "reqres_rspec/version"
+require "reqres_rspec/collector"
+
+module ReqresRspec
+  # Contains spec values read from rspec example, request and response
+  mattr_accessor :records
+
+  # define if all doc generation is enabled
+  mattr_accessor :enabled
+end
+
+ReqresRspec.enabled = defined?(RSpec)
+
+if !ReqresRspec.enabled
+  puts "\nWARNING: ReqresRspec is disabled\n"
+end
+
+if ReqresRspec.enabled
+  # initialize
+  ReqresRspec.records = []
+
+  RSpec.configure do |config|
+    config.after(:each) do
+      if defined?(request) && defined?(response)
+        unless self.example.options.has_key?(:rspec_doc) && !self.example.options[:rspec_doc]
+          ReqresRspec::Collector.collect(self, request, response)
+        end
+      end
+    end
+
+    config.after(:suite) do
+      if ReqresRspec.records && ReqresRspec.records.size > 0
+        puts 'TODO: save records'
+        puts ReqresRspec.records.inspect
+      end
+    end
+  end
+end

data/lib/reqres_rspec/collector.rb

@@ -0,0 +1,14 @@
+require 'reqres_rspec'
+
+module ReqresRspec
+  module Collector
+    # collects spec data for further processing
+    def Collector.collect(spec, request, response)
+      record = {
+        title: 'title',
+      }
+
+      ReqresRspec.records << record
+    end
+  end
+end

data/lib/reqres_rspec/version.rb

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

data/reqres_rspec.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reqres_rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reqres_rspec"
+  spec.version       = ReqresRspec::VERSION
+  spec.authors       = ["rilian"]
+  spec.email         = ["dmitriyis@gmail.com"]
+  spec.description   = %q{Generates API documentation in PDF, HTML, JSON, YAML format for integration tests written with RSpec}
+  spec.summary       = %q{Generates API documentation in PDF, HTML, JSON, YAML format for integration tests written with 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"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: reqres_rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- rilian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates API documentation in PDF, HTML, JSON, YAML format for integration
+  tests written with RSpec
+email:
+- dmitriyis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reqres_rspec.rb
+- lib/reqres_rspec/collector.rb
+- lib/reqres_rspec/version.rb
+- reqres_rspec.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Generates API documentation in PDF, HTML, JSON, YAML format for integration
+  tests written with RSpec
+test_files: []