rspec-api-docs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7e5799e512fca99e136a0909ba2118a90d96073
-  data.tar.gz: 48de8b3f91fa45947fc1903fe25b0e4b8351aa93
+  metadata.gz: 45bd45a0a13f8512cf26c3406b17a461de6a6844
+  data.tar.gz: 545d0fe44c9de8c1a33c3fe5285fb716ea611ee2
 SHA512:
-  metadata.gz: adac7650aa8fbd77ae177ec13eb55173818a0c48cf725795bbc0fa8821a98c7e9b375cc3418b0df1b668cd508cdad26c83b39e578c1ba76d2400235cbc7478e5
-  data.tar.gz: 12f01cf8d991c15c98b5d05b9a452f0ea2e915049160337b8ef5ef39510b356af4ece8d43096aa80cdb2935e564f4394ca06599269c3fd5115e0efdac551f74f
+  metadata.gz: 4e2cd0a674337ac2e8683d5f9116a85f5bf01726482fd9300173653cd643ce3ae772edc6499dab21e62d701a9d2e6debcb706c5c4619b34c98283cf7ed8fcb4d
+  data.tar.gz: 30877036d873b254345a13678b9f339c4c2972876e3b5e76de3dd0a6aed946a7347c63cd70b29417b5b50e588ab9b8510f951d74bd2feb746f2bdd6fcb602e62

data/README.md

@@ -8,6 +8,15 @@
   <a href="http://www.rubydoc.info/github/twe4ked/rspec-api-docs/master"><img src="https://img.shields.io/badge/docs-master-lightgrey.svg?style=flat-square" /></a>
 </p>
 
+**rspec-api-docs** provides a way to generate documentation from your request
+specs. It does this by providing a simple DSL and a custom formatter.
+
+The default renderer produces a [single JSON file] which can be used by
+[api-docs] to [display your documentation].
+
+[single JSON file]: ./spec/integration/output/json/index.json
+[display your documentation]: https://twe4ked.github.io/api-docs/
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -265,6 +274,7 @@ $ ./bin/generate_integration_docs
 ## TODO
 
 - Allow specifying an order (`precedence`?)
+- Order Resources and Examples alphabetically
 
 ## Contributing
 
@@ -281,3 +291,4 @@ The gem is available as open source under the terms of the [MIT License].
 [MIT License]: http://opensource.org/licenses/MIT
 [Contributor Covenant]: http://contributor-covenant.org
 [rubygems.org]: https://rubygems.org
+[api-docs]: https://github.com/twe4ked/api-docs

data/lib/rspec_api_docs/config.rb

@@ -17,12 +17,14 @@ module RspecApiDocs
     attr_accessor \
       :output_dir,
       :renderer,
-      :validate_params
+      :validate_params,
+      :exclude_request_headers
 
     def initialize
       @output_dir = 'docs'
       @renderer = :json
       @validate_params = true
+      @exclude_request_headers = []
     end
   end
 end

data/lib/rspec_api_docs/formatter/resource/example.rb

@@ -95,12 +95,17 @@ module RspecApiDocs
 
       # http://stackoverflow.com/a/33235714/826820
       def request_headers(env)
-        Hash[
+        headers = Hash[
           *env.select { |k,v| k.start_with? 'HTTP_' }
             .collect { |k,v| [k.sub(/^HTTP_/, ''), v] }
             .collect { |k,v| [k.split('_').collect(&:capitalize).join('-'), v] }
             .sort.flatten
         ]
+
+        # TODO: Extract, test, and document
+        headers.reject do |k, v|
+          RspecApiDocs.configuration.exclude_request_headers.include?(k)
+        end
       end
 
       def request_path(request)

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-02 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Generate API documentation using RSpec